1 /*M///////////////////////////////////////////////////////////////////////////////////////
2 //
3 // IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4 //
5 // By downloading, copying, installing or using the software you agree to this license.
6 // If you do not agree to this license, do not download, install,
7 // copy or use the software.
8 //
9 //
10 // Intel License Agreement
11 // For Open Source Computer Vision Library
12 //
13 // Copyright (C) 2000, Intel Corporation, all rights reserved.
14 // Third party copyrights are property of their respective owners.
15 //
16 // Redistribution and use in source and binary forms, with or without modification,
17 // are permitted provided that the following conditions are met:
18 //
19 // * Redistribution's of source code must retain the above copyright notice,
20 // this list of conditions and the following disclaimer.
21 //
22 // * Redistribution's in binary form must reproduce the above copyright notice,
23 // this list of conditions and the following disclaimer in the documentation
24 // and/or other materials provided with the distribution.
25 //
26 // * The name of Intel Corporation may not be used to endorse or promote products
27 // derived from this software without specific prior written permission.
28 //
29 // This software is provided by the copyright holders and contributors "as is" and
30 // any express or implied warranties, including, but not limited to, the implied
31 // warranties of merchantability and fitness for a particular purpose are disclaimed.
32 // In no event shall the Intel Corporation or contributors be liable for any direct,
33 // indirect, incidental, special, exemplary, or consequential damages
34 // (including, but not limited to, procurement of substitute goods or services;
35 // loss of use, data, or profits; or business interruption) however caused
36 // and on any theory of liability, whether in contract, strict liability,
37 // or tort (including negligence or otherwise) arising in any way out of
38 // the use of this software, even if advised of the possibility of such damage.
39 //
40 //M*/
41
42 #ifndef __OPENCV_VIDEOIO_H__
43 #define __OPENCV_VIDEOIO_H__
44
45 #include "opencv2/core/core_c.h"
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif /* __cplusplus */
50
51 /**
52 @addtogroup videoio_c
53 @{
54 */
55
56 /****************************************************************************************\
57 * Working with Video Files and Cameras *
58 \****************************************************************************************/
59
60 /* "black box" capture structure */
61 typedef struct CvCapture CvCapture;
62
63 /* start capturing frames from video file */
64 CVAPI(CvCapture*) cvCreateFileCapture( const char* filename );
65
66 enum
67 {
68 CV_CAP_ANY =0, // autodetect
69
70 CV_CAP_MIL =100, // MIL proprietary drivers
71
72 CV_CAP_VFW =200, // platform native
73 CV_CAP_V4L =200,
74 CV_CAP_V4L2 =200,
75
76 CV_CAP_FIREWARE =300, // IEEE 1394 drivers
77 CV_CAP_FIREWIRE =300,
78 CV_CAP_IEEE1394 =300,
79 CV_CAP_DC1394 =300,
80 CV_CAP_CMU1394 =300,
81
82 CV_CAP_STEREO =400, // TYZX proprietary drivers
83 CV_CAP_TYZX =400,
84 CV_TYZX_LEFT =400,
85 CV_TYZX_RIGHT =401,
86 CV_TYZX_COLOR =402,
87 CV_TYZX_Z =403,
88
89 CV_CAP_QT =500, // QuickTime
90
91 CV_CAP_UNICAP =600, // Unicap drivers
92
93 CV_CAP_DSHOW =700, // DirectShow (via videoInput)
94 CV_CAP_MSMF =1400, // Microsoft Media Foundation (via videoInput)
95
96 CV_CAP_PVAPI =800, // PvAPI, Prosilica GigE SDK
97
98 CV_CAP_OPENNI =900, // OpenNI (for Kinect)
99 CV_CAP_OPENNI_ASUS =910, // OpenNI (for Asus Xtion)
100
101 CV_CAP_ANDROID =1000, // Android - not used
102 CV_CAP_ANDROID_BACK =CV_CAP_ANDROID+99, // Android back camera - not used
103 CV_CAP_ANDROID_FRONT =CV_CAP_ANDROID+98, // Android front camera - not used
104
105 CV_CAP_XIAPI =1100, // XIMEA Camera API
106
107 CV_CAP_AVFOUNDATION = 1200, // AVFoundation framework for iOS (OS X Lion will have the same API)
108
109 CV_CAP_GIGANETIX = 1300, // Smartek Giganetix GigEVisionSDK
110
111 CV_CAP_INTELPERC = 1500, // Intel Perceptual Computing
112
113 CV_CAP_OPENNI2 = 1600, // OpenNI2 (for Kinect)
114
115 CV_CAP_GPHOTO2 = 1700
116 };
117
118 /* start capturing frames from camera: index = camera_index + domain_offset (CV_CAP_*) */
119 CVAPI(CvCapture*) cvCreateCameraCapture( int index );
120
121 /* grab a frame, return 1 on success, 0 on fail.
122 this function is thought to be fast */
123 CVAPI(int) cvGrabFrame( CvCapture* capture );
124
125 /* get the frame grabbed with cvGrabFrame(..)
126 This function may apply some frame processing like
127 frame decompression, flipping etc.
128 !!!DO NOT RELEASE or MODIFY the retrieved frame!!! */
129 CVAPI(IplImage*) cvRetrieveFrame( CvCapture* capture, int streamIdx CV_DEFAULT(0) );
130
131 /* Just a combination of cvGrabFrame and cvRetrieveFrame
132 !!!DO NOT RELEASE or MODIFY the retrieved frame!!! */
133 CVAPI(IplImage*) cvQueryFrame( CvCapture* capture );
134
135 /* stop capturing/reading and free resources */
136 CVAPI(void) cvReleaseCapture( CvCapture** capture );
137
138 enum
139 {
140 // modes of the controlling registers (can be: auto, manual, auto single push, absolute Latter allowed with any other mode)
141 // every feature can have only one mode turned on at a time
142 CV_CAP_PROP_DC1394_OFF = -4, //turn the feature off (not controlled manually nor automatically)
143 CV_CAP_PROP_DC1394_MODE_MANUAL = -3, //set automatically when a value of the feature is set by the user
144 CV_CAP_PROP_DC1394_MODE_AUTO = -2,
145 CV_CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO = -1,
146 CV_CAP_PROP_POS_MSEC =0,
147 CV_CAP_PROP_POS_FRAMES =1,
148 CV_CAP_PROP_POS_AVI_RATIO =2,
149 CV_CAP_PROP_FRAME_WIDTH =3,
150 CV_CAP_PROP_FRAME_HEIGHT =4,
151 CV_CAP_PROP_FPS =5,
152 CV_CAP_PROP_FOURCC =6,
153 CV_CAP_PROP_FRAME_COUNT =7,
154 CV_CAP_PROP_FORMAT =8,
155 CV_CAP_PROP_MODE =9,
156 CV_CAP_PROP_BRIGHTNESS =10,
157 CV_CAP_PROP_CONTRAST =11,
158 CV_CAP_PROP_SATURATION =12,
159 CV_CAP_PROP_HUE =13,
160 CV_CAP_PROP_GAIN =14,
161 CV_CAP_PROP_EXPOSURE =15,
162 CV_CAP_PROP_CONVERT_RGB =16,
163 CV_CAP_PROP_WHITE_BALANCE_BLUE_U =17,
164 CV_CAP_PROP_RECTIFICATION =18,
165 CV_CAP_PROP_MONOCHROME =19,
166 CV_CAP_PROP_SHARPNESS =20,
167 CV_CAP_PROP_AUTO_EXPOSURE =21, // exposure control done by camera,
168 // user can adjust refernce level
169 // using this feature
170 CV_CAP_PROP_GAMMA =22,
171 CV_CAP_PROP_TEMPERATURE =23,
172 CV_CAP_PROP_TRIGGER =24,
173 CV_CAP_PROP_TRIGGER_DELAY =25,
174 CV_CAP_PROP_WHITE_BALANCE_RED_V =26,
175 CV_CAP_PROP_ZOOM =27,
176 CV_CAP_PROP_FOCUS =28,
177 CV_CAP_PROP_GUID =29,
178 CV_CAP_PROP_ISO_SPEED =30,
179 CV_CAP_PROP_MAX_DC1394 =31,
180 CV_CAP_PROP_BACKLIGHT =32,
181 CV_CAP_PROP_PAN =33,
182 CV_CAP_PROP_TILT =34,
183 CV_CAP_PROP_ROLL =35,
184 CV_CAP_PROP_IRIS =36,
185 CV_CAP_PROP_SETTINGS =37,
186 CV_CAP_PROP_BUFFERSIZE =38,
187
188 CV_CAP_PROP_AUTOGRAB =1024, // property for videoio class CvCapture_Android only
189 CV_CAP_PROP_SUPPORTED_PREVIEW_SIZES_STRING=1025, // readonly, tricky property, returns cpnst char* indeed
190 CV_CAP_PROP_PREVIEW_FORMAT=1026, // readonly, tricky property, returns cpnst char* indeed
191
192 // OpenNI map generators
193 CV_CAP_OPENNI_DEPTH_GENERATOR = 1 << 31,
194 CV_CAP_OPENNI_IMAGE_GENERATOR = 1 << 30,
195 CV_CAP_OPENNI_GENERATORS_MASK = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_OPENNI_IMAGE_GENERATOR,
196
197 // Properties of cameras available through OpenNI interfaces
198 CV_CAP_PROP_OPENNI_OUTPUT_MODE = 100,
199 CV_CAP_PROP_OPENNI_FRAME_MAX_DEPTH = 101, // in mm
200 CV_CAP_PROP_OPENNI_BASELINE = 102, // in mm
201 CV_CAP_PROP_OPENNI_FOCAL_LENGTH = 103, // in pixels
202 CV_CAP_PROP_OPENNI_REGISTRATION = 104, // flag
203 CV_CAP_PROP_OPENNI_REGISTRATION_ON = CV_CAP_PROP_OPENNI_REGISTRATION, // flag that synchronizes the remapping depth map to image map
204 // by changing depth generator's view point (if the flag is "on") or
205 // sets this view point to its normal one (if the flag is "off").
206 CV_CAP_PROP_OPENNI_APPROX_FRAME_SYNC = 105,
207 CV_CAP_PROP_OPENNI_MAX_BUFFER_SIZE = 106,
208 CV_CAP_PROP_OPENNI_CIRCLE_BUFFER = 107,
209 CV_CAP_PROP_OPENNI_MAX_TIME_DURATION = 108,
210
211 CV_CAP_PROP_OPENNI_GENERATOR_PRESENT = 109,
212 CV_CAP_PROP_OPENNI2_SYNC = 110,
213 CV_CAP_PROP_OPENNI2_MIRROR = 111,
214
215 CV_CAP_OPENNI_IMAGE_GENERATOR_PRESENT = CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
216 CV_CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE = CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_PROP_OPENNI_OUTPUT_MODE,
217 CV_CAP_OPENNI_DEPTH_GENERATOR_BASELINE = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_BASELINE,
218 CV_CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_FOCAL_LENGTH,
219 CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_REGISTRATION,
220 CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON = CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION,
221
222 // Properties of cameras available through GStreamer interface
223 CV_CAP_GSTREAMER_QUEUE_LENGTH = 200, // default is 1
224
225 // PVAPI
226 CV_CAP_PROP_PVAPI_MULTICASTIP = 300, // ip for anable multicast master mode. 0 for disable multicast
227 CV_CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE = 301, // FrameStartTriggerMode: Determines how a frame is initiated
228 CV_CAP_PROP_PVAPI_DECIMATIONHORIZONTAL = 302, // Horizontal sub-sampling of the image
229 CV_CAP_PROP_PVAPI_DECIMATIONVERTICAL = 303, // Vertical sub-sampling of the image
230 CV_CAP_PROP_PVAPI_BINNINGX = 304, // Horizontal binning factor
231 CV_CAP_PROP_PVAPI_BINNINGY = 305, // Vertical binning factor
232 CV_CAP_PROP_PVAPI_PIXELFORMAT = 306, // Pixel format
233
234 // Properties of cameras available through XIMEA SDK interface
235 CV_CAP_PROP_XI_DOWNSAMPLING = 400, // Change image resolution by binning or skipping.
236 CV_CAP_PROP_XI_DATA_FORMAT = 401, // Output data format.
237 CV_CAP_PROP_XI_OFFSET_X = 402, // Horizontal offset from the origin to the area of interest (in pixels).
238 CV_CAP_PROP_XI_OFFSET_Y = 403, // Vertical offset from the origin to the area of interest (in pixels).
239 CV_CAP_PROP_XI_TRG_SOURCE = 404, // Defines source of trigger.
240 CV_CAP_PROP_XI_TRG_SOFTWARE = 405, // Generates an internal trigger. PRM_TRG_SOURCE must be set to TRG_SOFTWARE.
241 CV_CAP_PROP_XI_GPI_SELECTOR = 406, // Selects general purpose input
242 CV_CAP_PROP_XI_GPI_MODE = 407, // Set general purpose input mode
243 CV_CAP_PROP_XI_GPI_LEVEL = 408, // Get general purpose level
244 CV_CAP_PROP_XI_GPO_SELECTOR = 409, // Selects general purpose output
245 CV_CAP_PROP_XI_GPO_MODE = 410, // Set general purpose output mode
246 CV_CAP_PROP_XI_LED_SELECTOR = 411, // Selects camera signalling LED
247 CV_CAP_PROP_XI_LED_MODE = 412, // Define camera signalling LED functionality
248 CV_CAP_PROP_XI_MANUAL_WB = 413, // Calculates White Balance(must be called during acquisition)
249 CV_CAP_PROP_XI_AUTO_WB = 414, // Automatic white balance
250 CV_CAP_PROP_XI_AEAG = 415, // Automatic exposure/gain
251 CV_CAP_PROP_XI_EXP_PRIORITY = 416, // Exposure priority (0.5 - exposure 50%, gain 50%).
252 CV_CAP_PROP_XI_AE_MAX_LIMIT = 417, // Maximum limit of exposure in AEAG procedure
253 CV_CAP_PROP_XI_AG_MAX_LIMIT = 418, // Maximum limit of gain in AEAG procedure
254 CV_CAP_PROP_XI_AEAG_LEVEL = 419, // Average intensity of output signal AEAG should achieve(in %)
255 CV_CAP_PROP_XI_TIMEOUT = 420, // Image capture timeout in milliseconds
256
257 // Properties for Android cameras
258 CV_CAP_PROP_ANDROID_FLASH_MODE = 8001,
259 CV_CAP_PROP_ANDROID_FOCUS_MODE = 8002,
260 CV_CAP_PROP_ANDROID_WHITE_BALANCE = 8003,
261 CV_CAP_PROP_ANDROID_ANTIBANDING = 8004,
262 CV_CAP_PROP_ANDROID_FOCAL_LENGTH = 8005,
263 CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_NEAR = 8006,
264 CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_OPTIMAL = 8007,
265 CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_FAR = 8008,
266 CV_CAP_PROP_ANDROID_EXPOSE_LOCK = 8009,
267 CV_CAP_PROP_ANDROID_WHITEBALANCE_LOCK = 8010,
268
269 // Properties of cameras available through AVFOUNDATION interface
270 CV_CAP_PROP_IOS_DEVICE_FOCUS = 9001,
271 CV_CAP_PROP_IOS_DEVICE_EXPOSURE = 9002,
272 CV_CAP_PROP_IOS_DEVICE_FLASH = 9003,
273 CV_CAP_PROP_IOS_DEVICE_WHITEBALANCE = 9004,
274 CV_CAP_PROP_IOS_DEVICE_TORCH = 9005,
275
276 // Properties of cameras available through Smartek Giganetix Ethernet Vision interface
277 /* --- Vladimir Litvinenko (litvinenko.vladimir@gmail.com) --- */
278 CV_CAP_PROP_GIGA_FRAME_OFFSET_X = 10001,
279 CV_CAP_PROP_GIGA_FRAME_OFFSET_Y = 10002,
280 CV_CAP_PROP_GIGA_FRAME_WIDTH_MAX = 10003,
281 CV_CAP_PROP_GIGA_FRAME_HEIGH_MAX = 10004,
282 CV_CAP_PROP_GIGA_FRAME_SENS_WIDTH = 10005,
283 CV_CAP_PROP_GIGA_FRAME_SENS_HEIGH = 10006,
284
285 CV_CAP_PROP_INTELPERC_PROFILE_COUNT = 11001,
286 CV_CAP_PROP_INTELPERC_PROFILE_IDX = 11002,
287 CV_CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE = 11003,
288 CV_CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE = 11004,
289 CV_CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD = 11005,
290 CV_CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ = 11006,
291 CV_CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT = 11007,
292
293 // Intel PerC streams
294 CV_CAP_INTELPERC_DEPTH_GENERATOR = 1 << 29,
295 CV_CAP_INTELPERC_IMAGE_GENERATOR = 1 << 28,
296 CV_CAP_INTELPERC_GENERATORS_MASK = CV_CAP_INTELPERC_DEPTH_GENERATOR + CV_CAP_INTELPERC_IMAGE_GENERATOR
297 };
298
299 // Generic camera output modes.
300 // Currently, these are supported through the libv4l interface only.
301 enum
302 {
303 CV_CAP_MODE_BGR = 0, // BGR24 (default)
304 CV_CAP_MODE_RGB = 1, // RGB24
305 CV_CAP_MODE_GRAY = 2, // Y8
306 CV_CAP_MODE_YUYV = 3 // YUYV
307 };
308
309 enum
310 {
311 // Data given from depth generator.
312 CV_CAP_OPENNI_DEPTH_MAP = 0, // Depth values in mm (CV_16UC1)
313 CV_CAP_OPENNI_POINT_CLOUD_MAP = 1, // XYZ in meters (CV_32FC3)
314 CV_CAP_OPENNI_DISPARITY_MAP = 2, // Disparity in pixels (CV_8UC1)
315 CV_CAP_OPENNI_DISPARITY_MAP_32F = 3, // Disparity in pixels (CV_32FC1)
316 CV_CAP_OPENNI_VALID_DEPTH_MASK = 4, // CV_8UC1
317
318 // Data given from RGB image generator.
319 CV_CAP_OPENNI_BGR_IMAGE = 5,
320 CV_CAP_OPENNI_GRAY_IMAGE = 6
321 };
322
323 // Supported output modes of OpenNI image generator
324 enum
325 {
326 CV_CAP_OPENNI_VGA_30HZ = 0,
327 CV_CAP_OPENNI_SXGA_15HZ = 1,
328 CV_CAP_OPENNI_SXGA_30HZ = 2,
329 CV_CAP_OPENNI_QVGA_30HZ = 3,
330 CV_CAP_OPENNI_QVGA_60HZ = 4
331 };
332
333 enum
334 {
335 CV_CAP_INTELPERC_DEPTH_MAP = 0, // Each pixel is a 16-bit integer. The value indicates the distance from an object to the camera's XY plane or the Cartesian depth.
336 CV_CAP_INTELPERC_UVDEPTH_MAP = 1, // Each pixel contains two 32-bit floating point values in the range of 0-1, representing the mapping of depth coordinates to the color coordinates.
337 CV_CAP_INTELPERC_IR_MAP = 2, // Each pixel is a 16-bit integer. The value indicates the intensity of the reflected laser beam.
338 CV_CAP_INTELPERC_IMAGE = 3
339 };
340
341 // gPhoto2 properties, if propertyId is less than 0 then work on widget with that __additive inversed__ camera setting ID
342 // Get IDs by using CAP_PROP_GPHOTO2_WIDGET_ENUMERATE.
343 // @see CvCaptureCAM_GPHOTO2 for more info
344 enum
345 {
346 CV_CAP_PROP_GPHOTO2_PREVIEW = 17001, // Capture only preview from liveview mode.
347 CV_CAP_PROP_GPHOTO2_WIDGET_ENUMERATE = 17002, // Readonly, returns (const char *).
348 CV_CAP_PROP_GPHOTO2_RELOAD_CONFIG = 17003, // Trigger, only by set. Reload camera settings.
349 CV_CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE = 17004, // Reload all settings on set.
350 CV_CAP_PROP_GPHOTO2_COLLECT_MSGS = 17005, // Collect messages with details.
351 CV_CAP_PROP_GPHOTO2_FLUSH_MSGS = 17006, // Readonly, returns (const char *).
352 CV_CAP_PROP_SPEED = 17007, // Exposure speed. Can be readonly, depends on camera program.
353 CV_CAP_PROP_APERTURE = 17008, // Aperture. Can be readonly, depends on camera program.
354 CV_CAP_PROP_EXPOSUREPROGRAM = 17009, // Camera exposure program.
355 CV_CAP_PROP_VIEWFINDER = 17010 // Enter liveview mode.
356 };
357
358 /* retrieve or set capture properties */
359 CVAPI(double) cvGetCaptureProperty( CvCapture* capture, int property_id );
360 CVAPI(int) cvSetCaptureProperty( CvCapture* capture, int property_id, double value );
361
362 // Return the type of the capturer (eg, CV_CAP_V4W, CV_CAP_UNICAP), which is unknown if created with CV_CAP_ANY
363 CVAPI(int) cvGetCaptureDomain( CvCapture* capture);
364
365 /* "black box" video file writer structure */
366 typedef struct CvVideoWriter CvVideoWriter;
367
368 #define CV_FOURCC_MACRO(c1, c2, c3, c4) (((c1) & 255) + (((c2) & 255) << 8) + (((c3) & 255) << 16) + (((c4) & 255) << 24))
369
CV_FOURCC(char c1,char c2,char c3,char c4)370 CV_INLINE int CV_FOURCC(char c1, char c2, char c3, char c4)
371 {
372 return CV_FOURCC_MACRO(c1, c2, c3, c4);
373 }
374
375 #define CV_FOURCC_PROMPT -1 /* Open Codec Selection Dialog (Windows only) */
376 #define CV_FOURCC_DEFAULT CV_FOURCC('I', 'Y', 'U', 'V') /* Use default codec for specified filename (Linux only) */
377
378 /* initialize video file writer */
379 CVAPI(CvVideoWriter*) cvCreateVideoWriter( const char* filename, int fourcc,
380 double fps, CvSize frame_size,
381 int is_color CV_DEFAULT(1));
382
383 /* write frame to video file */
384 CVAPI(int) cvWriteFrame( CvVideoWriter* writer, const IplImage* image );
385
386 /* close video file writer */
387 CVAPI(void) cvReleaseVideoWriter( CvVideoWriter** writer );
388
389 /****************************************************************************************\
390 * Obsolete functions/synonyms *
391 \****************************************************************************************/
392
393 #define cvCaptureFromFile cvCreateFileCapture
394 #define cvCaptureFromCAM cvCreateCameraCapture
395 #define cvCaptureFromAVI cvCaptureFromFile
396 #define cvCreateAVIWriter cvCreateVideoWriter
397 #define cvWriteToAVI cvWriteFrame
398
399 /** @} videoio_c */
400
401 #ifdef __cplusplus
402 }
403 #endif
404
405 #endif //__OPENCV_VIDEOIO_H__
406