Fix grammar errors in documentation
authorMåns Rullgård <mans@mansr.com>
Wed, 30 Jun 2010 15:38:06 +0000 (15:38 +0000)
committerMåns Rullgård <mans@mansr.com>
Wed, 30 Jun 2010 15:38:06 +0000 (15:38 +0000)
Originally committed as revision 23904 to svn://svn.ffmpeg.org/ffmpeg/trunk

111 files changed:
cmdutils.h
libavcodec/aac_parser.h
libavcodec/ac3.c
libavcodec/ac3.h
libavcodec/ac3_parser.h
libavcodec/ac3tab.c
libavcodec/allcodecs.c
libavcodec/alsdec.c
libavcodec/avcodec.h
libavcodec/avfft.h
libavcodec/bgmc.c
libavcodec/bink.c
libavcodec/cavsdata.h
libavcodec/celp_math.h
libavcodec/dirac.h
libavcodec/dirac_parser.c
libavcodec/dsputil.c
libavcodec/fft.h
libavcodec/flacenc.c
libavcodec/h261enc.c
libavcodec/h263.h
libavcodec/h264.c
libavcodec/h264.h
libavcodec/h264pred.c
libavcodec/idcinvideo.c
libavcodec/iff.c
libavcodec/indeo5.c
libavcodec/internal.h
libavcodec/ituh263enc.c
libavcodec/ivi_common.c
libavcodec/ivi_common.h
libavcodec/ivi_dsp.h
libavcodec/libtheoraenc.c
libavcodec/libxvidff.c
libavcodec/lpc.c
libavcodec/lpc.h
libavcodec/lsp.h
libavcodec/mlpdec.c
libavcodec/mpeg12.c
libavcodec/mpeg4videoenc.c
libavcodec/mpegvideo.c
libavcodec/mpegvideo_xvmc.c
libavcodec/msrledec.h
libavcodec/nellymoserenc.c
libavcodec/opt.h
libavcodec/parser.h
libavcodec/pgssubdec.c
libavcodec/ppc/check_altivec.c
libavcodec/put_bits.h
libavcodec/qcelpdec.c
libavcodec/qdm2.c
libavcodec/qtrleenc.c
libavcodec/ra144enc.c
libavcodec/roqvideoenc.c
libavcodec/sipr.c
libavcodec/twinvq.c
libavcodec/utils.c
libavcodec/vaapi_h264.c
libavcodec/vaapi_vc1.c
libavcodec/vp3.c
libavcodec/wmavoice.c
libavcodec/x86/vc1dsp_mmx.c
libavcodec/xiph.h
libavcodec/xsubenc.c
libavcodec/xvmc.h
libavcodec/yop.c
libavdevice/alsa-audio.h
libavdevice/avdevice.h
libavdevice/x11grab.c
libavfilter/avfilter.h
libavfilter/avfiltergraph.h
libavfilter/graphparser.h
libavfilter/parseutils.c
libavfilter/parseutils.h
libavformat/avformat.h
libavformat/avio.h
libavformat/avlanguage.h
libavformat/http.h
libavformat/id3v2.h
libavformat/internal.h
libavformat/librtmp.c
libavformat/matroskaenc.c
libavformat/mpeg.c
libavformat/mpegts.c
libavformat/nutenc.c
libavformat/rtmppkt.h
libavformat/rtmpproto.c
libavformat/utils.c
libavformat/vorbiscomment.h
libavutil/aes.h
libavutil/avutil.h
libavutil/base64.h
libavutil/common.h
libavutil/crc.c
libavutil/error.h
libavutil/eval.h
libavutil/fifo.h
libavutil/integer.h
libavutil/internal.h
libavutil/lfg.h
libavutil/log.h
libavutil/mathematics.h
libavutil/mem.h
libavutil/pixdesc.h
libavutil/random_seed.h
libavutil/rational.h
libavutil/sha.h
libavutil/sha1.h
libavutil/tree.h
libpostproc/postprocess.h
libpostproc/postprocess_template.c

index 5656370..78867b7 100644 (file)
@@ -51,7 +51,7 @@ extern struct SwsContext *sws_opts;
 int opt_default(const char *opt, const char *arg);
 
 /**
- * Sets the libav* libraries log level.
+ * Set the libav* libraries log level.
  */
 int opt_loglevel(const char *opt, const char *arg);
 
@@ -61,8 +61,8 @@ int opt_loglevel(const char *opt, const char *arg);
 int opt_timelimit(const char *opt, const char *arg);
 
 /**
- * Parses a string and returns its corresponding value as a double.
- * Exits from the application if the string cannot be correctly
+ * Parse a string and return its corresponding value as a double.
+ * Exit from the application if the string cannot be correctly
  * parsed or the corresponding value is invalid.
  *
  * @param context the context of the value to be set (e.g. the
@@ -76,8 +76,8 @@ int opt_timelimit(const char *opt, const char *arg);
 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
 
 /**
- * Parses a string specifying a time and returns its corresponding
- * value as a number of microseconds. Exits from the application if
+ * Parse a string specifying a time and return its corresponding
+ * value as a number of microseconds. Exit from the application if
  * the string cannot be correctly parsed.
  *
  * @param context the context of the value to be set (e.g. the
@@ -122,7 +122,7 @@ typedef struct {
 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
 
 /**
- * Parses the command line arguments.
+ * Parse the command line arguments.
  * @param options Array with the definitions required to interpret every
  * option of the form: -<option_name> [<argument>]
  * @param parse_arg_function Name of the function called to process every
@@ -135,7 +135,7 @@ void parse_options(int argc, char **argv, const OptionDef *options,
 void set_context_opts(void *ctx, void *opts_ctx, int flags);
 
 /**
- * Prints an error message to stderr, indicating filename and a human
+ * Print an error message to stderr, indicating filename and a human
  * readable description of the error code err.
  *
  * If strerror_r() is not available the use of this function in a
@@ -148,73 +148,73 @@ void print_error(const char *filename, int err);
 void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
 
 /**
- * Prints the program banner to stderr. The banner contents depend on the
+ * Print the program banner to stderr. The banner contents depend on the
  * current version of the repository and of the libav* libraries used by
  * the program.
  */
 void show_banner(void);
 
 /**
- * Prints the version of the program to stdout. The version message
+ * Print the version of the program to stdout. The version message
  * depends on the current versions of the repository and of the libav*
  * libraries.
  */
 void show_version(void);
 
 /**
- * Prints the license of the program to stdout. The license depends on
+ * Print the license of the program to stdout. The license depends on
  * the license of the libraries compiled into the program.
  */
 void show_license(void);
 
 /**
- * Prints a listing containing all the formats supported by the
+ * Print a listing containing all the formats supported by the
  * program.
  */
 void show_formats(void);
 
 /**
- * Prints a listing containing all the codecs supported by the
+ * Print a listing containing all the codecs supported by the
  * program.
  */
 void show_codecs(void);
 
 /**
- * Prints a listing containing all the filters supported by the
+ * Print a listing containing all the filters supported by the
  * program.
  */
 void show_filters(void);
 
 /**
- * Prints a listing containing all the bit stream filters supported by the
+ * Print a listing containing all the bit stream filters supported by the
  * program.
  */
 void show_bsfs(void);
 
 /**
- * Prints a listing containing all the protocols supported by the
+ * Print a listing containing all the protocols supported by the
  * program.
  */
 void show_protocols(void);
 
 /**
- * Prints a listing containing all the pixel formats supported by the
+ * Print a listing containing all the pixel formats supported by the
  * program.
  */
 void show_pix_fmts(void);
 
 /**
- * Returns a positive value if reads from standard input a line
+ * Return a positive value if reads from standard input a line
  * starting with [yY], otherwise returns 0.
  */
 int read_yesno(void);
 
 /**
- * Reads the file with name filename, and puts its content in a newly
+ * Read the file with name filename, and put its content in a newly
  * allocated 0-terminated buffer.
  *
- * @param bufptr puts here the pointer to the newly allocated buffer
- * @param size puts here the size of the newly allocated buffer
+ * @param bufptr location where pointer to buffer is returned
+ * @param size   location where size of buffer is returned
  * @return 0 in case of success, a negative value corresponding to an
  * AVERROR error code in case of failure.
  */
index 8dd575b..7688009 100644 (file)
@@ -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.
index 3fce5bc..1f5ab32 100644 (file)
@@ -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.
  */
index 0def3b0..9c8dc48 100644 (file)
@@ -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.
index 766c68b..757cb15 100644 (file)
@@ -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.
index 4f28fb3..76f6245 100644 (file)
@@ -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,
index 0e3b9b3..ccede8b 100644 (file)
@@ -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"
index 3bfe9e0..6040ce3 100644 (file)
@@ -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)
 {
index 0389915..8aaed2c 100644 (file)
@@ -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);
 
index 623f0a3..be2d9c7 100644 (file)
@@ -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
index 86b807b..ffe3cea 100644 (file)
@@ -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,
index b5921f9..0a0b5bc 100644 (file)
@@ -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
index b597da1..9e52fd5 100644 (file)
@@ -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
index 7cf7861..4cf656f 100644 (file)
@@ -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)
index 09c5581..87d66cc 100644 (file)
@@ -24,7 +24,7 @@
 
 /**
  * @file
- * Interfaces to Dirac Decoder/Encoder
+ * Interface to Dirac Decoder/Encoder
  * @author Marco Gerards <marco@gnu.org>
  */
 
index c82f0e6..e5b9599 100644 (file)
@@ -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 {
index e84bb2a..eb9e1ad 100644 (file)
@@ -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
index 10ca1b1..9cf2fd9 100644 (file)
@@ -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
index c6729f1..ebec6f6 100644 (file)
@@ -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)
 {
index d3f2219..c85ee8b 100644 (file)
@@ -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;
index 678588a..6c05565 100644 (file)
@@ -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);
index ef09996..8e4420b 100644 (file)
@@ -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)
 {
index 0922ede..1bb18d1 100644 (file)
@@ -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);
index eff7d89..64c4882 100644 (file)
@@ -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;
index 203812b..cc79ef0 100644 (file)
@@ -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) {
index 21d93ec..b9ed560 100644 (file)
@@ -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
index f060448..dd22d4f 100644 (file)
@@ -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)
 {
index 67d5be7..24aca6b 100644 (file)
 #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
index f736d7c..2537838 100644 (file)
@@ -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)
 {
index f0a3a49..b158458 100644 (file)
@@ -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)
index 8d466c6..6f7ea90 100644 (file)
@@ -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
index bdd9654..927461f 100644 (file)
@@ -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);
 
index b502942..e4ca721 100644 (file)
@@ -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)
index 2a404cd..2c58e59 100644 (file)
@@ -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
index 49e41d8..41d5e19 100644 (file)
@@ -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,
index d3754f0..a5b6f2e 100644 (file)
@@ -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,
index 6d979e8..cae38c3 100644 (file)
@@ -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.
  *
index 80fbbdb..16397ee 100644 (file)
@@ -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)
index bc9ddcc..24beae3 100644 (file)
@@ -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)
index 79190f0..856cfa7 100644 (file)
@@ -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
index b5631cf..624419a 100644 (file)
@@ -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)
 {
index df81e5d..a245200 100644 (file)
@@ -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)
 {
index 7495de5..2230162 100644 (file)
@@ -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
index dd9a271..1f9442c 100644 (file)
@@ -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
index 55ca4ea..9f0da72 100644 (file)
@@ -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.
index 6274bb2..6712bfe 100644 (file)
@@ -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.
  */
index 5512006..ef7c4f8 100644 (file)
@@ -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.
  *
index c8bc6ed..6b9332c 100644 (file)
@@ -19,7 +19,7 @@
 
 /**
  * @file
- * Checks for AltiVec presence.
+ * Check for AltiVec presence.
  */
 
 #ifdef __APPLE__
index 80a514d..44d81c1 100644 (file)
@@ -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
  */
index 97785ad..4394ec4 100644 (file)
@@ -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
index 6451fbe..d88d03a 100644 (file)
@@ -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
index 7f95c7f..6cc7a55 100644 (file)
@@ -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;
index 0f7aa40..7886602 100644 (file)
@@ -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
index f9fbb64..28fd9d8 100644 (file)
@@ -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)
 {
index b76e891..aa79834 100644 (file)
@@ -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)
index bf22799..701e959 100644 (file)
@@ -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
index 008f9e9..a8ed6d7 100644 (file)
@@ -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;
index 6d4251a..29f3a81 100644 (file)
@@ -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)
index 992e1da..2c24042 100644 (file)
@@ -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)
index 28e1eac..9a24740 100644 (file)
@@ -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,
index 4c0ed09..ec682b6 100644 (file)
@@ -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).
index e0b1f5b..5e441e1 100644 (file)
@@ -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.
index 60f4a95..0cbb870 100644 (file)
@@ -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.
  *
