e194663ee3810208feba8f54c86c1ad6b30bb72f
[ffmpeg.git] / libavdevice / avdevice.h
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVDEVICE_AVDEVICE_H
20 #define AVDEVICE_AVDEVICE_H
21
22 #include "version.h"
23
24 /**
25  * @file
26  * @ingroup lavd
27  * Main libavdevice API header
28  */
29
30 /**
31  * @defgroup lavd Special devices muxing/demuxing library
32  * @{
33  * Libavdevice is a complementary library to @ref libavf "libavformat". It
34  * provides various "special" platform-specific muxers and demuxers, e.g. for
35  * grabbing devices, audio capture and playback etc. As a consequence, the
36  * (de)muxers in libavdevice are of the AVFMT_NOFILE type (they use their own
37  * I/O functions). The filename passed to avformat_open_input() often does not
38  * refer to an actually existing file, but has some special device-specific
39  * meaning - e.g. for x11grab it is the display name.
40  *
41  * To use libavdevice, simply call avdevice_register_all() to register all
42  * compiled muxers and demuxers. They all use standard libavformat API.
43  * @}
44  */
45
46 #include "libavutil/log.h"
47 #include "libavutil/opt.h"
48 #include "libavutil/dict.h"
49 #include "libavformat/avformat.h"
50
51 /**
52  * Return the LIBAVDEVICE_VERSION_INT constant.
53  */
54 unsigned avdevice_version(void);
55
56 /**
57  * Return the libavdevice build-time configuration.
58  */
59 const char *avdevice_configuration(void);
60
61 /**
62  * Return the libavdevice license.
63  */
64 const char *avdevice_license(void);
65
66 /**
67  * Initialize libavdevice and register all the input and output devices.
68  * @warning This function is not thread safe.
69  */
70 void avdevice_register_all(void);
71
72 /**
73  * Audio input devices iterator.
74  *
75  * If d is NULL, returns the first registered input audio/video device,
76  * if d is non-NULL, returns the next registered input audio/video device after d
77  * or NULL if d is the last one.
78  */
79 AVInputFormat *av_input_audio_device_next(AVInputFormat  *d);
80
81 /**
82  * Video input devices iterator.
83  *
84  * If d is NULL, returns the first registered input audio/video device,
85  * if d is non-NULL, returns the next registered input audio/video device after d
86  * or NULL if d is the last one.
87  */
88 AVInputFormat *av_input_video_device_next(AVInputFormat  *d);
89
90 /**
91  * Audio output devices iterator.
92  *
93  * If d is NULL, returns the first registered output audio/video device,
94  * if d is non-NULL, returns the next registered output audio/video device after d
95  * or NULL if d is the last one.
96  */
97 AVOutputFormat *av_output_audio_device_next(AVOutputFormat *d);
98
99 /**
100  * Video output devices iterator.
101  *
102  * If d is NULL, returns the first registered output audio/video device,
103  * if d is non-NULL, returns the next registered output audio/video device after d
104  * or NULL if d is the last one.
105  */
106 AVOutputFormat *av_output_video_device_next(AVOutputFormat *d);
107
108 typedef struct AVDeviceRect {
109     int x;      /**< x coordinate of top left corner */
110     int y;      /**< y coordinate of top left corner */
111     int width;  /**< width */
112     int height; /**< height */
113 } AVDeviceRect;
114
115 /**
116  * Message types used by avdevice_app_to_dev_control_message().
117  */
118 enum AVAppToDevMessageType {
119     /**
120      * Dummy message.
121      */
122     AV_APP_TO_DEV_NONE = MKBETAG('N','O','N','E'),
123
124     /**
125      * Window size change message.
126      *
127      * Message is sent to the device every time the application changes the size
128      * of the window device renders to.
129      * Message should also be sent right after window is created.
130      *
131      * data: AVDeviceRect: new window size.
132      */
133     AV_APP_TO_DEV_WINDOW_SIZE = MKBETAG('G','E','O','M'),
134
135     /**
136      * Repaint request message.
137      *
138      * Message is sent to the device when window have to be rapainted.
139      *
140      * data: AVDeviceRect: area required to be repainted.
141      *       NULL: whole area is required to be repainted.
142      */
143     AV_APP_TO_DEV_WINDOW_REPAINT = MKBETAG('R','E','P','A')
144 };
145
146 /**
147  * Message types used by avdevice_dev_to_app_control_message().
148  */
149 enum AVDevToAppMessageType {
150     /**
151      * Dummy message.
152      */
153     AV_DEV_TO_APP_NONE = MKBETAG('N','O','N','E'),
154
155     /**
156      * Create window buffer message.
157      *
158      * Device requests to create a window buffer. Exact meaning is device-
159      * and application-dependent. Message is sent before rendering first
160      * frame and all one-shot initializations should be done here.
161      * Application is allowed to ignore preferred window buffer size.
162      *
163      * @note: Application is obligated to inform about window buffer size
164      *        with AV_APP_TO_DEV_WINDOW_SIZE message.
165      *
166      * data: AVDeviceRect: preferred size of the window buffer.
167      *       NULL: no preferred size of the window buffer.
168      */
169     AV_DEV_TO_APP_CREATE_WINDOW_BUFFER = MKBETAG('B','C','R','E'),
170
171     /**
172      * Prepare window buffer message.
173      *
174      * Device requests to prepare a window buffer for rendering.
175      * Exact meaning is device- and application-dependent.
176      * Message is sent before rendering of each frame.
177      *
178      * data: NULL.
179      */
180     AV_DEV_TO_APP_PREPARE_WINDOW_BUFFER = MKBETAG('B','P','R','E'),
181
182     /**
183      * Display window buffer message.
184      *
185      * Device requests to display a window buffer.
186      * Message is sent when new frame is ready to be displyed.
187      * Usually buffers need to be swapped in handler of this message.
188      *
189      * data: NULL.
190      */
191     AV_DEV_TO_APP_DISPLAY_WINDOW_BUFFER = MKBETAG('B','D','I','S'),
192
193     /**
194      * Destroy window buffer message.
195      *
196      * Device requests to destroy a window buffer.
197      * Message is sent when device is about to be destroyed and window
198      * buffer is not required anymore.
199      *
200      * data: NULL.
201      */
202     AV_DEV_TO_APP_DESTROY_WINDOW_BUFFER = MKBETAG('B','D','E','S')
203 };
204
205 /**
206  * Send control message from application to device.
207  *
208  * @param s         device context.
209  * @param type      message type.
210  * @param data      message data. Exact type depends on message type.
211  * @param data_size size of message data.
212  * @return >= 0 on success, negative on error.
213  *         AVERROR(ENOSYS) when device doesn't implement handler of the message.
214  */
215 int avdevice_app_to_dev_control_message(struct AVFormatContext *s,
216                                         enum AVAppToDevMessageType type,
217                                         void *data, size_t data_size);
218
219 /**
220  * Send control message from device to application.
221  *
222  * @param s         device context.
223  * @param type      message type.
224  * @param data      message data. Can be NULL.
225  * @param data_size size of message data.
226  * @return >= 0 on success, negative on error.
227  *         AVERROR(ENOSYS) when application doesn't implement handler of the message.
228  */
229 int avdevice_dev_to_app_control_message(struct AVFormatContext *s,
230                                         enum AVDevToAppMessageType type,
231                                         void *data, size_t data_size);
232
233 /**
234  * Following API allows user to probe device capabilities (supported codecs,
235  * pixel formats, sample formats, resolutions, channel counts, etc).
236  * It is build on top op AVOption API.
237  * Queried capabilities allows to set up converters of video or audio
238  * parameters that fit to the device.
239  *
240  * List of capablities that can be queried:
241  *  - Capabilities valid for both audio and video devices:
242  *    - codec:          supported audio/video codecs.
243  *                      type: AV_OPT_TYPE_INT (AVCodecID value)
244  *  - Capabilities valid for audio devices:
245  *    - sample_format:  supported sample formats.
246  *                      type: AV_OPT_TYPE_INT (AVSampleFormat value)
247  *    - sample_rate:    supported sample rates.
248  *                      type: AV_OPT_TYPE_INT
249  *    - channels:       supported number of channels.
250  *                      type: AV_OPT_TYPE_INT
251  *    - channel_layout: supported channel layouts.
252  *                      type: AV_OPT_TYPE_INT64
253  *  - Capabilities valid for video devices:
254  *    - pixel_format:   supported pixel formats.
255  *                      type: AV_OPT_TYPE_INT (AVPixelFormat value)
256  *    - window_size:    supported window sizes (describes size of the window size presented to the user).
257  *                      type: AV_OPT_TYPE_IMAGE_SIZE
258  *    - frame_size:     supported frame sizes (describes size of provided video frames).
259  *                      type: AV_OPT_TYPE_IMAGE_SIZE
260  *    - fps:            supported fps values
261  *                      type: AV_OPT_TYPE_RATIONAL
262  *
263  * Value of the capability may be set by user using av_opt_set() function
264  * and AVDeviceCapabilitiesQuery object. Following queries will
265  * limit results to the values matching already set capabilities.
266  * For example, setting a codec may impact number of formats or fps values
267  * returned during next query. Setting invalid value may limit results to zero.
268  *
269  * Example of the usage basing on opengl output device:
270  *
271  * @code
272  *  AVFormatContext *oc = NULL;
273  *  AVDeviceCapabilitiesQuery *caps = NULL;
274  *  AVOptionRanges *ranges;
275  *  int ret;
276  *
277  *  if ((ret = avformat_alloc_output_context2(&oc, NULL, "opengl", NULL)) < 0)
278  *      goto fail;
279  *  if (avdevice_capabilities_create(&caps, oc, NULL) < 0)
280  *      goto fail;
281  *
282  *  //query codecs
283  *  if (av_opt_query_ranges(&ranges, caps, "codec", AV_OPT_MULTI_COMPONENT_RANGE)) < 0)
284  *      goto fail;
285  *  //pick codec here and set it
286  *  av_opt_set(caps, "codec", AV_CODEC_ID_RAWVIDEO, 0);
287  *
288  *  //query format
289  *  if (av_opt_query_ranges(&ranges, caps, "pixel_format", AV_OPT_MULTI_COMPONENT_RANGE)) < 0)
290  *      goto fail;
291  *  //pick format here and set it
292  *  av_opt_set(caps, "pixel_format", AV_PIX_FMT_YUV420P, 0);
293  *
294  *  //query and set more capabilities
295  *
296  * fail:
297  *  //clean up code
298  *  avdevice_capabilities_free(&query, oc);
299  *  avformat_free_context(oc);
300  * @endcode
301  */
302
303 /**
304  * Structure describes device capabilites.
305  *
306  * It is used by devices in conjuntion with av_device_capabilities AVOption table
307  * to implement capabilities probing API based on AVOption API. Should not be used directly.
308  */
309 typedef struct AVDeviceCapabilitiesQuery {
310     const AVClass *class;
311     AVFormatContext *device_context;
312     enum AVCodecID codec;
313     enum AVSampleFormat sample_format;
314     enum AVPixelFormat pixel_format;
315     int sample_rate;
316     int channels;
317     int64_t channel_layout;
318     int window_width;
319     int window_height;
320     int frame_width;
321     int frame_height;
322     AVRational fps;
323 } AVDeviceCapabilitiesQuery;
324
325 /**
326  * AVOption table used by devices to implement device capabilites API. Should not be used by a user.
327  */
328 extern const AVOption av_device_capabilities[];
329
330 /**
331  * Initialize capabilities probing API based on AVOption API.
332  *
333  * avdevice_capabilities_free() must be called when query capabilities API is
334  * not used anymore.
335  *
336  * @param[out] caps      Device capabilities data. Pointer to a NULL pointer must be passed.
337  * @param s              Context of the device.
338  * @param device_options An AVDictionary filled with device-private options.
339  *                       On return this parameter will be destroyed and replaced with a dict
340  *                       containing options that were not found. May be NULL.
341  *                       The same options must be passed later to avformat_write_header() for output
342  *                       devices or avformat_open_input() for input devices, or at any other place
343  *                       that affects device-private options.
344  *
345  * @return >= 0 on success, negative otherwise.
346  */
347 int avdevice_capabilities_create(AVDeviceCapabilitiesQuery **caps, AVFormatContext *s,
348                                  AVDictionary **device_options);
349
350 /**
351  * Free resources created by avdevice_capabilities_create()
352  *
353  * @param caps Device capabilities data to be freed.
354  * @param s    Context of the device.
355  */
356 void avdevice_capabilities_free(AVDeviceCapabilitiesQuery **caps, AVFormatContext *s);
357
358 /**
359  * Structure describes basic parameters of the device.
360  */
361 typedef struct AVDeviceInfo {
362     char *device_name;                   /**< device name, format depends on device */
363     char *device_description;            /**< human friendly name */
364 } AVDeviceInfo;
365
366 /**
367  * List of devices.
368  */
369 typedef struct AVDeviceInfoList {
370     AVDeviceInfo **devices;              /**< list of autodetected devices */
371     int nb_devices;                      /**< number of autodetected devices */
372     int default_device;                  /**< index of default device or -1 if no default */
373 } AVDeviceInfoList;
374
375 /**
376  * List devices.
377  *
378  * Returns available device names and their parameters.
379  *
380  * @note: Some devices may accept system-dependent device names that cannot be
381  *        autodetected. The list returned by this function cannot be assumed to
382  *        be always completed.
383  *
384  * @param s                device context.
385  * @param[out] device_list list of autodetected devices.
386  * @return count of autodetected devices, negative on error.
387  */
388 int avdevice_list_devices(struct AVFormatContext *s, AVDeviceInfoList **device_list);
389
390 /**
391  * Convinient function to free result of avdevice_list_devices().
392  *
393  * @param devices device list to be freed.
394  */
395 void avdevice_free_list_devices(AVDeviceInfoList **device_list);
396
397 #endif /* AVDEVICE_AVDEVICE_H */