1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*
* libmedia-thumbnail
*
* Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
*
* Contact: Hyunjun Ko <zzoon.ko@samsung.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef _MEDIA_THUMBNAIL_H_
#define _MEDIA_THUMBNAIL_H_
#include "media-thumb-types.h"
#include "media-thumb-error.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
@defgroup THUMB_GENERATE Thumbnail generator
@{
* @file media-thumbnail.h
* @brief This file defines API's for thumbnail generator.
* @version 1.0
*/
/**
@defgroup THUMB_API Thumbnail generator API
@{
@par
generates thumbnail data and return the path of the generated thumbnail file.
*/
/**
* Callback function, which is used to call thumbnail_request_from_db_async
*/
typedef int (*ThumbFunc) (int error_code, char* path, void* data);
/**
* thumbnail_request_from_db:
* This function connects to the media database and find thumbnail path of the passed original image.
* If found, the thumbnail path will be returned, or starts to generate thumbnail
*
* @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
* Please refer 'media-thumb-error.h' to know the exact meaning of the error.
* @param[in] origin_path The path of the original image
* @param[out] thumb_path The path of generated thumbnail image.
* @param[in] max_length The max length of the returned thumbnail path.
* @see None.
* @pre None.
* @post None.
* @remark The database name is "/opt/dbspace/.media.db".
* @par example
* @code
#include <media-thumbnail.h>
void gen_thumbs()
{
int ret = MEDIA_THUMB_ERROR_NONE;
const char *origin_path = "/opt/media/test.jpg";
char thumb_path[255];
ret = thumbnail_request_from_db(origin_path, thumb_path, 255);
if (ret < 0)
{
printf( "thumbnail_request_from_db fails. error code->%d", ret);
}
return;
}
* @endcode
*/
int thumbnail_request_from_db(const char *origin_path, char *thumb_path, int max_length);
/**
* thumbnail_request_from_db_async:
* This function connects to the media database and find thumbnail path of the passed original image.
* If found, the thumbnail path will be returned through callback, which is registered by user.
*
* @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
* Please refer 'media-thumb-error.h' to know the exact meaning of the error.
* @param[in] origin_path The path of the original image
* @param[in] func The callback, which is registered by user
* @param[in] user_data User data, which is used by user in callback
* @see None.
* @pre None.
* @post None.
* @remark The database name is "/opt/dbspace/.media.db".
* @par example
* @code
#include <media-thumbnail.h>
int _thumb_cb(int error_code, char *path, void *user_data)
{
printf("Error code : %d\n", error_code);
printf("Thumb path : %s\n", path);
}
void gen_thumbs()
{
int ret = MEDIA_THUMB_ERROR_NONE;
const char *origin_path = "/opt/media/test.jpg";
char thumb_path[255];
ret = thumbnail_request_from_db_async(origin_path, _thumb_cb, NULL);
if (ret < 0)
{
printf( "thumbnail_request_from_db_async fails. error code->%d", ret);
}
return;
}
* @endcode
*/
int thumbnail_request_from_db_async(const char *origin_path, ThumbFunc func, void *user_data);
/**
* thumbnail_request_save_to_file:
* This function generates thumbnail of the original path and save it to the file system as jpeg format with the passed thumbnail path.
* This function doesn't care about media DB.
*
* @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
* Please refer 'media-thumb-error.h' to know the exact meaning of the error.
* @param[in] origin_path The path of the original image
* @param[in] thumb_type The type of the returned thumbnail data.
* @param[in] thumb_path The path of generated thumbnail image.
* @see None.
* @pre None.
* @post None.
* @par example
* @code
#include <media-thumbnail.h>
void save_thumbs()
{
int ret = MEDIA_THUMB_ERROR_NONE;
const char *origin_path = "/opt/media/test.jpg";
const char *thumb_path = "/my_dir/thumb.jpg";
ret = thumbnail_request_save_to_file(origin_path, thumb_path);
if (ret < 0) {
printf( "thumbnail_request_save_to_file fails. error code->%d", ret);
}
return;
}
* @endcode
*/
int thumbnail_request_save_to_file(const char *origin_path,
media_thumb_type thumb_type,
const char *thumb_path);
/**
* thumbnail_request_extract_all_thumbs:
* This function generates thumbnail of all media, which don't have thumbnail yet and save it to the file system as jpeg format.
* Once thumbnail generated, the thumbnail path and original image's width and height will be updated to media database.
*
* @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
* Please refer 'media-thumb-error.h' to know the exact meaning of the error.
* @see None.
* @pre None.
* @post None.
* @par example
* @code
#include <media-thumbnail.h>
void extract_all_thumbs()
{
int ret = MEDIA_THUMB_ERROR_NONE;
ret = thumbnail_request_extract_all_thumbs();
if (ret < 0) {
printf( "thumbnail_request_extract_all_thumbs fails. error code->%d", ret);
}
return;
}
* @endcode
*/
int thumbnail_request_extract_all_thumbs(void);
/** @} */
/**
@}
*/
#ifdef __cplusplus
}
#endif
#endif /*_MEDIA_THUMBNAIL_H_*/
|