index 903cbd2..60f4979 100644 (file)
@@ -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.
  */
index 01f84b2..29c010b 100644 (file)
@@ -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
index 1eb76b1..72aebc6 100644 (file)
@@ -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)
 {
index 9a8a089..a90d5e7 100644 (file)
@@ -50,7 +50,7 @@ typedef struct {
 } AlsaData;
 
 /**
- * Opens an ALSA PCM.
+ * Open an ALSA PCM.
  *
  * @param s media file handle
  * @param mode either SND_PCM_STREAM_CAPTURE or SND_PCM_STREAM_PLAYBACK
@@ -68,7 +68,7 @@ int ff_alsa_open(AVFormatContext *s, snd_pcm_stream_t mode,
                  int channels, enum CodecID *codec_id);
 
 /**
- * Closes the ALSA PCM.
+ * Close the ALSA PCM.
  *
  * @param s1 media file handle
  *
@@ -77,7 +77,7 @@ int ff_alsa_open(AVFormatContext *s, snd_pcm_stream_t mode,
 int ff_alsa_close(AVFormatContext *s1);
 
 /**
- * Tries to recover from ALSA buffer underrun.
+ * Try to recover from ALSA buffer underrun.
  *
  * @param s1 media file handle
  * @param err error code reported by the previous ALSA call
index dcd835c..b9c0fd7 100644 (file)
 #define LIBAVDEVICE_BUILD       LIBAVDEVICE_VERSION_INT
 
 /**
- * Returns the LIBAVDEVICE_VERSION_INT constant.
+ * Return the LIBAVDEVICE_VERSION_INT constant.
  */
 unsigned avdevice_version(void);
 
 /**
- * Returns the libavdevice build-time configuration.
+ * Return the libavdevice build-time configuration.
  */
 const char *avdevice_configuration(void);
 
 /**
- * Returns the libavdevice license.
+ * Return the libavdevice license.
  */
 const char *avdevice_license(void);
 
index 0c4e0c4..63dc0f7 100644 (file)
@@ -71,7 +71,7 @@ struct x11_grab
 };
 
 /**
- * Initializes the x11 grab device demuxer (public device demuxer API).
+ * Initialize the x11 grab device demuxer (public device demuxer API).
  *
  * @param s1 Context from avformat core
  * @param ap Parameters from avformat core
@@ -238,7 +238,7 @@ x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
 }
 
 /**
- * Paints a mouse pointer in an X11 image.
+ * Paint a mouse pointer in an X11 image.
  *
  * @param image image to paint the mouse pointer to
  * @param s context used to retrieve original grabbing rectangle
@@ -288,7 +288,7 @@ paint_mouse_pointer(XImage *image, struct x11_grab *s)
 
 
 /**
- * Reads new data in the image structure.
+ * Read new data in the image structure.
  *
  * @param dpy X11 display to grab from
  * @param d
@@ -335,7 +335,7 @@ xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
 }
 
 /**
- * Grabs a frame from x11 (public device demuxer API).
+ * Grab a frame from x11 (public device demuxer API).
  *
  * @param s1 Context from avformat core
  * @param pkt Packet holding the brabbed frame
@@ -398,7 +398,7 @@ x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
 }
 
 /**
- * Closes x11 frame grabber (public device demuxer API).
+ * Close x11 frame grabber (public device demuxer API).
  *
  * @param s1 Context from avformat core
  * @return 0 success, !0 failure
index c403cfe..7b473ad 100644 (file)
 #include "libavcodec/avcodec.h"
 
 /**
- * Returns the LIBAVFILTER_VERSION_INT constant.
+ * Return the LIBAVFILTER_VERSION_INT constant.
  */
 unsigned avfilter_version(void);
 
 /**
- * Returns the libavfilter build-time configuration.
+ * Return the libavfilter build-time configuration.
  */
 const char *avfilter_configuration(void);
 
 /**
- * Returns the libavfilter license.
+ * Return the libavfilter license.
  */
 const char *avfilter_license(void);
 
@@ -121,7 +121,7 @@ typedef struct AVFilterPicRef
 } AVFilterPicRef;
 
 /**
- * Adds a new reference to a picture.
+ * Add a new reference to a picture.
  * @param ref   an existing reference to the picture
  * @param pmask a bitmask containing the allowable permissions in the new
  *              reference
@@ -131,7 +131,7 @@ typedef struct AVFilterPicRef
 AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask);
 
 /**
- * Removes a reference to a picture. If this is the last reference to the
+ * Remove a reference to a picture. If this is the last reference to the
  * picture, the picture itself is also automatically freed.
  * @param ref reference to the picture
  */
@@ -188,7 +188,7 @@ struct AVFilterFormats
 };
 
 /**
- * Creates a list of supported formats. This is intended for use in
+ * Create a list of supported formats. This is intended for use in
  * AVFilter->query_formats().
  * @param pix_fmt list of pixel formats, terminated by PIX_FMT_NONE
  * @return the format list, with no existing references
@@ -196,7 +196,7 @@ struct AVFilterFormats
 AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts);
 
 /**
- * Adds pix_fmt to the list of pixel formats contained in *avff.
+ * Add pix_fmt to the list of pixel formats contained in *avff.
  * If *avff is NULL the function allocates the filter formats struct
  * and puts its pointer in *avff.
  *
@@ -206,12 +206,12 @@ AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts);
 int avfilter_add_colorspace(AVFilterFormats **avff, enum PixelFormat pix_fmt);
 
 /**
- * Returns a list of all colorspaces supported by FFmpeg.
+ * Return a list of all colorspaces supported by FFmpeg.
  */
 AVFilterFormats *avfilter_all_colorspaces(void);
 
 /**
- * Returns a format list which contains the intersection of the formats of
+ * Return a format list which contains the intersection of the formats of
  * a and b. Also, all the references of a, all the references of b, and
  * a and b themselves will be deallocated.
  *
@@ -221,7 +221,7 @@ AVFilterFormats *avfilter_all_colorspaces(void);
 AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
 
 /**
- * Adds *ref as a new reference to formats.
+ * Add *ref as a new reference to formats.
  * That is the pointers will point like in the ascii art below:
  *   ________
  *  |formats |<--------.
@@ -235,7 +235,7 @@ AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
 void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
 
 /**
- * If *ref is non-NULL, removes *ref as a reference to the format list
+ * If *ref is non-NULL, remove *ref as a reference to the format list
  * it currently points to, deallocates that list if this was the last
  * reference, and sets *ref to NULL.
  *
@@ -524,7 +524,7 @@ struct AVFilterLink
 };
 
 /**
- * Links two filters together.
+ * Link two filters together.
  * @param src    the source filter
  * @param srcpad index of the output pad on the source filter
  * @param dst    the destination filter
@@ -535,14 +535,14 @@ int avfilter_link(AVFilterContext *src, unsigned srcpad,
                   AVFilterContext *dst, unsigned dstpad);
 
 /**
- * Negotiates the colorspace, dimensions, etc of all inputs to a filter.
+ * Negotiate the colorspace, dimensions, etc of all inputs to a filter.
  * @param filter the filter to negotiate the properties for its inputs
  * @return       zero on successful negotiation
  */
 int avfilter_config_links(AVFilterContext *filter);
 
 /**
- * Requests a picture buffer with a specific set of permissions.
+ * Request a picture buffer with a specific set of permissions.
  * @param link  the output link to the filter from which the picture will
  *              be requested
  * @param perms the required access permissions
@@ -555,14 +555,14 @@ AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
                                           int w, int h);
 
 /**
- * Requests an input frame from the filter at the other end of the link.
+ * Request an input frame from the filter at the other end of the link.
  * @param link the input link
  * @return     zero on success
  */
 int avfilter_request_frame(AVFilterLink *link);
 
 /**
- * Polls a frame from the filter chain.
+ * Poll a frame from the filter chain.
  * @param  link the input link
  * @return the number of immediately available frames, a negative
  * number in case of error
@@ -570,7 +570,7 @@ int avfilter_request_frame(AVFilterLink *link);
 int avfilter_poll_frame(AVFilterLink *link);
 
 /**
- * Notifies the next filter of the start of a frame.
+ * Notifie the next filter of the start of a frame.
  * @param link   the output link the frame will be sent over
  * @param picref A reference to the frame about to be sent. The data for this
  *               frame need only be valid once draw_slice() is called for that
@@ -580,13 +580,13 @@ int avfilter_poll_frame(AVFilterLink *link);
 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
 
 /**
- * Notifies the next filter that the current frame has finished.
+ * Notifie the next filter that the current frame has finished.
  * @param link the output link the frame was sent over
  */
 void avfilter_end_frame(AVFilterLink *link);
 
 /**
- * Sends a slice to the next filter.
+ * Send a slice to the next filter.
  *
  * Slices have to be provided in sequential order, either in
  * top-bottom or bottom-top order. If slices are provided in
@@ -602,14 +602,14 @@ void avfilter_end_frame(AVFilterLink *link);
  */
 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
 
-/** Initializes the filter system. Registers all builtin filters. */
+/** Initialize the filter system. Register all builtin filters. */
 void avfilter_register_all(void);
 
-/** Uninitializes the filter system. Unregisters all filters. */
+/** Uninitialize the filter system. Unregister all filters. */
 void avfilter_uninit(void);
 
 /**
- * Registers a filter. This is only needed if you plan to use
+ * Register a filter. This is only needed if you plan to use
  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
  * filter can still by instantiated with avfilter_open even if it is not
  * registered.
@@ -620,7 +620,7 @@ void avfilter_uninit(void);
 int avfilter_register(AVFilter *filter);
 
 /**
- * Gets a filter definition matching the given name.
+ * Get a filter definition matching the given name.
  * @param name the filter name to find
  * @return     the filter definition, if any matching one is registered.
  *             NULL if none found.
@@ -636,7 +636,7 @@ AVFilter *avfilter_get_by_name(const char *name);
 AVFilter **av_filter_next(AVFilter **filter);
 
 /**
- * Creates a filter instance.
+ * Create a filter instance.
  * @param filter    the filter to create an instance of
  * @param inst_name Name to give to the new instance. Can be NULL for none.
  * @return          Pointer to the new instance on success. NULL on failure.
@@ -644,7 +644,7 @@ AVFilter **av_filter_next(AVFilter **filter);
 AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
 
 /**
- * Initializes a filter.
+ * Initialize a filter.
  * @param filter the filter to initialize
  * @param args   A string of parameters to use when initializing the filter.
  *               The format and meaning of this string varies by filter.
@@ -655,13 +655,13 @@ AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
 
 /**
- * Destroys a filter.
+ * Destroy a filter.
  * @param filter the filter to destroy
  */
 void avfilter_destroy(AVFilterContext *filter);
 
 /**
- * Inserts a filter in the middle of an existing link.
+ * Insert a filter in the middle of an existing link.
  * @param link the link into which the filter should be inserted
  * @param filt the filter to be inserted
  * @param in   the input pad on the filter to connect
@@ -672,7 +672,7 @@ int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
                            unsigned in, unsigned out);
 
 /**
- * Inserts a new pad.
+ * Insert a new pad.
  * @param idx Insertion point. Pad is inserted at the end if this point
  *            is beyond the end of the list of pads.
  * @param count Pointer to the number of pads in the list
@@ -687,7 +687,7 @@ void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
                          AVFilterPad **pads, AVFilterLink ***links,
                          AVFilterPad *newpad);
 
-/** Inserts a new input pad for the filter. */
+/** Insert a new input pad for the filter. */
 static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
                                          AVFilterPad *p)
 {
@@ -695,7 +695,7 @@ static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
                         &f->input_pads, &f->inputs, p);
 }
 
