Add basic libavdevice documentation.
[ffmpeg.git] / libavdevice / avdevice.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; 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 /**
23  * @file
24  * @ingroup lavd
25  * Main libavdevice API header
26  */
27
28 /**
29  * @defgroup lavd Special devices muxing/demuxing library
30  * @{
31  * Libavdevice is a complementary library to @ref libavf "libavformat". It
32  * provides various "special" platform-specific muxers and demuxers, e.g. for
33  * grabbing devices, audio capture and playback etc. As a consequence, the
34  * (de)muxers in libavdevice are of the AVFMT_NOFILE type (they use their own
35  * I/O functions). The filename passed to avformat_open_input() often does not
36  * refer to an actually existing file, but has some special device-specific
37  * meaning - e.g. for the x11grab device it is the display name.
38  *
39  * To use libavdevice, simply call avdevice_register_all() to register all
40  * compiled muxers and demuxers. They all use standard libavformat API.
41  * @}
42  */
43
44 #include "libavutil/avutil.h"
45
46 #define LIBAVDEVICE_VERSION_MAJOR 53
47 #define LIBAVDEVICE_VERSION_MINOR  2
48 #define LIBAVDEVICE_VERSION_MICRO  0
49
50 #define LIBAVDEVICE_VERSION_INT AV_VERSION_INT(LIBAVDEVICE_VERSION_MAJOR, \
51                                                LIBAVDEVICE_VERSION_MINOR, \
52                                                LIBAVDEVICE_VERSION_MICRO)
53 #define LIBAVDEVICE_VERSION     AV_VERSION(LIBAVDEVICE_VERSION_MAJOR, \
54                                            LIBAVDEVICE_VERSION_MINOR, \
55                                            LIBAVDEVICE_VERSION_MICRO)
56 #define LIBAVDEVICE_BUILD       LIBAVDEVICE_VERSION_INT
57
58 #ifndef FF_API_V4L
59 #define FF_API_V4L              (LIBAVDEVICE_VERSION_MAJOR < 54)
60 #endif
61
62 /**
63  * Return the LIBAVDEVICE_VERSION_INT constant.
64  */
65 unsigned avdevice_version(void);
66
67 /**
68  * Return the libavdevice build-time configuration.
69  */
70 const char *avdevice_configuration(void);
71
72 /**
73  * Return the libavdevice license.
74  */
75 const char *avdevice_license(void);
76
77 /**
78  * Initialize libavdevice and register all the input and output devices.
79  * @warning This function is not thread safe.
80  */
81 void avdevice_register_all(void);
82
83 #endif /* AVDEVICE_AVDEVICE_H */
84