src/include/mm_camcorder.h

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