avfilter/af_astats: improve options descriptions

Limin Wang committed 4 years ago

Commit 571e8ca1 parent 2f28f6c2 files · +7 −6Browse files

Unified · Split

2 files

doc/filters.texi +4 −3
libavfilter/af_astats.c +3 −3

@@ -2962,16 +2962,17 @@ this @code{lavfi.astats.Overall.Peak_count}. · 2961 unmodified lines
2962	2962	For description what each key means read below.
2963	2963
2964	2964	@item reset
2965		−Set number of frame after which stats are going to be recalculated.
	2965	+Set the number of frames over which cumulative stats are calculated before
	2966	+being reset
2966	2967	Default is disabled.
2967	2968
2968	2969	@item measure_perchannel
2969		−Select the entries which need to be measured per channel. The metadata keys can
	2970	+Select the parameters which are measured per channel. The metadata keys can
2970	2971	be used as flags, default is @option{all} which measures everything.
2971	2972	@option{none} disables all per channel measurement.
2972	2973
2973	2974	@item measure_overall
2974		−Select the entries which need to be measured overall. The metadata keys can
	2975	+Select the parameters which are measured overall. The metadata keys can
2975	2976	be used as flags, default is @option{all} which measures everything.
2976	2977	@option{none} disables all overall measurement.
2977	2978

libavfilter/af_astats.c+3−3

@@ -114,8 +114,8 @@ typedef struct AudioStatsContext { · 113 unmodified lines
114	114	static const AVOption astats_options[] = {
115	115	{ "length", "set the window length", OFFSET(time_constant), AV_OPT_TYPE_DOUBLE, {.dbl=.05}, 0, 10, FLAGS },
116	116	{ "metadata", "inject metadata in the filtergraph", OFFSET(metadata), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
117		− { "reset", "recalculate stats after this many frames", OFFSET(reset_count), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
118		− { "measure_perchannel", "only measure_perchannel these per-channel statistics", OFFSET(measure_perchannel), AV_OPT_TYPE_FLAGS, {.i64=MEASURE_ALL}, 0, UINT_MAX, FLAGS, "measure" },
	117	+ { "reset", "Set the number of frames over which cumulative stats are calculated before being reset", OFFSET(reset_count), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
	118	+ { "measure_perchannel", "Select the parameters which are measured per channel", OFFSET(measure_perchannel), AV_OPT_TYPE_FLAGS, {.i64=MEASURE_ALL}, 0, UINT_MAX, FLAGS, "measure" },
119	119	{ "none" , "", 0, AV_OPT_TYPE_CONST, {.i64=MEASURE_NONE }, 0, 0, FLAGS, "measure" },
120	120	{ "all" , "", 0, AV_OPT_TYPE_CONST, {.i64=MEASURE_ALL }, 0, 0, FLAGS, "measure" },
121	121	{ "DC_offset" , "", 0, AV_OPT_TYPE_CONST, {.i64=MEASURE_DC_OFFSET }, 0, 0, FLAGS, "measure" },
@@ -143,7 +143,7 @@ static const AVOption astats_options[] = { · 21 unmodified lines
143	143	{ "Number_of_NaNs" , "", 0, AV_OPT_TYPE_CONST, {.i64=MEASURE_NUMBER_OF_NANS }, 0, 0, FLAGS, "measure" },
144	144	{ "Number_of_Infs" , "", 0, AV_OPT_TYPE_CONST, {.i64=MEASURE_NUMBER_OF_INFS }, 0, 0, FLAGS, "measure" },
145	145	{ "Number_of_denormals" , "", 0, AV_OPT_TYPE_CONST, {.i64=MEASURE_NUMBER_OF_DENORMALS }, 0, 0, FLAGS, "measure" },
146		− { "measure_overall", "only measure_perchannel these overall statistics", OFFSET(measure_overall), AV_OPT_TYPE_FLAGS, {.i64=MEASURE_ALL}, 0, UINT_MAX, FLAGS, "measure" },
	146	+ { "measure_overall", "Select the parameters which are measured overall", OFFSET(measure_overall), AV_OPT_TYPE_FLAGS, {.i64=MEASURE_ALL}, 0, UINT_MAX, FLAGS, "measure" },
147	147	{ NULL }
148	148	};
149	149

avfilter/af_astats: improve options descriptions

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code