Commit 58c42af7 authored by Diego Biurrun's avatar Diego Biurrun

doxygen: misc consistency, spelling and wording fixes

parent 8b494b7b
......@@ -216,7 +216,7 @@ static const float psy_fir_coeffs[] = {
};
/**
* calculates the attack threshold for ABR from the above table for the LAME psy model
* Calculate the ABR attack threshold from the above LAME psymodel table.
*/
static float lame_calc_attack_threshold(int bitrate)
{
......
This diff is collapsed.
......@@ -2591,7 +2591,7 @@ typedef struct AVCodecContext {
#if FF_API_X264_GLOBAL_OPTS
/**
* Influences how often B-frames are used.
* Influence how often B-frames are used.
* - encoding: Set by user.
* - decoding: unused
*/
......@@ -2672,7 +2672,7 @@ typedef struct AVCodecContext {
int mv0_threshold;
/**
* Adjusts sensitivity of b_frame_strategy 1.
* Adjust sensitivity of b_frame_strategy 1.
* - encoding: Set by user.
* - decoding: unused
*/
......@@ -2956,7 +2956,7 @@ typedef struct AVCodecContext {
#if FF_API_FLAC_GLOBAL_OPTS
/**
* Determines which LPC analysis algorithm to use.
* Determine which LPC analysis algorithm to use.
* - encoding: Set by user
* - decoding: unused
*/
......@@ -4121,7 +4121,7 @@ int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
AVPacket *avpkt);
/**
* Frees all allocated data in the given subtitle struct.
* Free all allocated data in the given subtitle struct.
*
* @param sub AVSubtitle to free.
*/
......@@ -4486,7 +4486,7 @@ int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width,
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
/**
* Logs a generic warning message about a missing feature. This function is
* Log a generic warning message about a missing feature. This function is
* intended to be used internally by Libav (libavcodec, libavformat, etc.)
* only, and would normally not be used by applications.
* @param[in] avc a pointer to an arbitrary struct of which the first field is
......
......@@ -30,7 +30,7 @@
/**
* finds the end of the current frame in the bitstream.
* Find the end of the current frame in the bitstream.
* @return the position of the first byte of the next frame, or -1
*/
static int cavs_find_frame_end(ParseContext *pc, const uint8_t *buf,
......
......@@ -64,7 +64,7 @@ static inline int bidir_sal(int value, int offset)
}
/**
* returns the dot product.
* Return the dot product.
* @param a input data array
* @param b input data array
* @param length number of elements
......
......@@ -39,7 +39,7 @@ typedef struct DCAParseContext {
|| state == DCA_MARKER_RAW_LE || state == DCA_MARKER_RAW_BE)
/**
* finds the end of the current frame in the bitstream.
* Find the end of the current frame in the bitstream.
* @return the position of the first byte of the next frame, or -1
*/
static int dca_find_frame_end(DCAParseContext * pc1, const uint8_t * buf,
......
......@@ -1779,7 +1779,7 @@ static void add_8x8basis_c(int16_t rem[64], int16_t basis[64], int scale){
}
/**
* permutes an 8x8 block.
* Permute an 8x8 block.
* @param block the block which will be permuted according to the given permutation vector
* @param permutation the permutation vector
* @param last the last non zero coefficient in scantable order, used to speed the permutation up
......
......@@ -80,7 +80,7 @@ static void set_mv_strides(MpegEncContext *s, int *mv_step, int *stride){
}
/**
* replaces the current MB with a flat dc only version.
* Replace the current MB with a flat dc-only version.
*/
static void put_dc(MpegEncContext *s, uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr, int mb_x, int mb_y)
{
......@@ -711,7 +711,7 @@ void ff_er_frame_start(MpegEncContext *s){
}
/**
* adds a slice.
* Add a slice.
* @param endx x component of the last macroblock, can be -1 for the last of the previous line
* @param status the status at the end (MV_END, AC_ERROR, ...), it is assumed that no earlier end or
* error of the same type occurred
......
......@@ -85,13 +85,13 @@ gb
getbitcontext
OPEN_READER(name, gb)
loads gb into local variables
load gb into local variables
CLOSE_READER(name, gb)
stores local vars in gb
store local vars in gb
UPDATE_CACHE(name, gb)
refills the internal cache from the bitstream
refill the internal cache from the bitstream
after this call at least MIN_CACHE_BITS will be available,
GET_CACHE(name, gb)
......@@ -282,7 +282,7 @@ static inline unsigned int get_bits(GetBitContext *s, int n){
}
/**
* Shows 1-25 bits.
* Show 1-25 bits.
*/
static inline unsigned int show_bits(GetBitContext *s, int n){
register int tmp;
......@@ -329,7 +329,7 @@ static inline void skip_bits1(GetBitContext *s){
}
/**
* reads 0-32 bits.
* Read 0-32 bits.
*/
static inline unsigned int get_bits_long(GetBitContext *s, int n){
if (n <= MIN_CACHE_BITS) return get_bits(s, n);
......@@ -345,14 +345,14 @@ static inline unsigned int get_bits_long(GetBitContext *s, int n){
}
/**
* reads 0-32 bits as a signed integer.
* Read 0-32 bits as a signed integer.
*/
static inline int get_sbits_long(GetBitContext *s, int n) {
return sign_extend(get_bits_long(s, n), n);
}
/**
* shows 0-32 bits.
* Show 0-32 bits.
*/
static inline unsigned int show_bits_long(GetBitContext *s, int n){
if (n <= MIN_CACHE_BITS) return show_bits(s, n);
......@@ -372,7 +372,7 @@ static inline int check_marker(GetBitContext *s, const char *msg)
}
/**
* init GetBitContext.
* Inititalize GetBitContext.
* @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger than the actual read bits
* because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
* @param bit_size the size of the buffer in bits
......@@ -434,7 +434,6 @@ void free_vlc(VLC *vlc);
/**
*
* If the vlc code is invalid and max_depth=1, then no bits will be removed.
* If the vlc code is invalid and max_depth>1, then the number of bits removed
* is undefined.
......@@ -496,7 +495,7 @@ void free_vlc(VLC *vlc);
/**
* parses a vlc code, faster than get_vlc()
* Parse a vlc code, faster than get_vlc().
* @param bits is the number of bits which will be read at once, must be
* identical to nb_bits in init_vlc()
* @param max_depth is the number of times bits bits must be read to completely
......
......@@ -97,7 +97,7 @@ static av_cold int h261_decode_init(AVCodecContext *avctx){
}
/**
* decodes the group of blocks header or slice header.
* Decode the group of blocks header or slice header.
* @return <0 if an error occurred
*/
static int h261_decode_gob_header(H261Context *h){
......@@ -150,7 +150,7 @@ static int h261_decode_gob_header(H261Context *h){
}
/**
* decodes the group of blocks / video packet header.
* Decode the group of blocks / video packet header.
* @return <0 if no resync found
*/
static int ff_h261_resync(H261Context *h){
......@@ -191,7 +191,7 @@ static int ff_h261_resync(H261Context *h){
}
/**
* decodes skipped macroblocks
* Decode skipped macroblocks.
* @return 0
*/
static int h261_decode_mb_skipped(H261Context *h, int mba1, int mba2 )
......@@ -355,7 +355,7 @@ intra:
}
/**
* decodes a macroblock
* Decode a macroblock.
* @return <0 if an error occurred
*/
static int h261_decode_block(H261Context * h, DCTELEM * block,
......@@ -437,7 +437,7 @@ static int h261_decode_block(H261Context * h, DCTELEM * block,
}
/**
* decodes the H261 picture header.
* Decode the H.261 picture header.
* @return <0 if no startcode found
*/
static int h261_decode_picture_header(H261Context *h){
......
......@@ -251,7 +251,7 @@ void ff_h261_encode_init(MpegEncContext *s){
/**
* encodes a 8x8 block.
* Encode an 8x8 block.
* @param block the 8x8 block
* @param n block index (0-3 are luma, 4-5 are chroma)
*/
......
......@@ -127,7 +127,7 @@ av_cold int ff_h263_decode_end(AVCodecContext *avctx)
}
/**
* returns the number of bytes consumed for building the current frame
* Return the number of bytes consumed for building the current frame.
*/
static int get_consumed_bytes(MpegEncContext *s, int buf_size){
int pos= (get_bits_count(&s->gb)+7)>>3;
......
......@@ -62,7 +62,8 @@ static const enum PixelFormat hwaccel_pixfmt_list_h264_jpeg_420[] = {
};
/**
* checks if the top & left blocks are available if needed & changes the dc mode so it only uses the available blocks.
* Check if the top & left blocks are available if needed and
* change the dc mode so it only uses the available blocks.
*/
int ff_h264_check_intra4x4_pred_mode(H264Context *h){
MpegEncContext * const s = &h->s;
......@@ -101,7 +102,8 @@ int ff_h264_check_intra4x4_pred_mode(H264Context *h){
} //FIXME cleanup like ff_h264_check_intra_pred_mode
/**
* checks if the top & left blocks are available if needed & changes the dc mode so it only uses the available blocks.
* Check if the top & left blocks are available if needed and
* change the dc mode so it only uses the available blocks.
*/
int ff_h264_check_intra_pred_mode(H264Context *h, int mode){
MpegEncContext * const s = &h->s;
......@@ -2592,7 +2594,7 @@ static void clone_slice(H264Context *dst, H264Context *src)
}
/**
* computes profile from profile_idc and constraint_set?_flags
* Compute profile from profile_idc and constraint_set?_flags.
*
* @param sps SPS
*
......@@ -2619,7 +2621,7 @@ int ff_h264_get_profile(SPS *sps)
}
/**
* decodes a slice header.
* Decode a slice header.
* This will also call MPV_common_init() and frame_start() as needed.
*
* @param h h264context
......@@ -3982,7 +3984,7 @@ static int decode_nal_units(H264Context *h, const uint8_t *buf, int buf_size){
}
/**
* returns the number of bytes consumed for building the current frame
* Return the number of bytes consumed for building the current frame.
*/
static int get_consumed_bytes(MpegEncContext *s, int pos, int buf_size){
if(pos==0) pos=1; //avoid infinite loops (i doubt that is needed but ...)
......
......@@ -762,14 +762,14 @@ static av_always_inline uint16_t pack8to16(int a, int b){
}
/**
* gets the chroma qp.
* Get the chroma qp.
*/
static av_always_inline int get_chroma_qp(H264Context *h, int t, int qscale){
return h->pps.chroma_qp_table[t][qscale];
}
/**
* gets the predicted intra4x4 prediction mode.
* Get the predicted intra4x4 prediction mode.
*/
static av_always_inline int pred_intra_mode(H264Context *h, int n){
const int index8= scan8[n];
......
......@@ -1862,7 +1862,7 @@ static av_always_inline void decode_cabac_luma_residual( H264Context *h, const u
}
/**
* decodes a macroblock
* Decode a macroblock.
* @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
*/
int ff_h264_decode_mb_cabac(H264Context *h) {
......
......@@ -281,7 +281,7 @@ static int8_t cavlc_level_tab[7][1<<LEVEL_TAB_BITS][2];
#define RUN7_VLC_BITS 6
/**
* gets the predicted number of non-zero coefficients.
* Get the predicted number of non-zero coefficients.
* @param n block index
*/
static inline int pred_non_zero_count(H264Context *h, int n){
......@@ -436,7 +436,7 @@ static inline int get_level_prefix(GetBitContext *gb){
}
/**
* decodes a residual block.
* Decode a residual block.
* @param n block index
* @param scantable scantable
* @param max_coeff number of coefficients in the block
......
......@@ -86,7 +86,7 @@ static av_always_inline int fetch_diagonal_mv(H264Context *h, const int16_t **C,
}
/**
* gets the predicted MV.
* Get the predicted MV.
* @param n the block index
* @param part_width the width of the partition (4, 8,16) -> (1, 2, 4)
* @param mx the x component of the predicted motion vector
......@@ -142,7 +142,7 @@ static av_always_inline void pred_motion(H264Context * const h, int n, int part_
}
/**
* gets the directionally predicted 16x8 MV.
* Get the directionally predicted 16x8 MV.
* @param n the block index
* @param mx the x component of the predicted motion vector
* @param my the y component of the predicted motion vector
......@@ -177,7 +177,7 @@ static av_always_inline void pred_16x8_motion(H264Context * const h, int n, int
}
/**
* gets the directionally predicted 8x16 MV.
* Get the directionally predicted 8x16 MV.
* @param n the block index
* @param mx the x component of the predicted motion vector
* @param my the y component of the predicted motion vector
......
......@@ -148,7 +148,7 @@ int ff_h263_decode_mba(MpegEncContext *s)
}
/**
* decodes the group of blocks header or slice header.
* Decode the group of blocks header or slice header.
* @return <0 if an error occurred
*/
static int h263_decode_gob_header(MpegEncContext *s)
......@@ -203,7 +203,7 @@ static int h263_decode_gob_header(MpegEncContext *s)
}
/**
* finds the next resync_marker
* Find the next resync_marker.
* @param p pointer to buffer to scan
* @param end pointer to the end of the buffer
* @return pointer to the next resync_marker, or end if none was found
......@@ -224,7 +224,7 @@ const uint8_t *ff_h263_find_resync_marker(const uint8_t *restrict p, const uint8
}
/**
* decodes the group of blocks / video packet header.
* Decode the group of blocks / video packet header.
* @return bit position of the resync_marker, or <0 if none was found
*/
int ff_h263_resync(MpegEncContext *s){
......@@ -306,7 +306,7 @@ int h263_decode_motion(MpegEncContext * s, int pred, int f_code)
}
/* Decodes RVLC of H.263+ UMV */
/* Decode RVLC of H.263+ UMV */
static int h263p_decode_umotion(MpegEncContext * s, int pred)
{
int code = 0, sign;
......
......@@ -302,7 +302,7 @@ void ff_clean_h263_qscales(MpegEncContext *s){
static const int dquant_code[5]= {1,0,9,2,3};
/**
* encodes a 8x8 block.
* Encode an 8x8 block.
* @param block the 8x8 block
* @param n block index (0-3 are luma, 4-5 are chroma)
*/
......
......@@ -36,7 +36,7 @@ typedef struct LATMParseContext{
} LATMParseContext;
/**
* finds the end of the current frame in the bitstream.
* Find the end of the current frame in the bitstream.
* @return the position of the first byte of the next frame, or -1
*/
static int latm_find_frame_end(AVCodecParserContext *s1, const uint8_t *buf,
......
......@@ -30,7 +30,7 @@
/**
* finds the end of the current frame in the bitstream.
* Find the end of the current frame in the bitstream.
* @return the position of the first byte of the next frame, or -1
*/
static int find_frame_end(ParseContext *pc, const uint8_t *buf, int buf_size){
......
......@@ -1619,9 +1619,10 @@ static int mpeg_field_start(MpegEncContext *s, const uint8_t *buf, int buf_size)
#define DECODE_SLICE_OK 0
/**
* decodes a slice. MpegEncContext.mb_y must be set to the MB row from the startcode
* @return DECODE_SLICE_ERROR if the slice is damaged<br>
* DECODE_SLICE_OK if this slice is ok<br>
* Decode a slice.
* MpegEncContext.mb_y must be set to the MB row from the startcode.
* @return DECODE_SLICE_ERROR if the slice is damaged,
* DECODE_SLICE_OK if this slice is OK
*/
static int mpeg_decode_slice(MpegEncContext *s, int mb_y,
const uint8_t **buf, int buf_size)
......
......@@ -119,7 +119,7 @@ extern uint8_t ff_mpeg4_static_rl_table_store[3][2][2*MAX_RUN + MAX_LEVEL + 3];
/**
* predicts the dc.
* Predict the dc.
* encoding quantized level -> quantized diff
* decoding quantized diff -> quantized level
* @param n block index (0-3 are luma, 4-5 are chroma)
......
......@@ -26,7 +26,7 @@
#include "parser.h"
/**
* finds the end of the current frame in the bitstream.
* Find the end of the current frame in the bitstream.
* @return the position of the first byte of the next frame, or -1
*/
int ff_mpeg4_find_frame_end(ParseContext *pc, const uint8_t *buf, int buf_size);
......
......@@ -46,7 +46,7 @@ static const int mb_type_b_map[4]= {
};
/**
* predicts the ac.
* Predict the ac.
* @param n block index (0-3 are luma, 4-5 are chroma)
* @param dir the ac prediction direction
*/
......@@ -343,7 +343,7 @@ static void mpeg4_decode_sprite_trajectory(MpegEncContext * s, GetBitContext *gb
}
/**
* decodes the next video packet.
* Decode the next video packet.
* @return <0 if something went wrong
*/
int mpeg4_decode_video_packet_header(MpegEncContext *s)
......@@ -439,7 +439,7 @@ int mpeg4_decode_video_packet_header(MpegEncContext *s)
}
/**
* gets the average motion vector for a GMC MB.
* Get the average motion vector for a GMC MB.
* @param n either 0 for the x component or 1 for y
* @return the average MV for a GMC MB
*/
......@@ -485,7 +485,7 @@ static inline int get_amv(MpegEncContext *s, int n){
}
/**
* decodes the dc value.
* Decode the dc value.
* @param n block index (0-3 are luma, 4-5 are chroma)
* @param dir_ptr the prediction direction will be stored here
* @return the quantized dc
......@@ -532,7 +532,7 @@ static inline int mpeg4_decode_dc(MpegEncContext * s, int n, int *dir_ptr)
}
/**
* decodes first partition.
* Decode first partition.
* @return number of MBs decoded or <0 if an error occurred
*/
static int mpeg4_decode_partition_a(MpegEncContext *s){
......@@ -784,7 +784,7 @@ static int mpeg4_decode_partition_b(MpegEncContext *s, int mb_count){
}
/**
* decodes the first & second partition
* Decode the first and second partition.
* @return <0 if error (and sets error type in the error_status_table)
*/
int ff_mpeg4_decode_partitions(MpegEncContext *s)
......@@ -837,7 +837,7 @@ int ff_mpeg4_decode_partitions(MpegEncContext *s)
}
/**
* decodes a block.
* Decode a block.
* @return <0 if an error occurred
*/
static inline int mpeg4_decode_block(MpegEncContext * s, DCTELEM * block,
......@@ -1824,7 +1824,7 @@ no_cplx_est:
}
/**
* decodes the user data stuff in the header.
* Decode the user data stuff in the header.
* Also initializes divx/xvid/lavc_version/build.
*/
static int decode_user_data(MpegEncContext *s, GetBitContext *gb){
......@@ -2094,7 +2094,7 @@ static int decode_vop_header(MpegEncContext *s, GetBitContext *gb){
}
/**
* decode mpeg4 headers
* Decode mpeg4 headers.
* @return <0 if no VOP found (or a damaged one)
* FRAME_SKIPPED if a not coded VOP is found
* 0 if a VOP is found
......
......@@ -238,7 +238,7 @@ void ff_clean_mpeg4_qscales(MpegEncContext *s){
/**
* encodes the dc value.
* Encode the dc value.
* @param n block index (0-3 are luma, 4-5 are chroma)
*/
static inline void mpeg4_encode_dc(PutBitContext * s, int level, int n)
......@@ -291,7 +291,7 @@ static inline int mpeg4_get_dc_length(int level, int n){
}
/**
* encodes a 8x8 block
* Encode an 8x8 block.
* @param n block index (0-3 are luma, 4-5 are chroma)
*/
static inline void mpeg4_encode_block(MpegEncContext * s, DCTELEM * block, int n, int intra_dc,
......
......@@ -289,7 +289,7 @@ static int alloc_frame_buffer(MpegEncContext *s, Picture *pic)
}
/**
* allocates a Picture
* Allocate a Picture.
* The pixels are allocated/set by calling get_buffer() if shared = 0
*/
int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared)
......@@ -388,7 +388,7 @@ fail: // for the FF_ALLOCZ_OR_GOTO macro
}
/**
* deallocates a picture
* Deallocate a picture.
*/
static void free_picture(MpegEncContext *s, Picture *pic)
{
......@@ -624,9 +624,9 @@ int ff_mpeg_update_thread_context(AVCodecContext *dst,
}
/**
* sets the given MpegEncContext to common defaults
* Set the given MpegEncContext to common defaults
* (same for encoding and decoding).
* the changed fields will not depend upon the
* The changed fields will not depend upon the
* prior state of the MpegEncContext.
*/
void MPV_common_defaults(MpegEncContext *s)
......@@ -652,7 +652,7 @@ void MPV_common_defaults(MpegEncContext *s)
}
/**
* sets the given MpegEncContext to defaults for decoding.
* Set the given MpegEncContext to defaults for decoding.
* the changed fields will not depend upon
* the prior state of the MpegEncContext.
*/
......@@ -1400,7 +1400,7 @@ void MPV_frame_end(MpegEncContext *s)
}
/**
* draws an line from (ex, ey) -> (sx, sy).
* Draw a line from (ex, ey) -> (sx, sy).
* @param w width of the image
* @param h height of the image
* @param stride stride/linesize of the image
......@@ -1449,7 +1449,7 @@ static void draw_line(uint8_t *buf, int sx, int sy, int ex, int ey, int w, int h
}
/**
* draws an arrow from (ex, ey) -> (sx, sy).
* Draw an arrow from (ex, ey) -> (sx, sy).
* @param w width of the image
* @param h height of the image
* @param stride stride/linesize of the image
......@@ -1482,7 +1482,7 @@ static void draw_arrow(uint8_t *buf, int sx, int sy, int ex, int ey, int w, int
}
/**
* prints debuging info for the given picture.
* Print debuging info for the given picture.
*/
void ff_print_debug_info(MpegEncContext *s, AVFrame *pict){
......@@ -2127,7 +2127,7 @@ static inline void add_dequant_dct(MpegEncContext *s,
}
/**
* cleans dc, ac, coded_block for the current non intra MB
* Clean dc, ac, coded_block for the current non-intra MB.
*/
void ff_clean_intra_table_entries(MpegEncContext *s)
{
......@@ -2432,7 +2432,6 @@ void MPV_decode_mb(MpegEncContext *s, DCTELEM block[12][64]){
}
/**
*
* @param h is the normal height, this will be reduced automatically if needed for the last row
*/
void ff_draw_horiz_band(MpegEncContext *s, int y, int h){
......
......@@ -728,8 +728,8 @@ void ff_init_block_index(MpegEncContext *s);
void ff_copy_picture(Picture *dst, Picture *src);
/**
* allocates a Picture
* The pixels are allocated/set by calling get_buffer() if shared=0
* Allocate a Picture.
* The pixels are allocated/set by calling get_buffer() if shared = 0.
*/
int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared);
......
......@@ -42,14 +42,14 @@
int dct_quantize_c(MpegEncContext *s, DCTELEM *block, int n, int qscale, int *overflow);
/**
* allocates a Picture
* The pixels are allocated/set by calling get_buffer() if shared=0
* Allocate a Picture.
* The pixels are allocated/set by calling get_buffer() if shared = 0.
*/
int alloc_picture(MpegEncContext *s, Picture *pic, int shared);
/**
* sets the given MpegEncContext to common defaults (same for encoding and decoding).
* the changed fields will not depend upon the prior state of the MpegEncContext.
* Set the given MpegEncContext to common defaults (same for encoding and decoding).
* The changed fields will not depend upon the prior state of the MpegEncContext.
*/
void MPV_common_defaults(MpegEncContext *s);
......
......@@ -227,7 +227,7 @@ static void update_duplicate_context_after_me(MpegEncContext *dst, MpegEncContex
}
/**
* sets the given MpegEncContext to defaults for encoding.
* Set the given MpegEncContext to defaults for encoding.
* the changed fields will not depend upon the prior state of the MpegEncContext.
*/
static void MPV_encode_defaults(MpegEncContext *s){
......
......@@ -216,7 +216,7 @@ void av_parser_close(AVCodecParserContext *s)
/*****************************************************/
/**
* combines the (truncated) bitstream to a complete frame
* Combine the (truncated) bitstream to a complete frame.
* @return -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
*/
int ff_combine_frame(ParseContext *pc, int next, const uint8_t **buf, int *buf_size)
......
......@@ -322,7 +322,7 @@ static attribute_align_arg void *frame_worker_thread(void *arg)
}
/**
* Updates the next thread's AVCodecContext with values from the reference thread's context.
* Update the next thread's AVCodecContext with values from the reference thread's context.
*
* @param dst The destination context.
* @param src The source context.
......
......@@ -300,7 +300,7 @@ int ff_vbv_update(MpegEncContext *s, int frame_size){
}
/**
* modifies the bitrate curve from pass1 for one frame
* Modify the bitrate curve from pass1 for one frame.
*/
static double get_qscale(MpegEncContext *s, RateControlEntry *rce, double rate_factor, int frame_num){
RateControlContext *rcc= &s->rc_context;
......@@ -404,7 +404,7 @@ static double get_diff_limited_q(MpegEncContext *s, RateControlEntry *rce, doubl
}
/**
* gets the qmin & qmax for pict_type
* Get the qmin & qmax for pict_type.
*/
static void get_qminmax(int *qmin_ret, int *qmax_ret, MpegEncContext *s, int pict_type){
int qmin= s->avctx->lmin;
......
......@@ -90,7 +90,7 @@ static double bessel(double x){
}
/**
* builds a polyphase filterbank.
* Build a polyphase filterbank.
* @param factor resampling factor
* @param scale wanted sum of coefficients for each filter
* @param type 0->cubic, 1->blackman nuttall windowed sinc, 2..16->kaiser windowed sinc beta=2..16
......
......@@ -31,15 +31,15 @@
#include "avcodec.h"
/**
* Waits for decoding threads to finish and resets internal
* state. Called by avcodec_flush_buffers().
* Wait for decoding threads to finish and reset internal state.
* Called by avcodec_flush_buffers().
*
* @param avctx The context.
*/
void ff_thread_flush(AVCodecContext *avctx);
/**
* Submits a new frame to a decoding thread.
* Submit a new frame to a decoding thread.
* Returns the next available frame in picture. *got_picture_ptr
* will be 0 if none is available.
* The return value on success is the size of the consumed packet for
......@@ -62,8 +62,7 @@ int ff_thread_decode_frame(AVCodecContext *avctx, AVFrame *picture,
void ff_thread_finish_setup(AVCodecContext *avctx);
/**
* Notifies later decoding threads when part of their reference picture
* is ready.