From 0ae3e4689dbd69d9452c0e3e66b1cd54e10b7101 Mon Sep 17 00:00:00 2001 From: Martijn van Beurden Date: Fri, 1 Aug 2014 09:57:38 +0200 Subject: [PATCH] Various documentation fixes, merge with website The html documentation was diff'ed to the current website pages and all difference were merged into the page they weren't yet incorporated. This includes lots of small fixes and improvements. Signed-off-by: Erik de Castro Lopo --- doc/html/Makefile.am | 1 - doc/html/changelog.html | 509 ++++++++++++++++++---- doc/html/documentation.html | 2 +- doc/html/documentation_bugs.html | 17 +- doc/html/documentation_tools.html | 3 +- doc/html/documentation_tools_flac.html | 16 +- doc/html/documentation_tools_plugins.html | 83 ---- doc/html/faq.html | 23 +- doc/html/format.html | 14 +- doc/html/id.html | 2 +- doc/html/license.html | 8 +- doc/html/ogg_mapping.html | 4 +- 12 files changed, 479 insertions(+), 203 deletions(-) delete mode 100644 doc/html/documentation_tools_plugins.html diff --git a/doc/html/Makefile.am b/doc/html/Makefile.am index d744134c..d19ffa79 100644 --- a/doc/html/Makefile.am +++ b/doc/html/Makefile.am @@ -30,7 +30,6 @@ doc_DATA = \ documentation_tools.html \ documentation_tools_flac.html \ documentation_tools_metaflac.html \ - documentation_tools_plugins.html \ faq.html \ favicon.ico \ features.html \ diff --git a/doc/html/changelog.html b/doc/html/changelog.html index 06032985..02f7eca1 100644 --- a/doc/html/changelog.html +++ b/doc/html/changelog.html @@ -8,7 +8,7 @@ - + @@ -76,24 +76,24 @@
  • flac:
  • metaflac:
  • @@ -106,16 +106,17 @@
  • build system:
    • +
  • documentation:
      @@ -127,9 +128,9 @@
    • libraries:
        -
      • libFLAC encoder was defaulting to level 0 compression instead of 5 (SF #1816825).
        • -
      • Fix bug in bitreader handling of read callback returning a short count (SF #2490454).
        • -
      • Improve decoder's ability to distinguish between a FLAC sync code and an MPEG one (SF #2491433).
        • +
      • libFLAC encoder was defaulting to level 0 compression instead of 5 (SF #1816825).
        • +
      • Fix bug in bitreader handling of read callback returning a short count (SF #2490454).
        • +
      • Improve decoder's ability to distinguish between a FLAC sync code and an MPEG one (SF #2491433).
    • @@ -174,25 +175,25 @@
    • Ogg FLAC format:
        -
      • This is not a format change, but changed default extension for Ogg FLAC from .ogg to .oga, according to new Xiph specification (SF #1762492).
        • +
      • This is not a format change, but changed default extension for Ogg FLAC from .ogg to .oga, according to new Xiph specification (SF #1762492).
    • flac:
        -
      • Added a new option --no-utf8-convert which works like it does in metaflac (SF #973740).
        • -
      • Added a new option --keep-foreign-metadata which can save/restore RIFF and AIFF chunks to/from FLAC files (SF #363478).
        • -
      • Changed default extension for Ogg FLAC from .ogg to .oga, according to new Xiph specification (SF #1762492).
        • -
      • Fixed bug where using --replay-gain without any padding option caused only a small PADDING block to be created (SF #1760790).
        • -
      • Fixed bug where encoding from stdin on Windows could fail if WAVE/AIFF contained unknown chunks (SF #1776803).
        • -
      • Fixed bug where importing non-CDDA cuesheets would cause an invalid lead-out track number (SF #1764105).
        • +
      • Added a new option --no-utf8-convert which works like it does in metaflac (SF #973740).
        • +
      • Added a new option --keep-foreign-metadata which can save/restore RIFF and AIFF chunks to/from FLAC files (SF #363478).
        • +
      • Changed default extension for Ogg FLAC from .ogg to .oga, according to new Xiph specification (SF #1762492).
        • +
      • Fixed bug where using --replay-gain without any padding option caused only a small PADDING block to be created (SF #1760790).
        • +
      • Fixed bug where encoding from stdin on Windows could fail if WAVE/AIFF contained unknown chunks (SF #1776803).
        • +
      • Fixed bug where importing non-CDDA cuesheets would cause an invalid lead-out track number (SF #1764105).
    • metaflac:
        -
      • Changed default extension for Ogg FLAC from .ogg to .oga, according to new Xiph specification (SF #1762492).
        • -
      • Fixed bug where importing non-CDDA cuesheets would cause an invalid lead-out track number (SF #1764105).
        • +
      • Changed default extension for Ogg FLAC from .ogg to .oga, according to new Xiph specification (SF #1762492).
        • +
      • Fixed bug where importing non-CDDA cuesheets would cause an invalid lead-out track number (SF #1764105).
    • @@ -204,14 +205,14 @@
    • build system:
    • @@ -224,9 +225,9 @@
    • libraries:
        -
      • libFLAC: Fixed very rare seek bug (SF #1684049).
        • -
      • libFLAC: Fixed seek bug with Ogg FLAC and small streams (SF #1792172).
        • -
      • libFLAC: 64-bit fixes (SF #1790872).
        • +
      • libFLAC: Fixed very rare seek bug (SF #1684049).
        • +
      • libFLAC: Fixed seek bug with Ogg FLAC and small streams (SF #1792172).
        • +
      • libFLAC: 64-bit fixes (SF #1790872).
      • libFLAC: Fix assembler code to be position independent.
      • libFLAC: Optimization of a number of inner loop functions.
      • Added support for encoding the residual coding method introduced in libFLAC 1.2.0 (RESIDUAL_CODING_METHOD_PARTITIONED_RICE2) which will encode 24-bit files more efficiently.
        • @@ -367,10 +368,10 @@
      • Encoding and decoding speedups for all modes. Encoding at -8 is twice as fast.
      • Added a new option -w,--warnings-as-errors for treating all warnings as errors.
      • Allow --picture option to take only a filename, and have all other attributes extracted from the file itself.
        • -
      • Fixed a bug that caused suboptimal default compression settings in some locales (SF #1608883).
        • -
      • Fixed a bug where FLAC-to-FLAC transcoding of a corrupted FLAC file would truncate the transcoded file at the first error (SF #1615019).
        • -
      • Fixed a bug where using -F with FLAC-to-FLAC transcoding of a corrupted FLAC would have no effect (SF #1615391).
        • -
      • Fixed a bug where new PICTURE metadata blocks specified with --picture would not be transferred during FLAC-to-FLAC transcoding (SF #1627993).
        • +
      • Fixed a bug that caused suboptimal default compression settings in some locales (SF #1608883).
        • +
      • Fixed a bug where FLAC-to-FLAC transcoding of a corrupted FLAC file would truncate the transcoded file at the first error (SF #1615019).
        • +
      • Fixed a bug where using -F with FLAC-to-FLAC transcoding of a corrupted FLAC would have no effect (SF #1615391).
        • +
      • Fixed a bug where new PICTURE metadata blocks specified with --picture would not be transferred during FLAC-to-FLAC transcoding (SF #1627993).
    • @@ -382,15 +383,15 @@
    • plugins:
        -
      • Fixed a bug in the XMMS plugin where Ctrl-3 (file info) would cause a crash if the file did not exist (SF #1634941).
        • +
      • Fixed a bug in the XMMS plugin where Ctrl-3 (file info) would cause a crash if the file did not exist (SF #1634941).
    • build system:
        -
      • Fixed a makefile linkage bug with libogg (SF #1611414).
        • -
      • Added pkg-config files for libFLAC and libFLAC++ (SF #1647881).
        • -
      • Added --disable-ogg option for building without Ogg support even if libogg is installed (SF #1196996).
        • +
      • Fixed a makefile linkage bug with libogg (SF #1611414).
        • +
      • Added pkg-config files for libFLAC and libFLAC++ (SF #1647881).
        • +
      • Added --disable-ogg option for building without Ogg support even if libogg is installed (SF #1196996).
    • @@ -400,7 +401,7 @@
    • Much faster Rice partition size estimation which greatly speeds encoding in higher modes.
    • Increased compression for all modes.
    • Reduced memory requirements for encoder and decoder.
      • -
    • Fixed a bug with default apodization settings that were erroneous in some locales (SF #1608883).
      • +
    • Fixed a bug with default apodization settings that were erroneous in some locales (SF #1608883).
  • @@ -468,20 +469,20 @@
  • Added a new option --tag-from-file for setting a tag from file (e.g. for importing a cuesheet as a tag).
  • Added a new option --picture for adding pictures.
  • Added a new option --apodization for specifying the window function(s) to be used in LPC analysis.
    • -
  • Added support for encoding from non-compressed AIFF-C (SF #1090933).
    • -
  • Importing of non-CDDA-compliant cuesheets now only issues a warning, not an error (see here).
    • -
  • MD5 comparison failures on decoding are now an error instead of a warning and will also return a non-zero exit code (SF #1493725).
    • +
  • Added support for encoding from non-compressed AIFF-C (SF #1090933).
    • +
  • Importing of non-CDDA-compliant cuesheets now only issues a warning, not an error (see here).
    • +
  • MD5 comparison failures on decoding are now an error instead of a warning and will also return a non-zero exit code (SF #1493725).
  • The default padding size is now 8K, or 64K if the input audio stream is more than 20 minutes long.
  • Fixed a bug in cuesheet parsing where it would return an error if the last line of the cuesheet did not end with a newline.
    • -
  • Fixed a bug that caused a crash when -a and -t were used together (SF #1229481).
    • -
  • Fixed a bug with --sector-align where appended samples were not always totally silent (SF #1237707).
    • +
  • Fixed a bug that caused a crash when -a and -t were used together (SF #1229481).
    • +
  • Fixed a bug with --sector-align where appended samples were not always totally silent (SF #1237707).
  • Fixed bugs with --sector-align and raw input files.
    • -
  • Fixed a bug printing out unknown AIFF subchunk names (SF #1267476).
    • -
  • Fixed a bug where WAVE files with "data" subchunks of size 0 where accepted (SF #1293830).
    • -
  • Fixed a bug where sync error at end-of-stream of truncated files was not being caught (SF #1244071).
    • -
  • Fixed a problem with filename parsing if file does not have extension but also has a . in the path (SF #1161916).
    • -
  • Fixed a problem with fractional-second parsing for --skip/--until in some locales (SF #1031043).
    • -
  • Increase progress report rate when -p and -e are used together (SF #1580122).
    • +
  • Fixed a bug printing out unknown AIFF subchunk names (SF #1267476).
    • +
  • Fixed a bug where WAVE files with "data" subchunks of size 0 where accepted (SF #1293830).
    • +
  • Fixed a bug where sync error at end-of-stream of truncated files was not being caught (SF #1244071).
    • +
  • Fixed a problem with filename parsing if file does not have extension but also has a . in the path (SF #1161916).
    • +
  • Fixed a problem with fractional-second parsing for --skip/--until in some locales (SF #1031043).
    • +
  • Increase progress report rate when -p and -e are used together (SF #1580122).
  • @@ -492,7 +493,7 @@
  • Added a new option --import-picture-from for importing pictures.
  • Added a new option --export-picture-to for exporting pictures.
  • Added shorthand operation --remove-replay-gain for removing ReplayGain tags.
    • -
  • --export-cuesheet-to now properly specifies the FLAC file name (SF #1272825).
    • +
  • --export-cuesheet-to now properly specifies the FLAC file name (SF #1272825).
  • Importing of non-CDDA-compliant cuesheets now issues a warning.
  • Removed the following deprecated tag editing options; you should use the new option names shown instead:
      @@ -506,7 +507,7 @@
    • Removed --export-vc-to; use --export-tags-to
    • -
  • Disallow multiple input FLAC files when --import-tags-from=- is used (SF #1082577).
    • +
  • Disallow multiple input FLAC files when --import-tags-from=- is used (SF #1082577).
  • @@ -520,11 +521,11 @@
  • build system:
      -
    • Added support for building on OS/2 with EMX (SF #1229495)
      • -
    • Added support for building with Borland C++ (SF #1599018)
      • -
    • Added a --disable-xmms-plugin option to configure to prevent building the XMMS plugin (SF #930494).
      • -
    • Added a --disable-doxygen-docs option to configure for disabling Doxygen-based API doc generation (SF #1365935).
      • -
    • Added a --disable-thorough-tests option to configure to do the basic library, stream, and tool tests in a reasonable time (SF #1077948).
      • +
    • Added support for building on OS/2 with EMX (SF #1229495)
      • +
    • Added support for building with Borland C++ (SF #1599018)
      • +
    • Added a --disable-xmms-plugin option to configure to prevent building the XMMS plugin (SF #930494).
      • +
    • Added a --disable-doxygen-docs option to configure for disabling Doxygen-based API doc generation (SF #1365935).
      • +
    • Added a --disable-thorough-tests option to configure to do the basic library, stream, and tool tests in a reasonable time (SF #1077948).
    • Added large file support with AC_SYS_LARGEFILE; use --disable-largefile with configure to disable.
    • @@ -535,10 +536,10 @@
  • Merged libOggFLAC++ into libFLAC++; both formats are now supporte through the same API.
  • libFLAC and libFLAC++: Simplified encoder setup with new FLAC__stream_encoder_set_compression_level() function.
  • libFLAC: Improved compression with no impact on FLAC format or decoding time by adding a windowing stage before LPC analysis.
    • -
  • libFLAC: Fixed a bug where missing STREAMINFO fields (min/max framesize, total samples, MD5 sum) and seek point offsets were not getting rewritten back to Ogg FLAC file (SF #1338969).
    • +
  • libFLAC: Fixed a bug where missing STREAMINFO fields (min/max framesize, total samples, MD5 sum) and seek point offsets were not getting rewritten back to Ogg FLAC file (SF #1338969).
  • libFLAC: Fixed a bug in cuesheet parsing where it would return an error if the last line of the cuesheet did not end with a newline.
  • libFLAC: Fixed UTF-8 decoder to disallow non-shortest-form and surrogate sequences (see here).
    • -
  • libFLAC: Fixed a bug in the return value for FLAC__stream_decoder_set_metadata_respond_application() and FLAC__stream_decoder_set_metadata_ignore_application() when there was a memory allocation error (SF #1235005).
    • +
  • libFLAC: Fixed a bug in the return value for FLAC__stream_decoder_set_metadata_respond_application() and FLAC__stream_decoder_set_metadata_ignore_application() when there was a memory allocation error (SF #1235005).
  • @@ -642,7 +643,7 @@
  • plugins:
      -
    • Added support for HTTP streaming in XMMS plugin. NOTE: there is a bug in the XMMS mpg123 plugin that hijacks FLAC streams; to fix it you will need to add the '.flac' extension to the list of exceptions in Input/mpg123/mpg123.c:is_our_file() in the XMMS sources and recompile.
      • +
    • Added support for HTTP streaming in XMMS plugin. NOTE: there is a bug in the XMMS mpg123 plugin that hijacks FLAC streams; to fix it you will need to add the '.flac' extension to the list of exceptions in Input/mpg123/mpg123.c:is_our_file() in the XMMS sources and recompile.
  • @@ -747,7 +748,7 @@
  • New option -f (--force) to force overwriting if the output file already exists.
  • New option --cue to select a specific section to decode using cuesheet track/index points.
  • New option --totally-silent to suppress all output.
    • -
  • New (but undocumented) option --apply-replaygain-which-is-not-lossless which applies ReplayGain to the decoded output. See this thread for usage and caveats.
    • +
  • New (but undocumented) option --apply-replaygain-which-is-not-lossless which applies ReplayGain to the decoded output. See this thread for usage and caveats.
  • When encoding to Ogg FLAC, use a random serial number (instead of 0 as was done before) when a serial number is not specified.
  • When encoding multiple Ogg FLAC streams, --serial-number or random serial number sets the first number, which is then incremented for subsequent streams (before, the same serial number was used for all streams).
  • Decoder no longer exits with an error when writing to stdout and the pipe is broken.
    • @@ -757,12 +758,12 @@
  • Bug fix: calculating ReplayGain on 48kHz streams.
  • Bug fix: check for supported block alignments in WAVE files.
  • Bug fix: "offset" field in AIFF SSND chunk properly handled.
    • -
  • Bug fix: #679166: flac doesn't respect RIFF subchunk padding byte.
    • -
  • Bug fix: #828391: --add-replay-gain segfaults.
    • -
  • Bug fix: #851155: Can't seek to position in flac file.
    • -
  • Bug fix: #851756: flac --skip --until reads entire file.
    • -
  • Bug fix: #877122: problem parsing cuesheet with CATALOG entry.
    • -
  • Bug fix: #896057: parsing ISRC number from cuesheet.
    • +
  • Bug fix: #679166: flac doesn't respect RIFF subchunk padding byte.
    • +
  • Bug fix: #828391: --add-replay-gain segfaults.
    • +
  • Bug fix: #851155: Can't seek to position in flac file.
    • +
  • Bug fix: #851756: flac --skip --until reads entire file.
    • +
  • Bug fix: #877122: problem parsing cuesheet with CATALOG entry.
    • +
  • Bug fix: #896057: parsing ISRC number from cuesheet.
  • @@ -793,7 +794,7 @@
  • Support for big-endian architectures in XMMS plugin.
  • Removed support for ID3 tags.
  • Bug fix: make hard limiter default to off in XMMS plugin.
    • -
  • Bug fix: stream length calculation bug in XMMS plugin, debian bug #200435; see also.
    • +
  • Bug fix: stream length calculation bug in XMMS plugin, debian bug #200435
  • Bug fix: small memory leak in XMMS plugin.
    • @@ -907,6 +908,360 @@ + +
    + + FLAC 1.1.0 (26-Jan-2003) + +
    + + +
    + + FLAC 1.0.4 (24-Sep-2002) + +
    + + +
    + + FLAC 1.0.3 (03-Jul-2002) + +
    + + + +
    + + FLAC 1.0.2 (03-Dec-2001) + +
    + +
    + + FLAC 1.0.1 (14-Nov-2001) + +
    + + +
    + + FLAC 1.0 (20-Jul-2001) + +
    + +
    + + FLAC 0.10 (07-Jun-2001) + +
    + +
    + + FLAC 0.9 (31-Mar-2001) + +
    + + +
    + + FLAC 0.8 (05-Mar-2001) + +
    + +
    + + FLAC 0.7 (12-Feb-2001) + +
    + + +
    + + FLAC 0.6 (28-Jan-2001) + +
    + +
    + + FLAC 0.5 (15-Jan-2001) + +
    + +
    + + FLAC 0.4 (23-Dec-2000) + +
    + + + +
    diff --git a/doc/html/documentation.html b/doc/html/documentation.html index 3db35b3b..87d03ade 100644 --- a/doc/html/documentation.html +++ b/doc/html/documentation.html @@ -55,7 +55,7 @@
  • Official Tools - How to use the flac and metaflac command-line tools.
  • Comparison - A comparison of FLAC with other lossless codecs.
  • Bugs - How to report bugs and request features, and a list of known bugs in the FLAC tools.
    • -
  • Request Support - Support for the official FLAC tools. For other programs, use hydrogenaudio.org
    • +
  • Request Support - Support for the official FLAC tools. For other programs, use hydrogenaud.io
  • FLAC Mailing List - General discussion about FLAC, tools, releases, etc. (You must subscribe to post.)
    • For developers who want to add FLAC support to their programs: diff --git a/doc/html/documentation_bugs.html b/doc/html/documentation_bugs.html index a835fe18..12a5bd78 100644 --- a/doc/html/documentation_bugs.html +++ b/doc/html/documentation_bugs.html @@ -42,12 +42,19 @@
    - The following are major known bugs in the current (1.1.4) release: + The following are major known bugs in the current (1.3.0) release:
    • - When encoding to Ogg FLAC, if there are too many seek points (>240), the seek table will not have the offsets written back properly after encoding. + If you use the --replay-gain option with flac, but no --padding/-P option, only a very small padding block will be created. The workaround is to always use a -P option when using --replay-gain to make sure the correct amount of padding is added. +
      • +
    • + When encoding to Ogg FLAC, the progress indicator is broken +
      • +
    • + When encoding to Ogg FLAC, the number of seek points is limited to 240.
    + The first two have been fixed, these fixes will be incorporated in the next release.
    @@ -60,11 +67,9 @@
    - To report a bug, please go to the FLAC bug tracker (or appropriately the feature request tracker, patch page, or support page).
    + To report a bug, please go to the FLAC bug tracker (or appropriately the feature request tracker, patch page, or support page).

    - First check that there is not already an existing request. If you do submit a new request, make sure and provide an email contact and use the Monitor feature.
    -
    - Note that we get many false bug reports from people with faulty hardware or who overclock their machines that FLAC is not working. Please do due diligence if you are getting FLAC encoding or decoding errors that it is not the fault of the hardware. FLAC encoding tends to highlight problems with bad RAM, corrupted files, and excessive overclocking. + First check that there is not already an existing request. If you do submit a new request, make sure and provide an email contact and use the Monitor feature.
    diff --git a/doc/html/documentation_tools.html b/doc/html/documentation_tools.html index f662b06c..b3ac5d50 100644 --- a/doc/html/documentation_tools.html +++ b/doc/html/documentation_tools.html @@ -46,12 +46,11 @@ Other resources:
    diff --git a/doc/html/documentation_tools_flac.html b/doc/html/documentation_tools_flac.html index ea1b8a13..6fa18dad 100644 --- a/doc/html/documentation_tools_flac.html +++ b/doc/html/documentation_tools_flac.html @@ -355,29 +355,35 @@ - --skip={#|mm:ss.ss} + --skip={#|mm:ss.ss}
    --skip={#|mm:ss,ss}     Skip over the first # of samples of the input. This works for both encoding and decoding, but not testing. The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second.

    + Note that the use of either a dot or a comma depends on the locale used for the system.
    +
    Examples:

    --skip=123 : skip the first 123 samples of the input
    - --skip=1:23.45 : skip the first 1 minute and 23.45 seconds of the input + --skip=1:23.45 : skip the first 1 minute and 23.45 seconds of the input, with a locale using the point as decimal separator
    + --skip=1:23,45 : skip the first 1 minute and 23.45 seconds of the input, with a locale using the comma as decimal separator     - --until={#|[+|-]mm:ss.ss} + --until={#|[+|-]mm:ss.ss}
    --until={#|[+|-]mm:ss,ss}     Stop at the given sample number for each input file. This works for both encoding and decoding, but not testing. The given sample number is not included in the decoded output. The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second. If a + sign is at the beginning, the --until point is relative to the --skip point. If a - sign is at the beginning, the --until point is relative to end of the audio.

    + Note that the use of either a dot or a comma depends on the locale used for the system.
    +
    Examples:

    --until=123 : decode only the first 123 samples of the input (samples 0-122, stopping at 123)
    --until=1:23.45 : decode only the first 1 minute and 23.45 seconds of the input
    + --until=1:23,45 : decode only the first 1 minute and 23.45 seconds of the input, if your locale setting uses a comma as decimal separator
    --skip=1:00 --until=+1:23.45 : decode 1:00.00 to 2:23.45
    --until=-1:23.45 : decode everything except the last 1 minute and 23.45 seconds
    --until=-0:00 : decode until the end of the input (the same as not specifying --until) @@ -550,7 +556,7 @@ --replay-gain - Calculate     ReplayGain values and store them as FLAC tags, similar to VorbisGain. Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files. All input files must have the same resolution, sample rate, and number of channels. Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. Also note that this option may leave a few extra bytes in a PADDING block as the exact size of the tags is not known until all files are processed.
    + Calculate ReplayGain values and store them as FLAC tags, similar to VorbisGain. Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files. All input files must have the same resolution, sample rate, and number of channels. Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. Also note that this option may leave a few extra bytes in a PADDING block as the exact size of the tags is not known until all files are processed.

    Note that this option cannot be used when encoding to standard output (stdout). @@ -849,6 +855,7 @@ 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").
    + Please note that for both P as well as STDDEV, the use of a point or comma as decimal separator is locale-dependent.
    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.
    @@ -1018,6 +1025,7 @@ --no-mid-side
    --no-ogg
    --no-padding
    + --no-preserve-modtime
    --no-qlp-coeff-prec-search
    --no-residual-gnuplot
    --no-residual-text
    diff --git a/doc/html/documentation_tools_plugins.html b/doc/html/documentation_tools_plugins.html deleted file mode 100644 index b7959bb1..00000000 --- a/doc/html/documentation_tools_plugins.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - - - - - - - - FLAC - documentation - - - - - - -
    - -
    -  home  | -  faq  | -  documentation  | -  developers  | -  changelog  | -  more -
    - -
    - -
    -
    - xmms plugin -
    -
    -
    - Normally the FLAC plugin for XMMS is installed with a package, but some of the binary builds have a compiled plugin. All that is necessary is to copy libxmms-flac.so to the directory where XMMS looks for input plugins (usually /usr/lib/xmms/Input or $HOME/.xmms/Input). There is nothing else to configure. Make sure to restart XMMS before trying to play any .flac files. -
    -
    -
    - -
    - -
    -
    - winamp plugin -
    -
    -
    - Since Winamp 5.31, Nullsoft has supplied a FLAC plugin with their Full install; nothing else is needed to get FLAC to play in Wnamp.
    -
    - Before Winamp 5.31 it was necessary to use our FLAC plugin. If you have an older version of Winamp, our plugin is still available in the FLAC Installer for Windows. The Winamp plugin should work for both Winamp2 and Winamp5. All that is necessary is to copy in_flac.dll to the Plugins/ directory of your Winamp installation. There is nothing else to configure. Make sure to restart Winamp before trying to play any .flac files. -
    -
    -
    - - -
    - - - - - - -
    - Copyright (c) 2000-2009 Josh Coalson -
    - Copyright (c) 2011-2013 Xiph.Org Foundation -     		- Valid XHTML 1.0! -
    -
    - - - diff --git a/doc/html/faq.html b/doc/html/faq.html index a50c34aa..b815e405 100644 --- a/doc/html/faq.html +++ b/doc/html/faq.html @@ -127,9 +127,6 @@
  • Why does it take so long to edit some FLAC files with metaflac?
    • -
  • - Why don't Unicode file names work with flac/metaflac on Windows? -
  • Why don't wildcards for file names like *.flac or *.wav work with flac/metaflac on Windows?
    • @@ -184,7 +181,7 @@ I have a FLAC file, how do I play it?
    How can I create FLAC files?

    - See Using FLAC.
    + See Using FLAC or a list of hardware that supports FLAC.

    What licensing applies to the FLAC format and software?

    @@ -202,7 +199,7 @@
    How can I play FLAC in Windows Media Player?

    - See this guide.
    + The easiest way is to use the Xiph.org Directshow Filters, download them here

    What hardware products support FLAC?

    @@ -294,11 +291,11 @@ How do I set up EAC to rip directly to FLAC?

    - See Case's excellent EAC configuration page. Or use AutoFLAC, Omni Encoder, or MAREO to rip to FLAC or multiple formats at once.
    + See Case's excellent EAC configuration page. Or use AutoFLAC or MAREO to rip to FLAC or multiple formats at once.

    Why am I getting "Run-time error '75': Path/File access error" with FLAC Frontend?

    - Depending on how FLAC Frontend is installed, it could be one of two things: 1) you are trying to encode to file to a directory where you do not have write permission; 2) the FLAC Frontend program must be set to run as Administrator by opening Windows Explorer, navigating to C:\Program Files\FLAC (or wherever FLAC was installed), then right-clicking on FLAC Frontend.exe and checking "Run this program as an administrator".
    + You are probably using an old version of FLAC Frontend. Try downloading a new version from this sourceforge page

    How do I encode a file that starts with a dash?

    @@ -310,13 +307,9 @@
    Since metadata is stored at the beginning of a FLAC file, changing the length of it can sometimes cause the whole file to be rewritten. You can avoid this by adding padding with flac when you encode, or with metaflac after encoding. By default, flac adds 8k of padding; you can change this amount if you need more or less.

    - Why don't Unicode file names work with flac/metaflac on Windows?
    -
    - Windows implements Unicode filenames differently than all other operating systems, and can only be supported via Windows APIs (non-portable). Also the method is different for different versions of Windows. It's so hard to get right that most programs that have to work for other operating systems also do not support it. A workaround can be found here.
    -
    Why don't wildcards for file names like *.flac or *.wav work with flac/metaflac on Windows?

    - The Windows command shells (cmd.exe, command.com) implement wildcard handling differently than most other shells, leaving it up to the program to do everything including difficult and ambiguous cases. For an explanation of why wildcards on cmd.exe/command.com are dangerous, see here. Better command shells for Windows exist, e.g. from Cygwin. A workaround with the Windows shells is to do something like:
    + The Windows command shells (cmd.exe, command.com) implement wildcard handling differently than most other shells, leaving it up to the program to do everything including difficult and ambiguous cases. For an explanation of why wildcards on cmd.exe/command.com are dangerous, see here. Better command shells for Windows exist, e.g. from Cygwin. A workaround with the Windows shells is to do something like:

    for %F in (*.wav) do flac "%F"

    @@ -326,9 +319,9 @@
    The only known cause of verify errors is faulty hardware. The dead giveaway is that if you repeat the exact same command, the error occurs in a different place or not at all. This can also happen when decoding or testing a FLAC file. If this is happening it is your hardware and not a FLAC bug.

    - The problem is usually caused by overclocking/overheating the CPU or bad RAM. Try one of the many free programs available for testing hardware (e.g. Memtest86+). We have had reports of a few cases where a system is passing with flying colors and still getting unrepeatable FLAC errors, and the one thing many (all?) of these systems have in common is an ASUS motherboard (A7V133 or P3V4X) which we suspect is buggy in some way. (See also)
    + The problem is usually caused by overclocking/overheating the CPU or bad RAM. Try one of the many free programs available for testing hardware (e.g. Memtest).

    - If you ever have a verify error that fails at the same place every time, please file a bug, uploading a sample according to the instructions found at the bottom of this bug report.
    + If you ever have a verify error that fails at the same place every time, please file a bug, uploading a sample according to the instructions found at the bottom of this bug report.

    I compressed a WAVE file to FLAC, then decompressed to WAVE, and the two weren't identical. Why?
    I compressed a WAVE file to FLAC and it said "warning: skipping unknown sub-chunk LIST". Why?
    @@ -369,7 +362,7 @@ Where are the mailing lists, forums, discussion areas, etc.?

    - There are a few places. The main discussions happen on the official FLAC mailing lists (you must subscribe to post). Also, there is a lot of discussion relating to FLAC on Hydrogen Audio.
    + There are a few places. The main discussions happen on the official FLAC mailing lists (you must subscribe to post). Also, there is a lot of discussion relating to FLAC on Hydrogen Audio.

    How do I submit a bug report?

    diff --git a/doc/html/format.html b/doc/html/format.html index 3e1ed9ab..42e1d6f5 100644 --- a/doc/html/format.html +++ b/doc/html/format.html @@ -136,10 +136,10 @@ FLAC owes much to the many people who have advanced the audio compression field so freely. For instance: Residual Coding
    @@ -263,7 +263,7 @@
  • SEEKTABLE: This is an optional block for storing seek points. It is possible to seek to any given sample in a FLAC stream without a seek table, but the delay can be unpredictable since the bitrate may vary widely within a stream. By adding seek points to a stream, this delay can be significantly reduced. Each seek point takes 18 bytes, so 1% resolution within a stream adds less than 2k. There can be only one SEEKTABLE in a stream, but the table can have any number of seek points. There is also a special 'placeholder' seekpoint which will be ignored by decoders but which can be used to reserve space for future seek point insertion.
  • VORBIS_COMMENT: This block is for storing a list of human-readable name/value pairs. Values are encoded using UTF-8. It is an implementation of the Vorbis comment specification (without the framing bit). This is the only officially supported tagging mechanism in FLAC. There may be only one VORBIS_COMMENT block in a stream. In some external documentation, Vorbis comments are called FLAC tags to lessen confusion.
  • CUESHEET: This block is for storing various information that can be used in a cue sheet. It supports track and index points, compatible with Red Book CD digital audio discs, as well as other CD-DA metadata such as media catalog number and track ISRCs. The CUESHEET block is especially useful for backing up CD-DA discs, but it can be used as a general purpose cueing mechanism for playback.
    • -
  • PICTURE: This block is for storing pictures associated with the file, most commonly cover art from CDs. There may be more than one PICTURE block in a file. The picture format is similar to the APIC frame in ID3v2. The PICTURE block has a type, MIME type, and UTF-8 description like ID3v2, and supports external linking via URL (though this is discouraged). The differences are that there is no uniqueness constraint on the description field, and the MIME type is mandatory. The FLAC PICTURE block also includes the resolution, color depth, and palette size so that the client can search for a suitable picture without having to scan them all.
    • +
  • PICTURE: This block is for storing pictures associated with the file, most commonly cover art from CDs. There may be more than one PICTURE block in a file. The picture format is similar to the APIC frame in ID3v2. The PICTURE block has a type, MIME type, and UTF-8 description like ID3v2, and supports external linking via URL (though this is discouraged). The differences are that there is no uniqueness constraint on the description field, and the MIME type is mandatory. The FLAC PICTURE block also includes the resolution, color depth, and palette size so that the client can search for a suitable picture without having to scan them all.
  • @@ -834,7 +834,7 @@ <12*8> - Track ISRC. This is a 12-digit alphanumeric code; see here and here. A value of 12 ASCII NUL characters may be used to denote absence of an ISRC. + Track ISRC. This is a 12-digit alphanumeric code; see here and here. A value of 12 ASCII NUL characters may be used to denote absence of an ISRC. @@ -1792,7 +1792,7 @@ Encoding parameter:
    • - 0000-11110 : Rice parameter. + 00000-11110 : Rice parameter.
    • 11111 : Escape code, meaning the partition is in unencoded binary form using n bits per sample; n follows as a 5-bit number. diff --git a/doc/html/id.html b/doc/html/id.html index 00725106..a5856a35 100644 --- a/doc/html/id.html +++ b/doc/html/id.html @@ -251,7 +251,7 @@ 786D6364 - "xmcd" - xmcd + xmcd BSD License. In simple terms, these libraries may be used by any application, Open or proprietary, linked or incorporated in whole, so long as acknowledgement is made to Xiph.org Foundation when using the source code in whole or in derived works. The Xiph License is free enough that the libraries have been used in commercial products to implement FLAC, including in the firmware of hardware devices where other Open Source licenses can be problematic. In the source code these libraries are called libFLAC and libFLAC++.
      + The reference implementation libraries are licensed under the New BSD License. In simple terms, these libraries may be used by any application, Open or proprietary, linked or incorporated in whole, so long as acknowledgement is made to Xiph.org Foundation when using the source code in whole or in derived works. The Xiph License is free enough that the libraries have been used in commercial products to implement FLAC, including in the firmware of hardware devices where other Open Source licenses can be problematic. In the source code these libraries are called libFLAC and libFLAC++.

      The rest of the software that the FLAC project provides is licensed under the GNU General Public License (GPL). This software includes various utilities for converting files to and from FLAC format, plugins for audio players, et cetera. In general, the GPL allows redistribution as long as derived works are also made available in source code form according to compatible terms.

      Neither the FLAC nor Ogg FLAC formats nor any of the implemented encoding/decoding methods are covered by any known patent.

      - FLAC is one of a family of codecs of the Xiph.org Foundation, all created according to the same free ideals. For some other codecs' descriptions of the Xiph License see the Vorbis license page.
      + FLAC is one of a family of codecs of the Xiph.org Foundation, all created according to the same free ideals. For some other codecs' descriptions of the Xiph License see the Speex and Vorbis license pages.

      - If you would like to redistribute parts or all of FLAC under different terms, contact the developers on the flac-dev mailinglist. + If you would like to redistribute parts or all of FLAC under different terms, contact the FLAC-dev mailinglist.
      diff --git a/doc/html/ogg_mapping.html b/doc/html/ogg_mapping.html index 06390b07..5e4d8b54 100644 --- a/doc/html/ogg_mapping.html +++ b/doc/html/ogg_mapping.html @@ -42,7 +42,7 @@
      - This page specifies the way in which compressed FLAC data is encapsulated in an Ogg transport layer. It assumes basic knowledge of the FLAC format and Ogg structure and framing.
      + This page specifies the way in which compressed FLAC data is encapsulated in an Ogg transport layer. It assumes basic knowledge of the FLAC format and Ogg structure and framing.

      The original FLAC format includes a very thin transport system. This system of compressed FLAC audio data mixed with a thin transport has come to be known as 'native FLAC'. The transport consists of audio frame headers and footers which contain synchronization patterns, timecodes, and checksums (but notably not frame lengths), and a metadata system. It is very lightweight and does not support more elaborate transport mechanisms such as multiple logical streams, but it has served its purpose well.

      @@ -93,7 +93,7 @@ FLAC packets may span page boundaries.
    • - The granule position of pages containing FLAC audio follows the same semantics as that for Ogg-encapsulated Vorbis as described here. + The granule position of pages containing FLAC audio follows the same semantics as that for Ogg-encapsulated Vorbis as described here.
    • Redundant fields in the STREAMINFO packet may be set to zero (indicating "unknown" in native FLAC), which also facilitates single-pass encoding. These fields are: the minimum and maximum frame sizes, the total samples count, and the MD5 signature. "Unknown" values for these fields will not prevent a compliant native FLAC or Ogg FLAC decoder from decoding the stream.