C API for video I/O

Overview

// typedefs

typedef struct CvCapture CvCapture;
typedef struct CvVideoWriter CvVideoWriter;

// enums

enum
{
    @106::CV_CAP_ANY           =0,
    @106::CV_CAP_MIL           =100,
    @106::CV_CAP_VFW           =200,
    @106::CV_CAP_V4L           =200,
    @106::CV_CAP_V4L2          =200,
    @106::CV_CAP_FIREWARE      =300,
    @106::CV_CAP_FIREWIRE      =300,
    @106::CV_CAP_IEEE1394      =300,
    @106::CV_CAP_DC1394        =300,
    @106::CV_CAP_CMU1394       =300,
    @106::CV_CAP_STEREO        =400,
    @106::CV_CAP_TYZX          =400,
    @106::CV_TYZX_LEFT         =400,
    @106::CV_TYZX_RIGHT        =401,
    @106::CV_TYZX_COLOR        =402,
    @106::CV_TYZX_Z            =403,
    @106::CV_CAP_QT            =500,
    @106::CV_CAP_UNICAP        =600,
    @106::CV_CAP_DSHOW         =700,
    @106::CV_CAP_MSMF          =1400,
    @106::CV_CAP_PVAPI         =800,
    @106::CV_CAP_OPENNI        =900,
    @106::CV_CAP_OPENNI_ASUS   =910,
    @106::CV_CAP_ANDROID       =1000,
    @106::CV_CAP_ANDROID_BACK  =CV_CAP_ANDROID+99,
    @106::CV_CAP_ANDROID_FRONT =CV_CAP_ANDROID+98,
    @106::CV_CAP_XIAPI         =1100,
    @106::CV_CAP_AVFOUNDATION  = 1200,
    @106::CV_CAP_GIGANETIX     = 1300,
    @106::CV_CAP_INTELPERC     = 1500,
    @106::CV_CAP_OPENNI2       = 1600,
    @106::CV_CAP_GPHOTO2       = 1700,
    @106::CV_CAP_GSTREAMER     = 1800,
    @106::CV_CAP_FFMPEG        = 1900,
    @106::CV_CAP_IMAGES        = 2000,
    @106::CV_CAP_ARAVIS        = 2100,
    @106::CV_CAP_OCV_MJPEG     = 2200,
};

