diff options
author | Michael Niedermayer <michaelni@gmx.at> | 2003-03-06 11:32:04 +0000 |
---|---|---|
committer | Michael Niedermayer <michaelni@gmx.at> | 2003-03-06 11:32:04 +0000 |
commit | 983e3246b7528e6ffc0cc347d54b86e161140fe6 (patch) | |
tree | dcbb0c1222a0717ed687c3dabf0a35bf205bf044 /libavcodec | |
parent | d33c949cd3292e6014c350afdbac91f6d2d66153 (diff) | |
download | ffmpeg-983e3246b7528e6ffc0cc347d54b86e161140fe6.tar.gz |
per file doxy
Originally committed as revision 1634 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec')
66 files changed, 342 insertions, 27 deletions
diff --git a/libavcodec/a52dec.c b/libavcodec/a52dec.c index c9f22a981d..fb169c7ee3 100644 --- a/libavcodec/a52dec.c +++ b/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" diff --git a/libavcodec/ac3.h b/libavcodec/ac3.h index 51583edfa9..1e8a5ba2db 100644 --- a/libavcodec/ac3.h +++ b/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 */ diff --git a/libavcodec/ac3dec.c b/libavcodec/ac3dec.c index 62a7cdfaf3..53bfa56a85 100644 --- a/libavcodec/ac3dec.c +++ b/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" diff --git a/libavcodec/ac3enc.c b/libavcodec/ac3enc.c index bd29b2b46d..3e83fb1fcf 100644 --- a/libavcodec/ac3enc.c +++ b/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" diff --git a/libavcodec/ac3tab.h b/libavcodec/ac3tab.h index 65345deb46..5d404b5390 100644 --- a/libavcodec/ac3tab.h +++ b/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 }; diff --git a/libavcodec/adpcm.c b/libavcodec/adpcm.c index 8f6863cb01..e94d16b513 100644 --- a/libavcodec/adpcm.c +++ b/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] = { diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c index bc8bedcca6..51c3402229 100644 --- a/libavcodec/allcodecs.c +++ b/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 diff --git a/libavcodec/apiexample.c b/libavcodec/apiexample.c index 303082cdbd..530ae74cd1 100644 --- a/libavcodec/apiexample.c +++ b/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> diff --git a/libavcodec/avcodec.c b/libavcodec/avcodec.c index b1fb5c88a8..4f4114cda9 100644 --- a/libavcodec/avcodec.c +++ b/libavcodec/avcodec.c @@ -1,3 +1,8 @@ +/** + * @file avcodec.c + * avcodec. + */ + #include "errno.h" #include "avcodec.h" diff --git a/libavcodec/bswap.h b/libavcodec/bswap.h index bdc8212aee..035216dddd 100644 --- a/libavcodec/bswap.h +++ b/libavcodec/bswap.h @@ -1,3 +1,8 @@ +/** + * @file bswap.h + * byte swap. + */ + #ifndef __BSWAP_H__ #define __BSWAP_H__ diff --git a/libavcodec/common.c b/libavcodec/common.c index 58d79a9a0a..96d0afcbe5 100644 --- a/libavcodec/common.c +++ b/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]={ diff --git a/libavcodec/common.h b/libavcodec/common.h index 175eb741ff..b65e8bd991 100644 --- a/libavcodec/common.h +++ b/libavcodec/common.h @@ -1,3 +1,8 @@ +/** + * @file common.h + * common internal api header. + */ + #ifndef COMMON_H #define COMMON_H diff --git a/libavcodec/cyuv.c b/libavcodec/cyuv.c index 5edd3aa9c0..1bf676a434 100644 --- a/libavcodec/cyuv.c +++ b/libavcodec/cyuv.c @@ -23,6 +23,11 @@ * */ +/** + * @file cyuv.c + * Creative YUV (CYUV) Video Decoder. + */ + #include <stdio.h> #include <stdlib.h> #include <string.h> diff --git a/libavcodec/dct-test.c b/libavcodec/dct-test.c index 29410ca5af..5f8473accc 100644 --- a/libavcodec/dct-test.c +++ b/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> diff --git a/libavcodec/dsputil.c b/libavcodec/dsputil.c index 7fdf0decd5..5f4190f755 100644 --- a/libavcodec/dsputil.c +++ b/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" diff --git a/libavcodec/dsputil.h b/libavcodec/dsputil.h index c16d563354..0a06b4a545 100644 --- a/libavcodec/dsputil.h +++ b/libavcodec/dsputil.h @@ -19,8 +19,7 @@ /** * @file dsputil.h - * @brief DSP utils - * + * DSP utils. */ #ifndef DSPUTIL_H diff --git a/libavcodec/dv.c b/libavcodec/dv.c index c9a1f4796b..9e89b3ac15 100644 --- a/libavcodec/dv.c +++ b/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" diff --git a/libavcodec/dvdata.h b/libavcodec/dvdata.h index 83dd955d3c..29aea40224 100644 --- a/libavcodec/dvdata.h +++ b/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) diff --git a/libavcodec/error_resilience.c b/libavcodec/error_resilience.c index 195f31fce6..d58cfb0304 100644 --- a/libavcodec/error_resilience.c +++ b/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" diff --git a/libavcodec/eval.c b/libavcodec/eval.c index 1a9cce6add..28a492cd4b 100644 --- a/libavcodec/eval.c +++ b/libavcodec/eval.c @@ -19,7 +19,10 @@ * */ - /* +/** + * @file eval.c + * simple arithmetic expression evaluator. + * * see http://joe.hotchkiss.com/programming/eval/eval.html */ diff --git a/libavcodec/fdctref.c b/libavcodec/fdctref.c index ae376f7941..d728727ce6 100644 --- a/libavcodec/fdctref.c +++ b/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. */ diff --git a/libavcodec/fft-test.c b/libavcodec/fft-test.c index 09f45c7096..4a3ac9f540 100644 --- a/libavcodec/fft-test.c +++ b/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> diff --git a/libavcodec/fft.c b/libavcodec/fft.c index 65eb575f36..3b5244a077 100644 --- a/libavcodec/fft.c +++ b/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" /** diff --git a/libavcodec/h263.c b/libavcodec/h263.c index 9781a1ba84..05f4baf286 100644 --- a/libavcodec/h263.c +++ b/libavcodec/h263.c @@ -25,8 +25,7 @@ /** * @file h263.c - * @brief h263/mpeg4 codec - * + * h263/mpeg4 codec. */ //#define DEBUG diff --git a/libavcodec/h263data.h b/libavcodec/h263data.h index 840d64aa12..132ed98a9b 100644 --- a/libavcodec/h263data.h +++ b/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 }; diff --git a/libavcodec/h263dec.c b/libavcodec/h263dec.c index e1ee79a166..9d797f5e97 100644 --- a/libavcodec/h263dec.c +++ b/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" diff --git a/libavcodec/huffyuv.c b/libavcodec/huffyuv.c index 909c2a1537..7823f0bf1c 100644 --- a/libavcodec/huffyuv.c +++ b/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" diff --git a/libavcodec/imgconvert.c b/libavcodec/imgconvert.c index cfebe2477c..9d833ccc51 100644 --- a/libavcodec/imgconvert.c +++ b/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" diff --git a/libavcodec/imgresample.c b/libavcodec/imgresample.c index 2e67fecb3d..140894d365 100644 --- a/libavcodec/imgresample.c +++ b/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" diff --git a/libavcodec/jfdctfst.c b/libavcodec/jfdctfst.c index dd496b816e..899768d361 100644 --- a/libavcodec/jfdctfst.c +++ b/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" diff --git a/libavcodec/jfdctint.c b/libavcodec/jfdctint.c index 97de639bb7..702d0a9476 100644 --- a/libavcodec/jfdctint.c +++ b/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" diff --git a/libavcodec/jrevdct.c b/libavcodec/jrevdct.c index 07d8ce8160..3bd78c1925 100644 --- a/libavcodec/jrevdct.c +++ b/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" diff --git a/libavcodec/mace.c b/libavcodec/mace.c index d8438e8d9c..91a37452b9 100644 --- a/libavcodec/mace.c +++ b/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" /* diff --git a/libavcodec/mdct.c b/libavcodec/mdct.c index 91a927cb09..a0f5671771 100644 --- a/libavcodec/mdct.c +++ b/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) { diff --git a/libavcodec/mem.c b/libavcodec/mem.c index a36952fd74..c5ca166d33 100644 --- a/libavcodec/mem.c +++ b/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 */ diff --git a/libavcodec/mjpeg.c b/libavcodec/mjpeg.c index 4160ff4809..efc9108b69 100644 --- a/libavcodec/mjpeg.c +++ b/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" diff --git a/libavcodec/motion_est.c b/libavcodec/motion_est.c index 36226d203d..5bc37fa035 100644 --- a/libavcodec/motion_est.c +++ b/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" diff --git a/libavcodec/motion_est_template.c b/libavcodec/motion_est_template.c index 4725ed994c..f393fd88a9 100644 --- a/libavcodec/motion_est_template.c +++ b/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 diff --git a/libavcodec/motion_test.c b/libavcodec/motion_test.c index 63d0a08757..477d108796 100644 --- a/libavcodec/motion_test.c +++ b/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> diff --git a/libavcodec/mp3lameaudio.c b/libavcodec/mp3lameaudio.c index 18f36e1a39..4e1660d4eb 100644 --- a/libavcodec/mp3lameaudio.c +++ b/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" diff --git a/libavcodec/mpeg12.c b/libavcodec/mpeg12.c index bee03d2876..6eb16c9dfc 100644 --- a/libavcodec/mpeg12.c +++ b/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" diff --git a/libavcodec/mpeg12data.h b/libavcodec/mpeg12data.h index 4a90bbdb72..d18640d074 100644 --- a/libavcodec/mpeg12data.h +++ b/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] = { diff --git a/libavcodec/mpeg4data.h b/libavcodec/mpeg4data.h index 92814908b4..219e329934 100644 --- a/libavcodec/mpeg4data.h +++ b/libavcodec/mpeg4data.h @@ -1,3 +1,8 @@ +/** + * @file mpeg4data.h + * mpeg4 tables. + */ + // shapes #define RECT_SHAPE 0 #define BIN_SHAPE 1 diff --git a/libavcodec/mpegaudio.c b/libavcodec/mpegaudio.c index e8bf6f1d21..f5b9223049 100644 --- a/libavcodec/mpegaudio.c +++ b/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" diff --git a/libavcodec/mpegaudio.h b/libavcodec/mpegaudio.h index 338d3c1e08..7aba13200b 100644 --- a/libavcodec/mpegaudio.h +++ b/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 diff --git a/libavcodec/mpegaudiodec.c b/libavcodec/mpegaudiodec.c index a0234e47f4..a93c280abc 100644 --- a/libavcodec/mpegaudiodec.c +++ b/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" diff --git a/libavcodec/mpegaudiodectab.h b/libavcodec/mpegaudiodectab.h index ce9f1a8de0..8a13127ad9 100644 --- a/libavcodec/mpegaudiodectab.h +++ b/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 }, diff --git a/libavcodec/mpegaudiotab.h b/libavcodec/mpegaudiotab.h index 6521202bbb..59bf868932 100644 --- a/libavcodec/mpegaudiotab.h +++ b/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] = { diff --git a/libavcodec/mpegvideo.c b/libavcodec/mpegvideo.c index f487c51f7d..fbea1f94db 100644 --- a/libavcodec/mpegvideo.c +++ b/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" diff --git a/libavcodec/mpegvideo.h b/libavcodec/mpegvideo.h index 899956a5b5..0c8bd5e32f 100644 --- a/libavcodec/mpegvideo.h +++ b/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 diff --git a/libavcodec/msmpeg4.c b/libavcodec/msmpeg4.c index 2183b9d3a0..acf52d8136 100644 --- a/libavcodec/msmpeg4.c +++ b/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" diff --git a/libavcodec/msmpeg4data.h b/libavcodec/msmpeg4data.h index 2c3a28f0e2..69568cbf63 100644 --- a/libavcodec/msmpeg4data.h +++ b/libavcodec/msmpeg4data.h @@ -1,4 +1,5 @@ -/* +/** + * @file msmpeg4data.h * MSMPEG4 data tables. */ diff --git a/libavcodec/oggvorbis.c b/libavcodec/oggvorbis.c index af5b1eb7bf..7e525a5593 100644 --- a/libavcodec/oggvorbis.c +++ b/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> diff --git a/libavcodec/oggvorbis.h b/libavcodec/oggvorbis.h index 0b206a1737..fd431dc64c 100644 --- a/libavcodec/oggvorbis.h +++ b/libavcodec/oggvorbis.h @@ -1,3 +1,8 @@ +/** + * @file oggvorbis.h + * oggvorbis. + */ + #ifndef AVCODEC_OGGVORBIS_H #define AVCODEC_OGGVORBIS_H diff --git a/libavcodec/opts.c b/libavcodec/opts.c index cf5cf0eef7..908f27875a 100644 --- a/libavcodec/opts.c +++ b/libavcodec/opts.c @@ -2,7 +2,9 @@ * LGPL */ -/* +/** + * @file opts.c + * options parser. * typical parsed command line: * msmpeg4:bitrate=720000:qmax=16 * diff --git a/libavcodec/ratecontrol.c b/libavcodec/ratecontrol.c index ffb9237ac7..d7fe11100c 100644 --- a/libavcodec/ratecontrol.c +++ b/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" diff --git a/libavcodec/resample.c b/libavcodec/resample.c index 36b039c06b..209a00808d 100644 --- a/libavcodec/resample.c +++ b/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 { diff --git a/libavcodec/rv10.c b/libavcodec/rv10.c index 6ed93b2abd..8244cb5dcf 100644 --- a/libavcodec/rv10.c +++ b/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" diff --git a/libavcodec/simple_idct.c b/libavcodec/simple_idct.c index d8fc32a105..4b488197a8 100644 --- a/libavcodec/simple_idct.c +++ b/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>) diff --git a/libavcodec/simple_idct.h b/libavcodec/simple_idct.h index f8d2148a18..2da822771b 100644 --- a/libavcodec/simple_idct.h +++ b/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); diff --git a/libavcodec/svq1.c b/libavcodec/svq1.c index 6046f20034..ab2f8e855f 100644 --- a/libavcodec/svq1.c +++ b/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> diff --git a/libavcodec/svq1_cb.h b/libavcodec/svq1_cb.h index fa1eb3b1f1..14372a2550 100644 --- a/libavcodec/svq1_cb.h +++ b/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, diff --git a/libavcodec/utils.c b/libavcodec/utils.c index d8d750dffa..70de6ca13d 100644 --- a/libavcodec/utils.c +++ b/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" diff --git a/libavcodec/wmadata.h b/libavcodec/wmadata.h index 12050b2f36..ee17207102 100644 --- a/libavcodec/wmadata.h +++ b/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, diff --git a/libavcodec/wmadec.c b/libavcodec/wmadec.c index d3aff0a67f..ab02feb728 100644 --- a/libavcodec/wmadec.c +++ b/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" diff --git a/libavcodec/wmv2.c b/libavcodec/wmv2.c index 5050ef4ac5..be8c71364f 100644 --- a/libavcodec/wmv2.c +++ b/libavcodec/wmv2.c @@ -17,6 +17,11 @@ * */ +/** + * @file wmv2.c + * wmv2 codec. + */ + #include "simple_idct.h" #define SKIP_TYPE_NONE 0 |