10f589cf1f04280c11e51918ffb4d36da6ae41b5
[platform/core/multimedia/libmm-camcorder.git] / src / include / mm_camcorder.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 /**
23         @addtogroup CAMCORDER
24         @{
25
26         @par
27         This part describes the APIs with repect to Multimedia Camcorder.
28         Camcorder is for recording audio and video from audio and video input devices, capturing
29         still image from video input device, and audio recording from audio input
30         device.
31
32         @par
33         Camcorder can be reached by calling functions as shown in the following
34         figure, "The State of Camcorder".
35
36         @par
37         @image html     camcorder_state.png     "The State of Camcorder"        width=12cm
38         @image latex    camcorder_state.png     "The State of Camcorder"        width=12cm
39
40         @par
41         Between each states there is intermediate state, and in this state,
42         any function call which change the camcorder state will be failed.
43
44         @par
45         Recording state and paused state exists when the mode of camcorder is
46         video-capture or audio-capture mode. In case of image-capture mode, CAPTURING state will 
47         exsit.
48
49         @par
50 <div>
51 <table>
52         <tr>
53                 <td>FUNCTION</td>
54                 <td>PRE-STATE</td>
55                 <td>POST-STATE</td>
56                 <td>SYNC TYPE</td>
57         </tr>
58         <tr>
59                 <td>mm_camcorder_create()</td>
60                 <td>NONE</td>
61                 <td>NULL</td>
62                 <td>SYNC</td>
63         </tr>
64         <tr>
65                 <td>mm_camcorder_destroy()</td>
66                 <td>NULL</td>
67                 <td>NONE</td>
68                 <td>SYNC</td>
69         </tr>
70         <tr>
71                 <td>mm_camcorder_realize()</td>
72                 <td>NULL</td>
73                 <td>READY</td>
74                 <td>SYNC</td>
75         </tr>
76         <tr>
77                 <td>mm_camcorder_unrealize()</td>
78                 <td>READY</td>
79                 <td>NULL</td>
80                 <td>SYNC</td>
81         </tr>
82         <tr>
83                 <td>mm_camcorder_start()</td>
84                 <td>READY</td>
85                 <td>PREPARED</td>
86                 <td>SYNC</td>
87         </tr>
88         <tr>
89                 <td>mm_camcorder_stop()</td>
90                 <td>PREPARED</td>
91                 <td>READY</td>
92                 <td>SYNC</td>
93         </tr>
94         <tr>
95                 <td>mm_camcorder_capture_start()</td>
96                 <td>PREPARED</td>
97                 <td>CAPTURING</td>
98                 <td>SYNC</td>
99         </tr>
100         <tr>
101                 <td>mm_camcorder_capture_stop()</td>
102                 <td>CAPTURING</td>
103                 <td>PREPARED</td>
104                 <td>SYNC</td>
105         </tr>
106         <tr>
107                 <td>mm_camcorder_record()</td>
108                 <td>PREPARED/PAUSED</td>
109                 <td>RECORDING</td>
110                 <td>SYNC</td>
111         </tr>
112         <tr>
113                 <td>mm_camcorder_pause()</td>
114                 <td>RECORDING</td>
115                 <td>PAUSED</td>
116                 <td>SYNC</td>
117         </tr>
118         <tr>
119                 <td>mm_camcorder_commit()</td>
120                 <td>RECORDING/PAUSED</td>
121                 <td>PREPARED</td>
122                 <td>SYNC</td>
123         </tr>
124         <tr>
125                 <td>mm_camcorder_cancel()</td>
126                 <td>RECORDING/PAUSED</td>
127                 <td>PREPARED</td>
128                 <td>SYNC</td>
129         </tr>
130         <tr>
131                 <td>mm_camcorder_set_message_callback()</td>
132                 <td>N/A</td>
133                 <td>N/A</td>
134                 <td>SYNC</td>
135         </tr>
136         <tr>
137                 <td>mm_camcorder_set_video_stream_callback()</td>
138                 <td>N/A</td>
139                 <td>N/A</td>
140                 <td>SYNC</td>
141         </tr>
142         <tr>
143                 <td>mm_camcorder_set_video_capture_callback()</td>
144                 <td>N/A</td>
145                 <td>N/A</td>
146                 <td>SYNC</td>
147         </tr>
148         <tr>
149                 <td>mm_camcorder_get_state()</td>
150                 <td>N/A</td>
151                 <td>N/A</td>
152                 <td>SYNC</td>
153         </tr>
154         <tr>
155                 <td>mm_camcorder_get_attributes()</td>
156                 <td>N/A</td>
157                 <td>N/A</td>
158                 <td>SYNC</td>
159         </tr>
160         <tr>
161                 <td>mm_camcorder_set_attributes()</td>
162                 <td>N/A</td>
163                 <td>N/A</td>
164                 <td>SYNC</td>
165         </tr>
166         <tr>
167                 <td>mm_camcorder_get_attribute_info()</td>
168                 <td>N/A</td>
169                 <td>N/A</td>
170                 <td>SYNC</td>
171         </tr>
172         <tr>
173                 <td>mm_camcorder_init_focusing()</td>
174                 <td>N/A</td>
175                 <td>N/A</td>
176                 <td>SYNC</td>
177         </tr>
178         <tr>
179                 <td>mm_camcorder_start_focusing()</td>
180                 <td>N/A</td>
181                 <td>N/A</td>
182                 <td>SYNC</td>
183         </tr>
184         <tr>
185                 <td>mm_camcorder_stop_focusing()</td>
186                 <td>N/A</td>
187                 <td>N/A</td>
188                 <td>SYNC</td>
189         </tr>
190 </table>
191 </div>
192
193         @par
194         * Attribute @n
195         Attribute system is an interface to operate camcorder. Depending on each attribute, camcorder behaves differently.
196         Attribute system provides get/set functions. Setting proper attributes, a user can control camcorder as he want. (mm_camcorder_set_attributes())
197         Also, a user can comprehend current status of the camcorder, calling getter function(mm_camcorder_get_attributes()).
198         Beware, arguments of mm_camcorder_set_attributes() and mm_camcorder_get_attributes() should be finished with 'NULL'.
199         This is a rule for the variable argument.
200         @par
201         Besides its value, each Attribute also has 'type' and 'validity type'. 'type' describes variable type that the attribute can get.
202         If you input a value that has wrong type, camcorder will not work properly or be crashed. 'validity' describes array or
203         range of values that are able to set to the attribute. 'validity type' defines type of the 'validity'.
204         @par
205         A user can retrieve these values using mm_camcorder_get_attribute_info().
206         Following tables have 'Attribute name', 'Attribute macro', 'Type', and 'Validity type'. You can refer '#MMCamAttrsType' and '#MMCamAttrsValidType'
207         for discerning 'Type' and 'Validity type'.
208
209
210         @par
211         Following are the attributes which should be set before initialization (#mm_camcorder_realize):
212
213         @par
214 <div>
215 <table>
216         <tr>
217                 <td><center><b>Attribute</b></center></td>
218                 <td><center><b>Description</b></center></td>
219         </tr>
220         <tr>
221                 <td>#MMCAM_MODE</td>
222                 <td>Mode of camcorder ( still/video/audio )</td>
223         </tr>
224         <tr>
225                 <td>#MMCAM_AUDIO_DEVICE</td>
226                 <td>Audio device ID for capturing audio stream</td>
227         </tr>
228         <tr>
229                 <td>#MMCAM_CAMERA_DEVICE_COUNT</td>
230                 <td>Video device count</td>
231         </tr>
232         <tr>
233                 <td>#MMCAM_AUDIO_ENCODER</td>
234                 <td>Audio codec for encoding audio stream</td>
235         </tr>
236         <tr>
237                 <td>#MMCAM_VIDEO_ENCODER</td>
238                 <td>Video codec for encoding video stream</td>
239         </tr>
240         <tr>
241                 <td>#MMCAM_IMAGE_ENCODER</td>
242                 <td>Image codec for capturing still-image</td>
243         </tr>
244         <tr>
245                 <td>#MMCAM_FILE_FORMAT</td>
246                 <td>File format for recording media stream</td>
247         </tr>
248         <tr>
249                 <td>#MMCAM_AUDIO_SAMPLERATE</td>
250                 <td>Sampling rate of audio stream ( This is an integer field )</td>
251         </tr>
252         <tr>
253                 <td>#MMCAM_AUDIO_FORMAT</td>
254                 <td>Audio format of each sample</td>
255         </tr>
256         <tr>
257                 <td>#MMCAM_AUDIO_CHANNEL</td>
258                 <td>Channels of each sample ( This is an integer field )</td>
259         </tr>
260         <tr>
261                 <td>#MMCAM_AUDIO_INPUT_ROUTE(deprecated)</td>
262                 <td>Set audio input route</td>
263         </tr>
264         <tr>
265                 <td>#MMCAM_CAMERA_FORMAT</td>
266                 <td>Format of video stream. This is an integer field</td>
267         </tr>
268         <tr>
269                 <td>#MMCAM_CAMERA_FPS</td>
270                 <td>Frames per second ( This is an integer field )</td>
271         </tr>
272         <tr>
273                 <td>#MMCAM_CAMERA_WIDTH</td>
274                 <td>Width of input video stream</td>
275         </tr>
276         <tr>
277                 <td>#MMCAM_CAMERA_HEIGHT</td>
278                 <td>Height of input video stream</td>
279         </tr>
280         <tr>
281                 <td>#MMCAM_CAMERA_FPS_AUTO</td>
282                 <td>FPS Auto. When you set true to this attribute, FPS will vary depending on the amount of the light.</td>
283         </tr>
284         <tr>
285                 <td>#MMCAM_DISPLAY_HANDLE</td>
286                 <td>Pointer of display buffer or ID of xwindow</td>
287         </tr>
288         <tr>
289                 <td>#MMCAM_DISPLAY_DEVICE</td>
290                 <td>Device of display</td>
291         </tr>
292         <tr>
293                 <td>#MMCAM_DISPLAY_SURFACE</td>
294                 <td>Surface of display</td>
295         </tr>
296         <tr>
297                 <td>#MMCAM_DISPLAY_SOURCE_X</td>
298                 <td>X position of source rectangle. When you want to crop the source, you can set the area with this value.</td>
299         </tr>
300         <tr>
301                 <td>#MMCAM_DISPLAY_SOURCE_Y</td>
302                 <td>Y position of source rectangle. When you want to crop the source, you can set the area with this value.</td>
303         </tr>
304         <tr>
305                 <td>#MMCAM_DISPLAY_SOURCE_WIDTH</td>
306                 <td>Width of source rectangle. When you want to crop the source, you can set the area with this value.</td>
307         </tr>
308         <tr>
309                 <td>#MMCAM_DISPLAY_SOURCE_HEIGHT</td>
310                 <td>Height of source rectangle. When you want to crop the source, you can set the area with this value.</td>
311         </tr>
312         <tr>
313                 <td>#MMCAM_DISPLAY_ROTATION</td>
314                 <td>Rotation of display</td>
315         </tr>
316         <tr>
317                 <td>#MMCAM_DISPLAY_VISIBLE</td>
318                 <td>Visible of display</td>
319         </tr>
320         <tr>
321                 <td>#MMCAM_DISPLAY_SCALE</td>
322                 <td>A scale of displayed image</td>
323         </tr>
324         <tr>
325                 <td>#MMCAM_DISPLAY_GEOMETRY_METHOD</td>
326                 <td>A method that describes a form of geometry for display</td>
327         </tr>
328 </table>
329 </div>
330
331         @par
332         Following are the attributes which should be set before recording (mm_camcorder_record()):
333
334         @par
335 <div>
336 <table>
337         <tr>
338                 <td><center><b>Attribute</b></center></td>
339                 <td><center><b>Description</b></center></td>
340         </tr>
341         <tr>
342                 <td>#MMCAM_AUDIO_ENCODER_BITRATE</td>
343                 <td>Bitrate of Audio Encoder</td>
344         </tr>
345         <tr>
346                 <td>#MMCAM_VIDEO_ENCODER_BITRATE</td>
347                 <td>Bitrate of Video Encoder</td>
348         </tr>
349         <tr>
350                 <td>#MMCAM_TARGET_FILENAME</td>
351                 <td>Target filename. Only used in Audio/Video recording. This is not used for capturing.</td>
352         </tr>
353         <tr>
354                 <td>#MMCAM_TARGET_MAX_SIZE</td>
355                 <td>Maximum size of recording file(Kbyte). If the size of file reaches this value.</td>
356         </tr>
357         <tr>
358                 <td>#MMCAM_TARGET_TIME_LIMIT</td>
359                 <td>Time limit of recording file. If the elapsed time of recording reaches this value.</td>
360         </tr>
361 </table>
362 </div>
363
364         @par
365         Following are the attributes which should be set before capturing (mm_camcorder_capture_start()):
366
367         @par
368 <div>
369 <table>
370         <tr>
371                 <td><center><b>Attribute</b></center></td>
372                 <td><center><b>Description</b></center></td>
373         </tr>
374         <tr>
375                 <td>#MMCAM_IMAGE_ENCODER_QUALITY</td>
376                 <td>Encoding quality of Image codec</td>
377         </tr>
378         <tr>
379                 <td>#MMCAM_CAPTURE_FORMAT</td>
380                 <td>Pixel format that you want to capture</td>
381         </tr>
382         <tr>
383                 <td>#MMCAM_CAPTURE_WIDTH</td>
384                 <td>Width of the image that you want to capture</td>
385         </tr>
386         <tr>
387                 <td>#MMCAM_CAPTURE_HEIGHT</td>
388                 <td>Height of the image that you want to capture</td>
389         </tr>
390         <tr>
391                 <td>#MMCAM_CAPTURE_COUNT</td>
392                 <td>Total count of capturing</td>
393         </tr>
394         <tr>
395                 <td>#MMCAM_CAPTURE_INTERVAL</td>
396                 <td>Interval between each capturing on Multishot ( MMCAM_CAPTURE_COUNT > 1 )</td>
397         </tr>
398 </table>
399 </div>
400
401         @par
402         Following are the attributes which can be set anytime:
403
404         @par
405 <div>
406 <table>
407         <tr>
408                 <td><center><b>Attribute</b></center></td>
409                 <td><center><b>Description</b></center></td>
410         </tr>
411         <tr>
412                 <td>#MMCAM_AUDIO_VOLUME</td>
413                 <td>Input volume of audio source ( double value )</td>
414         </tr>
415         <tr>
416                 <td>#MMCAM_CAMERA_DIGITAL_ZOOM</td>
417                 <td>Digital zoom level</td>
418         </tr>
419         <tr>
420                 <td>#MMCAM_CAMERA_OPTICAL_ZOOM</td>
421                 <td>Optical zoom level</td>
422         </tr>
423         <tr>
424                 <td>#MMCAM_CAMERA_FOCUS_MODE</td>
425                 <td>Focus mode</td>
426         </tr>
427         <tr>
428                 <td>#MMCAM_CAMERA_AF_SCAN_RANGE</td>
429                 <td>AF Scan range</td>
430         </tr>
431         <tr>
432                 <td>#MMCAM_CAMERA_AF_TOUCH_X</td>
433                 <td>X coordinate of touching position</td>
434         </tr>
435         <tr>
436                 <td>#MMCAM_CAMERA_AF_TOUCH_Y</td>
437                 <td>Y coordinate of touching position</td>
438         </tr>
439         <tr>
440                 <td>#MMCAM_CAMERA_AF_TOUCH_WIDTH</td>
441                 <td>Width of touching area</td>
442         </tr>
443         <tr>
444                 <td>#MMCAM_CAMERA_AF_TOUCH_HEIGHT</td>
445                 <td>Height of touching area</td>
446         </tr>
447         <tr>
448                 <td>#MMCAM_CAMERA_EXPOSURE_MODE</td>
449                 <td>Exposure mode</td>
450         </tr>
451         <tr>
452                 <td>#MMCAM_CAMERA_EXPOSURE_VALUE</td>
453                 <td>Exposure value</td>
454         </tr>
455         <tr>
456                 <td>#MMCAM_CAMERA_F_NUMBER</td>
457                 <td>f number of camera</td>
458         </tr>
459         <tr>
460                 <td>#MMCAM_CAMERA_SHUTTER_SPEED</td>
461                 <td>Shutter speed</td>
462         </tr>
463         <tr>
464                 <td>#MMCAM_CAMERA_ISO</td>
465                 <td>ISO of capturing image</td>
466         </tr>
467         <tr>
468                 <td>#MMCAM_CAMERA_WDR</td>
469                 <td>Wide dynamic range</td>
470         </tr>
471         <tr>
472                 <td>#MMCAM_CAMERA_ANTI_HANDSHAKE</td>
473                 <td>Anti Handshake</td>
474         </tr>
475         <tr>
476                 <td>#MMCAM_CAMERA_FOCAL_LENGTH</td>
477                 <td>Focal length of camera lens</td>
478         </tr>
479         <tr>
480                 <td>#MMCAM_FILTER_BRIGHTNESS</td>
481                 <td>Brightness level</td>
482         </tr>
483         <tr>
484                 <td>#MMCAM_FILTER_CONTRAST</td>
485                 <td>Contrast level</td>
486         </tr>
487         <tr>
488                 <td>#MMCAM_FILTER_WB</td>
489                 <td>White balance</td>
490         </tr>
491         <tr>
492                 <td>#MMCAM_FILTER_COLOR_TONE</td>
493                 <td>Color tone (Color effect)</td>
494         </tr>
495         <tr>
496                 <td>#MMCAM_FILTER_SCENE_MODE</td>
497                 <td>Scene mode (Program mode)</td>
498         </tr>
499         <tr>
500                 <td>#MMCAM_FILTER_SATURATION</td>
501                 <td>Saturation level</td>
502         </tr>
503         <tr>
504                 <td>#MMCAM_FILTER_HUE</td>
505                 <td>Hue level</td>
506         </tr>
507         <tr>
508                 <td>#MMCAM_FILTER_SHARPNESS</td>
509                 <td>Sharpness level</td>
510         </tr>
511         <tr>
512                 <td>#MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT</td>
513                 <td>Set this as true when you want to stop multishot immediately</td>
514         </tr>
515         <tr>
516                 <td>#MMCAM_DISPLAY_RECT_X</td>
517                 <td>X position of display rectangle (This is only available when MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI)</td>
518         </tr>
519         <tr>
520                 <td>#MMCAM_DISPLAY_RECT_Y</td>
521                 <td>Y position of display rectangle (This is only available when MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI)</td>
522         </tr>
523         <tr>
524                 <td>#MMCAM_DISPLAY_RECT_WIDTH</td>
525                 <td>Width of display rectangle (This is only available when MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI)</td>
526         </tr>
527         <tr>
528                 <td>#MMCAM_DISPLAY_RECT_HEIGHT</td>
529                 <td>Height of display rectangle (This is only available when MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI)</td>
530         </tr>
531         <tr>
532                 <td>#MMCAM_TAG_ENABLE</td>
533                 <td>Enable to write tags (If this value is FALSE, none of tag information will be written to captured file)</td>
534         </tr>
535         <tr>
536                 <td>#MMCAM_TAG_IMAGE_DESCRIPTION</td>
537                 <td>Image description</td>
538         </tr>
539         <tr>
540                 <td>#MMCAM_TAG_ORIENTATION</td>
541                 <td>Orientation of captured image</td>
542         </tr>
543         <tr>
544                 <td>#MMCAM_TAG_VIDEO_ORIENTATION</td>
545                 <td>Orientation of encoded video</td>
546         </tr>
547         <tr>
548                 <td>#MMCAM_TAG_SOFTWARE</td>
549                 <td>software name and version</td>
550         </tr>
551         <tr>
552                 <td>#MMCAM_TAG_LATITUDE</td>
553                 <td>Latitude of captured postion (GPS information)</td>
554         </tr>
555         <tr>
556                 <td>#MMCAM_TAG_LONGITUDE</td>
557                 <td>Longitude of captured postion (GPS information)</td>
558         </tr>
559         <tr>
560                 <td>#MMCAM_TAG_ALTITUDE</td>
561                 <td>Altitude of captured postion (GPS information)</td>
562         </tr>
563         <tr>
564                 <td>#MMCAM_STROBE_CONTROL</td>
565                 <td>Strobe control</td>
566         </tr>
567         <tr>
568                 <td>#MMCAM_STROBE_MODE</td>
569                 <td>Operation Mode of strobe</td>
570         </tr>
571         <tr>
572                 <td>#MMCAM_DETECT_MODE</td>
573                 <td>Detection mode</td>
574         </tr>
575         <tr>
576                 <td>#MMCAM_DETECT_NUMBER</td>
577                 <td>Total number of detected object</td>
578         </tr>
579         <tr>
580                 <td>#MMCAM_DETECT_FOCUS_SELECT</td>
581                 <td>Select one of detected objects</td>
582         </tr>
583 </table>
584 </div>
585  */
586
587
588
589 #ifndef __MM_CAMCORDER_H__
590 #define __MM_CAMCORDER_H__
591
592
593 /*=======================================================================================
594 | INCLUDE FILES                                                                         |
595 ========================================================================================*/
596 #include <glib.h>
597
598 #include <mm_types.h>
599 #include <mm_error.h>
600 #include <mm_message.h>
601
602 #ifdef __cplusplus
603 extern "C" {
604 #endif
605
606 /*=======================================================================================
607 | GLOBAL DEFINITIONS AND DECLARATIONS FOR CAMCORDER                                     |
608 ========================================================================================*/
609
610 /*=======================================================================================
611 | MACRO DEFINITIONS                                                                     |
612 ========================================================================================*/
613 /**
614  * Get numerator. Definition for fraction setting, such as MMCAM_CAMERA_SHUTTER_SPEED and MMCAM_CAMERA_EXPOSURE_VALUE.
615  */
616 #define MM_CAMCORDER_GET_NUMERATOR(x)                                   ((int)(((int)(x) >> 16) & 0xFFFF))
617 /**
618  * Get denominator. Definition for fraction setting, such as MMCAM_CAMERA_SHUTTER_SPEED and MMCAM_CAMERA_EXPOSURE_VALUE.
619  */
620 #define MM_CAMCORDER_GET_DENOMINATOR(x)                                 ((int)(((int)(x)) & 0xFFFF))
621 /**
622  * Set fraction value. Definition for fraction setting, such as MMCAM_CAMERA_SHUTTER_SPEED and MMCAM_CAMERA_EXPOSURE_VALUE.
623  */
624 #define MM_CAMCORDER_SET_FRACTION(numerator,denominator)        ((int)((((int)(numerator)) << 16) | (int)(denominator)))
625
626 /* Attributes Macros */
627 /**
628  * Mode of camcorder (still/video/audio).
629  * @see         MMCamcorderModeType
630  */
631 #define MMCAM_MODE                              "mode"
632
633 /**
634  * Audio device ID for capturing audio stream.
635  * @see         MMAudioDeviceType (in mm_types.h)
636  */
637 #define MMCAM_AUDIO_DEVICE                      "audio-device"
638
639 /**
640  * Video device count.
641  */
642 #define MMCAM_CAMERA_DEVICE_COUNT               "camera-device-count"
643
644 /**
645  * Facing direction of camera device.
646  * @see         MMCamcorderCameraFacingDirection
647  */
648 #define MMCAM_CAMERA_FACING_DIRECTION           "camera-facing-direction"
649
650 /**
651  * Audio codec for encoding audio stream.
652  * @see         MMAudioCodecType  (in mm_types.h)
653  */
654 #define MMCAM_AUDIO_ENCODER                     "audio-encoder"
655
656 /**
657  * Video codec for encoding video stream.
658  * @see         MMVideoCodecType (in mm_types.h)
659  */
660 #define MMCAM_VIDEO_ENCODER                     "video-encoder"
661
662 /**
663  * Image codec for capturing still-image.
664  * @see         MMImageCodecType (in mm_types.h)
665  */
666 #define MMCAM_IMAGE_ENCODER                     "image-encoder"
667
668 /**
669  * File format for recording media stream.
670  * @see         MMFileFormatType (in mm_types.h)
671  */
672 #define MMCAM_FILE_FORMAT                       "file-format"
673
674 /**
675  * Sampling rate of audio stream. This is an integer field.
676  */
677 #define MMCAM_AUDIO_SAMPLERATE                  "audio-samplerate"
678
679 /**
680  * Audio format of each sample.
681  * @see         MMCamcorderAudioFormat
682  */
683 #define MMCAM_AUDIO_FORMAT                      "audio-format"
684
685 /**
686  * Channels of each sample. This is an integer field.
687  */
688 #define MMCAM_AUDIO_CHANNEL                     "audio-channel"
689
690 /**
691  * Input volume of audio source. Double value.
692  */
693 #define MMCAM_AUDIO_VOLUME                      "audio-volume"
694
695 /**
696  * Disable Audio stream when record.
697  */
698 #define MMCAM_AUDIO_DISABLE                     "audio-disable"
699
700 /**
701  * Set audio input route
702  * @remarks     Deprecated. This will be removed soon.
703  * @see         MMAudioRoutePolicy (in mm_types.h)
704  */
705 #define MMCAM_AUDIO_INPUT_ROUTE                 "audio-input-route"
706
707 /**
708  * Format of video stream. This is an integer field
709  * @see         MMPixelFormatType (in mm_types.h)
710  */
711 #define MMCAM_CAMERA_FORMAT                     "camera-format"
712
713 /**
714  * Slow motion rate when video recording
715  * @remarks     Deprecated
716  */
717 #define MMCAM_CAMERA_SLOW_MOTION_RATE           "camera-slow-motion-rate"
718
719 /**
720  * Motion rate when video recording
721  * @remarks     This should be bigger than 0(zero).
722  *              Default value is 1 and it's for normal video recording.
723  *              If the value is smaller than 1, recorded file will be played slower,
724  *              otherwise, recorded file will be played faster.
725  */
726 #define MMCAM_CAMERA_RECORDING_MOTION_RATE      "camera-recording-motion-rate"
727
728 /**
729  * Frames per second. This is an integer field
730  *
731  */
732 #define MMCAM_CAMERA_FPS                        "camera-fps"
733
734 /**
735  * Width of preview stream.
736  */
737 #define MMCAM_CAMERA_WIDTH                      "camera-width"
738
739 /**
740  * Height of preview stream.
741  */
742 #define MMCAM_CAMERA_HEIGHT                     "camera-height"
743
744 /**
745  * Width of video stream.
746  */
747 #define MMCAM_VIDEO_WIDTH                       "video-width"
748
749 /**
750  * Height of video stream.
751  */
752 #define MMCAM_VIDEO_HEIGHT                      "video-height"
753
754 /**
755  * Digital zoom level.
756  */
757 #define MMCAM_CAMERA_DIGITAL_ZOOM               "camera-digital-zoom"
758
759 /**
760  * Optical zoom level.
761  */
762 #define MMCAM_CAMERA_OPTICAL_ZOOM               "camera-optical-zoom"
763
764 /**
765  * Focus mode
766  * @see         MMCamcorderFocusMode
767  */
768 #define MMCAM_CAMERA_FOCUS_MODE                 "camera-focus-mode"
769
770 /**
771  * AF Scan range
772  * @see         MMCamcorderAutoFocusType
773  */
774 #define MMCAM_CAMERA_AF_SCAN_RANGE              "camera-af-scan-range"
775
776 /**
777  * X coordinate of touching position. Only available when you set '#MM_CAMCORDER_AUTO_FOCUS_TOUCH' to '#MMCAM_CAMERA_AF_SCAN_RANGE'.
778  * @see         MMCamcorderAutoFocusType
779  */
780 #define MMCAM_CAMERA_AF_TOUCH_X                 "camera-af-touch-x"
781
782 /**
783  * Y coordinate of touching position. Only available when you set '#MM_CAMCORDER_AUTO_FOCUS_TOUCH' to '#MMCAM_CAMERA_AF_SCAN_RANGE'.
784  * @see         MMCamcorderAutoFocusType
785  */
786 #define MMCAM_CAMERA_AF_TOUCH_Y                 "camera-af-touch-y"
787
788 /**
789  * Width of touching area. Only available when you set '#MM_CAMCORDER_AUTO_FOCUS_TOUCH' to '#MMCAM_CAMERA_AF_SCAN_RANGE'.
790  * @see         MMCamcorderAutoFocusType
791  */
792 #define MMCAM_CAMERA_AF_TOUCH_WIDTH             "camera-af-touch-width"
793
794 /**
795  * Height of touching area. Only available when you set '#MM_CAMCORDER_AUTO_FOCUS_TOUCH' to '#MMCAM_CAMERA_AF_SCAN_RANGE'.
796  * @see         MMCamcorderAutoFocusType
797  */
798 #define MMCAM_CAMERA_AF_TOUCH_HEIGHT            "camera-af-touch-height"
799
800 /**
801  * Exposure mode
802  * @see         MMCamcorderAutoExposureType
803  */
804 #define MMCAM_CAMERA_EXPOSURE_MODE              "camera-exposure-mode"
805
806 /**
807  * Exposure value
808  */
809 #define MMCAM_CAMERA_EXPOSURE_VALUE             "camera-exposure-value"
810
811 /**
812  * f number of camera
813  */
814 #define MMCAM_CAMERA_F_NUMBER                   "camera-f-number"
815
816 /**
817  * Shutter speed
818  */
819 #define MMCAM_CAMERA_SHUTTER_SPEED              "camera-shutter-speed"
820
821 /**
822  * ISO of capturing image
823  * @see         MMCamcorderISOType
824  */
825 #define MMCAM_CAMERA_ISO                        "camera-iso"
826
827 /**
828  * Wide dynamic range.
829  * @see         MMCamcorderWDRMode
830  */
831 #define MMCAM_CAMERA_WDR                        "camera-wdr"
832
833 /**
834  * Focal length of camera lens.
835  */
836 #define MMCAM_CAMERA_FOCAL_LENGTH               "camera-focal-length"
837
838 /**
839  * Anti Handshake
840  * @see         MMCamcorderAHSMode
841  */
842 #define MMCAM_CAMERA_ANTI_HANDSHAKE             "camera-anti-handshake"
843
844 /**
845  * Video Stabilization
846  * @see         MMCamcorderVideoStabilizationMode
847  */
848 #define MMCAM_CAMERA_VIDEO_STABILIZATION        "camera-video-stabilization"
849
850 /**
851  * FPS Auto. When you set true to this attribute, FPS will vary depending on the amount of the light.
852  */
853 #define MMCAM_CAMERA_FPS_AUTO                   "camera-fps-auto"
854
855 /**
856  * Rotation angle of video input stream.
857  * @see         MMVideoInputRotationType (in mm_types.h)
858  */
859 #define MMCAM_CAMERA_ROTATION                   "camera-rotation"
860
861 /**
862  * HDR(High Dynamic Range) Capture mode
863  * @see         MMCamcorderHDRMode
864  */
865 #define MMCAM_CAMERA_HDR_CAPTURE                "camera-hdr-capture"
866
867 /**
868  * Bitrate of Audio Encoder
869  */
870 #define MMCAM_AUDIO_ENCODER_BITRATE             "audio-encoder-bitrate"
871
872 /**
873  * Bitrate of Video Encoder
874  */
875 #define MMCAM_VIDEO_ENCODER_BITRATE             "video-encoder-bitrate"
876
877 /**
878  * Encoding quality of Image codec
879  */
880 #define MMCAM_IMAGE_ENCODER_QUALITY             "image-encoder-quality"
881
882 /**
883  * Brightness level
884  */
885 #define MMCAM_FILTER_BRIGHTNESS                 "filter-brightness"
886
887 /**
888  * Contrast level
889  */
890 #define MMCAM_FILTER_CONTRAST                   "filter-contrast"
891
892 /**
893  * White balance
894  * @see         MMCamcorderWhiteBalanceType
895  */
896 #define MMCAM_FILTER_WB                         "filter-wb"
897
898 /**
899  * Color tone. (Color effect)
900  * @see         MMCamcorderColorToneType
901  */
902 #define MMCAM_FILTER_COLOR_TONE                 "filter-color-tone"
903
904 /**
905  * Scene mode (Program mode)
906  * @see         MMCamcorderSceneModeType
907  */
908 #define MMCAM_FILTER_SCENE_MODE                 "filter-scene-mode"
909
910 /**
911  * Saturation  level
912  */
913 #define MMCAM_FILTER_SATURATION                 "filter-saturation"
914
915 /**
916  * Hue  level
917  */
918 #define MMCAM_FILTER_HUE                        "filter-hue"
919
920 /**
921  * Sharpness  level
922  */
923 #define MMCAM_FILTER_SHARPNESS                  "filter-sharpness"
924
925 /**
926  * Pixel format that you want to capture. If you set MM_PIXEL_FORMAT_ENCODED,
927  * the result will be encoded by image codec specified in #MMCAM_IMAGE_ENCODER.
928  * If not, the result will be raw data.
929  *
930  * @see         MMPixelFormatType (in mm_types.h)
931  */
932 #define MMCAM_CAPTURE_FORMAT                    "capture-format"
933
934 /**
935  * Width of the image that you want to capture
936  */
937 #define MMCAM_CAPTURE_WIDTH                     "capture-width"
938
939 /**
940  * Height of the image that you want to capture
941
942  */
943 #define MMCAM_CAPTURE_HEIGHT                    "capture-height"
944
945 /**
946  * Total count of capturing. If you set this, it will caputre multiple time.
947  */
948 #define MMCAM_CAPTURE_COUNT                     "capture-count"
949
950 /**
951  * Interval between each capturing on Multishot.
952  */
953 #define MMCAM_CAPTURE_INTERVAL                  "capture-interval"
954
955 /**
956  * Set this when you want to stop multishot immediately.
957  */
958 #define MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT     "capture-break-cont-shot"
959
960 /**
961  * Raw data of captured image which resolution is same as preview.
962  * This is READ-ONLY attribute and only available in capture callback.
963  * This should be used after casted as MMCamcorderCaptureDataType.
964  */
965 #define MMCAM_CAPTURED_SCREENNAIL               "captured-screennail"
966
967 /**
968  * Raw data of EXIF. This is READ-ONLY attribute and only available in capture callback.
969  */
970 #define MMCAM_CAPTURED_EXIF_RAW_DATA            "captured-exif-raw-data"
971
972 /**
973  * Pointer of display buffer or ID of xwindow.
974  */
975 #define MMCAM_DISPLAY_HANDLE                    "display-handle"
976
977 /**
978  * Device of display.
979  * @see         MMDisplayDeviceType (in mm_types.h)
980  */
981 #define MMCAM_DISPLAY_DEVICE                    "display-device"
982
983 /**
984  * Surface of display.
985  * @see         MMDisplaySurfaceType (in mm_types.h)
986  */
987 #define MMCAM_DISPLAY_SURFACE                    "display-surface"
988
989 /**
990  * Mode of display.
991  * @see         MMDisplayModeType (in mm_types.h)
992  */
993 #define MMCAM_DISPLAY_MODE                       "display-mode"
994
995 /**
996  * X position of display rectangle.
997  * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
998  * @see         MMCamcorderGeometryMethod
999  */
1000 #define MMCAM_DISPLAY_RECT_X                    "display-rect-x"
1001
1002 /**
1003  * Y position of display rectangle
1004  * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
1005  * @see         MMCamcorderGeometryMethod
1006  */
1007 #define MMCAM_DISPLAY_RECT_Y                    "display-rect-y"
1008
1009 /**
1010  * Width of display rectangle
1011  * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
1012  * @see         MMCamcorderGeometryMethod
1013  */
1014 #define MMCAM_DISPLAY_RECT_WIDTH                "display-rect-width"
1015
1016 /**
1017  * Height of display rectangle
1018  * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
1019  * @see         MMCamcorderGeometryMethod
1020  */
1021 #define MMCAM_DISPLAY_RECT_HEIGHT               "display-rect-height"
1022
1023 /**
1024  * X position of source rectangle. When you want to crop the source, you can set the area with this value.
1025  */
1026 #define MMCAM_DISPLAY_SOURCE_X                  "display-src-x"
1027
1028 /**
1029  * Y position of source rectangle. When you want to crop the source, you can set the area with this value.
1030  */
1031 #define MMCAM_DISPLAY_SOURCE_Y                  "display-src-y"
1032
1033 /**
1034  * Width of source rectangle. When you want to crop the source, you can set the area with this value.
1035  */
1036 #define MMCAM_DISPLAY_SOURCE_WIDTH              "display-src-width"
1037
1038 /**
1039  * Height of source rectangle. When you want to crop the source, you can set the area with this value.
1040  */
1041 #define MMCAM_DISPLAY_SOURCE_HEIGHT             "display-src-height"
1042
1043 /**
1044  * Rotation angle of display.
1045  * @see         MMDisplayRotationType (in mm_types.h)
1046  */
1047 #define MMCAM_DISPLAY_ROTATION                  "display-rotation"
1048
1049 /**
1050  * Flip of display.
1051  * @see         MMFlipType (in mm_types.h)
1052  */
1053 #define MMCAM_DISPLAY_FLIP                      "display-flip"
1054
1055 /**
1056  * Visible of display.
1057  */
1058 #define MMCAM_DISPLAY_VISIBLE                   "display-visible"
1059
1060 /**
1061  * A scale of displayed image. Available value is like below.
1062  * @see         MMDisplayScaleType (in mm_types.h)
1063  */
1064 #define MMCAM_DISPLAY_SCALE                     "display-scale"
1065
1066 /**
1067  * A method that describes a form of geometry for display.
1068  * @see         MMCamcorderGeometryMethod
1069  */
1070 #define MMCAM_DISPLAY_GEOMETRY_METHOD           "display-geometry-method"
1071
1072 /**
1073  * A videosink name of evas surface.
1074  * This is READ-ONLY attribute.
1075  */
1076 #define MMCAM_DISPLAY_EVAS_SURFACE_SINK         "display-evas-surface-sink"
1077
1078 /**
1079  * This attribute is only available if value of MMCAM_DISPLAY_EVAS_SURFACE_SINK "evaspixmapsink"
1080  */
1081 #define MMCAM_DISPLAY_EVAS_DO_SCALING           "display-evas-do-scaling"
1082
1083 /**
1084  * Target filename. Only used in Audio/Video recording. This is not used for capturing.
1085  */
1086 #define MMCAM_TARGET_FILENAME                   "target-filename"
1087
1088 /**
1089  * Maximum size(Kbyte) of recording file. If the size of file reaches this value,
1090  * camcorder will send 'MM_MESSAGE_CAMCORDER_MAX_SIZE' message.
1091  */
1092 #define MMCAM_TARGET_MAX_SIZE                   "target-max-size"
1093
1094 /**
1095  * Time limit(Second) of recording file. If the elapsed time of recording reaches this value,
1096  * camcorder will send 'MM_MESSAGE_CAMCORDER_TIME_LIMIT' message.
1097  */
1098 #define MMCAM_TARGET_TIME_LIMIT                 "target-time-limit"
1099
1100 /**
1101  * Enable to write tags. If this value is FALSE, none of tag information will be written to captured file.
1102  */
1103 #define MMCAM_TAG_ENABLE                        "tag-enable"
1104
1105 /**
1106  * Image description.
1107  */
1108 #define MMCAM_TAG_IMAGE_DESCRIPTION             "tag-image-description"
1109
1110 /**
1111  * Orientation of captured image
1112  * @see         MMCamcorderTagOrientation
1113  */
1114 #define MMCAM_TAG_ORIENTATION                   "tag-orientation"
1115
1116 /**
1117  * Orientation of captured video
1118  * @see         MMCamcorderTagVideoOrientation
1119  */
1120 #define MMCAM_TAG_VIDEO_ORIENTATION            "tag-video-orientation"
1121
1122 /**
1123  * software name and version
1124  */
1125 #define MMCAM_TAG_SOFTWARE                      "tag-software"
1126
1127 /**
1128  * Enable to write tags related to GPS. If this value is TRUE, tags related GPS information will be written to captured file.
1129  */
1130 #define MMCAM_TAG_GPS_ENABLE                    "tag-gps-enable"
1131
1132 /**
1133  * Latitude of captured postion. GPS information.
1134  */
1135 #define MMCAM_TAG_LATITUDE                      "tag-latitude"
1136
1137 /**
1138  * Longitude of captured postion. GPS information.
1139  */
1140 #define MMCAM_TAG_LONGITUDE                     "tag-longitude"
1141
1142 /**
1143  * Altitude of captured postion. GPS information.
1144  */
1145 #define MMCAM_TAG_ALTITUDE                      "tag-altitude"
1146
1147 /**
1148  * Strobe control
1149  * @see         MMCamcorderStrobeControl
1150  */
1151 #define MMCAM_STROBE_CONTROL                    "strobe-control"
1152
1153 /**
1154  * Operation Mode of strobe
1155  * @see         MMCamcorderStrobeMode
1156  */
1157 #define MMCAM_STROBE_MODE                       "strobe-mode"
1158
1159 /**
1160  * Detection mode
1161  * @see         MMCamcorderDetectMode
1162  */
1163 #define MMCAM_DETECT_MODE                       "detect-mode"
1164
1165 /**
1166  * Total number of detected object
1167  */
1168 #define MMCAM_DETECT_NUMBER                     "detect-number"
1169
1170 /**
1171  * You can use this attribute to select one of detected objects.
1172  */
1173 #define MMCAM_DETECT_FOCUS_SELECT               "detect-focus-select"
1174
1175 /**
1176  * Recommend preview format for capture
1177  */
1178 #define MMCAM_RECOMMEND_PREVIEW_FORMAT_FOR_CAPTURE     "recommend-preview-format-for-capture"
1179
1180 /**
1181  * Recommend preview format for recording
1182  */
1183 #define MMCAM_RECOMMEND_PREVIEW_FORMAT_FOR_RECORDING   "recommend-preview-format-for-recording"
1184
1185 /**
1186  * Recommend rotation of display
1187  */
1188 #define MMCAM_RECOMMEND_DISPLAY_ROTATION        "recommend-display-rotation"
1189
1190 /**
1191  * Recommend width of camera preview.
1192  * This attribute can be used with #mm_camcorder_get_attribute_info and #MMCamcorderPreviewType.
1193  * @see         mm_camcorder_get_attribute_info, MMCamcorderPreviewType
1194  */
1195 #define MMCAM_RECOMMEND_CAMERA_WIDTH            "recommend-camera-width"
1196
1197 /**
1198  * Recommend height of camera preview
1199  * This attribute can be used with #mm_camcorder_get_attribute_info and #MMCamcorderPreviewType.
1200  * @see         mm_camcorder_get_attribute_info, MMCamcorderPreviewType
1201  */
1202 #define MMCAM_RECOMMEND_CAMERA_HEIGHT           "recommend-camera-height"
1203
1204 /**
1205  * Flip of video input stream.
1206  * @see         MMFlipType (in mm_types.h)
1207  */
1208 #define MMCAM_CAMERA_FLIP                       "camera-flip"
1209
1210 /**
1211  * Support Zero Shutter Lag capture
1212  */
1213 #define MMCAM_SUPPORT_ZSL_CAPTURE               "support-zsl-capture"
1214
1215 /**
1216 * Support zero copy format
1217 */
1218 #define MMCAM_SUPPORT_ZERO_COPY_FORMAT          "support-zero-copy-format"
1219
1220 /**
1221 * Support media packet callback
1222 */
1223 #define MMCAM_SUPPORT_MEDIA_PACKET_PREVIEW_CB   "support-media-packet-preview-cb"
1224
1225 /**
1226  * Enable to write tags for recorded file
1227  */
1228 #define MMCAM_RECORDER_TAG_ENABLE               "recorder-tag-enable"
1229
1230 /**
1231  * Determines the socket stream path
1232  */
1233 #define MMCAM_DISPLAY_SOCKET_PATH               "display-socket-path"
1234
1235 /**
1236  * PID for sound focus
1237  */
1238 #define MMCAM_PID_FOR_SOUND_FOCUS               "pid-for-sound-focus"
1239
1240 /**
1241  * Root directory of application
1242  */
1243 #define MMCAM_ROOT_DIRECTORY                    "root-directory"
1244
1245 /**
1246  * Bitrate for encoded preview stream
1247  */
1248 #define MMCAM_ENCODED_PREVIEW_BITRATE           "encoded-preview-bitrate"
1249
1250 /**
1251  * GOP interval for encoded preview stream
1252  */
1253 #define MMCAM_ENCODED_PREVIEW_GOP_INTERVAL   "encoded-preview-gop-interval"
1254
1255 /*=======================================================================================
1256 | ENUM DEFINITIONS                                                                      |
1257 ========================================================================================*/
1258 /**
1259  * An enumeration for camcorder states.
1260  */
1261 typedef enum {
1262         MM_CAMCORDER_STATE_NONE,                /**< Camcorder is not created yet */
1263         MM_CAMCORDER_STATE_NULL,                /**< Camcorder is created, but not initialized yet */
1264         MM_CAMCORDER_STATE_READY,               /**< Camcorder is ready to capture */
1265         MM_CAMCORDER_STATE_PREPARE,             /**< Camcorder is prepared to capture (Preview) */
1266         MM_CAMCORDER_STATE_CAPTURING,           /**< Camcorder is now capturing still images */
1267         MM_CAMCORDER_STATE_RECORDING,           /**< Camcorder is now recording */
1268         MM_CAMCORDER_STATE_PAUSED,              /**< Camcorder is paused while recording */
1269         MM_CAMCORDER_STATE_NUM,                 /**< Number of camcorder states */
1270 } MMCamcorderStateType;
1271
1272 /**
1273  * An enumeration for camcorder mode.
1274  */
1275 typedef enum {
1276         MM_CAMCORDER_MODE_VIDEO_CAPTURE = 0,    /**< Video recording and Image capture mode */
1277         MM_CAMCORDER_MODE_AUDIO,                /**< Audio recording mode */
1278 } MMCamcorderModeType;
1279
1280 /**
1281  * An enumeration for facing direction.
1282  */
1283 typedef enum {
1284         MM_CAMCORDER_CAMERA_FACING_DIRECTION_REAR = 0, /**< Facing direction of camera is REAR */
1285         MM_CAMCORDER_CAMERA_FACING_DIRECTION_FRONT,    /**< Facing direction of camera is FRONT */
1286 } MMCamcorderCameraFacingDirection;
1287
1288
1289 /**
1290  * An enumeration of Audio Format.
1291  */
1292 typedef enum
1293 {
1294         MM_CAMCORDER_AUDIO_FORMAT_PCM_U8 = 0,           /**< unsigned 8bit audio */
1295         MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE = 2,       /**< signed 16bit audio. Little endian. */
1296 } MMCamcorderAudioFormat;
1297
1298
1299 /**
1300  * An enumeration for color tone. Color tone provides an impression of
1301  * seeing through a tinted glass.
1302  */
1303 enum MMCamcorderColorToneType {
1304         MM_CAMCORDER_COLOR_TONE_NONE = 0,               /**< None */
1305         MM_CAMCORDER_COLOR_TONE_MONO,                   /**< Mono */
1306         MM_CAMCORDER_COLOR_TONE_SEPIA,                  /**< Sepia */
1307         MM_CAMCORDER_COLOR_TONE_NEGATIVE,               /**< Negative */
1308         MM_CAMCORDER_COLOR_TONE_BLUE,                   /**< Blue */
1309         MM_CAMCORDER_COLOR_TONE_GREEN,                  /**< Green */
1310         MM_CAMCORDER_COLOR_TONE_AQUA,                   /**< Aqua */
1311         MM_CAMCORDER_COLOR_TONE_VIOLET,                 /**< Violet */
1312         MM_CAMCORDER_COLOR_TONE_ORANGE,                 /**< Orange */
1313         MM_CAMCORDER_COLOR_TONE_GRAY,                   /**< Gray */
1314         MM_CAMCORDER_COLOR_TONE_RED,                    /**< Red */
1315         MM_CAMCORDER_COLOR_TONE_ANTIQUE,                /**< Antique */
1316         MM_CAMCORDER_COLOR_TONE_WARM,                   /**< Warm */
1317         MM_CAMCORDER_COLOR_TONE_PINK,                   /**< Pink */
1318         MM_CAMCORDER_COLOR_TONE_YELLOW,                 /**< Yellow */
1319         MM_CAMCORDER_COLOR_TONE_PURPLE,                 /**< Purple */
1320         MM_CAMCORDER_COLOR_TONE_EMBOSS,                 /**< Emboss */
1321         MM_CAMCORDER_COLOR_TONE_OUTLINE,                /**< Outline */
1322         MM_CAMCORDER_COLOR_TONE_SOLARIZATION,           /**< Solarization */
1323         MM_CAMCORDER_COLOR_TONE_SKETCH,                 /**< Sketch */
1324         MM_CAMCORDER_COLOR_TONE_WASHED,                 /**< Washed */
1325         MM_CAMCORDER_COLOR_TONE_VINTAGE_WARM,           /**< Vintage warm */
1326         MM_CAMCORDER_COLOR_TONE_VINTAGE_COLD,           /**< Vintage cold */
1327         MM_CAMCORDER_COLOR_TONE_POSTERIZATION,          /**< Posterization */
1328         MM_CAMCORDER_COLOR_TONE_CARTOON,                /**< Cartoon */
1329         MM_CAMCORDER_COLOR_TONE_SELECTIVE_RED,          /**< Selective color - Red */
1330         MM_CAMCORDER_COLOR_TONE_SELECTIVE_GREEN,        /**< Selective color - Green */
1331         MM_CAMCORDER_COLOR_TONE_SELECTIVE_BLUE,         /**< Selective color - Blue */
1332         MM_CAMCORDER_COLOR_TONE_SELECTIVE_YELLOW,       /**< Selective color - Yellow */
1333         MM_CAMCORDER_COLOR_TONE_SELECTIVE_RED_YELLOW,   /**< Selective color - Red and Yellow */
1334 };
1335
1336
1337 /**
1338  * An enumeration for white balance. White Balance is the control that adjusts
1339  * the camcorder's color sensitivity to match the prevailing color of white
1340  * outdoor light, yellower indoor light, or (sometimes) greenish fluorescent
1341  * light. White balance may be set either automatically or manually. White balance
1342  * may be set "incorrectly" on purpose to achieve special effects.
1343  */
1344 enum MMCamcorderWhiteBalanceType {
1345         MM_CAMCORDER_WHITE_BALANCE_NONE = 0,            /**< None */
1346         MM_CAMCORDER_WHITE_BALANCE_AUTOMATIC,           /**< Automatic */
1347         MM_CAMCORDER_WHITE_BALANCE_DAYLIGHT,            /**< Daylight */
1348         MM_CAMCORDER_WHITE_BALANCE_CLOUDY,              /**< Cloudy */
1349         MM_CAMCORDER_WHITE_BALANCE_FLUOROSCENT,         /**< Fluorescent */
1350         MM_CAMCORDER_WHITE_BALANCE_INCANDESCENT,        /**< Incandescent */
1351         MM_CAMCORDER_WHITE_BALANCE_SHADE,               /**< Shade */
1352         MM_CAMCORDER_WHITE_BALANCE_HORIZON,             /**< Horizon */
1353         MM_CAMCORDER_WHITE_BALANCE_FLASH,               /**< Flash */
1354         MM_CAMCORDER_WHITE_BALANCE_CUSTOM,              /**< Custom */
1355 };
1356
1357
1358 /**
1359  * An enumeration for scene mode. Scene mode gives the environment condition
1360  * for operating camcorder. The mode of operation can be in daylight, night and
1361  * backlight. It can be an automatic setting also.
1362  */
1363 enum MMCamcorderSceneModeType {
1364         MM_CAMCORDER_SCENE_MODE_NORMAL = 0,     /**< Normal */
1365         MM_CAMCORDER_SCENE_MODE_PORTRAIT,       /**< Portrait */
1366         MM_CAMCORDER_SCENE_MODE_LANDSCAPE,      /**< Landscape */
1367         MM_CAMCORDER_SCENE_MODE_SPORTS,         /**< Sports */
1368         MM_CAMCORDER_SCENE_MODE_PARTY_N_INDOOR, /**< Party & indoor */
1369         MM_CAMCORDER_SCENE_MODE_BEACH_N_INDOOR, /**< Beach & indoor */
1370         MM_CAMCORDER_SCENE_MODE_SUNSET,         /**< Sunset */
1371         MM_CAMCORDER_SCENE_MODE_DUSK_N_DAWN,    /**< Dusk & dawn */
1372         MM_CAMCORDER_SCENE_MODE_FALL_COLOR,     /**< Fall */
1373         MM_CAMCORDER_SCENE_MODE_NIGHT_SCENE,    /**< Night scene */
1374         MM_CAMCORDER_SCENE_MODE_FIREWORK,       /**< Firework */
1375         MM_CAMCORDER_SCENE_MODE_TEXT,           /**< Text */
1376         MM_CAMCORDER_SCENE_MODE_SHOW_WINDOW,    /**< Show window */
1377         MM_CAMCORDER_SCENE_MODE_CANDLE_LIGHT,   /**< Candle light */
1378         MM_CAMCORDER_SCENE_MODE_BACKLIGHT,      /**< Backlight */
1379         MM_CAMCORDER_SCENE_MODE_AQUA,           /**< Aqua */
1380 };
1381
1382
1383 /**
1384  * An enumeration for focusing .
1385  */
1386 enum MMCamcorderFocusMode {
1387         MM_CAMCORDER_FOCUS_MODE_NONE = 0,       /**< Focus mode is None */
1388         MM_CAMCORDER_FOCUS_MODE_PAN,            /**< Pan focus mode*/
1389         MM_CAMCORDER_FOCUS_MODE_AUTO,           /**< Autofocus mode*/
1390         MM_CAMCORDER_FOCUS_MODE_MANUAL,         /**< Manual focus mode*/
1391         MM_CAMCORDER_FOCUS_MODE_TOUCH_AUTO,     /**< Touch Autofocus mode*/
1392         MM_CAMCORDER_FOCUS_MODE_CONTINUOUS,     /**< Continuous Autofocus mode*/
1393 };
1394
1395
1396 /**
1397  * An enumeration for auto focus scan range (af scan range)
1398  */
1399 enum MMCamcorderAutoFocusType {
1400         MM_CAMCORDER_AUTO_FOCUS_NONE = 0,       /**< Scan autofocus is not set */
1401         MM_CAMCORDER_AUTO_FOCUS_NORMAL,         /**< Scan autofocus normally*/
1402         MM_CAMCORDER_AUTO_FOCUS_MACRO,          /**< Scan autofocus in macro mode(close distance)*/
1403         MM_CAMCORDER_AUTO_FOCUS_FULL,           /**< Scan autofocus in full mode(all range scan, limited by dev spec)*/
1404 };
1405
1406
1407 /**
1408  * An enumeration for focus state.
1409  * When 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' is delievered through 'MMMessageCallback',
1410  * this enumeration will be set to 'code' of MMMessageParamType.
1411  */
1412 enum MMCamcorderFocusStateType {
1413         MM_CAMCORDER_FOCUS_STATE_RELEASED = 0,  /**< Focus released.*/
1414         MM_CAMCORDER_FOCUS_STATE_ONGOING,       /**< Focus in pregress*/
1415         MM_CAMCORDER_FOCUS_STATE_FOCUSED,       /**< Focus success*/
1416         MM_CAMCORDER_FOCUS_STATE_FAILED,        /**< Focus failed*/
1417 };
1418
1419
1420 /**
1421  * An enumeration for ISO.
1422  */
1423 enum MMCamcorderISOType {
1424         MM_CAMCORDER_ISO_AUTO = 0,              /**< ISO auto mode*/
1425         MM_CAMCORDER_ISO_50,                    /**< ISO 50*/
1426         MM_CAMCORDER_ISO_100,                   /**< ISO 100*/
1427         MM_CAMCORDER_ISO_200,                   /**< ISO 200*/
1428         MM_CAMCORDER_ISO_400,                   /**< ISO 400*/
1429         MM_CAMCORDER_ISO_800,                   /**< ISO 800*/
1430         MM_CAMCORDER_ISO_1600,                  /**< ISO 1600*/
1431         MM_CAMCORDER_ISO_3200,                  /**< ISO 3200*/
1432         MM_CAMCORDER_ISO_6400,                  /**< ISO 6400*/
1433         MM_CAMCORDER_ISO_12800,                 /**< ISO 12800*/
1434 };
1435
1436 /**
1437  * An enumeration for Automatic exposure.
1438  */
1439 enum MMCamcorderAutoExposureType {
1440         MM_CAMCORDER_AUTO_EXPOSURE_OFF = 0,     /**< AE off*/
1441         MM_CAMCORDER_AUTO_EXPOSURE_ALL,         /**< AE on, XXX mode*/
1442         MM_CAMCORDER_AUTO_EXPOSURE_CENTER_1,    /**< AE on, XXX mode*/
1443         MM_CAMCORDER_AUTO_EXPOSURE_CENTER_2,    /**< AE on, XXX mode*/
1444         MM_CAMCORDER_AUTO_EXPOSURE_CENTER_3,    /**< AE on, XXX mode*/
1445         MM_CAMCORDER_AUTO_EXPOSURE_SPOT_1,      /**< AE on, XXX mode*/
1446         MM_CAMCORDER_AUTO_EXPOSURE_SPOT_2,      /**< AE on, XXX mode*/
1447         MM_CAMCORDER_AUTO_EXPOSURE_CUSTOM_1,    /**< AE on, XXX mode*/
1448         MM_CAMCORDER_AUTO_EXPOSURE_CUSTOM_2,    /**< AE on, XXX mode*/
1449 };
1450
1451
1452 /**
1453  * An enumeration for WDR mode .
1454  */
1455 enum MMCamcorderWDRMode {
1456         MM_CAMCORDER_WDR_OFF = 0,               /**< WDR OFF*/
1457         MM_CAMCORDER_WDR_ON,                    /**< WDR ON*/
1458         MM_CAMCORDER_WDR_AUTO,                  /**< WDR AUTO*/
1459 };
1460
1461
1462 /**
1463  * An enumeration for HDR capture mode
1464  */
1465 enum MMCamcorderHDRMode {
1466         MM_CAMCORDER_HDR_OFF = 0,               /**< HDR OFF */
1467         MM_CAMCORDER_HDR_ON,                    /**< HDR ON and no original data - capture callback will be come once */
1468         MM_CAMCORDER_HDR_ON_AND_ORIGINAL,       /**< HDR ON and original data - capture callback will be come twice(1st:Original, 2nd:HDR) */
1469 };
1470
1471
1472 /**
1473  * An enumeration for Anti-handshake mode .
1474  */
1475 enum MMCamcorderAHSMode {
1476         MM_CAMCORDER_AHS_OFF = 0,               /**< AHS OFF*/
1477         MM_CAMCORDER_AHS_ON,                    /**< AHS ON*/
1478         MM_CAMCORDER_AHS_AUTO,                  /**< AHS AUTO*/
1479         MM_CAMCORDER_AHS_MOVIE,                 /**< AHS MOVIE*/
1480 };
1481
1482
1483 /**
1484  * An enumeration for Video stabilization mode
1485  */
1486 enum MMCamcorderVideoStabilizationMode {
1487         MM_CAMCORDER_VIDEO_STABILIZATION_OFF = 0,       /**< Video Stabilization OFF*/
1488         MM_CAMCORDER_VIDEO_STABILIZATION_ON,            /**< Video Stabilization ON*/
1489 };
1490
1491
1492 /**
1493  * Geometry method for camcorder display.
1494  */
1495 enum MMCamcorderGeometryMethod {
1496         MM_CAMCORDER_LETTER_BOX = 0,            /**< Letter box*/
1497         MM_CAMCORDER_ORIGIN_SIZE,               /**< Origin size*/
1498         MM_CAMCORDER_FULL,                      /**< full-screen*/
1499         MM_CAMCORDER_CROPPED_FULL,              /**< Cropped full-screen*/
1500         MM_CAMCORDER_ORIGIN_OR_LETTER,          /**< Origin size or Letter box*/
1501         MM_CAMCORDER_CUSTOM_ROI,                /**< Explicitely described destination ROI*/
1502 };
1503
1504
1505 /**
1506  * An enumeration for orientation values of tag .
1507  */
1508 enum MMCamcorderTagOrientation {
1509         MM_CAMCORDER_TAG_ORT_NONE =0,           /**< No Orientation.*/
1510         MM_CAMCORDER_TAG_ORT_0R_VT_0C_VL,       /**< The 0th row is at the visual top of the image, and the 0th column is the visual left-hand side.*/
1511         MM_CAMCORDER_TAG_ORT_0R_VT_0C_VR,       /**< The 0th row is at the visual top of the image, and the 0th column is the visual right-hand side.*/
1512         MM_CAMCORDER_TAG_ORT_0R_VB_0C_VR,       /**< The 0th row is at the visual bottom of the image, and the 0th column is the visual right-hand side.*/
1513         MM_CAMCORDER_TAG_ORT_0R_VB_0C_VL,       /**< The 0th row is at the visual bottom of the image, and the 0th column is the visual left-hand side.*/
1514         MM_CAMCORDER_TAG_ORT_0R_VL_0C_VT,       /**< The 0th row is the visual left-hand side of the image, and the 0th column is the visual top.*/
1515         MM_CAMCORDER_TAG_ORT_0R_VR_0C_VT,       /**< The 0th row is the visual right-hand side of the image, and the 0th column is the visual top.*/
1516         MM_CAMCORDER_TAG_ORT_0R_VR_0C_VB,       /**< The 0th row is the visual right-hand side of the image, and the 0th column is the visual bottom.*/
1517         MM_CAMCORDER_TAG_ORT_0R_VL_0C_VB,       /**< The 0th row is the visual left-hand side of the image, and the 0th column is the visual bottom.*/
1518 };
1519
1520 /**
1521  * An enumeration for captured video orientation values of tag .
1522  */
1523 enum MMCamcorderTagVideoOrientation {
1524         MM_CAMCORDER_TAG_VIDEO_ORT_NONE =0,     /**< No Orientation.*/
1525         MM_CAMCORDER_TAG_VIDEO_ORT_90,          /**< 90 degree */
1526         MM_CAMCORDER_TAG_VIDEO_ORT_180, /**< 180 degree */
1527         MM_CAMCORDER_TAG_VIDEO_ORT_270, /**< 270 degree */
1528 };
1529
1530
1531
1532 /**
1533  * An enumeration for Strobe mode.
1534  */
1535 enum MMCamcorderStrobeMode {
1536         MM_CAMCORDER_STROBE_MODE_OFF = 0,               /**< Always off */
1537         MM_CAMCORDER_STROBE_MODE_ON,                    /**< Always splashes */
1538         MM_CAMCORDER_STROBE_MODE_AUTO,                  /**< Depending on intensity of light, strobe starts to flash. */
1539         MM_CAMCORDER_STROBE_MODE_REDEYE_REDUCTION,      /**< Red eye reduction. Multiple flash before capturing. */
1540         MM_CAMCORDER_STROBE_MODE_SLOW_SYNC,             /**< Slow sync. A type of curtain synchronization. */
1541         MM_CAMCORDER_STROBE_MODE_FRONT_CURTAIN,         /**< Front curtain. A type of curtain synchronization. */
1542         MM_CAMCORDER_STROBE_MODE_REAR_CURTAIN,          /**< Rear curtain. A type of curtain synchronization. */
1543         MM_CAMCORDER_STROBE_MODE_PERMANENT,             /**< keep turned on until turning off */
1544 };
1545
1546
1547 /**
1548  * An enumeration for Strobe Control.
1549  */
1550 enum MMCamcorderStrobeControl {
1551         MM_CAMCORDER_STROBE_CONTROL_OFF = 0,    /**< turn off the flash light */
1552         MM_CAMCORDER_STROBE_CONTROL_ON,         /**< turn on the flash light */
1553         MM_CAMCORDER_STROBE_CONTROL_CHARGE,     /**< charge the flash light */
1554 };
1555
1556
1557 /**
1558  * An enumeration for Detection mode.
1559  */
1560 enum MMCamcorderDetectMode {
1561         MM_CAMCORDER_DETECT_MODE_OFF = 0,       /**< turn detection off */
1562         MM_CAMCORDER_DETECT_MODE_ON,            /**< turn detection on */
1563 };
1564
1565
1566 /**
1567  * An enumeration for recommended preview resolution.
1568  */
1569 enum MMCamcorderPreviewType {
1570         MM_CAMCORDER_PREVIEW_TYPE_NORMAL = 0,   /**< normal ratio like 4:3 */
1571         MM_CAMCORDER_PREVIEW_TYPE_WIDE,         /**< wide ratio like 16:9 */
1572         MM_CAMCORDER_PREVIEW_TYPE_SQUARE,       /**< square ratio like 1:1 */
1573 };
1574
1575
1576 /**********************************
1577 *          Attribute info         *
1578 **********************************/
1579 /**
1580  * An enumeration for attribute values types.
1581  */
1582 typedef enum{
1583         MM_CAM_ATTRS_TYPE_INVALID = -1,         /**< Type is invalid */
1584         MM_CAM_ATTRS_TYPE_INT,                  /**< Integer type attribute */
1585         MM_CAM_ATTRS_TYPE_DOUBLE,               /**< Double type attribute */
1586         MM_CAM_ATTRS_TYPE_STRING,               /**< UTF-8 String type attribute */
1587         MM_CAM_ATTRS_TYPE_DATA,                 /**< Pointer type attribute */
1588 }MMCamAttrsType;
1589
1590
1591 /**
1592  * An enumeration for attribute validation type.
1593  */
1594 typedef enum {
1595         MM_CAM_ATTRS_VALID_TYPE_INVALID = -1,   /**< Invalid validation type */
1596         MM_CAM_ATTRS_VALID_TYPE_NONE,           /**< Do not check validity */
1597         MM_CAM_ATTRS_VALID_TYPE_INT_ARRAY,      /**< validity checking type of integer array */
1598         MM_CAM_ATTRS_VALID_TYPE_INT_RANGE,      /**< validity checking type of integer range */
1599         MM_CAM_ATTRS_VALID_TYPE_DOUBLE_ARRAY,   /**< validity checking type of double array */
1600         MM_CAM_ATTRS_VALID_TYPE_DOUBLE_RANGE,   /**< validity checking type of double range */
1601 } MMCamAttrsValidType;
1602
1603
1604 /**
1605  * An enumeration for attribute access flag.
1606  */
1607 typedef enum {
1608         MM_CAM_ATTRS_FLAG_DISABLED = 0,         /**< None flag is set. This means the attribute is not allowed to use.  */
1609         MM_CAM_ATTRS_FLAG_READABLE = 1 << 0,    /**< Readable */
1610         MM_CAM_ATTRS_FLAG_WRITABLE = 1 << 1,    /**< Writable */
1611         MM_CAM_ATTRS_FLAG_MODIFIED = 1 << 2,    /**< Modified */
1612         MM_CAM_ATTRS_FLAG_RW = MM_CAM_ATTRS_FLAG_READABLE | MM_CAM_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
1613 } MMCamAttrsFlag;
1614
1615
1616 /**********************************
1617 *          Stream data            *
1618 **********************************/
1619 /**
1620  * An enumeration for stream data type.
1621  */
1622 typedef enum {
1623         MM_CAM_STREAM_DATA_YUV420 = 0,          /**< YUV420 Packed type - 1 plane */
1624         MM_CAM_STREAM_DATA_YUV422,              /**< YUV422 Packed type - 1 plane */
1625         MM_CAM_STREAM_DATA_YUV420SP,            /**< YUV420 SemiPlannar type - 2 planes */
1626         MM_CAM_STREAM_DATA_YUV420P,             /**< YUV420 Plannar type - 3 planes */
1627         MM_CAM_STREAM_DATA_YUV422P,             /**< YUV422 Plannar type - 3 planes */
1628         MM_CAM_STREAM_DATA_ENCODED              /**< Encoded data type - 1 plane */
1629 } MMCamStreamData;
1630
1631
1632 /*=======================================================================================
1633 | STRUCTURE DEFINITIONS                                                                 |
1634 ========================================================================================*/
1635 /**
1636  * A structure for attribute information
1637  */
1638 typedef struct {
1639         MMCamAttrsType type;
1640         MMCamAttrsFlag flag;
1641         MMCamAttrsValidType validity_type;
1642
1643         /**
1644          * A union that describes validity of the attribute.
1645          * Only when type is 'MM_CAM_ATTRS_TYPE_INT' or 'MM_CAM_ATTRS_TYPE_DOUBLE',
1646          * the attribute can have validity.
1647          */
1648         union {
1649                 /**
1650                  * Validity structure for integer array.
1651                  */
1652                  struct {
1653                         int *array;             /**< a pointer of array */
1654                         int count;              /**< size of array */
1655                         int def;                /**< default value. Real value not index of array */
1656                 } int_array;
1657
1658                 /**
1659                  * Validity structure for integer range.
1660                  */
1661                 struct {
1662                         int min;                /**< minimum range */
1663                         int max;                /**< maximum range */
1664                         int def;                /**< default value */
1665                 } int_range;
1666
1667                 /**
1668                  * Validity structure for double array.
1669                  */
1670                  struct {
1671                         double *array;          /**< a pointer of array */
1672                         int count;              /**< size of array */
1673                         double def;             /**< default value. Real value not index of array */
1674                 } double_array;
1675
1676                 /**
1677                  * Validity structure for double range.
1678                  */
1679                 struct {
1680                         double min;             /**< minimum range */
1681                         double max;             /**< maximum range */
1682                         double def;             /**< default value */
1683                 } double_range;
1684         };
1685 } MMCamAttrsInfo;
1686
1687
1688 /* General Structure */
1689 /**
1690  * Structure for capture data.
1691  */
1692 typedef struct {
1693         void *data;                     /**< pointer of captured image */
1694         unsigned int length;            /**< length of captured image (in byte)*/
1695         MMPixelFormatType format;       /**< image format */
1696         int width;                      /**< width of captured image */
1697         int height;                     /**< height of captured image */
1698         int encoder_type;               /**< encoder type */
1699 } MMCamcorderCaptureDataType;
1700
1701
1702 /**
1703  * Structure for video stream data.
1704  */
1705 #define BUFFER_MAX_PLANE_NUM 4
1706
1707 typedef struct {
1708         union {
1709                 struct {
1710                         unsigned char *yuv;
1711                         unsigned int length_yuv;
1712                 } yuv420, yuv422;
1713                 struct {
1714                         unsigned char *y;
1715                         unsigned int length_y;
1716                         unsigned char *uv;
1717                         unsigned int length_uv;
1718                 } yuv420sp;
1719                 struct {
1720                         unsigned char *y;
1721                         unsigned int length_y;
1722                         unsigned char *u;
1723                         unsigned int length_u;
1724                         unsigned char *v;
1725                         unsigned int length_v;
1726                 } yuv420p, yuv422p;
1727                 struct {
1728                         unsigned char *data;
1729                         unsigned int length_data;
1730                 } encoded;
1731         } data;                         /**< pointer of captured stream */
1732         MMCamStreamData data_type;      /**< data type */
1733         unsigned int length_total;      /**< total length of stream buffer (in byte)*/
1734         unsigned int num_planes;        /**< number of planes */
1735         MMPixelFormatType format;       /**< image format */
1736         int width;                      /**< width of video buffer */
1737         int height;                     /**< height of video buffer */
1738         unsigned int timestamp;         /**< timestamp of stream buffer (msec)*/
1739         void *bo[BUFFER_MAX_PLANE_NUM]; /**< TBM buffer object */
1740         void *internal_buffer;          /**< Internal buffer pointer */
1741         int stride[BUFFER_MAX_PLANE_NUM];    /**< Stride of each plane */
1742         int elevation[BUFFER_MAX_PLANE_NUM]; /**< Elevation of each plane */
1743 } MMCamcorderVideoStreamDataType;
1744
1745
1746 /**
1747  * Structure for audio stream data.
1748  */
1749 typedef struct {
1750         void *data;                             /**< pointer of captured stream */
1751         unsigned int length;                    /**< length of stream buffer (in byte)*/
1752         MMCamcorderAudioFormat format;          /**< audio format */
1753         int channel;                            /**< number of channel of the stream */
1754         unsigned int timestamp;                 /**< timestamp of stream buffer (msec)*/
1755         float volume_dB;                        /**< dB value of audio stream */
1756 } MMCamcorderAudioStreamDataType;
1757
1758
1759 /**
1760   * Prerequisite information for mm_camcorder_create()
1761   * The information to set prior to create.
1762   */
1763 typedef struct {
1764         enum MMVideoDeviceType videodev_type;   /**< Video device type */
1765         /* For future use */
1766         int reserved[4];                        /**< reserved fields */
1767 } MMCamPreset;
1768
1769
1770 /**
1771  * Report structure of recording file
1772  */
1773 typedef struct {
1774         char *recording_filename;               /**< File name of stored recording file. Please free after using. */
1775 } MMCamRecordingReport; /**< report structure definition of recording file */
1776
1777
1778 /**
1779  * Face detect defailed information
1780  */
1781 typedef struct _MMCamFaceInfo {
1782         int id;                                 /**< id of each face */
1783         int score;                              /**< score of each face */
1784         MMRectType rect;                        /**< area of face */
1785 } MMCamFaceInfo;
1786
1787 /**
1788  * Face detect information
1789  */
1790 typedef struct _MMCamFaceDetectInfo {
1791         int num_of_faces;                       /**< number of detected faces */
1792         MMCamFaceInfo *face_info;               /**< face information, this should be freed after use it. */
1793 } MMCamFaceDetectInfo;
1794
1795 #ifdef HAVE_WAYLAND
1796 /**
1797  * Wayland information
1798  */
1799 typedef struct _MMCamWaylandInfo {
1800         int global_surface_id;
1801         int window_x;
1802         int window_y;
1803         int window_width;
1804         int window_height;
1805         void *evas_obj;
1806 } MMCamWaylandInfo;
1807 #endif /* HAVE_WAYLAND */
1808
1809 /*=======================================================================================
1810 | TYPE DEFINITIONS                                                                      |
1811 ========================================================================================*/
1812 /**
1813  *      Function definition for video stream callback.
1814  *  Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1815  *  mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1816  *  Please don't hang this function long. It may cause low performance of preview or occur timeout error from video source.
1817  *  Also, you're not allowed to call mm_camcorder_stop() even in other context, while you're hanging this function.
1818  *  I recommend to you releasing this function ASAP.
1819  *
1820  *      @param[in]      stream                  Reference pointer to video stream data
1821  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1822  *      @return         This function returns true on success, or false on failure.
1823  *      @remarks                This function is issued in the context of gstreamer (video sink thread).
1824  */
1825 typedef gboolean (*mm_camcorder_video_stream_callback)(MMCamcorderVideoStreamDataType *stream, void *user_param);
1826
1827
1828 /**
1829  *      Function definition for audio stream callback.
1830  *  Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1831  *  mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1832  *  Please don't hang this function long. It may cause low performance of camcorder or occur timeout error from audio source.
1833  *  I recommend to you releasing this function ASAP.
1834  *
1835  *      @param[in]      stream                  Reference pointer to audio stream data
1836  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1837  *      @return         This function returns true on success, or false on failure.
1838  *      @remarks
1839  */
1840 typedef gboolean (*mm_camcorder_audio_stream_callback)(MMCamcorderAudioStreamDataType *stream, void *user_param);
1841
1842
1843 /**
1844  *      Function definition for video capture callback.
1845  *  Like '#mm_camcorder_video_stream_callback', you can't call mm_camcorder_stop() while you are hanging this function.
1846  *
1847  *      @param[in]      frame                   Reference pointer to captured data
1848  *      @param[in]      thumbnail               Reference pointer to thumbnail data
1849  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1850  *      @return         This function returns true on success, or false on failure.
1851  *      @remarks                This function is issued in the context of gstreamer (video src thread).
1852  */
1853 typedef gboolean (*mm_camcorder_video_capture_callback)(MMCamcorderCaptureDataType *frame, MMCamcorderCaptureDataType *thumbnail, void *user_param);
1854
1855
1856 /*=======================================================================================
1857 | GLOBAL FUNCTION PROTOTYPES                                                            |
1858 ========================================================================================*/
1859 /**
1860  *    mm_camcorder_create:\n
1861  *  Create camcorder object. This is the function that an user who wants to use mm_camcorder calls first.
1862  *  This function creates handle structure and initialize mutex, attributes, gstreamer.
1863  *  When this function success, it will return  a handle of newly created object.
1864  *  A user have to put the handle when he calls every function of mm_camcorder. \n
1865  *  Second argument of this function is the field to decribe pre-setting information of mm_camcorder such as which camera device it will use.
1866  *  Normally, MM_VIDEO_DEVICE_CAMERA0 is for Main camera(or Mega camera, Back camera),
1867  *  and MM_VIDEO_DEVICE_CAMERA1 is for VGA camera (or Front camera). If you want audio recording,
1868  *  please set MM_VIDEO_DEVICE_NONE. (No camera device is needed.)
1869  *
1870  *      @param[out]     camcorder       A handle of camcorder.
1871  *      @param[in]      info            Information for camera device. Depending on this information,
1872  *                                      camcorder opens different camera devices.
1873  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1874  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
1875  *      @see            mm_camcorder_destroy
1876  *      @pre            None
1877  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_NULL
1878  *      @remarks        You can create multiple handles on a context at the same time. However,
1879  *                      camcorder cannot guarantee proper operation because of limitation of resources, such as
1880  *                      camera device, audio device, and display device.
1881  *      @par example
1882  *      @code
1883
1884 #include <mm_camcorder.h>
1885
1886 gboolean initialize_camcorder()
1887 {
1888         int err;
1889         MMCamPreset cam_info;
1890 #if 1
1891         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
1892 #else
1893         // when you want to record audio only, enable this.
1894         cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
1895 #endif
1896
1897         err = mm_camcorder_create(&hcam, &cam_info);
1898
1899         if (err != MM_ERROR_NONE) {
1900                 printf("Fail to call mm_camcorder_create = %x\n", err);
1901                 return FALSE;
1902         }
1903
1904         return TRUE;
1905 }
1906
1907  *      @endcode
1908  */
1909 int mm_camcorder_create(MMHandleType *camcorder, MMCamPreset *info);
1910
1911
1912 /**
1913  *    mm_camcorder_destroy:\n
1914  *  Destroy camcorder object. Release handle and all of the resources that were created in mm_camcorder_create().\n
1915  *  This is the finalizing function of mm_camcorder. If this function is not called or fails to call, the handle isn't released fully.
1916  *  This function releases attributes, mutexes, sessions, and handle itself. This function also removes all of remaining messages.
1917  *  So if your application should wait a certain message of mm_camcorder, please wait to call this function till getting the message.
1918  *      
1919  *
1920  *      @param[in]      camcorder       A handle of camcorder.
1921  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1922  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
1923  *      @see            mm_camcorder_create
1924  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_NULL
1925  *      @post           Because the handle is not valid, you can't check the state.
1926  *      @remarks        None
1927  *      @par example
1928  *      @code
1929
1930 #include <mm_camcorder.h>
1931
1932 gboolean destroy_camcorder()
1933 {
1934         int err;
1935
1936         //Destroy camcorder handle
1937         err = mm_camcorder_destroy(hcam);
1938         if (err < 0) {
1939                 printf("Fail to call mm_camcorder_destroy  = %x\n", err);
1940                 return FALSE;
1941         }
1942
1943         return TRUE;
1944 }
1945
1946  *      @endcode
1947  */
1948 int mm_camcorder_destroy(MMHandleType camcorder);
1949
1950
1951 /**
1952  *    mm_camcorder_realize:\n
1953  *  Allocate resources for camcorder and initialize it.
1954  *  This also creates streamer pipeline. So you have to set attributes that are pivotal to create
1955  *  the pipeline before calling this function. This function also takes a roll to manage confliction
1956  *  between different applications which use camcorder. For example, if you try to use camcorder when
1957  *  other application that is more important such as call application, this function will return
1958  *  'MM_ERROR_POLICY_BLOCKED'. On the contrary, if your application that uses camcorder starts to launch
1959  *  while another application that uses speaker and has lower priority, your application will kick
1960  *  another application.
1961  *
1962  *      @param[in]      camcorder       A handle of camcorder.
1963  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1964  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
1965  *      @see            mm_camcorder_unrealize
1966  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_NULL
1967  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_READY
1968  *      @remarks        None
1969  *      @par example
1970  *      @code
1971
1972 #include <mm_camcorder.h>
1973
1974 //For image capturing
1975 gboolean initialize_image_capture()
1976 {
1977         int err;
1978         MMCamPreset cam_info;
1979         char *err_attr_name = NULL;
1980         void * hdisplay = NULL;
1981         int hsize = 0;
1982
1983         //Set video device as 'camera0' (main camera device)
1984         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
1985
1986         err = mm_camcorder_create(&hcam, &cam_info);
1987
1988         if (err != MM_ERROR_NONE) {
1989                 printf("Fail to call mm_camcorder_create = %x\n", err);
1990                 return FALSE;
1991         }
1992
1993         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
1994         mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
1995
1996         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
1997         hsize = sizeof(ad.xid);         //size of xid structure.
1998
1999         // camcorder attribute setting
2000         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2001                                           MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2002                                           MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2003                                           MMCAM_CAMERA_WIDTH, 640,
2004                                           MMCAM_CAMERA_HEIGHT, 480,
2005                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2006                                           MMCAM_CAMERA_FPS, 30,
2007                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2008                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,          hsize,
2009                                           MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
2010                                           MMCAM_CAPTURE_WIDTH, 640,
2011                                           MMCAM_CAPTURE_HEIGHT, 480,
2012                                           NULL);
2013
2014         if (err < 0) {
2015                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2016                 if (err_attr_name) {
2017                         free(err_attr_name);
2018                         err_attr_name = NULL;
2019                         return FALSE;
2020                 }
2021         }
2022
2023         err =  mm_camcorder_realize(hcam);
2024         if (err < 0) {
2025                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2026                 return FALSE;
2027         }
2028
2029         return TRUE;
2030 }
2031
2032 //For A/V capturing
2033 gboolean initialize_video_capture()
2034 {
2035         int err;
2036         MMCamPreset cam_info;
2037         char *err_attr_name = NULL;
2038         void * hdisplay = NULL;
2039         int hsize = 0;
2040
2041         //Set video device as 'camera0' (main camera device)
2042         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2043
2044         err = mm_camcorder_create(&hcam, &cam_info);
2045
2046         if (err != MM_ERROR_NONE) {
2047                 printf("Fail to call mm_camcorder_create = %x\n", err);
2048                 return FALSE;
2049         }
2050
2051         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, hcam);
2052
2053         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2054         hsize = sizeof(ad.xid);         //size of xid structure.
2055
2056         // camcorder attribute setting
2057         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2058                                           MMCAM_MODE, MM_CAMCORDER_MODE_VIDEO,
2059                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2060                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2061                                           MMCAM_VIDEO_ENCODER, MM_VIDEO_CODEC_MPEG4,
2062                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2063                                           MMCAM_CAMERA_WIDTH, 1280,
2064                                           MMCAM_CAMERA_HEIGHT, 720,
2065                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_NV12,
2066                                           MMCAM_CAMERA_FPS, 30,
2067                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2068                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2069                                           MMCAM_AUDIO_CHANNEL, 2,
2070                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2071                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,               hsize,
2072                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2073                                           NULL);
2074
2075         if (err < 0) {
2076                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2077                 if (err_attr_name) {
2078                         free(err_attr_name);
2079                         err_attr_name = NULL;
2080                         return FALSE;
2081                 }
2082         }
2083
2084         err =  mm_camcorder_realize(hcam);
2085         if (err < 0) {
2086                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2087                 return FALSE;
2088         }
2089
2090         return TRUE;
2091 }
2092
2093 //For audio(only) capturing
2094 gboolean initialize_audio_capture()
2095 {
2096         int err;
2097         MMCamPreset cam_info;
2098         char *err_attr_name = NULL;
2099         void * hdisplay = NULL;
2100         int hsize = 0;
2101
2102         //Set no video device, because audio recording doesn't need video input.
2103         cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
2104
2105         err = mm_camcorder_create(&hcam, &cam_info);
2106
2107         if (err != MM_ERROR_NONE) {
2108                 printf("Fail to call mm_camcorder_create = %x\n", err);
2109                 return FALSE;
2110         }
2111
2112         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2113
2114         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2115         hsize = sizeof(ad.xid);         //size of xid structure.
2116
2117         // camcorder attribute setting
2118         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2119                                           MMCAM_MODE, MM_CAMCORDER_MODE_AUDIO,
2120                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2121                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2122                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2123                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2124                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2125                                           MMCAM_AUDIO_CHANNEL, 2,
2126                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2127                                           MMCAM_TARGET_TIME_LIMIT, 360000,
2128                                           NULL);
2129
2130         if (err < 0) {
2131                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2132                 if (err_attr_name) {
2133                         free(err_attr_name);
2134                         err_attr_name = NULL;
2135                         return FALSE;
2136                 }
2137         }
2138
2139         err =  mm_camcorder_realize(hcam);
2140         if (err < 0) {
2141                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2142                 return FALSE;
2143         }
2144
2145         return TRUE;
2146 }
2147  *      @endcode
2148  */
2149 int mm_camcorder_realize(MMHandleType camcorder);
2150
2151
2152 /**
2153  *    mm_camcorder_unrealize:\n
2154  *  Uninitialize camcoder resources and free allocated memory.
2155  *  Most important resource that is released here is gstreamer pipeline of mm_camcorder.
2156  *  Because most of resources, such as camera device, video display device, and audio I/O device, are operating on the gstreamer pipeline,
2157  *  this function should be called to release its resources.
2158  *  Moreover, mm_camcorder is controlled by audio session manager. If an user doesn't call this function when he want to release mm_camcorder,
2159  *  other multimedia frameworks may face session problem. For more detail information, please refer mm_session module.
2160  *
2161  *      @param[in]      camcorder       A handle of camcorder.
2162  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2163  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2164  *      @see            mm_camcorder_realize
2165  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_READY
2166  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_NULL
2167  *      @remarks        None
2168  *      @par example
2169  *      @code
2170
2171 #include <mm_camcorder.h>
2172
2173 gboolean unrealize_camcorder()
2174 {
2175         int err;
2176
2177         //Release all resources of camcorder handle
2178         err =  mm_camcorder_unrealize(hcam);
2179         if (err < 0) {
2180                 printf("Fail to call mm_camcorder_unrealize  = %x\n", err);
2181                 return FALSE;
2182         }
2183
2184         return TRUE;
2185 }
2186
2187  *      @endcode
2188  */
2189 int mm_camcorder_unrealize(MMHandleType camcorder);
2190
2191
2192 /**
2193  *      mm_camcorder_start:\n
2194  *   Start previewing. (Image/Video mode)
2195  *  'mm_camcorder_video_stream_callback' is activated after calling this function.
2196  *
2197  *      @param[in]      camcorder       A handle of camcorder.
2198  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2199  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2200  *      @see            mm_camcorder_stop
2201  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_READY
2202  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2203  *      @remarks        None
2204  *      @par example
2205  *      @code
2206
2207 #include <mm_camcorder.h>
2208
2209 //For image capturing
2210 gboolean initialize_image_capture()
2211 {
2212         int err;
2213         MMCamPreset cam_info;
2214         char *err_attr_name = NULL;
2215         void * hdisplay = NULL;
2216         int hsize = 0;
2217
2218         //Set video device as 'camera0' (main camera device)
2219         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2220
2221         err = mm_camcorder_create(&hcam, &cam_info);
2222
2223         if (err != MM_ERROR_NONE) {
2224                         printf("Fail to call mm_camcorder_create = %x\n", err);
2225                         return FALSE;
2226         }
2227
2228         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2229         mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2230
2231         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2232         hsize = sizeof(ad.xid);         //size of xid structure.
2233
2234         // camcorder attribute setting
2235         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2236                                           MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2237                                           MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2238                                           MMCAM_CAMERA_WIDTH, 640,
2239                                           MMCAM_CAMERA_HEIGHT, 480,
2240                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2241                                           MMCAM_CAMERA_FPS, 30,
2242                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2243                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,          hsize,
2244                                           MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
2245                                           MMCAM_CAPTURE_WIDTH, 640,
2246                                           MMCAM_CAPTURE_HEIGHT, 480,
2247                                           NULL);
2248
2249         if (err < 0) {
2250                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2251                 if (err_attr_name) {
2252                         free(err_attr_name);
2253                         err_attr_name = NULL;
2254                         return FALSE;
2255                 }
2256         }
2257
2258         err =  mm_camcorder_realize(hcam);
2259         if (err < 0) {
2260                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2261                 return FALSE;
2262         }
2263
2264         // start camcorder
2265         err = mm_camcorder_start(hcam);
2266         if (err < 0) {
2267                 printf("Fail to call mm_camcorder_start  = %x\n", err);
2268                 return FALSE;
2269         }
2270
2271         return TRUE;
2272 }
2273
2274 //For A/V capturing
2275 gboolean initialize_video_capture()
2276 {
2277         int err;
2278         MMCamPreset cam_info;
2279         char *err_attr_name = NULL;
2280         void * hdisplay = NULL;
2281         int hsize = 0;
2282
2283         //Set video device as 'camera0' (main camera device)
2284         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2285
2286         err = mm_camcorder_create(&hcam, &cam_info);
2287
2288         if (err != MM_ERROR_NONE) {
2289                         printf("Fail to call mm_camcorder_create = %x\n", err);
2290                         return FALSE;
2291         }
2292
2293         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, hcam);
2294
2295         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2296         hsize = sizeof(ad.xid);         //size of xid structure.
2297
2298         // camcorder attribute setting
2299         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2300                                           MMCAM_MODE, MM_CAMCORDER_MODE_VIDEO,
2301                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2302                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2303                                           MMCAM_VIDEO_ENCODER, MM_VIDEO_CODEC_MPEG4,
2304                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2305                                           MMCAM_CAMERA_WIDTH, 1280,
2306                                           MMCAM_CAMERA_HEIGHT, 720,
2307                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_NV12,
2308                                           MMCAM_CAMERA_FPS, 30,
2309                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2310                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2311                                           MMCAM_AUDIO_CHANNEL, 2,
2312                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2313                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,               hsize,
2314                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2315                                           NULL);
2316
2317         if (err < 0) {
2318                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2319                 if (err_attr_name) {
2320                         free(err_attr_name);
2321                         err_attr_name = NULL;
2322                         return FALSE;
2323                 }
2324         }
2325
2326         err =  mm_camcorder_realize(hcam);
2327         if (err < 0) {
2328                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2329                 return FALSE;
2330         }
2331
2332         // start camcorder
2333         err = mm_camcorder_start(hcam);
2334         if (err < 0) {
2335                 printf("Fail to call mm_camcorder_start  = %x\n", err);
2336                 return FALSE;
2337         }
2338
2339         return TRUE;
2340 }
2341
2342 //For audio(only) capturing
2343 gboolean initialize_audio_capture()
2344 {
2345         int err;
2346         MMCamPreset cam_info;
2347         char *err_attr_name = NULL;
2348         void * hdisplay = NULL;
2349         int hsize = 0;
2350
2351         //Set no video device, because audio recording doesn't need video input.
2352         cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
2353
2354         err = mm_camcorder_create(&hcam, &cam_info);
2355
2356         if (err != MM_ERROR_NONE) {
2357                 printf("Fail to call mm_camcorder_create = %x\n", err);
2358                 return FALSE;
2359         }
2360
2361         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2362
2363         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2364         hsize = sizeof(ad.xid);         //size of xid structure.
2365
2366         // camcorder attribute setting
2367         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2368                                           MMCAM_MODE, MM_CAMCORDER_MODE_AUDIO,
2369                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2370                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2371                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2372                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2373                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2374                                           MMCAM_AUDIO_CHANNEL, 2,
2375                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2376                                           MMCAM_TARGET_TIME_LIMIT, 360000,
2377                                           NULL);
2378
2379         if (err < 0) {
2380                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2381                 if (err_attr_name) {
2382                         free(err_attr_name);
2383                         err_attr_name = NULL;
2384                         return FALSE;
2385                 }
2386         }
2387
2388         err =  mm_camcorder_realize(hcam);
2389         if (err < 0) {
2390                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2391                 return FALSE;
2392         }
2393
2394         // start camcorder
2395         err = mm_camcorder_start(hcam);
2396         if (err < 0) {
2397                 printf("Fail to call mm_camcorder_start  = %x\n", err);
2398                 return FALSE;
2399         }
2400
2401         return TRUE;
2402 }
2403  *      @endcode
2404  */
2405 int mm_camcorder_start(MMHandleType camcorder);
2406
2407
2408 /**
2409  *    mm_camcorder_stop:\n
2410  *  Stop previewing. (Image/Video mode)
2411  *  This function will change the status of pipeline. If an application doesn't return callbacks
2412  *  of camcorder, this function can be locked. For example, if your application still
2413  *  holds '#mm_camcorder_video_capture_callback' or '#mm_camcorder_video_stream_callback',
2414  *  this function could be hung. So users have to return every callback before calling this function.
2415  *
2416  *      @param[in]      camcorder       A handle of camcorder.
2417  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2418  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2419  *      @see            mm_camcorder_start
2420  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2421  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_READY
2422  *      @remarks        None
2423  *      @par example
2424  *      @code
2425
2426 #include <mm_camcorder.h>
2427
2428 gboolean stop_camcorder()
2429 {
2430         int err;
2431
2432         //Stop preview
2433         err =  mm_camcorder_stop(hcam);
2434         if (err < 0) {
2435                 printf("Fail to call mm_camcorder_stop  = %x\n", err);
2436                 return FALSE;
2437         }
2438
2439         return TRUE;
2440 }
2441
2442  *      @endcode
2443  */
2444 int mm_camcorder_stop(MMHandleType camcorder);
2445
2446
2447 /**
2448  *    mm_camcorder_capture_start:\n
2449  *  Start capturing of still images. (Image mode only)
2450  *  Captured image will be delievered through 'mm_camcorder_video_capture_callback'.
2451  *  So basically, the operation is working asynchronously. \n
2452  *  When a user call this function, MSL will stop to retrieving preview from camera device.
2453  *  Then set capture resolution, pixel format, and encoding type to camera driver. After resuming,
2454  *  camera can get still image.  A user will be notified by
2455  *  'MM_MESSAGE_CAMCORDER_CAPTURED' message when capturing succeed. When a user sets
2456  *  multishot (by setting multiple number to MMCAM_CAPTURE_COUNT), the message
2457  *  will be called multiple time. You can get the number of image from 'code' of
2458  *  'MMMessageParamType'.
2459  *
2460  *      @param[in]      camcorder       A handle of camcorder.
2461  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2462  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2463  *      @see            mm_camcorder_capture_stop
2464  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2465  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_CAPTURING
2466  *      @remarks        To call this function, preview should be started successfully.\n
2467  *                      This function is a pair of mm_camcorder_capture_stop(). 
2468  *                      So user should call mm_camcorder_capture_stop() after getting captured image.
2469  *      @par example
2470  *      @code
2471
2472 #include <mm_camcorder.h>
2473
2474 gboolean capturing_picture()
2475 {
2476         int err;
2477
2478         err =  mm_camcorder_capture_start(hcam);
2479         if (err < 0) 
2480         {
2481                 printf("Fail to call mm_camcorder_capture_start  = %x\n", err);
2482                 return FALSE;
2483         }
2484
2485         //mm_camcorder_capture_stop should be called after getting
2486         //MM_MESSAGE_CAMCORDER_CAPTURED message.
2487
2488         return TRUE;
2489 }
2490
2491
2492  *      @endcode
2493  */
2494 int mm_camcorder_capture_start(MMHandleType camcorder);
2495
2496
2497 /**
2498  *    mm_camcorder_capture_stop:\n
2499  *  Stop capturing of still images. (Image mode only)
2500  *  This function notifies the end of capturing and launch preview again.
2501  *  Just as mm_camcorder_capture_start(), this funciton stops still image stream and set preview information such as
2502  *  resolution, pixel format, and framerate to camera driver. Then it command to start preview.
2503  *  If you don't call this, preview will not be displayed even though capturing was finished.
2504  *
2505  *      @param[in]      camcorder       A handle of camcorder.
2506  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2507  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2508  *      @see            mm_camcorder_capture_start
2509  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_CAPTURING
2510  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2511  *      @remarks        To call this function, a user has to call mm_camcorder_capture_start() first.\n
2512  *                      This is not a function to stop multishot in the middle of operation. For that,
2513  *                      please use '#MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT' instead.
2514  *      @par example
2515  *      @code
2516
2517 #include <mm_camcorder.h>
2518
2519 gboolean capturing_picture_stop()
2520 {
2521         int err;
2522
2523         err =  mm_camcorder_capture_stop(hcam);
2524         if (err < 0) {
2525                 printf("Fail to call mm_camcorder_capture_stop  = %x\n", err);
2526                 return FALSE;
2527         }
2528
2529         //After calling upper function, preview will start.
2530
2531         return TRUE;
2532 }
2533
2534  *      @endcode
2535  */
2536 int mm_camcorder_capture_stop(MMHandleType camcorder);
2537
2538
2539 /**
2540  *    mm_camcorder_record:\n
2541  *  Start recording. (Audio/Video mode only)
2542  *  Camcorder starts to write a file when you call this function. You can specify the name of file
2543  *  using '#MMCAM_TARGET_FILENAME'. Beware, if you fail to call mm_camcorder_commit() or mm_camcorder_cancel(),
2544  *  the recorded file is still on the storage.
2545  *
2546  *      @param[in]      camcorder       A handle of camcorder.
2547  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2548  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2549  *      @see            mm_camcorder_pause
2550  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2551  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_RECORDING
2552  *      @remarks        None
2553  *      @par example
2554  *      @code
2555
2556 #include <mm_camcorder.h>
2557
2558 gboolean record_and_cancel_video_file()
2559 {
2560         int err;
2561
2562         // Start recording
2563         err =  mm_camcorder_record(hcam);
2564         if (err < 0) {
2565                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2566                 return FALSE;
2567         }
2568
2569         return TRUE;
2570 }
2571
2572  *      @endcode
2573  */
2574 int mm_camcorder_record(MMHandleType camcorder);
2575
2576
2577 /**
2578  *    mm_camcorder_pause:\n
2579  *  Pause A/V recording or Audio recording. (Audio/Video mode only)
2580  *  On video recording, you can see preview while on pausing. So mm_camcorder cuts video stream path to encoder and keep the flow to preview.
2581  *  If you call mm_camcorder_commit() while on pausing, the recorded file only has Audio and Video stream which were generated before pause().
2582  *
2583  *      @param[in]      camcorder       A handle of camcorder.
2584  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2585  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2586  *      @see            mm_camcorder_record
2587  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2588  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PAUSED
2589  *      @remarks        Even though this function is for pausing recording, small amount of buffers could be recorded after pause().
2590  *                      Because the buffers which are existed in the queue were created before pause(), the buffers should be recorded.
2591  *      @par example
2592  *      @code
2593
2594 #include <mm_camcorder.h>
2595
2596 gboolean record_pause_and_resume_recording()
2597 {
2598         int err;
2599
2600         // Start recording
2601         err =  mm_camcorder_record(hcam);
2602         if (err < 0) {
2603                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2604                 return FALSE;
2605         }
2606
2607         // Wait while recording...
2608
2609         // Pause
2610         err =  mm_camcorder_pause(hcam);
2611         if (err < 0) {
2612                 printf("Fail to call mm_camcorder_pause  = %x\n", err);
2613                 return FALSE;
2614         }
2615
2616         // Pausing...
2617
2618         // Resume
2619         err =  mm_camcorder_record(hcam);
2620         if (err < 0) {
2621                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2622                 return FALSE;
2623         }
2624
2625         return TRUE;
2626 }
2627
2628
2629  *      @endcode
2630  */
2631 int mm_camcorder_pause(MMHandleType camcorder);
2632
2633
2634 /**
2635  *    mm_camcorder_commit:\n
2636  *  Stop recording and save results.  (Audio/Video mode only)\n
2637  *  After starting recording, encoded data frame will be stored in the location specified in MMCAM_TARGET_FILENAME.
2638  *  Some encoder or muxer require a certain type of finalizing such as adding some information to header.
2639  *  This function takes that roll. So if you don't call this function after recording, the result file may not be playable.\n
2640  *  After committing successfully, camcorder resumes displaying preview (video recording case).
2641  *  Because this is the function for saving the recording result, the operation is available
2642  *  only when the mode of camcorder is MM_CAMCORDER_MODE_AUDIO or MM_CAMCORDER_MODE_VIDEO.
2643  *
2644  *      @param[in]      camcorder       A handle of camcorder.
2645  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2646  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2647  *      @see            mm_camcorder_cancel
2648  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2649  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2650  *      @remarks        This function can take a few second when recording time is long.
2651  *                      and if there are only quite few input buffer from video src or audio src,
2652  *                      committing could be failed.
2653  *      @par example
2654  *      @code
2655
2656 #include <mm_camcorder.h>
2657
2658 gboolean record_and_save_video_file()
2659 {
2660         int err;
2661
2662         // Start recording
2663         err =  mm_camcorder_record(hcam);
2664         if (err < 0) {
2665                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2666                 return FALSE;
2667         }
2668
2669         // Wait while recording for test...
2670         // In normal case, mm_camcorder_record() and mm_camcorder_commit() aren't called in the same function.
2671
2672         // Save file
2673         err =  mm_camcorder_commit(hcam);
2674         if (err < 0) {
2675                 printf("Fail to call mm_camcorder_commit  = %x\n", err);
2676                 return FALSE;
2677         }
2678
2679         return TRUE;
2680 }
2681
2682  *      @endcode
2683  */
2684 int mm_camcorder_commit(MMHandleType camcorder);
2685
2686
2687 /**
2688  *      mm_camcorder_cancel:\n
2689  *    Stop recording and discard the result. (Audio/Video mode only)
2690  *      When a user want to finish recording without saving the result file, this function can be used.
2691  *      Like mm_camcorder_commit(), this function also stops recording, release related resources(like codec) ,and goes back to preview status.
2692  *      However, instead of saving file, this function unlinks(delete) the result.\n
2693  *      Because this is the function for canceling recording, the operation is available
2694  *      only when mode is MM_CAMCORDER_MODE_AUDIO or MM_CAMCORDER_MODE_VIDEO.
2695  *
2696  *      @param[in]      camcorder       A handle of camcorder.
2697  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2698  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2699  *      @see            mm_camcorder_commit
2700  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2701  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2702  *      @remarks        None
2703  *      @par example
2704  *      @code
2705
2706 #include <mm_camcorder.h>
2707
2708 gboolean record_and_cancel_video_file()
2709 {
2710         int err;
2711
2712         // Start recording
2713         err =  mm_camcorder_record(hcam);
2714         if (err < 0) {
2715                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2716                 return FALSE;
2717         }
2718
2719         // Wait while recording...
2720
2721         // Cancel recording
2722         err =  mm_camcorder_cancel(hcam);
2723         if (err < 0) {
2724                 printf("Fail to call mm_camcorder_cancel  = %x\n", err);
2725                 return FALSE;
2726         }
2727
2728         return TRUE;
2729 }
2730
2731  *      @endcode
2732  */
2733 int mm_camcorder_cancel(MMHandleType camcorder);
2734
2735
2736 /**
2737  *    mm_camcorder_set_message_callback:\n
2738  *  Set callback for receiving messages from camcorder. Through this callback function, camcorder
2739  *  sends various message including status changes, asynchronous error, capturing, and limitations.
2740  *  One thing you have to know is that message callback is working on the main loop of application.
2741  *  So until releasing the main loop, message callback will not be called.
2742  *
2743  *      @param[in]      camcorder       A handle of camcorder.
2744  *      @param[in]      callback        Function pointer of callback function. Please refer 'MMMessageCallback'.
2745  *      @param[in]      user_data       User parameter for passing to callback function.
2746  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2747  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2748  *      @see            MMMessageCallback
2749  *      @pre            None
2750  *      @post           None
2751  *      @remarks        registered 'callback' is called on main loop of the application. So until the main loop is released, 'callback' will not be called.
2752  *      @par example
2753  *      @code
2754
2755 #include <mm_camcorder.h>
2756
2757 gboolean setting_msg_callback()
2758 {
2759         //set callback
2760         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2761
2762         return TRUE;
2763 }
2764
2765
2766  *      @endcode
2767  */
2768 int mm_camcorder_set_message_callback(MMHandleType camcorder, MMMessageCallback callback, void *user_data);
2769
2770
2771 /**
2772  *    mm_camcorder_set_video_stream_callback:\n
2773  *  Set callback for user defined video stream callback function.
2774  *  Users can retrieve video frame using registered callback.
2775  *  The callback function holds the same buffer that will be drawed on the display device.
2776  *  So if an user change the buffer, it will be displayed on the device.
2777  *
2778  *      @param[in]      camcorder       A handle of camcorder.
2779  *      @param[in]      callback        Function pointer of callback function.
2780  *      @param[in]      user_data       User parameter for passing to callback function.
2781  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2782  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2783  *      @see            mm_camcorder_video_stream_callback
2784  *      @pre            None
2785  *      @post           None
2786  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2787  *      @par example
2788  *      @code
2789
2790 #include <mm_camcorder.h>
2791
2792 gboolean setting_video_stream_callback()
2793 {
2794         //set callback
2795         mm_camcorder_set_video_stream_callback(hcam, (mm_camcorder_video_stream_callback)camcordertest_video_stream_cb, (void*)hcam);
2796
2797         return TRUE;
2798 }
2799  *      @endcode
2800  */
2801 int mm_camcorder_set_video_stream_callback(MMHandleType camcorder, mm_camcorder_video_stream_callback callback, void *user_data);
2802
2803
2804 /**
2805  *    mm_camcorder_set_video_capture_callback:\n
2806  *  Set callback for user defined video capture callback function.  (Image mode only)
2807  *  mm_camcorder deliever captured image through the callback.\n
2808  *  Normally, this function provides main captured image and thumnail image. But depending on the environment,
2809  *  thumnail would not be available. Information related with main captured image and thumnail image is also included
2810  *  in the argument of the callback function.
2811  *  For more detail information of callback, please refer 'mm_camcorder_video_capture_callback'.
2812  *
2813  *      @param[in]      camcorder       A handle of camcorder.
2814  *      @param[in]      callback        Function pointer of callback function.
2815  *      @param[in]      user_data       User parameter for passing to callback function.
2816  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2817  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2818  *      @see            mm_camcorder_video_capture_callback
2819  *      @pre            None
2820  *      @post           None
2821  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2822  *      @par example
2823  *      @code
2824
2825 #include <mm_camcorder.h>
2826
2827 gboolean setting_capture_callback()
2828 {
2829         //set callback
2830         mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2831
2832         return TRUE;
2833 }
2834  *      @endcode
2835  */
2836 int mm_camcorder_set_video_capture_callback(MMHandleType camcorder, mm_camcorder_video_capture_callback callback, void *user_data);
2837
2838
2839 /**
2840  *    mm_camcorder_set_audio_stream_callback:\n
2841  *  Set callback for user defined audio stream callback function.
2842  *  Users can retrieve audio data using registered callback.
2843  *  The callback function holds the same buffer that will be recorded.
2844  *  So if an user change the buffer, the result file will has the buffer.
2845  *
2846  *      @param[in]      camcorder       A handle of camcorder.
2847  *      @param[in]      callback        Function pointer of callback function.
2848  *      @param[in]      user_data       User parameter for passing to callback function.
2849  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2850  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2851  *      @see            mm_camcorder_audio_stream_callback
2852  *      @pre            None
2853  *      @post           None
2854  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2855  *      @par example
2856  *      @code
2857
2858 #include <mm_camcorder.h>
2859
2860 gboolean setting_audio_stream_callback()
2861 {
2862         //set callback
2863         mm_camcorder_set_audio_stream_callback(hcam, (mm_camcorder_audio_stream_callback)camcordertest_audio_stream_cb, (void*)hcam);
2864
2865         return TRUE;
2866 }
2867  *      @endcode
2868  */
2869 int mm_camcorder_set_audio_stream_callback(MMHandleType camcorder, mm_camcorder_audio_stream_callback callback, void *user_data);
2870
2871
2872 /**
2873  *    mm_camcorder_get_state:\n
2874  *  Get the current state of camcorder.
2875  *  mm_camcorder is working on the base of its state. An user should check the state of mm_camcorder before calling its functions.
2876  *  If the handle is avaiable, user can retrieve the value.
2877  *
2878  *      @param[in]      camcorder       A handle of camcorder.
2879  *      @param[out]     state           On return, it contains current state of camcorder.
2880  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2881  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2882  *      @see            MMCamcorderStateType
2883  *      @pre            None
2884  *      @post           None
2885  *      @remarks        None
2886  *      @par example
2887  *      @code
2888
2889 #include <mm_camcorder.h>
2890
2891 gboolean get_state_of_camcorder()
2892 {
2893         MMCamcorderStateType state;
2894
2895         //Get state of camcorder
2896         mm_camcorder_get_state(hcam, &state);
2897         printf("Current status is %d\n", state);
2898
2899         return TRUE;
2900 }
2901
2902  *      @endcode
2903  */
2904 int mm_camcorder_get_state(MMHandleType camcorder, MMCamcorderStateType *state);
2905
2906
2907 /**
2908  *    mm_camcorder_get_attributes:\n
2909  *  Get attributes of camcorder with given attribute names. This function can get multiple attributes
2910  *  simultaneously. If one of attribute fails, this function will stop at the point.
2911  *  'err_attr_name' let you know the name of the attribute.
2912  *
2913  *      @param[in]      camcorder       Specifies the camcorder  handle.
2914  *      @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. @n
2915  *                                      Free this variable after using.
2916  *      @param[in]      attribute_name  attribute name that user want to get.
2917  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2918  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2919  *      @pre            None
2920  *      @post           None
2921  *      @remarks        You can retrieve multiple attributes at the same time.  @n
2922  *                      This function must finish with 'NULL' argument.  @n
2923  *                      ex) mm_camcorder_get_attributes(....... , NULL);
2924  *      @see            mm_camcorder_set_attributes
2925  *      @par example
2926  *      @code
2927
2928 #include <mm_camcorder.h>
2929
2930 gboolean getting_attribute()
2931 {
2932         int err;
2933         MMCamPreset cam_info;
2934         char *err_attr_name = NULL;
2935         void * hdisplay = NULL;
2936         int hsize = 0;
2937
2938         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2939         hsize = sizeof(ad.xid);         //size of xid structure.
2940
2941         // camcorder attribute setting
2942         err = mm_camcorder_get_attributes(hcamcorder, NULL,     //The second is the argument for debugging. But you can skip this.
2943                                           MMCAM_MODE,  &mode,   //You have to input a pointer instead of variable itself.
2944                                           NULL);                //mm_camcorder_set_attributes() should be finished with a NULL argument.
2945
2946         return TRUE;
2947 }
2948
2949  *      @endcode
2950  */
2951 int mm_camcorder_get_attributes(MMHandleType camcorder,  char **err_attr_name, const char *attribute_name, ...) G_GNUC_NULL_TERMINATED;
2952
2953
2954
2955 /**
2956  *    mm_camcorder_set_attributes:\n
2957  *  Set attributes of camcorder with given attribute names. This function can set multiple attributes
2958  *  simultaneously. If one of attribute fails, this function will stop at the point.
2959  *  'err_attr_name' let you know the name of the attribute.
2960  *
2961  *      @param[in]      camcorder       Specifies the camcorder  handle.
2962  *      @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. @n
2963  *                                      Free this variable after using.
2964  *      @param[in]      attribute_name  attribute name that user want to set.
2965  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2966  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2967  *      @pre            None
2968  *      @post           None
2969  *      @remarks        You can put multiple attributes to camcorder at the same time.  @n
2970  *                      This function must finish with 'NULL' argument.  @n
2971  *                      ex) mm_camcorder_set_attributes(....... , NULL);
2972  *      @see            mm_camcorder_get_attributes
2973  *      @par example
2974  *      @code
2975
2976 #include <mm_camcorder.h>
2977
2978 gboolean setting_attribute()
2979 {
2980         int err;
2981         MMCamPreset cam_info;
2982         char *err_attr_name = NULL;
2983         void * hdisplay = NULL;
2984         int hsize = 0;
2985
2986         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2987         hsize = sizeof(ad.xid);         //size of xid structure.
2988
2989         // camcorder attribute setting
2990         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,           //The second is the argument for debugging.
2991                                           MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2992                                           MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2993                                           MMCAM_CAMERA_WIDTH, 640,
2994                                           MMCAM_CAMERA_HEIGHT, 480,
2995                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2996                                           MMCAM_CAMERA_FPS, 30,
2997                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2998                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,          hsize,               //Beware some types require 'size' value, too. (STRING, DATA type attributes)
2999                                           MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
3000                                           MMCAM_CAPTURE_WIDTH, 640,
3001                                           MMCAM_CAPTURE_HEIGHT, 480,
3002                                           NULL);                //mm_camcorder_set_attributes() should be finished with a NULL argument.
3003
3004         if (err < 0) {
3005                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);                //When the function failed, 'err_attr_name' has the name of attr that made the error.
3006                 if (err_attr_name) {
3007                         free(err_attr_name);                    //Please free 'err_attr_name', after using the argument.
3008                         err_attr_name = NULL;
3009                         return FALSE;
3010                 }
3011         }
3012
3013         return TRUE;
3014 }
3015  *      @endcode
3016  */
3017 int mm_camcorder_set_attributes(MMHandleType camcorder,  char **err_attr_name, const char *attribute_name, ...) G_GNUC_NULL_TERMINATED;
3018
3019
3020 /**
3021  *    mm_camcorder_get_attribute_info:\n
3022  *  Get detail information of the attribute. To manager attributes, an user may want to know the exact character of the attribute,
3023  *  such as type, flag, and validity. This is the function to provide such information.
3024  *  Depending on the 'validity_type', validity union would be different. To know about the type of union, please refer 'MMCamAttrsInfo'.
3025  *
3026  *      @param[in]      camcorder       Specifies the camcorder  handle.
3027  *      @param[in]      attribute_name  attribute name that user want to get information.
3028  *      @param[out]     info            a structure that holds information related with the attribute.
3029  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3030  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3031  *      @pre            None
3032  *      @post           None
3033  *      @remarks        If the function succeeds, 'info' holds detail information about the attribute, such as type,
3034  *                      flag, validity_type, validity_values, and default values.
3035  *      @see            mm_camcorder_get_attributes, mm_camcorder_set_attributes
3036  *      @par example
3037  *      @code
3038
3039 #include <mm_camcorder.h>
3040
3041 gboolean getting_info_from_attribute()
3042 {
3043         MMCamAttrsInfo info;
3044         int err;
3045
3046         err = mm_camcorder_get_attribute_info(handle, MMCAM_CAPTURE_HEIGHT, &info);
3047         if (err < 0) {
3048                 printf("Fail to call mm_camcorder_get_attribute_info()");
3049                 return FALSE;
3050         }
3051
3052         //Now 'info' has many information about 'MMCAM_CAPTURE_HEIGHT'
3053
3054         return TRUE;
3055 }
3056  *      @endcode
3057  */
3058 int mm_camcorder_get_attribute_info(MMHandleType camcorder, const char *attribute_name, MMCamAttrsInfo *info);
3059
3060
3061 /**
3062  *    mm_camcorder_get_fps_list_by_resolution:\n
3063  *  Get detail information of the fps configure. To manager fps, an user may want to know the supported fps list by the current preview resolution,
3064  *  Gives attribute information structure, from the configure data.
3065  *  Depending on the 'validity_type', validity union would be different. To know about the type of union, please refer 'MMCamAttrsInfo'.
3066  *
3067  *      @param[in]      camcorder       Specifies the camcorder  handle.
3068  *      @param[in]      width   width value of the current Preview resolution.
3069  *      @param[in]      height  height value of the current Preview resolution.
3070  *      @param[out]     fps_info                a structure that holds information related with the attribute.
3071  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3072  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3073  *      @pre            None
3074  *      @post           None
3075  *      @remarks        If the function succeeds, 'info' holds detail information about the attribute, such as type,
3076  *                      flag, validity_type, validity_values, and default values.
3077  *      @see            mm_camcorder_get_attributes, mm_camcorder_set_attributes
3078  *      @par example
3079  *      @code
3080
3081 #include <mm_camcorder.h>
3082
3083 gboolean getting_info_from_attribute()
3084 {
3085         MMCamAttrsInfo info;
3086         int err;
3087
3088         err = mm_camcorder_get_fps_list_by_resolution(handle, width, height, &info);
3089         if (err < 0) {
3090                 printf("Fail to call mm_camcorder_get_attribute_info()");
3091                 return FALSE;
3092         }
3093
3094         //Now 'info' has many information about 'MMCAM_CAPTURE_HEIGHT'
3095
3096         return TRUE;
3097 }
3098  *      @endcode
3099  */
3100 int mm_camcorder_get_fps_list_by_resolution(MMHandleType camcorder, int width, int height, MMCamAttrsInfo *fps_info);
3101
3102
3103 /**
3104  *    mm_camcorder_init_focusing:\n
3105  *  Initialize focusing. \n
3106  *  This function stops focusing action and adjust the camera lens to initial position.
3107  *  Some camera applciation requires to initialize its lens position after releasing half shutter. In that case,
3108  *  this should be a good choice. Comparing with mm_camcorder_stop_focusing, this function not only stops focusing,
3109  *  but also initialize the lens. Preview image might be out-focused after calling this function.
3110  *      @param[in]      camcorder  A handle of camcorder.
3111  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3112  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3113  *      @pre            The status of camcorder should be MM_CAMCORDER_STATE_PREPARE, MM_CAMCORDER_STATE_RECORDING, or MM_CAMCORDER_STATE_PAUSED.
3114  *      @post           None
3115  *      @remarks        None
3116  *      @see            mm_camcorder_start_focusing, mm_camcorder_stop_focusing
3117  *      @par example
3118  *      @code
3119
3120 #include <mm_camcorder.h>
3121
3122 gboolean start_autofocus()
3123 {
3124         int err;
3125         char * err_attr_name = NULL;
3126
3127         // Set focus mode to 'AUTO' and scan range to 'AF Normal'.
3128         //You just need to set these values one time. After that, just call mm_camcorder_start_focusing().
3129         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
3130                                           MMCAM_CAMERA_FOCUS_MODE, MM_CAMCORDER_FOCUS_MODE_AUTO,
3131                                           MMCAM_CAMERA_AF_SCAN_RANGE, MM_CAMCORDER_AUTO_FOCUS_NORMAL,
3132                                           NULL);
3133
3134         if (err < 0) {
3135                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
3136                 if (err_attr_name) {
3137                         free(err_attr_name);
3138                         err_attr_name = NULL;
3139                         return FALSE;
3140                 }
3141         }
3142
3143         mm_camcorder_init_focusing(hcam);
3144         mm_camcorder_start_focusing(hcam);
3145         printf("Waiting for adjusting focus\n");
3146
3147         // Waiting for 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED'
3148
3149         return TRUE;
3150 }
3151
3152  *      @endcode
3153  */
3154 int mm_camcorder_init_focusing(MMHandleType camcorder);
3155
3156
3157 /**
3158  *    mm_camcorder_start_focusing:\n
3159  *  Start focusing. \n
3160  *  This function command to start focusing opeartion. Because focusing operation depends on mechanic or electric module,
3161  *  it may take small amount of time. (For ex, 500ms ~ 3sec). \n
3162  *  This function works asynchronously. When an user call this function,  it will return immediately.
3163  *  However, focusing operation will continue until it gets results.
3164  *  After finishing operation, you can get 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' message.
3165  *  'param.code' of the message structure describes the fucusing was success or not.
3166  *
3167  *      @param[in]      camcorder       A handle of camcorder.
3168  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3169  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3170  *      @pre            None
3171  *      @post           None
3172  *      @remarks        None
3173  *      @see            mm_camcorder_init_focusing, mm_camcorder_stop_focusing
3174  *      @par example
3175  *      @code
3176
3177 #include <mm_camcorder.h>
3178
3179 gboolean start_autofocus()
3180 {
3181         int err;
3182         char * err_attr_name = NULL;
3183
3184         // Set focus mode to 'AUTO' and scan range to 'AF Normal'.
3185         //You just need to set these values one time. After that, just call mm_camcorder_start_focusing().
3186         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
3187                                           MMCAM_CAMERA_FOCUS_MODE, MM_CAMCORDER_FOCUS_MODE_AUTO,
3188                                           MMCAM_CAMERA_AF_SCAN_RANGE, MM_CAMCORDER_AUTO_FOCUS_NORMAL,
3189                                           NULL);
3190
3191         if (err < 0) {
3192                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
3193                 if (err_attr_name) {
3194                         free(err_attr_name);
3195                         err_attr_name = NULL;
3196                         return FALSE;
3197                 }
3198         }
3199
3200         mm_camcorder_init_focusing(hcam);
3201         mm_camcorder_start_focusing(hcam);
3202         printf("Waiting for adjusting focus\n");
3203
3204         // Waiting for 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED'
3205
3206         return TRUE;
3207 }
3208
3209  *      @endcode
3210  */
3211 int mm_camcorder_start_focusing(MMHandleType camcorder);
3212
3213
3214 /**
3215  *    mm_camcorder_stop_focusing:\n
3216  *  Stop focusing. This function halts focusing operation.\n
3217  *  This is the function to stop focusing in the middle of the operation. So if focusing is already finished or not started yet,
3218  *  this function will do nothing.
3219  *
3220  *      @param[in]      camcorder       A handle of camcorder.
3221  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3222  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3223  *      @see            mm_camcorder_init_focusing, mm_camcorder_start_focusing
3224  *      @pre            mm_camcorder_start_focusing() should be called before calling this function.
3225  *      @post           None
3226  *      @remarks        None
3227  *      @par example
3228  *      @code
3229
3230 #include <mm_camcorder.h>
3231
3232 gboolean stop_autofocus()
3233 {
3234         int err;
3235
3236         //Stop focusing
3237         mm_camcorder_stop_focusing(hcam);
3238
3239         return TRUE;
3240 }
3241
3242  *      @endcode
3243  */
3244 int mm_camcorder_stop_focusing(MMHandleType camcorder);
3245
3246 /**
3247  *    mm_camcorder_get_video_caps:
3248  *  Stop focusing. This function halts focusing operation.
3249  *  This is the function to stop focusing in the middle of the operation.
3250  *  So if focusing is already finished or not started yet,
3251  *  this function will do nothing.
3252  *
3253  *      @param[in]      camcorder       A handle of camcorder.
3254  *      @return         This function returns zero(MM_ERROR_NONE) on success,
3255  *                      or negative value with error code.
3256  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3257  *      @see            mm_camcorder_create
3258  *      @pre            mm_camcorder_realize() should be called before calling this function.
3259  *      @post           None
3260  *      @remarks        None
3261  *      @par example
3262  *      @code
3263  */
3264 int mm_camcorder_get_video_caps(MMHandleType handle, char **caps);
3265
3266 /**
3267         @}
3268  */
3269
3270 #ifdef __cplusplus
3271 }
3272 #endif
3273
3274 #endif /* __MM_CAMCORDER_H__ */