enum
{
    @107::CV_CAP_PROP_DC1394_OFF                           = -4,
    @107::CV_CAP_PROP_DC1394_MODE_MANUAL                   = -3,
    @107::CV_CAP_PROP_DC1394_MODE_AUTO                     = -2,
    @107::CV_CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO            = -1,
    @107::CV_CAP_PROP_POS_MSEC                             =0,
    @107::CV_CAP_PROP_POS_FRAMES                           =1,
    @107::CV_CAP_PROP_POS_AVI_RATIO                        =2,
    @107::CV_CAP_PROP_FRAME_WIDTH                          =3,
    @107::CV_CAP_PROP_FRAME_HEIGHT                         =4,
    @107::CV_CAP_PROP_FPS                                  =5,
    @107::CV_CAP_PROP_FOURCC                               =6,
    @107::CV_CAP_PROP_FRAME_COUNT                          =7,
    @107::CV_CAP_PROP_FORMAT                               =8,
    @107::CV_CAP_PROP_MODE                                 =9,
    @107::CV_CAP_PROP_BRIGHTNESS                           =10,
    @107::CV_CAP_PROP_CONTRAST                             =11,
    @107::CV_CAP_PROP_SATURATION                           =12,
    @107::CV_CAP_PROP_HUE                                  =13,
    @107::CV_CAP_PROP_GAIN                                 =14,
    @107::CV_CAP_PROP_EXPOSURE                             =15,
    @107::CV_CAP_PROP_CONVERT_RGB                          =16,
    @107::CV_CAP_PROP_WHITE_BALANCE_BLUE_U                 =17,
    @107::CV_CAP_PROP_RECTIFICATION                        =18,
    @107::CV_CAP_PROP_MONOCHROME                           =19,
    @107::CV_CAP_PROP_SHARPNESS                            =20,
    @107::CV_CAP_PROP_AUTO_EXPOSURE                        =21,
    @107::CV_CAP_PROP_GAMMA                                =22,
    @107::CV_CAP_PROP_TEMPERATURE                          =23,
    @107::CV_CAP_PROP_TRIGGER                              =24,
    @107::CV_CAP_PROP_TRIGGER_DELAY                        =25,
    @107::CV_CAP_PROP_WHITE_BALANCE_RED_V                  =26,
    @107::CV_CAP_PROP_ZOOM                                 =27,
    @107::CV_CAP_PROP_FOCUS                                =28,
    @107::CV_CAP_PROP_GUID                                 =29,
    @107::CV_CAP_PROP_ISO_SPEED                            =30,
    @107::CV_CAP_PROP_MAX_DC1394                           =31,
    @107::CV_CAP_PROP_BACKLIGHT                            =32,
    @107::CV_CAP_PROP_PAN                                  =33,
    @107::CV_CAP_PROP_TILT                                 =34,
    @107::CV_CAP_PROP_ROLL                                 =35,
    @107::CV_CAP_PROP_IRIS                                 =36,
    @107::CV_CAP_PROP_SETTINGS                             =37,
    @107::CV_CAP_PROP_BUFFERSIZE                           =38,
    @107::CV_CAP_PROP_AUTOFOCUS                            =39,
    @107::CV_CAP_PROP_SAR_NUM                              =40,
    @107::CV_CAP_PROP_SAR_DEN                              =41,
    @107::CV_CAP_PROP_AUTOGRAB                             =1024,
    @107::CV_CAP_PROP_SUPPORTED_PREVIEW_SIZES_STRING       =1025,
    @107::CV_CAP_PROP_PREVIEW_FORMAT                       =1026,
    @107::CV_CAP_OPENNI_DEPTH_GENERATOR                    = 1 <<31,
    @107::CV_CAP_OPENNI_IMAGE_GENERATOR                    = 1 <<30,
    @107::CV_CAP_OPENNI_IR_GENERATOR                       = 1 <<29,
    @107::CV_CAP_OPENNI_GENERATORS_MASK                    = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_OPENNI_IR_GENERATOR,
    @107::CV_CAP_PROP_OPENNI_OUTPUT_MODE                   = 100,
    @107::CV_CAP_PROP_OPENNI_FRAME_MAX_DEPTH               = 101,
    @107::CV_CAP_PROP_OPENNI_BASELINE                      = 102,
    @107::CV_CAP_PROP_OPENNI_FOCAL_LENGTH                  = 103,
    @107::CV_CAP_PROP_OPENNI_REGISTRATION                  = 104,
    @107::CV_CAP_PROP_OPENNI_REGISTRATION_ON               = CV_CAP_PROP_OPENNI_REGISTRATION,
    @107::CV_CAP_PROP_OPENNI_APPROX_FRAME_SYNC             = 105,
    @107::CV_CAP_PROP_OPENNI_MAX_BUFFER_SIZE               = 106,
    @107::CV_CAP_PROP_OPENNI_CIRCLE_BUFFER                 = 107,
    @107::CV_CAP_PROP_OPENNI_MAX_TIME_DURATION             = 108,
    @107::CV_CAP_PROP_OPENNI_GENERATOR_PRESENT             = 109,
    @107::CV_CAP_PROP_OPENNI2_SYNC                         = 110,
    @107::CV_CAP_PROP_OPENNI2_MIRROR                       = 111,
    @107::CV_CAP_OPENNI_IMAGE_GENERATOR_PRESENT            = CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
    @107::CV_CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE        = CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_PROP_OPENNI_OUTPUT_MODE,
    @107::CV_CAP_OPENNI_DEPTH_GENERATOR_PRESENT            = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
    @107::CV_CAP_OPENNI_DEPTH_GENERATOR_BASELINE           = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_BASELINE,
    @107::CV_CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH       = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_FOCAL_LENGTH,
    @107::CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION       = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_REGISTRATION,
    @107::CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON    = CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION,
    @107::CV_CAP_OPENNI_IR_GENERATOR_PRESENT               = CV_CAP_OPENNI_IR_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
    @107::CV_CAP_GSTREAMER_QUEUE_LENGTH                    = 200,
    @107::CV_CAP_PROP_PVAPI_MULTICASTIP                    = 300,
    @107::CV_CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE          = 301,
    @107::CV_CAP_PROP_PVAPI_DECIMATIONHORIZONTAL           = 302,
    @107::CV_CAP_PROP_PVAPI_DECIMATIONVERTICAL             = 303,
    @107::CV_CAP_PROP_PVAPI_BINNINGX                       = 304,
    @107::CV_CAP_PROP_PVAPI_BINNINGY                       = 305,
    @107::CV_CAP_PROP_PVAPI_PIXELFORMAT                    = 306,
    @107::CV_CAP_PROP_XI_DOWNSAMPLING                      = 400,
    @107::CV_CAP_PROP_XI_DATA_FORMAT                       = 401,
    @107::CV_CAP_PROP_XI_OFFSET_X                          = 402,
    @107::CV_CAP_PROP_XI_OFFSET_Y                          = 403,
    @107::CV_CAP_PROP_XI_TRG_SOURCE                        = 404,
    @107::CV_CAP_PROP_XI_TRG_SOFTWARE                      = 405,
    @107::CV_CAP_PROP_XI_GPI_SELECTOR                      = 406,
    @107::CV_CAP_PROP_XI_GPI_MODE                          = 407,
    @107::CV_CAP_PROP_XI_GPI_LEVEL                         = 408,
    @107::CV_CAP_PROP_XI_GPO_SELECTOR                      = 409,
    @107::CV_CAP_PROP_XI_GPO_MODE                          = 410,
    @107::CV_CAP_PROP_XI_LED_SELECTOR                      = 411,
    @107::CV_CAP_PROP_XI_LED_MODE                          = 412,
    @107::CV_CAP_PROP_XI_MANUAL_WB                         = 413,
    @107::CV_CAP_PROP_XI_AUTO_WB                           = 414,
    @107::CV_CAP_PROP_XI_AEAG                              = 415,
    @107::CV_CAP_PROP_XI_EXP_PRIORITY                      = 416,
    @107::CV_CAP_PROP_XI_AE_MAX_LIMIT                      = 417,
    @107::CV_CAP_PROP_XI_AG_MAX_LIMIT                      = 418,
    @107::CV_CAP_PROP_XI_AEAG_LEVEL                        = 419,
    @107::CV_CAP_PROP_XI_TIMEOUT                           = 420,
    @107::CV_CAP_PROP_XI_EXPOSURE                          = 421,
    @107::CV_CAP_PROP_XI_EXPOSURE_BURST_COUNT              = 422,
    @107::CV_CAP_PROP_XI_GAIN_SELECTOR                     = 423,
    @107::CV_CAP_PROP_XI_GAIN                              = 424,
    @107::CV_CAP_PROP_XI_DOWNSAMPLING_TYPE                 = 426,
    @107::CV_CAP_PROP_XI_BINNING_SELECTOR                  = 427,
    @107::CV_CAP_PROP_XI_BINNING_VERTICAL                  = 428,
    @107::CV_CAP_PROP_XI_BINNING_HORIZONTAL                = 429,
    @107::CV_CAP_PROP_XI_BINNING_PATTERN                   = 430,
    @107::CV_CAP_PROP_XI_DECIMATION_SELECTOR               = 431,
    @107::CV_CAP_PROP_XI_DECIMATION_VERTICAL               = 432,
    @107::CV_CAP_PROP_XI_DECIMATION_HORIZONTAL             = 433,
    @107::CV_CAP_PROP_XI_DECIMATION_PATTERN                = 434,
    @107::CV_CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR   = 587,
    @107::CV_CAP_PROP_XI_TEST_PATTERN                      = 588,
    @107::CV_CAP_PROP_XI_IMAGE_DATA_FORMAT                 = 435,
    @107::CV_CAP_PROP_XI_SHUTTER_TYPE                      = 436,
    @107::CV_CAP_PROP_XI_SENSOR_TAPS                       = 437,
    @107::CV_CAP_PROP_XI_AEAG_ROI_OFFSET_X                 = 439,
    @107::CV_CAP_PROP_XI_AEAG_ROI_OFFSET_Y                 = 440,
    @107::CV_CAP_PROP_XI_AEAG_ROI_WIDTH                    = 441,
    @107::CV_CAP_PROP_XI_AEAG_ROI_HEIGHT                   = 442,
    @107::CV_CAP_PROP_XI_BPC                               = 445,
    @107::CV_CAP_PROP_XI_WB_KR                             = 448,
    @107::CV_CAP_PROP_XI_WB_KG                             = 449,
    @107::CV_CAP_PROP_XI_WB_KB                             = 450,
    @107::CV_CAP_PROP_XI_WIDTH                             = 451,
    @107::CV_CAP_PROP_XI_HEIGHT                            = 452,
    @107::CV_CAP_PROP_XI_REGION_SELECTOR                   = 589,
    @107::CV_CAP_PROP_XI_REGION_MODE                       = 595,
    @107::CV_CAP_PROP_XI_LIMIT_BANDWIDTH                   = 459,
    @107::CV_CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH             = 460,
    @107::CV_CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH             = 461,
    @107::CV_CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH              = 462,
    @107::CV_CAP_PROP_XI_OUTPUT_DATA_PACKING               = 463,
    @107::CV_CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE          = 464,
    @107::CV_CAP_PROP_XI_IS_COOLED                         = 465,
    @107::CV_CAP_PROP_XI_COOLING                           = 466,
    @107::CV_CAP_PROP_XI_TARGET_TEMP                       = 467,
    @107::CV_CAP_PROP_XI_CHIP_TEMP                         = 468,
    @107::CV_CAP_PROP_XI_HOUS_TEMP                         = 469,
    @107::CV_CAP_PROP_XI_HOUS_BACK_SIDE_TEMP               = 590,
    @107::CV_CAP_PROP_XI_SENSOR_BOARD_TEMP                 = 596,
    @107::CV_CAP_PROP_XI_CMS                               = 470,
    @107::CV_CAP_PROP_XI_APPLY_CMS                         = 471,
    @107::CV_CAP_PROP_XI_IMAGE_IS_COLOR                    = 474,
    @107::CV_CAP_PROP_XI_COLOR_FILTER_ARRAY                = 475,
    @107::CV_CAP_PROP_XI_GAMMAY                            = 476,
    @107::CV_CAP_PROP_XI_GAMMAC                            = 477,
    @107::CV_CAP_PROP_XI_SHARPNESS                         = 478,
    @107::CV_CAP_PROP_XI_CC_MATRIX_00                      = 479,
    @107::CV_CAP_PROP_XI_CC_MATRIX_01                      = 480,
    @107::CV_CAP_PROP_XI_CC_MATRIX_02                      = 481,
    @107::CV_CAP_PROP_XI_CC_MATRIX_03                      = 482,
    @107::CV_CAP_PROP_XI_CC_MATRIX_10                      = 483,
    @107::CV_CAP_PROP_XI_CC_MATRIX_11                      = 484,
    @107::CV_CAP_PROP_XI_CC_MATRIX_12                      = 485,
    @107::CV_CAP_PROP_XI_CC_MATRIX_13                      = 486,
    @107::CV_CAP_PROP_XI_CC_MATRIX_20                      = 487,
    @107::CV_CAP_PROP_XI_CC_MATRIX_21                      = 488,
    @107::CV_CAP_PROP_XI_CC_MATRIX_22                      = 489,
    @107::CV_CAP_PROP_XI_CC_MATRIX_23                      = 490,
    @107::CV_CAP_PROP_XI_CC_MATRIX_30                      = 491,
    @107::CV_CAP_PROP_XI_CC_MATRIX_31                      = 492,
    @107::CV_CAP_PROP_XI_CC_MATRIX_32                      = 493,
    @107::CV_CAP_PROP_XI_CC_MATRIX_33                      = 494,
    @107::CV_CAP_PROP_XI_DEFAULT_CC_MATRIX                 = 495,
    @107::CV_CAP_PROP_XI_TRG_SELECTOR                      = 498,
    @107::CV_CAP_PROP_XI_ACQ_FRAME_BURST_COUNT             = 499,
    @107::CV_CAP_PROP_XI_DEBOUNCE_EN                       = 507,
    @107::CV_CAP_PROP_XI_DEBOUNCE_T0                       = 508,
    @107::CV_CAP_PROP_XI_DEBOUNCE_T1                       = 509,
    @107::CV_CAP_PROP_XI_DEBOUNCE_POL                      = 510,
    @107::CV_CAP_PROP_XI_LENS_MODE                         = 511,
    @107::CV_CAP_PROP_XI_LENS_APERTURE_VALUE               = 512,
    @107::CV_CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE         = 513,
    @107::CV_CAP_PROP_XI_LENS_FOCUS_MOVE                   = 514,
    @107::CV_CAP_PROP_XI_LENS_FOCUS_DISTANCE               = 515,
    @107::CV_CAP_PROP_XI_LENS_FOCAL_LENGTH                 = 516,
    @107::CV_CAP_PROP_XI_LENS_FEATURE_SELECTOR             = 517,
    @107::CV_CAP_PROP_XI_LENS_FEATURE                      = 518,
    @107::CV_CAP_PROP_XI_DEVICE_MODEL_ID                   = 521,
    @107::CV_CAP_PROP_XI_DEVICE_SN                         = 522,
    @107::CV_CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA     = 529,
    @107::CV_CAP_PROP_XI_IMAGE_PAYLOAD_SIZE                = 530,
    @107::CV_CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT            = 531,
    @107::CV_CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ              = 532,
    @107::CV_CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX           = 533,
    @107::CV_CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT       = 534,
    @107::CV_CAP_PROP_XI_FRAMERATE                         = 535,
    @107::CV_CAP_PROP_XI_COUNTER_SELECTOR                  = 536,
    @107::CV_CAP_PROP_XI_COUNTER_VALUE                     = 537,
    @107::CV_CAP_PROP_XI_ACQ_TIMING_MODE                   = 538,
    @107::CV_CAP_PROP_XI_AVAILABLE_BANDWIDTH               = 539,
    @107::CV_CAP_PROP_XI_BUFFER_POLICY                     = 540,
    @107::CV_CAP_PROP_XI_LUT_EN                            = 541,
    @107::CV_CAP_PROP_XI_LUT_INDEX                         = 542,
    @107::CV_CAP_PROP_XI_LUT_VALUE                         = 543,
    @107::CV_CAP_PROP_XI_TRG_DELAY                         = 544,
    @107::CV_CAP_PROP_XI_TS_RST_MODE                       = 545,
    @107::CV_CAP_PROP_XI_TS_RST_SOURCE                     = 546,
    @107::CV_CAP_PROP_XI_IS_DEVICE_EXIST                   = 547,
    @107::CV_CAP_PROP_XI_ACQ_BUFFER_SIZE                   = 548,
    @107::CV_CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT              = 549,
    @107::CV_CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE         = 550,
    @107::CV_CAP_PROP_XI_BUFFERS_QUEUE_SIZE                = 551,
    @107::CV_CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT       = 552,
    @107::CV_CAP_PROP_XI_RECENT_FRAME                      = 553,
    @107::CV_CAP_PROP_XI_DEVICE_RESET                      = 554,
    @107::CV_CAP_PROP_XI_COLUMN_FPN_CORRECTION             = 555,
    @107::CV_CAP_PROP_XI_ROW_FPN_CORRECTION                = 591,
    @107::CV_CAP_PROP_XI_SENSOR_MODE                       = 558,
    @107::CV_CAP_PROP_XI_HDR                               = 559,
    @107::CV_CAP_PROP_XI_HDR_KNEEPOINT_COUNT               = 560,
    @107::CV_CAP_PROP_XI_HDR_T1                            = 561,
    @107::CV_CAP_PROP_XI_HDR_T2                            = 562,
    @107::CV_CAP_PROP_XI_KNEEPOINT1                        = 563,
    @107::CV_CAP_PROP_XI_KNEEPOINT2                        = 564,
    @107::CV_CAP_PROP_XI_IMAGE_BLACK_LEVEL                 = 565,
    @107::CV_CAP_PROP_XI_HW_REVISION                       = 571,
    @107::CV_CAP_PROP_XI_DEBUG_LEVEL                       = 572,
    @107::CV_CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION        = 573,
    @107::CV_CAP_PROP_XI_FFS_FILE_ID                       = 594,
    @107::CV_CAP_PROP_XI_FFS_FILE_SIZE                     = 580,
    @107::CV_CAP_PROP_XI_FREE_FFS_SIZE                     = 581,
    @107::CV_CAP_PROP_XI_USED_FFS_SIZE                     = 582,
    @107::CV_CAP_PROP_XI_FFS_ACCESS_KEY                    = 583,
    @107::CV_CAP_PROP_XI_SENSOR_FEATURE_SELECTOR           = 585,
    @107::CV_CAP_PROP_XI_SENSOR_FEATURE_VALUE              = 586,
    @107::CV_CAP_PROP_ANDROID_FLASH_MODE                   = 8001,
    @107::CV_CAP_PROP_ANDROID_FOCUS_MODE                   = 8002,
    @107::CV_CAP_PROP_ANDROID_WHITE_BALANCE                = 8003,
    @107::CV_CAP_PROP_ANDROID_ANTIBANDING                  = 8004,
    @107::CV_CAP_PROP_ANDROID_FOCAL_LENGTH                 = 8005,
    @107::CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_NEAR          = 8006,
    @107::CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_OPTIMAL       = 8007,
    @107::CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_FAR           = 8008,
    @107::CV_CAP_PROP_ANDROID_EXPOSE_LOCK                  = 8009,
    @107::CV_CAP_PROP_ANDROID_WHITEBALANCE_LOCK            = 8010,
    @107::CV_CAP_PROP_IOS_DEVICE_FOCUS                     = 9001,
    @107::CV_CAP_PROP_IOS_DEVICE_EXPOSURE                  = 9002,
    @107::CV_CAP_PROP_IOS_DEVICE_FLASH                     = 9003,
    @107::CV_CAP_PROP_IOS_DEVICE_WHITEBALANCE              = 9004,
    @107::CV_CAP_PROP_IOS_DEVICE_TORCH                     = 9005,
    @107::CV_CAP_PROP_GIGA_FRAME_OFFSET_X                  = 10001,
    @107::CV_CAP_PROP_GIGA_FRAME_OFFSET_Y                  = 10002,
    @107::CV_CAP_PROP_GIGA_FRAME_WIDTH_MAX                 = 10003,
    @107::CV_CAP_PROP_GIGA_FRAME_HEIGH_MAX                 = 10004,
    @107::CV_CAP_PROP_GIGA_FRAME_SENS_WIDTH                = 10005,
    @107::CV_CAP_PROP_GIGA_FRAME_SENS_HEIGH                = 10006,
    @107::CV_CAP_PROP_INTELPERC_PROFILE_COUNT              = 11001,
    @107::CV_CAP_PROP_INTELPERC_PROFILE_IDX                = 11002,
    @107::CV_CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE = 11003,
    @107::CV_CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE     = 11004,
    @107::CV_CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD = 11005,
    @107::CV_CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ    = 11006,
    @107::CV_CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT    = 11007,
    @107::CV_CAP_INTELPERC_DEPTH_GENERATOR                 = 1 <<29,
    @107::CV_CAP_INTELPERC_IMAGE_GENERATOR                 = 1 <<28,
    @107::CV_CAP_INTELPERC_GENERATORS_MASK                 = CV_CAP_INTELPERC_DEPTH_GENERATOR + CV_CAP_INTELPERC_IMAGE_GENERATOR,
};

