avdevice.h 2.07 KB
Newer Older
Luca Abeni's avatar
Luca Abeni committed
1
/*
2
 * This file is part of Libav.
Luca Abeni's avatar
Luca Abeni committed
3
 *
4
 * Libav is free software; you can redistribute it and/or
Luca Abeni's avatar
Luca Abeni committed
5 6 7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
9
 * Libav is distributed in the hope that it will be useful,
Luca Abeni's avatar
Luca Abeni committed
10 11 12 13 14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
15
 * License along with Libav; if not, write to the Free Software
Luca Abeni's avatar
Luca Abeni committed
16 17 18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

19 20
#ifndef AVDEVICE_AVDEVICE_H
#define AVDEVICE_AVDEVICE_H
Luca Abeni's avatar
Luca Abeni committed
21

22 23
#include "version.h"

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/**
 * @file
 * @ingroup lavd
 * Main libavdevice API header
 */

/**
 * @defgroup lavd Special devices muxing/demuxing library
 * @{
 * Libavdevice is a complementary library to @ref libavf "libavformat". It
 * provides various "special" platform-specific muxers and demuxers, e.g. for
 * grabbing devices, audio capture and playback etc. As a consequence, the
 * (de)muxers in libavdevice are of the AVFMT_NOFILE type (they use their own
 * I/O functions). The filename passed to avformat_open_input() often does not
 * 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 42 43 44 45
 *
 * To use libavdevice, simply call avdevice_register_all() to register all
 * compiled muxers and demuxers. They all use standard libavformat API.
 * @}
 */

46
/**
47
 * Return the LIBAVDEVICE_VERSION_INT constant.
48 49 50
 */
unsigned avdevice_version(void);

51
/**
52
 * Return the libavdevice build-time configuration.
53
 */
Stefano Sabatini's avatar
Stefano Sabatini committed
54
const char *avdevice_configuration(void);
55 56

/**
57
 * Return the libavdevice license.
58
 */
Stefano Sabatini's avatar
Stefano Sabatini committed
59
const char *avdevice_license(void);
60

Luca Abeni's avatar
Luca Abeni committed
61 62 63 64 65 66
/**
 * Initialize libavdevice and register all the input and output devices.
 * @warning This function is not thread safe.
 */
void avdevice_register_all(void);

67
#endif /* AVDEVICE_AVDEVICE_H */