[FFmpeg-soc] [soc]: r4704 - in concat/libavformat: concat.c concatgen.c m3u.c playlist.c playlist.h pls.c xspf.c

[gkovacs]

Author: gkovacs
Date: Mon Jul 13 09:07:16 2009
New Revision: 4704

Log:
per-file doxygen comments

Modified:
   concat/libavformat/concat.c
   concat/libavformat/concatgen.c
   concat/libavformat/m3u.c
   concat/libavformat/playlist.c
   concat/libavformat/playlist.h
   concat/libavformat/pls.c
   concat/libavformat/xspf.c

Modified: concat/libavformat/concat.c
==============================================================================
--- concat/libavformat/concat.c	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/concat.c	Mon Jul 13 09:07:16 2009	(r4704)
@@ -1,5 +1,5 @@
 /*
- * Standard playlist/concatenation demuxer
+ * Minimal playlist/concatenation demuxer
  * Copyright (c) 2009 Geza Kovacs
  *
  * This file is part of FFmpeg.
@@ -19,6 +19,14 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file concat.c
+ *  @brief Minimal playlist/concatenation demuxer
+ *  @details This is a minimal concat-type demuxer that can be constructed
+ *  by allocating a PlayElem for each playlist item and setting its filename,
+ *  then allocating a PlaylistContext, creating a list of PlayElem, and setting
+ *  the PlaylistContext in the AVFormatContext.
+ */
+
 #include "playlist.h"
 
 static int ff_concatgen_read_packet(AVFormatContext *s, AVPacket *pkt);
@@ -33,27 +41,27 @@ static int ff_concatgen_read_play(AVForm
 
 static int ff_concatgen_read_pause(AVFormatContext *s);
 
-/* The ffmpeg codecs we support, and the IDs they have in the file */
+// The FFmpeg codecs we support, and the IDs they have in the file
 static const AVCodecTag codec_concat_tags[] = {
     { 0, 0 },
 };
 
+// concat demuxer should only be manually constructed in ffmpeg
 static int concat_probe(AVProbeData *p)
 {
-    // concat demuxer should only be manually constructed in ffmpeg
     return 0;
 }
 
+// PlaylistD should be constructed externally
 static int concat_read_header(AVFormatContext *s,
-                       AVFormatParameters *ap)
+                              AVFormatParameters *ap)
 {
-    // PlaylistD should be constructed externally
     return 0;
 }
 
 AVInputFormat* ff_concat_alloc_demuxer(void)
 {
-    AVInputFormat *cdm = av_malloc(sizeof(*cdm));
+    AVInputFormat *cdm  = av_malloc(sizeof(*cdm));
     cdm->name           = "concat";
     cdm->long_name      = NULL_IF_CONFIG_SMALL("CONCAT format");
     cdm->priv_data_size = sizeof(PlaylistContext);

Modified: concat/libavformat/concatgen.c
==============================================================================
--- concat/libavformat/concatgen.c	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/concatgen.c	Mon Jul 13 09:07:16 2009	(r4704)
@@ -19,6 +19,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file concatgen.c
+ *  @brief Generic functions used by playlist/concatenation demuxers
+ *  @details These functions are used to read packets and seek streams
+ *  for concat-type demuxers, abstracting away the playlist element switching
+ *  process.
+ */
+
 #include "playlist.h"
 
 int ff_concatgen_read_packet(AVFormatContext *s,

Modified: concat/libavformat/m3u.c
==============================================================================
--- concat/libavformat/m3u.c	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/m3u.c	Mon Jul 13 09:07:16 2009	(r4704)
@@ -1,5 +1,5 @@
 /*
- * M3U muxer and demuxer
+ * M3U playlist demuxer
  * Copyright (c) 2009 Geza Kovacs
  *
  * This file is part of FFmpeg.
@@ -19,6 +19,10 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file m3u.c
+ *  @brief M3U playlist demuxer
+ */
+
 #include "playlist.h"
 
 static int ff_concatgen_read_packet(AVFormatContext *s, AVPacket *pkt);

Modified: concat/libavformat/playlist.c
==============================================================================
--- concat/libavformat/playlist.c	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/playlist.c	Mon Jul 13 09:07:16 2009	(r4704)
@@ -19,6 +19,14 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file playlist.c
+ *  @brief General components used by playlist formats
+ *  @details These functions are used to initialize and manipulate playlists
+ *  (PlaylistContext) and their individual playlist elements (PlayElem), each
+ *  of which encapsulates its own AVFormatContext. This abstraction used for
+ *  implementing file concatenation and support for playlist formats.
+ */
+
 #include "avformat.h"
 #include "playlist.h"
 #include "internal.h"

Modified: concat/libavformat/playlist.h
==============================================================================
--- concat/libavformat/playlist.h	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/playlist.h	Mon Jul 13 09:07:16 2009	(r4704)
@@ -19,6 +19,14 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file playlist.h
+ *  @brief General components used by playlist formats
+ *  @details These functions are used to initialize and manipulate playlists
+ *  (PlaylistContext) and their individual playlist elements (PlayElem), each
+ *  of which encapsulates its own AVFormatContext. This abstraction used for
+ *  implementing file concatenation and support for playlist formats.
+ */
+
 #ifndef AVFORMAT_PLAYLIST_H
 #define AVFORMAT_PLAYLIST_H
 
@@ -27,7 +35,7 @@
 #include <libgen.h>
 
 /** @struct PlayElem
- *  @brief Represents each input file on a playlist
+ *  @brief Represents each input file on a playlist.
  */
 typedef struct PlayElem {
     AVFormatContext *ic; /**< AVFormatContext for this playlist item */
@@ -37,7 +45,7 @@ typedef struct PlayElem {
 } PlayElem;
 
 /** @struct PlaylistContext
- *  @brief Represents the playlist and contains PlayElem for each playlist item
+ *  @brief Represents the playlist and contains PlayElem for each playlist item.
  */
 typedef struct PlaylistContext {
     PlayElem **pelist; /**< List of PlayElem, with each representing a playlist item */

Modified: concat/libavformat/pls.c
==============================================================================
--- concat/libavformat/pls.c	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/pls.c	Mon Jul 13 09:07:16 2009	(r4704)
@@ -1,5 +1,5 @@
 /*
- * PLS muxer and demuxer
+ * PLS playlist demuxer
  * Copyright (c) 2009 Geza Kovacs
  *
  * This file is part of FFmpeg.
@@ -19,6 +19,10 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file pls.c
+ *  @brief PLS playlist demuxer
+ */
+
 #include "playlist.h"
 
 static int ff_concatgen_read_packet(AVFormatContext *s, AVPacket *pkt);

Modified: concat/libavformat/xspf.c
==============================================================================
--- concat/libavformat/xspf.c	Mon Jul 13 08:22:18 2009	(r4703)
+++ concat/libavformat/xspf.c	Mon Jul 13 09:07:16 2009	(r4704)
@@ -1,5 +1,5 @@
 /*
- * XSPF muxer and demuxer
+ * XSPF playlist demuxer
  * Copyright (c) 2009 Geza Kovacs
  *
  * This file is part of FFmpeg.
@@ -19,6 +19,10 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/** @file pls.c
+ *  @brief XSPF playlist demuxer
+ */
+
 #include "avformat.h"