mirror of
https://github.com/FFmpeg/FFmpeg.git
synced 2025-01-29 22:00:58 +02:00
doxygen: eliminate Qt-style doxygen syntax
This commit is contained in:
parent
714cd7e758
commit
c68fafe0d2
@ -653,7 +653,7 @@ static void decode_gains(AMRContext *p, const AMRNBSubframe *amr_subframe,
|
||||
static void apply_ir_filter(float *out, const AMRFixed *in,
|
||||
const float *filter)
|
||||
{
|
||||
float filter1[AMR_SUBFRAME_SIZE], //!< filters at pitch lag*1 and *2
|
||||
float filter1[AMR_SUBFRAME_SIZE], ///< filters at pitch lag*1 and *2
|
||||
filter2[AMR_SUBFRAME_SIZE];
|
||||
int lag = in->pitch_lag;
|
||||
float fac = in->pitch_fac;
|
||||
|
@ -51,7 +51,7 @@ typedef struct {
|
||||
/// or "7" for custom one
|
||||
VLC *tab; /// pointer to the table associated with tab_sel
|
||||
|
||||
//! the following are used only when tab_sel == 7
|
||||
/// the following are used only when tab_sel == 7
|
||||
IVIHuffDesc cust_desc; /// custom Huffman codebook descriptor
|
||||
VLC cust_tab; /// vlc table for custom codebook
|
||||
} IVIHuffTab;
|
||||
|
@ -45,35 +45,35 @@ static const char* sample_message =
|
||||
"a sample of this file.";
|
||||
|
||||
typedef struct SubStream {
|
||||
//! Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
|
||||
/// Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
|
||||
uint8_t restart_seen;
|
||||
|
||||
//@{
|
||||
/** restart header data */
|
||||
//! The type of noise to be used in the rematrix stage.
|
||||
/// The type of noise to be used in the rematrix stage.
|
||||
uint16_t noise_type;
|
||||
|
||||
//! The index of the first channel coded in this substream.
|
||||
/// The index of the first channel coded in this substream.
|
||||
uint8_t min_channel;
|
||||
//! The index of the last channel coded in this substream.
|
||||
/// The index of the last channel coded in this substream.
|
||||
uint8_t max_channel;
|
||||
//! The number of channels input into the rematrix stage.
|
||||
/// The number of channels input into the rematrix stage.
|
||||
uint8_t max_matrix_channel;
|
||||
//! For each channel output by the matrix, the output channel to map it to
|
||||
/// For each channel output by the matrix, the output channel to map it to
|
||||
uint8_t ch_assign[MAX_CHANNELS];
|
||||
|
||||
//! Channel coding parameters for channels in the substream
|
||||
/// Channel coding parameters for channels in the substream
|
||||
ChannelParams channel_params[MAX_CHANNELS];
|
||||
|
||||
//! The left shift applied to random noise in 0x31ea substreams.
|
||||
/// The left shift applied to random noise in 0x31ea substreams.
|
||||
uint8_t noise_shift;
|
||||
//! The current seed value for the pseudorandom noise generator(s).
|
||||
/// The current seed value for the pseudorandom noise generator(s).
|
||||
uint32_t noisegen_seed;
|
||||
|
||||
//! Set if the substream contains extra info to check the size of VLC blocks.
|
||||
/// Set if the substream contains extra info to check the size of VLC blocks.
|
||||
uint8_t data_check_present;
|
||||
|
||||
//! Bitmask of which parameter sets are conveyed in a decoding parameter block.
|
||||
/// Bitmask of which parameter sets are conveyed in a decoding parameter block.
|
||||
uint8_t param_presence_flags;
|
||||
#define PARAM_BLOCKSIZE (1 << 7)
|
||||
#define PARAM_MATRIX (1 << 6)
|
||||
@ -88,32 +88,32 @@ typedef struct SubStream {
|
||||
//@{
|
||||
/** matrix data */
|
||||
|
||||
//! Number of matrices to be applied.
|
||||
/// Number of matrices to be applied.
|
||||
uint8_t num_primitive_matrices;
|
||||
|
||||
//! matrix output channel
|
||||
/// matrix output channel
|
||||
uint8_t matrix_out_ch[MAX_MATRICES];
|
||||
|
||||
//! Whether the LSBs of the matrix output are encoded in the bitstream.
|
||||
/// Whether the LSBs of the matrix output are encoded in the bitstream.
|
||||
uint8_t lsb_bypass[MAX_MATRICES];
|
||||
//! Matrix coefficients, stored as 2.14 fixed point.
|
||||
/// Matrix coefficients, stored as 2.14 fixed point.
|
||||
int32_t matrix_coeff[MAX_MATRICES][MAX_CHANNELS];
|
||||
//! Left shift to apply to noise values in 0x31eb substreams.
|
||||
/// Left shift to apply to noise values in 0x31eb substreams.
|
||||
uint8_t matrix_noise_shift[MAX_MATRICES];
|
||||
//@}
|
||||
|
||||
//! Left shift to apply to Huffman-decoded residuals.
|
||||
/// Left shift to apply to Huffman-decoded residuals.
|
||||
uint8_t quant_step_size[MAX_CHANNELS];
|
||||
|
||||
//! number of PCM samples in current audio block
|
||||
/// number of PCM samples in current audio block
|
||||
uint16_t blocksize;
|
||||
//! Number of PCM samples decoded so far in this frame.
|
||||
/// Number of PCM samples decoded so far in this frame.
|
||||
uint16_t blockpos;
|
||||
|
||||
//! Left shift to apply to decoded PCM values to get final 24-bit output.
|
||||
/// Left shift to apply to decoded PCM values to get final 24-bit output.
|
||||
int8_t output_shift[MAX_CHANNELS];
|
||||
|
||||
//! Running XOR of all output samples.
|
||||
/// Running XOR of all output samples.
|
||||
int32_t lossless_check_data;
|
||||
|
||||
} SubStream;
|
||||
@ -122,21 +122,21 @@ typedef struct MLPDecodeContext {
|
||||
AVCodecContext *avctx;
|
||||
AVFrame frame;
|
||||
|
||||
//! Current access unit being read has a major sync.
|
||||
/// Current access unit being read has a major sync.
|
||||
int is_major_sync_unit;
|
||||
|
||||
//! Set if a valid major sync block has been read. Otherwise no decoding is possible.
|
||||
/// Set if a valid major sync block has been read. Otherwise no decoding is possible.
|
||||
uint8_t params_valid;
|
||||
|
||||
//! Number of substreams contained within this stream.
|
||||
/// Number of substreams contained within this stream.
|
||||
uint8_t num_substreams;
|
||||
|
||||
//! Index of the last substream to decode - further substreams are skipped.
|
||||
/// Index of the last substream to decode - further substreams are skipped.
|
||||
uint8_t max_decoded_substream;
|
||||
|
||||
//! number of PCM samples contained in each frame
|
||||
/// number of PCM samples contained in each frame
|
||||
int access_unit_size;
|
||||
//! next power of two above the number of samples in each frame
|
||||
/// next power of two above the number of samples in each frame
|
||||
int access_unit_size_pow2;
|
||||
|
||||
SubStream substream[MAX_SUBSTREAMS];
|
||||
|
@ -40,16 +40,16 @@
|
||||
typedef struct {
|
||||
/// @name QCELP excitation codebook parameters
|
||||
/// @{
|
||||
uint8_t cbsign[16]; ///!< sign of the codebook gain for each codebook subframe
|
||||
uint8_t cbgain[16]; ///!< unsigned codebook gain for each codebook subframe
|
||||
uint8_t cindex[16]; ///!< codebook index for each codebook subframe
|
||||
uint8_t cbsign[16]; ///< sign of the codebook gain for each codebook subframe
|
||||
uint8_t cbgain[16]; ///< unsigned codebook gain for each codebook subframe
|
||||
uint8_t cindex[16]; ///< codebook index for each codebook subframe
|
||||
/// @}
|
||||
|
||||
/// @name QCELP pitch prediction parameters
|
||||
/// @{
|
||||
uint8_t plag[4]; ///!< pitch lag for each pitch subframe
|
||||
uint8_t pfrac[4]; ///!< fractional pitch lag for each pitch subframe
|
||||
uint8_t pgain[4]; ///!< pitch gain for each pitch subframe
|
||||
uint8_t plag[4]; ///< pitch lag for each pitch subframe
|
||||
uint8_t pfrac[4]; ///< fractional pitch lag for each pitch subframe
|
||||
uint8_t pgain[4]; ///< pitch gain for each pitch subframe
|
||||
/// @}
|
||||
|
||||
/**
|
||||
@ -266,7 +266,7 @@ static const QCELPBitmap qcelp_rate_octave_bitmap[] = {
|
||||
* the QCELPContext
|
||||
*/
|
||||
static const QCELPBitmap * const qcelp_unpacking_bitmaps_per_rate[5] = {
|
||||
NULL, ///!< for SILENCE rate
|
||||
NULL, ///< for SILENCE rate
|
||||
qcelp_rate_octave_bitmap,
|
||||
qcelp_rate_quarter_bitmap,
|
||||
qcelp_rate_half_bitmap,
|
||||
@ -274,7 +274,7 @@ static const QCELPBitmap * const qcelp_unpacking_bitmaps_per_rate[5] = {
|
||||
};
|
||||
|
||||
static const uint16_t qcelp_unpacking_bitmaps_lengths[5] = {
|
||||
0, ///!< for SILENCE rate
|
||||
0, ///< for SILENCE rate
|
||||
FF_ARRAY_ELEMS(qcelp_rate_octave_bitmap),
|
||||
FF_ARRAY_ELEMS(qcelp_rate_quarter_bitmap),
|
||||
FF_ARRAY_ELEMS(qcelp_rate_half_bitmap),
|
||||
|
@ -27,7 +27,7 @@
|
||||
i = scan[coeff--]; \
|
||||
block[i] = (c) * quant[i];
|
||||
|
||||
//! aligns the bitstream to the give power of two
|
||||
/// aligns the bitstream to the given power of two
|
||||
#define ALIGN(a) \
|
||||
n = (-get_bits_count(gb)) & (a - 1); \
|
||||
if (n) {skip_bits(gb, n);}
|
||||
|
@ -293,7 +293,7 @@ typedef struct AVFormatParameters {
|
||||
#endif
|
||||
} AVFormatParameters;
|
||||
|
||||
//! Demuxer will use avio_open, no opened file should be provided by the caller.
|
||||
/// Demuxer will use avio_open, no opened file should be provided by the caller.
|
||||
#define AVFMT_NOFILE 0x0001
|
||||
#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
|
||||
#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
|
||||
|
@ -47,7 +47,7 @@ static int nuv_probe(AVProbeData *p) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
//! little macro to sanitize packet size
|
||||
/// little macro to sanitize packet size
|
||||
#define PKTSIZE(s) (s & 0xffffff)
|
||||
|
||||
/**
|
||||
|
@ -21,14 +21,14 @@
|
||||
|
||||
#include "avutil.h"
|
||||
#include "common.h"
|
||||
//! Avoid e.g. MPlayers fast_memcpy, it slows things down here.
|
||||
/// Avoid e.g. MPlayers fast_memcpy, it slows things down here.
|
||||
#undef memcpy
|
||||
#include <string.h>
|
||||
#include "lzo.h"
|
||||
|
||||
//! Define if we may write up to 12 bytes beyond the output buffer.
|
||||
/// Define if we may write up to 12 bytes beyond the output buffer.
|
||||
#define OUTBUF_PADDED 1
|
||||
//! Define if we may read up to 8 bytes beyond the input buffer.
|
||||
/// Define if we may read up to 8 bytes beyond the input buffer.
|
||||
#define INBUF_PADDED 1
|
||||
typedef struct LZOContext {
|
||||
const uint8_t *in, *in_end;
|
||||
|
@ -33,13 +33,13 @@
|
||||
|
||||
/** @name Error flags returned by av_lzo1x_decode
|
||||
* \{ */
|
||||
//! end of the input buffer reached before decoding finished
|
||||
/// end of the input buffer reached before decoding finished
|
||||
#define AV_LZO_INPUT_DEPLETED 1
|
||||
//! decoded data did not fit into output buffer
|
||||
/// decoded data did not fit into output buffer
|
||||
#define AV_LZO_OUTPUT_FULL 2
|
||||
//! a reference to previously decoded data was wrong
|
||||
/// a reference to previously decoded data was wrong
|
||||
#define AV_LZO_INVALID_BACKPTR 4
|
||||
//! a non-specific error in the compressed bitstream
|
||||
/// a non-specific error in the compressed bitstream
|
||||
#define AV_LZO_ERROR 8
|
||||
/** \} */
|
||||
|
||||
|
@ -644,7 +644,7 @@ static inline void postProcess(const uint8_t src[], int srcStride, uint8_t dst[]
|
||||
#endif
|
||||
postProcess_C(src, srcStride, dst, dstStride, width, height, QPs, QPStride, isColor, c);
|
||||
#endif
|
||||
#else //CONFIG_RUNTIME_CPUDETECT
|
||||
#else /* CONFIG_RUNTIME_CPUDETECT */
|
||||
#if HAVE_MMX2
|
||||
postProcess_MMX2(src, srcStride, dst, dstStride, width, height, QPs, QPStride, isColor, c);
|
||||
#elif HAVE_AMD3DNOW
|
||||
@ -656,7 +656,7 @@ static inline void postProcess(const uint8_t src[], int srcStride, uint8_t dst[]
|
||||
#else
|
||||
postProcess_C(src, srcStride, dst, dstStride, width, height, QPs, QPStride, isColor, c);
|
||||
#endif
|
||||
#endif //!CONFIG_RUNTIME_CPUDETECT
|
||||
#endif /* !CONFIG_RUNTIME_CPUDETECT */
|
||||
}
|
||||
|
||||
//static void postProcess(uint8_t src[], int srcStride, uint8_t dst[], int dstStride, int width, int height,
|
||||
|
Loading…
x
Reference in New Issue
Block a user