2 * This file is part of FFmpeg.
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.
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.
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
19 #ifndef AVDEVICE_AVDEVICE_H
20 #define AVDEVICE_AVDEVICE_H
27 * Main libavdevice API header
31 * @defgroup lavd Special devices muxing/demuxing library
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.
41 * To use libavdevice, simply call avdevice_register_all() to register all
42 * compiled muxers and demuxers. They all use standard libavformat API.
46 #include "libavformat/avformat.h"
49 * Return the LIBAVDEVICE_VERSION_INT constant.
51 unsigned avdevice_version(void);
54 * Return the libavdevice build-time configuration.
56 const char *avdevice_configuration(void);
59 * Return the libavdevice license.
61 const char *avdevice_license(void);
64 * Initialize libavdevice and register all the input and output devices.
65 * @warning This function is not thread safe.
67 void avdevice_register_all(void);
69 typedef struct AVDeviceRect {
70 int x; /**< x coordinate of top left corner */
71 int y; /**< y coordinate of top left corner */
72 int width; /**< width */
73 int height; /**< height */
77 * Message types used by avdevice_app_to_dev_control_message().
79 enum AVAppToDevMessageType {
83 AV_APP_TO_DEV_NONE = MKBETAG('N','O','N','E'),
86 * Window size change message.
88 * Message is sent to the device every time the application changes the size
89 * of the window device renders to.
90 * Message should also be sent right after window is created.
92 * data: AVDeviceRect: new window size.
94 AV_APP_TO_DEV_WINDOW_SIZE = MKBETAG('G','E','O','M'),
97 * Repaint request message.
99 * Message is sent to the device when window have to be rapainted.
101 * data: AVDeviceRect: area required to be repainted.
102 * NULL: whole area is required to be repainted.
104 AV_APP_TO_DEV_WINDOW_REPAINT = MKBETAG('R','E','P','A')
108 * Message types used by avdevice_dev_to_app_control_message().
110 enum AVDevToAppMessageType {
114 AV_DEV_TO_APP_NONE = MKBETAG('N','O','N','E'),
117 * Create window buffer message.
119 * Device requests to create a window buffer. Exact meaning is device-
120 * and application-dependent. Message is sent before rendering first
121 * frame and all one-shot initializations should be done here.
122 * Application is allowed to ignore preferred window buffer size.
124 * @note: Application is obligated to inform about window buffer size
125 * with AV_APP_TO_DEV_WINDOW_SIZE message.
127 * data: AVDeviceRect: preferred size of the window buffer.
128 * NULL: no preferred size of the window buffer.
130 AV_DEV_TO_APP_CREATE_WINDOW_BUFFER = MKBETAG('B','C','R','E'),
133 * Prepare window buffer message.
135 * Device requests to prepare a window buffer for rendering.
136 * Exact meaning is device- and application-dependent.
137 * Message is sent before rendering of each frame.
141 AV_DEV_TO_APP_PREPARE_WINDOW_BUFFER = MKBETAG('B','P','R','E'),
144 * Display window buffer message.
146 * Device requests to display a window buffer.
147 * Message is sent when new frame is ready to be displyed.
148 * Usually buffers need to be swapped in handler of this message.
152 AV_DEV_TO_APP_DISPLAY_WINDOW_BUFFER = MKBETAG('B','D','I','S'),
155 * Destroy window buffer message.
157 * Device requests to destroy a window buffer.
158 * Message is sent when device is about to be destroyed and window
159 * buffer is not required anymore.
163 AV_DEV_TO_APP_DESTROY_WINDOW_BUFFER = MKBETAG('B','D','E','S')
167 * Send control message from application to device.
169 * @param s device context.
170 * @param type message type.
171 * @param data message data. Exact type depends on message type.
172 * @param data_size size of message data.
173 * @return >= 0 on success, negative on error.
174 * AVERROR(ENOSYS) when device doesn't implement handler of the message.
176 int avdevice_app_to_dev_control_message(struct AVFormatContext *s,
177 enum AVAppToDevMessageType type,
178 void *data, size_t data_size);
181 * Send control message from device to application.
183 * @param s device context.
184 * @param type message type.
185 * @param data message data. Can be NULL.
186 * @param data_size size of message data.
187 * @return >= 0 on success, negative on error.
188 * AVERROR(ENOSYS) when application doesn't implement handler of the message.
190 int avdevice_dev_to_app_control_message(struct AVFormatContext *s,
191 enum AVDevToAppMessageType type,
192 void *data, size_t data_size);
194 #endif /* AVDEVICE_AVDEVICE_H */