All packages should have README...
[framework/uifw/ethumb.git] / README
1                 Ethumb - Thumbnail generation library
2
3
4 FEATURES
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
12 API
13 ===
14
15 It'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
31 Path 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
40 Client 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