virtualenv/FFmpeg
1
0
Fork 0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-08-10 06:10:52 +02:00
Code Issues Releases Activity

all: Fix doxy comments wrongly designated as trailing ///<

Browse Source 
The ///< or /**< form of doxygen comments are only to be used
when the documentation follows the member and the comment
block starts on the same line as the member. This commit
fixes wrong uses of them; in particular, this fixes the comment
for mb_height in H.264 SPS's structure which was wrongly added
to mb_width.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
This commit is contained in:
Andreas Rheinhardt
2025-03-09 16:03:20 +01:00
parent e99faf28d5
commit a6c58450da
15 changed files with 29 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
fftools/cmdutils.h
View File

@@ -319,7 +319,7 @@ typedef struct Option {
} Option; } Option;
typedef struct OptionGroupDef { typedef struct OptionGroupDef {
/**< group name */ /** group name */
const char *name; const char *name;
/** /**
* Option to be used as group separator. Can be NULL for groups which * Option to be used as group separator. Can be NULL for groups which

4
fftools/ffmpeg_demux.c
View File

@@ -71,13 +71,13 @@ typedef struct DemuxStream {
int wrap_correction_done; int wrap_correction_done;
int saw_first_ts; int saw_first_ts;
///< dts of the first packet read for this stream (in AV_TIME_BASE units) /// dts of the first packet read for this stream (in AV_TIME_BASE units)
int64_t first_dts; int64_t first_dts;
/* predicted dts of the next packet read for this stream or (when there are /* predicted dts of the next packet read for this stream or (when there are
* several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */ * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
int64_t next_dts; int64_t next_dts;
///< dts of the last packet read for this stream (in AV_TIME_BASE units) /// dts of the last packet read for this stream (in AV_TIME_BASE units)
int64_t dts; int64_t dts;
const AVCodecDescriptor *codec_desc; const AVCodecDescriptor *codec_desc;

2
fftools/ffmpeg_filter.c
View File

@@ -160,7 +160,7 @@ typedef struct InputFilterPriv {
int64_t last_pts; int64_t last_pts;
int64_t end_pts; int64_t end_pts;
///< marks if sub2video_update should force an initialization /// marks if sub2video_update should force an initialization
unsigned int initialize; unsigned int initialize;
} sub2video; } sub2video;
} InputFilterPriv; } InputFilterPriv;

2
libavcodec/aacsbrdata.h
View File