enum
{
    @108::CV_CAP_MODE_BGR  = 0,
    @108::CV_CAP_MODE_RGB  = 1,
    @108::CV_CAP_MODE_GRAY = 2,
    @108::CV_CAP_MODE_YUYV = 3,
};

enum
{
    @109::CV_CAP_OPENNI_DEPTH_MAP         = 0,
    @109::CV_CAP_OPENNI_POINT_CLOUD_MAP   = 1,
    @109::CV_CAP_OPENNI_DISPARITY_MAP     = 2,
    @109::CV_CAP_OPENNI_DISPARITY_MAP_32F = 3,
    @109::CV_CAP_OPENNI_VALID_DEPTH_MASK  = 4,
    @109::CV_CAP_OPENNI_BGR_IMAGE         = 5,
    @109::CV_CAP_OPENNI_GRAY_IMAGE        = 6,
    @109::CV_CAP_OPENNI_IR_IMAGE          = 7,
};

enum
{
    @110::CV_CAP_OPENNI_VGA_30HZ  = 0,
    @110::CV_CAP_OPENNI_SXGA_15HZ = 1,
    @110::CV_CAP_OPENNI_SXGA_30HZ = 2,
    @110::CV_CAP_OPENNI_QVGA_30HZ = 3,
    @110::CV_CAP_OPENNI_QVGA_60HZ = 4,
};

