per file doxy

Originally committed as revision 1634 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/a52dec.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file a52dec.c
+ * A52 decoder.
+ */
+
 #include "avcodec.h"
 #include "liba52/a52.h"
 

libavcodec/ac3.h

@@ -17,6 +17,11 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/**
+ * @file ac3.h
+ * Common code between AC3 encoder and decoder.
+ */
+
 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
 

libavcodec/ac3dec.c

@@ -16,6 +16,14 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file ac3dec.c
+ * AC3 decoder.
+ */
+
+//#define DEBUG
+
 #include "avcodec.h"
 #include "libac3/ac3.h"
 

libavcodec/ac3enc.c

@@ -16,6 +16,11 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file ac3enc.c
+ * The simplest AC3 encoder.
+ */
 //#define DEBUG
 //#define DEBUG_BITALLOC
 #include "avcodec.h"

libavcodec/ac3tab.h

@@ -1,4 +1,7 @@
-/* tables taken directly from AC3 spec */
+/**
+ * @file ac3tab.h
+ * tables taken directly from AC3 spec.
+ */
 
 /* possible frequencies */
 const uint16_t ac3_freqs[3] = { 48000, 44100, 32000 };

libavcodec/adpcm.c

@@ -18,7 +18,9 @@
  */
 #include "avcodec.h"
 
