summaryrefslogtreecommitdiff
path: root/legacy/ethumb
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2010-02-13 13:28:32 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2010-02-13 13:28:32 +0000
commit23f96d5d339d5a32ead074114be75cdf61ca25d7 (patch)
tree1e030314cfd7fa8a9cb98b2ee4531470d3278cad /legacy/ethumb
parentb87e1d6fae74fc26eea10e295027751f94020fa6 (diff)
All packages should have README...
SVN revision: 46138
Diffstat (limited to 'legacy/ethumb')
-rw-r--r--legacy/ethumb/README51
1 files changed, 51 insertions, 0 deletions
diff --git a/legacy/ethumb/README b/legacy/ethumb/README
index e69de29bb2..906dbc9e75 100644
--- a/legacy/ethumb/README
+++ b/legacy/ethumb/README
@@ -0,0 +1,51 @@
1 Ethumb - Thumbnail generation library
2
3
4FEATURES
5========
6
7 * create thumbnails with a predefined frame (possibly an edje frame);
8 * have an option to create fdo-like thumbnails;
9 * have a client/server utility.
10
11
12API
13===
14
15It's possible to set the following properties of thumbnails:
16
17 * size
18 * format (jpeg, png, eet...)
19 * aspect:
20 * have crop?
21 * crop alignment?
22 * video:
23 * video_time
24 * document:
25 * page
26 * frame: edje file, group and swallow part to use when generating
27 thumbnails
28 * directory: directory where to save thumbnails
29 * category: to be used as DIRECTORY/CATEGORY/md5.format
30
31Path generation should provide the following:
32
33 * If no path to save the thumbnail is specified, the following is used:
34 * if CATEGORY, return ~/.thumbnail/CATEGORY/md5.format
35 * else if size (128x128 or 256x256), format (png), aspect (keep
36 aspect, no crop) and no frame matches, return
37 ~/.thumbnail/{normal,large}/md5.png
38 * else return WxH-FORMAT-[framed-]ASPECT
39
40Client server provides the following:
41 * multiple client support
42 * per-client configuration, avoid exchanging parameters over and over
43 again
44 * per-client queue, when client disconnect (ie: dies), remove whole
45 queue
46 * all clients have same priority, so queue is mixed for processing
47 * cancel thumb generation request
48 * communication over (for now) dbus and (future) ecore-ipc and unix
49 sockets
50 * interface of client library is independent of the communication
51 method selected