From ea73d72ab66003a9f55964b14af9651c6f15dfee Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Fri, 28 Apr 2006 00:15:01 +0000 Subject: [PATCH] add docs for -A, additional docs for --cue --- doc/html/documentation.html | 16 +++++++++++++++- man/flac.sgml | 31 ++++++++++++++++++++++++++++++- src/flac/main.c | 8 ++++++-- 3 files changed, 51 insertions(+), 4 deletions(-) diff --git a/doc/html/documentation.html b/doc/html/documentation.html index 7e9c5d2..b07004d 100644 --- a/doc/html/documentation.html +++ b/doc/html/documentation.html @@ -423,7 +423,8 @@ --cue=4.1 : decode from track 4, index 1 to the end of the stream
--cue=4.1- : decode from track 4, index 1 to the end of the stream
--cue=-4.1 : decode from the beginning of the stream up to, but not including, track 4, index 1
- --cue=2.1-2.4 : decode from track 2, index 1, up to, but not including, track 2, index 4 + --cue=2.1-2.4 : decode from track 2, index 1, up to, but not including, track 2, index 4
+ --cue=9.1-10.1 : decode from track 9 the way it would be played on a CD player; this works even if the CD has no 10th track. @@ -728,6 +729,19 @@ + + -A "function", --apodization="function" + + + Window audio data with given the apodization function. The functions are: bartlett, bartlett_hann, blackman, blackman_harris_4term_92db, connes, flattop, gauss(STDDEV), hamming, hann, kaiser_bessel, nuttall, rectangle, triangle, tukey(P), welch.
+ For gauss(STDDEV), STDDEV is the standard deviation (0<STDDEV<=0.5).
+ For tukey(P), P specifies the fraction of the window that is tapered (0<=P<=1; P=0 corresponds to "rectangle" and P=1 corresponds to "hann").
+ More than one -A option (up to 32) may be used. Any function that is specified erroneously is silently dropped. The encoder chooses suitable defaults in the absence of any -A options; any -A option specified replaces the default(s).
+ When more than one function is specified, then for every subframe the encoder will try each of them separately and choose the window that results in the smallest compressed subframe. Multiple functions can greatly increase the encoding time.
+ + + + -l #, --max-lpc-order=# diff --git a/man/flac.sgml b/man/flac.sgml index 122cdb0..e959e84 100644 --- a/man/flac.sgml +++ b/man/flac.sgml @@ -310,7 +310,9 @@ don't exist, the start of the stream (for the start point) or end of the stream (for the end point) will be used. The cuepoints are merely translated into sample - numbers then used as --skip and --until. + numbers then used as --skip and --until. A CD track can + always be cued by, for example, --cue=9.1-10.1 for track + 9, even if the CD has no 10th track. @@ -615,6 +617,33 @@ + function, =function + + + Window audio data with given the apodization function. + The functions are: bartlett, bartlett_hann, blackman, + blackman_harris_4term_92db, connes, flattop, gauss(STDDEV), + hamming, hann, kaiser_bessel, nuttall, rectangle, triangle, + tukey(P), welch. + For gauss(STDDEV), STDDEV is the standard deviation + (0<STDDEV<=0.5). + For tukey(P), P specifies the fraction of the window that + is tapered (0<=P<=1; P=0 corresponds to "rectangle" and + P=1 corresponds to "hann"). + More than one -A option (up to 32) may be used. Any + function that is specified erroneously is silently dropped. + The encoder chooses suitable defaults in the absence of any + -A options; any -A option specified replaces the default(s). + + When more than one function is specified, then for every + subframe the encoder will try each of them separately and + choose the window that results in the smallest compressed + subframe. Multiple functions can greatly increase the + encoding time. + + + + #, =# diff --git a/src/flac/main.c b/src/flac/main.c index c6ff5f1..1e5d59e 100644 --- a/src/flac/main.c +++ b/src/flac/main.c @@ -1363,6 +1363,9 @@ void show_explain() printf(" point) or after it (for the end point) will be\n"); printf(" used. The cuepoints are merely translated into\n"); printf(" sample numbers then used as --skip and --until.\n"); + printf(" A CD track can always be cued by, for example,\n"); + printf(" --cue=9.1-10.1 for track 9, even if the CD has\n"); + printf(" no 10th track.\n"); printf("encoding options:\n"); printf(" -V, --verify Verify a correct encoding by decoding the\n"); printf(" output in parallel and comparing to the\n"); @@ -1444,8 +1447,9 @@ void show_explain() printf(" triangle, tukey(P), welch. More than one\n"); printf(" may be specified but encoding time is a\n"); printf(" multiple of the number of functions since\n"); - printf(" they are each tried in turn. The default\n"); - printf(" is \"hann\". \n"); + printf(" they are each tried in turn. The encoder\n"); + printf(" chooses suitable defaults in the absence\n"); + printf(" of any -A options.\n"); printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n"); printf(" -p, --qlp-coeff-precision-search Do exhaustive search of LP coefficient\n"); printf(" quantization (expensive!); overrides -q;\n"); -- 2.7.4