-/** Inserts a new output pad for the filter. */
+/** Insert a new output pad for the filter. */
 static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
                                           AVFilterPad *p)
 {
index 1640795..5a0bbf7 100644 (file)
@@ -32,7 +32,7 @@ typedef struct AVFilterGraph {
 } AVFilterGraph;
 
 /**
- * Gets a filter instance with name name from graph.
+ * Get a filter instance with name name from graph.
  *
  * @return the pointer to the found filter instance or NULL if it
  * cannot be found.
@@ -40,7 +40,7 @@ typedef struct AVFilterGraph {
 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
 
 /**
- * Adds an existing filter instance to a filter graph.
+ * Add an existing filter instance to a filter graph.
  *
  * @param graph  the filter graph
  * @param filter the filter to be added
@@ -48,7 +48,7 @@ AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
 
 /**
- * Checks for the validity of graph.
+ * Check for the validity of graph.
  *
  * A graph is considered valid if all its input and output pads are
  * connected.
@@ -58,19 +58,19 @@ int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
 int avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
 
 /**
- * Configures all the links of graphctx.
+ * Configure all the links of graphctx.
  *
  * @return 0 in case of success, a negative value otherwise
  */
 int avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
 
 /**
- * Configures the formats of all the links in the graph.
+ * Configure the formats of all the links in the graph.
  */
 int avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
 
 /**
- * Frees a graph and destroys its links.
+ * Free a graph and destroy its links.
  */
 void avfilter_graph_destroy(AVFilterGraph *graph);
 
index e69f295..510b4b3 100644 (file)
@@ -37,7 +37,7 @@ typedef struct AVFilterInOut {
 } AVFilterInOut;
 
 /**
- * Adds a graph described by a string to a graph.
+ * Add a graph described by a string to a graph.
  *
  * @param graph   the filter graph where to link the parsed graph context
  * @param filters string to be parsed
index 7f5baa0..669ec9d 100644 (file)
@@ -288,7 +288,7 @@ int av_parse_color(uint8_t *rgba_color, const char *color_string, void *log_ctx)
 }
 
 /**
- * Stores the value in the field in ctx that is named like key.
+ * Store the value in the field in ctx that is named like key.
  * ctx must be an AVClass context, storing is done using AVOptions.
  *
  * @param buf the string to parse, buf will be updated to point at the
index f699e9d..e8e1e1a 100644 (file)
@@ -28,8 +28,8 @@
 #include "libavcodec/opt.h"
 
 /**
- * Unescapes the given string until a non escaped terminating char,
- * and returns the token corresponding to the unescaped string.
+ * Unescape the given string until a non escaped terminating char,
+ * and return the token corresponding to the unescaped string.
  *
  * The normal \ and ' escaping is supported. Leading and trailing
  * whitespaces are removed.
@@ -43,7 +43,7 @@
 char *av_get_token(const char **buf, const char *term);
 
 /**
- * Puts the RGBA values that correspond to color_string in rgba_color.
+ * Put the RGBA values that correspond to color_string in rgba_color.
  *
  * @param color_string a string specifying a color. It can be the name of
  * a color (case insensitive match) or a 0xRRGGBB[AA] sequence,
@@ -62,7 +62,7 @@ char *av_get_token(const char **buf, const char *term);
 int av_parse_color(uint8_t *rgba_color, const char *color_string, void *log_ctx);
 
 /**
- * Parses the key/value pairs list in opts. For each key/value pair
+ * Parse the key/value pairs list in opts. For each key/value pair
  * found, stores the value in the field in ctx that is named like the
  * key. ctx must be an AVClass context, storing is done using
  * AVOptions.
index 283b5b9..a7204fc 100644 (file)
 unsigned avformat_version(void);
 
 /**
- * Returns the libavformat build-time configuration.
+ * Return the libavformat build-time configuration.
  */
 const char *avformat_configuration(void);
 
 /**
- * Returns the libavformat license.
+ * Return the libavformat license.
  */
 const char *avformat_license(void);
 
@@ -130,7 +130,7 @@ typedef struct AVMetadata AVMetadata;
 typedef struct AVMetadataConv AVMetadataConv;
 
 /**
- * Gets a metadata element with matching key.
+ * Get a metadata element with matching key.
  * @param prev Set to the previous matching element to find the next.
  *             If set to NULL the first matching element is returned.
  * @param flags Allows case as well as suffix-insensitive comparisons.
@@ -141,7 +141,7 @@ av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int f
 
 #if LIBAVFORMAT_VERSION_MAJOR == 52
 /**
- * Sets the given tag in m, overwriting an existing tag.
+ * Set the given tag in m, overwriting an existing tag.
  * @param key tag key to add to m (will be av_strduped)
  * @param value tag value to add to m (will be av_strduped)
  * @return >= 0 on success otherwise an error code <0
@@ -151,7 +151,7 @@ attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const
 #endif
 
 /**
- * Sets the given tag in m, overwriting an existing tag.
+ * Set the given tag in m, overwriting an existing tag.
  * @param key tag key to add to m (will be av_strduped depending on flags)
  * @param value tag value to add to m (will be av_strduped depending on flags).
  *        Passing a NULL value will cause an existing tag to be deleted.
@@ -160,7 +160,7 @@ attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const
 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
 
 /**
- * Converts all the metadata sets from ctx according to the source and
+ * Convert all the metadata sets from ctx according to the source and
  * destination conversion tables. If one of the tables is NULL, then
  * tags are converted to/from ffmpeg generic tag names.
  * @param d_conv destination tags format conversion table
@@ -170,7 +170,7 @@ void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
                                                   const AVMetadataConv *s_conv);
 
 /**
- * Frees all the memory allocated for an AVMetadata struct.
+ * Free all the memory allocated for an AVMetadata struct.
  */
 void av_metadata_free(AVMetadata **m);
 
@@ -179,7 +179,7 @@ void av_metadata_free(AVMetadata **m);
 
 
 /**
- * Allocates and reads the payload of a packet and initializes its
+ * Allocate and read the payload of a packet and initialize its
  * fields with default values.
  *
  * @param pkt packet
@@ -349,18 +349,18 @@ typedef struct AVInputFormat {
     /** General purpose read-only value that the format can use. */
     int value;
 
-    /** Starts/resumes playing - only meaningful if using a network-based format
+    /** Start/resume playing - only meaningful if using a network-based format
        (RTSP). */
     int (*read_play)(struct AVFormatContext *);
 
-    /** Pauses playing - only meaningful if using a network-based format
+    /** Pause playing - only meaningful if using a network-based format
        (RTSP). */
     int (*read_pause)(struct AVFormatContext *);
 
     const struct AVCodecTag * const *codec_tag;
 
     /**
-     * Seeks to timestamp ts.
+     * Seek to timestamp ts.
      * Seeking will be done so that the point from which all active streams
      * can be presented successfully will be closest to ts and within min/max_ts.
      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
@@ -790,8 +790,8 @@ attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
 #endif
 
 /**
- * Returns the output format in the list of registered output formats
- * which best matches the provided parameters, or returns NULL if
+ * Return the output format in the list of registered output formats
+ * which best matches the provided parameters, or return NULL if
  * there is no match.
  *
  * @param short_name if non-NULL checks if short_name matches with the
@@ -806,14 +806,14 @@ AVOutputFormat *av_guess_format(const char *short_name,
                                 const char *mime_type);
 
 /**
- * Guesses the codec ID based upon muxer and filename.
+ * Guess the codec ID based upon muxer and filename.
  */
 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
                             const char *filename, const char *mime_type,
                             enum AVMediaType type);
 
 /**
- * Sends a nice hexadecimal dump of a buffer to the specified file stream.
+ * Send a nice hexadecimal dump of a buffer to the specified file stream.
  *
  * @param f The file stream pointer where the dump should be sent to.
  * @param buf buffer
@@ -824,7 +824,7 @@ enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
 void av_hex_dump(FILE *f, uint8_t *buf, int size);
 
 /**
- * Sends a nice hexadecimal dump of a buffer to the log.
+ * Send a nice hexadecimal dump of a buffer to the log.
  *
  * @param avcl A pointer to an arbitrary struct of which the first field is a
  * pointer to an AVClass struct.
@@ -838,7 +838,7 @@ void av_hex_dump(FILE *f, uint8_t *buf, int size);
 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
 
 /**
- * Sends a nice dump of a packet to the specified file stream.
+ * Send a nice dump of a packet to the specified file stream.
  *
  * @param f The file stream pointer where the dump should be sent to.
  * @param pkt packet to dump
@@ -847,7 +847,7 @@ void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
 
 /**
- * Sends a nice dump of a packet to the log.
+ * Send a nice dump of a packet to the log.
  *
  * @param avcl A pointer to an arbitrary struct of which the first field is a
  * pointer to an AVClass struct.
@@ -859,7 +859,7 @@ void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
 
 /**
- * Initializes libavformat and registers all the muxers, demuxers and
+ * Initialize libavformat and register all the muxers, demuxers and
  * protocols. If you do not call this function, then you can select
  * exactly which formats you want to support.
  *
@@ -870,7 +870,7 @@ void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
 void av_register_all(void);
 
 /**
- * Gets the CodecID for the given codec tag tag.
+ * Get the CodecID for the given codec tag tag.
  * If no codec id is found returns CODEC_ID_NONE.
  *
  * @param tags list of supported codec_id-codec_tag pairs, as stored
@@ -879,7 +879,7 @@ void av_register_all(void);
 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
 
 /**
- * Gets the codec tag for the given codec id id.
+ * Get the codec tag for the given codec id id.
  * If no codec tag is found returns 0.
  *
  * @param tags list of supported codec_id-codec_tag pairs, as stored
@@ -890,12 +890,12 @@ unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecI
 /* media file input */
 
 /**
- * Finds AVInputFormat based on the short name of the input format.
+ * Find AVInputFormat based on the short name of the input format.
  */
 AVInputFormat *av_find_input_format(const char *short_name);
 
 /**
- * Guesses the file format.
+ * Guess the file format.
  *
  * @param is_opened Whether the file is already opened; determines whether
  *                  demuxers with or without AVFMT_NOFILE are probed.
@@ -903,7 +903,7 @@ AVInputFormat *av_find_input_format(const char *short_name);
 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
 
 /**
- * Guesses the file format.
+ * Guess the file format.
  *
  * @param is_opened Whether the file is already opened; determines whether
  *                  demuxers with or without AVFMT_NOFILE are probed.
@@ -916,7 +916,7 @@ AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
 
 /**
- * Allocates all the structures needed to read an input stream.
+ * Allocate all the structures needed to read an input stream.
  *        This does not open the needed codecs for decoding the stream[s].
  */
 int av_open_input_stream(AVFormatContext **ic_ptr,
@@ -924,7 +924,7 @@ int av_open_input_stream(AVFormatContext **ic_ptr,
                          AVInputFormat *fmt, AVFormatParameters *ap);
 
 /**
- * Opens a media file as input. The codecs are not opened. Only the file
+ * Open a media file as input. The codecs are not opened. Only the file
  * header (if present) is read.
  *
  * @param ic_ptr The opened media file handle is put here.
@@ -948,14 +948,14 @@ attribute_deprecated AVFormatContext *av_alloc_format_context(void);
 #endif
 
 /**
- * Allocates an AVFormatContext.
+ * Allocate an AVFormatContext.
  * Can be freed with av_free() but do not forget to free everything you
  * explicitly allocated as well!
  */
 AVFormatContext *avformat_alloc_context(void);
 
 /**
- * Reads packets of a media file to get stream information. This
+ * Read packets of a media file to get stream information. This
  * is useful for file formats with no headers such as MPEG. This
  * function also computes the real framerate in case of MPEG-2 repeat
  * frame mode.
@@ -970,7 +970,7 @@ AVFormatContext *avformat_alloc_context(void);
 int av_find_stream_info(AVFormatContext *ic);
 
 /**
- * Reads a transport packet from a media file.
+ * Read a transport packet from a media file.
  *
  * This function is obsolete and should never be used.
  * Use av_read_frame() instead.
@@ -982,7 +982,7 @@ int av_find_stream_info(AVFormatContext *ic);
 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
 
 /**
- * Returns the next frame of a stream.
+ * Return the next frame of a stream.
  *
  * The returned packet is valid
  * until the next av_read_frame() or until av_close_input_file() and
@@ -1003,7 +1003,7 @@ int av_read_packet(AVFormatContext *s, AVPacket *pkt);
 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
 
 /**
- * Seeks to the keyframe at timestamp.
+ * Seek to the keyframe at timestamp.
  * 'timestamp' in 'stream_index'.
  * @param stream_index If stream_index is (-1), a default
  * stream is selected, and timestamp is automatically converted
@@ -1017,7 +1017,7 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                   int flags);
 
 /**
- * Seeks to timestamp ts.
+ * Seek to timestamp ts.
  * Seeking will be done so that the point from which all active streams
  * can be presented successfully will be closest to ts and within min/max_ts.
  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
@@ -1045,33 +1045,33 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
 
 /**
- * Starts playing a network-based stream (e.g. RTSP stream) at the
+ * Start playing a network-based stream (e.g. RTSP stream) at the
  * current position.
  */
 int av_read_play(AVFormatContext *s);
 
 /**
- * Pauses a network-based stream (e.g. RTSP stream).
+ * Pause a network-based stream (e.g. RTSP stream).
  *
  * Use av_read_play() to resume it.
  */
 int av_read_pause(AVFormatContext *s);
 
 /**
- * Frees a AVFormatContext allocated by av_open_input_stream.
+ * Free a AVFormatContext allocated by av_open_input_stream.
  * @param s context to free
  */
 void av_close_input_stream(AVFormatContext *s);
 
 /**
- * Closes a media file (but not its codecs).
+ * Close a media file (but not its codecs).
  *
  * @param s media file handle
  */
 void av_close_input_file(AVFormatContext *s);
 
 /**
- * Adds a new stream to a media file.
+ * Add a new stream to a media file.
  *
  * Can only be called in the read_header() function. If the flag
  * AVFMTCTX_NOHEADER is in the format context, then new streams
@@ -1084,7 +1084,7 @@ AVStream *av_new_stream(AVFormatContext *s, int id);
 AVProgram *av_new_program(AVFormatContext *s, int id);
 
 /**
- * Adds a new chapter.
+ * Add a new chapter.
  * This function is NOT part of the public API
  * and should ONLY be used by demuxers.
  *
@@ -1100,7 +1100,7 @@ AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
                           int64_t start, int64_t end, const char *title);
 
 /**
- * Sets the pts for a given stream.
+ * Set the pts for a given stream.
  *
  * @param s stream
  * @param pts_wrap_bits number of bits effectively used by the pts
@@ -1119,7 +1119,7 @@ void av_set_pts_info(AVStream *s, int pts_wrap_bits,
 int av_find_default_stream_index(AVFormatContext *s);
 
 /**
- * Gets the index for a specific timestamp.
+ * Get the index for a specific timestamp.
  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
  *                 to the timestamp which is <= the requested one, if backward
  *                 is 0, then it will be >=
@@ -1129,7 +1129,7 @@ int av_find_default_stream_index(AVFormatContext *s);
 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
 
 /**
- * Ensures the index uses less memory than the maximum specified in
+ * Ensure the index uses less memory than the maximum specified in
  * AVFormatContext.max_index_size by discarding entries if it grows
  * too large.
  * This function is not part of the public API and should only be called
@@ -1138,7 +1138,7 @@ int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
 void ff_reduce_index(AVFormatContext *s, int stream_index);
 
 /**
- * Adds an index entry into a sorted list. Updates the entry if the list
+ * Add an index entry into a sorted list. Update the entry if the list
  * already contains it.
  *
  * @param timestamp timestamp in the time base of the given stream
@@ -1147,7 +1147,7 @@ int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                        int size, int distance, int flags);
 
 /**
- * Does a binary search using av_index_search_timestamp() and
+ * Perform a binary search using av_index_search_timestamp() and
  * AVCodec.read_timestamp().
  * This is not supposed to be called directly by a user application,
  * but by demuxers.
@@ -1158,7 +1158,7 @@ int av_seek_frame_binary(AVFormatContext *s, int stream_index,
                          int64_t target_ts, int flags);
 
 /**
- * Updates cur_dts of all streams based on the given timestamp and AVStream.
+ * Update cur_dts of all streams based on the given timestamp and AVStream.
  *
  * Stream ref_st unchanged, others set cur_dts in their native time base.
  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
@@ -1168,7 +1168,7 @@ int av_seek_frame_binary(AVFormatContext *s, int stream_index,
 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
 
 /**
- * Does a binary search using read_timestamp().
+ * Perform a binary search using read_timestamp().
  * This is not supposed to be called directly by a user application,
  * but by demuxers.
  * @param target_ts target timestamp in the time base of the given stream
@@ -1211,7 +1211,7 @@ void av_url_split(char *proto,         int proto_size,
                   const char *url);
 
 /**
- * Allocates the stream private data and writes the stream header to an
+ * Allocate the stream private data and write the stream header to an
  * output media file.
  *
  * @param s media file handle
@@ -1220,7 +1220,7 @@ void av_url_split(char *proto,         int proto_size,
 int av_write_header(AVFormatContext *s);
 
 /**
- * Writes a packet to an output media file.
+ * Write a packet to an output media file.
  *
  * The packet shall contain one audio or video frame.
  * The packet must be correctly interleaved according to the container
@@ -1234,7 +1234,7 @@ int av_write_header(AVFormatContext *s);
 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
 
 /**
- * Writes a packet to an output media file ensuring correct interleaving.
+ * Write a packet to an output media file ensuring correct interleaving.
  *
  * The packet must contain one audio or video frame.
  * If the packets are already correctly interleaved, the application should
@@ -1251,7 +1251,7 @@ int av_write_frame(AVFormatContext *s, AVPacket *pkt);
 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
 
 /**
- * Interleaves a packet per dts in an output media file.
+ * Interleave a packet per dts in an output media file.
  *
  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
  * function, so they cannot be used after it. Note that calling av_free_packet()
@@ -1269,7 +1269,7 @@ int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
                                  AVPacket *pkt, int flush);
 
 /**
- * Writes the stream trailer to an output media file and frees the
+ * Write the stream trailer to an output media file and free the
  * file private data.
  *
  * May only be called after a successful call to av_write_header.
@@ -1286,14 +1286,14 @@ void dump_format(AVFormatContext *ic,
 
 #if LIBAVFORMAT_VERSION_MAJOR < 53
 /**
- * Parses width and height out of string str.
+ * Parse width and height out of string str.
  * @deprecated Use av_parse_video_frame_size instead.
  */
 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
                                           const char *str);
 
 /**
- * Converts framerate from a string to a fraction.
+ * Convert framerate from a string to a fraction.
  * @deprecated Use av_parse_video_frame_rate instead.
  */
 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
