h264_metadata: Add option to delete filler data
[libav.git] / libavdevice / avdevice.h
CommitLineData
c721d803 1/*
2912e87a 2 * This file is part of Libav.
c721d803 3 *
2912e87a 4 * Libav is free software; you can redistribute it and/or
c721d803
LA
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 *
2912e87a 9 * Libav is distributed in the hope that it will be useful,
c721d803
LA
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
2912e87a 15 * License along with Libav; if not, write to the Free Software
c721d803
LA
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
98790382
SS
19#ifndef AVDEVICE_AVDEVICE_H
20#define AVDEVICE_AVDEVICE_H
c721d803 21
86ab7b0f
DB
22#include "version.h"
23
1be32305
AK
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
5ed4644d 39 * meaning - e.g. for xcbgrab it is the display name.
1be32305
AK
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
c721d803 46/**
49bd8e4b 47 * Return the LIBAVDEVICE_VERSION_INT constant.
b3b990b6
SS
48 */
49unsigned avdevice_version(void);
50
51/**
49bd8e4b 52 * Return the libavdevice build-time configuration.
c1736936 53 */
1dc5c358 54const char *avdevice_configuration(void);
c1736936
DB
55
56/**
49bd8e4b 57 * Return the libavdevice license.
c1736936 58 */
1dc5c358 59const char *avdevice_license(void);
c1736936
DB
60
61/**
c721d803
LA
62 * Initialize libavdevice and register all the input and output devices.
63 * @warning This function is not thread safe.
64 */
65void avdevice_register_all(void);
66
98790382 67#endif /* AVDEVICE_AVDEVICE_H */