@@ -41,7 +41,7 @@ static const int8_t sbr_offset[6][16] = {
{-2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 9, 11, 13, 16, 20, 24}, // 64000 Hz < fs_sbr {-2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 9, 11, 13, 16, 20, 24}, // 64000 Hz < fs_sbr
}; };
///< window coefficients for analysis/synthesis QMF banks /// window coefficients for analysis/synthesis QMF banks
static const DECLARE_ALIGNED(32, INTFLOAT, sbr_qmf_window_ds)[320] = { static const DECLARE_ALIGNED(32, INTFLOAT, sbr_qmf_window_ds)[320] = {
Q31( 0.0000000000f), Q31(-0.0005617692f), Q31( 0.0000000000f), Q31(-0.0005617692f),
Q31(-0.0004875227f), Q31(-0.0005040714f), Q31(-0.0004875227f), Q31(-0.0005040714f),

2
libavcodec/av1dec.c
View File

@@ -41,7 +41,7 @@
#include "progressframe.h" #include "progressframe.h"
#include "libavutil/refstruct.h" #include "libavutil/refstruct.h"
/**< same with Div_Lut defined in spec 7.11.3.7 */ /** same with Div_Lut defined in spec 7.11.3.7 */
static const uint16_t div_lut[AV1_DIV_LUT_NUM] = { static const uint16_t div_lut[AV1_DIV_LUT_NUM] = {
16384, 16320, 16257, 16194, 16132, 16070, 16009, 15948, 15888, 15828, 15768, 16384, 16320, 16257, 16194, 16132, 16070, 16009, 15948, 15888, 15828, 15768,
15709, 15650, 15592, 15534, 15477, 15420, 15364, 15308, 15252, 15197, 15142, 15709, 15650, 15592, 15534, 15477, 15420, 15364, 15308, 15252, 15197, 15142,

2
libavcodec/error_resilience.h
View File

@@ -25,7 +25,7 @@
#include "avcodec.h" #include "avcodec.h"
#include "me_cmp.h" #include "me_cmp.h"
///< current MB is the first after a resync marker /// current MB is the first after a resync marker
#define VP_START 1 #define VP_START 1
#define ER_AC_ERROR 2 #define ER_AC_ERROR 2
#define ER_DC_ERROR 4 #define ER_DC_ERROR 4

2
libavcodec/h264_ps.h
View File

@@ -57,7 +57,7 @@ typedef struct SPS {
int ref_frame_count; ///< num_ref_frames int ref_frame_count; ///< num_ref_frames
int gaps_in_frame_num_allowed_flag; int gaps_in_frame_num_allowed_flag;
int mb_width; ///< pic_width_in_mbs_minus1 + 1 int mb_width; ///< pic_width_in_mbs_minus1 + 1
///< (pic_height_in_map_units_minus1 + 1) * (2 - frame_mbs_only_flag) /// (pic_height_in_map_units_minus1 + 1) * (2 - frame_mbs_only_flag)
int mb_height; int mb_height;
int frame_mbs_only_flag; int frame_mbs_only_flag;
int mb_aff; ///< mb_adaptive_frame_field_flag int mb_aff; ///< mb_adaptive_frame_field_flag

6
libavcodec/h264dec.h
View File

@@ -305,11 +305,11 @@ typedef struct H264SliceContext {
DECLARE_ALIGNED(8, uint16_t, sub_mb_type)[4]; DECLARE_ALIGNED(8, uint16_t, sub_mb_type)[4];
///< as a DCT coefficient is int32_t in high depth, we need to reserve twice the space. /// as a DCT coefficient is int32_t in high depth, we need to reserve twice the space.
DECLARE_ALIGNED(16, int16_t, mb)[16 * 48 * 2]; DECLARE_ALIGNED(16, int16_t, mb)[16 * 48 * 2];
DECLARE_ALIGNED(16, int16_t, mb_luma_dc)[3][16 * 2]; DECLARE_ALIGNED(16, int16_t, mb_luma_dc)[3][16 * 2];
///< as mb is addressed by scantable[i] and scantable is uint8_t we can either /// as mb is addressed by scantable[i] and scantable is uint8_t we can either
///< check that i is not too large or ensure that there is some unused stuff after mb /// check that i is not too large or ensure that there is some unused stuff after mb
int16_t mb_padding[256 * 2]; int16_t mb_padding[256 * 2];
uint8_t (*mvd_table[2])[2]; uint8_t (*mvd_table[2])[2];

8
libavcodec/hevc/hevcdec.h
View File

@@ -207,9 +207,9 @@ typedef struct RefPicListTab {
typedef struct SliceHeader { typedef struct SliceHeader {
unsigned int pps_id; unsigned int pps_id;
///< address (in raster order) of the first block in the current slice segment /// address (in raster order) of the first block in the current slice segment
unsigned int slice_segment_addr; unsigned int slice_segment_addr;
///< address (in raster order) of the first block in the current slice /// address (in raster order) of the first block in the current slice
unsigned int slice_addr; unsigned int slice_addr;
enum HEVCSliceType slice_type; enum HEVCSliceType slice_type;
@@ -223,7 +223,7 @@ typedef struct SliceHeader {
uint8_t colour_plane_id; uint8_t colour_plane_id;
uint8_t inter_layer_pred; uint8_t inter_layer_pred;
///< RPS coded in the slice header itself is stored here /// RPS coded in the slice header itself is stored here
int short_term_ref_pic_set_sps_flag; int short_term_ref_pic_set_sps_flag;
int short_term_ref_pic_set_size; int short_term_ref_pic_set_size;
ShortTermRPS slice_rps; ShortTermRPS slice_rps;
@@ -513,7 +513,7 @@ typedef struct HEVCContext {
HEVCSEI sei; HEVCSEI sei;
struct AVMD5 *md5_ctx; struct AVMD5 *md5_ctx;
///< candidate references for the current frame /// candidate references for the current frame
RefPicList rps[NB_RPS_TYPE]; RefPicList rps[NB_RPS_TYPE];
const HEVCVPS *vps; ///< RefStruct reference const HEVCVPS *vps; ///< RefStruct reference

2
libavcodec/hevc/ps.h
View File

@@ -346,7 +346,7 @@ typedef struct HEVCSPS {
int sps_palette_predictor_initializer[3][HEVC_MAX_PALETTE_PREDICTOR_SIZE]; int sps_palette_predictor_initializer[3][HEVC_MAX_PALETTE_PREDICTOR_SIZE];
int motion_vector_resolution_control_idc; int motion_vector_resolution_control_idc;
///< coded frame dimension in various units /// coded frame dimension in various units
int width; int width;
int height; int height;
int ctb_width; int ctb_width;

2
libavcodec/mpegvideo.h
View File

@@ -372,7 +372,7 @@ typedef struct MpegEncContext {
/* MPEG-4 specific */ /* MPEG-4 specific */
int studio_profile; int studio_profile;
int dct_precision; int dct_precision;
///< number of bits to represent the fractional part of time (encoder only) /// number of bits to represent the fractional part of time (encoder only)
int time_increment_bits; int time_increment_bits;
int last_time_base; int last_time_base;
int time_base; ///< time in seconds of last I,P,S Frame int time_base; ///< time in seconds of last I,P,S Frame

19
libavcodec/wmavoice.c
View File

@@ -199,7 +199,7 @@ typedef struct WMAVoiceContext {
///< to #wmavoice_decode_packet() (since ///< to #wmavoice_decode_packet() (since
///< they're part of the previous superframe) ///< they're part of the previous superframe)
uint8_t sframe_cache[SFRAME_CACHE_MAXSIZE + AV_INPUT_BUFFER_PADDING_SIZE]; uint8_t sframe_cache[SFRAME_CACHE_MAXSIZE + AV_INPUT_BUFFER_PADDING_SIZE]; ///<
///< cache for superframe data split over ///< cache for superframe data split over
///< multiple packets ///< multiple packets
int sframe_cache_size; ///< set to >0 if we have data from an int sframe_cache_size; ///< set to >0 if we have data from an
@@ -249,10 +249,9 @@ typedef struct WMAVoiceContext {
///< only used for comfort noise in #pRNG() ///< only used for comfort noise in #pRNG()
int nb_superframes; ///< number of superframes in current packet int nb_superframes; ///< number of superframes in current packet
float gain_pred_err[6]; ///< cache for gain prediction float gain_pred_err[6]; ///< cache for gain prediction
float excitation_history[MAX_SIGNAL_HISTORY]; float excitation_history[MAX_SIGNAL_HISTORY]; ///< cache of the signal of
///< cache of the signal of previous ///< previous superframes, used as a history
///< superframes, used as a history for ///< for signal generation
///< signal generation
float synth_history[MAX_LSPS]; ///< see #excitation_history float synth_history[MAX_LSPS]; ///< see #excitation_history
/** /**
* @} * @}
@@ -272,18 +271,16 @@ typedef struct WMAVoiceContext {
float postfilter_agc; ///< gain control memory, used in float postfilter_agc; ///< gain control memory, used in
///< #adaptive_gain_control() ///< #adaptive_gain_control()
float dcf_mem[2]; ///< DC filter history float dcf_mem[2]; ///< DC filter history
/// zero filter output (i.e. excitation) by postfilter
float zero_exc_pf[MAX_SIGNAL_HISTORY + MAX_SFRAMESIZE]; float zero_exc_pf[MAX_SIGNAL_HISTORY + MAX_SFRAMESIZE];
///< zero filter output (i.e. excitation)
///< by postfilter
float denoise_filter_cache[MAX_FRAMESIZE]; float denoise_filter_cache[MAX_FRAMESIZE];
int denoise_filter_cache_size; ///< samples in #denoise_filter_cache int denoise_filter_cache_size; ///< samples in #denoise_filter_cache
/// aligned buffer for LPC tilting
DECLARE_ALIGNED(32, float, tilted_lpcs_pf)[0x82]; DECLARE_ALIGNED(32, float, tilted_lpcs_pf)[0x82];
///< aligned buffer for LPC tilting /// aligned buffer for denoise coefficients
DECLARE_ALIGNED(32, float, denoise_coeffs_pf)[0x82]; DECLARE_ALIGNED(32, float, denoise_coeffs_pf)[0x82];
///< aligned buffer for denoise coefficients /// aligned buffer for postfilter speech synthesis
DECLARE_ALIGNED(32, float, synth_filter_out_buf)[0x80 + MAX_LSPS_ALIGN16]; DECLARE_ALIGNED(32, float, synth_filter_out_buf)[0x80 + MAX_LSPS_ALIGN16];
///< aligned buffer for postfilter speech
///< synthesis
/** /**
* @} * @}
*/ */

4
libavfilter/avfilter_internal.h
View File

@@ -110,9 +110,9 @@ typedef struct FFFilterContext {
*/ */
unsigned ready; unsigned ready;
///< parsed expression /// parsed expression
struct AVExpr *enable; struct AVExpr *enable;
///< variable values for the enable expression /// variable values for the enable expression
double *var_values; double *var_values;
struct AVFilterCommand *command_queue; struct AVFilterCommand *command_queue;

2
libavformat/rdt.c
View File

@@ -293,7 +293,7 @@ ff_rdt_parse_header(const uint8_t *buf, int len,
return consumed + (get_bits_count(&gb) >> 3); return consumed + (get_bits_count(&gb) >> 3);
} }
/**< return 0 on packet, no more left, 1 on packet, 1 on partial packet... */ /** return 0 on packet, no more left, 1 on packet, 1 on partial packet... */
static int static int
rdt_parse_packet (AVFormatContext *ctx, PayloadContext *rdt, AVStream *st, rdt_parse_packet (AVFormatContext *ctx, PayloadContext *rdt, AVStream *st,
AVPacket *pkt, uint32_t *timestamp, AVPacket *pkt, uint32_t *timestamp,

2
libavutil/channel_layout.h
View File

@@ -45,7 +45,7 @@
*/ */
enum AVChannel { enum AVChannel {
///< Invalid channel index /// Invalid channel index
AV_CHAN_NONE = -1, AV_CHAN_NONE = -1,
AV_CHAN_FRONT_LEFT, AV_CHAN_FRONT_LEFT,
AV_CHAN_FRONT_RIGHT, AV_CHAN_FRONT_RIGHT,