@@ -1301,7 +1301,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
 #endif
 
 /**
- * Parses datestr and returns a corresponding number of microseconds.
+ * Parse datestr and return a corresponding number of microseconds.
  * @param datestr String representing a date or a duration.
  * - If a date the syntax is:
  * @code
@@ -1312,7 +1312,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
  * interpreted as UTC.
  * If the year-month-day part is not specified it takes the current
  * year-month-day.
- * Returns the number of microseconds since 1st of January, 1970 up to
+ * @return the number of microseconds since 1st of January, 1970 up to
  * the time of the parsed date or INT64_MIN if datestr cannot be
  * successfully parsed.
  * - If a duration the syntax is:
@@ -1320,7 +1320,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
  *  [-]HH[:MM[:SS[.m...]]]
  *  [-]S+[.m...]
  * @endcode
- * Returns the number of microseconds contained in a time interval
+ * @return the number of microseconds contained in a time interval
  * with the specified duration or INT64_MIN if datestr cannot be
  * successfully parsed.
  * @param duration Flag which tells how to interpret datestr, if
@@ -1329,7 +1329,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
  */
 int64_t parse_date(const char *datestr, int duration);
 
-/** Gets the current time in microseconds. */
+/** Get the current time in microseconds. */
 int64_t av_gettime(void);
 
 /* ffm-specific for ffserver */
@@ -1339,7 +1339,7 @@ int ffm_write_write_index(int fd, int64_t pos);
 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
 
 /**
- * Attempts to find a specific tag in a URL.
+ * Attempt to find a specific tag in a URL.
  *
  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
  * Return 1 if found.
@@ -1347,7 +1347,7 @@ void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
 
 /**
- * Returns in 'buf' the path with '%d' replaced by a number.
+ * Return in 'buf' the path with '%d' replaced by a number.
  *
  * Also handles the '%0nd' format where 'n' is the total number
  * of digits and '%%'.
@@ -1362,7 +1362,7 @@ int av_get_frame_filename(char *buf, int buf_size,
                           const char *path, int number);
 
 /**
- * Checks whether filename actually is a numbered sequence generator.
+ * Check whether filename actually is a numbered sequence generator.
  *
  * @param filename possible numbered sequence string
  * @return 1 if a valid numbered sequence string, 0 otherwise
@@ -1370,7 +1370,7 @@ int av_get_frame_filename(char *buf, int buf_size,
 int av_filename_number_test(const char *filename);
 
 /**
- * Generates an SDP for an RTP session.
+ * Generate an SDP for an RTP session.
  *
  * @param ac array of AVFormatContexts describing the RTP streams. If the
  *           array is composed by only one context, such context can contain
@@ -1386,7 +1386,7 @@ int av_filename_number_test(const char *filename);
 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
 
 /**
- * Returns a positive value if the given filename has one of the given
+ * Return a positive value if the given filename has one of the given
  * extensions, 0 otherwise.
  *
  * @param extensions a comma-separated list of filename extensions
index f699a6e..dc8fdd6 100644 (file)
@@ -68,8 +68,8 @@ typedef struct URLPollEntry {
 typedef int URLInterruptCB(void);
 
 /**
- * Creates an URLContext for accessing to the resource indicated by
- * url, and opens it using the URLProtocol up.
+ * Create a URLContext for accessing to the resource indicated by
+ * url, and open it using the URLProtocol up.
  *
  * @param puc pointer to the location where, in case of success, the
  * function puts the pointer to the created URLContext
@@ -82,8 +82,8 @@ int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                        const char *url, int flags);
 
 /**
- * Creates an URLContext for accessing to the resource indicated by
- * url, but doesn't initiate the connection yet.
+ * Create a URLContext for accessing to the resource indicated by
+ * url, but do not initiate the connection yet.
  *
  * @param puc pointer to the location where, in case of success, the
  * function puts the pointer to the created URLContext
@@ -100,8 +100,8 @@ int url_alloc(URLContext **h, const char *url, int flags);
 int url_connect(URLContext *h);
 
 /**
- * Creates an URLContext for accessing to the resource indicated by
- * url, and opens it.
+ * Create an URLContext for accessing to the resource indicated by
+ * url, and open it.
  *
  * @param puc pointer to the location where, in case of success, the
  * function puts the pointer to the created URLContext
@@ -113,7 +113,7 @@ int url_connect(URLContext *h);
 int url_open(URLContext **h, const char *url, int flags);
 
 /**
- * Reads up to size bytes from the resource accessed by h, and stores
+ * Read up to size bytes from the resource accessed by h, and store
  * the read bytes in buf.
  *
  * @return The number of bytes actually read, or a negative value
@@ -135,7 +135,7 @@ int url_read_complete(URLContext *h, unsigned char *buf, int size);
 int url_write(URLContext *h, const unsigned char *buf, int size);
 
 /**
- * Changes the position that will be used by the next read/write
+ * Change the position that will be used by the next read/write
  * operation on the resource accessed by h.
  *
  * @param pos specifies the new position to set
@@ -151,7 +151,7 @@ int url_write(URLContext *h, const unsigned char *buf, int size);
 int64_t url_seek(URLContext *h, int64_t pos, int whence);
 
 /**
- * Closes the resource accessed by the URLContext h, and frees the
+ * Close the resource accessed by the URLContext h, and free the
  * memory used by it.
  *
  * @return a negative value if an error condition occurred, 0
@@ -160,7 +160,7 @@ int64_t url_seek(URLContext *h, int64_t pos, int whence);
 int url_close(URLContext *h);
 
 /**
- * Returns a non-zero value if the resource indicated by url
+ * Return a non-zero value if the resource indicated by url
  * exists, 0 otherwise.
  */
 int url_exist(const char *url);
@@ -282,7 +282,7 @@ attribute_deprecated int av_register_protocol(URLProtocol *protocol);
 #endif
 
 /**
- * Registers the URLProtocol protocol.
+ * Register the URLProtocol protocol.
  *
  * @param size the size of the URLProtocol struct referenced
  */
@@ -368,7 +368,7 @@ void url_fskip(ByteIOContext *s, int64_t offset);
 int64_t url_ftell(ByteIOContext *s);
 
 /**
- * Gets the filesize.
+ * Get the filesize.
  * @return filesize or AVERROR
  */
 int64_t url_fsize(ByteIOContext *s);