enum
{
    @111::CV_CAP_INTELPERC_DEPTH_MAP   = 0,
    @111::CV_CAP_INTELPERC_UVDEPTH_MAP = 1,
    @111::CV_CAP_INTELPERC_IR_MAP      = 2,
    @111::CV_CAP_INTELPERC_IMAGE       = 3,
};

enum
{
    @112::CV_CAP_PROP_GPHOTO2_PREVIEW          = 17001,
    @112::CV_CAP_PROP_GPHOTO2_WIDGET_ENUMERATE = 17002,
    @112::CV_CAP_PROP_GPHOTO2_RELOAD_CONFIG    = 17003,
    @112::CV_CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE = 17004,
    @112::CV_CAP_PROP_GPHOTO2_COLLECT_MSGS     = 17005,
    @112::CV_CAP_PROP_GPHOTO2_FLUSH_MSGS       = 17006,
    @112::CV_CAP_PROP_SPEED                    = 17007,
    @112::CV_CAP_PROP_APERTURE                 = 17008,
    @112::CV_CAP_PROP_EXPOSUREPROGRAM          = 17009,
    @112::CV_CAP_PROP_VIEWFINDER               = 17010,
};

// global functions

int
CV_FOURCC(
    char c1,
    char c2,
    char c3,
    char c4
    );

