[FFmpeg-soc] [soc]: r5559 - in indeo5: indeo5.c ivi_common.c ivi_common.h ivi_dsp.c ivi_dsp.h
kostya
subversion at mplayerhq.hu
Sun Jan 3 11:13:43 CET 2010
Author: kostya
Date: Sun Jan 3 11:13:43 2010
New Revision: 5559
Log:
Correct and reword doxy comments to be more in line with guidelines
Modified:
indeo5/indeo5.c
indeo5/ivi_common.c
indeo5/ivi_common.h
indeo5/ivi_dsp.c
indeo5/ivi_dsp.h
Modified: indeo5/indeo5.c
==============================================================================
--- indeo5/indeo5.c Sun Jan 3 10:45:49 2010 (r5558)
+++ indeo5/indeo5.c Sun Jan 3 11:13:43 2010 (r5559)
@@ -21,7 +21,8 @@
/**
* @file libavcodec/indeo5.c
- * This is a decoder for Indeo Video Interactive v5.
+ * Indeo Video Interactive version 5 decoder
+ *
* Indeo5 data is usually transported within .avi or .mov files.
* Known FOURCCs: 'IV50'
*/
@@ -45,9 +46,9 @@
typedef struct {
GetBitContext gb;
AVFrame frame;
- RVMapDesc rvmap_tabs[9]; ///< local changeable copy of the static rvmap tables
+ RVMapDesc rvmap_tabs[9]; ///< local corrected copy of the static rvmap tables
IVIPlaneDesc planes[3]; ///< color planes
- const uint8_t *frame_data; ///< ptr to the input frame data
+ const uint8_t *frame_data; ///< input frame data pointer
uint8_t buf_switch; ///< used to switch between three buffers
uint8_t dst_buf;
uint8_t ref_buf;
@@ -70,7 +71,7 @@ typedef struct {
uint32_t lock_word;
IVIPicConfig pic_conf;
#ifdef IVI_DEBUG
- int32_t gop_num; ///< gop number
+ int32_t gop_num; ///< gop number
#endif
} IVI5DecContext;
@@ -80,7 +81,7 @@ static VLC blk_vlc_tabs[8];
/**
- * Decode Indeo5 GOP (Group of pictures) header.
+ * Decodes Indeo5 GOP (Group of pictures) header.
* This header is present in key frames only.
* It defines parameters for all frames in a GOP.
*
@@ -286,7 +287,7 @@ static int decode_gop_header(IVI5DecCont
/**
- * Skip a header extension.
+ * Skips a header extension.
*
* @param gb [in,out] the GetBit context
*/
@@ -302,7 +303,7 @@ static inline void skip_hdr_extension(Ge
/**
- * Decode Indeo5 picture header.
+ * Decodes Indeo5 picture header.
*
* @param ctx [in,out] ptr to the decoder context
* @param avctx [in] ptr to the AVCodecContext
@@ -382,7 +383,7 @@ static int decode_pic_hdr(IVI5DecContext
/**
- * Decode Indeo5 band header.
+ * Decodes Indeo5 band header.
*
* @param ctx [in,out] ptr to the decoder context
* @param band [in,out] ptr to the band descriptor
@@ -478,7 +479,7 @@ static int decode_band_hdr(IVI5DecContex
/**
- * Decode info (block type, cbp, quant delta, motion vector)
+ * Decodes info (block type, cbp, quant delta, motion vector)
* for all macroblocks in the current tile.
*
* @param ctx [in,out] ptr to the decoder context
@@ -619,7 +620,7 @@ static int decode_mb_info(IVI5DecContext
/**
- * Decode an Indeo5 band.
+ * Decodes an Indeo5 band.
*
* @param ctx [in,out] ptr to the decoder context
* @param band [in,out] ptr to the band descriptor
@@ -726,7 +727,7 @@ static int decode_band(IVI5DecContext *c
/**
- * Switch buffers.
+ * Switches buffers.
*
* @param ctx [in,out] ptr to the decoder context
* @param avctx [in] ptr to the AVCodecContext
@@ -784,7 +785,7 @@ static void switch_buffers(IVI5DecContex
/**
- * Indeo5 decoder initializations
+ * Initializes Indeo5 decoder.
*/
static av_cold int decode_init(AVCodecContext *avctx)
{
@@ -903,7 +904,7 @@ static int decode_frame(AVCodecContext *
/**
- * Indeo5 free function
+ * Closes Indeo5 decoder and cleans up its context.
*/
static av_cold int decode_close(AVCodecContext *avctx)
{
Modified: indeo5/ivi_common.c
==============================================================================
--- indeo5/ivi_common.c Sun Jan 3 10:45:49 2010 (r5558)
+++ indeo5/ivi_common.c Sun Jan 3 11:13:43 2010 (r5559)
@@ -34,7 +34,7 @@
#include "ivi_dsp.h"
/**
- * Reverse "nbits" bits of the value "val" and return the result
+ * Reverses "nbits" bits of the value "val" and returns the result
* right-justified.
*/
static uint16_t inv_bits(const uint16_t val, const int nbits)
@@ -96,7 +96,7 @@ int ff_ivi_create_huff_from_desc(const I
/**
- * Decode a huffman codebook descriptor from the bitstream.
+ * Decodes a huffman codebook descriptor from the bitstream.
*
* @param gb [in,out] the GetBit context
* @param desc [out] ptr to descriptor to be filled with data
@@ -121,7 +121,7 @@ int ff_ivi_dec_huff_desc(GetBitContext *
/**
- * Compare two huffman codebook descriptors.
+ * Compares two huffman codebook descriptors.
*
* @param desc1 [in] ptr to the 1st descriptor to compare
* @param desc2 [in] ptr to the 2nd descriptor to compare
@@ -137,7 +137,7 @@ int ff_ivi_huff_desc_cmp(const IVIHuffDe
/**
- * Copy huffman codebook descriptors.
+ * Copies huffman codebook descriptors.
*
* @param dst [out] ptr to the destination descriptor
* @param src [in] ptr to the source descriptor
@@ -150,7 +150,7 @@ void ff_ivi_huff_desc_copy(IVIHuffDesc *
/**
- * Initialize planes (prepare descriptors, allocate buffers etc).
+ * Initializes planes (prepares descriptors, allocates buffers etc).
*
* @param planes [in,out] pointer to the array of the plane descriptors
* @param cfg [in] pointer to the ivi_pic_config structure describing picture layout
@@ -213,7 +213,7 @@ int av_cold ff_ivi_init_planes(IVIPlaneD
/**
- * Free planes, bands and macroblocks buffers.
+ * Frees planes, bands and macroblocks buffers.
*
* @param planes [in] pointer to the array of the plane descriptors
*/
@@ -237,7 +237,7 @@ void av_cold ff_ivi_free_buffers(IVIPlan
/**
- * Initialize tile and macroblock descriptors.
+ * Initializes tile and macroblock descriptors.
*
* @param planes [in,out] pointer to the array of the plane descriptors
* @param tile_width [in] tile width
@@ -334,7 +334,7 @@ void ff_ivi_put_dc_pixel_8x8(int32_t *in
/**
- * Decode size of the tile data.
+ * Decodes size of the tile data.
* The size is stored as a variable-length field having the following format:
* if (tile_data_size < 255) than this field is only one byte long
* if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
@@ -362,9 +362,9 @@ int ff_ivi_dec_tile_data_size(GetBitCont
/**
- * Decode block data:
- * extract huffman-coded transform coefficients from the bitstream,
- * dequantize them, apply inverse transform and motion compensation
+ * Decodes block data:
+ * extracts huffman-coded transform coefficients from the bitstream,
+ * dequantizes them, applies inverse transform and motion compensation
* in order to reconstruct the picture.
*
* @param gb [in,out] the GetBit context
@@ -631,7 +631,7 @@ void ff_ivi_process_empty_tile(AVCodecCo
#ifdef IVI_DEBUG
/**
- * for debugging only
+ * Calculates band checksum from band data.
*/
uint16_t ivi_calc_band_checksum (IVIBandDesc *band)
{
@@ -650,7 +650,7 @@ uint16_t ivi_calc_band_checksum (IVIBand
/**
- * for debugging only
+ * Verifies that band data lies in range.
*/
int ivi_check_band (IVIBandDesc *band, uint8_t *ref, int pitch)
{
@@ -680,7 +680,7 @@ int ivi_check_band (IVIBandDesc *band, u
/**
- * Convert and output the current plane.
+ * Converts and outputs the current plane.
* This conversion is done by adding back the bias value of 128
* (subtracted in the encoder) and clipping the result.
*
Modified: indeo5/ivi_common.h
==============================================================================
--- indeo5/ivi_common.h Sun Jan 3 10:45:49 2010 (r5558)
+++ indeo5/ivi_common.h Sun Jan 3 11:13:43 2010 (r5559)
@@ -51,11 +51,11 @@ extern const IVIHuffDesc ff_ivi_blk_huff
/**
- * Run-value (RLE) table descriptor
+ * run-value (RLE) table descriptor
*/
typedef struct {
- uint8_t eob_sym; ///< huffman symbol for EOB (end of block)
- uint8_t esc_sym; ///< huffman symbol for ESC (escape)
+ uint8_t eob_sym; ///< end of block symbol
+ uint8_t esc_sym; ///< escape symbol
uint8_t runtab[256];
int8_t valtab[256];
} RVMapDesc;
@@ -64,7 +64,7 @@ extern const RVMapDesc ff_ivi_rvmap_tabs
/**
- * This structure describes an Indeo macroblock (16x16, 8x8 or 4x4).
+ * information for Indeo macroblock (16x16, 8x8 or 4x4)
*/
typedef struct {
int16_t xpos;
@@ -79,7 +79,7 @@ typedef struct {
/**
- * This structure describes an Indeo tile.
+ * information for Indeo tile
*/
typedef struct {
uint32_t xpos;
@@ -95,7 +95,7 @@ typedef struct {
/**
- * This structure describes an Indeo wavelet band.
+ * information for Indeo wavelet band
*/
typedef struct {
uint8_t plane; ///< plane number this band belongs to
@@ -104,8 +104,8 @@ typedef struct {
uint32_t height;
const uint8_t *data_ptr; ///< ptr to the first byte of the band data
uint32_t data_size; ///< size of the band data
- int16_t *buf; ///< ptr to the output buffer for this band
- int16_t *ref_buf; ///< ptr to the reference frame buffer for motion compensation
+ int16_t *buf; ///< pointer to the output buffer for this band
+ int16_t *ref_buf; ///< pointer to the reference frame buffer (for motion compensation)
int16_t *bufs[3]; ///< array of pointers to the band buffers
uint32_t pitch; ///< pitch associated with the buffers above
uint8_t is_empty; ///< = 1 if this band doesn't contain any data
@@ -132,13 +132,13 @@ typedef struct {
RVMapDesc *rv_map; ///< ptr to the RLE table for this band
uint16_t num_tiles; ///< number of tiles in this band
IVITile *tiles; ///< array of tile descriptors
- void (*inv_transform)(int32_t *in, int16_t *out, uint32_t pitch, uint8_t *flags); ///< ptr to inverse transform function
- void (*dc_transform) (int32_t *in, int16_t *out, uint32_t pitch, int blk_size); ///< ptr to dc transform function or NULL
- uint8_t is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform
+ void (*inv_transform)(int32_t *in, int16_t *out, uint32_t pitch, uint8_t *flags); ///< inverse transform function pointer
+ void (*dc_transform) (int32_t *in, int16_t *out, uint32_t pitch, int blk_size); ///< dc transform function pointer, it may be NULL
+ uint8_t is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
#ifdef IVI_DEBUG
- uint16_t checksum; ///< for debug purposes
+ uint16_t checksum; ///< for debug purposes
int32_t checksum_present;
- uint32_t bufsize; ///< band buffer size in bytes
+ uint32_t bufsize; ///< band buffer size in bytes
#endif
const uint8_t *intra_base;
const uint8_t *inter_base;
@@ -148,7 +148,7 @@ typedef struct {
/**
- * This structure describes a color plane (luma or chroma).
+ * color plane (luma or chroma) information
*/
typedef struct {
uint16_t width;
Modified: indeo5/ivi_dsp.c
==============================================================================
--- indeo5/ivi_dsp.c Sun Jan 3 10:45:49 2010 (r5558)
+++ indeo5/ivi_dsp.c Sun Jan 3 11:13:43 2010 (r5559)
@@ -32,7 +32,7 @@
#include "ivi_dsp.h"
/**
- * 5/3 - Wavelet recomposition filter for Indeo5.
+ * 5/3 wavelet recomposition filter for Indeo5
*/
void ff_ivi_recompose53(const IVIPlaneDesc *plane, uint8_t *dst,
const int dst_pitch, const int num_bands)
@@ -221,7 +221,7 @@ void ff_ivi_recompose53(const IVIPlaneDe
/**
- * Two-dimensional inverse slant 8x8 transform.
+ * two-dimensional inverse slant 8x8 transform
*/
void ff_ivi_inverse_slant_8x8(int32_t *in, int16_t *out, uint32_t pitch, uint8_t *flags)
{
@@ -263,7 +263,7 @@ void ff_ivi_inverse_slant_8x8(int32_t *i
/**
- * Two-dimensional inverse slant 4x4 transform.
+ * two-dimensional inverse slant 4x4 transform
*/
void ff_ivi_inverse_slant_4x4(int32_t *in, int16_t *out, uint32_t pitch, uint8_t *flags)
{
@@ -302,7 +302,7 @@ void ff_ivi_inverse_slant_4x4(int32_t *i
/**
- * Speed-up inverse 2D slant transforms.
+ * DC-only inverse 2D slant transforms
*/
void ff_ivi_dc_slant_2d(int32_t *in, int16_t *out, uint32_t pitch, int blk_size)
{
@@ -343,7 +343,7 @@ void ff_ivi_row_slant8(int32_t *in, int1
/**
- * Speed-up inverse row slant transform.
+ * DC-only inverse row slant transform
*/
void ff_ivi_dc_row_slant(int32_t *in, int16_t *out, uint32_t pitch, int blk_size)
{
@@ -396,7 +396,7 @@ void ff_ivi_col_slant8(int32_t *in, int1
/**
- * Speed-up inverse column slant transform.
+ * DC-only inverse column slant transform
*/
void ff_ivi_dc_col_slant(int32_t *in, int16_t *out, uint32_t pitch, int blk_size)
{
@@ -414,7 +414,7 @@ void ff_ivi_dc_col_slant(int32_t *in, in
/**
- * 8x8 block motion compensation with adding delta.
+ * 8x8 block motion compensation with adding delta
*/
void ff_ivi_mc_8x8_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type)
{
@@ -456,7 +456,7 @@ void ff_ivi_mc_8x8_delta(int16_t *buf, i
/**
- * 4x4 block motion compensation with adding delta.
+ * 4x4 block motion compensation with adding delta
*/
void ff_ivi_mc_4x4_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type)
{
@@ -503,7 +503,7 @@ void ff_ivi_mc_4x4_delta(int16_t *buf, i
/**
- * Motion compensation without adding delta.
+ * motion compensation without adding delta
*/
void ff_ivi_mc_8x8_no_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type)
{
@@ -537,7 +537,7 @@ void ff_ivi_mc_8x8_no_delta(int16_t *buf
/**
- * 4x4 block motion compensation without adding delta.
+ * 4x4 block motion compensation without adding delta
*/
void ff_ivi_mc_4x4_no_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type)
{
Modified: indeo5/ivi_dsp.h
==============================================================================
--- indeo5/ivi_dsp.h Sun Jan 3 10:45:49 2010 (r5558)
+++ indeo5/ivi_dsp.h Sun Jan 3 11:13:43 2010 (r5559)
@@ -33,7 +33,7 @@
#include "ivi_common.h"
/**
- * 5/3 - Wavelet recomposition filter for Indeo5.
+ * 5/3 wavelet recomposition filter for Indeo5
*
* @param plane [in] pointer to the descriptor of the plane being processed
* @param dst [out] pointer to the destination buffer
@@ -44,7 +44,7 @@ void ff_ivi_recompose53(const IVIPlaneDe
const int dst_pitch, const int num_bands);
/**
- * Two-dimensional inverse slant 8x8 transform.
+ * two-dimensional inverse slant 8x8 transform
*
* @param in [in] pointer to the vector of transform coefficients
* @param out [out] pointer to the output buffer (frame)
@@ -56,7 +56,7 @@ void ff_ivi_recompose53(const IVIPlaneDe
void ff_ivi_inverse_slant_8x8(int32_t *in, int16_t *out, uint32_t pitch, uint8_t *flags);
/**
- * Two-dimensional inverse slant 4x4 transform.
+ * two-dimensional inverse slant 4x4 transform
*
* @param in [in] pointer to the vector of transform coefficients
* @param out [out] pointer to the output buffer (frame)
@@ -108,7 +108,7 @@ void ff_ivi_dc_row_slant(int32_t *in, in
void ff_ivi_dc_col_slant(int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
/**
- * 8x8 block motion compensation with adding delta.
+ * 8x8 block motion compensation with adding delta
*
* @param buf [in,out] pointer to the block in the current frame buffer containing delta
* @param ref_buf [in] pointer to the corresponding block in the reference frame
@@ -118,7 +118,7 @@ void ff_ivi_dc_col_slant(int32_t *in, in
void ff_ivi_mc_8x8_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type);
/**
- * 4x4 block motion compensation with adding delta.
+ * 4x4 block motion compensation with adding delta
*
* @param buf [in,out] pointer to the block in the current frame buffer containing delta
* @param ref_buf [in] pointer to the corresponding block in the reference frame
@@ -128,7 +128,7 @@ void ff_ivi_mc_8x8_delta(int16_t *buf, i
void ff_ivi_mc_4x4_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type);
/**
- * Motion compensation without adding delta.
+ * motion compensation without adding delta
*
* @param buf [in,out] pointer to the block in the current frame receiving the result
* @param ref_buf [in] pointer to the corresponding block in the reference frame
@@ -138,7 +138,7 @@ void ff_ivi_mc_4x4_delta(int16_t *buf, i
void ff_ivi_mc_8x8_no_delta(int16_t *buf, int16_t *ref_buf, uint32_t pitch, int mc_type);
/**
- * 4x4 block motion compensation without adding delta.
+ * 4x4 block motion compensation without adding delta
*
* @param buf [in,out] pointer to the block in the current frame receiving the result
* @param ref_buf [in] pointer to the corresponding block in the reference frame
More information about the FFmpeg-soc
mailing list