Fix grammar errors in documentation
[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 "libavutil/avutil.h"
23
24 #define LIBAVDEVICE_VERSION_MAJOR 52
25 #define LIBAVDEVICE_VERSION_MINOR  2
26 #define LIBAVDEVICE_VERSION_MICRO  0
27
28 #define LIBAVDEVICE_VERSION_INT AV_VERSION_INT(LIBAVDEVICE_VERSION_MAJOR, \
29                                                LIBAVDEVICE_VERSION_MINOR, \
30                                                LIBAVDEVICE_VERSION_MICRO)
31 #define LIBAVDEVICE_VERSION     AV_VERSION(LIBAVDEVICE_VERSION_MAJOR, \
32                                            LIBAVDEVICE_VERSION_MINOR, \
33                                            LIBAVDEVICE_VERSION_MICRO)
34 #define LIBAVDEVICE_BUILD       LIBAVDEVICE_VERSION_INT
35
36 /**
37  * Return the LIBAVDEVICE_VERSION_INT constant.
38  */
39 unsigned avdevice_version(void);
40
41 /**
42  * Return the libavdevice build-time configuration.
43  */
44 const char *avdevice_configuration(void);
45
46 /**
47  * Return the libavdevice license.
48  */
49 const char *avdevice_license(void);
50
51 /**
52  * Initialize libavdevice and register all the input and output devices.
53  * @warning This function is not thread safe.
54  */
55 void avdevice_register_all(void);
56
57 #endif /* AVDEVICE_AVDEVICE_H */
58