diff options
Diffstat (limited to 'libavcodec/ivi_common.h')
| -rw-r--r-- | libavcodec/ivi_common.h | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/libavcodec/ivi_common.h b/libavcodec/ivi_common.h index 8d466c6ca1..6f7ea90054 100644 --- a/libavcodec/ivi_common.h +++ b/libavcodec/ivi_common.h @@ -194,7 +194,7 @@ typedef struct { uint8_t chroma_bands; } IVIPicConfig; -/** compares some properties of two pictures */ +/** compare some properties of two pictures */ static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2) { return (str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height || @@ -213,15 +213,15 @@ static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2) /** convert unsigned values into signed ones (the sign is in the LSB) */ #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1))) -/** scales motion vector */ +/** scale motion vector */ static inline int ivi_scale_mv(int mv, int mv_scale) { return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale; } /** - * Generates a huffman codebook from the given descriptor - * and converts it into the FFmpeg VLC table. + * Generate a huffman codebook from the given descriptor + * and convert it into the FFmpeg VLC table. * * @param cb [in] pointer to codebook descriptor * @param vlc [out] where to place the generated VLC table @@ -231,13 +231,13 @@ static inline int ivi_scale_mv(int mv, int mv_scale) int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag); /** - * Initializes static codes used for macroblock and block decoding. + * Initialize static codes used for macroblock and block decoding. */ void ff_ivi_init_static_vlc(void); /** - * Decodes a huffman codebook descriptor from the bitstream - * and selects specified huffman table. + * Decode a huffman codebook descriptor from the bitstream + * and select specified huffman table. * * @param gb [in,out] the GetBit context * @param desc_coded [in] flag signalling if table descriptor was coded @@ -250,7 +250,7 @@ int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab, IVIHuffTab *huff_tab, AVCodecContext *avctx); /** - * Compares two huffman codebook descriptors. + * Compare two huffman codebook descriptors. * * @param desc1 [in] ptr to the 1st descriptor to compare * @param desc2 [in] ptr to the 2nd descriptor to compare @@ -259,7 +259,7 @@ int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab, int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2); /** - * Copies huffman codebook descriptors. + * Copy huffman codebook descriptors. * * @param dst [out] ptr to the destination descriptor * @param src [in] ptr to the source descriptor @@ -267,7 +267,7 @@ int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2); void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src); /** - * Initializes planes (prepares descriptors, allocates buffers etc). + * Initialize 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 @@ -276,14 +276,14 @@ void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src); int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg); /** - * Frees planes, bands and macroblocks buffers. + * Free planes, bands and macroblocks buffers. * * @param planes [in] pointer to the array of the plane descriptors */ void ff_ivi_free_buffers(IVIPlaneDesc *planes); /** - * Initializes tile and macroblock descriptors. + * Initialize tile and macroblock descriptors. * * @param planes [in,out] pointer to the array of the plane descriptors * @param tile_width [in] tile width @@ -293,7 +293,7 @@ void ff_ivi_free_buffers(IVIPlaneDesc *planes); int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height); /** - * Decodes size of the tile data. + * Decode 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 @@ -305,9 +305,9 @@ int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height); int ff_ivi_dec_tile_data_size(GetBitContext *gb); /** - * Decodes block data: - * extracts huffman-coded transform coefficients from the bitstream, - * dequantizes them, applies inverse transform and motion compensation + * Decode block data: + * extract huffman-coded transform coefficients from the bitstream, + * dequantize them, apply inverse transform and motion compensation * in order to reconstruct the picture. * * @param gb [in,out] the GetBit context @@ -318,7 +318,7 @@ int ff_ivi_dec_tile_data_size(GetBitContext *gb); int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile); /** - * Handles empty tiles by performing data copying and motion + * Handle empty tiles by performing data copying and motion * compensation respectively. * * @param avctx [in] ptr to the AVCodecContext @@ -330,7 +330,7 @@ void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band, IVITile *tile, int32_t mv_scale); /** - * Converts and outputs the current plane. + * Convert and output the current plane. * This conversion is done by adding back the bias value of 128 * (subtracted in the encoder) and clipping the result. * @@ -342,12 +342,12 @@ void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch); #if IVI_DEBUG /** - * Calculates band checksum from band data. + * Calculate band checksum from band data. */ uint16_t ivi_calc_band_checksum (IVIBandDesc *band); /** - * Verifies that band data lies in range. + * Verify that band data lies in range. */ int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch); #endif |