Remove unused parameter
[platform/core/multimedia/libmm-camcorder.git] / src / include / mm_camcorder_attribute.h
1 /*
2  * libmm-camcorder
3  *
4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
5  *
6  * Contact: Jeongmo Yang <jm80.yang@samsung.com>
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  *
20  */
21
22 #ifndef __MM_CAMCORDER_ATTRIBUTE_H__
23 #define __MM_CAMCORDER_ATTRIBUTE_H__
24
25 /*=======================================================================================
26 | INCLUDE FILES                                                                         |
27 ========================================================================================*/
28 #include <gst/gst.h>
29 #include <mm_types.h>
30 #include <stdarg.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 /*=======================================================================================
37 | GLOBAL DEFINITIONS AND DECLARATIONS FOR CAMCORDER                                     |
38 ========================================================================================*/
39 /* Disabled
40 #define GET_AND_STORE_ATTRS_AFTER_SCENE_MODE
41 */
42
43 /*=======================================================================================
44 | MACRO DEFINITIONS                                                                     |
45 ========================================================================================*/
46 /**
47  * Caster of attributes handle
48  */
49 #define MMF_CAMCORDER_ATTRS(h) (((mmf_camcorder_t *)(h))->attributes)
50
51 /*=======================================================================================
52 | ENUM DEFINITIONS                                                                      |
53 ========================================================================================*/
54 /**
55  * Enumerations for camcorder attribute ID.
56  */
57 typedef enum {
58         MM_CAM_MODE,                                    /* 0 */
59         MM_CAM_AUDIO_DEVICE,
60         MM_CAM_CAMERA_DEVICE_COUNT,
61         MM_CAM_AUDIO_ENCODER,
62         MM_CAM_VIDEO_ENCODER,
63         MM_CAM_IMAGE_ENCODER,
64         MM_CAM_FILE_FORMAT,
65         MM_CAM_CAMERA_DEVICE_NAME,
66         MM_CAM_AUDIO_SAMPLERATE,
67         MM_CAM_AUDIO_FORMAT,
68         MM_CAM_AUDIO_CHANNEL,                           /* 10 */
69         MM_CAM_AUDIO_VOLUME,
70         MM_CAM_AUDIO_INPUT_ROUTE,
71         MM_CAM_FILTER_SCENE_MODE,
72         MM_CAM_FILTER_BRIGHTNESS,
73         MM_CAM_FILTER_CONTRAST,
74         MM_CAM_FILTER_WB,
75         MM_CAM_FILTER_COLOR_TONE,
76         MM_CAM_FILTER_SATURATION,
77         MM_CAM_FILTER_HUE,
78         MM_CAM_FILTER_SHARPNESS,                        /* 20 */
79         MM_CAM_CAMERA_FORMAT,
80         MM_CAM_CAMERA_RECORDING_MOTION_RATE,
81         MM_CAM_CAMERA_FPS,
82         MM_CAM_CAMERA_WIDTH,
83         MM_CAM_CAMERA_HEIGHT,
84         MM_CAM_CAMERA_DIGITAL_ZOOM,
85         MM_CAM_CAMERA_OPTICAL_ZOOM,
86         MM_CAM_CAMERA_FOCUS_MODE,
87         MM_CAM_CAMERA_AF_SCAN_RANGE,
88         MM_CAM_CAMERA_EXPOSURE_MODE,                    /* 30 */
89         MM_CAM_CAMERA_EXPOSURE_VALUE,
90         MM_CAM_CAMERA_F_NUMBER,
91         MM_CAM_CAMERA_SHUTTER_SPEED,
92         MM_CAM_CAMERA_ISO,
93         MM_CAM_CAMERA_WDR,
94         MM_CAM_CAMERA_ANTI_HANDSHAKE,
95         MM_CAM_CAMERA_FPS_AUTO,
96         MM_CAM_CAMERA_DELAY_ATTR_SETTING,
97         MM_CAM_AUDIO_ENCODER_BITRATE,
98         MM_CAM_VIDEO_ENCODER_BITRATE,                   /* 40 */
99         MM_CAM_IMAGE_ENCODER_QUALITY,
100         MM_CAM_CAPTURE_FORMAT,
101         MM_CAM_CAPTURE_WIDTH,
102         MM_CAM_CAPTURE_HEIGHT,
103         MM_CAM_CAPTURE_COUNT,
104         MM_CAM_CAPTURE_INTERVAL,
105         MM_CAM_CAPTURE_BREAK_CONTINUOUS_SHOT,
106         MM_CAM_DISPLAY_HANDLE,
107         MM_CAM_DISPLAY_DEVICE,
108         MM_CAM_DISPLAY_SURFACE,                         /* 50 */
109         MM_CAM_DISPLAY_RECT_X,
110         MM_CAM_DISPLAY_RECT_Y,
111         MM_CAM_DISPLAY_RECT_WIDTH,
112         MM_CAM_DISPLAY_RECT_HEIGHT,
113         MM_CAM_DISPLAY_SOURCE_X,
114         MM_CAM_DISPLAY_SOURCE_Y,
115         MM_CAM_DISPLAY_SOURCE_WIDTH,
116         MM_CAM_DISPLAY_SOURCE_HEIGHT,
117         MM_CAM_DISPLAY_ROTATION,
118         MM_CAM_DISPLAY_VISIBLE,                         /* 60 */
119         MM_CAM_DISPLAY_SCALE,
120         MM_CAM_DISPLAY_GEOMETRY_METHOD,
121         MM_CAM_TARGET_FILENAME,
122         MM_CAM_TARGET_MAX_SIZE,
123         MM_CAM_TARGET_TIME_LIMIT,
124         MM_CAM_TAG_ENABLE,
125         MM_CAM_TAG_IMAGE_DESCRIPTION,
126         MM_CAM_TAG_ORIENTATION,
127         MM_CAM_TAG_SOFTWARE,
128         MM_CAM_TAG_LATITUDE,                            /* 70 */
129         MM_CAM_TAG_LONGITUDE,
130         MM_CAM_TAG_ALTITUDE,
131         MM_CAM_STROBE_CONTROL,
132         MM_CAM_STROBE_CAPABILITIES,
133         MM_CAM_STROBE_MODE,
134         MM_CAM_DETECT_MODE,
135         MM_CAM_DETECT_NUMBER,
136         MM_CAM_DETECT_FOCUS_SELECT,
137         MM_CAM_DETECT_SELECT_NUMBER,
138         MM_CAM_DETECT_STATUS,                           /* 80 */
139         MM_CAM_CAPTURE_ZERO_SYSTEMLAG,
140         MM_CAM_CAMERA_AF_TOUCH_X,
141         MM_CAM_CAMERA_AF_TOUCH_Y,
142         MM_CAM_CAMERA_AF_TOUCH_WIDTH,
143         MM_CAM_CAMERA_AF_TOUCH_HEIGHT,
144         MM_CAM_CAMERA_FOCAL_LENGTH,
145         MM_CAM_RECOMMEND_PREVIEW_FORMAT_FOR_CAPTURE,
146         MM_CAM_RECOMMEND_PREVIEW_FORMAT_FOR_RECORDING,
147         MM_CAM_TAG_GPS_ENABLE,
148         MM_CAM_TAG_GPS_TIME_STAMP,                      /* 90 */
149         MM_CAM_TAG_GPS_DATE_STAMP,
150         MM_CAM_TAG_GPS_PROCESSING_METHOD,
151         MM_CAM_CAMERA_ROTATION,
152         MM_CAM_CAPTURED_SCREENNAIL,
153         MM_CAM_CAPTURE_SOUND_ENABLE,
154         MM_CAM_RECOMMEND_DISPLAY_ROTATION,
155         MM_CAM_CAMERA_FLIP,
156         MM_CAM_CAMERA_HDR_CAPTURE,
157         MM_CAM_DISPLAY_MODE,
158         MM_CAM_AUDIO_DISABLE,                           /* 100 */
159         MM_CAM_RECOMMEND_CAMERA_WIDTH,
160         MM_CAM_RECOMMEND_CAMERA_HEIGHT,
161         MM_CAM_CAPTURED_EXIF_RAW_DATA,
162         MM_CAM_DISPLAY_EVAS_SURFACE_SINK,
163         MM_CAM_DISPLAY_EVAS_DO_SCALING,
164         MM_CAM_CAMERA_FACING_DIRECTION,
165         MM_CAM_DISPLAY_FLIP,
166         MM_CAM_CAMERA_VIDEO_STABILIZATION,
167         MM_CAM_TAG_VIDEO_ORIENTATION,
168         MM_CAM_CAMERA_PAN_MECHA,                        /* 110 */
169         MM_CAM_CAMERA_PAN_ELEC,
170         MM_CAM_CAMERA_TILT_MECHA,
171         MM_CAM_CAMERA_TILT_ELEC,
172         MM_CAM_CAMERA_PTZ_TYPE,
173         MM_CAM_VIDEO_WIDTH,
174         MM_CAM_VIDEO_HEIGHT,
175         MM_CAM_SUPPORT_ZSL_CAPTURE,
176         MM_CAM_SUPPORT_ZERO_COPY_FORMAT,
177         MM_CAM_SUPPORT_MEDIA_PACKET_PREVIEW_CB,
178         MM_CAM_ENCODED_PREVIEW_BITRATE,         /* 120 */
179         MM_CAM_ENCODED_PREVIEW_GOP_INTERVAL,
180         MM_CAM_RECORDER_TAG_ENABLE,
181         MM_CAM_DISPLAY_SOCKET_PATH,
182         MM_CAM_CLIENT_PID,
183         MM_CAM_ROOT_DIRECTORY,
184         MM_CAM_SOUND_STREAM_INDEX,
185         MM_CAM_SOUND_STREAM_TYPE,
186         MM_CAM_DISPLAY_REUSE_HINT,
187         MM_CAM_DISPLAY_REUSE_ELEMENT,
188         MM_CAM_GDBUS_CONNECTION,                        /* 130 */
189         MM_CAM_AUDIO_REPLAY_GAIN_ENABLE,
190         MM_CAM_AUDIO_REPLAY_GAIN_REFERENCE_LEVEL,
191         MM_CAM_ATTRIBUTE_NUM
192 } MMCamcorderAttrsID;
193
194 /*=======================================================================================
195 | TYPE DEFINITIONS                                                                      |
196 ========================================================================================*/
197 typedef bool (*mmf_cam_commit_func_t)(MMHandleType handle, int attr_idx, const mmf_value_t *value);
198
199 /*=======================================================================================
200 | STRUCTURE DEFINITIONS                                                                 |
201 ========================================================================================*/
202 typedef struct {
203         MMCamcorderAttrsID attrid;
204         char *name;
205         int value_type;
206         int flags;
207         union {
208                 void *value_void;
209                 char *value_string;
210                 int value_int;
211                 double value_double;
212         } default_value;              /* default value */
213         MMCamAttrsValidType validity_type;
214         union {
215                 int *int_array;
216                 int int_min;
217                 double *double_array;
218                 double double_min;
219         } validity_value_1;
220         union {
221                 int int_max;
222                 double double_max;
223                 int count;
224         } validity_value_2;
225         mmf_cam_commit_func_t attr_commit;
226 } mm_cam_attr_construct_info;
227
228 /*=======================================================================================
229 | CONSTANT DEFINITIONS                                                                  |
230 ========================================================================================*/
231
232 /*=======================================================================================
233 | STATIC VARIABLES                                                                      |
234 ========================================================================================*/
235
236 /*=======================================================================================
237 | EXTERN GLOBAL VARIABLE                                                                |
238 ========================================================================================*/
239
240 /*=======================================================================================
241 | GLOBAL FUNCTION PROTOTYPES                                                            |
242 ========================================================================================*/
243 /**
244  * This function allocates structure of attributes and sets initial values.
245  *
246  * @param[in]   handle          Handle of camcorder.
247  * @param[in]   info            Preset information of camcorder.
248  * @return      This function returns allocated structure of attributes.
249  * @remarks
250  * @see         _mmcamcorder_dealloc_attribute()
251  *
252  */
253 MMHandleType _mmcamcorder_alloc_attribute(MMHandleType handle);
254
255 /**
256  * This function release structure of attributes.
257  *
258  * @param[in]   handle          Handle of camcorder.
259  * @param[in]   attrs           Handle of camcorder attribute.
260  * @return      void
261  * @remarks
262  * @see         _mmcamcorder_alloc_attribute()
263  *
264  */
265 void _mmcamcorder_dealloc_attribute(MMHandleType handle, MMHandleType attrs);
266
267 /**
268  * This is a meta  function to get attributes of camcorder with given attribute names.
269  *
270  * @param[in]   handle          Handle of camcorder.
271  * @param[out]  err_attr_name   Specifies the name of attributes that made an error. If the function doesn't make an error, this will be null.
272  * @param[in]   attribute_name  attribute name that user want to get.
273  * @param[in]   var_args        Specifies variable arguments.
274  * @return      This function returns MM_ERROR_NONE on Success, minus on Failure.
275  * @remarks     You can retrieve multiple attributes at the same time.  @n
276  * @see         _mmcamcorder_set_attributes
277  */
278 int _mmcamcorder_get_attributes(MMHandleType handle, char **err_attr_name, const char *attribute_name, va_list var_args);
279
280
281 /**
282  * This is a meta  function to set attributes of camcorder with given attribute names.
283  *
284  * @param[in]   handle          Handle of camcorder.
285  * @param[out]  err_attr_name   Specifies the name of attributes that made an error. If the function doesn't make an error, this will be null.
286  * @param[in]   attribute_name  attribute name that user want to set.
287  * @param[in]   var_args        Specifies variable arguments.
288  * @return      This function returns MM_ERROR_NONE on Success, minus on Failure.
289  * @remarks     You can put multiple attributes to camcorder at the same time.  @n
290  * @see         _mmcamcorder_get_attributes
291  */
292 int _mmcamcorder_set_attributes(MMHandleType handle, char **err_attr_name, const char *attribute_name, va_list var_args);
293
294
295 /**
296  * This is a meta  function to get detail information of the attribute.
297  *
298  * @param[in]   handle          Handle of camcorder.
299  * @param[in]   attr_name       attribute name that user want to get information.
300  * @param[out]  info            a structure that holds information related with the attribute.
301  * @return      This function returns MM_ERROR_NONE on Success, minus on Failure.
302  * @remarks     If the function succeeds, 'info' holds detail information about the attribute, such as type, flag, validity_type, validity_values  @n
303  * @see         _mmcamcorder_get_attributes, _mmcamcorder_set_attributes
304  */
305 int _mmcamcorder_get_attribute_info(MMHandleType handle, const char *attr_name, MMCamAttrsInfo *info);
306
307 /*=======================================================================================
308 | CAMCORDER INTERNAL LOCAL                                                              |
309 ========================================================================================*/
310 /**
311  * A commit function to set camcorder attributes
312  * If the attribute needs actual setting, this function handles that activity.
313  * When application sets an attribute, setting function in MSL common calls this function.
314  * If this function fails, original value will not change.
315  *
316  * @param[in]   attr_idx        Attribute index of subcategory.
317  * @param[in]   attr_name       Attribute name.
318  * @param[in]   value           Handle of camcorder.
319  * @param[in]   commit_param    Allocation type of camcorder context.
320  * @return      This function returns TRUE on success, or FALSE on failure
321  * @remarks
322  * @see
323  *
324  */
325 bool _mmcamcorder_commit_camcorder_attrs(int attr_idx, const char *attr_name, const mmf_value_t *value, void *commit_param);
326
327 /**
328  * A commit function to set videosource attribute
329  * If the attribute needs actual setting, this function handles that activity.
330  * When application sets an attribute, setting function in MSL common calls this function.
331  * If this function fails, original value will not change.
332  *
333  * @param[in]   attr_idx        Attribute index of subcategory.
334  * @param[in]   attr_name       Attribute name.
335  * @param[in]   value           Handle of camcorder.
336  * @param[in]   commit_param    Allocation type of camcorder context.
337  * @return      This function returns TRUE on success, or FALSE on failure
338  * @remarks
339  * @see
340  *
341  */
342 bool _mmcamcorder_commit_capture_width(MMHandleType handle, int attr_idx, const mmf_value_t *value);
343 bool _mmcamcorder_commit_capture_height(MMHandleType handle, int attr_idx, const mmf_value_t *value);
344 bool _mmcamcorder_commit_capture_break_cont_shot(MMHandleType handle, int attr_idx, const mmf_value_t *value);
345 bool _mmcamcorder_commit_capture_count(MMHandleType handle, int attr_idx, const mmf_value_t *value);
346 bool _mmcamcorder_commit_capture_sound_enable(MMHandleType handle, int attr_idx, const mmf_value_t *value);
347 bool _mmcamcorder_commit_audio_volume(MMHandleType handle, int attr_idx, const mmf_value_t *value);
348 bool _mmcamcorder_commit_audio_input_route(MMHandleType handle, int attr_idx, const mmf_value_t *value);
349 bool _mmcamcorder_commit_audio_disable(MMHandleType handle, int attr_idx, const mmf_value_t *value);
350 bool _mmcamcorder_commit_camera_format(MMHandleType handle, int attr_idx, const mmf_value_t *value);
351 bool _mmcamcorder_commit_camera_fps(MMHandleType handle, int attr_idx, const mmf_value_t *value);
352 bool _mmcamcorder_commit_camera_recording_motion_rate(MMHandleType handle, int attr_idx, const mmf_value_t *value);
353 bool _mmcamcorder_commit_camera_width(MMHandleType handle, int attr_idx, const mmf_value_t *value);
354 bool _mmcamcorder_commit_camera_height(MMHandleType handle, int attr_idx, const mmf_value_t *value);
355 bool _mmcamcorder_commit_video_size(MMHandleType handle, int attr_idx, const mmf_value_t *value);
356 bool _mmcamcorder_commit_camera_zoom(MMHandleType handle, int attr_idx, const mmf_value_t *value);
357 bool _mmcamcorder_commit_camera_ptz_type(MMHandleType handle, int attr_idx, const mmf_value_t *value);
358 bool _mmcamcorder_commit_camera_pan(MMHandleType handle, int attr_idx, const mmf_value_t *value);
359 bool _mmcamcorder_commit_camera_tilt(MMHandleType handle, int attr_idx, const mmf_value_t *value);
360 bool _mmcamcorder_commit_camera_focus_mode(MMHandleType handle, int attr_idx, const mmf_value_t *value);
361 bool _mmcamcorder_commit_camera_af_scan_range(MMHandleType handle, int attr_idx, const mmf_value_t *value);
362 bool _mmcamcorder_commit_camera_af_touch_area(MMHandleType handle, int attr_idx, const mmf_value_t *value);
363 bool _mmcamcorder_commit_camera_capture_mode(MMHandleType handle, int attr_idx, const mmf_value_t *value);
364 bool _mmcamcorder_commit_camera_wdr(MMHandleType handle, int attr_idx, const mmf_value_t *value);
365 bool _mmcamcorder_commit_camera_anti_handshake(MMHandleType handle, int attr_idx, const mmf_value_t *value);
366 bool _mmcamcorder_commit_camera_video_stabilization(MMHandleType handle, int attr_idx, const mmf_value_t *value);
367 bool _mmcamcorder_commit_camera_rotate(MMHandleType handle, int attr_idx, const mmf_value_t *value);
368 bool _mmcamcorder_commit_image_encoder_quality(MMHandleType handle, int attr_idx, const mmf_value_t *value);
369 bool _mmcamcorder_commit_target_filename(MMHandleType handle, int attr_idx, const mmf_value_t *value);
370 bool _mmcamcorder_commit_encoder_bitrate(MMHandleType handle, int attr_idx, const mmf_value_t *value);
371 bool _mmcamcorder_commit_recording_max_limit(MMHandleType handle, int attr_idx, const mmf_value_t *value);
372 bool _mmcamcorder_commit_filter(MMHandleType handle, int attr_idx, const mmf_value_t *value);
373 bool _mmcamcorder_commit_filter_scene_mode(MMHandleType handle, int attr_idx, const mmf_value_t *value);
374 bool _mmcamcorder_commit_filter_flip(MMHandleType handle, int attr_idx, const mmf_value_t *value);
375 bool _mmcamcorder_commit_display_handle(MMHandleType handle, int attr_idx, const mmf_value_t *value);
376 bool _mmcamcorder_commit_display_mode(MMHandleType handle, int attr_idx, const mmf_value_t *value);
377 bool _mmcamcorder_commit_display_rotation(MMHandleType handle, int attr_idx, const mmf_value_t *value);
378 bool _mmcamcorder_commit_display_flip(MMHandleType handle, int attr_idx, const mmf_value_t *value);
379 bool _mmcamcorder_commit_display_visible(MMHandleType handle, int attr_idx, const mmf_value_t *value);
380 bool _mmcamcorder_commit_display_geometry_method(MMHandleType handle, int attr_idx, const mmf_value_t *value);
381 bool _mmcamcorder_commit_display_rect(MMHandleType handle, int attr_idx, const mmf_value_t *value);
382 bool _mmcamcorder_commit_display_scale(MMHandleType handle, int attr_idx, const mmf_value_t *value);
383 bool _mmcamcorder_commit_display_evas_do_scaling(MMHandleType handle, int attr_idx, const mmf_value_t *value);
384 bool _mmcamcorder_commit_strobe(MMHandleType handle, int attr_idx, const mmf_value_t *value);
385 bool _mmcamcorder_commit_detect(MMHandleType handle, int attr_idx, const mmf_value_t *value);
386 bool _mmcamcorder_commit_camera_flip(MMHandleType handle, int attr_idx, const mmf_value_t *value);
387 bool _mmcamcorder_commit_camera_hdr_capture(MMHandleType handle, int attr_idx, const mmf_value_t *value);
388 bool _mmcamcorder_commit_encoded_preview_bitrate(MMHandleType handle, int attr_idx, const mmf_value_t *value);
389 bool _mmcamcorder_commit_encoded_preview_gop_interval(MMHandleType handle, int attr_idx, const mmf_value_t *value);
390 bool _mmcamcorder_commit_sound_stream_info(MMHandleType handle, int attr_idx, const mmf_value_t *value);
391 bool _mmcamcorder_commit_tag(MMHandleType handle, int attr_idx, const mmf_value_t *value);
392 bool _mmcamcorder_commit_audio_replay_gain(MMHandleType handle, int attr_idx, const mmf_value_t *value);
393
394
395 /**
396  * This function initialize effect setting.
397  *
398  * @param[in]   handle          Handle of camcorder.
399  * @return      bool            Success on TRUE or return FALSE
400  */
401 bool _mmcamcorder_set_attribute_to_camsensor(MMHandleType handle);
402 bool _mmcamcorder_set_attribute_to_camsensor2(MMHandleType handle);
403
404 /**
405  * This function removes writable flag from pre-defined attributes.
406  *
407  * @param[in]   handle          Handle of camcorder.
408  * @return      int             Success on MM_ERROR_NONE or return ERROR with error code
409  */
410 int _mmcamcorder_lock_readonly_attributes(MMHandleType handle);
411
412 /**
413  * This function disable pre-defined attributes.
414  *
415  * @param[in]   handle          Handle of camcorder.
416  * @return      int             Success on MM_ERROR_NONE or return ERROR with error code
417  */
418 int _mmcamcorder_set_disabled_attributes(MMHandleType handle);
419
420 /**
421  * check whether supported or not
422  *
423  * @param[in]   handle          Handle of camcorder.
424  * @param[in]   attr_index      index of attribute to check.
425  * @return      bool            TRUE if supported or FALSE
426  */
427 bool _mmcamcorder_check_supported_attribute(MMHandleType handle, int attr_index);
428
429 #ifdef __cplusplus
430 }
431 #endif
432
433 #endif /* __MM_CAMCORDER_ATTRIBUTE_H__ */