CvCapture*
cvCreateCameraCapture(int index);

CvCapture*
cvCreateFileCapture(const char* filename);

CvCapture*
cvCreateFileCaptureWithPreference(
    const char* filename,
    int apiPreference
    );

CvVideoWriter*
cvCreateVideoWriter(
    const char* filename,
    int fourcc,
    double fps,
    CvSize frame_size,
    int is_color = 1
    );

int
cvGetCaptureDomain(CvCapture* capture);

double
cvGetCaptureProperty(
    CvCapture* capture,
    int property_id
    );

int
cvGrabFrame(CvCapture* capture);

IplImage*
cvQueryFrame(CvCapture* capture);

void
cvReleaseCapture(CvCapture** capture);

void
cvReleaseVideoWriter(CvVideoWriter** writer);

IplImage*
cvRetrieveFrame(
    CvCapture* capture,
    int streamIdx = 0
    );

int
cvSetCaptureProperty(
    CvCapture* capture,
    int property_id,
    double value
    );

int
cvWriteFrame(
    CvVideoWriter* writer,
    const IplImage* image
    );

// macros

#define CV_FOURCC_DEFAULT

#define CV_FOURCC_MACRO( \
    c1, \
    c2, \
    c3, \
    c4 \
    )

#define CV_FOURCC_PROMPT
#define cvCaptureFromAVI
#define cvCaptureFromCAM
#define cvCaptureFromFile
#define cvCreateAVIWriter
#define cvWriteToAVI

