summaryrefslogtreecommitdiff
path: root/libavcodec
diff options
context:
space:
mode:
authorMåns Rullgård <mans@mansr.com>2010-06-30 15:38:06 +0000
committerMåns Rullgård <mans@mansr.com>2010-06-30 15:38:06 +0000
commit49bd8e4b843d9a92fdb8ef4361a551a1e019c65d (patch)
tree3004e5605d2b5328b3cba95b884327f9bcfd3aca /libavcodec
parent38e23c88db9a6b1ce15a2eca431b824f65b214bc (diff)
Fix grammar errors in documentation
Originally committed as revision 23904 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec')
-rw-r--r--libavcodec/aac_parser.h4
-rw-r--r--libavcodec/ac3.c4
-rw-r--r--libavcodec/ac3.h6
-rw-r--r--libavcodec/ac3_parser.h8
-rw-r--r--libavcodec/ac3tab.c4
-rw-r--r--libavcodec/allcodecs.c4
-rw-r--r--libavcodec/alsdec.c44
-rw-r--r--libavcodec/avcodec.h95
-rw-r--r--libavcodec/avfft.h2
-rw-r--r--libavcodec/bgmc.c12
-rw-r--r--libavcodec/bink.c18
-rw-r--r--libavcodec/cavsdata.h6
-rw-r--r--libavcodec/celp_math.h2
-rw-r--r--libavcodec/dirac.h2
-rw-r--r--libavcodec/dirac_parser.c2
-rw-r--r--libavcodec/dsputil.c2
-rw-r--r--libavcodec/fft.h8
-rw-r--r--libavcodec/flacenc.c6
-rw-r--r--libavcodec/h261enc.c2
-rw-r--r--libavcodec/h263.h6
-rw-r--r--libavcodec/h264.c2
-rw-r--r--libavcodec/h264.h22
-rw-r--r--libavcodec/h264pred.c2
-rw-r--r--libavcodec/idcinvideo.c2
-rw-r--r--libavcodec/iff.c2
-rw-r--r--libavcodec/indeo5.c18
-rw-r--r--libavcodec/internal.h4
-rw-r--r--libavcodec/ituh263enc.c4
-rw-r--r--libavcodec/ivi_common.c2
-rw-r--r--libavcodec/ivi_common.h40
-rw-r--r--libavcodec/ivi_dsp.h6
-rw-r--r--libavcodec/libtheoraenc.c2
-rw-r--r--libavcodec/libxvidff.c14
-rw-r--r--libavcodec/lpc.c2
-rw-r--r--libavcodec/lpc.h2
-rw-r--r--libavcodec/lsp.h4
-rw-r--r--libavcodec/mlpdec.c4
-rw-r--r--libavcodec/mpeg12.c4
-rw-r--r--libavcodec/mpeg4videoenc.c6
-rw-r--r--libavcodec/mpegvideo.c4
-rw-r--r--libavcodec/mpegvideo_xvmc.c12
-rw-r--r--libavcodec/msrledec.h2
-rw-r--r--libavcodec/nellymoserenc.c2
-rw-r--r--libavcodec/opt.h4
-rw-r--r--libavcodec/parser.h2
-rw-r--r--libavcodec/pgssubdec.c10
-rw-r--r--libavcodec/ppc/check_altivec.c2
-rw-r--r--libavcodec/put_bits.h24
-rw-r--r--libavcodec/qcelpdec.c14
-rw-r--r--libavcodec/qdm2.c4
-rw-r--r--libavcodec/qtrleenc.c4
-rw-r--r--libavcodec/ra144enc.c16
-rw-r--r--libavcodec/roqvideoenc.c10
-rw-r--r--libavcodec/sipr.c6
-rw-r--r--libavcodec/twinvq.c4
-rw-r--r--libavcodec/utils.c2
-rw-r--r--libavcodec/vaapi_h264.c18
-rw-r--r--libavcodec/vaapi_vc1.c10
-rw-r--r--libavcodec/vp3.c4
-rw-r--r--libavcodec/wmavoice.c2
-rw-r--r--libavcodec/x86/vc1dsp_mmx.c2
-rw-r--r--libavcodec/xiph.h2
-rw-r--r--libavcodec/xsubenc.c4
-rw-r--r--libavcodec/xvmc.h2
-rw-r--r--libavcodec/yop.c8
65 files changed, 276 insertions, 277 deletions
diff --git a/libavcodec/aac_parser.h b/libavcodec/aac_parser.h
index 8dd575bb39..76880095b9 100644
--- a/libavcodec/aac_parser.h
+++ b/libavcodec/aac_parser.h
@@ -41,8 +41,8 @@ typedef struct {
} AACADTSHeaderInfo;
/**
- * Parses AAC frame header.
- * Parses the ADTS frame header to the end of the variable header, which is
+ * Parse AAC frame header.
+ * Parse the ADTS frame header to the end of the variable header, which is
* the first 54 bits.
* @param gbc[in] BitContext containing the first 54 bits of the frame.
* @param hdr[out] Pointer to struct where header info is written.
diff --git a/libavcodec/ac3.c b/libavcodec/ac3.c
index 3fce5bcfb9..1f5ab32eb8 100644
--- a/libavcodec/ac3.c
+++ b/libavcodec/ac3.c
@@ -42,7 +42,7 @@ static const uint8_t band_start_tab[51] = {
};
/**
- * Maps each frequency coefficient bin to the critical band that contains it.
+ * Map each frequency coefficient bin to the critical band that contains it.
*/
static const uint8_t bin_to_band_tab[253] = {
0,
@@ -261,7 +261,7 @@ void ac3_parametric_bit_allocation(AC3BitAllocParameters *s, uint8_t *bap,
}
/**
- * Initializes some tables.
+ * Initialize some tables.
* note: This function must remain thread safe because it is called by the
* AVParser init code.
*/
diff --git a/libavcodec/ac3.h b/libavcodec/ac3.h
index 0def3b06cc..9c8dc4870e 100644
--- a/libavcodec/ac3.h
+++ b/libavcodec/ac3.h
@@ -114,7 +114,7 @@ typedef enum {
void ac3_common_init(void);
/**
- * Calculates the log power-spectral density of the input signal.
+ * Calculate the log power-spectral density of the input signal.
* This gives a rough estimate of signal power in the frequency domain by using
* the spectral envelope (exponents). The psd is also separately grouped
* into critical bands for use in the calculating the masking curve.
@@ -131,7 +131,7 @@ void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
int16_t *band_psd);
/**
- * Calculates the masking curve.
+ * Calculate the masking curve.
* First, the excitation is calculated using parameters in s and the signal
* power in each critical band. The excitation is compared with a predefined
* hearing threshold table to produce the masking curve. If delta bit
@@ -159,7 +159,7 @@ int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
int16_t *mask);
/**
- * Calculates bit allocation pointers.
+ * Calculate bit allocation pointers.
* The SNR is the difference between the masking curve and the signal. AC-3
* uses this value for each frequency bin to allocate bits. The snroffset
* parameter is a global adjustment to the SNR for all bins.
diff --git a/libavcodec/ac3_parser.h b/libavcodec/ac3_parser.h
index 766c68b2bc..757cb1582c 100644
--- a/libavcodec/ac3_parser.h
+++ b/libavcodec/ac3_parser.h
@@ -27,8 +27,8 @@
#include "get_bits.h"
/**
- * Parses AC-3 frame header.
- * Parses the header up to the lfeon element, which is the first 52 or 54 bits
+ * Parse AC-3 frame header.
+ * Parse the header up to the lfeon element, which is the first 52 or 54 bits
* depending on the audio coding mode.
* @param gbc[in] BitContext containing the first 54 bits of the frame.
* @param hdr[out] Pointer to struct where header info is written.
@@ -39,8 +39,8 @@
int ff_ac3_parse_header(GetBitContext *gbc, AC3HeaderInfo *hdr);
/**
- * Parses AC-3 frame header and sets channel_map
- * Parses the header up to the lfeon (channel_map in E-AC-3)
+ * Parse AC-3 frame header and sets channel_map
+ * Parse the header up to the lfeon (channel_map in E-AC-3)
* element, which is the first 52, 54 or 104 bits depending
* on the audio coding mode.
* @param gbc[in] BitContext containing the first 54 bits of the frame.
diff --git a/libavcodec/ac3tab.c b/libavcodec/ac3tab.c
index 4f28fb3d39..76f6245ba0 100644
--- a/libavcodec/ac3tab.c
+++ b/libavcodec/ac3tab.c
@@ -73,7 +73,7 @@ const uint16_t ff_ac3_frame_size_tab[38][3] = {
};
/**
- * Maps audio coding mode (acmod) to number of full-bandwidth channels.
+ * Map audio coding mode (acmod) to number of full-bandwidth channels.
* from ATSC A/52 Table 5.8 Audio Coding Mode
*/
const uint8_t ff_ac3_channels_tab[8] = {
@@ -81,7 +81,7 @@ const uint8_t ff_ac3_channels_tab[8] = {
};
/**
- * Maps audio coding mode (acmod) to channel layout mask.
+ * Map audio coding mode (acmod) to channel layout mask.
*/
const uint16_t ff_ac3_channel_layout_tab[8] = {
CH_LAYOUT_STEREO,
diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c
index 0e3b9b3666..ccede8b0ac 100644
--- a/libavcodec/allcodecs.c
+++ b/libavcodec/allcodecs.c
@@ -1,5 +1,5 @@
/*
- * Provides registration of all codecs, parsers and bitstream filters for libavcodec.
+ * Provide registration of all codecs, parsers and bitstream filters for libavcodec.
* Copyright (c) 2002 Fabrice Bellard
*
* This file is part of FFmpeg.
@@ -21,7 +21,7 @@
/**
* @file
- * Provides registration of all codecs, parsers and bitstream filters for libavcodec.
+ * Provide registration of all codecs, parsers and bitstream filters for libavcodec.
*/
#include "avcodec.h"
diff --git a/libavcodec/alsdec.c b/libavcodec/alsdec.c
index 3bfe9e0cff..6040ce34b6 100644
--- a/libavcodec/alsdec.c
+++ b/libavcodec/alsdec.c
@@ -271,7 +271,7 @@ static av_cold void dprint_specific_config(ALSDecContext *ctx)
}
-/** Reads an ALSSpecificConfig from a buffer into the output struct.
+/** Read an ALSSpecificConfig from a buffer into the output struct.
*/
static av_cold int read_specific_config(ALSDecContext *ctx)
{
@@ -406,7 +406,7 @@ static av_cold int read_specific_config(ALSDecContext *ctx)
}
-/** Checks the ALSSpecificConfig for unsupported features.
+/** Check the ALSSpecificConfig for unsupported features.
*/
static int check_specific_config(ALSDecContext *ctx)
{
@@ -430,7 +430,7 @@ static int check_specific_config(ALSDecContext *ctx)
}
-/** Parses the bs_info field to extract the block partitioning used in
+/** Parse the bs_info field to extract the block partitioning used in
* block switching mode, refer to ISO/IEC 14496-3, section 11.6.2.
*/
static void parse_bs_info(const uint32_t bs_info, unsigned int n,
@@ -454,7 +454,7 @@ static void parse_bs_info(const uint32_t bs_info, unsigned int n,
}
-/** Reads and decodes a Rice codeword.
+/** Read and decodes a Rice codeword.
*/
static int32_t decode_rice(GetBitContext *gb, unsigned int k)
{
@@ -472,7 +472,7 @@ static int32_t decode_rice(GetBitContext *gb, unsigned int k)
}
-/** Converts PARCOR coefficient k to direct filter coefficient.
+/** Convert PARCOR coefficient k to direct filter coefficient.
*/
static void parcor_to_lpc(unsigned int k, const int32_t *par, int32_t *cof)
{
@@ -490,7 +490,7 @@ static void parcor_to_lpc(unsigned int k, const int32_t *par, int32_t *cof)
}
-/** Reads block switching field if necessary and sets actual block sizes.
+/** Read block switching field if necessary and sets actual block sizes.
* Also assures that the block sizes of the last frame correspond to the
* actual number of samples.
*/
@@ -545,7 +545,7 @@ static void get_block_sizes(ALSDecContext *ctx, unsigned int *div_blocks,
}
-/** Reads the block data for a constant block
+/** Read the block data for a constant block
*/
static void read_const_block_data(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -570,7 +570,7 @@ static void read_const_block_data(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Decodes the block data for a constant block
+/** Decode the block data for a constant block
*/
static void decode_const_block_data(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -584,7 +584,7 @@ static void decode_const_block_data(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Reads the block data for a non-constant block
+/** Read the block data for a non-constant block
*/
static int read_var_block_data(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -831,7 +831,7 @@ static int read_var_block_data(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Decodes the block data for a non-constant block
+/** Decode the block data for a non-constant block
*/
static int decode_var_block_data(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -940,7 +940,7 @@ static int decode_var_block_data(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Reads the block data.
+/** Read the block data.
*/
static int read_block(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -958,7 +958,7 @@ static int read_block(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Decodes the block data.
+/** Decode the block data.
*/
static int decode_block(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -980,7 +980,7 @@ static int decode_block(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Reads and decodes block data successively.
+/** Read and decodes block data successively.
*/
static int read_decode_block(ALSDecContext *ctx, ALSBlockData *bd)
{
@@ -997,7 +997,7 @@ static int read_decode_block(ALSDecContext *ctx, ALSBlockData *bd)
}
-/** Computes the number of samples left to decode for the current frame and
+/** Compute the number of samples left to decode for the current frame and
* sets these samples to zero.
*/
static void zero_remaining(unsigned int b, unsigned int b_max,
@@ -1013,7 +1013,7 @@ static void zero_remaining(unsigned int b, unsigned int b_max,
}
-/** Decodes blocks independently.
+/** Decode blocks independently.
*/
static int decode_blocks_ind(ALSDecContext *ctx, unsigned int ra_frame,
unsigned int c, const unsigned int *div_blocks,
@@ -1051,7 +1051,7 @@ static int decode_blocks_ind(ALSDecContext *ctx, unsigned int ra_frame,
}
-/** Decodes blocks dependently.
+/** Decode blocks dependently.
*/
static int decode_blocks(ALSDecContext *ctx, unsigned int ra_frame,
unsigned int c, const unsigned int *div_blocks,
@@ -1132,7 +1132,7 @@ static int decode_blocks(ALSDecContext *ctx, unsigned int ra_frame,
}
-/** Reads the channel data.
+/** Read the channel data.
*/
static int read_channel_data(ALSDecContext *ctx, ALSChannelData *cd, int c)
{
@@ -1260,7 +1260,7 @@ static int revert_channel_correlation(ALSDecContext *ctx, ALSBlockData *bd,
}
-/** Reads the frame data.
+/** Read the frame data.
*/
static int read_frame_data(ALSDecContext *ctx, unsigned int ra_frame)
{
@@ -1389,7 +1389,7 @@ static int read_frame_data(ALSDecContext *ctx, unsigned int ra_frame)
}
-/** Decodes an ALS frame.
+/** Decode an ALS frame.
*/
static int decode_frame(AVCodecContext *avctx,
void *data, int *data_size,
@@ -1511,7 +1511,7 @@ static int decode_frame(AVCodecContext *avctx,
}
-/** Uninitializes the ALS decoder.
+/** Uninitialize the ALS decoder.
*/
static av_cold int decode_end(AVCodecContext *avctx)
{
@@ -1541,7 +1541,7 @@ static av_cold int decode_end(AVCodecContext *avctx)
}
-/** Initializes the ALS decoder.
+/** Initialize the ALS decoder.
*/
static av_cold int decode_init(AVCodecContext *avctx)
{
@@ -1693,7 +1693,7 @@ static av_cold int decode_init(AVCodecContext *avctx)
}
-/** Flushes (resets) the frame ID after seeking.
+/** Flush (reset) the frame ID after seeking.
*/
static av_cold void flush(AVCodecContext *avctx)
{
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 0389915141..8aaed2cbc5 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -48,7 +48,7 @@
#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
/**
- * Identifies the syntax and semantics of the bitstream.
+ * Identifie the syntax and semantics of the bitstream.
* The principle is roughly:
* Two decoders with the same ID can decode the same streams.
* Two encoders with the same ID can encode compatible streams.
@@ -2951,7 +2951,7 @@ attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, i
int output_rate, int input_rate);
#endif
/**
- * Initializes audio resampling context
+ * Initialize audio resampling context
*
* @param output_channels number of output channels
* @param input_channels number of input channels
@@ -2978,7 +2978,7 @@ void audio_resample_close(ReSampleContext *s);
/**
- * Initializes an audio resampler.
+ * Initialize an audio resampler.
* Note, if either rate is not an integer then simply scale both rates up so they are.
* @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
* @param log2_phase_count log2 of the number of entries in the polyphase filterbank
@@ -3001,7 +3001,7 @@ int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consum
/**
- * Compensates samplerate/timestamp drift. The compensation is done by changing
+ * Compensate samplerate/timestamp drift. The compensation is done by changing
* the resampler parameters, so no audible clicks or similar distortions occur
* @param compensation_distance distance in output samples over which the compensation should be performed
* @param sample_delta number of output samples which should be output less
@@ -3074,15 +3074,15 @@ void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
#if LIBAVCODEC_VERSION_MAJOR < 53
/**
- * Returns the pixel format corresponding to the name name.
+ * Return the pixel format corresponding to the name name.
*
- * If there is no pixel format with name name, then looks for a
+ * If there is no pixel format with name name, then look for a
* pixel format with the name corresponding to the native endian
* format of name.
- * For example in a little-endian system, first looks for "gray16",
+ * For example in a little-endian system, first look for "gray16",
* then for "gray16le".
*
- * Finally if no pixel format has been found, returns PIX_FMT_NONE.
+ * Finally if no pixel format has been found, return PIX_FMT_NONE.
*
* @deprecated Deprecated in favor of av_get_pix_fmt().
*/
@@ -3090,14 +3090,14 @@ attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
#endif
/**
- * Returns a value representing the fourCC code associated to the
+ * Return a value representing the fourCC code associated to the
* pixel format pix_fmt, or 0 if no associated fourCC code can be
* found.
*/
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
/**
- * Puts a string representing the codec tag codec_tag in buf.
+ * Put a string representing the codec tag codec_tag in buf.
*
* @param buf_size size in bytes of buf
* @return the length of the string that would have been generated if
@@ -3113,7 +3113,7 @@ size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_ta
#define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
/**
- * Computes what kind of losses will occur when converting from one specific
+ * Compute what kind of losses will occur when converting from one specific
* pixel format to another.
* When converting from one pixel format to another, information loss may occur.
* For example, when converting from RGB24 to GRAY, the color information will
@@ -3133,7 +3133,7 @@ int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_
int has_alpha);
/**
- * Finds the best pixel format to convert to given a certain source pixel
+ * Find the best pixel format to convert to given a certain source pixel
* format. When converting from one pixel format to another, information loss
* may occur. For example, when converting from RGB24 to GRAY, the color
* information will be lost. Similarly, other losses occur when converting from
@@ -3195,22 +3195,22 @@ int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
AVCodec *av_codec_next(AVCodec *c);
/**
- * Returns the LIBAVCODEC_VERSION_INT constant.
+ * Return the LIBAVCODEC_VERSION_INT constant.
*/
unsigned avcodec_version(void);
/**
- * Returns the libavcodec build-time configuration.
+ * Return the libavcodec build-time configuration.
*/
const char *avcodec_configuration(void);
/**
- * Returns the libavcodec license.
+ * Return the libavcodec license.
*/
const char *avcodec_license(void);
/**
- * Initializes libavcodec.
+ * Initialize libavcodec.
*
* @warning This function must be called before any other libavcodec
* function.
@@ -3232,7 +3232,7 @@ attribute_deprecated void register_avcodec(AVCodec *codec);
void avcodec_register(AVCodec *codec);
/**
- * Finds a registered encoder with a matching codec ID.
+ * Find a registered encoder with a matching codec ID.
*
* @param id CodecID of the requested encoder
* @return An encoder if one was found, NULL otherwise.
@@ -3240,7 +3240,7 @@ void avcodec_register(AVCodec *codec);
AVCodec *avcodec_find_encoder(enum CodecID id);
/**
- * Finds a registered encoder with the specified name.
+ * Find a registered encoder with the specified name.
*
* @param name name of the requested encoder
* @return An encoder if one was found, NULL otherwise.
@@ -3248,7 +3248,7 @@ AVCodec *avcodec_find_encoder(enum CodecID id);
AVCodec *avcodec_find_encoder_by_name(const char *name);
/**
- * Finds a registered decoder with a matching codec ID.
+ * Find a registered decoder with a matching codec ID.
*
* @param id CodecID of the requested decoder
* @return A decoder if one was found, NULL otherwise.
@@ -3256,7 +3256,7 @@ AVCodec *avcodec_find_encoder_by_name(const char *name);
AVCodec *avcodec_find_decoder(enum CodecID id);
/**
- * Finds a registered decoder with the specified name.
+ * Find a registered decoder with the specified name.
*
* @param name name of the requested decoder
* @return A decoder if one was found, NULL otherwise.
@@ -3265,7 +3265,7 @@ AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
/**
- * Sets the fields of the given AVCodecContext to default values.
+ * Set the fields of the given AVCodecContext to default values.
*
* @param s The AVCodecContext of which the fields should be set to default values.
*/
@@ -3276,7 +3276,7 @@ void avcodec_get_context_defaults(AVCodecContext *s);
void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
/**
- * Allocates an AVCodecContext and sets its fields to default values. The
+ * Allocate an AVCodecContext and set its fields to default values. The
* resulting struct can be deallocated by simply calling av_free().
*
* @return An AVCodecContext filled with default values or NULL on failure.
@@ -3302,14 +3302,14 @@ AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
/**
- * Sets the fields of the given AVFrame to default values.
+ * Set the fields of the given AVFrame to default values.
*
* @param pic The AVFrame of which the fields should be set to default values.
*/
void avcodec_get_frame_defaults(AVFrame *pic);
/**
- * Allocates an AVFrame and sets its fields to default values. The resulting
+ * Allocate an AVFrame and set its fields to default values. The resulting
* struct can be deallocated by simply calling av_free().
*
* @return An AVFrame filled with default values or NULL on failure.
@@ -3322,7 +3322,7 @@ void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
/**
- * Returns the amount of padding in pixels which the get_buffer callback must
+ * Return the amount of padding in pixels which the get_buffer callback must
* provide around the edge of the image for codecs which do not have the
* CODEC_FLAG_EMU_EDGE flag.
*
@@ -3330,7 +3330,7 @@ int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
*/
unsigned avcodec_get_edge_width(void);
/**
- * Modifies width and height values so that they will result in a memory
+ * Modify width and height values so that they will result in a memory
* buffer that is acceptable for the codec if you do not use any horizontal
* padding.
*
@@ -3340,7 +3340,7 @@ unsigned avcodec_get_edge_width(void);
*/
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
/**
- * Modifies width and height values so that they will result in a memory
+ * Modify width and height values so that they will result in a memory
* buffer that is acceptable for the codec if you also ensure that all
* line sizes are a multiple of the respective linesize_align[i].
*
@@ -3352,7 +3352,7 @@ void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
int linesize_align[4]);
/**
- * Checks if the given dimension of a picture is valid, meaning that all
+ * Check if the given dimension of a picture is valid, meaning that all
* bytes of the picture can be addressed with a signed int.
*
* @param[in] w Width of the picture.
@@ -3369,7 +3369,7 @@ int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2,
//FIXME func typedef
/**
- * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
+ * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
* function the context has to be allocated.
*
* The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
@@ -3399,7 +3399,7 @@ int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
#if LIBAVCODEC_VERSION_MAJOR < 53
/**
- * Decodes an audio frame from buf into samples.
+ * Decode an audio frame from buf into samples.
* Wrapper function which calls avcodec_decode_audio3.
*
* @deprecated Use avcodec_decode_audio3 instead.
@@ -3417,7 +3417,7 @@ attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *s
#endif
/**
- * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
+ * Decode the audio frame of size avpkt->size from avpkt->data into samples.
* Some decoders may support multiple frames in a single AVPacket, such
* decoders would then just decode the first frame. In this case,
* avcodec_decode_audio3 has to be called again with an AVPacket that contains
@@ -3461,7 +3461,7 @@ int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
#if LIBAVCODEC_VERSION_MAJOR < 53
/**
- * Decodes a video frame from buf into picture.
+ * Decode a video frame from buf into picture.
* Wrapper function which calls avcodec_decode_video2.
*
* @deprecated Use avcodec_decode_video2 instead.
@@ -3479,7 +3479,7 @@ attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *pi
#endif
/**
- * Decodes the video frame of size avpkt->size from avpkt->data into picture.
+ * Decode the video frame of size avpkt->size from avpkt->data into picture.
* Some decoders may support multiple frames in a single AVPacket, such
* decoders would then just decode the first frame.
*
@@ -3532,8 +3532,8 @@ attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtit
#endif
/**
- * Decodes a subtitle message.
- * Returns a negative value on error, otherwise returns the number of bytes used.
+ * Decode a subtitle message.
+ * Return a negative value on error, otherwise returns the number of bytes used.
* If no subtitle could be decompressed, got_sub_ptr is zero.
* Otherwise, the subtitle is stored in *sub.
*
@@ -3550,7 +3550,7 @@ int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
uint8_t *buf, int buf_size);
/**
- * Encodes an audio frame from samples into buf.
+ * Encode an audio frame from samples into buf.
*
* @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
* However, for PCM audio the user will know how much space is needed
@@ -3572,7 +3572,7 @@ int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
const short *samples);
/**
- * Encodes a video frame from pict into buf.
+ * Encode a video frame from pict into buf.
* The input picture should be
* stored using a specific format, namely avctx.pix_fmt.
*
@@ -3612,7 +3612,7 @@ void avcodec_default_free_buffers(AVCodecContext *s);
/* misc useful functions */
/**
- * Returns a single letter to describe the given picture type pict_type.
+ * Return a single letter to describe the given picture type pict_type.
*
* @param[in] pict_type the picture type
* @return A single character representing the picture type.
@@ -3620,7 +3620,7 @@ void avcodec_default_free_buffers(AVCodecContext *s);
char av_get_pict_type_char(int pict_type);
/**
- * Returns codec bits per sample.
+ * Return codec bits per sample.
*
* @param[in] codec_id the codec
* @return Number of bits per sample or zero if unknown for the given codec.
@@ -3628,7 +3628,7 @@ char av_get_pict_type_char(int pict_type);
int av_get_bits_per_sample(enum CodecID codec_id);
/**
- * Returns sample format bits per sample.
+ * Return sample format bits per sample.
*
* @param[in] sample_fmt the sample format
* @return Number of bits per sample or zero if unknown for the given sample format.
@@ -3861,15 +3861,14 @@ AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
/* memory */
/**
- * Reallocates the given block if it is not large enough, otherwise it
- * does nothing.
+ * Reallocate the given block if it is not large enough, otherwise do nothing.
*
* @see av_realloc
*/
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
/**
- * Allocates a buffer, reusing the given one if large enough.
+ * Allocate a buffer, reusing the given one if large enough.
*
* Contrary to av_fast_realloc the current buffer contents might not be
* preserved and on error the old buffer is freed, thus no special
@@ -3901,7 +3900,7 @@ int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width,
int padtop, int padbottom, int padleft, int padright, int *color);
/**
- * Encodes extradata length to a buffer. Used by xiph codecs.
+ * Encode extradata length to a buffer. Used by xiph codecs.
*
* @param s buffer to write to; must be at least (v/255+1) bytes long
* @param v size of extradata in bytes
@@ -3910,7 +3909,7 @@ int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width,
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
/**
- * Parses str and put in width_ptr and height_ptr the detected values.
+ * Parse str and put in width_ptr and height_ptr the detected values.
*
* @return 0 in case of a successful parsing, a negative value otherwise
* @param[in] str the string to parse: it has to be a string in the format
@@ -3923,7 +3922,7 @@ unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
/**
- * Parses str and put in frame_rate the detected values.
+ * Parse str and store the detected values in *frame_rate.
*
* @return 0 in case of a successful parsing, a negative value otherwise
* @param[in] str the string to parse: it has to be a string in the format
@@ -3948,7 +3947,7 @@ int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
/**
- * Logs a generic warning message asking for a sample. This function is
+ * Log a generic warning message asking for a sample. This function is
* intended to be used internally by FFmpeg (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
@@ -3958,7 +3957,7 @@ void av_log_missing_feature(void *avc, const char *feature, int want_sample);
void av_log_ask_for_sample(void *avc, const char *msg);
/**
- * Registers the hardware accelerator hwaccel.
+ * Register the hardware accelerator hwaccel.
*/
void av_register_hwaccel(AVHWAccel *hwaccel);
diff --git a/libavcodec/avfft.h b/libavcodec/avfft.h
index 623f0a33b5..be2d9c7e10 100644
--- a/libavcodec/avfft.h
+++ b/libavcodec/avfft.h
@@ -85,7 +85,7 @@ enum DCTTransformType {
};
/**
- * Sets up DCT.
+ * Set up DCT.
* @param nbits size of the input array:
* (1 << nbits) for DCT-II, DCT-III and DST-I
* (1 << nbits) + 1 for DCT-I
diff --git a/libavcodec/bgmc.c b/libavcodec/bgmc.c
index 86b807bc2f..ffe3cea4a6 100644
--- a/libavcodec/bgmc.c
+++ b/libavcodec/bgmc.c
@@ -424,7 +424,7 @@ static const uint16_t * const cf_table[16] = {
};
-/** Initializes a given lookup table using a given delta
+/** Initialize a given lookup table using a given delta
*/
static void bgmc_lut_fillp(uint8_t *lut, unsigned int *lut_status,
unsigned int delta)
@@ -446,7 +446,7 @@ static void bgmc_lut_fillp(uint8_t *lut, unsigned int *lut_status,
}
-/** Retunes the index of a suitable lookup table for a given delta
+/** Retune the index of a suitable lookup table for a given delta
*/
static uint8_t* bgmc_lut_getp(uint8_t *lut, unsigned int *lut_status,
unsigned int delta)
@@ -462,7 +462,7 @@ static uint8_t* bgmc_lut_getp(uint8_t *lut, unsigned int *lut_status,
}
-/** Initializes the lookup table arrays
+/** Initialize the lookup table arrays
*/
int ff_bgmc_init(AVCodecContext *avctx, uint8_t **cf_lut, unsigned int **cf_lut_status)
{
@@ -479,7 +479,7 @@ int ff_bgmc_init(AVCodecContext *avctx, uint8_t **cf_lut, unsigned int **cf_lut_
}
-/** Releases the lookup table arrays
+/** Release the lookup table arrays
*/
void ff_bgmc_end(uint8_t **cf_lut, unsigned int **cf_lut_status)
{
@@ -488,7 +488,7 @@ void ff_bgmc_end(uint8_t **cf_lut, unsigned int **cf_lut_status)
}
-/** Initializes decoding and reads the first value
+/** Initialize decoding and reads the first value
*/
void ff_bgmc_decode_init(GetBitContext *gb,
unsigned int *h, unsigned int *l, unsigned int *v)
@@ -507,7 +507,7 @@ void ff_bgmc_decode_end(GetBitContext *gb)
}
-/** Reads and decodes a block Gilbert-Moore coded symbol
+/** Read and decode a block Gilbert-Moore coded symbol
*/
void ff_bgmc_decode(GetBitContext *gb, unsigned int num, int32_t *dst,
unsigned int delta, unsigned int sx,
diff --git a/libavcodec/bink.c b/libavcodec/bink.c
index b5921f9f4f..0a0b5bc915 100644
--- a/libavcodec/bink.c
+++ b/libavcodec/bink.c
@@ -106,7 +106,7 @@ enum BlockTypes {
};
/**
- * Initializes length length in all bundles.
+ * Initialize length length in all bundles.
*
* @param c decoder context
* @param width plane width
@@ -131,7 +131,7 @@ static void init_lengths(BinkContext *c, int width, int bw)
}
/**
- * Allocates memory for bundles.
+ * Allocate memory for bundles.
*
* @param c decoder context
*/
@@ -151,7 +151,7 @@ static av_cold void init_bundles(BinkContext *c)
}
/**
- * Frees memory used by bundles.
+ * Free memory used by bundles.
*
* @param c decoder context
*/
@@ -163,7 +163,7 @@ static av_cold void free_bundles(BinkContext *c)
}
/**
- * Merges two consequent lists of equal size depending on bits read.
+ * Merge two consequent lists of equal size depending on bits read.
*
* @param gb context for reading bits
* @param dst buffer where merged list will be written to
@@ -192,7 +192,7 @@ static void merge(GetBitContext *gb, uint8_t *dst, uint8_t *src, int size)
}
/**
- * Reads information about Huffman tree used to decode data.
+ * Read information about Huffman tree used to decode data.
*
* @param gb context for reading bits
* @param tree pointer for storing tree data
@@ -233,7 +233,7 @@ static void read_tree(GetBitContext *gb, Tree *tree)
}
/**
- * Prepares bundle for decoding data.
+ * Prepare bundle for decoding data.
*
* @param gb context for reading bits
* @param c decoder context
@@ -462,7 +462,7 @@ static int read_dcs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b,
}
/**
- * Retrieves next value from bundle.
+ * Retrieve next value from bundle.
*
* @param c decoder context
* @param bundle bundle number
@@ -481,7 +481,7 @@ static inline int get_value(BinkContext *c, int bundle)
}
/**
- * Reads 8x8 block of DCT coefficients.
+ * Read 8x8 block of DCT coefficients.
*
* @param gb context for reading bits
* @param block place for storing coefficients
@@ -583,7 +583,7 @@ static int read_dct_coeffs(GetBitContext *gb, DCTELEM block[64], const uint8_t *
}
/**
- * Reads 8x8 block with residue after motion compensation.
+ * Read 8x8 block with residue after motion compensation.
*
* @param gb context for reading bits
* @param block place to store read data
diff --git a/libavcodec/cavsdata.h b/libavcodec/cavsdata.h
index b597da1986..9e52fd5cc4 100644
--- a/libavcodec/cavsdata.h
+++ b/libavcodec/cavsdata.h
@@ -88,15 +88,15 @@ const uint16_t ff_cavs_dequant_mul[64] = {
32771,35734,38965,42497,46341,50535,55109,60099
};
-/** marks block as unavailable, i.e. out of picture
+/** mark block as unavailable, i.e. out of picture
or not yet decoded */
const cavs_vector ff_cavs_un_mv = {0,0,1,NOT_AVAIL};
-/** marks block as "no prediction from this direction"
+/** mark block as "no prediction from this direction"
e.g. forward motion vector in BWD partition */
const cavs_vector ff_cavs_dir_mv = {0,0,1,REF_DIR};
-/** marks block as using intra prediction */
+/** mark block as using intra prediction */
const cavs_vector ff_cavs_intra_mv = {0,0,1,REF_INTRA};
#define EOB 0,0,0
diff --git a/libavcodec/celp_math.h b/libavcodec/celp_math.h
index 7cf7861ca7..4cf656fb7e 100644
--- a/libavcodec/celp_math.h
+++ b/libavcodec/celp_math.h
@@ -43,7 +43,7 @@ int16_t ff_cos(uint16_t arg);
int ff_exp2(uint16_t power);
/**
- * Calculates log2(x).
+ * Calculate log2(x).
* @param value function argument, 0 < value <= 7fff ffff
*
* @return value of (1<<15) * log2(value)
diff --git a/libavcodec/dirac.h b/libavcodec/dirac.h
index 09c5581013..87d66ccab6 100644
--- a/libavcodec/dirac.h
+++ b/libavcodec/dirac.h
@@ -24,7 +24,7 @@
/**
* @file
- * Interfaces to Dirac Decoder/Encoder
+ * Interface to Dirac Decoder/Encoder
* @author Marco Gerards <marco@gnu.org>
*/
diff --git a/libavcodec/dirac_parser.c b/libavcodec/dirac_parser.c
index c82f0e673d..e5b9599c7f 100644
--- a/libavcodec/dirac_parser.c
+++ b/libavcodec/dirac_parser.c
@@ -33,7 +33,7 @@
#define DIRAC_PARSE_INFO_PREFIX 0x42424344
/**
- * 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
*/
typedef struct DiracParseContext {
diff --git a/libavcodec/dsputil.c b/libavcodec/dsputil.c
index e84bb2af8a..eb9e1ada15 100644
--- a/libavcodec/dsputil.c
+++ b/libavcodec/dsputil.c
@@ -359,7 +359,7 @@ static void draw_edges_c(uint8_t *buf, int wrap, int width, int height, int w)
}
/**
- * Copies a rectangular area of samples to a temporary buffer and replicates the boarder samples.
+ * Copy a rectangular area of samples to a temporary buffer and replicate the border samples.
* @param buf destination buffer
* @param src source buffer
* @param linesize number of bytes between 2 vertically adjacent samples in both the source and destination buffers
diff --git a/libavcodec/fft.h b/libavcodec/fft.h
index 10ca1b140e..9cf2fd9aa2 100644
--- a/libavcodec/fft.h
+++ b/libavcodec/fft.h
@@ -84,7 +84,7 @@ extern COSTABLE(65536);
extern COSTABLE_CONST FFTSample* const ff_cos_tabs[17];
/**
- * Initializes the cosine table in ff_cos_tabs[index]
+ * Initialize the cosine table in ff_cos_tabs[index]
* \param index index in ff_cos_tabs array of the table to initialize
*/
void ff_init_ff_cos_tabs(int index);
@@ -104,7 +104,7 @@ extern SINTABLE(32768);
extern SINTABLE(65536);
/**
- * Sets up a complex FFT.
+ * Set up a complex FFT.
* @param nbits log2 of the length of the input array
* @param inverse if 0 perform the forward transform, if 1 perform the inverse
*/
@@ -205,7 +205,7 @@ struct RDFTContext {
};
/**
- * Sets up a real FFT.
+ * Set up a real FFT.
* @param nbits log2 of the length of the input array
* @param trans the type of transform
*/
@@ -231,7 +231,7 @@ struct DCTContext {
};
/**
- * Sets up DCT.
+ * Set up DCT.
* @param nbits size of the input array:
* (1 << nbits) for DCT-II, DCT-III and DST-I
* (1 << nbits) + 1 for DCT-I
diff --git a/libavcodec/flacenc.c b/libavcodec/flacenc.c
index c6729f152a..ebec6f608e 100644
--- a/libavcodec/flacenc.c
+++ b/libavcodec/flacenc.c
@@ -98,7 +98,7 @@ typedef struct FlacEncodeContext {
} FlacEncodeContext;
/**
- * Writes streaminfo metadata block to byte array
+ * Write streaminfo metadata block to byte array
*/
static void write_streaminfo(FlacEncodeContext *s, uint8_t *header)
{
@@ -123,8 +123,8 @@ static void write_streaminfo(FlacEncodeContext *s, uint8_t *header)
}
/**
- * Sets blocksize based on samplerate
- * Chooses the closest predefined blocksize >= BLOCK_TIME_MS milliseconds
+ * Set blocksize based on samplerate
+ * Choose the closest predefined blocksize >= BLOCK_TIME_MS milliseconds
*/
static int select_blocksize(int samplerate, int block_time_ms)
{
diff --git a/libavcodec/h261enc.c b/libavcodec/h261enc.c
index d3f2219f69..c85ee8bb05 100644
--- a/libavcodec/h261enc.c
+++ b/libavcodec/h261enc.c
@@ -84,7 +84,7 @@ void ff_h261_encode_picture_header(MpegEncContext * s, int picture_number){
}
/**
- * Encodes a group of blocks header.
+ * Encode a group of blocks header.
*/
static void h261_encode_gob_header(MpegEncContext * s, int mb_line){
H261Context * h = (H261Context *)s;
diff --git a/libavcodec/h263.h b/libavcodec/h263.h
index 678588a171..6c05565c70 100644
--- a/libavcodec/h263.h
+++ b/libavcodec/h263.h
@@ -93,7 +93,7 @@ void h263_pred_acdc(MpegEncContext * s, DCTELEM *block, int n);
/**
- * Prints picture info if FF_DEBUG_PICT_INFO is set.
+ * Print picture info if FF_DEBUG_PICT_INFO is set.
*/
void ff_h263_show_pict_info(MpegEncContext *s);
@@ -102,8 +102,8 @@ int ff_h263_decode_mb(MpegEncContext *s,
DCTELEM block[6][64]);
/**
- * Returns the value of the 3bit "source format" syntax element.
- * that represents some standard picture dimensions or indicates that
+ * Return the value of the 3bit "source format" syntax element.
+ * This represents some standard picture dimensions or indicates that
* width&height are explicitly stored later.
*/
int av_const h263_get_picture_format(int width, int height);
diff --git a/libavcodec/h264.c b/libavcodec/h264.c
index ef0999617a..8e4420b847 100644
--- a/libavcodec/h264.c
+++ b/libavcodec/h264.c
@@ -1690,7 +1690,7 @@ static void field_end(H264Context *h){
}
/**
- * Replicates H264 "master" context to thread contexts.
+ * Replicate H264 "master" context to thread contexts.
*/
static void clone_slice(H264Context *dst, H264Context *src)
{
diff --git a/libavcodec/h264.h b/libavcodec/h264.h
index 0922ede6f7..1bb18d1024 100644
--- a/libavcodec/h264.h
+++ b/libavcodec/h264.h
@@ -620,7 +620,7 @@ int ff_h264_decode_seq_parameter_set(H264Context *h);
int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length);
/**
- * Decodes a network abstraction layer unit.
+ * Decode a network abstraction layer unit.
* @param consumed is the number of bytes used as input
* @param length is the length of the array
* @param dst_length is the number of decoded bytes FIXME here or a decode rbsp tailing?
@@ -629,29 +629,29 @@ int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length);
const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src, int *dst_length, int *consumed, int length);
/**
- * identifies the exact end of the bitstream
+ * Identify the exact end of the bitstream
* @return the length of the trailing, or 0 if damaged
*/
int ff_h264_decode_rbsp_trailing(H264Context *h, const uint8_t *src);
/**
- * frees any data that may have been allocated in the H264 context like SPS, PPS etc.
+ * Free any data that may have been allocated in the H264 context like SPS, PPS etc.
*/
av_cold void ff_h264_free_context(H264Context *h);
/**
- * reconstructs bitstream slice_type.
+ * Reconstruct bitstream slice_type.
*/
int ff_h264_get_slice_type(const H264Context *h);
/**
- * allocates tables.
+ * Allocate tables.
* needs width/height
*/
int ff_h264_alloc_tables(H264Context *h);
/**
- * fills the default_ref_list.
+ * Fill the default_ref_list.
*/
int ff_h264_fill_default_ref_list(H264Context *h);
@@ -660,7 +660,7 @@ void ff_h264_fill_mbaff_ref_list(H264Context *h);
void ff_h264_remove_all_refs(H264Context *h);
/**
- * Executes the reference picture marking (memory management control operations).
+ * Execute the reference picture marking (memory management control operations).
*/
int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count);
@@ -668,12 +668,12 @@ int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb);
/**
- * 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 & change the dc mode so it only uses the available blocks.
*/
int ff_h264_check_intra4x4_pred_mode(H264Context *h);
/**
- * 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 & change the dc mode so it only uses the available blocks.
*/
int ff_h264_check_intra_pred_mode(H264Context *h, int mode);
@@ -686,13 +686,13 @@ av_cold int ff_h264_decode_end(AVCodecContext *avctx);
av_cold void ff_h264_decode_init_vlc(void);
/**
- * 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_cavlc(H264Context *h);
/**
- * decodes a CABAC coded macroblock
+ * Decode a CABAC coded macroblock
* @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
*/
int ff_h264_decode_mb_cabac(H264Context *h);
diff --git a/libavcodec/h264pred.c b/libavcodec/h264pred.c
index eff7d89055..64c4882f89 100644
--- a/libavcodec/h264pred.c
+++ b/libavcodec/h264pred.c
@@ -1184,7 +1184,7 @@ static void pred8x8_horizontal_add_c(uint8_t *pix, const int *block_offset, cons
/**
- * Sets the intra prediction function pointers.
+ * Set the intra prediction function pointers.
*/
void ff_h264_pred_init(H264PredContext *h, int codec_id){
// MpegEncContext * const s = &h->s;
diff --git a/libavcodec/idcinvideo.c b/libavcodec/idcinvideo.c
index 203812b128..cc79ef0a4f 100644
--- a/libavcodec/idcinvideo.c
+++ b/libavcodec/idcinvideo.c
@@ -77,7 +77,7 @@ typedef struct IdcinContext {
/*
* Find the lowest probability node in a Huffman table, and mark it as
* being assigned to a higher probability.
- * Returns the node index of the lowest unused node, or -1 if all nodes
+ * @return the node index of the lowest unused node, or -1 if all nodes
* are used.
*/
static int huff_smallest_node(hnode *hnodes, int num_hnodes) {
diff --git a/libavcodec/iff.c b/libavcodec/iff.c
index 21d93ec102..b9ed560914 100644
--- a/libavcodec/iff.c
+++ b/libavcodec/iff.c
@@ -215,7 +215,7 @@ static void decodeplane32(uint32_t *dst, const uint8_t *buf, int buf_size, int p
}
/**
- * Decodes one complete byterun1 encoded line.
+ * Decode one complete byterun1 encoded line.
*
* @param dst the destination buffer where to store decompressed bitstream
* @param dst_size the destination plane size in bytes
diff --git a/libavcodec/indeo5.c b/libavcodec/indeo5.c
index f060448538..dd22d4fb9e 100644
--- a/libavcodec/indeo5.c
+++ b/libavcodec/indeo5.c
@@ -80,7 +80,7 @@ typedef struct {
/**
- * Decodes Indeo5 GOP (Group of pictures) header.
+ * Decode Indeo5 GOP (Group of pictures) header.
* This header is present in key frames only.
* It defines parameters for all frames in a GOP.
*
@@ -296,7 +296,7 @@ static int decode_gop_header(IVI5DecContext *ctx, AVCodecContext *avctx)
/**
- * Skips a header extension.
+ * Skip a header extension.
*
* @param gb [in,out] the GetBit context
*/
@@ -312,7 +312,7 @@ static inline void skip_hdr_extension(GetBitContext *gb)
/**
- * Decodes Indeo5 picture header.
+ * Decode Indeo5 picture header.
*
* @param ctx [in,out] ptr to the decoder context
* @param avctx [in] ptr to the AVCodecContext
@@ -364,7 +364,7 @@ static int decode_pic_hdr(IVI5DecContext *ctx, AVCodecContext *avctx)
/**
- * Decodes Indeo5 band header.
+ * Decode Indeo5 band header.
*
* @param ctx [in,out] ptr to the decoder context
* @param band [in,out] ptr to the band descriptor
@@ -432,7 +432,7 @@ static int decode_band_hdr(IVI5DecContext *ctx, IVIBandDesc *band,
/**
- * Decodes info (block type, cbp, quant delta, motion vector)
+ * Decode info (block type, cbp, quant delta, motion vector)
* for all macroblocks in the current tile.
*
* @param ctx [in,out] ptr to the decoder context
@@ -557,7 +557,7 @@ static int decode_mb_info(IVI5DecContext *ctx, IVIBandDesc *band,
/**
- * Decodes an Indeo5 band.
+ * Decode an Indeo5 band.
*
* @param ctx [in,out] ptr to the decoder context
* @param band [in,out] ptr to the band descriptor
@@ -647,7 +647,7 @@ static int decode_band(IVI5DecContext *ctx, int plane_num,
/**
- * Switches buffers.
+ * Switch buffers.
*
* @param ctx [in,out] ptr to the decoder context
*/
@@ -690,7 +690,7 @@ static void switch_buffers(IVI5DecContext *ctx)
/**
- * Initializes Indeo5 decoder.
+ * Initialize Indeo5 decoder.
*/
static av_cold int decode_init(AVCodecContext *avctx)
{
@@ -800,7 +800,7 @@ static int decode_frame(AVCodecContext *avctx, void *data, int *data_size,
/**
- * Closes Indeo5 decoder and cleans up its context.
+ * Close Indeo5 decoder and clean up its context.
*/
static av_cold int decode_close(AVCodecContext *avctx)
{
diff --git a/libavcodec/internal.h b/libavcodec/internal.h
index 67d5be7c3b..24aca6b28b 100644
--- a/libavcodec/internal.h
+++ b/libavcodec/internal.h
@@ -28,12 +28,12 @@
#include "avcodec.h"
/**
- * Determines whether pix_fmt is a hardware accelerated format.
+ * Determine whether pix_fmt is a hardware accelerated format.
*/
int ff_is_hwaccel_pix_fmt(enum PixelFormat pix_fmt);
/**
- * Returns the hardware accelerated codec for codec codec_id and
+ * Return the hardware accelerated codec for codec codec_id and
* pixel format pix_fmt.
*
* @param codec_id the codec to match
diff --git a/libavcodec/ituh263enc.c b/libavcodec/ituh263enc.c
index f736d7c66a..2537838224 100644
--- a/libavcodec/ituh263enc.c
+++ b/libavcodec/ituh263enc.c
@@ -84,7 +84,7 @@ static const uint8_t wrong_run[102] = {
};
/**
- * Returns the 4 bit value that specifies the given aspect ratio.
+ * Return the 4 bit value that specifies the given aspect ratio.
* This may be one of the standard aspect ratios or it specifies
* that the aspect will be stored explicitly later.
*/
@@ -245,7 +245,7 @@ void h263_encode_picture_header(MpegEncContext * s, int picture_number)
}
/**
- * Encodes a group of blocks header.
+ * Encode a group of blocks header.
*/
void h263_encode_gob_header(MpegEncContext * s, int mb_line)
{
diff --git a/libavcodec/ivi_common.c b/libavcodec/ivi_common.c
index f0a3a49464..b15845808f 100644
--- a/libavcodec/ivi_common.c
+++ b/libavcodec/ivi_common.c
@@ -40,7 +40,7 @@ VLC ff_ivi_mb_vlc_tabs [8];
VLC ff_ivi_blk_vlc_tabs[8];
/**
- * Reverses "nbits" bits of the value "val" and returns the result
+ * Reverse "nbits" bits of the value "val" and return the result
* in the least significant bits.
*/
static uint16_t inv_bits(uint16_t val, int nbits)
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
diff --git a/libavcodec/ivi_dsp.h b/libavcodec/ivi_dsp.h
index bdd9654c79..927461f5aa 100644
--- a/libavcodec/ivi_dsp.h
+++ b/libavcodec/ivi_dsp.h
@@ -117,13 +117,13 @@ void ff_ivi_dc_row_slant(const int32_t *in, int16_t *out, uint32_t pitch, int bl
void ff_ivi_dc_col_slant(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
/**
- * Copies the pixels into the frame buffer.
+ * Copy the pixels into the frame buffer.
*/
void ff_ivi_put_pixels_8x8(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags);
/**
- * Copies the DC coefficient into the first pixel of the block and
- * zeroes all others.
+ * Copy the DC coefficient into the first pixel of the block and
+ * zero all others.
*/
void ff_ivi_put_dc_pixel_8x8(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
diff --git a/libavcodec/libtheoraenc.c b/libavcodec/libtheoraenc.c
index b502942718..e4ca721166 100644
--- a/libavcodec/libtheoraenc.c
+++ b/libavcodec/libtheoraenc.c
@@ -49,7 +49,7 @@ typedef struct TheoraContext {
int keyframe_mask;
} TheoraContext;
-/** Concatenates an ogg_packet into the extradata. */
+/** Concatenate an ogg_packet into the extradata. */
static int concatenate_packet(unsigned int* offset,
AVCodecContext* avc_context,
const ogg_packet* packet)
diff --git a/libavcodec/libxvidff.c b/libavcodec/libxvidff.c
index 2a404cd5f9..2c58e59add 100644
--- a/libavcodec/libxvidff.c
+++ b/libavcodec/libxvidff.c
@@ -75,7 +75,7 @@ int xvid_ff_2pass(void *ref, int opt, void *p1, void *p2);
void xvid_correct_framerate(AVCodecContext *avctx);
/**
- * Creates the private context for the encoder.
+ * Create the private context for the encoder.
* All buffers are allocated, settings are loaded from the user,
* and the encoder context created.
*
@@ -359,7 +359,7 @@ static av_cold int xvid_encode_init(AVCodecContext *avctx) {
}
/**
- * Encodes a single frame.
+ * Encode a single frame.
*
* @param avctx AVCodecContext pointer to context
* @param frame Pointer to encoded frame buffer
@@ -469,7 +469,7 @@ static int xvid_encode_frame(AVCodecContext *avctx,
}
/**
- * Destroys the private context for the encoder.
+ * Destroy the private context for the encoder.
* All buffers are freed, and the Xvid encoder context is destroyed.
*
* @param avctx AVCodecContext pointer to context
@@ -609,7 +609,7 @@ void xvid_correct_framerate(AVCodecContext *avctx) {
*/
/**
- * Initializes the two-pass plugin and context.
+ * Initialize the two-pass plugin and context.
*
* @param param Input construction parameter structure
* @param handle Private context handle
@@ -640,7 +640,7 @@ static int xvid_ff_2pass_create(xvid_plg_create_t * param,
}
/**
- * Destroys the two-pass plugin context.
+ * Destroy the two-pass plugin context.
*
* @param ref Context pointer for the plugin
* @param param Destrooy context
@@ -656,7 +656,7 @@ static int xvid_ff_2pass_destroy(struct xvid_context *ref,
}
/**
- * Enables fast encode mode during the first pass.
+ * Enable fast encode mode during the first pass.
*
* @param ref Context pointer for the plugin
* @param param Frame data
@@ -699,7 +699,7 @@ static int xvid_ff_2pass_before(struct xvid_context *ref,
}
/**
- * Captures statistic data and writes it during first pass.
+ * Capture statistic data and write it during first pass.
*
* @param ref Context pointer for the plugin
* @param param Statistic data
diff --git a/libavcodec/lpc.c b/libavcodec/lpc.c
index 49e41d8c34..41d5e19255 100644
--- a/libavcodec/lpc.c
+++ b/libavcodec/lpc.c
@@ -52,7 +52,7 @@ static void apply_welch_window(const int32_t *data, int len, double *w_data)
}
/**
- * Calculates autocorrelation data from audio samples
+ * Calculate autocorrelation data from audio samples
* A Welch window function is applied before calculation.
*/
void ff_lpc_compute_autocorr(const int32_t *data, int len, int lag,
diff --git a/libavcodec/lpc.h b/libavcodec/lpc.h
index d3754f04d2..a5b6f2ebb1 100644
--- a/libavcodec/lpc.h
+++ b/libavcodec/lpc.h
@@ -56,7 +56,7 @@ void ff_lpc_compute_autocorr(const int32_t *data, int len, int lag,
/**
* Levinson-Durbin recursion.
- * Produces LPC coefficients from autocorrelation data.
+ * Produce LPC coefficients from autocorrelation data.
*/
static inline int compute_lpc_coefs(const LPC_TYPE *autoc, int max_order,
LPC_TYPE *lpc, int lpc_stride, int fail,
diff --git a/libavcodec/lsp.h b/libavcodec/lsp.h
index 6d979e89c6..cae38c3a9c 100644
--- a/libavcodec/lsp.h
+++ b/libavcodec/lsp.h
@@ -85,7 +85,7 @@ void ff_acelp_lp_decode(int16_t* lp_1st, int16_t* lp_2nd, const int16_t* lsp_2nd
#define MAX_LP_ORDER (2*MAX_LP_HALF_ORDER)
/**
- * Reconstructs LPC coefficients from the line spectral pair frequencies.
+ * Reconstruct LPC coefficients from the line spectral pair frequencies.
*
* @param lsp line spectral pairs in cosine domain
* @param lpc linear predictive coding coefficients
@@ -106,7 +106,7 @@ void ff_acelp_lspd2lpc(const double *lsp, float *lpc, int lp_half_order);
void ff_sort_nearly_sorted_floats(float *vals, int len);
/**
- * Computes the Pa / (1 + z(-1)) or Qa / (1 - z(-1)) coefficients
+ * Compute the Pa / (1 + z(-1)) or Qa / (1 - z(-1)) coefficients
* needed for LSP to LPC conversion.
* We only need to calculate the 6 first elements of the polynomial.
*
diff --git a/libavcodec/mlpdec.c b/libavcodec/mlpdec.c
index 80fbbdb07e..16397eefd7 100644
--- a/libavcodec/mlpdec.c
+++ b/libavcodec/mlpdec.c
@@ -939,8 +939,8 @@ static int output_data(MLPDecodeContext *m, unsigned int substr,
/** Read an access unit from the stream.
- * Returns < 0 on error, 0 if not enough data is present in the input stream
- * otherwise returns the number of bytes consumed. */
+ * @return negative on error, 0 if not enough data is present in the input stream,
+ * otherwise the number of bytes consumed. */
static int read_access_unit(AVCodecContext *avctx, void* data, int *data_size,
AVPacket *avpkt)
diff --git a/libavcodec/mpeg12.c b/libavcodec/mpeg12.c
index bc9ddcc4cb..24beae3a13 100644
--- a/libavcodec/mpeg12.c
+++ b/libavcodec/mpeg12.c
@@ -1920,7 +1920,7 @@ static int slice_decode_thread(AVCodecContext *c, void *arg){
}
/**
- * Handles slice ends.
+ * Handle slice ends.
* @return 1 if it seems to be the last slice
*/
static int slice_end(AVCodecContext *avctx, AVFrame *pict)
@@ -2155,7 +2155,7 @@ static void mpeg_decode_gop(AVCodecContext *avctx,
time_code_pictures, s->closed_gop, broken_link);
}
/**
- * 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_mpeg1_find_frame_end(ParseContext *pc, const uint8_t *buf, int buf_size, AVCodecParserContext *s)
diff --git a/libavcodec/mpeg4videoenc.c b/libavcodec/mpeg4videoenc.c
index 79190f0a6f..856cfa777e 100644
--- a/libavcodec/mpeg4videoenc.c
+++ b/libavcodec/mpeg4videoenc.c
@@ -54,7 +54,7 @@ max run: 29/41
/**
- * Returns the number of bits that encoding the 8x8 block in block would need.
+ * Return the number of bits that encoding the 8x8 block in block would need.
* @param[in] block_last_index last index in scantable order that refers to a non zero element in block.
*/
static inline int get_block_rate(MpegEncContext * s, DCTELEM block[64], int block_last_index, uint8_t scantable[64]){
@@ -82,7 +82,7 @@ static inline int get_block_rate(MpegEncContext * s, DCTELEM block[64], int bloc
/**
- * Restores the ac coefficients in block that have been changed by decide_ac_pred().
+ * Restore the ac coefficients in block that have been changed by decide_ac_pred().
* This function also restores s->block_last_index.
* @param[in,out] block MB coefficients, these will be restored
* @param[in] dir ac prediction direction for each 8x8 block
@@ -113,7 +113,7 @@ static inline void restore_ac_coeffs(MpegEncContext * s, DCTELEM block[6][64], c
}
/**
- * Returns the optimal value (0 or 1) for the ac_pred element for the given MB in mpeg4.
+ * Return the optimal value (0 or 1) for the ac_pred element for the given MB in mpeg4.
* This function will also update s->block_last_index and s->ac_val.
* @param[in,out] block MB coefficients, these will be updated if 1 is returned
* @param[in] dir ac prediction direction for each 8x8 block
diff --git a/libavcodec/mpegvideo.c b/libavcodec/mpegvideo.c
index b5631cffc3..624419a059 100644
--- a/libavcodec/mpegvideo.c
+++ b/libavcodec/mpegvideo.c
@@ -200,7 +200,7 @@ void ff_copy_picture(Picture *dst, Picture *src){
}
/**
- * Releases a frame buffer
+ * Release a frame buffer
*/
static void free_frame_buffer(MpegEncContext *s, Picture *pic)
{
@@ -209,7 +209,7 @@ static void free_frame_buffer(MpegEncContext *s, Picture *pic)
}
/**
- * Allocates a frame buffer
+ * Allocate a frame buffer
*/
static int alloc_frame_buffer(MpegEncContext *s, Picture *pic)
{
diff --git a/libavcodec/mpegvideo_xvmc.c b/libavcodec/mpegvideo_xvmc.c
index df81e5da68..a245200517 100644
--- a/libavcodec/mpegvideo_xvmc.c
+++ b/libavcodec/mpegvideo_xvmc.c
@@ -33,7 +33,7 @@
#include "xvmc_internal.h"
/**
- * Initializes the block field of the MpegEncContext pointer passed as
+ * Initialize the block field of the MpegEncContext pointer passed as
* parameter after making sure that the data is not corrupted.
* In order to implement something like direct rendering instead of decoding
* coefficients in s->blocks and then copying them, copy them directly
@@ -48,7 +48,7 @@ void ff_xvmc_init_block(MpegEncContext *s)
}
/**
- * Fills individual block pointers, so there are no gaps in the data_block array
+ * Fill individual block pointers, so there are no gaps in the data_block array
* in case not all blocks in the macroblock are coded.
*/
void ff_xvmc_pack_pblocks(MpegEncContext *s, int cbp)
@@ -67,7 +67,7 @@ void ff_xvmc_pack_pblocks(MpegEncContext *s, int cbp)
}
/**
- * Finds and stores the surfaces that are used as reference frames.
+ * Find and store the surfaces that are used as reference frames.
* This function should be called for every new field and/or frame.
* It should be safe to call the function a few times for the same field.
*/
@@ -134,7 +134,7 @@ return -1;
}
/**
- * Completes frame/field rendering by passing any remaining blocks.
+ * Complete frame/field rendering by passing any remaining blocks.
* Normally ff_draw_horiz_band() is called for each slice, however,
* some leftover blocks, for example from error_resilience(), may remain.
* It should be safe to call the function a few times for the same field.
@@ -149,8 +149,8 @@ void ff_xvmc_field_end(MpegEncContext *s)
}
/**
- * Synthesizes the data needed by XvMC to render one macroblock of data.
- * Fills all relevant fields, if necessary do IDCT.
+ * Synthesize the data needed by XvMC to render one macroblock of data.
+ * Fill all relevant fields, if necessary do IDCT.
*/
void ff_xvmc_decode_mb(MpegEncContext *s)
{
diff --git a/libavcodec/msrledec.h b/libavcodec/msrledec.h
index 7495de5324..2230162691 100644
--- a/libavcodec/msrledec.h
+++ b/libavcodec/msrledec.h
@@ -25,7 +25,7 @@
#include "avcodec.h"
/**
- * Decodes stream in MS RLE format into frame.
+ * Decode stream in MS RLE format into frame.
*
* @param avctx codec context
* @param pic destination frame
diff --git a/libavcodec/nellymoserenc.c b/libavcodec/nellymoserenc.c
index dd9a2719e2..1f9442cf9d 100644
--- a/libavcodec/nellymoserenc.c
+++ b/libavcodec/nellymoserenc.c
@@ -270,7 +270,7 @@ static void get_exponent_dynamic(NellyMoserEncodeContext *s, float *cand, int *i
}
/**
- * Encodes NELLY_SAMPLES samples. It assumes, that samples contains 3 * NELLY_BUF_LEN values
+ * Encode NELLY_SAMPLES samples. It assumes, that samples contains 3 * NELLY_BUF_LEN values
* @param s encoder context
* @param output output buffer
* @param output_size size of output buffer
diff --git a/libavcodec/opt.h b/libavcodec/opt.h
index 55ca4ea63e..9f0da7296f 100644
--- a/libavcodec/opt.h
+++ b/libavcodec/opt.h
@@ -139,7 +139,7 @@ typedef struct AVOption2 {
/**
- * Looks for an option in obj. Looks only for the options which
+ * Look for an option in obj. Look only for the options which
* have the flags set as specified in mask and flags (that is,
* for which it is the case that opt->flags & mask == flags).
*
@@ -168,7 +168,7 @@ attribute_deprecated const AVOption *av_set_string2(void *obj, const char *name,
#endif
/**
- * Sets the field of obj with the given name to value.
+ * Set the field of obj with the given name to value.
*
* @param[in] obj A struct whose first element is a pointer to an
* AVClass.
diff --git a/libavcodec/parser.h b/libavcodec/parser.h
index 6274bb2b49..6712bfe8b0 100644
--- a/libavcodec/parser.h
+++ b/libavcodec/parser.h
@@ -61,7 +61,7 @@ void ff_parse_close(AVCodecParserContext *s);
void ff_parse1_close(AVCodecParserContext *s);
/**
- * Fetches timestamps for a specific byte within the current access unit.
+ * Fetch timestamps for a specific byte within the current access unit.
* @param off byte position within the access unit
* @param remove Found timestamps will be removed if set to 1, kept if set to 0.
*/
diff --git a/libavcodec/pgssubdec.c b/libavcodec/pgssubdec.c
index 5512006845..ef7c4f8148 100644
--- a/libavcodec/pgssubdec.c
+++ b/libavcodec/pgssubdec.c
@@ -80,7 +80,7 @@ static av_cold int close_decoder(AVCodecContext *avctx)
}
/**
- * Decodes the RLE data.
+ * Decode the RLE data.
*
* The subtitle is stored as an Run Length Encoded image.
*
@@ -141,7 +141,7 @@ static int decode_rle(AVCodecContext *avctx, AVSubtitle *sub,
}
/**
- * Parses the picture segment packet.
+ * Parse the picture segment packet.
*
* The picture segment contains details on the sequence id,
* width, height and Run Length Encoded (RLE) bitmap data.
@@ -205,7 +205,7 @@ static int parse_picture_segment(AVCodecContext *avctx,
}
/**
- * Parses the palette segment packet.
+ * Parse the palette segment packet.
*
* The palette segment contains details of the palette,
* a maximum of 256 colors can be defined.
@@ -246,7 +246,7 @@ static void parse_palette_segment(AVCodecContext *avctx,
}
/**
- * Parses the presentation segment packet.
+ * Parse the presentation segment packet.
*
* The presentation segment contains details on the video
* width, video height, x & y subtitle position.
@@ -317,7 +317,7 @@ static void parse_presentation_segment(AVCodecContext *avctx,
}
/**
- * Parses the display segment packet.
+ * Parse the display segment packet.
*
* The display segment controls the updating of the display.
*
diff --git a/libavcodec/ppc/check_altivec.c b/libavcodec/ppc/check_altivec.c
index c8bc6edcf3..6b9332ce3a 100644
--- a/libavcodec/ppc/check_altivec.c
+++ b/libavcodec/ppc/check_altivec.c
@@ -19,7 +19,7 @@
/**
* @file
- * Checks for AltiVec presence.
+ * Check for AltiVec presence.
*/
#ifdef __APPLE__
diff --git a/libavcodec/put_bits.h b/libavcodec/put_bits.h
index 80a514df89..44d81c1aa2 100644
--- a/libavcodec/put_bits.h
+++ b/libavcodec/put_bits.h
@@ -52,7 +52,7 @@ typedef struct PutBitContext {
} PutBitContext;
/**
- * Initializes the PutBitContext s.
+ * Initialize the PutBitContext s.
*
* @param buffer the buffer where to put bits
* @param buffer_size the size in bytes of buffer
@@ -79,7 +79,7 @@ static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_s
}
/**
- * Returns the total number of bits written to the bitstream.
+ * @return the total number of bits written to the bitstream.
*/
static inline int put_bits_count(PutBitContext *s)
{
@@ -91,7 +91,7 @@ static inline int put_bits_count(PutBitContext *s)
}
/**
- * Pads the end of the output stream with zeros.
+ * Pad the end of the output stream with zeros.
*/
static inline void flush_put_bits(PutBitContext *s)
{
@@ -123,19 +123,19 @@ static inline void flush_put_bits(PutBitContext *s)
#define ff_copy_bits ff_copy_bits_unsupported_here
#else
/**
- * Pads the bitstream with zeros up to the next byte boundary.
+ * Pad the bitstream with zeros up to the next byte boundary.
*/
void align_put_bits(PutBitContext *s);
/**
- * Puts the string string in the bitstream.
+ * Put the string string in the bitstream.
*
* @param terminate_string 0-terminates the written string if value is 1
*/
void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
/**
- * Copies the content of src to the bitstream.
+ * Copy the content of src to the bitstream.
*
* @param length the number of bits of src to copy
*/
@@ -143,7 +143,7 @@ void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
#endif
/**
- * Writes up to 31 bits into a bitstream.
+ * Write up to 31 bits into a bitstream.
* Use put_bits32 to write 32 bits.
*/
static inline void put_bits(PutBitContext *s, int n, unsigned int value)
@@ -270,7 +270,7 @@ static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
}
/**
- * Writes exactly 32 bits into a bitstream.
+ * Write exactly 32 bits into a bitstream.
*/
static void av_unused put_bits32(PutBitContext *s, uint32_t value)
{
@@ -286,7 +286,7 @@ static void av_unused put_bits32(PutBitContext *s, uint32_t value)
}
/**
- * Returns the pointer to the byte where the bitstream writer will put
+ * Return the pointer to the byte where the bitstream writer will put
* the next bit.
*/
static inline uint8_t* put_bits_ptr(PutBitContext *s)
@@ -299,7 +299,7 @@ static inline uint8_t* put_bits_ptr(PutBitContext *s)
}
/**
- * Skips the given number of bytes.
+ * Skip the given number of bytes.
* PutBitContext must be flushed & aligned to a byte boundary before calling this.
*/
static inline void skip_put_bytes(PutBitContext *s, int n)
@@ -315,7 +315,7 @@ static inline void skip_put_bytes(PutBitContext *s, int n)
}
/**
- * Skips the given number of bits.
+ * Skip the given number of bits.
* Must only be used if the actual values in the bitstream do not matter.
* If n is 0 the behavior is undefined.
*/
@@ -331,7 +331,7 @@ static inline void skip_put_bits(PutBitContext *s, int n)
}
/**
- * Changes the end of the buffer.
+ * Change the end of the buffer.
*
* @param size the new size in bytes of the buffer where to put bits
*/
diff --git a/libavcodec/qcelpdec.c b/libavcodec/qcelpdec.c
index 97785adb96..4394ec472d 100644
--- a/libavcodec/qcelpdec.c
+++ b/libavcodec/qcelpdec.c
@@ -101,8 +101,8 @@ static av_cold int qcelp_decode_init(AVCodecContext *avctx)
}
/**
- * Decodes the 10 quantized LSP frequencies from the LSPV/LSP
- * transmission codes of any bitrate and checks for badly received packets.
+ * Decode the 10 quantized LSP frequencies from the LSPV/LSP
+ * transmission codes of any bitrate and check for badly received packets.
*
* @param q the context
* @param lspf line spectral pair frequencies
@@ -197,7 +197,7 @@ static int decode_lspf(QCELPContext *q, float *lspf)
}
/**
- * Converts codebook transmission codes to GAIN and INDEX.
+ * Convert codebook transmission codes to GAIN and INDEX.
*
* @param q the context
* @param gain array holding the decoded gain
@@ -309,7 +309,7 @@ static int codebook_sanity_check_for_rate_quarter(const uint8_t *cbgain)
}
/**
- * Computes the scaled codebook vector Cdn From INDEX and GAIN
+ * Compute the scaled codebook vector Cdn From INDEX and GAIN
* for all rates.
*
* The specification lacks some information here.
@@ -564,8 +564,8 @@ static void apply_pitch_filters(QCELPContext *q, float *cdn_vector)
}
/**
- * Reconstructs LPC coefficients from the line spectral pair frequencies
- * and performs bandwidth expansion.
+ * Reconstruct LPC coefficients from the line spectral pair frequencies
+ * and perform bandwidth expansion.
*
* @param lspf line spectral pair frequencies
* @param lpc linear predictive coding coefficients
@@ -594,7 +594,7 @@ static void lspf2lpc(const float *lspf, float *lpc)
}
/**
- * Interpolates LSP frequencies and computes LPC coefficients
+ * Interpolate LSP frequencies and computes LPC coefficients
* for a given bitrate & pitch subframe.
*
* TIA/EIA/IS-733 2.4.3.3.4, 2.4.8.7.2
diff --git a/libavcodec/qdm2.c b/libavcodec/qdm2.c
index 6451fbe91f..d88d03a212 100644
--- a/libavcodec/qdm2.c
+++ b/libavcodec/qdm2.c
@@ -385,7 +385,7 @@ static uint16_t qdm2_packet_checksum (const uint8_t *data, int length, int value
/**
- * Fills a QDM2SubPacket structure with packet type, size, and data pointer.
+ * Fill a QDM2SubPacket structure with packet type, size, and data pointer.
*
* @param gb bitreader context
* @param sub_packet packet under analysis
@@ -436,7 +436,7 @@ static QDM2SubPNode* qdm2_search_subpacket_type_in_list (QDM2SubPNode *list, int
/**
- * Replaces 8 elements with their average value.
+ * Replace 8 elements with their average value.
* Called by qdm2_decode_superblock before starting subblock decoding.
*
* @param q context
diff --git a/libavcodec/qtrleenc.c b/libavcodec/qtrleenc.c
index 7f95c7f5a4..6cc7a556f3 100644
--- a/libavcodec/qtrleenc.c
+++ b/libavcodec/qtrleenc.c
@@ -104,7 +104,7 @@ static av_cold int qtrle_encode_init(AVCodecContext *avctx)
}
/**
- * Computes the best RLE sequence for a line
+ * Compute the best RLE sequence for a line
*/
static void qtrle_encode_line(QtrleEncContext *s, AVFrame *p, int line, uint8_t **buf)
{
@@ -235,7 +235,7 @@ static void qtrle_encode_line(QtrleEncContext *s, AVFrame *p, int line, uint8_t
bytestream_put_byte(buf, -1); // end RLE line
}
-/** Encodes frame including header */
+/** Encode frame including header */
static int encode_frame(QtrleEncContext *s, AVFrame *p, uint8_t *buf)
{
int i;
diff --git a/libavcodec/ra144enc.c b/libavcodec/ra144enc.c
index 0f7aa40929..7886602477 100644
--- a/libavcodec/ra144enc.c
+++ b/libavcodec/ra144enc.c
@@ -59,7 +59,7 @@ static av_cold int ra144_encode_init(AVCodecContext * avctx)
/**
- * Quantizes a value by searching a sorted table for the element with the
+ * Quantize a value by searching a sorted table for the element with the
* nearest value
*
* @param value value to quantize
@@ -88,7 +88,7 @@ static int quantize(int value, const int16_t *table, unsigned int size)
/**
- * Orthogonalizes a vector to another vector
+ * Orthogonalize a vector to another vector
*
* @param v vector to orthogonalize
* @param u vector against which orthogonalization is performed
@@ -109,7 +109,7 @@ static void orthogonalize(float *v, const float *u)
/**
- * Calculates match score and gain of an LPC-filtered vector with respect to
+ * Calculate match score and gain of an LPC-filtered vector with respect to
* input data, possibly othogonalizing it to up to 2 other vectors
*
* @param work array used to calculate the filtered vector
@@ -148,7 +148,7 @@ static void get_match_score(float *work, const float *coefs, float *vect,
/**
- * Creates a vector from the adaptive codebook at a given lag value
+ * Create a vector from the adaptive codebook at a given lag value
*
* @param vect array where vector is stored
* @param cb adaptive codebook
@@ -168,7 +168,7 @@ static void create_adapt_vect(float *vect, const int16_t *cb, int lag)
/**
- * Searches the adaptive codebook for the best entry and gain and removes its
+ * Search the adaptive codebook for the best entry and gain and remove its
* contribution from input data
*
* @param adapt_cb array from which the adaptive codebook is extracted
@@ -210,7 +210,7 @@ static int adaptive_cb_search(const int16_t *adapt_cb, float *work,
/**
- * Finds the best vector of a fixed codebook by applying an LPC filter to
+ * Find the best vector of a fixed codebook by applying an LPC filter to
* codebook entries, possibly othogonalizing them to up to 2 other vectors and
* matching the results with input data
*
@@ -249,7 +249,7 @@ static void find_best_vect(float *work, const float *coefs,
/**
- * Searches the two fixed codebooks for the best entry and gain
+ * Search the two fixed codebooks for the best entry and gain
*
* @param work array used to calculate LPC-filtered vectors
* @param coefs coefficients of the LPC filter
@@ -301,7 +301,7 @@ static void fixed_cb_search(float *work, const float *coefs, float *data,
/**
- * Encodes a subblock of the current frame
+ * Encode a subblock of the current frame
*
* @param ractx encoder context
* @param sblock_data input data of the subblock
diff --git a/libavcodec/roqvideoenc.c b/libavcodec/roqvideoenc.c
index f9fbb64bd8..28fd9d8512 100644
--- a/libavcodec/roqvideoenc.c
+++ b/libavcodec/roqvideoenc.c
@@ -165,7 +165,7 @@ static int eval_motion_dist(RoqContext *enc, int x, int y, motion_vect vect,
}
/**
- * Returns distortion between two macroblocks
+ * @return distortion between two macroblocks
*/
static inline int squared_diff_macroblock(uint8_t a[], uint8_t b[], int size)
{
@@ -240,7 +240,7 @@ typedef struct RoqTempData
} RoqTempdata;
/**
- * Initializes cel evaluators and sets their source coordinates
+ * Initialize cel evaluators and set their source coordinates
*/
static void create_cel_evals(RoqContext *enc, RoqTempdata *tempData)
{
@@ -393,7 +393,7 @@ static void motion_search(RoqContext *enc, int blocksize)
}
/**
- * Gets distortion for all options available to a subcel
+ * Get distortion for all options available to a subcel
*/
static void gather_data_for_subcel(SubcelEvaluation *subcel, int x,
int y, RoqContext *enc, RoqTempdata *tempData)
@@ -457,7 +457,7 @@ static void gather_data_for_subcel(SubcelEvaluation *subcel, int x,
}
/**
- * Gets distortion for all options available to a cel
+ * Get distortion for all options available to a cel
*/
static void gather_data_for_cel(CelEvaluation *cel, RoqContext *enc,
RoqTempdata *tempData)
@@ -773,7 +773,7 @@ static inline void frame_block_to_cell(uint8_t *block, uint8_t **data,
}
/**
- * Creates YUV clusters for the entire image
+ * Create YUV clusters for the entire image
*/
static void create_clusters(AVFrame *frame, int w, int h, uint8_t *yuvClusters)
{
diff --git a/libavcodec/sipr.c b/libavcodec/sipr.c
index b76e89100f..aa798340bb 100644
--- a/libavcodec/sipr.c
+++ b/libavcodec/sipr.c
@@ -184,7 +184,7 @@ static void pitch_sharpening(int pitch_lag_int, float beta,
}
/**
- * Extracts decoding parameters from the input bitstream.
+ * Extract decoding parameters from the input bitstream.
* @param parms parameters structure
* @param pgb pointer to initialized GetBitContext structure
*/
@@ -254,7 +254,7 @@ static void sipr_decode_lp(float *lsfnew, const float *lsfold, float *Az,
}
/**
- * Evaluates the adaptive impulse response.
+ * Evaluate the adaptive impulse response.
*/
static void eval_ir(const float *Az, int pitch_lag, float *freq,
float pitch_sharp_factor)
@@ -276,7 +276,7 @@ static void eval_ir(const float *Az, int pitch_lag, float *freq,
}
/**
- * Evaluates the convolution of a vector with a sparse vector.
+ * Evaluate the convolution of a vector with a sparse vector.
*/
static void convolute_with_sparse(float *out, const AMRFixed *pulses,
const float *shape, int length)
diff --git a/libavcodec/twinvq.c b/libavcodec/twinvq.c
index bf2279907c..701e9595cf 100644
--- a/libavcodec/twinvq.c
+++ b/libavcodec/twinvq.c
@@ -258,7 +258,7 @@ static float eval_lpc_spectrum(const float *lsp, float cos_val, int order)
}
/**
- * Evaluates the LPC amplitude spectrum envelope from the line spectrum pairs.
+ * Evaluate the LPC amplitude spectrum envelope from the line spectrum pairs.
*/
static void eval_lpcenv(TwinContext *tctx, const float *cos_vals, float *lpc)
{
@@ -291,7 +291,7 @@ static inline float get_cos(int idx, int part, const float *cos_tab, int size)
}
/**
- * Evaluates the LPC amplitude spectrum envelope from the line spectrum pairs.
+ * Evaluate the LPC amplitude spectrum envelope from the line spectrum pairs.
* Probably for speed reasons, the coefficients are evaluated as
* siiiibiiiisiiiibiiiisiiiibiiiisiiiibiiiis ...
* where s is an evaluated value, i is a value interpolated from the others
diff --git a/libavcodec/utils.c b/libavcodec/utils.c
index 008f9e9e81..a8ed6d743a 100644
--- a/libavcodec/utils.c
+++ b/libavcodec/utils.c
@@ -1075,7 +1075,7 @@ unsigned int av_xiphlacing(unsigned char *s, unsigned int v)
/* Wrapper to work around the lack of mkstemp() on mingw/cygin.
* Also, tries to create file in /tmp first, if possible.
* *prefix can be a character constant; *filename will be allocated internally.
- * Returns file descriptor of opened file (or -1 on error)
+ * @return file descriptor of opened file (or -1 on error)
* and opened file name in **filename. */
int av_tempfile(char *prefix, char **filename) {
int fd=-1;
diff --git a/libavcodec/vaapi_h264.c b/libavcodec/vaapi_h264.c
index 6d4251a263..29f3a81bac 100644
--- a/libavcodec/vaapi_h264.c
+++ b/libavcodec/vaapi_h264.c
@@ -29,7 +29,7 @@
*/
/**
- * Initializes an empty VA API picture.
+ * Initialize an empty VA API picture.
*
* VA API requires a fixed-size reference picture array.
*/
@@ -42,7 +42,7 @@ static void init_vaapi_pic(VAPictureH264 *va_pic)
}
/**
- * Translates an FFmpeg Picture into its VA API form.
+ * Translate an FFmpeg Picture into its VA API form.
*
* @param[out] va_pic A pointer to VA API's own picture struct
* @param[in] pic A pointer to the FFmpeg picture struct to convert
@@ -82,7 +82,7 @@ typedef struct DPB {
} DPB;
/**
- * Appends picture to the decoded picture buffer, in a VA API form that
+ * Append picture to the decoded picture buffer, in a VA API form that
* merges the second field picture attributes with the first, if
* available. The decoded picture buffer's size must be large enough
* to receive the new VA API picture object.
@@ -117,7 +117,7 @@ static int dpb_add(DPB *dpb, Picture *pic)
return 0;
}
-/** Fills in VA API reference frames array. */
+/** Fill in VA API reference frames array. */
static int fill_vaapi_ReferenceFrames(VAPictureParameterBufferH264 *pic_param,
H264Context *h)
{
@@ -145,7 +145,7 @@ static int fill_vaapi_ReferenceFrames(VAPictureParameterBufferH264 *pic_param,
}
/**
- * Fills in VA API reference picture lists from the FFmpeg reference
+ * Fill in VA API reference picture lists from the FFmpeg reference
* picture list.
*
* @param[out] RefPicList VA API internal reference picture list
@@ -166,7 +166,7 @@ static void fill_vaapi_RefPicList(VAPictureH264 RefPicList[32],
}
/**
- * Fills in prediction weight table.
+ * Fill in prediction weight table.
*
* VA API requires a plain prediction weight table as it does not infer
* any value.
@@ -216,7 +216,7 @@ static void fill_vaapi_plain_pred_weight_table(H264Context *h,
}
}
-/** Initializes and starts decoding a frame with VA API. */
+/** Initialize and start decoding a frame with VA API. */
static int start_frame(AVCodecContext *avctx,
av_unused const uint8_t *buffer,
av_unused uint32_t size)
@@ -284,7 +284,7 @@ static int start_frame(AVCodecContext *avctx,
return 0;
}
-/** Ends a hardware decoding based frame. */
+/** End a hardware decoding based frame. */
static int end_frame(AVCodecContext *avctx)
{
H264Context * const h = avctx->priv_data;
@@ -293,7 +293,7 @@ static int end_frame(AVCodecContext *avctx)
return ff_vaapi_common_end_frame(&h->s);
}
-/** Decodes the given H.264 slice with VA API. */
+/** Decode the given H.264 slice with VA API. */
static int decode_slice(AVCodecContext *avctx,
const uint8_t *buffer,
uint32_t size)
diff --git a/libavcodec/vaapi_vc1.c b/libavcodec/vaapi_vc1.c
index 992e1da4b1..2c24042ab5 100644
--- a/libavcodec/vaapi_vc1.c
+++ b/libavcodec/vaapi_vc1.c
@@ -24,7 +24,7 @@
#include "vc1.h"
#include "vc1data.h"
-/** Translates FFmpeg MV modes to VA API */
+/** Translate FFmpeg MV modes to VA API */
static int get_VAMvModeVC1(enum MVModes mv_mode)
{
switch (mv_mode) {
@@ -37,7 +37,7 @@ static int get_VAMvModeVC1(enum MVModes mv_mode)
return 0;
}
-/** Checks whether the MVTYPEMB bitplane is present */
+/** Check whether the MVTYPEMB bitplane is present */
static inline int vc1_has_MVTYPEMB_bitplane(VC1Context *v)
{
if (v->mv_type_is_raw)
@@ -48,7 +48,7 @@ static inline int vc1_has_MVTYPEMB_bitplane(VC1Context *v)
v->mv_mode2 == MV_PMODE_MIXED_MV)));
}
-/** Checks whether the SKIPMB bitplane is present */
+/** Check whether the SKIPMB bitplane is present */
static inline int vc1_has_SKIPMB_bitplane(VC1Context *v)
{
if (v->skip_is_raw)
@@ -57,7 +57,7 @@ static inline int vc1_has_SKIPMB_bitplane(VC1Context *v)
(v->s.pict_type == FF_B_TYPE && !v->bi_type));
}
-/** Checks whether the DIRECTMB bitplane is present */
+/** Check whether the DIRECTMB bitplane is present */
static inline int vc1_has_DIRECTMB_bitplane(VC1Context *v)
{
if (v->dmb_is_raw)
@@ -65,7 +65,7 @@ static inline int vc1_has_DIRECTMB_bitplane(VC1Context *v)
return v->s.pict_type == FF_B_TYPE && !v->bi_type;
}
-/** Checks whether the ACPRED bitplane is present */
+/** Check whether the ACPRED bitplane is present */
static inline int vc1_has_ACPRED_bitplane(VC1Context *v)
{
if (v->acpred_is_raw)
diff --git a/libavcodec/vp3.c b/libavcodec/vp3.c
index 28e1eaccee..9a247404e3 100644
--- a/libavcodec/vp3.c
+++ b/libavcodec/vp3.c
@@ -258,7 +258,7 @@ typedef struct Vp3DecodeContext {
* superblocks <-> fragments, macroblocks <-> fragments,
* superblocks <-> macroblocks
*
- * Returns 0 is successful; returns 1 if *anything* went wrong.
+ * @return 0 is successful; returns 1 if *anything* went wrong.
*/
static int init_block_mapping(Vp3DecodeContext *s)
{
@@ -1270,7 +1270,7 @@ static void apply_loop_filter(Vp3DecodeContext *s, int plane, int ystart, int ye
}
/**
- * Pulls DCT tokens from the 64 levels to decode and dequant the coefficients
+ * Pull DCT tokens from the 64 levels to decode and dequant the coefficients
* for the next block in coding order
*/
static inline int vp3_dequant(Vp3DecodeContext *s, Vp3Fragment *frag,
diff --git a/libavcodec/wmavoice.c b/libavcodec/wmavoice.c
index 4c0ed0978e..ec682b6483 100644
--- a/libavcodec/wmavoice.c
+++ b/libavcodec/wmavoice.c
@@ -287,7 +287,7 @@ typedef struct {
} WMAVoiceContext;
/**
- * Sets up the variable bit mode (VBM) tree from container extradata.
+ * Set up the variable bit mode (VBM) tree from container extradata.
* @param gb bit I/O context.
* The bit context (s->gb) should be loaded with byte 23-46 of the
* container extradata (i.e. the ones containing the VBM tree).
diff --git a/libavcodec/x86/vc1dsp_mmx.c b/libavcodec/x86/vc1dsp_mmx.c
index e0b1f5b99a..5e441e16fd 100644
--- a/libavcodec/x86/vc1dsp_mmx.c
+++ b/libavcodec/x86/vc1dsp_mmx.c
@@ -411,7 +411,7 @@ typedef void (*vc1_mspel_mc_filter_hor_16bits)(uint8_t *dst, x86_reg dst_stride,
typedef void (*vc1_mspel_mc_filter_8bits)(uint8_t *dst, const uint8_t *src, x86_reg stride, int rnd, x86_reg offset);
/**
- * Interpolates fractional pel values by applying proper vertical then
+ * Interpolate fractional pel values by applying proper vertical then
* horizontal filter.
*
* @param dst Destination buffer for interpolated pels.
diff --git a/libavcodec/xiph.h b/libavcodec/xiph.h
index 60f4a95d1c..0cbb870355 100644
--- a/libavcodec/xiph.h
+++ b/libavcodec/xiph.h
@@ -24,7 +24,7 @@
#include "libavutil/common.h"
/**
- * Splits a single extradata buffer into the three headers that most
+ * Split a single extradata buffer into the three headers that most
* Xiph codecs use. (e.g. Theora and Vorbis)
* Works both with Matroska's packing and lavc's packing.
*
diff --git a/libavcodec/xsubenc.c b/libavcodec/xsubenc.c
index 903cbd2098..60f4979edb 100644
--- a/libavcodec/xsubenc.c
+++ b/libavcodec/xsubenc.c
@@ -35,7 +35,7 @@
#define PADDING_COLOR 0
/**
- * Encodes a single color run. At most 16 bits will be used.
+ * Encode a single color run. At most 16 bits will be used.
* \param len length of the run, values > 255 mean "until end of line", may not be < 0.
* \param color color to encode, only the lowest two bits are used and all others must be 0.
*/
@@ -49,7 +49,7 @@ static void put_xsub_rle(PutBitContext *pb, int len, int color)
}
/**
- * Encodes a 4-color bitmap with XSUB rle.
+ * Encode a 4-color bitmap with XSUB rle.
*
* The encoded bitmap may be wider than the source bitmap due to padding.
*/
diff --git a/libavcodec/xvmc.h b/libavcodec/xvmc.h
index 01f84b28c5..29c010bff9 100644
--- a/libavcodec/xvmc.h
+++ b/libavcodec/xvmc.h
@@ -71,7 +71,7 @@ struct xvmc_pix_fmt {
*/
int allocated_data_blocks;
- /** Indicates that the hardware would interpret data_blocks as IDCT
+ /** Indicate that the hardware would interpret data_blocks as IDCT
coefficients and perform IDCT on them.
- application - set during initialization
- libavcodec - unchanged
diff --git a/libavcodec/yop.c b/libavcodec/yop.c
index 1eb76b128e..72aebc68da 100644
--- a/libavcodec/yop.c
+++ b/libavcodec/yop.c
@@ -114,7 +114,7 @@ static av_cold int yop_decode_close(AVCodecContext *avctx)
}
/**
- * Paints a macroblock using the pattern in paint_lut.
+ * Paint a macroblock using the pattern in paint_lut.
* @param s codec context
* @param tag the tag that was in the nibble
*/
@@ -130,7 +130,7 @@ static void yop_paint_block(YopDecContext *s, int tag)
}
/**
- * Copies a previously painted macroblock to the current_block.
+ * Copy a previously painted macroblock to the current_block.
* @param copy_tag the tag that was in the nibble
*/
static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
@@ -155,7 +155,7 @@ static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
}
/**
- * Returns the next nibble in sequence, consuming a new byte on the input
+ * Return the next nibble in sequence, consuming a new byte on the input
* only if necessary.
*/
static uint8_t yop_get_next_nibble(YopDecContext *s)
@@ -173,7 +173,7 @@ static uint8_t yop_get_next_nibble(YopDecContext *s)
}
/**
- * Takes s->dstptr to the next macroblock in sequence.
+ * Take s->dstptr to the next macroblock in sequence.
*/
static void yop_next_macroblock(YopDecContext *s)
{