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  * Enable to play capture sound
1206  */
1207 #define MMCAM_CAPTURE_SOUND_ENABLE              "capture-sound-enable"
1208
1209 /**
1210  * Flip of video input stream.
1211  * @see         MMFlipType (in mm_types.h)
1212  */
1213 #define MMCAM_CAMERA_FLIP                       "camera-flip"
1214
1215 /**
1216  * Support Zero Shutter Lag capture
1217  */
1218 #define MMCAM_SUPPORT_ZSL_CAPTURE               "support-zsl-capture"
1219
1220 /**
1221 * Support zero copy format
1222 */
1223 #define MMCAM_SUPPORT_ZERO_COPY_FORMAT          "support-zero-copy-format"
1224
1225 /**
1226 * Support media packet callback
1227 */
1228 #define MMCAM_SUPPORT_MEDIA_PACKET_PREVIEW_CB   "support-media-packet-preview-cb"
1229
1230 /**
1231  * Enable to write tags for recorded file
1232  */
1233 #define MMCAM_RECORDER_TAG_ENABLE               "recorder-tag-enable"
1234
1235 /**
1236  * Determines the socket stream path
1237  */
1238 #define MMCAM_DISPLAY_SOCKET_PATH               "display-socket-path"
1239
1240 /**
1241  * PID for sound focus
1242  */
1243 #define MMCAM_PID_FOR_SOUND_FOCUS               "pid-for-sound-focus"
1244
1245 /**
1246  * Root directory of application
1247  */
1248 #define MMCAM_ROOT_DIRECTORY                    "root-directory"
1249
1250 /**
1251  * Bitrate for encoded preview stream
1252  */
1253 #define MMCAM_ENCODED_PREVIEW_BITRATE           "encoded-preview-bitrate"
1254
1255 /**
1256  * GOP interval for encoded preview stream
1257  */
1258 #define MMCAM_ENCODED_PREVIEW_GOP_INTERVAL      "encoded-preview-gop-interval"
1259
1260 /**
1261  * The distance to move the camera horizontally and physically
1262  */
1263 #define MMCAM_CAMERA_PAN_MECHA                  "camera-pan-mecha"
1264
1265 /**
1266  * The distance to move the camera horizontally
1267  */
1268 #define MMCAM_CAMERA_PAN_ELEC                   "camera-pan-elec"
1269
1270 /**
1271  * The distance to move the camera vertically and physically
1272  */
1273 #define MMCAM_CAMERA_TILT_MECHA                 "camera-tilt-mecha"
1274
1275 /**
1276  * The distance to move the camera vertically
1277  */
1278 #define MMCAM_CAMERA_TILT_ELEC                  "camera-tilt-elec"
1279
1280 /**
1281  * The type of PTZ(Pan Tilt Zoom). Mechanical or Electonic PTZ.
1282  */
1283 #define MMCAM_CAMERA_PTZ_TYPE                   "camera-ptz-type"
1284
1285 /**
1286  * Stream type and index for sound route
1287  */
1288 #define MMCAM_SOUND_STREAM_TYPE                 "sound-stream-type"
1289 #define MMCAM_SOUND_STREAM_INDEX                "sound-stream-index"
1290
1291 /**
1292  * The display reuse flag and sink element pointer
1293  */
1294 #define MMCAM_DISPLAY_REUSE_HINT                "display-reuse-hint"
1295 #define MMCAM_DISPLAY_REUSE_ELEMENT             "display-reuse-element"
1296
1297 /**
1298  * The GBbus connection from outside
1299  */
1300 #define MMCAM_GDBUS_CONNECTION                  "gdbus-connection"
1301
1302 /**
1303  * Replay gain enable
1304  */
1305 #define MMCAM_AUDIO_REPLAY_GAIN_ENABLE          "audio-replay-gain-enable"
1306
1307 /**
1308  * Reference level for replay gain
1309  */
1310 #define MMCAM_AUDIO_REPLAY_GAIN_REFERENCE_LEVEL "audio-replay-gain-reference-level"
1311
1312 /*=======================================================================================
1313 | ENUM DEFINITIONS                                                                      |
1314 ========================================================================================*/
1315 /**
1316  * An enumeration for camcorder states.
1317  */
1318 typedef enum {
1319         MM_CAMCORDER_STATE_NONE,                /**< Camcorder is not created yet */
1320         MM_CAMCORDER_STATE_NULL,                /**< Camcorder is created, but not initialized yet */
1321         MM_CAMCORDER_STATE_READY,               /**< Camcorder is ready to capture */
1322         MM_CAMCORDER_STATE_PREPARE,             /**< Camcorder is prepared to capture (Preview) */
1323         MM_CAMCORDER_STATE_CAPTURING,           /**< Camcorder is now capturing still images */
1324         MM_CAMCORDER_STATE_RECORDING,           /**< Camcorder is now recording */
1325         MM_CAMCORDER_STATE_PAUSED,              /**< Camcorder is paused while recording */
1326         MM_CAMCORDER_STATE_NUM,                 /**< Number of camcorder states */
1327 } MMCamcorderStateType;
1328
1329 /**
1330  * An enumeration for camcorder mode.
1331  */
1332 typedef enum {
1333         MM_CAMCORDER_MODE_VIDEO_CAPTURE = 0,    /**< Video recording and Image capture mode */
1334         MM_CAMCORDER_MODE_AUDIO,                /**< Audio recording mode */
1335 } MMCamcorderModeType;
1336
1337 /**
1338  * An enumeration for facing direction.
1339  */
1340 typedef enum {
1341         MM_CAMCORDER_CAMERA_FACING_DIRECTION_REAR = 0, /**< Facing direction of camera is REAR */
1342         MM_CAMCORDER_CAMERA_FACING_DIRECTION_FRONT,    /**< Facing direction of camera is FRONT */
1343 } MMCamcorderCameraFacingDirection;
1344
1345
1346 /**
1347  * An enumeration of Audio Format.
1348  */
1349 typedef enum {
1350         MM_CAMCORDER_AUDIO_FORMAT_PCM_U8 = 0,           /**< unsigned 8bit audio */
1351         MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE = 2,       /**< signed 16bit audio. Little endian. */
1352 } MMCamcorderAudioFormat;
1353
1354
1355 /**
1356  * An enumeration for color tone. Color tone provides an impression of
1357  * seeing through a tinted glass.
1358  */
1359 enum MMCamcorderColorToneType {
1360         MM_CAMCORDER_COLOR_TONE_NONE = 0,               /**< None */
1361         MM_CAMCORDER_COLOR_TONE_MONO,                   /**< Mono */
1362         MM_CAMCORDER_COLOR_TONE_SEPIA,                  /**< Sepia */
1363         MM_CAMCORDER_COLOR_TONE_NEGATIVE,               /**< Negative */
1364         MM_CAMCORDER_COLOR_TONE_BLUE,                   /**< Blue */
1365         MM_CAMCORDER_COLOR_TONE_GREEN,                  /**< Green */
1366         MM_CAMCORDER_COLOR_TONE_AQUA,                   /**< Aqua */
1367         MM_CAMCORDER_COLOR_TONE_VIOLET,                 /**< Violet */
1368         MM_CAMCORDER_COLOR_TONE_ORANGE,                 /**< Orange */
1369         MM_CAMCORDER_COLOR_TONE_GRAY,                   /**< Gray */
1370         MM_CAMCORDER_COLOR_TONE_RED,                    /**< Red */
1371         MM_CAMCORDER_COLOR_TONE_ANTIQUE,                /**< Antique */
1372         MM_CAMCORDER_COLOR_TONE_WARM,                   /**< Warm */
1373         MM_CAMCORDER_COLOR_TONE_PINK,                   /**< Pink */
1374         MM_CAMCORDER_COLOR_TONE_YELLOW,                 /**< Yellow */
1375         MM_CAMCORDER_COLOR_TONE_PURPLE,                 /**< Purple */
1376         MM_CAMCORDER_COLOR_TONE_EMBOSS,                 /**< Emboss */
1377         MM_CAMCORDER_COLOR_TONE_OUTLINE,                /**< Outline */
1378         MM_CAMCORDER_COLOR_TONE_SOLARIZATION,           /**< Solarization */
1379         MM_CAMCORDER_COLOR_TONE_SKETCH,                 /**< Sketch */
1380         MM_CAMCORDER_COLOR_TONE_WASHED,                 /**< Washed */
1381         MM_CAMCORDER_COLOR_TONE_VINTAGE_WARM,           /**< Vintage warm */
1382         MM_CAMCORDER_COLOR_TONE_VINTAGE_COLD,           /**< Vintage cold */
1383         MM_CAMCORDER_COLOR_TONE_POSTERIZATION,          /**< Posterization */
1384         MM_CAMCORDER_COLOR_TONE_CARTOON,                /**< Cartoon */
1385         MM_CAMCORDER_COLOR_TONE_SELECTIVE_RED,          /**< Selective color - Red */
1386         MM_CAMCORDER_COLOR_TONE_SELECTIVE_GREEN,        /**< Selective color - Green */
1387         MM_CAMCORDER_COLOR_TONE_SELECTIVE_BLUE,         /**< Selective color - Blue */
1388         MM_CAMCORDER_COLOR_TONE_SELECTIVE_YELLOW,       /**< Selective color - Yellow */
1389         MM_CAMCORDER_COLOR_TONE_SELECTIVE_RED_YELLOW,   /**< Selective color - Red and Yellow */
1390 };
1391
1392
1393 /**
1394  * An enumeration for white balance. White Balance is the control that adjusts
1395  * the camcorder's color sensitivity to match the prevailing color of white
1396  * outdoor light, yellower indoor light, or (sometimes) greenish fluorescent
1397  * light. White balance may be set either automatically or manually. White balance
1398  * may be set "incorrectly" on purpose to achieve special effects.
1399  */
1400 enum MMCamcorderWhiteBalanceType {
1401         MM_CAMCORDER_WHITE_BALANCE_NONE = 0,            /**< None */
1402         MM_CAMCORDER_WHITE_BALANCE_AUTOMATIC,           /**< Automatic */
1403         MM_CAMCORDER_WHITE_BALANCE_DAYLIGHT,            /**< Daylight */
1404         MM_CAMCORDER_WHITE_BALANCE_CLOUDY,              /**< Cloudy */
1405         MM_CAMCORDER_WHITE_BALANCE_FLUOROSCENT,         /**< Fluorescent */
1406         MM_CAMCORDER_WHITE_BALANCE_INCANDESCENT,        /**< Incandescent */
1407         MM_CAMCORDER_WHITE_BALANCE_SHADE,               /**< Shade */
1408         MM_CAMCORDER_WHITE_BALANCE_HORIZON,             /**< Horizon */
1409         MM_CAMCORDER_WHITE_BALANCE_FLASH,               /**< Flash */
1410         MM_CAMCORDER_WHITE_BALANCE_CUSTOM,              /**< Custom */
1411 };
1412
1413
1414 /**
1415  * An enumeration for scene mode. Scene mode gives the environment condition
1416  * for operating camcorder. The mode of operation can be in daylight, night and
1417  * backlight. It can be an automatic setting also.
1418  */
1419 enum MMCamcorderSceneModeType {
1420         MM_CAMCORDER_SCENE_MODE_NORMAL = 0,     /**< Normal */
1421         MM_CAMCORDER_SCENE_MODE_PORTRAIT,       /**< Portrait */
1422         MM_CAMCORDER_SCENE_MODE_LANDSCAPE,      /**< Landscape */
1423         MM_CAMCORDER_SCENE_MODE_SPORTS,         /**< Sports */
1424         MM_CAMCORDER_SCENE_MODE_PARTY_N_INDOOR, /**< Party & indoor */
1425         MM_CAMCORDER_SCENE_MODE_BEACH_N_INDOOR, /**< Beach & indoor */
1426         MM_CAMCORDER_SCENE_MODE_SUNSET,         /**< Sunset */
1427         MM_CAMCORDER_SCENE_MODE_DUSK_N_DAWN,    /**< Dusk & dawn */
1428         MM_CAMCORDER_SCENE_MODE_FALL_COLOR,     /**< Fall */
1429         MM_CAMCORDER_SCENE_MODE_NIGHT_SCENE,    /**< Night scene */
1430         MM_CAMCORDER_SCENE_MODE_FIREWORK,       /**< Firework */
1431         MM_CAMCORDER_SCENE_MODE_TEXT,           /**< Text */
1432         MM_CAMCORDER_SCENE_MODE_SHOW_WINDOW,    /**< Show window */
1433         MM_CAMCORDER_SCENE_MODE_CANDLE_LIGHT,   /**< Candle light */
1434         MM_CAMCORDER_SCENE_MODE_BACKLIGHT,      /**< Backlight */
1435         MM_CAMCORDER_SCENE_MODE_AQUA,           /**< Aqua */
1436 };
1437
1438
1439 /**
1440  * An enumeration for focusing .
1441  */
1442 enum MMCamcorderFocusMode {
1443         MM_CAMCORDER_FOCUS_MODE_NONE = 0,       /**< Focus mode is None */
1444         MM_CAMCORDER_FOCUS_MODE_PAN,            /**< Pan focus mode*/
1445         MM_CAMCORDER_FOCUS_MODE_AUTO,           /**< Autofocus mode*/
1446         MM_CAMCORDER_FOCUS_MODE_MANUAL,         /**< Manual focus mode*/
1447         MM_CAMCORDER_FOCUS_MODE_TOUCH_AUTO,     /**< Touch Autofocus mode*/
1448         MM_CAMCORDER_FOCUS_MODE_CONTINUOUS,     /**< Continuous Autofocus mode*/
1449 };
1450
1451
1452 /**
1453  * An enumeration for auto focus scan range (af scan range)
1454  */
1455 enum MMCamcorderAutoFocusType {
1456         MM_CAMCORDER_AUTO_FOCUS_NONE = 0,       /**< Scan autofocus is not set */
1457         MM_CAMCORDER_AUTO_FOCUS_NORMAL,         /**< Scan autofocus normally*/
1458         MM_CAMCORDER_AUTO_FOCUS_MACRO,          /**< Scan autofocus in macro mode(close distance)*/
1459         MM_CAMCORDER_AUTO_FOCUS_FULL,           /**< Scan autofocus in full mode(all range scan, limited by dev spec)*/
1460 };
1461
1462
1463 /**
1464  * An enumeration for focus state.
1465  * When 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' is delievered through 'MMMessageCallback',
1466  * this enumeration will be set to 'code' of MMMessageParamType.
1467  */
1468 enum MMCamcorderFocusStateType {
1469         MM_CAMCORDER_FOCUS_STATE_RELEASED = 0,  /**< Focus released.*/
1470         MM_CAMCORDER_FOCUS_STATE_ONGOING,       /**< Focus in pregress*/
1471         MM_CAMCORDER_FOCUS_STATE_FOCUSED,       /**< Focus success*/
1472         MM_CAMCORDER_FOCUS_STATE_FAILED,        /**< Focus failed*/
1473 };
1474
1475
1476 /**
1477  * An enumeration for ISO.
1478  */
1479 enum MMCamcorderISOType {
1480         MM_CAMCORDER_ISO_AUTO = 0,              /**< ISO auto mode*/
1481         MM_CAMCORDER_ISO_50,                    /**< ISO 50*/
1482         MM_CAMCORDER_ISO_100,                   /**< ISO 100*/
1483         MM_CAMCORDER_ISO_200,                   /**< ISO 200*/
1484         MM_CAMCORDER_ISO_400,                   /**< ISO 400*/
1485         MM_CAMCORDER_ISO_800,                   /**< ISO 800*/
1486         MM_CAMCORDER_ISO_1600,                  /**< ISO 1600*/
1487         MM_CAMCORDER_ISO_3200,                  /**< ISO 3200*/
1488         MM_CAMCORDER_ISO_6400,                  /**< ISO 6400*/
1489         MM_CAMCORDER_ISO_12800,                 /**< ISO 12800*/
1490 };
1491
1492 /**
1493  * An enumeration for Automatic exposure.
1494  */
1495 enum MMCamcorderAutoExposureType {
1496         MM_CAMCORDER_AUTO_EXPOSURE_OFF = 0,     /**< AE off*/
1497         MM_CAMCORDER_AUTO_EXPOSURE_ALL,         /**< AE on, XXX mode*/
1498         MM_CAMCORDER_AUTO_EXPOSURE_CENTER_1,    /**< AE on, XXX mode*/
1499         MM_CAMCORDER_AUTO_EXPOSURE_CENTER_2,    /**< AE on, XXX mode*/
1500         MM_CAMCORDER_AUTO_EXPOSURE_CENTER_3,    /**< AE on, XXX mode*/
1501         MM_CAMCORDER_AUTO_EXPOSURE_SPOT_1,      /**< AE on, XXX mode*/
1502         MM_CAMCORDER_AUTO_EXPOSURE_SPOT_2,      /**< AE on, XXX mode*/
1503         MM_CAMCORDER_AUTO_EXPOSURE_CUSTOM_1,    /**< AE on, XXX mode*/
1504         MM_CAMCORDER_AUTO_EXPOSURE_CUSTOM_2,    /**< AE on, XXX mode*/
1505 };
1506
1507
1508 /**
1509  * An enumeration for WDR mode .
1510  */
1511 enum MMCamcorderWDRMode {
1512         MM_CAMCORDER_WDR_OFF = 0,               /**< WDR OFF*/
1513         MM_CAMCORDER_WDR_ON,                    /**< WDR ON*/
1514         MM_CAMCORDER_WDR_AUTO,                  /**< WDR AUTO*/
1515 };
1516
1517
1518 /**
1519  * An enumeration for HDR capture mode
1520  */
1521 enum MMCamcorderHDRMode {
1522         MM_CAMCORDER_HDR_OFF = 0,               /**< HDR OFF */
1523         MM_CAMCORDER_HDR_ON,                    /**< HDR ON and no original data - capture callback will be come once */
1524         MM_CAMCORDER_HDR_ON_AND_ORIGINAL,       /**< HDR ON and original data - capture callback will be come twice(1st:Original, 2nd:HDR) */
1525 };
1526
1527
1528 /**
1529  * An enumeration for Anti-handshake mode .
1530  */
1531 enum MMCamcorderAHSMode {
1532         MM_CAMCORDER_AHS_OFF = 0,               /**< AHS OFF*/
1533         MM_CAMCORDER_AHS_ON,                    /**< AHS ON*/
1534         MM_CAMCORDER_AHS_AUTO,                  /**< AHS AUTO*/
1535         MM_CAMCORDER_AHS_MOVIE,                 /**< AHS MOVIE*/
1536 };
1537
1538
1539 /**
1540  * An enumeration for Video stabilization mode
1541  */
1542 enum MMCamcorderVideoStabilizationMode {
1543         MM_CAMCORDER_VIDEO_STABILIZATION_OFF = 0,       /**< Video Stabilization OFF*/
1544         MM_CAMCORDER_VIDEO_STABILIZATION_ON,            /**< Video Stabilization ON*/
1545 };
1546
1547
1548 /**
1549  * Geometry method for camcorder display.
1550  */
1551 enum MMCamcorderGeometryMethod {
1552         MM_CAMCORDER_LETTER_BOX = 0,            /**< Letter box*/
1553         MM_CAMCORDER_ORIGIN_SIZE,               /**< Origin size*/
1554         MM_CAMCORDER_FULL,                      /**< full-screen*/
1555         MM_CAMCORDER_CROPPED_FULL,              /**< Cropped full-screen*/
1556         MM_CAMCORDER_ORIGIN_OR_LETTER,          /**< Origin size or Letter box*/
1557         MM_CAMCORDER_CUSTOM_ROI,                /**< Explicitely described destination ROI*/
1558 };
1559
1560
1561 /**
1562  * An enumeration for orientation values of tag .
1563  */
1564 enum MMCamcorderTagOrientation {
1565         MM_CAMCORDER_TAG_ORT_NONE = 0,          /**< No Orientation.*/
1566         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.*/
1567         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.*/
1568         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.*/
1569         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.*/
1570         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.*/
1571         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.*/
1572         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.*/
1573         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.*/
1574 };
1575
1576 /**
1577  * An enumeration for captured video orientation values of tag .
1578  */
1579 enum MMCamcorderTagVideoOrientation {
1580         MM_CAMCORDER_TAG_VIDEO_ORT_NONE = 0,    /**< No Orientation.*/
1581         MM_CAMCORDER_TAG_VIDEO_ORT_90,          /**< 90 degree */
1582         MM_CAMCORDER_TAG_VIDEO_ORT_180, /**< 180 degree */
1583         MM_CAMCORDER_TAG_VIDEO_ORT_270, /**< 270 degree */
1584 };
1585
1586
1587
1588 /**
1589  * An enumeration for Strobe mode.
1590  */
1591 enum MMCamcorderStrobeMode {
1592         MM_CAMCORDER_STROBE_MODE_OFF = 0,               /**< Always off */
1593         MM_CAMCORDER_STROBE_MODE_ON,                    /**< Always splashes */
1594         MM_CAMCORDER_STROBE_MODE_AUTO,                  /**< Depending on intensity of light, strobe starts to flash. */
1595         MM_CAMCORDER_STROBE_MODE_REDEYE_REDUCTION,      /**< Red eye reduction. Multiple flash before capturing. */
1596         MM_CAMCORDER_STROBE_MODE_SLOW_SYNC,             /**< Slow sync. A type of curtain synchronization. */
1597         MM_CAMCORDER_STROBE_MODE_FRONT_CURTAIN,         /**< Front curtain. A type of curtain synchronization. */
1598         MM_CAMCORDER_STROBE_MODE_REAR_CURTAIN,          /**< Rear curtain. A type of curtain synchronization. */
1599         MM_CAMCORDER_STROBE_MODE_PERMANENT,             /**< keep turned on until turning off */
1600 };
1601
1602
1603 /**
1604  * An enumeration for Strobe Control.
1605  */
1606 enum MMCamcorderStrobeControl {
1607         MM_CAMCORDER_STROBE_CONTROL_OFF = 0,    /**< turn off the flash light */
1608         MM_CAMCORDER_STROBE_CONTROL_ON,         /**< turn on the flash light */
1609         MM_CAMCORDER_STROBE_CONTROL_CHARGE,     /**< charge the flash light */
1610 };
1611
1612
1613 /**
1614  * An enumeration for Detection mode.
1615  */
1616 enum MMCamcorderDetectMode {
1617         MM_CAMCORDER_DETECT_MODE_OFF = 0,       /**< turn detection off */
1618         MM_CAMCORDER_DETECT_MODE_ON,            /**< turn detection on */
1619 };
1620
1621
1622 /**
1623  * An enumeration for recommended preview resolution.
1624  */
1625 enum MMCamcorderPreviewType {
1626         MM_CAMCORDER_PREVIEW_TYPE_NORMAL = 0,   /**< normal ratio like 4:3 */
1627         MM_CAMCORDER_PREVIEW_TYPE_WIDE,         /**< wide ratio like 16:9 */
1628         MM_CAMCORDER_PREVIEW_TYPE_SQUARE,       /**< square ratio like 1:1 */
1629 };
1630
1631
1632 /**********************************
1633 *          Attribute info         *
1634 **********************************/
1635 /**
1636  * An enumeration for attribute values types.
1637  */
1638 typedef enum {
1639         MM_CAM_ATTRS_TYPE_INVALID = -1,         /**< Type is invalid */
1640         MM_CAM_ATTRS_TYPE_INT,                  /**< Integer type attribute */
1641         MM_CAM_ATTRS_TYPE_DOUBLE,               /**< Double type attribute */
1642         MM_CAM_ATTRS_TYPE_STRING,               /**< UTF-8 String type attribute */
1643         MM_CAM_ATTRS_TYPE_DATA,                 /**< Pointer type attribute */
1644 } MMCamAttrsType;
1645
1646
1647 /**
1648  * An enumeration for attribute validation type.
1649  */
1650 typedef enum {
1651         MM_CAM_ATTRS_VALID_TYPE_INVALID = -1,   /**< Invalid validation type */
1652         MM_CAM_ATTRS_VALID_TYPE_NONE,           /**< Do not check validity */
1653         MM_CAM_ATTRS_VALID_TYPE_INT_ARRAY,      /**< validity checking type of integer array */
1654         MM_CAM_ATTRS_VALID_TYPE_INT_RANGE,      /**< validity checking type of integer range */
1655         MM_CAM_ATTRS_VALID_TYPE_DOUBLE_ARRAY,   /**< validity checking type of double array */
1656         MM_CAM_ATTRS_VALID_TYPE_DOUBLE_RANGE,   /**< validity checking type of double range */
1657 } MMCamAttrsValidType;
1658
1659
1660 /**
1661  * An enumeration for attribute access flag.
1662  */
1663 typedef enum {
1664         MM_CAM_ATTRS_FLAG_DISABLED = 0,         /**< None flag is set. This means the attribute is not allowed to use.  */
1665         MM_CAM_ATTRS_FLAG_READABLE = 1 << 0,    /**< Readable */
1666         MM_CAM_ATTRS_FLAG_WRITABLE = 1 << 1,    /**< Writable */
1667         MM_CAM_ATTRS_FLAG_MODIFIED = 1 << 2,    /**< Modified */
1668         MM_CAM_ATTRS_FLAG_RW = MM_CAM_ATTRS_FLAG_READABLE | MM_CAM_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
1669 } MMCamAttrsFlag;
1670
1671
1672 /**********************************
1673 *          Stream data            *
1674 **********************************/
1675 /**
1676  * An enumeration for stream data type.
1677  */
1678 typedef enum {
1679         MM_CAM_STREAM_DATA_YUV420 = 0,          /**< YUV420 Packed type - 1 plane */
1680         MM_CAM_STREAM_DATA_YUV422,              /**< YUV422 Packed type - 1 plane */
1681         MM_CAM_STREAM_DATA_YUV420SP,            /**< YUV420 SemiPlannar type - 2 planes */
1682         MM_CAM_STREAM_DATA_YUV420P,             /**< YUV420 Plannar type - 3 planes */
1683         MM_CAM_STREAM_DATA_YUV422P,             /**< YUV422 Plannar type - 3 planes */
1684         MM_CAM_STREAM_DATA_ENCODED              /**< Encoded data type - 1 plane */
1685 } MMCamStreamData;
1686
1687
1688 /*=======================================================================================
1689 | STRUCTURE DEFINITIONS                                                                 |
1690 ========================================================================================*/
1691 /**
1692  * A structure for attribute information
1693  */
1694 typedef struct {
1695         MMCamAttrsType type;
1696         MMCamAttrsFlag flag;
1697         MMCamAttrsValidType validity_type;
1698
1699         /**
1700          * A union that describes validity of the attribute.
1701          * Only when type is 'MM_CAM_ATTRS_TYPE_INT' or 'MM_CAM_ATTRS_TYPE_DOUBLE',
1702          * the attribute can have validity.
1703          */
1704         union {
1705                 /**
1706                  * Validity structure for integer array.
1707                  */
1708                  struct {
1709                         int *array;             /**< a pointer of array */
1710                         int count;              /**< size of array */
1711                         int def;                /**< default value. Real value not index of array */
1712                 } int_array;
1713
1714                 /**
1715                  * Validity structure for integer range.
1716                  */
1717                 struct {
1718                         int min;                /**< minimum range */
1719                         int max;                /**< maximum range */
1720                         int def;                /**< default value */
1721                 } int_range;
1722
1723                 /**
1724                  * Validity structure for double array.
1725                  */
1726                  struct {
1727                         double *array;          /**< a pointer of array */
1728                         int count;              /**< size of array */
1729                         double def;             /**< default value. Real value not index of array */
1730                 } double_array;
1731
1732                 /**
1733                  * Validity structure for double range.
1734                  */
1735                 struct {
1736                         double min;             /**< minimum range */
1737                         double max;             /**< maximum range */
1738                         double def;             /**< default value */
1739                 } double_range;
1740         };
1741 } MMCamAttrsInfo;
1742
1743
1744 /* General Structure */
1745 /**
1746  * Structure for capture data.
1747  */
1748 typedef struct {
1749         void *data;                     /**< pointer of captured image */
1750         unsigned int length;            /**< length of captured image (in byte)*/
1751         MMPixelFormatType format;       /**< image format */
1752         int width;                      /**< width of captured image */
1753         int height;                     /**< height of captured image */
1754         int encoder_type;               /**< encoder type */
1755 } MMCamcorderCaptureDataType;
1756
1757
1758 /**
1759  * Structure for video stream data.
1760  */
1761 #define BUFFER_MAX_PLANE_NUM 4
1762
1763 typedef struct {
1764         union {
1765                 struct {
1766                         unsigned char *yuv;
1767                         unsigned int length_yuv;
1768                 } yuv420, yuv422;
1769                 struct {
1770                         unsigned char *y;
1771                         unsigned int length_y;
1772                         unsigned char *uv;
1773                         unsigned int length_uv;
1774                 } yuv420sp;
1775                 struct {
1776                         unsigned char *y;
1777                         unsigned int length_y;
1778                         unsigned char *u;
1779                         unsigned int length_u;
1780                         unsigned char *v;
1781                         unsigned int length_v;
1782                 } yuv420p, yuv422p;
1783                 struct {
1784                         unsigned char *data;
1785                         unsigned int length_data;
1786                 } encoded;
1787         } data;                         /**< pointer of captured stream */
1788         MMCamStreamData data_type;      /**< data type */
1789         unsigned int length_total;      /**< total length of stream buffer (in byte)*/
1790         unsigned int num_planes;        /**< number of planes */
1791         MMPixelFormatType format;       /**< image format */
1792         int width;                      /**< width of video buffer */
1793         int height;                     /**< height of video buffer */
1794         unsigned int timestamp;         /**< timestamp of stream buffer (msec)*/
1795         void *bo[BUFFER_MAX_PLANE_NUM]; /**< TBM buffer object */
1796         void *internal_buffer;          /**< Internal buffer pointer */
1797         int stride[BUFFER_MAX_PLANE_NUM];    /**< Stride of each plane */
1798         int elevation[BUFFER_MAX_PLANE_NUM]; /**< Elevation of each plane */
1799 } MMCamcorderVideoStreamDataType;
1800
1801
1802 /**
1803  * Structure for audio stream data.
1804  */
1805 typedef struct {
1806         void *data;                             /**< pointer of captured stream */
1807         unsigned int length;                    /**< length of stream buffer (in byte)*/
1808         MMCamcorderAudioFormat format;          /**< audio format */
1809         int channel;                            /**< number of channel of the stream */
1810         unsigned int timestamp;                 /**< timestamp of stream buffer (msec)*/
1811         float volume_dB;                        /**< dB value of audio stream */
1812 } MMCamcorderAudioStreamDataType;
1813
1814
1815 /**
1816  * Structure for muxed stream data.
1817  */
1818 typedef struct {
1819         void *data;             /**< pointer of muxed stream */
1820         unsigned int length;    /**< length of stream buffer (in byte) */
1821         unsigned long long offset;  /**< current offset for data */
1822 } MMCamcorderMuxedStreamDataType;
1823
1824
1825 /**
1826   * Prerequisite information for mm_camcorder_create()
1827   * The information to set prior to create.
1828   */
1829 typedef struct {
1830         enum MMVideoDeviceType videodev_type;   /**< Video device type */
1831         /* For future use */
1832         int reserved[4];                        /**< reserved fields */
1833 } MMCamPreset;
1834
1835
1836 /**
1837  * Report structure of recording file
1838  */
1839 typedef struct {
1840         char *recording_filename;               /**< File name of stored recording file. Please free after using. */
1841 } MMCamRecordingReport; /**< report structure definition of recording file */
1842
1843
1844 /**
1845  * Face detect defailed information
1846  */
1847 typedef struct _MMCamFaceInfo {
1848         int id;                                 /**< id of each face */
1849         int score;                              /**< score of each face */
1850         MMRectType rect;                        /**< area of face */
1851 } MMCamFaceInfo;
1852
1853 /**
1854  * Face detect information
1855  */
1856 typedef struct _MMCamFaceDetectInfo {
1857         int num_of_faces;                       /**< number of detected faces */
1858         MMCamFaceInfo *face_info;               /**< face information, this should be freed after use it. */
1859 } MMCamFaceDetectInfo;
1860
1861
1862 /*=======================================================================================
1863 | TYPE DEFINITIONS                                                                      |
1864 ========================================================================================*/
1865 /**
1866  *      Function definition for video stream callback.
1867  *  Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1868  *  mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1869  *  Please don't hang this function long. It may cause low performance of preview or occur timeout error from video source.
1870  *  Also, you're not allowed to call mm_camcorder_stop() even in other context, while you're hanging this function.
1871  *  I recommend to you releasing this function ASAP.
1872  *
1873  *      @param[in]      stream                  Reference pointer to video stream data
1874  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1875  *      @return         This function returns true on success, or false on failure.
1876  *      @remarks                This function is issued in the context of gstreamer (video sink thread).
1877  */
1878 typedef gboolean (*mm_camcorder_video_stream_callback)(MMCamcorderVideoStreamDataType *stream, void *user_param);
1879
1880
1881 /**
1882  *      Function definition for audio stream callback.
1883  *  Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1884  *  mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1885  *  Please don't hang this function long. It may cause low performance of camcorder or occur timeout error from audio source.
1886  *  I recommend to you releasing this function ASAP.
1887  *
1888  *      @param[in]      stream                  Reference pointer to audio stream data
1889  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1890  *      @return         This function returns true on success, or false on failure.
1891  *      @remarks
1892  */
1893 typedef gboolean (*mm_camcorder_audio_stream_callback)(MMCamcorderAudioStreamDataType *stream, void *user_param);
1894
1895
1896 /**
1897  *      Function definition for muxed stream callback.
1898  *  Be careful! In this function, you can't call functions that change the state of camcorder such as mm_camcorder_stop(),
1899  *  mm_camcorder_unrealize(), mm_camcorder_record(), mm_camcorder_commit(), and mm_camcorder_cancel(), etc.
1900  *  Please don't hang this function long. It may cause low performance of camcorder or occur timeout error from encoding pipeline.
1901  *  I recommend to you releasing this function ASAP.
1902  *
1903  *      @param[in]      stream                  Reference pointer to muxed stream data
1904  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1905  *      @return         This function returns true on success, or false on failure.
1906  *      @remarks
1907  */
1908 typedef gboolean (*mm_camcorder_muxed_stream_callback)(MMCamcorderMuxedStreamDataType *stream, void *user_param);
1909
1910
1911 /**
1912  *      Function definition for video capture callback.
1913  *  Like '#mm_camcorder_video_stream_callback', you can't call mm_camcorder_stop() while you are hanging this function.
1914  *
1915  *      @param[in]      frame                   Reference pointer to captured data
1916  *      @param[in]      thumbnail               Reference pointer to thumbnail data
1917  *      @param[in]      user_param              User parameter which is received from user when callback function was set
1918  *      @return         This function returns true on success, or false on failure.
1919  *      @remarks                This function is issued in the context of gstreamer (video src thread).
1920  */
1921 typedef gboolean (*mm_camcorder_video_capture_callback)(MMCamcorderCaptureDataType *frame, MMCamcorderCaptureDataType *thumbnail, void *user_param);
1922
1923
1924 /*=======================================================================================
1925 | GLOBAL FUNCTION PROTOTYPES                                                            |
1926 ========================================================================================*/
1927 /**
1928  *    mm_camcorder_create:\n
1929  *  Create camcorder object. This is the function that an user who wants to use mm_camcorder calls first.
1930  *  This function creates handle structure and initialize mutex, attributes, gstreamer.
1931  *  When this function success, it will return  a handle of newly created object.
1932  *  A user have to put the handle when he calls every function of mm_camcorder. \n
1933  *  Second argument of this function is the field to decribe pre-setting information of mm_camcorder such as which camera device it will use.
1934  *  Normally, MM_VIDEO_DEVICE_CAMERA0 is for Main camera(or Mega camera, Back camera),
1935  *  and MM_VIDEO_DEVICE_CAMERA1 is for VGA camera (or Front camera). If you want audio recording,
1936  *  please set MM_VIDEO_DEVICE_NONE. (No camera device is needed.)
1937  *
1938  *      @param[out]     camcorder       A handle of camcorder.
1939  *      @param[in]      info            Information for camera device. Depending on this information,
1940  *                                      camcorder opens different camera devices.
1941  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1942  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
1943  *      @see            mm_camcorder_destroy
1944  *      @pre            None
1945  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_NULL
1946  *      @remarks        You can create multiple handles on a context at the same time. However,
1947  *                      camcorder cannot guarantee proper operation because of limitation of resources, such as
1948  *                      camera device, audio device, and display device.
1949  *      @par example
1950  *      @code
1951
1952 #include <mm_camcorder.h>
1953
1954 gboolean initialize_camcorder()
1955 {
1956         int err;
1957         MMCamPreset cam_info;
1958 #if 1
1959         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
1960 #else
1961         // when you want to record audio only, enable this.
1962         cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
1963 #endif
1964
1965         err = mm_camcorder_create(&hcam, &cam_info);
1966
1967         if (err != MM_ERROR_NONE) {
1968                 printf("Fail to call mm_camcorder_create = %x\n", err);
1969                 return FALSE;
1970         }
1971
1972         return TRUE;
1973 }
1974
1975  *      @endcode
1976  */
1977 int mm_camcorder_create(MMHandleType *camcorder, MMCamPreset *info);
1978
1979
1980 /**
1981  *    mm_camcorder_destroy:\n
1982  *  Destroy camcorder object. Release handle and all of the resources that were created in mm_camcorder_create().\n
1983  *  This is the finalizing function of mm_camcorder. If this function is not called or fails to call, the handle isn't released fully.
1984  *  This function releases attributes, mutexes, sessions, and handle itself. This function also removes all of remaining messages.
1985  *  So if your application should wait a certain message of mm_camcorder, please wait to call this function till getting the message.
1986  *
1987  *
1988  *      @param[in]      camcorder       A handle of camcorder.
1989  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
1990  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
1991  *      @see            mm_camcorder_create
1992  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_NULL
1993  *      @post           Because the handle is not valid, you can't check the state.
1994  *      @remarks        None
1995  *      @par example
1996  *      @code
1997
1998 #include <mm_camcorder.h>
1999
2000 gboolean destroy_camcorder()
2001 {
2002         int err;
2003
2004         //Destroy camcorder handle
2005         err = mm_camcorder_destroy(hcam);
2006         if (err < 0) {
2007                 printf("Fail to call mm_camcorder_destroy  = %x\n", err);
2008                 return FALSE;
2009         }
2010
2011         return TRUE;
2012 }
2013
2014  *      @endcode
2015  */
2016 int mm_camcorder_destroy(MMHandleType camcorder);
2017
2018
2019 /**
2020  *    mm_camcorder_realize:\n
2021  *  Allocate resources for camcorder and initialize it.
2022  *  This also creates streamer pipeline. So you have to set attributes that are pivotal to create
2023  *  the pipeline before calling this function. This function also takes a roll to manage confliction
2024  *  between different applications which use camcorder. For example, if you try to use camcorder when
2025  *  other application that is more important such as call application, this function will return
2026  *  'MM_ERROR_POLICY_BLOCKED'. On the contrary, if your application that uses camcorder starts to launch
2027  *  while another application that uses speaker and has lower priority, your application will kick
2028  *  another application.
2029  *
2030  *      @param[in]      camcorder       A handle of camcorder.
2031  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2032  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2033  *      @see            mm_camcorder_unrealize
2034  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_NULL
2035  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_READY
2036  *      @remarks        None
2037  *      @par example
2038  *      @code
2039
2040 #include <mm_camcorder.h>
2041
2042 //For image capturing
2043 gboolean initialize_image_capture()
2044 {
2045         int err;
2046         MMCamPreset cam_info;
2047         char *err_attr_name = NULL;
2048         void * hdisplay = NULL;
2049         int hsize = 0;
2050
2051         //Set video device as 'camera0' (main camera device)
2052         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2053
2054         err = mm_camcorder_create(&hcam, &cam_info);
2055
2056         if (err != MM_ERROR_NONE) {
2057                 printf("Fail to call mm_camcorder_create = %x\n", err);
2058                 return FALSE;
2059         }
2060
2061         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2062         mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2063
2064         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2065         hsize = sizeof(ad.xid);         //size of xid structure.
2066
2067         // camcorder attribute setting
2068         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2069                                           MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2070                                           MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2071                                           MMCAM_CAMERA_WIDTH, 640,
2072                                           MMCAM_CAMERA_HEIGHT, 480,
2073                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2074                                           MMCAM_CAMERA_FPS, 30,
2075                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2076                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,          hsize,
2077                                           MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
2078                                           MMCAM_CAPTURE_WIDTH, 640,
2079                                           MMCAM_CAPTURE_HEIGHT, 480,
2080                                           NULL);
2081
2082         if (err < 0) {
2083                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2084                 if (err_attr_name) {
2085                         free(err_attr_name);
2086                         err_attr_name = NULL;
2087                         return FALSE;
2088                 }
2089         }
2090
2091         err =  mm_camcorder_realize(hcam);
2092         if (err < 0) {
2093                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2094                 return FALSE;
2095         }
2096
2097         return TRUE;
2098 }
2099
2100 //For A/V capturing
2101 gboolean initialize_video_capture()
2102 {
2103         int err;
2104         MMCamPreset cam_info;
2105         char *err_attr_name = NULL;
2106         void * hdisplay = NULL;
2107         int hsize = 0;
2108
2109         //Set video device as 'camera0' (main camera device)
2110         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2111
2112         err = mm_camcorder_create(&hcam, &cam_info);
2113
2114         if (err != MM_ERROR_NONE) {
2115                 printf("Fail to call mm_camcorder_create = %x\n", err);
2116                 return FALSE;
2117         }
2118
2119         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, hcam);
2120
2121         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2122         hsize = sizeof(ad.xid);         //size of xid structure.
2123
2124         // camcorder attribute setting
2125         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2126                                           MMCAM_MODE, MM_CAMCORDER_MODE_VIDEO,
2127                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2128                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2129                                           MMCAM_VIDEO_ENCODER, MM_VIDEO_CODEC_MPEG4,
2130                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2131                                           MMCAM_CAMERA_WIDTH, 1280,
2132                                           MMCAM_CAMERA_HEIGHT, 720,
2133                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_NV12,
2134                                           MMCAM_CAMERA_FPS, 30,
2135                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2136                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2137                                           MMCAM_AUDIO_CHANNEL, 2,
2138                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2139                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,               hsize,
2140                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2141                                           NULL);
2142
2143         if (err < 0) {
2144                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2145                 if (err_attr_name) {
2146                         free(err_attr_name);
2147                         err_attr_name = NULL;
2148                         return FALSE;
2149                 }
2150         }
2151
2152         err =  mm_camcorder_realize(hcam);
2153         if (err < 0) {
2154                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2155                 return FALSE;
2156         }
2157
2158         return TRUE;
2159 }
2160
2161 //For audio(only) capturing
2162 gboolean initialize_audio_capture()
2163 {
2164         int err;
2165         MMCamPreset cam_info;
2166         char *err_attr_name = NULL;
2167         void * hdisplay = NULL;
2168         int hsize = 0;
2169
2170         //Set no video device, because audio recording doesn't need video input.
2171         cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
2172
2173         err = mm_camcorder_create(&hcam, &cam_info);
2174
2175         if (err != MM_ERROR_NONE) {
2176                 printf("Fail to call mm_camcorder_create = %x\n", err);
2177                 return FALSE;
2178         }
2179
2180         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2181
2182         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2183         hsize = sizeof(ad.xid);         //size of xid structure.
2184
2185         // camcorder attribute setting
2186         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2187                                           MMCAM_MODE, MM_CAMCORDER_MODE_AUDIO,
2188                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2189                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2190                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2191                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2192                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2193                                           MMCAM_AUDIO_CHANNEL, 2,
2194                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2195                                           MMCAM_TARGET_TIME_LIMIT, 360000,
2196                                           NULL);
2197
2198         if (err < 0) {
2199                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2200                 if (err_attr_name) {
2201                         free(err_attr_name);
2202                         err_attr_name = NULL;
2203                         return FALSE;
2204                 }
2205         }
2206
2207         err =  mm_camcorder_realize(hcam);
2208         if (err < 0) {
2209                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2210                 return FALSE;
2211         }
2212
2213         return TRUE;
2214 }
2215  *      @endcode
2216  */
2217 int mm_camcorder_realize(MMHandleType camcorder);
2218
2219
2220 /**
2221  *    mm_camcorder_unrealize:\n
2222  *  Uninitialize camcoder resources and free allocated memory.
2223  *  Most important resource that is released here is gstreamer pipeline of mm_camcorder.
2224  *  Because most of resources, such as camera device, video display device, and audio I/O device, are operating on the gstreamer pipeline,
2225  *  this function should be called to release its resources.
2226  *  Moreover, mm_camcorder is controlled by audio session manager. If an user doesn't call this function when he want to release mm_camcorder,
2227  *  other multimedia frameworks may face session problem. For more detail information, please refer mm_session module.
2228  *
2229  *      @param[in]      camcorder       A handle of camcorder.
2230  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2231  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2232  *      @see            mm_camcorder_realize
2233  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_READY
2234  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_NULL
2235  *      @remarks        None
2236  *      @par example
2237  *      @code
2238
2239 #include <mm_camcorder.h>
2240
2241 gboolean unrealize_camcorder()
2242 {
2243         int err;
2244
2245         //Release all resources of camcorder handle
2246         err =  mm_camcorder_unrealize(hcam);
2247         if (err < 0) {
2248                 printf("Fail to call mm_camcorder_unrealize  = %x\n", err);
2249                 return FALSE;
2250         }
2251
2252         return TRUE;
2253 }
2254
2255  *      @endcode
2256  */
2257 int mm_camcorder_unrealize(MMHandleType camcorder);
2258
2259
2260 /**
2261  *      mm_camcorder_start:\n
2262  *   Start previewing. (Image/Video mode)
2263  *  'mm_camcorder_video_stream_callback' is activated after calling this function.
2264  *
2265  *      @param[in]      camcorder       A handle of camcorder.
2266  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2267  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2268  *      @see            mm_camcorder_stop
2269  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_READY
2270  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2271  *      @remarks        None
2272  *      @par example
2273  *      @code
2274
2275 #include <mm_camcorder.h>
2276
2277 //For image capturing
2278 gboolean initialize_image_capture()
2279 {
2280         int err;
2281         MMCamPreset cam_info;
2282         char *err_attr_name = NULL;
2283         void * hdisplay = NULL;
2284         int hsize = 0;
2285
2286         //Set video device as 'camera0' (main camera device)
2287         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2288
2289         err = mm_camcorder_create(&hcam, &cam_info);
2290
2291         if (err != MM_ERROR_NONE) {
2292                         printf("Fail to call mm_camcorder_create = %x\n", err);
2293                         return FALSE;
2294         }
2295
2296         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2297         mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2298
2299         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2300         hsize = sizeof(ad.xid);         //size of xid structure.
2301
2302         // camcorder attribute setting
2303         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2304                                           MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
2305                                           MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
2306                                           MMCAM_CAMERA_WIDTH, 640,
2307                                           MMCAM_CAMERA_HEIGHT, 480,
2308                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
2309                                           MMCAM_CAMERA_FPS, 30,
2310                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2311                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,          hsize,
2312                                           MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
2313                                           MMCAM_CAPTURE_WIDTH, 640,
2314                                           MMCAM_CAPTURE_HEIGHT, 480,
2315                                           NULL);
2316
2317         if (err < 0) {
2318                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2319                 if (err_attr_name) {
2320                         free(err_attr_name);
2321                         err_attr_name = NULL;
2322                         return FALSE;
2323                 }
2324         }
2325
2326         err =  mm_camcorder_realize(hcam);
2327         if (err < 0) {
2328                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2329                 return FALSE;
2330         }
2331
2332         // start camcorder
2333         err = mm_camcorder_start(hcam);
2334         if (err < 0) {
2335                 printf("Fail to call mm_camcorder_start  = %x\n", err);
2336                 return FALSE;
2337         }
2338
2339         return TRUE;
2340 }
2341
2342 //For A/V capturing
2343 gboolean initialize_video_capture()
2344 {
2345         int err;
2346         MMCamPreset cam_info;
2347         char *err_attr_name = NULL;
2348         void * hdisplay = NULL;
2349         int hsize = 0;
2350
2351         //Set video device as 'camera0' (main camera device)
2352         cam_info.videodev_type = MM_VIDEO_DEVICE_CAMERA0;
2353
2354         err = mm_camcorder_create(&hcam, &cam_info);
2355
2356         if (err != MM_ERROR_NONE) {
2357                         printf("Fail to call mm_camcorder_create = %x\n", err);
2358                         return FALSE;
2359         }
2360
2361         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, hcam);
2362
2363         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2364         hsize = sizeof(ad.xid);         //size of xid structure.
2365
2366         // camcorder attribute setting
2367         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2368                                           MMCAM_MODE, MM_CAMCORDER_MODE_VIDEO,
2369                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2370                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2371                                           MMCAM_VIDEO_ENCODER, MM_VIDEO_CODEC_MPEG4,
2372                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2373                                           MMCAM_CAMERA_WIDTH, 1280,
2374                                           MMCAM_CAMERA_HEIGHT, 720,
2375                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_NV12,
2376                                           MMCAM_CAMERA_FPS, 30,
2377                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2378                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2379                                           MMCAM_AUDIO_CHANNEL, 2,
2380                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
2381                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,               hsize,
2382                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2383                                           NULL);
2384
2385         if (err < 0) {
2386                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2387                 if (err_attr_name) {
2388                         free(err_attr_name);
2389                         err_attr_name = NULL;
2390                         return FALSE;
2391                 }
2392         }
2393
2394         err =  mm_camcorder_realize(hcam);
2395         if (err < 0) {
2396                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2397                 return FALSE;
2398         }
2399
2400         // start camcorder
2401         err = mm_camcorder_start(hcam);
2402         if (err < 0) {
2403                 printf("Fail to call mm_camcorder_start  = %x\n", err);
2404                 return FALSE;
2405         }
2406
2407         return TRUE;
2408 }
2409
2410 //For audio(only) capturing
2411 gboolean initialize_audio_capture()
2412 {
2413         int err;
2414         MMCamPreset cam_info;
2415         char *err_attr_name = NULL;
2416         void * hdisplay = NULL;
2417         int hsize = 0;
2418
2419         //Set no video device, because audio recording doesn't need video input.
2420         cam_info.videodev_type = MM_VIDEO_DEVICE_NONE;
2421
2422         err = mm_camcorder_create(&hcam, &cam_info);
2423
2424         if (err != MM_ERROR_NONE) {
2425                 printf("Fail to call mm_camcorder_create = %x\n", err);
2426                 return FALSE;
2427         }
2428
2429         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2430
2431         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
2432         hsize = sizeof(ad.xid);         //size of xid structure.
2433
2434         // camcorder attribute setting
2435         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
2436                                           MMCAM_MODE, MM_CAMCORDER_MODE_AUDIO,
2437                                           MMCAM_AUDIO_DEVICE, MM_AUDIO_DEVICE_MIC,
2438                                           MMCAM_AUDIO_ENCODER, MM_AUDIO_CODEC_AAC,
2439                                           MMCAM_FILE_FORMAT, MM_FILE_FORMAT_3GP,
2440                                           MMCAM_AUDIO_SAMPLERATE, 44100,
2441                                           MMCAM_AUDIO_FORMAT, MM_CAMCORDER_AUDIO_FORMAT_PCM_S16_LE,
2442                                           MMCAM_AUDIO_CHANNEL, 2,
2443                                           MMCAM_TARGET_FILENAME, TARGET_FILENAME, strlen(TARGET_FILENAME),
2444                                           MMCAM_TARGET_TIME_LIMIT, 360000,
2445                                           NULL);
2446
2447         if (err < 0) {
2448                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
2449                 if (err_attr_name) {
2450                         free(err_attr_name);
2451                         err_attr_name = NULL;
2452                         return FALSE;
2453                 }
2454         }
2455
2456         err =  mm_camcorder_realize(hcam);
2457         if (err < 0) {
2458                 printf("Fail to call mm_camcorder_realize  = %x\n", err);
2459                 return FALSE;
2460         }
2461
2462         // start camcorder
2463         err = mm_camcorder_start(hcam);
2464         if (err < 0) {
2465                 printf("Fail to call mm_camcorder_start  = %x\n", err);
2466                 return FALSE;
2467         }
2468
2469         return TRUE;
2470 }
2471  *      @endcode
2472  */
2473 int mm_camcorder_start(MMHandleType camcorder);
2474
2475
2476 /**
2477  *    mm_camcorder_stop:\n
2478  *  Stop previewing. (Image/Video mode)
2479  *  This function will change the status of pipeline. If an application doesn't return callbacks
2480  *  of camcorder, this function can be locked. For example, if your application still
2481  *  holds '#mm_camcorder_video_capture_callback' or '#mm_camcorder_video_stream_callback',
2482  *  this function could be hung. So users have to return every callback before calling this function.
2483  *
2484  *      @param[in]      camcorder       A handle of camcorder.
2485  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2486  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2487  *      @see            mm_camcorder_start
2488  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2489  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_READY
2490  *      @remarks        None
2491  *      @par example
2492  *      @code
2493
2494 #include <mm_camcorder.h>
2495
2496 gboolean stop_camcorder()
2497 {
2498         int err;
2499
2500         //Stop preview
2501         err =  mm_camcorder_stop(hcam);
2502         if (err < 0) {
2503                 printf("Fail to call mm_camcorder_stop  = %x\n", err);
2504                 return FALSE;
2505         }
2506
2507         return TRUE;
2508 }
2509
2510  *      @endcode
2511  */
2512 int mm_camcorder_stop(MMHandleType camcorder);
2513
2514
2515 /**
2516  *    mm_camcorder_capture_start:\n
2517  *  Start capturing of still images. (Image mode only)
2518  *  Captured image will be delievered through 'mm_camcorder_video_capture_callback'.
2519  *  So basically, the operation is working asynchronously. \n
2520  *  When a user call this function, MSL will stop to retrieving preview from camera device.
2521  *  Then set capture resolution, pixel format, and encoding type to camera driver. After resuming,
2522  *  camera can get still image.  A user will be notified by
2523  *  'MM_MESSAGE_CAMCORDER_CAPTURED' message when capturing succeed. When a user sets
2524  *  multishot (by setting multiple number to MMCAM_CAPTURE_COUNT), the message
2525  *  will be called multiple time. You can get the number of image from 'code' of
2526  *  'MMMessageParamType'.
2527  *
2528  *      @param[in]      camcorder       A handle of camcorder.
2529  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2530  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2531  *      @see            mm_camcorder_capture_stop
2532  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2533  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_CAPTURING
2534  *      @remarks        To call this function, preview should be started successfully.\n
2535  *                      This function is a pair of mm_camcorder_capture_stop().
2536  *                      So user should call mm_camcorder_capture_stop() after getting captured image.
2537  *      @par example
2538  *      @code
2539
2540 #include <mm_camcorder.h>
2541
2542 gboolean capturing_picture()
2543 {
2544         int err;
2545
2546         err =  mm_camcorder_capture_start(hcam);
2547         if (err < 0)
2548         {
2549                 printf("Fail to call mm_camcorder_capture_start  = %x\n", err);
2550                 return FALSE;
2551         }
2552
2553         //mm_camcorder_capture_stop should be called after getting
2554         //MM_MESSAGE_CAMCORDER_CAPTURED message.
2555
2556         return TRUE;
2557 }
2558
2559
2560  *      @endcode
2561  */
2562 int mm_camcorder_capture_start(MMHandleType camcorder);
2563
2564
2565 /**
2566  *    mm_camcorder_capture_stop:\n
2567  *  Stop capturing of still images. (Image mode only)
2568  *  This function notifies the end of capturing and launch preview again.
2569  *  Just as mm_camcorder_capture_start(), this funciton stops still image stream and set preview information such as
2570  *  resolution, pixel format, and framerate to camera driver. Then it command to start preview.
2571  *  If you don't call this, preview will not be displayed even though capturing was finished.
2572  *
2573  *      @param[in]      camcorder       A handle of camcorder.
2574  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2575  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2576  *      @see            mm_camcorder_capture_start
2577  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_CAPTURING
2578  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2579  *      @remarks        To call this function, a user has to call mm_camcorder_capture_start() first.\n
2580  *                      This is not a function to stop multishot in the middle of operation. For that,
2581  *                      please use '#MMCAM_CAPTURE_BREAK_CONTINUOUS_SHOT' instead.
2582  *      @par example
2583  *      @code
2584
2585 #include <mm_camcorder.h>
2586
2587 gboolean capturing_picture_stop()
2588 {
2589         int err;
2590
2591         err =  mm_camcorder_capture_stop(hcam);
2592         if (err < 0) {
2593                 printf("Fail to call mm_camcorder_capture_stop  = %x\n", err);
2594                 return FALSE;
2595         }
2596
2597         //After calling upper function, preview will start.
2598
2599         return TRUE;
2600 }
2601
2602  *      @endcode
2603  */
2604 int mm_camcorder_capture_stop(MMHandleType camcorder);
2605
2606
2607 /**
2608  *    mm_camcorder_record:\n
2609  *  Start recording. (Audio/Video mode only)
2610  *  Camcorder starts to write a file when you call this function. You can specify the name of file
2611  *  using '#MMCAM_TARGET_FILENAME'. Beware, if you fail to call mm_camcorder_commit() or mm_camcorder_cancel(),
2612  *  the recorded file is still on the storage.
2613  *
2614  *      @param[in]      camcorder       A handle of camcorder.
2615  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2616  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2617  *      @see            mm_camcorder_pause
2618  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_PREPARE
2619  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_RECORDING
2620  *      @remarks        None
2621  *      @par example
2622  *      @code
2623
2624 #include <mm_camcorder.h>
2625
2626 gboolean record_and_cancel_video_file()
2627 {
2628         int err;
2629
2630         // Start recording
2631         err =  mm_camcorder_record(hcam);
2632         if (err < 0) {
2633                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2634                 return FALSE;
2635         }
2636
2637         return TRUE;
2638 }
2639
2640  *      @endcode
2641  */
2642 int mm_camcorder_record(MMHandleType camcorder);
2643
2644
2645 /**
2646  *    mm_camcorder_pause:\n
2647  *  Pause A/V recording or Audio recording. (Audio/Video mode only)
2648  *  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.
2649  *  If you call mm_camcorder_commit() while on pausing, the recorded file only has Audio and Video stream which were generated before pause().
2650  *
2651  *      @param[in]      camcorder       A handle of camcorder.
2652  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2653  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2654  *      @see            mm_camcorder_record
2655  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2656  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PAUSED
2657  *      @remarks        Even though this function is for pausing recording, small amount of buffers could be recorded after pause().
2658  *                      Because the buffers which are existed in the queue were created before pause(), the buffers should be recorded.
2659  *      @par example
2660  *      @code
2661
2662 #include <mm_camcorder.h>
2663
2664 gboolean record_pause_and_resume_recording()
2665 {
2666         int err;
2667
2668         // Start recording
2669         err =  mm_camcorder_record(hcam);
2670         if (err < 0) {
2671                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2672                 return FALSE;
2673         }
2674
2675         // Wait while recording...
2676
2677         // Pause
2678         err =  mm_camcorder_pause(hcam);
2679         if (err < 0) {
2680                 printf("Fail to call mm_camcorder_pause  = %x\n", err);
2681                 return FALSE;
2682         }
2683
2684         // Pausing...
2685
2686         // Resume
2687         err =  mm_camcorder_record(hcam);
2688         if (err < 0) {
2689                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2690                 return FALSE;
2691         }
2692
2693         return TRUE;
2694 }
2695
2696
2697  *      @endcode
2698  */
2699 int mm_camcorder_pause(MMHandleType camcorder);
2700
2701
2702 /**
2703  *    mm_camcorder_commit:\n
2704  *  Stop recording and save results.  (Audio/Video mode only)\n
2705  *  After starting recording, encoded data frame will be stored in the location specified in MMCAM_TARGET_FILENAME.
2706  *  Some encoder or muxer require a certain type of finalizing such as adding some information to header.
2707  *  This function takes that roll. So if you don't call this function after recording, the result file may not be playable.\n
2708  *  After committing successfully, camcorder resumes displaying preview (video recording case).
2709  *  Because this is the function for saving the recording result, the operation is available
2710  *  only when the mode of camcorder is MM_CAMCORDER_MODE_AUDIO or MM_CAMCORDER_MODE_VIDEO.
2711  *
2712  *      @param[in]      camcorder       A handle of camcorder.
2713  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2714  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2715  *      @see            mm_camcorder_cancel
2716  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2717  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2718  *      @remarks        This function can take a few second when recording time is long.
2719  *                      and if there are only quite few input buffer from video src or audio src,
2720  *                      committing could be failed.
2721  *      @par example
2722  *      @code
2723
2724 #include <mm_camcorder.h>
2725
2726 gboolean record_and_save_video_file()
2727 {
2728         int err;
2729
2730         // Start recording
2731         err =  mm_camcorder_record(hcam);
2732         if (err < 0) {
2733                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2734                 return FALSE;
2735         }
2736
2737         // Wait while recording for test...
2738         // In normal case, mm_camcorder_record() and mm_camcorder_commit() aren't called in the same function.
2739
2740         // Save file
2741         err =  mm_camcorder_commit(hcam);
2742         if (err < 0) {
2743                 printf("Fail to call mm_camcorder_commit  = %x\n", err);
2744                 return FALSE;
2745         }
2746
2747         return TRUE;
2748 }
2749
2750  *      @endcode
2751  */
2752 int mm_camcorder_commit(MMHandleType camcorder);
2753
2754
2755 /**
2756  *      mm_camcorder_cancel:\n
2757  *    Stop recording and discard the result. (Audio/Video mode only)
2758  *      When a user want to finish recording without saving the result file, this function can be used.
2759  *      Like mm_camcorder_commit(), this function also stops recording, release related resources(like codec) ,and goes back to preview status.
2760  *      However, instead of saving file, this function unlinks(delete) the result.\n
2761  *      Because this is the function for canceling recording, the operation is available
2762  *      only when mode is MM_CAMCORDER_MODE_AUDIO or MM_CAMCORDER_MODE_VIDEO.
2763  *
2764  *      @param[in]      camcorder       A handle of camcorder.
2765  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2766  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2767  *      @see            mm_camcorder_commit
2768  *      @pre            Previous state of mm-camcorder should be MM_CAMCORDER_STATE_RECORDING
2769  *      @post           Next state of mm-camcorder will be MM_CAMCORDER_STATE_PREPARE
2770  *      @remarks        None
2771  *      @par example
2772  *      @code
2773
2774 #include <mm_camcorder.h>
2775
2776 gboolean record_and_cancel_video_file()
2777 {
2778         int err;
2779
2780         // Start recording
2781         err =  mm_camcorder_record(hcam);
2782         if (err < 0) {
2783                 printf("Fail to call mm_camcorder_record  = %x\n", err);
2784                 return FALSE;
2785         }
2786
2787         // Wait while recording...
2788
2789         // Cancel recording
2790         err =  mm_camcorder_cancel(hcam);
2791         if (err < 0) {
2792                 printf("Fail to call mm_camcorder_cancel  = %x\n", err);
2793                 return FALSE;
2794         }
2795
2796         return TRUE;
2797 }
2798
2799  *      @endcode
2800  */
2801 int mm_camcorder_cancel(MMHandleType camcorder);
2802
2803
2804 /**
2805  *    mm_camcorder_set_message_callback:\n
2806  *  Set callback for receiving messages from camcorder. Through this callback function, camcorder
2807  *  sends various message including status changes, asynchronous error, capturing, and limitations.
2808  *  One thing you have to know is that message callback is working on the main loop of application.
2809  *  So until releasing the main loop, message callback will not be called.
2810  *
2811  *      @param[in]      camcorder       A handle of camcorder.
2812  *      @param[in]      callback        Function pointer of callback function. Please refer 'MMMessageCallback'.
2813  *      @param[in]      user_data       User parameter for passing to callback function.
2814  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2815  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2816  *      @see            MMMessageCallback
2817  *      @pre            None
2818  *      @post           None
2819  *      @remarks        registered 'callback' is called on main loop of the application. So until the main loop is released, 'callback' will not be called.
2820  *      @par example
2821  *      @code
2822
2823 #include <mm_camcorder.h>
2824
2825 gboolean setting_msg_callback()
2826 {
2827         //set callback
2828         mm_camcorder_set_message_callback(hcam,(MMMessageCallback)msg_callback, (void*)hcam);
2829
2830         return TRUE;
2831 }
2832
2833
2834  *      @endcode
2835  */
2836 int mm_camcorder_set_message_callback(MMHandleType camcorder, MMMessageCallback callback, void *user_data);
2837
2838
2839 /**
2840  *    mm_camcorder_set_video_stream_callback:\n
2841  *  Set callback for user defined video stream callback function.
2842  *  Users can retrieve video frame using registered callback.
2843  *  The callback function holds the same buffer that will be drawed on the display device.
2844  *  So if an user change the buffer, it will be displayed on the device.
2845  *
2846  *      @param[in]      camcorder       A handle of camcorder.
2847  *      @param[in]      callback        Function pointer of callback function.
2848  *      @param[in]      user_data       User parameter for passing to callback function.
2849  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2850  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2851  *      @see            mm_camcorder_video_stream_callback
2852  *      @pre            None
2853  *      @post           None
2854  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2855  *      @par example
2856  *      @code
2857
2858 #include <mm_camcorder.h>
2859
2860 gboolean setting_video_stream_callback()
2861 {
2862         //set callback
2863         mm_camcorder_set_video_stream_callback(hcam, (mm_camcorder_video_stream_callback)camcordertest_video_stream_cb, (void*)hcam);
2864
2865         return TRUE;
2866 }
2867  *      @endcode
2868  */
2869 int mm_camcorder_set_video_stream_callback(MMHandleType camcorder, mm_camcorder_video_stream_callback callback, void *user_data);
2870
2871
2872 /**
2873  *    mm_camcorder_set_video_capture_callback:\n
2874  *  Set callback for user defined video capture callback function.  (Image mode only)
2875  *  mm_camcorder deliever captured image through the callback.\n
2876  *  Normally, this function provides main captured image and thumnail image. But depending on the environment,
2877  *  thumnail would not be available. Information related with main captured image and thumnail image is also included
2878  *  in the argument of the callback function.
2879  *  For more detail information of callback, please refer 'mm_camcorder_video_capture_callback'.
2880  *
2881  *      @param[in]      camcorder       A handle of camcorder.
2882  *      @param[in]      callback        Function pointer of callback function.
2883  *      @param[in]      user_data       User parameter for passing to callback function.
2884  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2885  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2886  *      @see            mm_camcorder_video_capture_callback
2887  *      @pre            None
2888  *      @post           None
2889  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2890  *      @par example
2891  *      @code
2892
2893 #include <mm_camcorder.h>
2894
2895 gboolean setting_capture_callback()
2896 {
2897         //set callback
2898         mm_camcorder_set_video_capture_callback(hcam,(mm_camcorder_video_capture_callback)camcordertest_video_capture_cb, (void*)hcam);
2899
2900         return TRUE;
2901 }
2902  *      @endcode
2903  */
2904 int mm_camcorder_set_video_capture_callback(MMHandleType camcorder, mm_camcorder_video_capture_callback callback, void *user_data);
2905
2906
2907 /**
2908  *    mm_camcorder_set_audio_stream_callback:\n
2909  *  Set callback for user defined audio stream callback function.
2910  *  Users can retrieve audio data using registered callback.
2911  *  The callback function holds the same buffer that will be recorded.
2912  *  So if an user change the buffer, the result file will has the buffer.
2913  *
2914  *      @param[in]      camcorder       A handle of camcorder.
2915  *      @param[in]      callback        Function pointer of callback function.
2916  *      @param[in]      user_data       User parameter for passing to callback function.
2917  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2918  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2919  *      @see            mm_camcorder_audio_stream_callback
2920  *      @pre            None
2921  *      @post           None
2922  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2923  *      @par example
2924  *      @code
2925
2926 #include <mm_camcorder.h>
2927
2928 gboolean setting_audio_stream_callback()
2929 {
2930         //set callback
2931         mm_camcorder_set_audio_stream_callback(hcam, (mm_camcorder_audio_stream_callback)camcordertest_audio_stream_cb, (void*)hcam);
2932
2933         return TRUE;
2934 }
2935  *  @endcode
2936  */
2937 int mm_camcorder_set_audio_stream_callback(MMHandleType camcorder, mm_camcorder_audio_stream_callback callback, void *user_data);
2938
2939
2940 /**
2941  *    mm_camcorder_set_muxed_stream_callback:\n
2942  *  Set callback for user defined muxed stream callback function.
2943  *  Users can retrieve muxed data using registered callback.
2944  *  The callback function holds the same buffer that will be recorded.
2945  *
2946  *      @param[in]      camcorder       A handle of camcorder.
2947  *      @param[in]      callback        Function pointer of callback function.
2948  *      @param[in]      user_data       User parameter for passing to callback function.
2949  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2950  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2951  *      @see            mm_camcorder_muxed_stream_callback
2952  *      @pre            None
2953  *      @post           None
2954  *      @remarks        registered 'callback' is called on internal thread of camcorder. Regardless of the status of main loop, this function will be called.
2955  *      @par example
2956  *      @code
2957
2958 #include <mm_camcorder.h>
2959
2960 gboolean setting_muxed_stream_callback()
2961 {
2962         //set callback
2963         mm_camcorder_set_muxed_stream_callback(hcam, (mm_camcorder_muxed_stream_callback)camcordertest_muxed_stream_cb, (void*)hcam);
2964
2965         return TRUE;
2966 }
2967  *  @endcode
2968  */
2969 int mm_camcorder_set_muxed_stream_callback(MMHandleType camcorder, mm_camcorder_muxed_stream_callback callback, void *user_data);
2970
2971
2972 /**
2973  *    mm_camcorder_get_state:\n
2974  *  Get the current state of camcorder.
2975  *  mm_camcorder is working on the base of its state. An user should check the state of mm_camcorder before calling its functions.
2976  *  If the handle is avaiable, user can retrieve the value.
2977  *
2978  *      @param[in]      camcorder       A handle of camcorder.
2979  *      @param[out]     state           On return, it contains current state of camcorder.
2980  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
2981  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
2982  *      @see            MMCamcorderStateType
2983  *      @pre            None
2984  *      @post           None
2985  *      @remarks        None
2986  *      @par example
2987  *      @code
2988
2989 #include <mm_camcorder.h>
2990
2991 gboolean get_state_of_camcorder()
2992 {
2993         MMCamcorderStateType state;
2994
2995         //Get state of camcorder
2996         mm_camcorder_get_state(hcam, &state);
2997         printf("Current status is %d\n", state);
2998
2999         return TRUE;
3000 }
3001
3002  *      @endcode
3003  */
3004 int mm_camcorder_get_state(MMHandleType camcorder, MMCamcorderStateType *state);
3005 int mm_camcorder_get_state2(MMHandleType camcorder, MMCamcorderStateType *state, MMCamcorderStateType *old_state);
3006
3007
3008 /**
3009  *    mm_camcorder_get_attributes:\n
3010  *  Get attributes of camcorder with given attribute names. This function can get multiple attributes
3011  *  simultaneously. If one of attribute fails, this function will stop at the point.
3012  *  'err_attr_name' let you know the name of the attribute.
3013  *
3014  *      @param[in]      camcorder       Specifies the camcorder  handle.
3015  *      @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
3016  *                                      Free this variable after using.
3017  *      @param[in]      attribute_name  attribute name that user want to get.
3018  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3019  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3020  *      @pre            None
3021  *      @post           None
3022  *      @remarks        You can retrieve multiple attributes at the same time.  @n
3023  *                      This function must finish with 'NULL' argument.  @n
3024  *                      ex) mm_camcorder_get_attributes(....... , NULL);
3025  *      @see            mm_camcorder_set_attributes
3026  *      @par example
3027  *      @code
3028
3029 #include <mm_camcorder.h>
3030
3031 gboolean getting_attribute()
3032 {
3033         int err;
3034         MMCamPreset cam_info;
3035         char *err_attr_name = NULL;
3036         void * hdisplay = NULL;
3037         int hsize = 0;
3038
3039         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
3040         hsize = sizeof(ad.xid);         //size of xid structure.
3041
3042         // camcorder attribute setting
3043         err = mm_camcorder_get_attributes(hcamcorder, NULL,     //The second is the argument for debugging. But you can skip this.
3044                                           MMCAM_MODE,  &mode,   //You have to input a pointer instead of variable itself.
3045                                           NULL);                //mm_camcorder_set_attributes() should be finished with a NULL argument.
3046
3047         return TRUE;
3048 }
3049
3050  *      @endcode
3051  */
3052 int mm_camcorder_get_attributes(MMHandleType camcorder,  char **err_attr_name, const char *attribute_name, ...) G_GNUC_NULL_TERMINATED;
3053
3054
3055
3056 /**
3057  *    mm_camcorder_set_attributes:\n
3058  *  Set attributes of camcorder with given attribute names. This function can set multiple attributes
3059  *  simultaneously. If one of attribute fails, this function will stop at the point.
3060  *  'err_attr_name' let you know the name of the attribute.
3061  *
3062  *      @param[in]      camcorder       Specifies the camcorder  handle.
3063  *      @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
3064  *                                      Free this variable after using.
3065  *      @param[in]      attribute_name  attribute name that user want to set.
3066  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3067  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3068  *      @pre            None
3069  *      @post           None
3070  *      @remarks        You can put multiple attributes to camcorder at the same time.  @n
3071  *                      This function must finish with 'NULL' argument.  @n
3072  *                      ex) mm_camcorder_set_attributes(....... , NULL);
3073  *      @see            mm_camcorder_get_attributes
3074  *      @par example
3075  *      @code
3076
3077 #include <mm_camcorder.h>
3078
3079 gboolean setting_attribute()
3080 {
3081         int err;
3082         MMCamPreset cam_info;
3083         char *err_attr_name = NULL;
3084         void * hdisplay = NULL;
3085         int hsize = 0;
3086
3087         hdisplay = &ad.xid;             //xid of xwindow. This value can be different depending on your environment.
3088         hsize = sizeof(ad.xid);         //size of xid structure.
3089
3090         // camcorder attribute setting
3091         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,           //The second is the argument for debugging.
3092                                           MMCAM_MODE, MM_CAMCORDER_MODE_IMAGE,
3093                                           MMCAM_IMAGE_ENCODER, MM_IMAGE_CODEC_JPEG,
3094                                           MMCAM_CAMERA_WIDTH, 640,
3095                                           MMCAM_CAMERA_HEIGHT, 480,
3096                                           MMCAM_CAMERA_FORMAT, MM_PIXEL_FORMAT_YUYV,
3097                                           MMCAM_CAMERA_FPS, 30,
3098                                           MMCAM_DISPLAY_ROTATION, MM_DISPLAY_ROTATION_270,
3099                                           MMCAM_DISPLAY_HANDLE, (void*) hdisplay,          hsize,               //Beware some types require 'size' value, too. (STRING, DATA type attributes)
3100                                           MMCAM_CAPTURE_FORMAT, MM_PIXEL_FORMAT_ENCODED,
3101                                           MMCAM_CAPTURE_WIDTH, 640,
3102                                           MMCAM_CAPTURE_HEIGHT, 480,
3103                                           NULL);                //mm_camcorder_set_attributes() should be finished with a NULL argument.
3104
3105         if (err < 0) {
3106                 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.
3107                 if (err_attr_name) {
3108                         free(err_attr_name);                    //Please free 'err_attr_name', after using the argument.
3109                         err_attr_name = NULL;
3110                         return FALSE;
3111                 }
3112         }
3113
3114         return TRUE;
3115 }
3116  *      @endcode
3117  */
3118 int mm_camcorder_set_attributes(MMHandleType camcorder,  char **err_attr_name, const char *attribute_name, ...) G_GNUC_NULL_TERMINATED;
3119
3120
3121 /**
3122  *    mm_camcorder_get_attribute_info:\n
3123  *  Get detail information of the attribute. To manager attributes, an user may want to know the exact character of the attribute,
3124  *  such as type, flag, and validity. This is the function to provide such information.
3125  *  Depending on the 'validity_type', validity union would be different. To know about the type of union, please refer 'MMCamAttrsInfo'.
3126  *
3127  *      @param[in]      camcorder       Specifies the camcorder  handle.
3128  *      @param[in]      attribute_name  attribute name that user want to get information.
3129  *      @param[out]     info            a structure that holds information related with the attribute.
3130  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3131  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3132  *      @pre            None
3133  *      @post           None
3134  *      @remarks        If the function succeeds, 'info' holds detail information about the attribute, such as type,
3135  *                      flag, validity_type, validity_values, and default values.
3136  *      @see            mm_camcorder_get_attributes, mm_camcorder_set_attributes
3137  *      @par example
3138  *      @code
3139
3140 #include <mm_camcorder.h>
3141
3142 gboolean getting_info_from_attribute()
3143 {
3144         MMCamAttrsInfo info;
3145         int err;
3146
3147         err = mm_camcorder_get_attribute_info(handle, MMCAM_CAPTURE_HEIGHT, &info);
3148         if (err < 0) {
3149                 printf("Fail to call mm_camcorder_get_attribute_info()");
3150                 return FALSE;
3151         }
3152
3153         //Now 'info' has many information about 'MMCAM_CAPTURE_HEIGHT'
3154
3155         return TRUE;
3156 }
3157  *      @endcode
3158  */
3159 int mm_camcorder_get_attribute_info(MMHandleType camcorder, const char *attribute_name, MMCamAttrsInfo *info);
3160
3161
3162 /**
3163  *    mm_camcorder_get_fps_list_by_resolution:\n
3164  *  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,
3165  *  Gives attribute information structure, from the configure data.
3166  *  Depending on the 'validity_type', validity union would be different. To know about the type of union, please refer 'MMCamAttrsInfo'.
3167  *
3168  *      @param[in]      camcorder       Specifies the camcorder  handle.
3169  *      @param[in]      width   width value of the current Preview resolution.
3170  *      @param[in]      height  height value of the current Preview resolution.
3171  *      @param[out]     fps_info                a structure that holds information related with the attribute.
3172  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3173  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3174  *      @pre            None
3175  *      @post           None
3176  *      @remarks        If the function succeeds, 'info' holds detail information about the attribute, such as type,
3177  *                      flag, validity_type, validity_values, and default values.
3178  *      @see            mm_camcorder_get_attributes, mm_camcorder_set_attributes
3179  *      @par example
3180  *      @code
3181
3182 #include <mm_camcorder.h>
3183
3184 gboolean getting_info_from_attribute()
3185 {
3186         MMCamAttrsInfo info;
3187         int err;
3188
3189         err = mm_camcorder_get_fps_list_by_resolution(handle, width, height, &info);
3190         if (err < 0) {
3191                 printf("Fail to call mm_camcorder_get_attribute_info()");
3192                 return FALSE;
3193         }
3194
3195         //Now 'info' has many information about 'MMCAM_CAPTURE_HEIGHT'
3196
3197         return TRUE;
3198 }
3199  *      @endcode
3200  */
3201 int mm_camcorder_get_fps_list_by_resolution(MMHandleType camcorder, int width, int height, MMCamAttrsInfo *fps_info);
3202
3203
3204 /**
3205  *    mm_camcorder_init_focusing:\n
3206  *  Initialize focusing. \n
3207  *  This function stops focusing action and adjust the camera lens to initial position.
3208  *  Some camera applciation requires to initialize its lens position after releasing half shutter. In that case,
3209  *  this should be a good choice. Comparing with mm_camcorder_stop_focusing, this function not only stops focusing,
3210  *  but also initialize the lens. Preview image might be out-focused after calling this function.
3211  *      @param[in]      camcorder  A handle of camcorder.
3212  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3213  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3214  *      @pre            The status of camcorder should be MM_CAMCORDER_STATE_PREPARE, MM_CAMCORDER_STATE_RECORDING, or MM_CAMCORDER_STATE_PAUSED.
3215  *      @post           None
3216  *      @remarks        None
3217  *      @see            mm_camcorder_start_focusing, mm_camcorder_stop_focusing
3218  *      @par example
3219  *      @code
3220
3221 #include <mm_camcorder.h>
3222
3223 gboolean start_autofocus()
3224 {
3225         int err;
3226         char * err_attr_name = NULL;
3227
3228         // Set focus mode to 'AUTO' and scan range to 'AF Normal'.
3229         //You just need to set these values one time. After that, just call mm_camcorder_start_focusing().
3230         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
3231                                           MMCAM_CAMERA_FOCUS_MODE, MM_CAMCORDER_FOCUS_MODE_AUTO,
3232                                           MMCAM_CAMERA_AF_SCAN_RANGE, MM_CAMCORDER_AUTO_FOCUS_NORMAL,
3233                                           NULL);
3234
3235         if (err < 0) {
3236                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
3237                 if (err_attr_name) {
3238                         free(err_attr_name);
3239                         err_attr_name = NULL;
3240                         return FALSE;
3241                 }
3242         }
3243
3244         mm_camcorder_init_focusing(hcam);
3245         mm_camcorder_start_focusing(hcam);
3246         printf("Waiting for adjusting focus\n");
3247
3248         // Waiting for 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED'
3249
3250         return TRUE;
3251 }
3252
3253  *      @endcode
3254  */
3255 int mm_camcorder_init_focusing(MMHandleType camcorder);
3256
3257
3258 /**
3259  *    mm_camcorder_start_focusing:\n
3260  *  Start focusing. \n
3261  *  This function command to start focusing opeartion. Because focusing operation depends on mechanic or electric module,
3262  *  it may take small amount of time. (For ex, 500ms ~ 3sec). \n
3263  *  This function works asynchronously. When an user call this function,  it will return immediately.
3264  *  However, focusing operation will continue until it gets results.
3265  *  After finishing operation, you can get 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' message.
3266  *  'param.code' of the message structure describes the fucusing was success or not.
3267  *
3268  *      @param[in]      camcorder       A handle of camcorder.
3269  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3270  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3271  *      @pre            None
3272  *      @post           None
3273  *      @remarks        None
3274  *      @see            mm_camcorder_init_focusing, mm_camcorder_stop_focusing
3275  *      @par example
3276  *      @code
3277
3278 #include <mm_camcorder.h>
3279
3280 gboolean start_autofocus()
3281 {
3282         int err;
3283         char * err_attr_name = NULL;
3284
3285         // Set focus mode to 'AUTO' and scan range to 'AF Normal'.
3286         //You just need to set these values one time. After that, just call mm_camcorder_start_focusing().
3287         err = mm_camcorder_set_attributes((MMHandleType)hcam, &err_attr_name,
3288                                           MMCAM_CAMERA_FOCUS_MODE, MM_CAMCORDER_FOCUS_MODE_AUTO,
3289                                           MMCAM_CAMERA_AF_SCAN_RANGE, MM_CAMCORDER_AUTO_FOCUS_NORMAL,
3290                                           NULL);
3291
3292         if (err < 0) {
3293                 printf("Set attrs fail. (%s:%x)\n", err_attr_name, err);
3294                 if (err_attr_name) {
3295                         free(err_attr_name);
3296                         err_attr_name = NULL;
3297                         return FALSE;
3298                 }
3299         }
3300
3301         mm_camcorder_init_focusing(hcam);
3302         mm_camcorder_start_focusing(hcam);
3303         printf("Waiting for adjusting focus\n");
3304
3305         // Waiting for 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED'
3306
3307         return TRUE;
3308 }
3309
3310  *      @endcode
3311  */
3312 int mm_camcorder_start_focusing(MMHandleType camcorder);
3313
3314
3315 /**
3316  *    mm_camcorder_stop_focusing:\n
3317  *  Stop focusing. This function halts focusing operation.\n
3318  *  This is the function to stop focusing in the middle of the operation. So if focusing is already finished or not started yet,
3319  *  this function will do nothing.
3320  *
3321  *      @param[in]      camcorder       A handle of camcorder.
3322  *      @return         This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
3323  *                      Please refer 'mm_error.h' to know the exact meaning of the error.
3324  *      @see            mm_camcorder_init_focusing, mm_camcorder_start_focusing
3325  *      @pre            mm_camcorder_start_focusing() should be called before calling this function.
3326  *      @post           None
3327  *      @remarks        None
3328  *      @par example
3329  *      @code
3330
3331 #include <mm_camcorder.h>
3332
3333 gboolean stop_autofocus()
3334 {
3335         int err;
3336
3337         //Stop focusing
3338         mm_camcorder_stop_focusing(hcam);
3339
3340         return TRUE;
3341 }
3342
3343  *      @endcode
3344  */
3345 int mm_camcorder_stop_focusing(MMHandleType camcorder);
3346
3347 /* emit signal */
3348 void mm_camcorder_emit_signal(MMHandleType camcorder, const char *object_name,
3349         const char *interface_name, const char *signal_name, int value);
3350
3351 /* check compatability between codec and file format */
3352 int mm_camcorder_check_codec_fileformat_compatibility(const char *codec_type, int codec, int file_format);
3353
3354 /* external storage state management */
3355 int mm_camcorder_manage_external_storage_state(MMHandleType camcorder, int storage_state);
3356
3357 /**
3358         @}
3359  */
3360
3361 #ifdef __cplusplus
3362 }
3363 #endif
3364
3365 #endif /* __MM_CAMCORDER_H__ */