Detailed Documentation

Typedefs

typedef struct CvCapture CvCapture

“black box” capture structure

In C++ use cv::VideoCapture

typedef struct CvVideoWriter CvVideoWriter

“black box” video file writer structure

In C++ use cv::VideoWriter

Global Functions

int
CV_FOURCC(
    char c1,
    char c2,
    char c3,
    char c4
    )

Constructs the fourcc code of the codec function.

Simply call it with 4 chars fourcc code like CV_FOURCC(‘I’, ‘Y’, ‘U’, ‘V’)

List of codes can be obtained at Video Codecs by FOURCC page. FFMPEG backend with MP4 container natively uses other values as fourcc code: see ObjectType.

CvCapture*
cvCreateCameraCapture(int index)

start capturing frames from camera: index = camera_index + domain_offset (CV_CAP_*)

CvCapture*
cvCreateFileCapture(const char* filename)

start capturing frames from video file

CvCapture*
cvCreateFileCaptureWithPreference(
    const char* filename,
    int apiPreference
    )

start capturing frames from video file. allows specifying a preferred API to use

CvVideoWriter*
cvCreateVideoWriter(
    const char* filename,
    int fourcc,
    double fps,
    CvSize frame_size,
    int is_color = 1
    )

initialize video file writer

int
cvGetCaptureDomain(CvCapture* capture)

