git.sesse.net Git - ffmpeg/blob - 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 #include "version.h"
  23
  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
  39  * meaning - e.g. for x11grab it is the display name.
  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
  46 /**
  47  * Return the LIBAVDEVICE_VERSION_INT constant.
  48  */
  49 unsigned avdevice_version(void);
  50
  51 /**
  52  * Return the libavdevice build-time configuration.
  53  */
  54 const char *avdevice_configuration(void);
  55
  56 /**
  57  * Return the libavdevice license.
  58  */
  59 const char *avdevice_license(void);
  60
  61 /**
  62  * Initialize libavdevice and register all the input and output devices.
  63  * @warning This function is not thread safe.
  64  */
  65 void avdevice_register_all(void);
  66
  67 #endif /* AVDEVICE_AVDEVICE_H */