4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: Jeongmo Yang <jm80.yang@samsung.com>
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
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
33 Camcorder can be reached by calling functions as shown in the following
34 figure, "The State of Camcorder".
37 @image html camcorder_state.png "The State of Camcorder" width=12cm
38 @image latex camcorder_state.png "The State of Camcorder" width=12cm
41 Between each states there is intermediate state, and in this state,
42 any function call which change the camcorder state will be failed.
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
59 <td>mm_camcorder_create()</td>
65 <td>mm_camcorder_destroy()</td>
71 <td>mm_camcorder_realize()</td>
77 <td>mm_camcorder_unrealize()</td>
83 <td>mm_camcorder_start()</td>
89 <td>mm_camcorder_stop()</td>
95 <td>mm_camcorder_capture_start()</td>
101 <td>mm_camcorder_capture_stop()</td>
107 <td>mm_camcorder_record()</td>
108 <td>PREPARED/PAUSED</td>
113 <td>mm_camcorder_pause()</td>
119 <td>mm_camcorder_commit()</td>
120 <td>RECORDING/PAUSED</td>
125 <td>mm_camcorder_cancel()</td>
126 <td>RECORDING/PAUSED</td>
131 <td>mm_camcorder_set_message_callback()</td>
137 <td>mm_camcorder_set_video_stream_callback()</td>
143 <td>mm_camcorder_set_video_capture_callback()</td>
149 <td>mm_camcorder_get_state()</td>
155 <td>mm_camcorder_get_attributes()</td>
161 <td>mm_camcorder_set_attributes()</td>
167 <td>mm_camcorder_get_attribute_info()</td>
173 <td>mm_camcorder_init_focusing()</td>
179 <td>mm_camcorder_start_focusing()</td>
185 <td>mm_camcorder_stop_focusing()</td>
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.
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'.
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'.
211 Following are the attributes which should be set before initialization (#mm_camcorder_realize):
217 <td><center><b>Attribute</b></center></td>
218 <td><center><b>Description</b></center></td>
222 <td>Mode of camcorder ( still/video/audio )</td>
225 <td>#MMCAM_AUDIO_DEVICE</td>
226 <td>Audio device ID for capturing audio stream</td>
229 <td>#MMCAM_CAMERA_DEVICE_COUNT</td>
230 <td>Video device count</td>
233 <td>#MMCAM_AUDIO_ENCODER</td>
234 <td>Audio codec for encoding audio stream</td>
237 <td>#MMCAM_VIDEO_ENCODER</td>
238 <td>Video codec for encoding video stream</td>
241 <td>#MMCAM_IMAGE_ENCODER</td>
242 <td>Image codec for capturing still-image</td>
245 <td>#MMCAM_FILE_FORMAT</td>
246 <td>File format for recording media stream</td>
249 <td>#MMCAM_AUDIO_SAMPLERATE</td>
250 <td>Sampling rate of audio stream ( This is an integer field )</td>
253 <td>#MMCAM_AUDIO_FORMAT</td>
254 <td>Audio format of each sample</td>
257 <td>#MMCAM_AUDIO_CHANNEL</td>
258 <td>Channels of each sample ( This is an integer field )</td>
261 <td>#MMCAM_AUDIO_INPUT_ROUTE(deprecated)</td>
262 <td>Set audio input route</td>
265 <td>#MMCAM_CAMERA_FORMAT</td>
266 <td>Format of video stream. This is an integer field</td>
269 <td>#MMCAM_CAMERA_FPS</td>
270 <td>Frames per second ( This is an integer field )</td>
273 <td>#MMCAM_CAMERA_WIDTH</td>
274 <td>Width of input video stream</td>
277 <td>#MMCAM_CAMERA_HEIGHT</td>
278 <td>Height of input video stream</td>
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>
285 <td>#MMCAM_DISPLAY_HANDLE</td>
286 <td>Pointer of display buffer or ID of xwindow</td>
289 <td>#MMCAM_DISPLAY_DEVICE</td>
290 <td>Device of display</td>
293 <td>#MMCAM_DISPLAY_SURFACE</td>
294 <td>Surface of display</td>
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>
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>
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>
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>
313 <td>#MMCAM_DISPLAY_ROTATION</td>
314 <td>Rotation of display</td>
317 <td>#MMCAM_DISPLAY_VISIBLE</td>
318 <td>Visible of display</td>
321 <td>#MMCAM_DISPLAY_SCALE</td>
322 <td>A scale of displayed image</td>
325 <td>#MMCAM_DISPLAY_GEOMETRY_METHOD</td>
326 <td>A method that describes a form of geometry for display</td>
332 Following are the attributes which should be set before recording (mm_camcorder_record()):
338 <td><center><b>Attribute</b></center></td>
339 <td><center><b>Description</b></center></td>
342 <td>#MMCAM_AUDIO_ENCODER_BITRATE</td>
343 <td>Bitrate of Audio Encoder</td>
346 <td>#MMCAM_VIDEO_ENCODER_BITRATE</td>
347 <td>Bitrate of Video Encoder</td>
350 <td>#MMCAM_TARGET_FILENAME</td>
351 <td>Target filename. Only used in Audio/Video recording. This is not used for capturing.</td>
354 <td>#MMCAM_TARGET_MAX_SIZE</td>
355 <td>Maximum size of recording file(Kbyte). If the size of file reaches this value.</td>
358 <td>#MMCAM_TARGET_TIME_LIMIT</td>
359 <td>Time limit of recording file. If the elapsed time of recording reaches this value.</td>
365 Following are the attributes which should be set before capturing (mm_camcorder_capture_start()):
371 <td><center><b>Attribute</b></center></td>
372 <td><center><b>Description</b></center></td>
375 <td>#MMCAM_IMAGE_ENCODER_QUALITY</td>
376 <td>Encoding quality of Image codec</td>
379 <td>#MMCAM_CAPTURE_FORMAT</td>
380 <td>Pixel format that you want to capture</td>
383 <td>#MMCAM_CAPTURE_WIDTH</td>
384 <td>Width of the image that you want to capture</td>
387 <td>#MMCAM_CAPTURE_HEIGHT</td>
388 <td>Height of the image that you want to capture</td>
391 <td>#MMCAM_CAPTURE_COUNT</td>
392 <td>Total count of capturing</td>
395 <td>#MMCAM_CAPTURE_INTERVAL</td>
396 <td>Interval between each capturing on Multishot ( MMCAM_CAPTURE_COUNT > 1 )</td>
402 Following are the attributes which can be set anytime:
408 <td><center><b>Attribute</b></center></td>
409 <td><center><b>Description</b></center></td>
412 <td>#MMCAM_AUDIO_VOLUME</td>
413 <td>Input volume of audio source ( double value )</td>
416 <td>#MMCAM_CAMERA_DIGITAL_ZOOM</td>
417 <td>Digital zoom level</td>
420 <td>#MMCAM_CAMERA_OPTICAL_ZOOM</td>
421 <td>Optical zoom level</td>
424 <td>#MMCAM_CAMERA_FOCUS_MODE</td>
428 <td>#MMCAM_CAMERA_AF_SCAN_RANGE</td>
429 <td>AF Scan range</td>
432 <td>#MMCAM_CAMERA_AF_TOUCH_X</td>
433 <td>X coordinate of touching position</td>
436 <td>#MMCAM_CAMERA_AF_TOUCH_Y</td>
437 <td>Y coordinate of touching position</td>
440 <td>#MMCAM_CAMERA_AF_TOUCH_WIDTH</td>
441 <td>Width of touching area</td>
444 <td>#MMCAM_CAMERA_AF_TOUCH_HEIGHT</td>
445 <td>Height of touching area</td>
448 <td>#MMCAM_CAMERA_EXPOSURE_MODE</td>
449 <td>Exposure mode</td>
452 <td>#MMCAM_CAMERA_EXPOSURE_VALUE</td>
453 <td>Exposure value</td>
456 <td>#MMCAM_CAMERA_F_NUMBER</td>
457 <td>f number of camera</td>
460 <td>#MMCAM_CAMERA_SHUTTER_SPEED</td>
461 <td>Shutter speed</td>
464 <td>#MMCAM_CAMERA_ISO</td>
465 <td>ISO of capturing image</td>
468 <td>#MMCAM_CAMERA_WDR</td>
469 <td>Wide dynamic range</td>
472 <td>#MMCAM_CAMERA_ANTI_HANDSHAKE</td>
473 <td>Anti Handshake</td>
476 <td>#MMCAM_CAMERA_FOCAL_LENGTH</td>
477 <td>Focal length of camera lens</td>
480 <td>#MMCAM_FILTER_BRIGHTNESS</td>
481 <td>Brightness level</td>
484 <td>#MMCAM_FILTER_CONTRAST</td>
485 <td>Contrast level</td>
488 <td>#MMCAM_FILTER_WB</td>
489 <td>White balance</td>
492 <td>#MMCAM_FILTER_COLOR_TONE</td>
493 <td>Color tone (Color effect)</td>
496 <td>#MMCAM_FILTER_SCENE_MODE</td>
497 <td>Scene mode (Program mode)</td>
500 <td>#MMCAM_FILTER_SATURATION</td>
501 <td>Saturation level</td>
504 <td>#MMCAM_FILTER_HUE</td>
508 <td>#MMCAM_FILTER_SHARPNESS</td>
509 <td>Sharpness level</td>
512 <td>#MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT</td>
513 <td>Set this as true when you want to stop multishot immediately</td>
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>
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>
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>
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>
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>
536 <td>#MMCAM_TAG_IMAGE_DESCRIPTION</td>
537 <td>Image description</td>
540 <td>#MMCAM_TAG_ORIENTATION</td>
541 <td>Orientation of captured image</td>
544 <td>#MMCAM_TAG_VIDEO_ORIENTATION</td>
545 <td>Orientation of encoded video</td>
548 <td>#MMCAM_TAG_SOFTWARE</td>
549 <td>software name and version</td>
552 <td>#MMCAM_TAG_LATITUDE</td>
553 <td>Latitude of captured postion (GPS information)</td>
556 <td>#MMCAM_TAG_LONGITUDE</td>
557 <td>Longitude of captured postion (GPS information)</td>
560 <td>#MMCAM_TAG_ALTITUDE</td>
561 <td>Altitude of captured postion (GPS information)</td>
564 <td>#MMCAM_STROBE_CONTROL</td>
565 <td>Strobe control</td>
568 <td>#MMCAM_STROBE_MODE</td>
569 <td>Operation Mode of strobe</td>
572 <td>#MMCAM_DETECT_MODE</td>
573 <td>Detection mode</td>
576 <td>#MMCAM_DETECT_NUMBER</td>
577 <td>Total number of detected object</td>
580 <td>#MMCAM_DETECT_FOCUS_SELECT</td>
581 <td>Select one of detected objects</td>
589 #ifndef __MM_CAMCORDER_H__
590 #define __MM_CAMCORDER_H__
593 /*=======================================================================================
595 ========================================================================================*/
598 #include <mm_types.h>
599 #include <mm_error.h>
600 #include <mm_message.h>
606 /*=======================================================================================
607 | GLOBAL DEFINITIONS AND DECLARATIONS FOR CAMCORDER |
608 ========================================================================================*/
610 /*=======================================================================================
611 | MACRO DEFINITIONS |
612 ========================================================================================*/
614 * Get numerator. Definition for fraction setting, such as MMCAM_CAMERA_SHUTTER_SPEED and MMCAM_CAMERA_EXPOSURE_VALUE.
616 #define MM_CAMCORDER_GET_NUMERATOR(x) ((int)(((int)(x) >> 16) & 0xFFFF))
618 * Get denominator. Definition for fraction setting, such as MMCAM_CAMERA_SHUTTER_SPEED and MMCAM_CAMERA_EXPOSURE_VALUE.
620 #define MM_CAMCORDER_GET_DENOMINATOR(x) ((int)(((int)(x)) & 0xFFFF))
622 * Set fraction value. Definition for fraction setting, such as MMCAM_CAMERA_SHUTTER_SPEED and MMCAM_CAMERA_EXPOSURE_VALUE.
624 #define MM_CAMCORDER_SET_FRACTION(numerator,denominator) ((int)((((int)(numerator)) << 16) | (int)(denominator)))
626 /* Attributes Macros */
628 * Mode of camcorder (still/video/audio).
629 * @see MMCamcorderModeType
631 #define MMCAM_MODE "mode"
634 * Audio device ID for capturing audio stream.
635 * @see MMAudioDeviceType (in mm_types.h)
637 #define MMCAM_AUDIO_DEVICE "audio-device"
640 * Video device count.
642 #define MMCAM_CAMERA_DEVICE_COUNT "camera-device-count"
645 * Facing direction of camera device.
646 * @see MMCamcorderCameraFacingDirection
648 #define MMCAM_CAMERA_FACING_DIRECTION "camera-facing-direction"
651 * Audio codec for encoding audio stream.
652 * @see MMAudioCodecType (in mm_types.h)
654 #define MMCAM_AUDIO_ENCODER "audio-encoder"
657 * Video codec for encoding video stream.
658 * @see MMVideoCodecType (in mm_types.h)
660 #define MMCAM_VIDEO_ENCODER "video-encoder"
663 * Image codec for capturing still-image.
664 * @see MMImageCodecType (in mm_types.h)
666 #define MMCAM_IMAGE_ENCODER "image-encoder"
669 * File format for recording media stream.
670 * @see MMFileFormatType (in mm_types.h)
672 #define MMCAM_FILE_FORMAT "file-format"
675 * Sampling rate of audio stream. This is an integer field.
677 #define MMCAM_AUDIO_SAMPLERATE "audio-samplerate"
680 * Audio format of each sample.
681 * @see MMCamcorderAudioFormat
683 #define MMCAM_AUDIO_FORMAT "audio-format"
686 * Channels of each sample. This is an integer field.
688 #define MMCAM_AUDIO_CHANNEL "audio-channel"
691 * Input volume of audio source. Double value.
693 #define MMCAM_AUDIO_VOLUME "audio-volume"
696 * Disable Audio stream when record.
698 #define MMCAM_AUDIO_DISABLE "audio-disable"
701 * Set audio input route
702 * @remarks Deprecated. This will be removed soon.
703 * @see MMAudioRoutePolicy (in mm_types.h)
705 #define MMCAM_AUDIO_INPUT_ROUTE "audio-input-route"
708 * Format of video stream. This is an integer field
709 * @see MMPixelFormatType (in mm_types.h)
711 #define MMCAM_CAMERA_FORMAT "camera-format"
714 * Slow motion rate when video recording
715 * @remarks Deprecated
717 #define MMCAM_CAMERA_SLOW_MOTION_RATE "camera-slow-motion-rate"
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.
726 #define MMCAM_CAMERA_RECORDING_MOTION_RATE "camera-recording-motion-rate"
729 * Frames per second. This is an integer field
732 #define MMCAM_CAMERA_FPS "camera-fps"
735 * Width of preview stream.
737 #define MMCAM_CAMERA_WIDTH "camera-width"
740 * Height of preview stream.
742 #define MMCAM_CAMERA_HEIGHT "camera-height"
745 * Width of video stream.
747 #define MMCAM_VIDEO_WIDTH "video-width"
750 * Height of video stream.
752 #define MMCAM_VIDEO_HEIGHT "video-height"
755 * Digital zoom level.
757 #define MMCAM_CAMERA_DIGITAL_ZOOM "camera-digital-zoom"
760 * Optical zoom level.
762 #define MMCAM_CAMERA_OPTICAL_ZOOM "camera-optical-zoom"
766 * @see MMCamcorderFocusMode
768 #define MMCAM_CAMERA_FOCUS_MODE "camera-focus-mode"
772 * @see MMCamcorderAutoFocusType
774 #define MMCAM_CAMERA_AF_SCAN_RANGE "camera-af-scan-range"
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
780 #define MMCAM_CAMERA_AF_TOUCH_X "camera-af-touch-x"
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
786 #define MMCAM_CAMERA_AF_TOUCH_Y "camera-af-touch-y"
789 * Width of touching area. Only available when you set '#MM_CAMCORDER_AUTO_FOCUS_TOUCH' to '#MMCAM_CAMERA_AF_SCAN_RANGE'.
790 * @see MMCamcorderAutoFocusType
792 #define MMCAM_CAMERA_AF_TOUCH_WIDTH "camera-af-touch-width"
795 * Height of touching area. Only available when you set '#MM_CAMCORDER_AUTO_FOCUS_TOUCH' to '#MMCAM_CAMERA_AF_SCAN_RANGE'.
796 * @see MMCamcorderAutoFocusType
798 #define MMCAM_CAMERA_AF_TOUCH_HEIGHT "camera-af-touch-height"
802 * @see MMCamcorderAutoExposureType
804 #define MMCAM_CAMERA_EXPOSURE_MODE "camera-exposure-mode"
809 #define MMCAM_CAMERA_EXPOSURE_VALUE "camera-exposure-value"
814 #define MMCAM_CAMERA_F_NUMBER "camera-f-number"
819 #define MMCAM_CAMERA_SHUTTER_SPEED "camera-shutter-speed"
822 * ISO of capturing image
823 * @see MMCamcorderISOType
825 #define MMCAM_CAMERA_ISO "camera-iso"
828 * Wide dynamic range.
829 * @see MMCamcorderWDRMode
831 #define MMCAM_CAMERA_WDR "camera-wdr"
834 * Focal length of camera lens.
836 #define MMCAM_CAMERA_FOCAL_LENGTH "camera-focal-length"
840 * @see MMCamcorderAHSMode
842 #define MMCAM_CAMERA_ANTI_HANDSHAKE "camera-anti-handshake"
845 * Video Stabilization
846 * @see MMCamcorderVideoStabilizationMode
848 #define MMCAM_CAMERA_VIDEO_STABILIZATION "camera-video-stabilization"
851 * FPS Auto. When you set true to this attribute, FPS will vary depending on the amount of the light.
853 #define MMCAM_CAMERA_FPS_AUTO "camera-fps-auto"
856 * Rotation angle of video input stream.
857 * @see MMVideoInputRotationType (in mm_types.h)
859 #define MMCAM_CAMERA_ROTATION "camera-rotation"
862 * HDR(High Dynamic Range) Capture mode
863 * @see MMCamcorderHDRMode
865 #define MMCAM_CAMERA_HDR_CAPTURE "camera-hdr-capture"
868 * Bitrate of Audio Encoder
870 #define MMCAM_AUDIO_ENCODER_BITRATE "audio-encoder-bitrate"
873 * Bitrate of Video Encoder
875 #define MMCAM_VIDEO_ENCODER_BITRATE "video-encoder-bitrate"
878 * Encoding quality of Image codec
880 #define MMCAM_IMAGE_ENCODER_QUALITY "image-encoder-quality"
885 #define MMCAM_FILTER_BRIGHTNESS "filter-brightness"
890 #define MMCAM_FILTER_CONTRAST "filter-contrast"
894 * @see MMCamcorderWhiteBalanceType
896 #define MMCAM_FILTER_WB "filter-wb"
899 * Color tone. (Color effect)
900 * @see MMCamcorderColorToneType
902 #define MMCAM_FILTER_COLOR_TONE "filter-color-tone"
905 * Scene mode (Program mode)
906 * @see MMCamcorderSceneModeType
908 #define MMCAM_FILTER_SCENE_MODE "filter-scene-mode"
913 #define MMCAM_FILTER_SATURATION "filter-saturation"
918 #define MMCAM_FILTER_HUE "filter-hue"
923 #define MMCAM_FILTER_SHARPNESS "filter-sharpness"
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.
930 * @see MMPixelFormatType (in mm_types.h)
932 #define MMCAM_CAPTURE_FORMAT "capture-format"
935 * Width of the image that you want to capture
937 #define MMCAM_CAPTURE_WIDTH "capture-width"
940 * Height of the image that you want to capture
943 #define MMCAM_CAPTURE_HEIGHT "capture-height"
946 * Total count of capturing. If you set this, it will caputre multiple time.
948 #define MMCAM_CAPTURE_COUNT "capture-count"
951 * Interval between each capturing on Multishot.
953 #define MMCAM_CAPTURE_INTERVAL "capture-interval"
956 * Set this when you want to stop multishot immediately.
958 #define MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT "capture-break-cont-shot"
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.
965 #define MMCAM_CAPTURED_SCREENNAIL "captured-screennail"
968 * Raw data of EXIF. This is READ-ONLY attribute and only available in capture callback.
970 #define MMCAM_CAPTURED_EXIF_RAW_DATA "captured-exif-raw-data"
973 * Pointer of display buffer or ID of xwindow.
975 #define MMCAM_DISPLAY_HANDLE "display-handle"
979 * @see MMDisplayDeviceType (in mm_types.h)
981 #define MMCAM_DISPLAY_DEVICE "display-device"
984 * Surface of display.
985 * @see MMDisplaySurfaceType (in mm_types.h)
987 #define MMCAM_DISPLAY_SURFACE "display-surface"
991 * @see MMDisplayModeType (in mm_types.h)
993 #define MMCAM_DISPLAY_MODE "display-mode"
996 * X position of display rectangle.
997 * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
998 * @see MMCamcorderGeometryMethod
1000 #define MMCAM_DISPLAY_RECT_X "display-rect-x"
1003 * Y position of display rectangle
1004 * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
1005 * @see MMCamcorderGeometryMethod
1007 #define MMCAM_DISPLAY_RECT_Y "display-rect-y"
1010 * Width of display rectangle
1011 * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
1012 * @see MMCamcorderGeometryMethod
1014 #define MMCAM_DISPLAY_RECT_WIDTH "display-rect-width"
1017 * Height of display rectangle
1018 * This is only available when #MMCAM_DISPLAY_GEOMETRY_METHOD is MM_CAMCORDER_CUSTOM_ROI.
1019 * @see MMCamcorderGeometryMethod
1021 #define MMCAM_DISPLAY_RECT_HEIGHT "display-rect-height"
1024 * X position of source rectangle. When you want to crop the source, you can set the area with this value.
1026 #define MMCAM_DISPLAY_SOURCE_X "display-src-x"
1029 * Y position of source rectangle. When you want to crop the source, you can set the area with this value.
1031 #define MMCAM_DISPLAY_SOURCE_Y "display-src-y"
1034 * Width of source rectangle. When you want to crop the source, you can set the area with this value.
1036 #define MMCAM_DISPLAY_SOURCE_WIDTH "display-src-width"
1039 * Height of source rectangle. When you want to crop the source, you can set the area with this value.
1041 #define MMCAM_DISPLAY_SOURCE_HEIGHT "display-src-height"
1044 * Rotation angle of display.
1045 * @see MMDisplayRotationType (in mm_types.h)
1047 #define MMCAM_DISPLAY_ROTATION "display-rotation"
1051 * @see MMFlipType (in mm_types.h)
1053 #define MMCAM_DISPLAY_FLIP "display-flip"
1056 * Visible of display.
1058 #define MMCAM_DISPLAY_VISIBLE "display-visible"
1061 * A scale of displayed image. Available value is like below.
1062 * @see MMDisplayScaleType (in mm_types.h)
1064 #define MMCAM_DISPLAY_SCALE "display-scale"
1067 * A method that describes a form of geometry for display.
1068 * @see MMCamcorderGeometryMethod
1070 #define MMCAM_DISPLAY_GEOMETRY_METHOD "display-geometry-method"
1073 * A videosink name of evas surface.
1074 * This is READ-ONLY attribute.
1076 #define MMCAM_DISPLAY_EVAS_SURFACE_SINK "display-evas-surface-sink"
1079 * This attribute is only available if value of MMCAM_DISPLAY_EVAS_SURFACE_SINK "evaspixmapsink"
1081 #define MMCAM_DISPLAY_EVAS_DO_SCALING "display-evas-do-scaling"
1084 * Target filename. Only used in Audio/Video recording. This is not used for capturing.
1086 #define MMCAM_TARGET_FILENAME "target-filename"
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.
1092 #define MMCAM_TARGET_MAX_SIZE "target-max-size"
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.
1098 #define MMCAM_TARGET_TIME_LIMIT "target-time-limit"
1101 * Enable to write tags. If this value is FALSE, none of tag information will be written to captured file.
1103 #define MMCAM_TAG_ENABLE "tag-enable"
1106 * Image description.
1108 #define MMCAM_TAG_IMAGE_DESCRIPTION "tag-image-description"
1111 * Orientation of captured image
1112 * @see MMCamcorderTagOrientation
1114 #define MMCAM_TAG_ORIENTATION "tag-orientation"
1117 * Orientation of captured video
1118 * @see MMCamcorderTagVideoOrientation
1120 #define MMCAM_TAG_VIDEO_ORIENTATION "tag-video-orientation"
1123 * software name and version
1125 #define MMCAM_TAG_SOFTWARE "tag-software"
1128 * Enable to write tags related to GPS. If this value is TRUE, tags related GPS information will be written to captured file.
1130 #define MMCAM_TAG_GPS_ENABLE "tag-gps-enable"
1133 * Latitude of captured postion. GPS information.
1135 #define MMCAM_TAG_LATITUDE "tag-latitude"
1138 * Longitude of captured postion. GPS information.
1140 #define MMCAM_TAG_LONGITUDE "tag-longitude"
1143 * Altitude of captured postion. GPS information.
1145 #define MMCAM_TAG_ALTITUDE "tag-altitude"
1149 * @see MMCamcorderStrobeControl
1151 #define MMCAM_STROBE_CONTROL "strobe-control"
1154 * Operation Mode of strobe
1155 * @see MMCamcorderStrobeMode
1157 #define MMCAM_STROBE_MODE "strobe-mode"
1161 * @see MMCamcorderDetectMode
1163 #define MMCAM_DETECT_MODE "detect-mode"
1166 * Total number of detected object
1168 #define MMCAM_DETECT_NUMBER "detect-number"
1171 * You can use this attribute to select one of detected objects.
1173 #define MMCAM_DETECT_FOCUS_SELECT "detect-focus-select"
1176 * Recommend preview format for capture
1178 #define MMCAM_RECOMMEND_PREVIEW_FORMAT_FOR_CAPTURE "recommend-preview-format-for-capture"
1181 * Recommend preview format for recording
1183 #define MMCAM_RECOMMEND_PREVIEW_FORMAT_FOR_RECORDING "recommend-preview-format-for-recording"
1186 * Recommend rotation of display
1188 #define MMCAM_RECOMMEND_DISPLAY_ROTATION "recommend-display-rotation"
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
1195 #define MMCAM_RECOMMEND_CAMERA_WIDTH "recommend-camera-width"
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
1202 #define MMCAM_RECOMMEND_CAMERA_HEIGHT "recommend-camera-height"
1205 * Flip of video input stream.
1206 * @see MMFlipType (in mm_types.h)
1208 #define MMCAM_CAMERA_FLIP "camera-flip"
1211 * Support Zero Shutter Lag capture
1213 #define MMCAM_SUPPORT_ZSL_CAPTURE "support-zsl-capture"
1216 * Support zero copy format
1218 #define MMCAM_SUPPORT_ZERO_COPY_FORMAT "support-zero-copy-format"
1221 * Support media packet callback
1223 #define MMCAM_SUPPORT_MEDIA_PACKET_PREVIEW_CB "support-media-packet-preview-cb"
1226 * Enable to write tags for recorded file
1228 #define MMCAM_RECORDER_TAG_ENABLE "recorder-tag-enable"
1231 * Determines the socket stream path
1233 #define MMCAM_DISPLAY_SOCKET_PATH "display-socket-path"
1236 * PID for sound focus
1238 #define MMCAM_PID_FOR_SOUND_FOCUS "pid-for-sound-focus"
1241 * Root directory of application
1243 #define MMCAM_ROOT_DIRECTORY "root-directory"
1246 * Bitrate for encoded preview stream
1248 #define MMCAM_ENCODED_PREVIEW_BITRATE "encoded-preview-bitrate"
1251 * GOP interval for encoded preview stream
1253 #define MMCAM_ENCODED_PREVIEW_GOP_INTERVAL "encoded-preview-gop-interval"
1255 /*=======================================================================================
1256 | ENUM DEFINITIONS |
1257 ========================================================================================*/
1259 * An enumeration for camcorder states.
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;
1273 * An enumeration for camcorder mode.
1276 MM_CAMCORDER_MODE_VIDEO_CAPTURE = 0, /**< Video recording and Image capture mode */
1277 MM_CAMCORDER_MODE_AUDIO, /**< Audio recording mode */
1278 } MMCamcorderModeType;
1281 * An enumeration for facing direction.
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;
1290 * An enumeration of Audio Format.
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;
1300 * An enumeration for color tone. Color tone provides an impression of
1301 * seeing through a tinted glass.
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 */
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.
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 */
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.
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 */
1384 * An enumeration for focusing .
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*/
1397 * An enumeration for auto focus scan range (af scan range)
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)*/
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.
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*/
1421 * An enumeration for ISO.
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*/
1437 * An enumeration for Automatic exposure.
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*/
1453 * An enumeration for WDR mode .
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*/
1463 * An enumeration for HDR capture mode
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) */
1473 * An enumeration for Anti-handshake mode .
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*/
1484 * An enumeration for Video stabilization mode
1486 enum MMCamcorderVideoStabilizationMode {
1487 MM_CAMCORDER_VIDEO_STABILIZATION_OFF = 0, /**< Video Stabilization OFF*/
1488 MM_CAMCORDER_VIDEO_STABILIZATION_ON, /**< Video Stabilization ON*/
1493 * Geometry method for camcorder display.
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*/
1506 * An enumeration for orientation values of tag .
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.*/
1521 * An enumeration for captured video orientation values of tag .
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 */
1533 * An enumeration for Strobe mode.
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 */
1548 * An enumeration for Strobe Control.
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 */
1558 * An enumeration for Detection mode.
1560 enum MMCamcorderDetectMode {
1561 MM_CAMCORDER_DETECT_MODE_OFF = 0, /**< turn detection off */
1562 MM_CAMCORDER_DETECT_MODE_ON, /**< turn detection on */
1567 * An enumeration for recommended preview resolution.
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 */
1576 /**********************************
1578 **********************************/
1580 * An enumeration for attribute values types.
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 */
1592 * An enumeration for attribute validation type.
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;
1605 * An enumeration for attribute access flag.
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 */
1616 /**********************************
1618 **********************************/
1620 * An enumeration for stream data type.
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 */
1632 /*=======================================================================================
1633 | STRUCTURE DEFINITIONS |
1634 ========================================================================================*/
1636 * A structure for attribute information
1639 MMCamAttrsType type;
1640 MMCamAttrsFlag flag;
1641 MMCamAttrsValidType validity_type;
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.
1650 * Validity structure for integer array.
1653 int *array; /**< a pointer of array */
1654 int count; /**< size of array */
1655 int def; /**< default value. Real value not index of array */
1659 * Validity structure for integer range.
1662 int min; /**< minimum range */
1663 int max; /**< maximum range */
1664 int def; /**< default value */
1668 * Validity structure for double array.
1671 double *array; /**< a pointer of array */
1672 int count; /**< size of array */
1673 double def; /**< default value. Real value not index of array */
1677 * Validity structure for double range.
1680 double min; /**< minimum range */
1681 double max; /**< maximum range */
1682 double def; /**< default value */
1688 /* General Structure */
1690 * Structure for capture data.
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;
1703 * Structure for video stream data.
1705 #define BUFFER_MAX_PLANE_NUM 4
1711 unsigned int length_yuv;
1715 unsigned int length_y;
1717 unsigned int length_uv;
1721 unsigned int length_y;
1723 unsigned int length_u;
1725 unsigned int length_v;
1728 unsigned char *data;
1729 unsigned int length_data;
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;
1747 * Structure for audio stream data.
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;
1760 * Prerequisite information for mm_camcorder_create()
1761 * The information to set prior to create.
1764 enum MMVideoDeviceType videodev_type; /**< Video device type */
1765 /* For future use */
1766 int reserved[4]; /**< reserved fields */
1771 * Report structure of recording file
1774 char *recording_filename; /**< File name of stored recording file. Please free after using. */
1775 } MMCamRecordingReport; /**< report structure definition of recording file */
1779 * Face detect defailed information
1781 typedef struct _MMCamFaceInfo {
1782 int id; /**< id of each face */
1783 int score; /**< score of each face */
1784 MMRectType rect; /**< area of face */
1788 * Face detect information
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;
1797 * Wayland information
1799 typedef struct _MMCamWaylandInfo {
1809 #endif /* HAVE_WAYLAND */
1811 /*=======================================================================================
1812 | TYPE DEFINITIONS |
1813 ========================================================================================*/
1815 * Function definition for video stream callback.
1816 * Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1817 * mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1818 * Please don't hang this function long. It may cause low performance of preview or occur timeout error from video source.
1819 * Also, you're not allowed to call mm_camcorder_stop() even in other context, while you're hanging this function.
1820 * I recommend to you releasing this function ASAP.
1822 * @param[in] stream Reference pointer to video stream data
1823 * @param[in] user_param User parameter which is received from user when callback function was set
1824 * @return This function returns true on success, or false on failure.
1825 * @remarks This function is issued in the context of gstreamer (video sink thread).
1827 typedef gboolean (*mm_camcorder_video_stream_callback)(MMCamcorderVideoStreamDataType *stream, void *user_param);
1831 * Function definition for audio stream callback.
1832 * Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1833 * mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1834 * Please don't hang this function long. It may cause low performance of camcorder or occur timeout error from audio source.
1835 * I recommend to you releasing this function ASAP.
1837 * @param[in] stream Reference pointer to audio stream data
1838 * @param[in] user_param User parameter which is received from user when callback function was set
1839 * @return This function returns true on success, or false on failure.
1842 typedef gboolean (*mm_camcorder_audio_stream_callback)(MMCamcorderAudioStreamDataType *stream, void *user_param);
1846 * Function definition for video capture callback.
1847 * Like '#mm_camcorder_video_stream_callback', you can't call mm_camcorder_stop() while you are hanging this function.
1849 * @param[in] frame Reference pointer to captured data
1850 * @param[in] thumbnail Reference pointer to thumbnail data
1851 * @param[in] user_param User parameter which is received from user when callback function was set
1852 * @return This function returns true on success, or false on failure.
1853 * @remarks This function is issued in the context of gstreamer (video src thread).
1855 typedef gboolean (*mm_camcorder_video_capture_callback)(MMCamcorderCaptureDataType *frame, MMCamcorderCaptureDataType *thumbnail, void *user_param);
1858 /*=======================================================================================
1859 | GLOBAL FUNCTION PROTOTYPES |
1860 ========================================================================================*/
1862 * mm_camcorder_create:\n
1863 * Create camcorder object. This is the function that an user who wants to use mm_camcorder calls first.
1864 * This function creates handle structure and initialize mutex, attributes, gstreamer.
1865 * When this function success, it will return a handle of newly created object.
1866 * A user have to put the handle when he calls every function of mm_camcorder. \n
1867 * Second argument of this function is the field to decribe pre-setting information of mm_camcorder such as which camera device it will use.
1868 * Normally, MM_VIDEO_DEVICE_CAMERA0 is for Main camera(or Mega camera, Back camera),
1869 * and MM_VIDEO_DEVICE_CAMERA1 is for VGA camera (or Front camera). If you want audio recording,
1870 * please set MM_VIDEO_DEVICE_NONE. (No camera device is needed.)
1872 * @param[out] camcorder A handle of camcorder.
1873 * @param[in] info Information for camera device. Depending on this information,
1874 * camcorder opens different camera devices.
1875 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1876 * Please refer 'mm_error.h' to know the exact meaning of the error.
1877 * @see mm_camcorder_destroy
1879 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_NULL
1880 * @remarks You can create multiple handles on a context at the same time. However,
1881 * camcorder cannot guarantee proper operation because of limitation of resources, such as
1882 * camera device, audio device, and display device.
1886 #include <mm_camcorder.h>
1888 gboolean initialize_camcorder()
1891 MMCamPreset cam_info;
1893 cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
1895 // when you want to record audio only, enable this.
1896 cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
1899 err = mm_camcorder_create(&hcam, &cam_info);
1901 if (err != MM_ERROR_NONE) {
1902 printf("Fail to call mm_camcorder_create = %x\n", err);
1911 int mm_camcorder_create(MMHandleType *camcorder, MMCamPreset *info);
1915 * mm_camcorder_destroy:\n
1916 * Destroy camcorder object. Release handle and all of the resources that were created in mm_camcorder_create().\n
1917 * This is the finalizing function of mm_camcorder. If this function is not called or fails to call, the handle isn't released fully.
1918 * This function releases attributes, mutexes, sessions, and handle itself. This function also removes all of remaining messages.
1919 * So if your application should wait a certain message of mm_camcorder, please wait to call this function till getting the message.
1922 * @param[in] camcorder A handle of camcorder.
1923 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1924 * Please refer 'mm_error.h' to know the exact meaning of the error.
1925 * @see mm_camcorder_create
1926 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_NULL
1927 * @post Because the handle is not valid, you can't check the state.
1932 #include <mm_camcorder.h>
1934 gboolean destroy_camcorder()
1938 //Destroy camcorder handle
1939 err = mm_camcorder_destroy(hcam);
1941 printf("Fail to call mm_camcorder_destroy = %x\n", err);
1950 int mm_camcorder_destroy(MMHandleType camcorder);
1954 * mm_camcorder_realize:\n
1955 * Allocate resources for camcorder and initialize it.
1956 * This also creates streamer pipeline. So you have to set attributes that are pivotal to create
1957 * the pipeline before calling this function. This function also takes a roll to manage confliction
1958 * between different applications which use camcorder. For example, if you try to use camcorder when
1959 * other application that is more important such as call application, this function will return
1960 * 'MM_ERROR_POLICY_BLOCKED'. On the contrary, if your application that uses camcorder starts to launch
1961 * while another application that uses speaker and has lower priority, your application will kick
1962 * another application.
1964 * @param[in] camcorder A handle of camcorder.
1965 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1966 * Please refer 'mm_error.h' to know the exact meaning of the error.
1967 * @see mm_camcorder_unrealize
1968 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_NULL
1969 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_READY
1974 #include <mm_camcorder.h>
1976 //For image capturing
1977 gboolean initialize_image_capture()
1980 MMCamPreset cam_info;
1981 char *err_attr_name = NULL;
1982 void * hdisplay = NULL;
1985 //Set video device as 'camera0' (main camera device)
1986 cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
1988 err = mm_camcorder_create(&hcam, &cam_info);
1990 if (err != MM_ERROR_NONE) {
1991 printf("Fail to call mm_camcorder_create = %x\n", err);
1995 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
1996 mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
1998 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
1999 hsize = sizeof(ad.xid); //size of xid structure.
2001 // camcorder attribute setting
2002 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2003 MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2004 MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2005 MMCAM_CAMERA_WIDTH, 640,
2006 MMCAM_CAMERA_HEIGHT, 480,
2007 MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2008 MMCAM_CAMERA_FPS, 30,
2009 MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2010 MMCAM_DISPLAY_HANDLE, (void*) hdisplay, hsize,
2011 MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
2012 MMCAM_CAPTURE_WIDTH, 640,
2013 MMCAM_CAPTURE_HEIGHT, 480,
2017 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2018 if (err_attr_name) {
2019 free(err_attr_name);
2020 err_attr_name = NULL;
2025 err = mm_camcorder_realize(hcam);
2027 printf("Fail to call mm_camcorder_realize = %x\n", err);
2035 gboolean initialize_video_capture()
2038 MMCamPreset cam_info;
2039 char *err_attr_name = NULL;
2040 void * hdisplay = NULL;
2043 //Set video device as 'camera0' (main camera device)
2044 cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2046 err = mm_camcorder_create(&hcam, &cam_info);
2048 if (err != MM_ERROR_NONE) {
2049 printf("Fail to call mm_camcorder_create = %x\n", err);
2053 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, hcam);
2055 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2056 hsize = sizeof(ad.xid); //size of xid structure.
2058 // camcorder attribute setting
2059 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2060 MMCAM_MODE, MM_CAMCORDER_MODE_VIDEO,
2061 MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2062 MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2063 MMCAM_VIDEO_ENCODER, MM_VIDEO_CODEC_MPEG4,
2064 MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2065 MMCAM_CAMERA_WIDTH, 1280,
2066 MMCAM_CAMERA_HEIGHT, 720,
2067 MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_NV12,
2068 MMCAM_CAMERA_FPS, 30,
2069 MMCAM_AUDIO_SAMPLERATE, 44100,
2070 MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2071 MMCAM_AUDIO_CHANNEL, 2,
2072 MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2073 MMCAM_DISPLAY_HANDLE, (void*) hdisplay, hsize,
2074 MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2078 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2079 if (err_attr_name) {
2080 free(err_attr_name);
2081 err_attr_name = NULL;
2086 err = mm_camcorder_realize(hcam);
2088 printf("Fail to call mm_camcorder_realize = %x\n", err);
2095 //For audio(only) capturing
2096 gboolean initialize_audio_capture()
2099 MMCamPreset cam_info;
2100 char *err_attr_name = NULL;
2101 void * hdisplay = NULL;
2104 //Set no video device, because audio recording doesn't need video input.
2105 cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
2107 err = mm_camcorder_create(&hcam, &cam_info);
2109 if (err != MM_ERROR_NONE) {
2110 printf("Fail to call mm_camcorder_create = %x\n", err);
2114 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2116 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2117 hsize = sizeof(ad.xid); //size of xid structure.
2119 // camcorder attribute setting
2120 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2121 MMCAM_MODE, MM_CAMCORDER_MODE_AUDIO,
2122 MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2123 MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2124 MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2125 MMCAM_AUDIO_SAMPLERATE, 44100,
2126 MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2127 MMCAM_AUDIO_CHANNEL, 2,
2128 MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2129 MMCAM_TARGET_TIME_LIMIT, 360000,
2133 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2134 if (err_attr_name) {
2135 free(err_attr_name);
2136 err_attr_name = NULL;
2141 err = mm_camcorder_realize(hcam);
2143 printf("Fail to call mm_camcorder_realize = %x\n", err);
2151 int mm_camcorder_realize(MMHandleType camcorder);
2155 * mm_camcorder_unrealize:\n
2156 * Uninitialize camcoder resources and free allocated memory.
2157 * Most important resource that is released here is gstreamer pipeline of mm_camcorder.
2158 * Because most of resources, such as camera device, video display device, and audio I/O device, are operating on the gstreamer pipeline,
2159 * this function should be called to release its resources.
2160 * Moreover, mm_camcorder is controlled by audio session manager. If an user doesn't call this function when he want to release mm_camcorder,
2161 * other multimedia frameworks may face session problem. For more detail information, please refer mm_session module.
2163 * @param[in] camcorder A handle of camcorder.
2164 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2165 * Please refer 'mm_error.h' to know the exact meaning of the error.
2166 * @see mm_camcorder_realize
2167 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_READY
2168 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_NULL
2173 #include <mm_camcorder.h>
2175 gboolean unrealize_camcorder()
2179 //Release all resources of camcorder handle
2180 err = mm_camcorder_unrealize(hcam);
2182 printf("Fail to call mm_camcorder_unrealize = %x\n", err);
2191 int mm_camcorder_unrealize(MMHandleType camcorder);
2195 * mm_camcorder_start:\n
2196 * Start previewing. (Image/Video mode)
2197 * 'mm_camcorder_video_stream_callback' is activated after calling this function.
2199 * @param[in] camcorder A handle of camcorder.
2200 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2201 * Please refer 'mm_error.h' to know the exact meaning of the error.
2202 * @see mm_camcorder_stop
2203 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_READY
2204 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2209 #include <mm_camcorder.h>
2211 //For image capturing
2212 gboolean initialize_image_capture()
2215 MMCamPreset cam_info;
2216 char *err_attr_name = NULL;
2217 void * hdisplay = NULL;
2220 //Set video device as 'camera0' (main camera device)
2221 cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2223 err = mm_camcorder_create(&hcam, &cam_info);
2225 if (err != MM_ERROR_NONE) {
2226 printf("Fail to call mm_camcorder_create = %x\n", err);
2230 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2231 mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2233 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2234 hsize = sizeof(ad.xid); //size of xid structure.
2236 // camcorder attribute setting
2237 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2238 MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2239 MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2240 MMCAM_CAMERA_WIDTH, 640,
2241 MMCAM_CAMERA_HEIGHT, 480,
2242 MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2243 MMCAM_CAMERA_FPS, 30,
2244 MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2245 MMCAM_DISPLAY_HANDLE, (void*) hdisplay, hsize,
2246 MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
2247 MMCAM_CAPTURE_WIDTH, 640,
2248 MMCAM_CAPTURE_HEIGHT, 480,
2252 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2253 if (err_attr_name) {
2254 free(err_attr_name);
2255 err_attr_name = NULL;
2260 err = mm_camcorder_realize(hcam);
2262 printf("Fail to call mm_camcorder_realize = %x\n", err);
2267 err = mm_camcorder_start(hcam);
2269 printf("Fail to call mm_camcorder_start = %x\n", err);
2277 gboolean initialize_video_capture()
2280 MMCamPreset cam_info;
2281 char *err_attr_name = NULL;
2282 void * hdisplay = NULL;
2285 //Set video device as 'camera0' (main camera device)
2286 cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2288 err = mm_camcorder_create(&hcam, &cam_info);
2290 if (err != MM_ERROR_NONE) {
2291 printf("Fail to call mm_camcorder_create = %x\n", err);
2295 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, hcam);
2297 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2298 hsize = sizeof(ad.xid); //size of xid structure.
2300 // camcorder attribute setting
2301 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2302 MMCAM_MODE, MM_CAMCORDER_MODE_VIDEO,
2303 MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2304 MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2305 MMCAM_VIDEO_ENCODER, MM_VIDEO_CODEC_MPEG4,
2306 MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2307 MMCAM_CAMERA_WIDTH, 1280,
2308 MMCAM_CAMERA_HEIGHT, 720,
2309 MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_NV12,
2310 MMCAM_CAMERA_FPS, 30,
2311 MMCAM_AUDIO_SAMPLERATE, 44100,
2312 MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2313 MMCAM_AUDIO_CHANNEL, 2,
2314 MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2315 MMCAM_DISPLAY_HANDLE, (void*) hdisplay, hsize,
2316 MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2320 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2321 if (err_attr_name) {
2322 free(err_attr_name);
2323 err_attr_name = NULL;
2328 err = mm_camcorder_realize(hcam);
2330 printf("Fail to call mm_camcorder_realize = %x\n", err);
2335 err = mm_camcorder_start(hcam);
2337 printf("Fail to call mm_camcorder_start = %x\n", err);
2344 //For audio(only) capturing
2345 gboolean initialize_audio_capture()
2348 MMCamPreset cam_info;
2349 char *err_attr_name = NULL;
2350 void * hdisplay = NULL;
2353 //Set no video device, because audio recording doesn't need video input.
2354 cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
2356 err = mm_camcorder_create(&hcam, &cam_info);
2358 if (err != MM_ERROR_NONE) {
2359 printf("Fail to call mm_camcorder_create = %x\n", err);
2363 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2365 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2366 hsize = sizeof(ad.xid); //size of xid structure.
2368 // camcorder attribute setting
2369 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2370 MMCAM_MODE, MM_CAMCORDER_MODE_AUDIO,
2371 MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2372 MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2373 MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2374 MMCAM_AUDIO_SAMPLERATE, 44100,
2375 MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2376 MMCAM_AUDIO_CHANNEL, 2,
2377 MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2378 MMCAM_TARGET_TIME_LIMIT, 360000,
2382 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2383 if (err_attr_name) {
2384 free(err_attr_name);
2385 err_attr_name = NULL;
2390 err = mm_camcorder_realize(hcam);
2392 printf("Fail to call mm_camcorder_realize = %x\n", err);
2397 err = mm_camcorder_start(hcam);
2399 printf("Fail to call mm_camcorder_start = %x\n", err);
2407 int mm_camcorder_start(MMHandleType camcorder);
2411 * mm_camcorder_stop:\n
2412 * Stop previewing. (Image/Video mode)
2413 * This function will change the status of pipeline. If an application doesn't return callbacks
2414 * of camcorder, this function can be locked. For example, if your application still
2415 * holds '#mm_camcorder_video_capture_callback' or '#mm_camcorder_video_stream_callback',
2416 * this function could be hung. So users have to return every callback before calling this function.
2418 * @param[in] camcorder A handle of camcorder.
2419 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2420 * Please refer 'mm_error.h' to know the exact meaning of the error.
2421 * @see mm_camcorder_start
2422 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2423 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_READY
2428 #include <mm_camcorder.h>
2430 gboolean stop_camcorder()
2435 err = mm_camcorder_stop(hcam);
2437 printf("Fail to call mm_camcorder_stop = %x\n", err);
2446 int mm_camcorder_stop(MMHandleType camcorder);
2450 * mm_camcorder_capture_start:\n
2451 * Start capturing of still images. (Image mode only)
2452 * Captured image will be delievered through 'mm_camcorder_video_capture_callback'.
2453 * So basically, the operation is working asynchronously. \n
2454 * When a user call this function, MSL will stop to retrieving preview from camera device.
2455 * Then set capture resolution, pixel format, and encoding type to camera driver. After resuming,
2456 * camera can get still image. A user will be notified by
2457 * 'MM_MESSAGE_CAMCORDER_CAPTURED' message when capturing succeed. When a user sets
2458 * multishot (by setting multiple number to MMCAM_CAPTURE_COUNT), the message
2459 * will be called multiple time. You can get the number of image from 'code' of
2460 * 'MMMessageParamType'.
2462 * @param[in] camcorder A handle of camcorder.
2463 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2464 * Please refer 'mm_error.h' to know the exact meaning of the error.
2465 * @see mm_camcorder_capture_stop
2466 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2467 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_CAPTURING
2468 * @remarks To call this function, preview should be started successfully.\n
2469 * This function is a pair of mm_camcorder_capture_stop().
2470 * So user should call mm_camcorder_capture_stop() after getting captured image.
2474 #include <mm_camcorder.h>
2476 gboolean capturing_picture()
2480 err = mm_camcorder_capture_start(hcam);
2483 printf("Fail to call mm_camcorder_capture_start = %x\n", err);
2487 //mm_camcorder_capture_stop should be called after getting
2488 //MM_MESSAGE_CAMCORDER_CAPTURED message.
2496 int mm_camcorder_capture_start(MMHandleType camcorder);
2500 * mm_camcorder_capture_stop:\n
2501 * Stop capturing of still images. (Image mode only)
2502 * This function notifies the end of capturing and launch preview again.
2503 * Just as mm_camcorder_capture_start(), this funciton stops still image stream and set preview information such as
2504 * resolution, pixel format, and framerate to camera driver. Then it command to start preview.
2505 * If you don't call this, preview will not be displayed even though capturing was finished.
2507 * @param[in] camcorder A handle of camcorder.
2508 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2509 * Please refer 'mm_error.h' to know the exact meaning of the error.
2510 * @see mm_camcorder_capture_start
2511 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_CAPTURING
2512 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2513 * @remarks To call this function, a user has to call mm_camcorder_capture_start() first.\n
2514 * This is not a function to stop multishot in the middle of operation. For that,
2515 * please use '#MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT' instead.
2519 #include <mm_camcorder.h>
2521 gboolean capturing_picture_stop()
2525 err = mm_camcorder_capture_stop(hcam);
2527 printf("Fail to call mm_camcorder_capture_stop = %x\n", err);
2531 //After calling upper function, preview will start.
2538 int mm_camcorder_capture_stop(MMHandleType camcorder);
2542 * mm_camcorder_record:\n
2543 * Start recording. (Audio/Video mode only)
2544 * Camcorder starts to write a file when you call this function. You can specify the name of file
2545 * using '#MMCAM_TARGET_FILENAME'. Beware, if you fail to call mm_camcorder_commit() or mm_camcorder_cancel(),
2546 * the recorded file is still on the storage.
2548 * @param[in] camcorder A handle of camcorder.
2549 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2550 * Please refer 'mm_error.h' to know the exact meaning of the error.
2551 * @see mm_camcorder_pause
2552 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2553 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_RECORDING
2558 #include <mm_camcorder.h>
2560 gboolean record_and_cancel_video_file()
2565 err = mm_camcorder_record(hcam);
2567 printf("Fail to call mm_camcorder_record = %x\n", err);
2576 int mm_camcorder_record(MMHandleType camcorder);
2580 * mm_camcorder_pause:\n
2581 * Pause A/V recording or Audio recording. (Audio/Video mode only)
2582 * 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.
2583 * If you call mm_camcorder_commit() while on pausing, the recorded file only has Audio and Video stream which were generated before pause().
2585 * @param[in] camcorder A handle of camcorder.
2586 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2587 * Please refer 'mm_error.h' to know the exact meaning of the error.
2588 * @see mm_camcorder_record
2589 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2590 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_PAUSED
2591 * @remarks Even though this function is for pausing recording, small amount of buffers could be recorded after pause().
2592 * Because the buffers which are existed in the queue were created before pause(), the buffers should be recorded.
2596 #include <mm_camcorder.h>
2598 gboolean record_pause_and_resume_recording()
2603 err = mm_camcorder_record(hcam);
2605 printf("Fail to call mm_camcorder_record = %x\n", err);
2609 // Wait while recording...
2612 err = mm_camcorder_pause(hcam);
2614 printf("Fail to call mm_camcorder_pause = %x\n", err);
2621 err = mm_camcorder_record(hcam);
2623 printf("Fail to call mm_camcorder_record = %x\n", err);
2633 int mm_camcorder_pause(MMHandleType camcorder);
2637 * mm_camcorder_commit:\n
2638 * Stop recording and save results. (Audio/Video mode only)\n
2639 * After starting recording, encoded data frame will be stored in the location specified in MMCAM_TARGET_FILENAME.
2640 * Some encoder or muxer require a certain type of finalizing such as adding some information to header.
2641 * This function takes that roll. So if you don't call this function after recording, the result file may not be playable.\n
2642 * After committing successfully, camcorder resumes displaying preview (video recording case).
2643 * Because this is the function for saving the recording result, the operation is available
2644 * only when the mode of camcorder is MM_CAMCORDER_MODE_AUDIO or MM_CAMCORDER_MODE_VIDEO.
2646 * @param[in] camcorder A handle of camcorder.
2647 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2648 * Please refer 'mm_error.h' to know the exact meaning of the error.
2649 * @see mm_camcorder_cancel
2650 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2651 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2652 * @remarks This function can take a few second when recording time is long.
2653 * and if there are only quite few input buffer from video src or audio src,
2654 * committing could be failed.
2658 #include <mm_camcorder.h>
2660 gboolean record_and_save_video_file()
2665 err = mm_camcorder_record(hcam);
2667 printf("Fail to call mm_camcorder_record = %x\n", err);
2671 // Wait while recording for test...
2672 // In normal case, mm_camcorder_record() and mm_camcorder_commit() aren't called in the same function.
2675 err = mm_camcorder_commit(hcam);
2677 printf("Fail to call mm_camcorder_commit = %x\n", err);
2686 int mm_camcorder_commit(MMHandleType camcorder);
2690 * mm_camcorder_cancel:\n
2691 * Stop recording and discard the result. (Audio/Video mode only)
2692 * When a user want to finish recording without saving the result file, this function can be used.
2693 * Like mm_camcorder_commit(), this function also stops recording, release related resources(like codec) ,and goes back to preview status.
2694 * However, instead of saving file, this function unlinks(delete) the result.\n
2695 * Because this is the function for canceling recording, the operation is available
2696 * only when mode is MM_CAMCORDER_MODE_AUDIO or MM_CAMCORDER_MODE_VIDEO.
2698 * @param[in] camcorder A handle of camcorder.
2699 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2700 * Please refer 'mm_error.h' to know the exact meaning of the error.
2701 * @see mm_camcorder_commit
2702 * @pre Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2703 * @post Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2708 #include <mm_camcorder.h>
2710 gboolean record_and_cancel_video_file()
2715 err = mm_camcorder_record(hcam);
2717 printf("Fail to call mm_camcorder_record = %x\n", err);
2721 // Wait while recording...
2724 err = mm_camcorder_cancel(hcam);
2726 printf("Fail to call mm_camcorder_cancel = %x\n", err);
2735 int mm_camcorder_cancel(MMHandleType camcorder);
2739 * mm_camcorder_set_message_callback:\n
2740 * Set callback for receiving messages from camcorder. Through this callback function, camcorder
2741 * sends various message including status changes, asynchronous error, capturing, and limitations.
2742 * One thing you have to know is that message callback is working on the main loop of application.
2743 * So until releasing the main loop, message callback will not be called.
2745 * @param[in] camcorder A handle of camcorder.
2746 * @param[in] callback Function pointer of callback function. Please refer 'MMMessageCallback'.
2747 * @param[in] user_data User parameter for passing to callback function.
2748 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2749 * Please refer 'mm_error.h' to know the exact meaning of the error.
2750 * @see MMMessageCallback
2753 * @remarks registered 'callback' is called on main loop of the application. So until the main loop is released, 'callback' will not be called.
2757 #include <mm_camcorder.h>
2759 gboolean setting_msg_callback()
2762 mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2770 int mm_camcorder_set_message_callback(MMHandleType camcorder, MMMessageCallback callback, void *user_data);
2774 * mm_camcorder_set_video_stream_callback:\n
2775 * Set callback for user defined video stream callback function.
2776 * Users can retrieve video frame using registered callback.
2777 * The callback function holds the same buffer that will be drawed on the display device.
2778 * So if an user change the buffer, it will be displayed on the device.
2780 * @param[in] camcorder A handle of camcorder.
2781 * @param[in] callback Function pointer of callback function.
2782 * @param[in] user_data User parameter for passing to callback function.
2783 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2784 * Please refer 'mm_error.h' to know the exact meaning of the error.
2785 * @see mm_camcorder_video_stream_callback
2788 * @remarks registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2792 #include <mm_camcorder.h>
2794 gboolean setting_video_stream_callback()
2797 mm_camcorder_set_video_stream_callback(hcam, (mm_camcorder_video_stream_callback)camcordertest_video_stream_cb, (void*)hcam);
2803 int mm_camcorder_set_video_stream_callback(MMHandleType camcorder, mm_camcorder_video_stream_callback callback, void *user_data);
2807 * mm_camcorder_set_video_capture_callback:\n
2808 * Set callback for user defined video capture callback function. (Image mode only)
2809 * mm_camcorder deliever captured image through the callback.\n
2810 * Normally, this function provides main captured image and thumnail image. But depending on the environment,
2811 * thumnail would not be available. Information related with main captured image and thumnail image is also included
2812 * in the argument of the callback function.
2813 * For more detail information of callback, please refer 'mm_camcorder_video_capture_callback'.
2815 * @param[in] camcorder A handle of camcorder.
2816 * @param[in] callback Function pointer of callback function.
2817 * @param[in] user_data User parameter for passing to callback function.
2818 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2819 * Please refer 'mm_error.h' to know the exact meaning of the error.
2820 * @see mm_camcorder_video_capture_callback
2823 * @remarks registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2827 #include <mm_camcorder.h>
2829 gboolean setting_capture_callback()
2832 mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2838 int mm_camcorder_set_video_capture_callback(MMHandleType camcorder, mm_camcorder_video_capture_callback callback, void *user_data);
2842 * mm_camcorder_set_audio_stream_callback:\n
2843 * Set callback for user defined audio stream callback function.
2844 * Users can retrieve audio data using registered callback.
2845 * The callback function holds the same buffer that will be recorded.
2846 * So if an user change the buffer, the result file will has the buffer.
2848 * @param[in] camcorder A handle of camcorder.
2849 * @param[in] callback Function pointer of callback function.
2850 * @param[in] user_data User parameter for passing to callback function.
2851 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2852 * Please refer 'mm_error.h' to know the exact meaning of the error.
2853 * @see mm_camcorder_audio_stream_callback
2856 * @remarks registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2860 #include <mm_camcorder.h>
2862 gboolean setting_audio_stream_callback()
2865 mm_camcorder_set_audio_stream_callback(hcam, (mm_camcorder_audio_stream_callback)camcordertest_audio_stream_cb, (void*)hcam);
2871 int mm_camcorder_set_audio_stream_callback(MMHandleType camcorder, mm_camcorder_audio_stream_callback callback, void *user_data);
2875 * mm_camcorder_get_state:\n
2876 * Get the current state of camcorder.
2877 * mm_camcorder is working on the base of its state. An user should check the state of mm_camcorder before calling its functions.
2878 * If the handle is avaiable, user can retrieve the value.
2880 * @param[in] camcorder A handle of camcorder.
2881 * @param[out] state On return, it contains current state of camcorder.
2882 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2883 * Please refer 'mm_error.h' to know the exact meaning of the error.
2884 * @see MMCamcorderStateType
2891 #include <mm_camcorder.h>
2893 gboolean get_state_of_camcorder()
2895 MMCamcorderStateType state;
2897 //Get state of camcorder
2898 mm_camcorder_get_state(hcam, &state);
2899 printf("Current status is %d\n", state);
2906 int mm_camcorder_get_state(MMHandleType camcorder, MMCamcorderStateType *state);
2910 * mm_camcorder_get_attributes:\n
2911 * Get attributes of camcorder with given attribute names. This function can get multiple attributes
2912 * simultaneously. If one of attribute fails, this function will stop at the point.
2913 * 'err_attr_name' let you know the name of the attribute.
2915 * @param[in] camcorder Specifies the camcorder handle.
2916 * @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
2917 * Free this variable after using.
2918 * @param[in] attribute_name attribute name that user want to get.
2919 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2920 * Please refer 'mm_error.h' to know the exact meaning of the error.
2923 * @remarks You can retrieve multiple attributes at the same time. @n
2924 * This function must finish with 'NULL' argument. @n
2925 * ex) mm_camcorder_get_attributes(....... , NULL);
2926 * @see mm_camcorder_set_attributes
2930 #include <mm_camcorder.h>
2932 gboolean getting_attribute()
2935 MMCamPreset cam_info;
2936 char *err_attr_name = NULL;
2937 void * hdisplay = NULL;
2940 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2941 hsize = sizeof(ad.xid); //size of xid structure.
2943 // camcorder attribute setting
2944 err = mm_camcorder_get_attributes(hcamcorder, NULL, //The second is the argument for debugging. But you can skip this.
2945 MMCAM_MODE, &mode, //You have to input a pointer instead of variable itself.
2946 NULL); //mm_camcorder_set_attributes() should be finished with a NULL argument.
2953 int mm_camcorder_get_attributes(MMHandleType camcorder, char **err_attr_name, const char *attribute_name, ...) G_GNUC_NULL_TERMINATED;
2958 * mm_camcorder_set_attributes:\n
2959 * Set attributes of camcorder with given attribute names. This function can set multiple attributes
2960 * simultaneously. If one of attribute fails, this function will stop at the point.
2961 * 'err_attr_name' let you know the name of the attribute.
2963 * @param[in] camcorder Specifies the camcorder handle.
2964 * @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
2965 * Free this variable after using.
2966 * @param[in] attribute_name attribute name that user want to set.
2967 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2968 * Please refer 'mm_error.h' to know the exact meaning of the error.
2971 * @remarks You can put multiple attributes to camcorder at the same time. @n
2972 * This function must finish with 'NULL' argument. @n
2973 * ex) mm_camcorder_set_attributes(....... , NULL);
2974 * @see mm_camcorder_get_attributes
2978 #include <mm_camcorder.h>
2980 gboolean setting_attribute()
2983 MMCamPreset cam_info;
2984 char *err_attr_name = NULL;
2985 void * hdisplay = NULL;
2988 hdisplay = &ad.xid; //xid of xwindow. This value can be different depending on your environment.
2989 hsize = sizeof(ad.xid); //size of xid structure.
2991 // camcorder attribute setting
2992 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name, //The second is the argument for debugging.
2993 MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2994 MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2995 MMCAM_CAMERA_WIDTH, 640,
2996 MMCAM_CAMERA_HEIGHT, 480,
2997 MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2998 MMCAM_CAMERA_FPS, 30,
2999 MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
3000 MMCAM_DISPLAY_HANDLE, (void*) hdisplay, hsize, //Beware some types require 'size' value, too. (STRING, DATA type attributes)
3001 MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
3002 MMCAM_CAPTURE_WIDTH, 640,
3003 MMCAM_CAPTURE_HEIGHT, 480,
3004 NULL); //mm_camcorder_set_attributes() should be finished with a NULL argument.
3007 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.
3008 if (err_attr_name) {
3009 free(err_attr_name); //Please free 'err_attr_name', after using the argument.
3010 err_attr_name = NULL;
3019 int mm_camcorder_set_attributes(MMHandleType camcorder, char **err_attr_name, const char *attribute_name, ...) G_GNUC_NULL_TERMINATED;
3023 * mm_camcorder_get_attribute_info:\n
3024 * Get detail information of the attribute. To manager attributes, an user may want to know the exact character of the attribute,
3025 * such as type, flag, and validity. This is the function to provide such information.
3026 * Depending on the 'validity_type', validity union would be different. To know about the type of union, please refer 'MMCamAttrsInfo'.
3028 * @param[in] camcorder Specifies the camcorder handle.
3029 * @param[in] attribute_name attribute name that user want to get information.
3030 * @param[out] info a structure that holds information related with the attribute.
3031 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3032 * Please refer 'mm_error.h' to know the exact meaning of the error.
3035 * @remarks If the function succeeds, 'info' holds detail information about the attribute, such as type,
3036 * flag, validity_type, validity_values, and default values.
3037 * @see mm_camcorder_get_attributes, mm_camcorder_set_attributes
3041 #include <mm_camcorder.h>
3043 gboolean getting_info_from_attribute()
3045 MMCamAttrsInfo info;
3048 err = mm_camcorder_get_attribute_info(handle, MMCAM_CAPTURE_HEIGHT, &info);
3050 printf("Fail to call mm_camcorder_get_attribute_info()");
3054 //Now 'info' has many information about 'MMCAM_CAPTURE_HEIGHT'
3060 int mm_camcorder_get_attribute_info(MMHandleType camcorder, const char *attribute_name, MMCamAttrsInfo *info);
3064 * mm_camcorder_get_fps_list_by_resolution:\n
3065 * 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,
3066 * Gives attribute information structure, from the configure data.
3067 * Depending on the 'validity_type', validity union would be different. To know about the type of union, please refer 'MMCamAttrsInfo'.
3069 * @param[in] camcorder Specifies the camcorder handle.
3070 * @param[in] width width value of the current Preview resolution.
3071 * @param[in] height height value of the current Preview resolution.
3072 * @param[out] fps_info a structure that holds information related with the attribute.
3073 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3074 * Please refer 'mm_error.h' to know the exact meaning of the error.
3077 * @remarks If the function succeeds, 'info' holds detail information about the attribute, such as type,
3078 * flag, validity_type, validity_values, and default values.
3079 * @see mm_camcorder_get_attributes, mm_camcorder_set_attributes
3083 #include <mm_camcorder.h>
3085 gboolean getting_info_from_attribute()
3087 MMCamAttrsInfo info;
3090 err = mm_camcorder_get_fps_list_by_resolution(handle, width, height, &info);
3092 printf("Fail to call mm_camcorder_get_attribute_info()");
3096 //Now 'info' has many information about 'MMCAM_CAPTURE_HEIGHT'
3102 int mm_camcorder_get_fps_list_by_resolution(MMHandleType camcorder, int width, int height, MMCamAttrsInfo *fps_info);
3106 * mm_camcorder_init_focusing:\n
3107 * Initialize focusing. \n
3108 * This function stops focusing action and adjust the camera lens to initial position.
3109 * Some camera applciation requires to initialize its lens position after releasing half shutter. In that case,
3110 * this should be a good choice. Comparing with mm_camcorder_stop_focusing, this function not only stops focusing,
3111 * but also initialize the lens. Preview image might be out-focused after calling this function.
3112 * @param[in] camcorder A handle of camcorder.
3113 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3114 * Please refer 'mm_error.h' to know the exact meaning of the error.
3115 * @pre The status of camcorder should be MM_CAMCORDER_STATE_PREPARE, MM_CAMCORDER_STATE_RECORDING, or MM_CAMCORDER_STATE_PAUSED.
3118 * @see mm_camcorder_start_focusing, mm_camcorder_stop_focusing
3122 #include <mm_camcorder.h>
3124 gboolean start_autofocus()
3127 char * err_attr_name = NULL;
3129 // Set focus mode to 'AUTO' and scan range to 'AF Normal'.
3130 //You just need to set these values one time. After that, just call mm_camcorder_start_focusing().
3131 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
3132 MMCAM_CAMERA_FOCUS_MODE, MM_CAMCORDER_FOCUS_MODE_AUTO,
3133 MMCAM_CAMERA_AF_SCAN_RANGE, MM_CAMCORDER_AUTO_FOCUS_NORMAL,
3137 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
3138 if (err_attr_name) {
3139 free(err_attr_name);
3140 err_attr_name = NULL;
3145 mm_camcorder_init_focusing(hcam);
3146 mm_camcorder_start_focusing(hcam);
3147 printf("Waiting for adjusting focus\n");
3149 // Waiting for 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED'
3156 int mm_camcorder_init_focusing(MMHandleType camcorder);
3160 * mm_camcorder_start_focusing:\n
3161 * Start focusing. \n
3162 * This function command to start focusing opeartion. Because focusing operation depends on mechanic or electric module,
3163 * it may take small amount of time. (For ex, 500ms ~ 3sec). \n
3164 * This function works asynchronously. When an user call this function, it will return immediately.
3165 * However, focusing operation will continue until it gets results.
3166 * After finishing operation, you can get 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' message.
3167 * 'param.code' of the message structure describes the fucusing was success or not.
3169 * @param[in] camcorder A handle of camcorder.
3170 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3171 * Please refer 'mm_error.h' to know the exact meaning of the error.
3175 * @see mm_camcorder_init_focusing, mm_camcorder_stop_focusing
3179 #include <mm_camcorder.h>
3181 gboolean start_autofocus()
3184 char * err_attr_name = NULL;
3186 // Set focus mode to 'AUTO' and scan range to 'AF Normal'.
3187 //You just need to set these values one time. After that, just call mm_camcorder_start_focusing().
3188 err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
3189 MMCAM_CAMERA_FOCUS_MODE, MM_CAMCORDER_FOCUS_MODE_AUTO,
3190 MMCAM_CAMERA_AF_SCAN_RANGE, MM_CAMCORDER_AUTO_FOCUS_NORMAL,
3194 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
3195 if (err_attr_name) {
3196 free(err_attr_name);
3197 err_attr_name = NULL;
3202 mm_camcorder_init_focusing(hcam);
3203 mm_camcorder_start_focusing(hcam);
3204 printf("Waiting for adjusting focus\n");
3206 // Waiting for 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED'
3213 int mm_camcorder_start_focusing(MMHandleType camcorder);
3217 * mm_camcorder_stop_focusing:\n
3218 * Stop focusing. This function halts focusing operation.\n
3219 * This is the function to stop focusing in the middle of the operation. So if focusing is already finished or not started yet,
3220 * this function will do nothing.
3222 * @param[in] camcorder A handle of camcorder.
3223 * @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3224 * Please refer 'mm_error.h' to know the exact meaning of the error.
3225 * @see mm_camcorder_init_focusing, mm_camcorder_start_focusing
3226 * @pre mm_camcorder_start_focusing() should be called before calling this function.
3232 #include <mm_camcorder.h>
3234 gboolean stop_autofocus()
3239 mm_camcorder_stop_focusing(hcam);
3246 int mm_camcorder_stop_focusing(MMHandleType camcorder);
3249 * mm_camcorder_get_video_caps:
3250 * Stop focusing. This function halts focusing operation.
3251 * This is the function to stop focusing in the middle of the operation.
3252 * So if focusing is already finished or not started yet,
3253 * this function will do nothing.
3255 * @param[in] camcorder A handle of camcorder.
3256 * @return This function returns zero(MM_ERROR_NONE) on success,
3257 * or negative value with error code.
3258 * Please refer 'mm_error.h' to know the exact meaning of the error.
3259 * @see mm_camcorder_create
3260 * @pre mm_camcorder_realize() should be called before calling this function.
3266 int mm_camcorder_get_video_caps(MMHandleType handle, char **caps);
3276 #endif /* __MM_CAMCORDER_H__ */