per file doxy
authorMichael Niedermayer <michaelni@gmx.at>
Thu, 6 Mar 2003 11:32:04 +0000 (11:32 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Thu, 6 Mar 2003 11:32:04 +0000 (11:32 +0000)
Originally committed as revision 1634 to svn://svn.ffmpeg.org/ffmpeg/trunk

66 files changed:
libavcodec/a52dec.c
libavcodec/ac3.h
libavcodec/ac3dec.c
libavcodec/ac3enc.c
libavcodec/ac3tab.h
libavcodec/adpcm.c
libavcodec/allcodecs.c
libavcodec/apiexample.c
libavcodec/avcodec.c
libavcodec/bswap.h
libavcodec/common.c
libavcodec/common.h
libavcodec/cyuv.c
libavcodec/dct-test.c
libavcodec/dsputil.c
libavcodec/dsputil.h
libavcodec/dv.c
libavcodec/dvdata.h
libavcodec/error_resilience.c
libavcodec/eval.c
libavcodec/fdctref.c
libavcodec/fft-test.c
libavcodec/fft.c
libavcodec/h263.c
libavcodec/h263data.h
libavcodec/h263dec.c
libavcodec/huffyuv.c
libavcodec/imgconvert.c
libavcodec/imgresample.c
libavcodec/jfdctfst.c
libavcodec/jfdctint.c
libavcodec/jrevdct.c
libavcodec/mace.c
libavcodec/mdct.c
libavcodec/mem.c
libavcodec/mjpeg.c
libavcodec/motion_est.c
libavcodec/motion_est_template.c
libavcodec/motion_test.c
libavcodec/mp3lameaudio.c
libavcodec/mpeg12.c
libavcodec/mpeg12data.h
libavcodec/mpeg4data.h
libavcodec/mpegaudio.c
libavcodec/mpegaudio.h
libavcodec/mpegaudiodec.c
libavcodec/mpegaudiodectab.h
libavcodec/mpegaudiotab.h
libavcodec/mpegvideo.c
libavcodec/mpegvideo.h
libavcodec/msmpeg4.c
libavcodec/msmpeg4data.h
libavcodec/oggvorbis.c
libavcodec/oggvorbis.h
libavcodec/opts.c
libavcodec/ratecontrol.c
libavcodec/resample.c
libavcodec/rv10.c
libavcodec/simple_idct.c
libavcodec/simple_idct.h
libavcodec/svq1.c
libavcodec/svq1_cb.h
libavcodec/utils.c
libavcodec/wmadata.h
libavcodec/wmadec.c
libavcodec/wmv2.c

index c9f22a9..fb169c7 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "liba52/a52.h"
 
index 51583ed..1e8a5ba 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
  * 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 */
 
 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
 
index 62a7cdf..53bfa56 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "libac3/ac3.h"
 
index bd29b2b..3e83fb1 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 //#define DEBUG
 //#define DEBUG_BITALLOC
 #include "avcodec.h"
index 65345de..5d404b5 100644 (file)
@@ -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 };
 
 /* possible frequencies */
 const uint16_t ac3_freqs[3] = { 48000, 44100, 32000 };
index 8f6863c..e94d16b 100644 (file)
@@ -18,7 +18,9 @@
  */
 #include "avcodec.h"
 
  */
 #include "avcodec.h"
 