Return the type of the capturer (eg, CV_CAP_VFW, CV_CAP_UNICAP)

It is unknown if created with CV_CAP_ANY

double
cvGetCaptureProperty(
    CvCapture* capture,
    int property_id
    )

retrieve capture properties

int
cvGrabFrame(CvCapture* capture)

grab a frame, return 1 on success, 0 on fail.

this function is thought to be fast

IplImage*
cvQueryFrame(CvCapture* capture)

Just a combination of cvGrabFrame and cvRetrieveFrame.

!!!DO NOT RELEASE or MODIFY the retrieved frame!!!

void
cvReleaseCapture(CvCapture** capture)

stop capturing/reading and free resources

void
cvReleaseVideoWriter(CvVideoWriter** writer)

close video file writer

IplImage*
cvRetrieveFrame(
    CvCapture* capture,
    int streamIdx = 0
    )

get the frame grabbed with cvGrabFrame(..)

This function may apply some frame processing like frame decompression, flipping etc.!!!DO NOT RELEASE or MODIFY the retrieved frame!!!

int
cvSetCaptureProperty(
    CvCapture* capture,
    int property_id,
    double value
    )

set capture properties

int
cvWriteFrame(
    CvVideoWriter* writer,
    const IplImage* image
    )

write frame to video file

Macros

#define CV_FOURCC_DEFAULT

(Linux only) Use default codec for specified filename

#define CV_FOURCC_MACRO( \
    c1, \
    c2, \
    c3, \
    c4 \
    )

Macro to construct the fourcc code of the codec. Same as CV_FOURCC()

#define CV_FOURCC_PROMPT

(Windows only) Open Codec Selection Dialog

#define cvCaptureFromAVI

Deprecated use cvCreateFileCapture() instead

#define cvCaptureFromCAM

Deprecated use cvCreateCameraCapture() instead

#define cvCaptureFromFile

Deprecated use cvCreateFileCapture() instead

#define cvCreateAVIWriter

Deprecated use cvCreateVideoWriter() instead

#define cvWriteToAVI

Deprecated use cvWriteFrame() instead