-/*
+/**
+ * @file adpcm.c
+ * ADPCM codecs.
  * First version by Francois Revol revol@free.fr
  *
  * Features and limitations:
@@ -47,7 +49,8 @@ static const int index_table[16] = {
     -1, -1, -1, -1, 2, 4, 6, 8,
 };
 
-/* This is the step table. Note that many programs use slight deviations from
+/** 
+ * This is the step table. Note that many programs use slight deviations from
  * this table, but such deviations are negligible:
  */
 static const int step_table[89] = {

libavcodec/allcodecs.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file allcodecs.c
+ * Utils for libavcodec.
+ */
+
 #include "avcodec.h"
 
 /* If you do not call this function, then you can select exactly which

libavcodec/apiexample.c

@@ -1,9 +1,12 @@
-/* avcodec API use example.
+/**
+ * @file apiexample.c
+ * avcodec API use example.
  *
  * Note that this library only handles codecs (mpeg, mpeg4, etc...),
  * not file formats (avi, vob, etc...). See library 'libav' for the
  * format handling 
  */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>

libavcodec/avcodec.c

@@ -1,3 +1,8 @@
+/**
+ * @file avcodec.c
+ * avcodec.
+ */
+
 #include "errno.h"
 #include "avcodec.h"
 

libavcodec/bswap.h

@@ -1,3 +1,8 @@
+/**
+ * @file bswap.h
+ * byte swap.
+ */
+
 #ifndef __BSWAP_H__
 #define __BSWAP_H__
 

libavcodec/common.c

@@ -18,6 +18,12 @@
  *
  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
  */
+
+/**
+ * @file common.c
+ * common internal api.
+ */
+
 #include "avcodec.h"
 
 const uint8_t ff_sqrt_tab[128]={

libavcodec/common.h

@@ -1,3 +1,8 @@
+/**
+ * @file common.h
+ * common internal api header.
+ */
+
 #ifndef COMMON_H
 #define COMMON_H
 

libavcodec/cyuv.c

@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * @file cyuv.c 
+ * Creative YUV (CYUV) Video Decoder.
+ */
+ 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>

libavcodec/dct-test.c

@@ -1,6 +1,9 @@
-/* DCT test. (c) 2001 Fabrice Bellard. 
-   Started from sample code by Juan J. Sierralta P.
-*/
+/**
+ * @file dct-test.c
+ * DCT test. (c) 2001 Fabrice Bellard. 
+ * Started from sample code by Juan J. Sierralta P.
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>

libavcodec/dsputil.c

@@ -18,6 +18,12 @@
  *
  * gmc & q-pel & 32/64 bit based MC by Michael Niedermayer <michaelni@gmx.at>
  */
+ 
+/**
+ * @file dsputil.c
+ * DSP utils
+ */
+ 
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/dsputil.h

@@ -19,8 +19,7 @@
 
 /**
  * @file dsputil.h
- * @brief DSP utils
- *
+ * DSP utils.
  */
 
 #ifndef DSPUTIL_H

libavcodec/dv.c

@@ -16,6 +16,11 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file dv.c
+ * DV decoder.
+ */
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/dvdata.h

@@ -17,6 +17,11 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/**
+ * @file dvdata.h
+ * Constants for DV codec.
+ */
+ 
 #define NB_DV_VLC 409
 #define AAUX_OFFSET (80*6 + 80*16*3 + 3)
 

libavcodec/error_resilience.c

@@ -17,6 +17,11 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file error_resilience.c
+ * Error resilience / concealment.
+ */
 
 #include "avcodec.h"
 #include "dsputil.h"

libavcodec/eval.c

@@ -19,7 +19,10 @@
  *
  */
 
- /*
+/**
+ * @file eval.c
+ * simple arithmetic expression evaluator.
+ *
  * see http://joe.hotchkiss.com/programming/eval/eval.html
  */
 

libavcodec/fdctref.c

@@ -1,4 +1,7 @@
-/* fdctref.c, forward discrete cosine transform, double precision           */
+/**
+ * @file fdctref.c
+ * forward discrete cosine transform, double precision.
+ */
 
 /* Copyright (C) 1996, MPEG Software Simulation Group. All Rights Reserved. */
 

libavcodec/fft-test.c

@@ -1,4 +1,8 @@
-/* FFT and MDCT tests */
+/**
+ * @file fft-test.c
+ * FFT and MDCT tests.
+ */
+
 #include "dsputil.h"
 #include <math.h>
 #include <unistd.h>

libavcodec/fft.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file fft.c
+ * FFT/IFFT transforms.
+ */
+
 #include "dsputil.h"
 
 /**

libavcodec/h263.c

@@ -25,8 +25,7 @@
 
 /**
  * @file h263.c
- * @brief h263/mpeg4 codec
- *
+ * h263/mpeg4 codec.
  */
  
 //#define DEBUG

libavcodec/h263data.h

@@ -1,3 +1,8 @@
+/**
+ * @file h263data.h
+ * H.263 tables.
+ */
+
 
 /* intra MCBPC, mb_type = (intra), then (intraq) */
 const uint8_t intra_MCBPC_code[8] = { 1, 1, 2, 3, 1, 1, 2, 3 };

libavcodec/h263dec.c

@@ -1,5 +1,5 @@
 /*
- * H263 decoder
+ * H.263 decoder
  * Copyright (c) 2001 Fabrice Bellard.
  *
  * This library is free software; you can redistribute it and/or
@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file h263dec.c
+ * H.263 decoder.
+ */
+ 
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/huffyuv.c

@@ -20,6 +20,11 @@
  * see http://www.pcisys.net/~melanson/codecs/huffyuv.txt for a description of
  * the algorithm used 
  */
+ 
+/**
+ * @file huffyuv.c
+ * huffyuv codec for libavcodec.
+ */
 
 #include "common.h"
 #include "avcodec.h"

libavcodec/imgconvert.c

@@ -16,6 +16,13 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @imgconvert.c
+ * Misc image convertion routines.
+ */
+
+
 #include "avcodec.h"
 #include "dsputil.h"
 

libavcodec/imgresample.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file imgresample.c
+ * High quality image resampling with polyphase filters .
+ */
+ 
 #include "avcodec.h"
 #include "dsputil.h"
 

libavcodec/jfdctfst.c

@@ -30,6 +30,11 @@
  * quality-setting files than with low-quality ones.
  */
 
+/**
+ * @file jfdctfst.c
+ * Independent JPEG Group's fast AAN dct.
+ */
+ 
 #include <stdlib.h>
 #include <stdio.h>
 #include "common.h"

libavcodec/jfdctint.c

@@ -23,6 +23,11 @@
  * scaled fixed-point arithmetic, with a minimal number of shifts.
  */
 
+/**
+ * @file jfdctint.c
+ * Independent JPEG Group's slow & accurate dct.
+ */
+ 
 #include <stdlib.h>
 #include <stdio.h>
 #include "common.h"

libavcodec/jrevdct.c

@@ -25,6 +25,12 @@
  * A better way to do this would be to pass in the DCT block as a sparse
  * matrix, perhaps with the difference cases encoded.
  */
+ 
+/**
+ * @file jrevdct.c
+ * Independent JPEG Group's LLM idct.
+ */
+ 
 #include "common.h"
 #include "dsputil.h"
 

libavcodec/mace.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file mace.c
+ * MACE decoder.
+ */
+ 
 #include "avcodec.h"
 
 /*

libavcodec/mdct.c

@@ -18,8 +18,13 @@
  */
 #include "dsputil.h"
 
-/*
- * init MDCT or IMDCT computation
+/**
+ * @file mdct.c
+ * MDCT/IMDCT transforms.
+ */
+
+/**
+ * init MDCT or IMDCT computation.
  */
 int ff_mdct_init(MDCTContext *s, int nbits, int inverse)
 {

libavcodec/mem.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file mem.c
+ * default memory allocator for libavcodec.
+ */
+ 
 #include "avcodec.h"
 
 /* here we can use OS dependant allocation functions */

libavcodec/mjpeg.c

@@ -20,6 +20,12 @@
  * aspecting, new decode_frame mechanism and apple mjpeg-b support
  *                                  by Alex Beregszaszi <alex@naxine.org>
  */
+
+/**
+ * @file mjpeg.c
+ * MJPEG encoder and decoder.
+ */
+ 
 //#define DEBUG
 #include "avcodec.h"
 #include "dsputil.h"

libavcodec/motion_est.c

@@ -20,6 +20,12 @@
  *
  * new Motion Estimation (X1/EPZS) by Michael Niedermayer <michaelni@gmx.at>
  */
+ 
+/**
+ * @file motion_est.c
+ * Motion estimation.
+ */
+ 
 #include <stdlib.h>
 #include <stdio.h>
 #include "avcodec.h"

libavcodec/motion_est_template.c

@@ -17,6 +17,11 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
+ 
+/**
+ * @file motion_est_template.c
+ * Motion estimation template.
+ */
 
 //lets hope gcc will remove the unused vars ...(gcc 3.2.2 seems to do it ...)
 //Note, the last line is there to kill these ugly unused var warnings

libavcodec/motion_test.c

@@ -1,4 +1,10 @@
 /* motion test. (c) 2001 Fabrice Bellard. */
+
+/**
+ * @file motion_test.c
+ * motion test.
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>

libavcodec/mp3lameaudio.c

@@ -16,6 +16,11 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file mp3lameaudio.c
+ * Interface to libmp3lame for mp3 encoding.
+ */
 
 #include "avcodec.h"
 #include "mpegaudio.h"

libavcodec/mpeg12.c

@@ -1,5 +1,5 @@
 /*
- * MPEG1 encoder / MPEG2 decoder
+ * MPEG1 codec / MPEG2 decoder
  * Copyright (c) 2000,2001 Fabrice Bellard.
  *
  * This library is free software; you can redistribute it and/or
@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file mpeg12.c
+ * MPEG1 codec / MPEG2 decoder.
+ */
+ 
 //#define DEBUG
 #include "avcodec.h"
 #include "dsputil.h"

libavcodec/mpeg12data.h

@@ -1,5 +1,6 @@
-/*
- * MPEG1/2 tables
+/**
+ * @file mpeg12data.h
+ * MPEG1/2 tables.
  */
 
 const int16_t ff_mpeg1_default_intra_matrix[64] = {

libavcodec/mpeg4data.h

@@ -1,3 +1,8 @@
+/**
+ * @file mpeg4data.h
+ * mpeg4 tables.
+ */
+
 // shapes
 #define RECT_SHAPE       0
 #define BIN_SHAPE        1

libavcodec/mpegaudio.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file mpegaudio.c
+ * The simplest mpeg audio layer 2 encoder.
+ */
+ 
 #include "avcodec.h"
 #include "mpegaudio.h"
 

libavcodec/mpegaudio.h

@@ -1,4 +1,7 @@
-/* mpeg audio declarations for both encoder and decoder */
+/**
+ * @file mpegaudio.h
+ * mpeg audio declarations for both encoder and decoder.
+ */
 
 /* max frame size, in samples */
 #define MPA_FRAME_SIZE 1152 

libavcodec/mpegaudiodec.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file mpegaudiodec.c
+ * MPEG Audio decoder.
+ */ 
+
 //#define DEBUG
 #include "avcodec.h"
 #include "mpegaudio.h"

libavcodec/mpegaudiodectab.h

@@ -1,3 +1,7 @@
+/**
+ * @file mpegaudiodectab.h
+ * mpeg audio layer decoder tables. 
+ */
 
 const uint16_t mpa_bitrate_tab[2][3][15] = {
     { {0, 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448 },

libavcodec/mpegaudiotab.h

@@ -8,6 +8,12 @@
  * same archive 
  */
 
+/**
+ * @file mpegaudiotab.h
+ * mpeg audio layer 2 tables. 
+ * Most of them come from the mpeg audio specification.
+ */
+ 
 #define SQRT2 1.41421356237309514547
 
 static const int costab32[30] = {

libavcodec/mpegvideo.c

@@ -19,6 +19,11 @@
  * 4MV & hq & b-frame encoding stuff by Michael Niedermayer <michaelni@gmx.at>
  */
  
+/**
+ * @file mpegvideo.c
+ * The simplest mpeg encoder (well, it was the simplest!).
+ */ 
+ 
 #include <ctype.h>
 #include <limits.h>
 #include "avcodec.h"

libavcodec/mpegvideo.h

@@ -17,6 +17,11 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/**
+ * @file mpegvideo.h
+ * mpegvideo header.
+ */
+ 
 #ifndef AVCODEC_MPEGVIDEO_H
 #define AVCODEC_MPEGVIDEO_H
 

libavcodec/msmpeg4.c

@@ -18,6 +18,12 @@
  *
  * msmpeg4v1 & v2 stuff by Michael Niedermayer <michaelni@gmx.at>
  */
+
+/**
+ * @file msmpeg4.c
+ * MSMPEG4 backend for ffmpeg encoder and decoder.
+ */
+
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/msmpeg4data.h

@@ -1,4 +1,5 @@
-/*
+/**
+ * @file msmpeg4data.h
  * MSMPEG4 data tables. 
  */
 

libavcodec/oggvorbis.c

@@ -1,6 +1,7 @@
-/*
- * Ogg Vorbis codec support via libvorbisenc
- * Mark Hills <mark@pogo.org.uk>
+/**
+ * @file oggvorbis.c
+ * Ogg Vorbis codec support via libvorbisenc.
+ * @author Mark Hills <mark@pogo.org.uk>
  */
 
 #include <time.h>

libavcodec/oggvorbis.h

@@ -1,3 +1,8 @@
+/**
+ * @file oggvorbis.h
+ * oggvorbis.
+ */
+
 #ifndef AVCODEC_OGGVORBIS_H
 #define AVCODEC_OGGVORBIS_H
 

libavcodec/opts.c

@@ -2,7 +2,9 @@
  * LGPL
  */
 
-/*
+/**
+ * @file opts.c
+ * options parser.
  * typical parsed command line:
  * msmpeg4:bitrate=720000:qmax=16
  *

libavcodec/ratecontrol.c

@@ -17,6 +17,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file ratecontrol.c
+ * Rate control for video encoders.
+ */ 
+
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/resample.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file resample.c
+ * Sample rate convertion for both audio and video.
+ */
+
 #include "avcodec.h"
 
 typedef struct {

libavcodec/rv10.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file rv10.c
+ * RV10 codec.
+ */
+ 
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/simple_idct.c

@@ -17,6 +17,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file simple_idct.c
+ * simpleidct in C.
+ */
+ 
 /*
   based upon some outcommented c code from mpeg2dec (idct_mmx.c
   written by Aaron Holtzman <aholtzma@ess.engr.uvic.ca>) 

libavcodec/simple_idct.h

@@ -18,6 +18,11 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/**
+ * @file simple_idct.h
+ * simple idct header.
+ */
+ 
 void simple_idct_put(uint8_t *dest, int line_size, DCTELEM *block);
 void simple_idct_add(uint8_t *dest, int line_size, DCTELEM *block);
 void ff_simple_idct_mmx(int16_t *block);

libavcodec/svq1.c

@@ -21,6 +21,12 @@
  * Ported to libavcodec by Nick Kurshev <nickols_k@mail.ru>
  *
  */
+
+/**
+ * @file svq1.c
+ * svq1 decoder.
+ */
+
 //#define DEBUG_SVQ1
 #include <stdio.h>
 #include <stdlib.h>

libavcodec/svq1_cb.h

@@ -22,6 +22,11 @@
  *
  */
 
+/**
+ * @file svq1_cb.h
+ * svq1 code books.
+ */
+ 
 /* 6x16-entry codebook for inter-coded 4x2 vectors */
 static const int8_t svq1_inter_codebook_4x2[768] = {
     7,  2, -6, -7,  7,  3, -3, -4, -7, -2,  7,  8, -8, -4,  3,  4,

libavcodec/utils.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+ 
+/**
+ * @file utils.c
+ * utils.
+ */
+ 
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"

libavcodec/wmadata.h

@@ -1,4 +1,7 @@
-/* Various WMA tables */
+/**
+ * @file wmadata.h
+ * Various WMA tables.
+ */
 
 static const uint16_t wma_critical_freqs[25] = {
     100,   200,  300, 400,   510,  630,  770,    920,

libavcodec/wmadec.c

@@ -16,6 +16,12 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+
+/**
+ * @file wmadec.c
+ * WMA compatible decoder.
+ */
+
 #include "avcodec.h"
 #include "dsputil.h"
 

libavcodec/wmv2.c

@@ -17,6 +17,11 @@
  *
  */
 
+/**
+ * @file wmv2.c
+ * wmv2 codec.
+ */
+ 
 #include "simple_idct.h"
  
 #define SKIP_TYPE_NONE 0