-/*
+/**
+ * @file adpcm.c
+ * ADPCM codecs.
  * First version by Francois Revol revol@free.fr
  *
  * Features and limitations:
  * 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,
 };
 
     -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] = {
  * this table, but such deviations are negligible:
  */
 static const int step_table[89] = {
index bc8bedc..51c3402 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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
 #include "avcodec.h"
 
 /* If you do not call this function, then you can select exactly which
index 303082c..530ae74 100644 (file)
@@ -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 
  */
  *
  * 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>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
index b1fb5c8..4f4114c 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file avcodec.c
+ * avcodec.
+ */
+
 #include "errno.h"
 #include "avcodec.h"
 
 #include "errno.h"
 #include "avcodec.h"
 
index bdc8212..035216d 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file bswap.h
+ * byte swap.
+ */
+
 #ifndef __BSWAP_H__
 #define __BSWAP_H__
 
 #ifndef __BSWAP_H__
 #define __BSWAP_H__
 
index 58d79a9..96d0afc 100644 (file)
  *
  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
  */
  *
  * 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]={
 #include "avcodec.h"
 
 const uint8_t ff_sqrt_tab[128]={
index 175eb74..b65e8bd 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file common.h
+ * common internal api header.
+ */
+
 #ifndef COMMON_H
 #define COMMON_H
 
 #ifndef COMMON_H
 #define COMMON_H
 
index 5edd3aa..1bf676a 100644 (file)
  *
  */
 
  *
  */
 
+/**
+ * @file cyuv.c 
+ * Creative YUV (CYUV) Video Decoder.
+ */
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
index 29410ca..5f8473a 100644 (file)
@@ -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>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
index 7fdf0de..5f4190f 100644 (file)
  *
  * gmc & q-pel & 32/64 bit based MC by Michael Niedermayer <michaelni@gmx.at>
  */
  *
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index c16d563..0a06b4a 100644 (file)
@@ -19,8 +19,7 @@
 
 /**
  * @file dsputil.h
 
 /**
  * @file dsputil.h
- * @brief DSP utils
- *
+ * DSP utils.
  */
 
 #ifndef DSPUTIL_H
  */
 
 #ifndef DSPUTIL_H
index c9a1f47..9e89b3a 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index 83dd955..29aea40 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
  * 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)
 
 #define NB_DV_VLC 409
 #define AAUX_OFFSET (80*6 + 80*16*3 + 3)
 
index 195f31f..d58cfb0 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "dsputil.h"
index 1a9cce6..28a492c 100644 (file)
  *
  */
 
  *
  */
 
- /*
+/**
+ * @file eval.c
+ * simple arithmetic expression evaluator.
+ *
  * see http://joe.hotchkiss.com/programming/eval/eval.html
  */
 
  * see http://joe.hotchkiss.com/programming/eval/eval.html
  */
 
index ae376f7..d728727 100644 (file)
@@ -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. */
 
 
 /* Copyright (C) 1996, MPEG Software Simulation Group. All Rights Reserved. */
 
index 09f45c7..4a3ac9f 100644 (file)
@@ -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>
 #include "dsputil.h"
 #include <math.h>
 #include <unistd.h>
index 65eb575..3b5244a 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 /**
 #include "dsputil.h"
 
 /**
index 9781a1b..05f4baf 100644 (file)
@@ -25,8 +25,7 @@
 
 /**
  * @file h263.c
 
 /**
  * @file h263.c
- * @brief h263/mpeg4 codec
- *
+ * h263/mpeg4 codec.
  */
  
 //#define DEBUG
  */
  
 //#define DEBUG
index 840d64a..132ed98 100644 (file)
@@ -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 };
 
 /* intra MCBPC, mb_type = (intra), then (intraq) */
 const uint8_t intra_MCBPC_code[8] = { 1, 1, 2, 3, 1, 1, 2, 3 };
index e1ee79a..9d797f5 100644 (file)
@@ -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
  * Copyright (c) 2001 Fabrice Bellard.
  *
  * This library is free software; you can redistribute it and/or
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index 909c2a1..7823f0b 100644 (file)
  * see http://www.pcisys.net/~melanson/codecs/huffyuv.txt for a description of
  * the algorithm used 
  */
  * 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"
 
 #include "common.h"
 #include "avcodec.h"
index cfebe24..9d833cc 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "dsputil.h"
 
index 2e67fec..140894d 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "dsputil.h"
 
index dd496b8..899768d 100644 (file)
  * quality-setting files than with low-quality ones.
  */
 
  * 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"
 #include <stdlib.h>
 #include <stdio.h>
 #include "common.h"
index 97de639..702d0a9 100644 (file)
  * scaled fixed-point arithmetic, with a minimal number of shifts.
  */
 
  * 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"
 #include <stdlib.h>
 #include <stdio.h>
 #include "common.h"
index 07d8ce8..3bd78c1 100644 (file)
  * A better way to do this would be to pass in the DCT block as a sparse
  * matrix, perhaps with the difference cases encoded.
  */
  * 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"
 
 #include "common.h"
 #include "dsputil.h"
 