@@ -404,13 +404,13 @@ void put_flush_packet(ByteIOContext *s);
 
 
 /**
- * Reads size bytes from ByteIOContext into buf.
+ * Read size bytes from ByteIOContext into buf.
  * @return number of bytes read or AVERROR
  */
 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
 
 /**
- * Reads size bytes from ByteIOContext into buf.
+ * Read size bytes from ByteIOContext into buf.
  * This reads at most 1 packet. If that is not enough fewer bytes will be
  * returned.
  * @return number of bytes read or AVERROR
@@ -439,7 +439,7 @@ static inline int url_is_streamed(ByteIOContext *s)
 }
 
 /**
- * Creates and initializes a ByteIOContext for accessing the
+ * Create and initialize a ByteIOContext for accessing the
  * resource referenced by the URLContext h.
  * @note When the URLContext h has been opened in read+write mode, the
  * ByteIOContext can be used only for writing.
@@ -462,7 +462,7 @@ int url_resetbuf(ByteIOContext *s, int flags);
 #endif
 
 /**
- * Rewinds the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
+ * Rewind the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
  * Used after probing to avoid seeking.
  * Joins buf and s->buffer, taking any overlap into consideration.
  * @note s->buffer must overlap with buf or they can't be joined and the function fails
@@ -477,7 +477,7 @@ int url_resetbuf(ByteIOContext *s, int flags);
 int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size);
 
 /**
- * Creates and initializes a ByteIOContext for accessing the
+ * Create and initialize a ByteIOContext for accessing the
  * resource indicated by url.
  * @note When the resource indicated by url has been opened in
  * read+write mode, the ByteIOContext can be used only for writing.
index eac0031..7fb8968 100644 (file)
@@ -31,8 +31,8 @@ enum AVLangCodespace {
 };
 
 /**
- * Converts a language code to a target codespace. The source codespace is guessed.
- * Returns NULL if the provided lang is null or invalid.
+ * Convert a language code to a target codespace. The source codespace is guessed.
+ * @return NULL if the provided lang is null or invalid.
  */
 const char *av_convert_lang_to(const char *lang, enum AVLangCodespace target_codespace);
 
index a0ae943..cd003bb 100644 (file)
@@ -25,7 +25,7 @@
 #include "avio.h"
 
 /**
- * Sets custom HTTP headers.
+ * Set custom HTTP headers.
  * A trailing CRLF ("\r\n") is required for custom headers.
  * Passing in an empty header string ("\0") will reset to defaults.
  *
@@ -43,7 +43,7 @@
 void ff_http_set_headers(URLContext *h, const char *headers);
 
 /**
- * Enables or disables chunked transfer encoding. (default is enabled)
+ * Enable or disable chunked transfer encoding. (default is enabled)
  *
  * @param h URL context for this HTTP connection
  * @param is_chunked 0 to disable chunking, nonzero otherwise.
index 1f15304..ed6e450 100644 (file)
@@ -34,7 +34,7 @@
 #define ID3v2_DEFAULT_MAGIC "ID3"
 
 /**
- * Detects ID3v2 Header.
+ * Detect ID3v2 Header.
  * @buf   must be ID3v2_HEADER_SIZE byte long
  * @magic magic bytes to identify the header, machine byte order.
  * If in doubt, use ID3v2_DEFAULT_MAGIC.
@@ -42,7 +42,7 @@
 int ff_id3v2_match(const uint8_t *buf, const char *magic);
 
 /**
- * Gets the length of an ID3v2 tag.
+ * Get the length of an ID3v2 tag.
  * @buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
  * already detected ID3v2 tag
  */
index 2edc330..6ff28d3 100644 (file)
@@ -67,11 +67,11 @@ void ff_read_frame_flush(AVFormatContext *s);
 #define NTP_OFFSET 2208988800ULL
 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
 
