X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavdevice%2Favdevice.h;h=39166a570a98dc02e296410a445a4ace96eea62e;hb=f407856968dcf4ff6c7240abe3afc17c00d81b46;hp=d1e321bf3ac996fd222919ff01fbaada9d6247d7;hpb=139f3ac42dcf24eb8c59af4aaab4e9afdccbc996;p=ffmpeg

diff --git a/libavdevice/avdevice.h b/libavdevice/avdevice.h
index d1e321bf3ac..39166a570a9 100644
--- a/libavdevice/avdevice.h
+++ b/libavdevice/avdevice.h
@@ -19,19 +19,29 @@
 #ifndef AVDEVICE_AVDEVICE_H
 #define AVDEVICE_AVDEVICE_H
 
-#include "libavutil/avutil.h"
+#include "version.h"
 
-#define LIBAVDEVICE_VERSION_MAJOR 53
-#define LIBAVDEVICE_VERSION_MINOR  0
-#define LIBAVDEVICE_VERSION_MICRO  0
+/**
+ * @file
+ * @ingroup lavd
+ * Main libavdevice API header
+ */
 
-#define LIBAVDEVICE_VERSION_INT AV_VERSION_INT(LIBAVDEVICE_VERSION_MAJOR, \
-                                               LIBAVDEVICE_VERSION_MINOR, \
-                                               LIBAVDEVICE_VERSION_MICRO)
-#define LIBAVDEVICE_VERSION     AV_VERSION(LIBAVDEVICE_VERSION_MAJOR, \
-                                           LIBAVDEVICE_VERSION_MINOR, \
-                                           LIBAVDEVICE_VERSION_MICRO)
-#define LIBAVDEVICE_BUILD       LIBAVDEVICE_VERSION_INT
+/**
+ * @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
+ * meaning - e.g. for x11grab it is the display name.
+ *
+ * To use libavdevice, simply call avdevice_register_all() to register all
+ * compiled muxers and demuxers. They all use standard libavformat API.
+ * @}
+ */
 
 /**
  * Return the LIBAVDEVICE_VERSION_INT constant.
@@ -55,4 +65,3 @@ const char *avdevice_license(void);
 void avdevice_register_all(void);
 
 #endif /* AVDEVICE_AVDEVICE_H */
-