index d8438e8..91a3745 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 /*
 #include "avcodec.h"
 
 /*
index 91a927c..a0f5671 100644 (file)
  */
 #include "dsputil.h"
 
  */
 #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)
 {
  */
 int ff_mdct_init(MDCTContext *s, int nbits, int inverse)
 {
index a36952f..c5ca166 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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 */
 #include "avcodec.h"
 
 /* here we can use OS dependant allocation functions */
index 4160ff4..efc9108 100644 (file)
  * aspecting, new decode_frame mechanism and apple mjpeg-b support
  *                                  by Alex Beregszaszi <alex@naxine.org>
  */
  * 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"
 //#define DEBUG
 #include "avcodec.h"
 #include "dsputil.h"
index 36226d2..5bc37fa 100644 (file)
  *
  * new Motion Estimation (X1/EPZS) by Michael Niedermayer <michaelni@gmx.at>
  */
  *
  * 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"
 #include <stdlib.h>
 #include <stdio.h>
 #include "avcodec.h"
index 4725ed9..f393fd8 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
  * 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
 
 //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
index 63d0a08..477d108 100644 (file)
@@ -1,4 +1,10 @@
 /* motion test. (c) 2001 Fabrice Bellard. */
 /* motion test. (c) 2001 Fabrice Bellard. */
+
+/**
+ * @file motion_test.c
+ * motion test.
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
index 18f36e1..4e1660d 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "mpegaudio.h"
index bee03d2..6eb16c9 100644 (file)
@@ -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
  * Copyright (c) 2000,2001 Fabrice Bellard.
  *
  * This library is free software; you can redistribute it and/or
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 //#define DEBUG
 #include "avcodec.h"
 #include "dsputil.h"
index 4a90bbd..d18640d 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * MPEG1/2 tables
+/**
+ * @file mpeg12data.h
+ * MPEG1/2 tables.
  */
 
 const int16_t ff_mpeg1_default_intra_matrix[64] = {
  */
 
 const int16_t ff_mpeg1_default_intra_matrix[64] = {
index 9281490..219e329 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file mpeg4data.h
+ * mpeg4 tables.
+ */
+
 // shapes
 #define RECT_SHAPE       0
 #define BIN_SHAPE        1
 // shapes
 #define RECT_SHAPE       0
 #define BIN_SHAPE        1
index e8bf6f1..f5b9223 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "mpegaudio.h"
 
index 338d3c1..7aba132 100644 (file)
@@ -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 
 
 /* max frame size, in samples */
 #define MPA_FRAME_SIZE 1152 
index a0234e4..a93c280 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 //#define DEBUG
 #include "avcodec.h"
 #include "mpegaudio.h"
index ce9f1a8..8a13127 100644 (file)
@@ -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 },
 
 const uint16_t mpa_bitrate_tab[2][3][15] = {
     { {0, 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448 },
index 6521202..59bf868 100644 (file)
@@ -8,6 +8,12 @@
  * same archive 
  */
 
  * 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] = {
 #define SQRT2 1.41421356237309514547
 
 static const int costab32[30] = {
index f487c51..fbea1f9 100644 (file)
  * 4MV & hq & b-frame encoding stuff by Michael Niedermayer <michaelni@gmx.at>
  */
  
  * 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"
 #include <ctype.h>
 #include <limits.h>
 #include "avcodec.h"
index 899956a..0c8bd5e 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
  * 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
 
 #ifndef AVCODEC_MPEGVIDEO_H
 #define AVCODEC_MPEGVIDEO_H
 
index 2183b9d..acf52d8 100644 (file)
  *
  * msmpeg4v1 & v2 stuff by Michael Niedermayer <michaelni@gmx.at>
  */
  *
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index 2c3a28f..69568cb 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * @file msmpeg4data.h
  * MSMPEG4 data tables. 
  */
 
  * MSMPEG4 data tables. 
  */
 
index af5b1eb..7e525a5 100644 (file)
@@ -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>
  */
 
 #include <time.h>
index 0b206a1..fd431dc 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file oggvorbis.h
+ * oggvorbis.
+ */
+
 #ifndef AVCODEC_OGGVORBIS_H
 #define AVCODEC_OGGVORBIS_H
 
 #ifndef AVCODEC_OGGVORBIS_H
 #define AVCODEC_OGGVORBIS_H
 
index cf5cf0e..908f278 100644 (file)
@@ -2,7 +2,9 @@
  * LGPL
  */
 
  * LGPL
  */
 
-/*
+/**
+ * @file opts.c
+ * options parser.
  * typical parsed command line:
  * msmpeg4:bitrate=720000:qmax=16
  *
  * typical parsed command line:
  * msmpeg4:bitrate=720000:qmax=16
  *
index ffb9237..d7fe111 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index 36b039c..209a008 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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 {
 #include "avcodec.h"
 
 typedef struct {
index 6ed93b2..8244cb5 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index d8fc32a..4b48819 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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>) 
 /*
   based upon some outcommented c code from mpeg2dec (idct_mmx.c
   written by Aaron Holtzman <aholtzma@ess.engr.uvic.ca>) 
index f8d2148..2da8227 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
  * 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);
 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);
index 6046f20..ab2f8e8 100644 (file)
  * Ported to libavcodec by Nick Kurshev <nickols_k@mail.ru>
  *
  */
  * Ported to libavcodec by Nick Kurshev <nickols_k@mail.ru>
  *
  */
+
+/**
+ * @file svq1.c
+ * svq1 decoder.
+ */
+
 //#define DEBUG_SVQ1
 #include <stdio.h>
 #include <stdlib.h>
 //#define DEBUG_SVQ1
 #include <stdio.h>
 #include <stdlib.h>
index fa1eb3b..14372a2 100644 (file)
  *
  */
 
  *
  */
 
+/**
+ * @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,
 /* 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,
index d8d750d..70de6ca 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 #include "avcodec.h"
 #include "dsputil.h"
 #include "mpegvideo.h"
index 12050b2..ee17207 100644 (file)
@@ -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,
 
 static const uint16_t wma_critical_freqs[25] = {
     100,   200,  300, 400,   510,  630,  770,    920,
index d3aff0a..ab02feb 100644 (file)
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
  * 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"
 
 #include "avcodec.h"
 #include "dsputil.h"
 
index 5050ef4..be8c713 100644 (file)
  *
  */
 
  *
  */
 
+/**
+ * @file wmv2.c
+ * wmv2 codec.
+ */
 #include "simple_idct.h"
  
 #define SKIP_TYPE_NONE 0
 #include "simple_idct.h"
  
 #define SKIP_TYPE_NONE 0