-/** Gets the current time since NTP epoch in microseconds. */
+/** Get the current time since NTP epoch in microseconds. */
 uint64_t ff_ntp_time(void);
 
 /**
- * Probes a bytestream to determine the input format. Each time a probe returns
+ * Probe a bytestream to determine the input format. Each time a probe returns
  * with a score that is too low, the probe buffer size is increased and another
  * attempt is made. When the maximum probe size is reached, the input format
  * with the highest score is returned.
@@ -102,7 +102,7 @@ void ff_url_split(char *proto, int proto_size,
 #endif
 
 /**
- * Assembles a URL string from components. This is the reverse operation
+ * Assemble a URL string from components. This is the reverse operation
  * of av_url_split.
  *
  * Note, this requires networking to be initialized, so the caller must
@@ -127,7 +127,7 @@ int ff_url_join(char *str, int size, const char *proto,
                 int port, const char *fmt, ...);
 
 /**
- * Appends the media-specific SDP fragment for the media stream c
+ * Append the media-specific SDP fragment for the media stream c
  * to the buffer buff.
  *
  * Note, the buffer needs to be initialized, since it is appended to
index dd7640a..be890ed 100644 (file)
@@ -55,7 +55,7 @@ static int rtmp_close(URLContext *s)
 }
 
 /**
- * Opens RTMP connection and verifies that the stream can be played.
+ * Open RTMP connection and verify that the stream can be played.
  *
  * URL syntax: rtmp://server[:port][/app][/playpath][ keyword=value]...
  *             where 'app' is first one or two directories in the path
index 2238c13..d906662 100644 (file)
@@ -193,7 +193,7 @@ static void put_ebml_string(ByteIOContext *pb, unsigned int elementid, const cha
 }
 
 /**
- * Writes a void element of a given size. Useful for reserving space in
+ * Write a void element of a given size. Useful for reserving space in
  * the file to be written to later.
  *
  * @param size The number of bytes to reserve, which must be at least 2.
index 4d1db25..6fd0125 100644 (file)
@@ -196,7 +196,7 @@ static int find_prev_start_code(ByteIOContext *pb, int *size_ptr)
 #endif
 
 /**
- * Extracts stream types from a program stream map
+ * Extract stream types from a program stream map
  * According to ISO/IEC 13818-1 ('MPEG-2 Systems') table 2-35
  *
  * @return number of bytes occupied by PSM in the bitstream
index 5960338..d9ee987 100644 (file)
@@ -239,7 +239,7 @@ static int discard_pid(MpegTSContext *ts, unsigned int pid)
 }
 
 /**
- *  Assembles PES packets out of TS packets, and then calls the "section_cb"
+ *  Assemble PES packets out of TS packets, and then call the "section_cb"
  *  function when they are complete.
  */
 static void write_section_data(AVFormatContext *s, MpegTSFilter *tss1,
index 061cd87..a11be96 100644 (file)
@@ -242,7 +242,7 @@ static void build_frame_code(AVFormatContext *s){
 }
 
 /**
- * Gets the length in bytes which is needed to store val as v.
+ * Get the length in bytes which is needed to store val as v.
  */
 static int get_length(uint64_t val){
     int i=1;
@@ -269,7 +269,7 @@ static void put_tt(NUTContext *nut, StreamContext *nus, ByteIOContext *bc, uint6
 }
 
 /**
- * Stores a string as vb.
+ * Store a string as vb.
  */
 static void put_str(ByteIOContext *bc, const char *string){
     int len= strlen(string);
index 23d4ebc..37e9891 100644 (file)
@@ -83,7 +83,7 @@ typedef struct RTMPPacket {
 } RTMPPacket;
 
 /**
- * Creates new RTMP packet with given attributes.
+ * Create new RTMP packet with given attributes.
  *
  * @param pkt        packet
  * @param channel_id packet channel ID
@@ -96,14 +96,14 @@ int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
                           int timestamp, int size);
 
 /**
- * Frees RTMP packet.
+ * Free RTMP packet.
  *
  * @param pkt packet
  */
 void ff_rtmp_packet_destroy(RTMPPacket *pkt);
 
 /**
- * Reads RTMP packet sent by the server.
+ * Read RTMP packet sent by the server.
  *
  * @param h          reader context
  * @param p          packet
@@ -116,7 +116,7 @@ int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
                         int chunk_size, RTMPPacket *prev_pkt);
 
 /**
- * Sends RTMP packet to the server.
+ * Send RTMP packet to the server.
  *
  * @param h          reader context
  * @param p          packet to send
@@ -129,7 +129,7 @@ int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p,
                          int chunk_size, RTMPPacket *prev_pkt);
 
 /**
- * Prints information and contents of RTMP packet.
+ * Print information and contents of RTMP packet.
  *
  * @param h          output context
  * @param p          packet to dump
@@ -143,7 +143,7 @@ void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p);
  */
 
 /**
- * Calculates number of bytes taken by first AMF entry in data.
+ * Calculate number of bytes taken by first AMF entry in data.
  *
  * @param data input data
  * @param data_end input buffer end
@@ -152,7 +152,7 @@ void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p);
 int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end);
 
 /**
- * Retrieves value of given AMF object field in string form.
+ * Retrieve value of given AMF object field in string form.
  *
  * @param data     AMF object data
  * @param data_end input buffer end
@@ -165,7 +165,7 @@ int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
                            const uint8_t *name, uint8_t *dst, int dst_size);
 
 /**
- * Writes boolean value in AMF format to buffer.
+ * Write boolean value in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param val value to write
@@ -173,7 +173,7 @@ int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
 void ff_amf_write_bool(uint8_t **dst, int val);
 
 /**
- * Writes number in AMF format to buffer.
+ * Write number in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param num value to write
@@ -181,7 +181,7 @@ void ff_amf_write_bool(uint8_t **dst, int val);
 void ff_amf_write_number(uint8_t **dst, double num);
 
 /**
- * Writes string in AMF format to buffer.
+ * Write string in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param str string to write
@@ -189,21 +189,21 @@ void ff_amf_write_number(uint8_t **dst, double num);
 void ff_amf_write_string(uint8_t **dst, const char *str);
 
 /**
- * Writes AMF NULL value to buffer.
+ * Write AMF NULL value to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
 void ff_amf_write_null(uint8_t **dst);
 
 /**
- * Writes marker for AMF object to buffer.
+ * Write marker for AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
 void ff_amf_write_object_start(uint8_t **dst);
 
 /**
- * Writes string used as field name in AMF object to buffer.
+ * Write string used as field name in AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param str string to write
@@ -211,7 +211,7 @@ void ff_amf_write_object_start(uint8_t **dst);
 void ff_amf_write_field_name(uint8_t **dst, const char *str);
 
 /**
- * Writes marker for end of AMF object to buffer.
+ * Write marker for end of AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
index a02bad5..aca1fd3 100644 (file)
@@ -102,7 +102,7 @@ static const uint8_t rtmp_server_key[] = {
 };
 
 /**
- * Generates 'connect' call and sends it to the server.
+ * Generate 'connect' call and send it to the server.
  */
 static void gen_connect(URLContext *s, RTMPContext *rt, const char *proto,
                         const char *host, int port)
@@ -154,7 +154,7 @@ static void gen_connect(URLContext *s, RTMPContext *rt, const char *proto,
 }
 
 /**
- * Generates 'releaseStream' call and sends it to the server. It should make
+ * Generate 'releaseStream' call and send it to the server. It should make
  * the server release some channel for media streams.
  */
 static void gen_release_stream(URLContext *s, RTMPContext *rt)
@@ -177,7 +177,7 @@ static void gen_release_stream(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Generates 'FCPublish' call and sends it to the server. It should make
+ * Generate 'FCPublish' call and send it to the server. It should make
  * the server preapare for receiving media streams.
  */
 static void gen_fcpublish_stream(URLContext *s, RTMPContext *rt)
@@ -200,7 +200,7 @@ static void gen_fcpublish_stream(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Generates 'FCUnpublish' call and sends it to the server. It should make
+ * Generate 'FCUnpublish' call and send it to the server. It should make
  * the server destroy stream.
  */
 static void gen_fcunpublish_stream(URLContext *s, RTMPContext *rt)
@@ -223,7 +223,7 @@ static void gen_fcunpublish_stream(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Generates 'createStream' call and sends it to the server. It should make
+ * Generate 'createStream' call and send it to the server. It should make
  * the server allocate some channel for media streams.
  */
 static void gen_create_stream(URLContext *s, RTMPContext *rt)
@@ -245,7 +245,7 @@ static void gen_create_stream(URLContext *s, RTMPContext *rt)
 
 
 /**
- * Generates 'deleteStream' call and sends it to the server. It should make
+ * Generate 'deleteStream' call and send it to the server. It should make
  * the server remove some channel for media streams.
  */
 static void gen_delete_stream(URLContext *s, RTMPContext *rt)
@@ -267,7 +267,7 @@ static void gen_delete_stream(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Generates 'play' call and sends it to the server, then pings the server
+ * Generate 'play' call and send it to the server, then ping the server
  * to start actual playing.
  */
 static void gen_play(URLContext *s, RTMPContext *rt)
@@ -302,7 +302,7 @@ static void gen_play(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Generates 'publish' call and sends it to the server.
+ * Generate 'publish' call and send it to the server.
  */
 static void gen_publish(URLContext *s, RTMPContext *rt)
 {
@@ -326,7 +326,7 @@ static void gen_publish(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Generates ping reply and sends it to the server.
+ * Generate ping reply and send it to the server.
  */
 static void gen_pong(URLContext *s, RTMPContext *rt, RTMPPacket *ppkt)
 {
@@ -342,7 +342,7 @@ static void gen_pong(URLContext *s, RTMPContext *rt, RTMPPacket *ppkt)
 }
 
 /**
- * Generates report on bytes read so far and sends it to the server.
+ * Generate report on bytes read so far and send it to the server.
  */
 static void gen_bytes_read(URLContext *s, RTMPContext *rt, uint32_t ts)
 {
@@ -361,7 +361,7 @@ static void gen_bytes_read(URLContext *s, RTMPContext *rt, uint32_t ts)
 #define HMAC_OPAD_VAL 0x5C
 
 /**
- * Calculates HMAC-SHA2 digest for RTMP handshake packets.
+ * Calculate HMAC-SHA2 digest for RTMP handshake packets.
  *
  * @param src    input buffer
  * @param len    input buffer length (should be 1536)
@@ -410,7 +410,7 @@ static void rtmp_calc_digest(const uint8_t *src, int len, int gap,
 }
 
 /**
- * Puts HMAC-SHA2 digest of packet data (except for the bytes where this digest
+ * Put HMAC-SHA2 digest of packet data (except for the bytes where this digest
  * will be stored) into that packet.
  *
  * @param buf handshake data (1536 bytes)
@@ -431,7 +431,7 @@ static int rtmp_handshake_imprint_with_digest(uint8_t *buf)
 }
 
 /**
- * Verifies that the received server response has the expected digest value.
+ * Verify that the received server response has the expected digest value.
  *
  * @param buf handshake data received from the server (1536 bytes)
  * @param off position to search digest offset from
@@ -455,7 +455,7 @@ static int rtmp_validate_digest(uint8_t *buf, int off)
 }
 
 /**
- * Performs handshake with the server by means of exchanging pseudorandom data
+ * Perform handshake with the server by means of exchanging pseudorandom data
  * signed with HMAC-SHA2 digest.
  *
  * @return 0 if handshake succeeds, negative value otherwise
@@ -540,7 +540,7 @@ static int rtmp_handshake(URLContext *s, RTMPContext *rt)
 }
 
 /**
- * Parses received packet and may perform some action depending on
+ * Parse received packet and possibly perform some action depending on
  * the packet contents.
  * @return 0 for no errors, negative values for serious errors which prevent
  *         further communications, positive values for uncritical errors
@@ -666,7 +666,7 @@ static int rtmp_parse_result(URLContext *s, RTMPContext *rt, RTMPPacket *pkt)
 }
 
 /**
- * Interacts with the server by receiving and sending RTMP packets until
+ * Interact with the server by receiving and sending RTMP packets until
  * there is some significant data (media data or expected status notification).
  *
  * @param s          reading context
@@ -791,7 +791,7 @@ static int rtmp_close(URLContext *h)
 }
 
 /**
- * Opens RTMP connection and verifies that the stream can be played.
+ * Open RTMP connection and verify that the stream can be played.
  *
  * URL syntax: rtmp://server[:port][/app][/playpath]
  *             where 'app' is first one or two directories in the path
index 4ab18bb..303e091 100644 (file)
@@ -1745,7 +1745,7 @@ int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int
 /*******************************************************/
 
 /**
- * Returns TRUE if the stream has accurate duration in any stream.
+ * Return TRUE if the stream has accurate duration in any stream.
  *
  * @return TRUE if the stream has accurate duration for at least one component.
  */
@@ -2924,7 +2924,7 @@ int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pk
 }
 
 /**
- * Interleaves an AVPacket correctly so it can be muxed.
+ * Interleave an AVPacket correctly so it can be muxed.
  * @param out the interleaved packet will be output here
  * @param in the input packet
  * @param flush 1 if no further packets are available as input and all
index 714f1f2..fe989a0 100644 (file)
@@ -26,7 +26,7 @@
 #include "metadata.h"
 
 /**
- * Calculates the length in bytes of a VorbisComment. This is the minimum
+ * Calculate the length in bytes of a VorbisComment. This is the minimum
  * size required by ff_vorbiscomment_write().
  *
  * @param m The metadata structure to be parsed. For no metadata, set to NULL.
index 1ca853d..f64d527 100644 (file)
@@ -28,14 +28,14 @@ extern const int av_aes_size;
 struct AVAES;
 
 /**
- * Initializes an AVAES context.
+ * Initialize an AVAES context.
  * @param key_bits 128, 192 or 256
  * @param decrypt 0 for encryption, 1 for decryption
  */
 int av_aes_init(struct AVAES *a, const uint8_t *key, int key_bits, int decrypt);
 
 /**
- * Encrypts / decrypts.
+ * Encrypt / decrypt.
  * @param count number of 16 byte blocks
  * @param dst destination array, can be equal to src
  * @param src source array, can be equal to dst
index 5deaf06..08ffb44 100644 (file)
 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
 
 /**
- * Returns the LIBAVUTIL_VERSION_INT constant.
+ * Return the LIBAVUTIL_VERSION_INT constant.
  */
 unsigned avutil_version(void);
 
 /**
- * Returns the libavutil build-time configuration.
+ * Return the libavutil build-time configuration.
  */
 const char *avutil_configuration(void);
 
 /**
- * Returns the libavutil license.
+ * Return the libavutil license.
  */
 const char *avutil_license(void);
 
index 477128a..6842936 100644 (file)
@@ -24,7 +24,7 @@
 #include <stdint.h>
 
 /**
- * Decodes the base64-encoded string in in and puts the decoded
+ * Decode the base64-encoded string in in and put the decoded
  * data in out.
  *
  * @param out_size size in bytes of the out buffer, it should be at
@@ -35,7 +35,7 @@
 int av_base64_decode(uint8_t *out, const char *in, int out_size);
 
 /**
- * Encodes in base64 the data in in and puts the resulting string
+ * Encode in base64 the data in in and put the resulting string
  * in out.
  *
  * @param out_size size in bytes of the out string, it should be at
index ee44175..fe9e83c 100644 (file)
@@ -98,7 +98,7 @@ static inline av_const int av_log2_16bit_c(unsigned int v)
 #endif
 
 /**
- * Clips a signed integer value into the amin-amax range.
+ * Clip a signed integer value into the amin-amax range.
  * @param a value to clip
  * @param amin minimum value of the clip range
  * @param amax maximum value of the clip range
@@ -112,7 +112,7 @@ static inline av_const int av_clip(int a, int amin, int amax)
 }
 
 /**
- * Clips a signed integer value into the 0-255 range.
+ * Clip a signed integer value into the 0-255 range.
  * @param a value to clip
  * @return clipped value
  */
@@ -123,7 +123,7 @@ static inline av_const uint8_t av_clip_uint8(int a)
 }
 
 /**
- * Clips a signed integer value into the -128,127 range.
+ * Clip a signed integer value into the -128,127 range.
  * @param a value to clip
  * @return clipped value
  */
@@ -134,7 +134,7 @@ static inline av_const int8_t av_clip_int8(int a)
 }
 
 /**
- * Clips a signed integer value into the 0-65535 range.
+ * Clip a signed integer value into the 0-65535 range.
  * @param a value to clip
  * @return clipped value
  */
@@ -145,7 +145,7 @@ static inline av_const uint16_t av_clip_uint16(int a)
 }
 
 /**
- * Clips a signed integer value into the -32768,32767 range.
+ * Clip a signed integer value into the -32768,32767 range.
  * @param a value to clip
  * @return clipped value
  */
@@ -156,7 +156,7 @@ static inline av_const int16_t av_clip_int16(int a)
 }
 
 /**
- * Clips a signed 64-bit integer value into the -2147483648,2147483647 range.
+ * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
  * @param a value to clip
  * @return clipped value
  */
@@ -167,7 +167,7 @@ static inline av_const int32_t av_clipl_int32(int64_t a)
 }
 
 /**
- * Clips a float value into the amin-amax range.
+ * Clip a float value into the amin-amax range.
  * @param a value to clip
  * @param amin minimum value of the clip range
  * @param amax maximum value of the clip range
@@ -180,7 +180,7 @@ static inline av_const float av_clipf(float a, float amin, float amax)
     else               return a;
 }
 
-/** Computes ceil(log2(x)).
+/** Compute ceil(log2(x)).
  * @param x value used to compute ceil(log2(x))
  * @return computed ceiling of log2(x)
  */
@@ -194,7 +194,7 @@ static inline av_const int av_ceil_log2(int x)
 
 /*!
  * \def GET_UTF8(val, GET_BYTE, ERROR)
- * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
+ * Convert a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
  * \param val is the output and should be of type uint32_t. It holds the converted
  * UCS-4 character and should be a left value.
  * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
@@ -222,7 +222,7 @@ static inline av_const int av_ceil_log2(int x)
 
 /*!
  * \def GET_UTF16(val, GET_16BIT, ERROR)
- * Converts a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form
+ * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form
  * \param val is the output and should be of type uint32_t. It holds the converted
  * UCS-4 character and should be a left value.
  * \param GET_16BIT gets two bytes of UTF-16 encoded data converted to native endianness.
@@ -246,7 +246,7 @@ static inline av_const int av_ceil_log2(int x)
 
 /*!
  * \def PUT_UTF8(val, tmp, PUT_BYTE)
- * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
+ * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
  * \param val is an input-only argument and should be of type uint32_t. It holds
  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
  * val is given as a function it is executed only once.
@@ -282,7 +282,7 @@ static inline av_const int av_ceil_log2(int x)
 
 /*!
  * \def PUT_UTF16(val, tmp, PUT_16BIT)
- * Converts a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
+ * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
  * \param val is an input-only argument and should be of type uint32_t. It holds
  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
  * val is given as a function it is executed only once.
index 2719bae..727b47f 100644 (file)
@@ -41,7 +41,7 @@ static AVCRC av_crc_table[AV_CRC_MAX][257];
 #endif
 
 /**
- * Initializes a CRC table.
+ * Initialize a CRC table.
  * @param ctx must be an array of size sizeof(AVCRC)*257 or sizeof(AVCRC)*1024
  * @param cts_size size of ctx in bytes
  * @param le If 1, the lowest bit represents the coefficient for the highest
@@ -88,7 +88,7 @@ int av_crc_init(AVCRC *ctx, int le, int bits, uint32_t poly, int ctx_size){
 }
 
 /**
- * Gets an initialized standard CRC table.
+ * Get an initialized standard CRC table.
  * @param crc_id ID of a standard CRC
  * @return a pointer to the CRC table or NULL on failure
  */
@@ -106,7 +106,7 @@ const AVCRC *av_crc_get_table(AVCRCId crc_id){
 }
 
 /**
- * Calculates the CRC of a block.
+ * Calculate the CRC of a block.
  * @param crc CRC of previous blocks if any or initial value for CRC
  * @return CRC updated with the data from the given block
  *
index 13a9a35..3cee903 100644 (file)
@@ -58,7 +58,7 @@
 #endif
 
 /**
- * Puts a description of the AVERROR code errnum in errbuf.
+ * Put a description of the AVERROR code errnum in errbuf.
  * In case of failure the global variable errno is set to indicate the
  * error. Even in case of failure av_strerror() will print a generic
  * error message indicating the errnum provided to errbuf.
index 38b4c25..7a4f5f0 100644 (file)
@@ -29,7 +29,7 @@
 typedef struct AVExpr AVExpr;
 
 /**
- * Parses and evaluates an expression.
+ * Parse and evaluate an expression.
  * Note, this is significantly slower than av_eval_expr().
  *
  * @param res a pointer to a double where is put the result value of
@@ -53,7 +53,7 @@ int av_parse_and_eval_expr(double *res, const char *s,
                            void *opaque, int log_offset, void *log_ctx);
 
 /**
- * Parses an expression.
+ * Parse an expression.
  *
  * @param expr a pointer where is put an AVExpr containing the parsed
  * value in case of successfull parsing, or NULL otherwise.
@@ -76,7 +76,7 @@ int av_parse_expr(AVExpr **expr, const char *s,
                   int log_offset, void *log_ctx);
 
 /**
- * Evaluates a previously parsed expression.
+ * Evaluate a previously parsed expression.
  *
  * @param const_values a zero terminated array of values for the identifiers from av_parse_expr() const_names
  * @param opaque a pointer which will be passed to all functions from funcs1 and funcs2
@@ -85,12 +85,12 @@ int av_parse_expr(AVExpr **expr, const char *s,
 double av_eval_expr(AVExpr *e, const double *const_values, void *opaque);
 
 /**
- * Frees a parsed expression previously created with av_parse_expr().
+ * Free a parsed expression previously created with av_parse_expr().
  */
 void av_free_expr(AVExpr *e);
 
 /**
- * Parses the string in numstr and returns its value as a double. If
+ * Parse the string in numstr and return its value as a double. If
  * the string is empty, contains only whitespaces, or does not contain
  * an initial substring that has the expected syntax for a
  * floating-point number, no conversion is performed. In this case,
index fb1ed47..999d0bf 100644 (file)
@@ -33,26 +33,26 @@ typedef struct AVFifoBuffer {
 } AVFifoBuffer;
 
 /**
- * Initializes an AVFifoBuffer.
+ * Initialize an AVFifoBuffer.
  * @param size of FIFO
  * @return AVFifoBuffer or NULL in case of memory allocation failure
  */
 AVFifoBuffer *av_fifo_alloc(unsigned int size);
 
 /**
- * Frees an AVFifoBuffer.
+ * Free an AVFifoBuffer.
  * @param *f AVFifoBuffer to free
  */
 void av_fifo_free(AVFifoBuffer *f);
 
 /**
- * Resets the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
+ * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
  * @param *f AVFifoBuffer to reset
  */
 void av_fifo_reset(AVFifoBuffer *f);
 
 /**
- * Returns the amount of data in bytes in the AVFifoBuffer, that is the
+ * Return the amount of data in bytes in the AVFifoBuffer, that is the
  * amount of data you can read from it.
  * @param *f AVFifoBuffer to read from
  * @return size
@@ -60,7 +60,7 @@ void av_fifo_reset(AVFifoBuffer *f);
 int av_fifo_size(AVFifoBuffer *f);
 
 /**
- * Returns the amount of space in bytes in the AVFifoBuffer, that is the
+ * Return the amount of space in bytes in the AVFifoBuffer, that is the
  * amount of data you can write into it.
  * @param *f AVFifoBuffer to write into
  * @return size
@@ -68,7 +68,7 @@ int av_fifo_size(AVFifoBuffer *f);
 int av_fifo_space(AVFifoBuffer *f);
 
 /**
- * Feeds data from an AVFifoBuffer to a user-supplied callback.
+ * Feed data from an AVFifoBuffer to a user-supplied callback.
  * @param *f AVFifoBuffer to read from
  * @param buf_size number of bytes to read
  * @param *func generic read function
@@ -77,7 +77,7 @@ int av_fifo_space(AVFifoBuffer *f);
 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
 
 /**
- * Feeds data from a user-supplied callback to an AVFifoBuffer.
+ * Feed data from a user-supplied callback to an AVFifoBuffer.
  * @param *f AVFifoBuffer to write to
  * @param *src data source; non-const since it may be used as a
  * modifiable context by the function defined in func
@@ -92,7 +92,7 @@ int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)
 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
 
 /**
- * Resizes an AVFifoBuffer.
+ * Resize an AVFifoBuffer.
  * @param *f AVFifoBuffer to resize
  * @param size new AVFifoBuffer size in bytes
  * @return <0 for failure, >=0 otherwise
@@ -100,7 +100,7 @@ int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void
 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
 
 /**
- * Reads and discards the specified amount of data from an AVFifoBuffer.
+ * Read and discard the specified amount of data from an AVFifoBuffer.
  * @param *f AVFifoBuffer to read from
  * @param size amount of data to read in bytes
  */
index fb46acb..45f733c 100644 (file)
@@ -41,7 +41,7 @@ AVInteger av_add_i(AVInteger a, AVInteger b) av_const;
 AVInteger av_sub_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * Returns the rounded-down value of the base 2 logarithm of the given
+ * Return the rounded-down value of the base 2 logarithm of the given
  * AVInteger. This is simply the index of the most significant bit
  * which is 1, or 0 if all bits are 0.
  */
@@ -49,7 +49,7 @@ int av_log2_i(AVInteger a) av_const;
 AVInteger av_mul_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * Returns 0 if a==b, 1 if a>b and -1 if a<b.
+ * Return 0 if a==b, 1 if a>b and -1 if a<b.
  */
 int av_cmp_i(AVInteger a, AVInteger b) av_const;
 
@@ -61,23 +61,23 @@ int av_cmp_i(AVInteger a, AVInteger b) av_const;
 AVInteger av_shr_i(AVInteger a, int s) av_const;
 
 /**
- * Returns a % b.
+ * Return a % b.
  * @param quot a/b will be stored here.
  */
 AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b);
 
 /**
- * Returns a/b.
+ * Return a/b.
  */
 AVInteger av_div_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * Converts the given int64_t to an AVInteger.
+ * Convert the given int64_t to an AVInteger.
  */
 AVInteger av_int2i(int64_t a) av_const;
 
 /**
- * Converts the given AVInteger to an int64_t.
+ * Convert the given AVInteger to an int64_t.
  * If the AVInteger is too large to fit into an int64_t,
  * then only the least significant 64 bits will be used.
  */
index 08a34a6..9150074 100644 (file)
@@ -48,8 +48,8 @@
 
 
 /**
- * Marks a variable as used and prevents the compiler from optimizing it away.
- * This is usefull for asm that accesses varibles in ways that the compiler doesnt
+ * Mark a variable as used and prevent the compiler from optimizing it away.
+ * This is useful for asm that accesses varibles in ways that the compiler does not
  * understand
  */
 #ifndef attribute_used
 #include "libm.h"
 
 /**
- * Returns NULL if CONFIG_SMALL is true, otherwise the argument
+ * Return NULL if CONFIG_SMALL is true, otherwise the argument
  * without modification. Used to disable the definition of strings
  * (for example AVCodec long_names).
  */
index ac89d12..2867710 100644 (file)
@@ -30,7 +30,7 @@ typedef struct {
 void av_lfg_init(AVLFG *c, unsigned int seed);
 
 /**
- * Gets the next random unsigned 32-bit number using an ALFG.
+ * Get the next random unsigned 32-bit number using an ALFG.
  *
  * Please also consider a simple LCG like state= state*1664525+1013904223,
  * it may be good enough and faster for your specific use case.
@@ -41,7 +41,7 @@ static inline unsigned int av_lfg_get(AVLFG *c){
 }
 
 /**
- * Gets the next random unsigned 32-bit number using a MLFG.
+ * Get the next random unsigned 32-bit number using a MLFG.
  *
  * Please also consider av_lfg_get() above, it is faster.
  */
@@ -52,7 +52,7 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
 }
 
 /**
- * Gets the next two numbers generated by a Box-Muller Gaussian
+ * Get the next two numbers generated by a Box-Muller Gaussian
  * generator using the random numbers issued by lfg.
  *
  * @param out[2] array where are placed the two generated numbers
index 0a413f6..bcd1b1e 100644 (file)
@@ -25,7 +25,7 @@
 #include "avutil.h"
 
 /**
- * Describes the class of an AVClass context structure. That is an
+ * Describe the class of an AVClass context structure. That is an
  * arbitrary struct of which the first field is a pointer to an
  * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
  */
@@ -109,7 +109,7 @@ typedef struct {
 #define AV_LOG_DEBUG    48
 
 /**
- * Sends the specified message to the log if the level is less than or equal
+ * Send the specified message to the log if the level is less than or equal
  * to the current av_log_level. By default, all logging messages are sent to
  * stderr. This behavior can be altered by setting a different av_vlog callback
  * function.
index eb78890..3e56311 100644 (file)
@@ -63,31 +63,31 @@ enum AVRounding {
 };
 
 /**
- * Returns the greatest common divisor of a and b.
+ * Return the greatest common divisor of a and b.
  * If both a and b are 0 or either or both are <0 then behavior is
  * undefined.
  */
 int64_t av_const av_gcd(int64_t a, int64_t b);
 
 /**
- * Rescales a 64-bit integer with rounding to nearest.
+ * Rescale a 64-bit integer with rounding to nearest.
  * A simple a*b/c isn't possible as it can overflow.
  */
 int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const;
 
 /**
- * Rescales a 64-bit integer with specified rounding.
+ * Rescale a 64-bit integer with specified rounding.
  * A simple a*b/c isn't possible as it can overflow.
  */
 int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding) av_const;
 
 /**
- * Rescales a 64-bit integer by 2 rational numbers.
+ * Rescale a 64-bit integer by 2 rational numbers.
  */
 int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const;
 
 /**
- * Compares 2 timestamps each in its own timebases.
+ * Compare 2 timestamps each in its own timebases.
  * The result of the function is undefined if one of the timestamps
  * is outside the int64_t range when represented in the others timebase.
  * @return -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position
@@ -95,7 +95,7 @@ int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const;
 int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
 
 /**
- * Compares 2 integers modulo mod.
+ * Compare 2 integers modulo mod.
  * That is we compare integers a and b for which only the least
  * significant log2(mod) bits are known.
  *
index 2a93135..c5ec2ab 100644 (file)
@@ -63,7 +63,7 @@
 #endif
 
 /**
- * Allocates a block of size bytes with alignment suitable for all
+ * Allocate a block of size bytes with alignment suitable for all
  * memory accesses (including vectors if available on the CPU).
  * @param size Size in bytes for the memory block to be allocated.
  * @return Pointer to the allocated block, NULL if the block cannot
@@ -73,9 +73,9 @@
 void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
 
 /**
- * Allocates or reallocates a block of memory.
- * If ptr is NULL and size > 0, allocates a new block. If
- * size is zero, frees the memory block pointed to by ptr.
+ * Allocate or reallocate a block of memory.
+ * If ptr is NULL and size > 0, allocate a new block. If
+ * size is zero, free the memory block pointed to by ptr.
  * @param size Size in bytes for the memory block to be allocated or
  * reallocated.
  * @param ptr Pointer to a memory block already allocated with
@@ -87,7 +87,7 @@ void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
 void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
 
 /**
- * Frees a memory block which has been allocated with av_malloc(z)() or
+ * Free a memory block which has been allocated with av_malloc(z)() or
  * av_realloc().
  * @param ptr Pointer to the memory block which should be freed.
  * @note ptr = NULL is explicitly allowed.
@@ -97,9 +97,9 @@ void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
 void av_free(void *ptr);
 
 /**
- * Allocates a block of size bytes with alignment suitable for all
+ * Allocate a block of size bytes with alignment suitable for all
  * memory accesses (including vectors if available on the CPU) and
- * zeroes all the bytes of the block.
+ * zero all the bytes of the block.
  * @param size Size in bytes for the memory block to be allocated.
  * @return Pointer to the allocated block, NULL if it cannot be allocated.
  * @see av_malloc()
@@ -107,7 +107,7 @@ void av_free(void *ptr);
 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
 
 /**
- * Duplicates the string s.
+ * Duplicate the string s.
  * @param s string to be duplicated
  * @return Pointer to a newly allocated string containing a
  * copy of s or NULL if the string cannot be allocated.
@@ -115,7 +115,7 @@ void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
 char *av_strdup(const char *s) av_malloc_attrib;
 
 /**
- * Frees a memory block which has been allocated with av_malloc(z)() or
+ * Free a memory block which has been allocated with av_malloc(z)() or
  * av_realloc() and set the pointer pointing to it to NULL.
  * @param ptr Pointer to the pointer to the memory block which should
  * be freed.
index 8e4c85d..60ff4b8 100644 (file)
@@ -93,7 +93,7 @@ typedef struct AVPixFmtDescriptor{
 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
 
 /**
- * Reads a line from an image, and writes the values of the
+ * Read a line from an image, and write the values of the
  * pixel format component c to dst.
  *
  * @param data the array containing the pointers to the planes of the image
@@ -112,7 +112,7 @@ void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4],
                const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component);
 
 /**
- * Writes the values from src to the pixel format component c of an
+ * Write the values from src to the pixel format component c of an
  * image line.
  *
  * @param src array containing the values to write
@@ -129,7 +129,7 @@ void write_line(const uint16_t *src, uint8_t *data[4], const int linesize[4],
                 const AVPixFmtDescriptor *desc, int x, int y, int c, int w);
 
 /**
- * Returns the pixel format corresponding to name.
+ * Return the pixel format corresponding to name.
  *
  * If there is no pixel format with name name, then looks for a
  * pixel format with the name corresponding to the native endian
@@ -142,7 +142,7 @@ void write_line(const uint16_t *src, uint8_t *data[4], const int linesize[4],
 enum PixelFormat av_get_pix_fmt(const char *name);
 
 /**
- * Returns the number of bits per pixel used by the pixel format
+ * Return the number of bits per pixel used by the pixel format
  * described by pixdesc.
  *
  * The returned number of bits refers to the number of bits actually
index 11a9017..7f75063 100644 (file)
@@ -24,7 +24,7 @@
 #include <stdint.h>
 
 /**
- * Gets a seed to use in conjunction with random functions.
+ * Get a seed to use in conjunction with random functions.
  */
 uint32_t av_get_random_seed(void);
 
index 4d91f7b..2dd0c2c 100644 (file)
@@ -40,7 +40,7 @@ typedef struct AVRational{
 } AVRational;
 
 /**
- * Compares two rationals.
+ * Compare two rationals.
  * @param a first rational
  * @param b second rational
  * @return 0 if a==b, 1 if a>b and -1 if a<b
@@ -53,7 +53,7 @@ static inline int av_cmp_q(AVRational a, AVRational b){
 }
 
 /**
- * Converts rational to double.
+ * Convert rational to double.
  * @param a rational to convert
  * @return (double) a
  */
@@ -62,7 +62,7 @@ static inline double av_q2d(AVRational a){
 }
 
 /**
- * Reduces a fraction.
+ * Reduce a fraction.
  * This is useful for framerate calculations.
  * @param dst_num destination numerator
  * @param dst_den destination denominator
@@ -74,7 +74,7 @@ static inline double av_q2d(AVRational a){
 int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max);
 
 /**
- * Multiplies two rationals.
+ * Multiply two rationals.
  * @param b first rational
  * @param c second rational
  * @return b*c
@@ -82,7 +82,7 @@ int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
 AVRational av_mul_q(AVRational b, AVRational c) av_const;
 
 /**
- * Divides one rational by another.
+ * Divide one rational by another.
  * @param b first rational
  * @param c second rational
  * @return b/c
@@ -90,7 +90,7 @@ AVRational av_mul_q(AVRational b, AVRational c) av_const;
 AVRational av_div_q(AVRational b, AVRational c) av_const;
 
 /**
- * Adds two rationals.
+ * Add two rationals.
  * @param b first rational
  * @param c second rational
  * @return b+c
@@ -98,7 +98,7 @@ AVRational av_div_q(AVRational b, AVRational c) av_const;
 AVRational av_add_q(AVRational b, AVRational c) av_const;
 
 /**
- * Subtracts one rational from another.
+ * Subtract one rational from another.
  * @param b first rational
  * @param c second rational
  * @return b-c
@@ -106,7 +106,7 @@ AVRational av_add_q(AVRational b, AVRational c) av_const;
 AVRational av_sub_q(AVRational b, AVRational c) av_const;
 
 /**
- * Converts a double precision floating point number to a rational.
+ * Convert a double precision floating point number to a rational.
  * @param d double to convert
  * @param max the maximum allowed numerator and denominator
  * @return (AVRational) d
@@ -120,7 +120,7 @@ AVRational av_d2q(double d, int max) av_const;
 int av_nearer_q(AVRational q, AVRational q1, AVRational q2);
 
 /**
- * Finds the nearest value in q_list to q.
+ * Find the nearest value in q_list to q.
  * @param q_list an array of rationals terminated by {0, 0}
  * @return the index of the nearest value found in the array
  */
index 5a20230..543f5a1 100644 (file)
@@ -28,7 +28,7 @@ extern const int av_sha_size;
 struct AVSHA;
 
 /**
- * Initializes SHA-1 or SHA-2 hashing.
+ * Initialize SHA-1 or SHA-2 hashing.
  *
  * @param context pointer to the function context (of size av_sha_size)
  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
@@ -37,7 +37,7 @@ struct AVSHA;
 int av_sha_init(struct AVSHA* context, int bits);
 
 /**
- * Updates hash value.
+ * Update hash value.
  *
  * @param context hash function context
  * @param data    input data to update hash with
@@ -46,7 +46,7 @@ int av_sha_init(struct AVSHA* context, int bits);
 void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len);
 
 /**
- * Finishes hashing and output digest value.
+ * Finish hashing and output digest value.
  *
  * @param context hash function context
  * @param digest  buffer where output digest value is stored
index cf7c4a6..3ff5804 100644 (file)
@@ -28,7 +28,7 @@ extern const int av_sha1_size;
 struct AVSHA1;
 
 /**
- * Initializes SHA-1 hashing.
+ * Initialize SHA-1 hashing.
  *
  * @param context pointer to the function context (of size av_sha_size)
  * @deprecated use av_sha_init() instead
@@ -36,7 +36,7 @@ struct AVSHA1;
 void av_sha1_init(struct AVSHA1* context);
 
 /**
- * Updates hash value.
+ * Update hash value.
  *
  * @param context hash function context
  * @param data    input data to update hash with
@@ -46,7 +46,7 @@ void av_sha1_init(struct AVSHA1* context);
 void av_sha1_update(struct AVSHA1* context, const uint8_t* data, unsigned int len);
 
 /**
- * Finishes hashing and output digest value.
+ * Finish hashing and output digest value.
  *
  * @param context hash function context
  * @param digest  buffer where output digest value is stored
index dde2f10..bf09fd0 100644 (file)
@@ -33,7 +33,7 @@ struct AVTreeNode;
 extern const int av_tree_node_size;
 
 /**
- * Finds an element.
+ * Find an element.
  * @param root a pointer to the root node of the tree
  * @param next If next is not NULL, then next[0] will contain the previous
  *             element and next[1] the next element. If either does not exist,
@@ -44,7 +44,7 @@ extern const int av_tree_node_size;
 void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *key, const void *b), void *next[2]);
 
 /**
- * Inserts or removes an element.
+ * Insert or remove an element.
  * If *next is NULL, then the supplied element will be removed if it exists.
  * If *next is not NULL, then the supplied element will be inserted, unless
  * it already exists in the tree.
@@ -80,7 +80,7 @@ void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key,
 void av_tree_destroy(struct AVTreeNode *t);
 
 /**
- * Applies enu(opaque, &elem) to all the elements in the tree in a given range.
+ * Apply enu(opaque, &elem) to all the elements in the tree in a given range.
  *
  * @param cmp a comparison function that returns < 0 for a element below the
  *            range, > 0 for a element above the range and == 0 for a
index 4cfcf7c..0713c47 100644 (file)
 #define LIBPOSTPROC_IDENT       "postproc" AV_STRINGIFY(LIBPOSTPROC_VERSION)
 
 /**
- * Returns the LIBPOSTPROC_VERSION_INT constant.
+ * Return the LIBPOSTPROC_VERSION_INT constant.
  */
 unsigned postproc_version(void);
 
 /**
- * Returns the libpostproc build-time configuration.
+ * Return the libpostproc build-time configuration.
  */
 const char *postproc_configuration(void);
 
 /**
- * Returns the libpostproc license.
+ * Return the libpostproc license.
  */
 const char *postproc_license(void);
 
index 637ebc6..918d005 100644 (file)
@@ -1390,7 +1390,7 @@ DERING_CORE((%0, %1, 8)    ,(%%REGd, %1, 4),%%mm2,%%mm4,%%mm0,%%mm3,%%mm5,%%mm1,
 #endif //HAVE_ALTIVEC
 
 /**
- * Deinterlaces the given block by linearly interpolating every second line.
+ * Deinterlace the given block by linearly interpolating every second line.
  * will be called for every 8x8 block and can read & write from line 4-15
  * lines 0-3 have been passed through the deblock / dering filters already, but can be read, too.
  * lines 4-12 will be read into the deblocking filter and should be deinterlaced
@@ -1442,7 +1442,7 @@ static inline void RENAME(deInterlaceInterpolateLinear)(uint8_t src[], int strid
 }
 
 /**
- * Deinterlaces the given block by cubic interpolating every second line.
+ * Deinterlace the given block by cubic interpolating every second line.
  * will be called for every 8x8 block and can read & write from line 4-15
  * lines 0-3 have been passed through the deblock / dering filters already, but can be read, too.
  * lines 4-12 will be read into the deblocking filter and should be deinterlaced
@@ -1506,7 +1506,7 @@ DEINT_CUBIC((%%REGd, %1), (%0, %1, 8) , (%%REGd, %1, 4), (%%REGc)    , (%%REGc,
 }
 
 /**
- * Deinterlaces the given block by filtering every second line with a (-1 4 2 4 -1) filter.
+ * Deinterlace the given block by filtering every second line with a (-1 4 2 4 -1) filter.
  * will be called for every 8x8 block and can read & write from line 4-15
  * lines 0-3 have been passed through the deblock / dering filters already, but can be read, too.
  * lines 4-12 will be read into the deblocking filter and should be deinterlaced
@@ -1585,7 +1585,7 @@ DEINT_FF((%%REGd, %1), (%%REGd, %1, 2), (%0, %1, 8) , (%%REGd, %1, 4))
 }
 
 /**
- * Deinterlaces the given block by filtering every line with a (-1 2 6 2 -1) filter.
+ * Deinterlace the given block by filtering every line with a (-1 2 6 2 -1) filter.
  * will be called for every 8x8 block and can read & write from line 4-15
  * lines 0-3 have been passed through the deblock / dering filters already, but can be read, too.
  * lines 4-12 will be read into the deblocking filter and should be deinterlaced
@@ -1686,7 +1686,7 @@ DEINT_L5(%%mm1, %%mm0, (%%REGd, %1, 2), (%0, %1, 8)    , (%%REGd, %1, 4))
 }
 
 /**
- * Deinterlaces the given block by filtering all lines with a (1 2 1) filter.
+ * Deinterlace the given block by filtering all lines with a (1 2 1) filter.
  * will be called for every 8x8 block and can read & write from line 4-15
  * lines 0-3 have been passed through the deblock / dering filters already, but can be read, too.
  * lines 4-12 will be read into the deblocking filter and should be deinterlaced
@@ -1788,7 +1788,7 @@ static inline void RENAME(deInterlaceBlendLinear)(uint8_t src[], int stride, uin
 }
 
 /**
- * Deinterlaces the given block by applying a median filter to every second line.
+ * Deinterlace the given block by applying a median filter to every second line.
  * will be called for every 8x8 block and can read & write from line 4-15,
  * lines 0-3 have been passed through the deblock / dering filters already, but can be read, too.
  * lines 4-12 will be read into the deblocking filter and should be deinterlaced
@@ -3006,7 +3006,7 @@ static void RENAME(postProcess)(const uint8_t src[], int srcStride, uint8_t dst[
                                 const QP_STORE_T QPs[], int QPStride, int isColor, PPContext *c);
 
 /**
- * Copies a block from src to dst and fixes the blacklevel.
+ * Copy a block from src to dst and fixes the blacklevel.
  * levelFix == 0 -> do not touch the brighness & contrast
  */
 #undef REAL_SCALED_CPY
@@ -3138,7 +3138,7 @@ SIMPLE_CPY((%%REGa, %2), (%%REGa, %2, 2), (%%REGd, %3), (%%REGd, %3, 2))
 }
 
 /**
- * Duplicates the given 8 src pixels ? times upward
+ * Duplicate the given 8 src pixels ? times upward
  */
 static inline void RENAME(duplicate)(uint8_t src[], int stride)
 {
@@ -3163,7 +3163,7 @@ static inline void RENAME(duplicate)(uint8_t src[], int stride)
 }
 
 /**
- * Filters array of bytes (Y or U or V values)
+ * Filter array of bytes (Y or U or V values)
  */
 static void RENAME(postProcess)(const uint8_t src[], int srcStride, uint8_t dst[], int dstStride, int width, int height,
                                 const QP_STORE_T QPs[], int QPStride, int isColor, PPContext *c2)