WavPack: Difference between revisions

From Hydrogenaudio Knowledgebase
(No, suffix does *not* override output filetype, that is FLAC ... Then details ... about metadata import, DSD, CAF fractional sampling rates apparently rejected, and about -vvv.)
(New Mediawiki wasn't as forgiving about tags unclosed, fixed. Added some wording about playing.)
 
(13 intermediate revisions by the same user not shown)
Line 5: Line 5:
| caption = Hybrid Lossless Audio Compression
| caption = Hybrid Lossless Audio Compression
| maintainer = David Bryant
| maintainer = David Bryant
| stable_release = 5.6.0 (2022-11-23)
| stable_release = 5.7.0 (2024-02-29)
| preview_release = None
| operating_system = Windows, MacOSX, Linux/BSD/Unix, ...
| operating_system = Windows, MacOSX, Linux/BSD/Unix, ...
| use = Encoder/Decoder
| use = Encoder/Decoder
Line 15: Line 14:
'''WavPack''' (pronounced "wave-pack") is a [[lossless]] audio [[codec]], also offering optionally a [[hybrid codec| hybrid lossless/lossy]] mode.  It is distributed as a free open-source encoder/decoder with a library and a large number of tools, including a Windows GUI and a range of plugins for both audio players and other software.  Third party implementations are available, including ffmpeg.  WavPack supports and/or can be played back on a large number of platforms/OSes including mobile (Android, iOS), portable ([[Rockbox]]) and even web apps.  
'''WavPack''' (pronounced "wave-pack") is a [[lossless]] audio [[codec]], also offering optionally a [[hybrid codec| hybrid lossless/lossy]] mode.  It is distributed as a free open-source encoder/decoder with a library and a large number of tools, including a Windows GUI and a range of plugins for both audio players and other software.  Third party implementations are available, including ffmpeg.  WavPack supports and/or can be played back on a large number of platforms/OSes including mobile (Android, iOS), portable ([[Rockbox]]) and even web apps.  


WavPack is arguably the most feature-rich lossless compressor, supporting a unique range of audio signals including [https://en.wikipedia.org/wiki/Direct_Stream_Digital Direct-Stream Digital].  Everyday use is supported by a wide range of players and taggers, but conversion is likely safest done with applications that invoke the official tools (rather than e.g. ffmpeg's implementation) – and special features might require the user to apply the WavPack executable directly, for example with drag+drop, see the [[#Using WavPack]] section below.
WavPack is arguably the most feature-rich lossless compressor, supporting a unique range of audio signals including [https://en.wikipedia.org/wiki/Direct_Stream_Digital Direct-Stream Digital].  Everyday use is supported by a wide range of players and taggers, but ''conversion'' is likely safest done with applications that invoke the official tools (rather than e.g. ffmpeg's implementation) – and special features might require the user to apply the WavPack executable directly, for example with drag+drop, see the [[#Using WavPack]] section below.


Performance-wise, WavPack defaults to a fast codec &ndash; less CPU intensive than [[ALAC]], but typically not as fast as [[FLAC]] or [[TAK]], especially in decoding CPU usage.<ref>[http://www.audiograaf.nl/losslesstest Martijn van Beurden: <em>Lossless audio codec comparison archive</em>], all comparisons in this wiki article consistent with CDDA results from revision 5, 2022, using WavPack 5.4.0.</ref> In the age of low-power portable Rockbox-equipped players, WavPack could be seen as a reasonable middle ground between FLAC's low CPU footprint and long battery life, and the smaller files but more CPU-intensive [[Monkey's Audio]]<ref>[https://www.rockbox.org/wiki/CodecPerformanceComparison CodecPerformanceComparison] at the Rockbox wiki</ref> &ndash; invoking WavPacks high mode and extra compression that would compress to smaller sizes than FLAC.
Performance-wise, WavPack defaults to a fast codec &ndash; less CPU intensive than [[ALAC]], but typically not as fast as [[FLAC]] or [[TAK]], especially in decoding CPU usage.<ref>[http://www.audiograaf.nl/losslesstest Martijn van Beurden: <em>Lossless audio codec comparison archive</em>], all comparisons in this wiki article consistent with CDDA results up to revision 6, 2023, using WavPack 5.6.0.</ref> In the age of low-power portable Rockbox-equipped players, WavPack could be seen as a reasonable middle ground between FLAC's low CPU footprint and long battery life, and the smaller files but more CPU-intensive [[Monkey's Audio]]<ref>[https://www.rockbox.org/wiki/CodecPerformanceComparison CodecPerformanceComparison] at the Rockbox wiki</ref> &ndash; invoking WavPacks high mode and extra compression that would compress to smaller sizes than FLAC.


WavPack has inspired other codecs<ref>Monkey's Audio FAQ {{webarchive|http://web.archive.org/web/20001017210206/http://www.monkeysaudio.com/faq.html|2000-10-17}}</ref> and their features<ref>[http://losslessaudio.org/DualStream.php OptimFROG's "DualStream"] hybrid encoding &ndash; apparently WavPack coined this phrase</ref>.  For more on WavPack, including on its history and technology, see the [https://en.wikipedia.org/wiki/WavPack Wikipedia entry].
WavPack has inspired other codecs<ref>Monkey's Audio historical FAQ {{webarchive|http://web.archive.org/web/20001017210206/http://www.monkeysaudio.com/faq.html|2000-10-17}}</ref> and their features<ref>[http://losslessaudio.org/DualStream.php OptimFROG's "DualStream"] hybrid encoding &ndash; apparently WavPack coined this phrase</ref>.  For more on WavPack, including on its history and technology, see the [https://en.wikipedia.org/wiki/WavPack Wikipedia entry].




= Features =
= Features =
For an end-user considering WavPack as an audio format, its feature-richness might be the big selling point.  WavPack supports pretty much all the more common features noted at [[Lossless_comparison| HA Wiki's Lossless Codec Comparison]] as in the following first list, but several users might consider the more unique features listed under the subsequent headline.
For an end-user considering WavPack as audio format, its feature-richness might be the big selling point.  WavPack supports pretty much all the more common features noted at [[Lossless_comparison| HA Wiki's Lossless Codec Comparison]] as in the following first list, but several users might consider the more unique features listed under the subsequent headline.


* Seekable and streaming playback.
* Seekable and streaming playback.
* Error handling: upon playback, it will detect and report corrupted frames, mute to protect against static/noise output, and continue playback.  Since version 5, WavPack can also check for corruption without decoding, hence quicker than any decoding format.  Optional MD5 audio checksum can also be added upon encoding for file fingerprinting.  
* Error handling: upon playback, it will detect and report corrupted frames, mute to protect against static/noise output, and continue playback.  Since version 5, WavPack can also check for corruption without decoding, hence quicker than any decoding format.  Optional MD5 audio checksum can also be added upon encoding for file fingerprinting.  
* High-resolution audio support (see next headline).
* High-resolution audio support (see next headline).
* Multichannel support: currently capped at 256 channels, supports [https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible WAVEFORMATEXTENSIBLE] channel masks.
* Multichannel support: currently capped at 256 channels, supports [https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible WAVEFORMATEXTENSIBLE] channel masks.
* Piping support for encoding, and support for RAW PCM input/output.
* Piping support for encoding, and support for RAW PCM input/output.
* Non-audio chunks (RIFF and similar) stored; by default, WavPack will not only decode the audio losslessly, but restore the non-audio chunks to file bit-identical to the original.
* Non-audio chunks (RIFF and similar) stored; by default, WavPack will not only encode/decode the audio losslessly, but store the non-audio chunks and restore them into a file bit-identical to the original.
* Tagging: APEv2. (ID3v1 is possible, but not advisable.)  
* Tagging: APEv2. (ID3v1 is possible, but not advisable.)  
* Cuesheet support. In practice, some applications handle ''embedded'' cuesheets better in WavPack than in some other formats.
* Cuesheet support. In practice, some applications handle ''embedded'' cuesheets better in WavPack than in some other formats.
Line 36: Line 35:
* Can be used in the [[Matroska]] container.  
* Can be used in the [[Matroska]] container.  
* Windows GUI available.
* Windows GUI available.
* Multithreading (from version 5.7.0).


WavPack also handles bit depths not divisible by 8, and is known to employ a "wasted bits" strategy: Say, if a WAVE file contains a 20 bit signal mono signal (which in WAVE takes up three bytes per sample anyway), but the two least significant bits are always zero, WavPack will compress it to the same size as if it were specified as the actual information content of eighteen bits &ndash; and will display it as 20 as per the WAVE's header flags (and restore it that way).
WavPack also handles bit depths not divisible by 8, e.g. 20-bit audio (found on some DVDs).


== Special/unique features ==
== Special/unique features ==
Most of these features are shared with only a few if any notable codecs, or extend to signal types or file types others do not support (comparisons given).
Most of these features are shared with only a few if any notable codecs, or extend to signal types or file types others do not support (comparisons given).
* DSD support: can losslessly compress Philips DSDIFF and Sony DSF files (see "Using WavPack" below; no other end-user codec compresses DSD.) ID3v2.3 tags can be imported.
* DSD support: can losslessly compress Philips DSDIFF and Sony DSF files (see "Using WavPack" below; no other end-user codec compresses DSD.) ID3v2.3/2.4 tags can be imported. wvunpack can select between DSDIFF and DSF out (i.e. 'convert between the two').  wvunpack can also convert DSD to PCM, but not the other way around. (Lossy, as conversion between PCM and DSD necessarily is.)
* High-resolution support for bit depth 1-bit to 32-bit integer and sampling rates up to 2 GiHz in integer steps. (Officially, 1 GHz is supported &ndash; it is ''gigaherz'', not MHz, the upper limit being in the UHF radio frequency band.  Monkey's Audio, OptimFROG and MPEG-4 ALS support the entire WAVE range up to 4 GiHz.) Can also compress AIFF files of non-integer sampling rates and recreate them bit-perfectly, but will round off sampling rate upon playback.
* High-resolution support for bit depth 1-bit to 32-bit integer and sampling rates up to ''giga''herz range radio frequencies, in integer steps. (2 GHz works although only 1 GHz is officially supported; for more UHF, Monkey's Audio, OptimFROG and MPEG-4 ALS support the entire WAVE range up to 4 GiHz.) Can also compress ''non-integer sampling rates'' in AIFF/AIFC/CAF (signals the WAVE format cannot contain).  
* 32-bit ''floating-point'' supported &ndash; also including CoolEdit/Adobe Audition's own float format (use the <tt>-a</tt> option only if the .wav was generated by CoolEdit/Audition).  (This line like OptimFROG.)
* 32-bit ''floating-point'' supported &ndash; also including CoolEdit/Adobe Audition's own float format (use the <code>-a</code> option ''only if'' the .wav was generated by CoolEdit/Audition).  (This line like OptimFROG.)
* As much as 256 channels currently supported (from version 5.5.0 on; [https://github.com/dbry/WavPack/issues/117 can be extended to the thousands] &ndash; for even more, MPEG-4 ALS supports 66536.)  
* As much as 256 channels currently supported (from version 5.5.0 on; [https://github.com/dbry/WavPack/issues/117 can be extended to the thousands] &ndash; more than any codec except MPEG-4 ALS (which is capped at 66536).)  
* Hybrid lossy/lossless mode (can also be used as lossy &ndash; OptimFROG also has such a mode.)
* Hybrid lossy/lossless mode (can also be used as lossy &ndash; OptimFROG also has such a mode.)
* For LPCM it can read and output to WAVE including extensions like RF64, to Sony's Wave64, AIFF/AIFC (both endiannesses) and CAF (ditto) &ndash; with full restore of also non-audio parts to bit-by-bit the original file in the original format.  (Monkey's/OptimFROG/TAK do the same to the input formats they support.)  Also WavPack can handle too large noncompliant "WAVE" files (can still be restored to bit-identical the same as the flawed input file &ndash; or to formats that provide for larger files).  
* For LPCM it can read and output to WAVE (including the RF64 format extension used for large files and from 5.70 also BW64), to Sony's Wave64, AIFF/AIFC (both endiannesses) and CAF (ditto) &ndash; with full restore of also non-audio parts to bit-by-bit the original file in the original format.  (Monkey's/OptimFROG/TAK do the same to the input formats they support.)  Also WavPack can handle too large noncompliant "WAVE" files (by default, those will be restored to bit-identical the same as the flawed input file &ndash; optionally one can force output to compliant RF64/W64 files).  
* Recompression: Can recompress .wv files in place, with tag transfer.  (Like FLAC on .flac files.)
* Recompression: Can recompress .wv files in place, with tag transfer.  (Like FLAC on .flac files.)
* Drag and drop support: Dropping a file on to wavpack.exe/wvunpack.exe will encode/decode it to source directory. (Like FLAC.)  From 5.5.0, one can also apply options to drag and drop by renaming the executable, and drop several files.
* Drag and drop support: Dropping a file on to wavpack.exe/wvunpack.exe will encode/decode it to source directory. (Similar to FLAC.)  From 5.5.0, one can also apply options to drag and drop by renaming the executable, and drop several files.
 
Like FLAC/TAK/OptimFROG, WavPack employs a "wasted bits" strategy to handle cases of ''n "actual bits of signal" zero-padded and stored as N bits''; such signals can be found in certain DVDs, but also as "fake high resolution" where a 16-bit signal is merely put in a 24-bit file to look impressive.  WavPack handles more "fake high resolution" cases than just zero-padding.  5.7.0 introduces an further improvement to capture similar patterns in 32-bit integer files generated by "naively converting from 32-bit float".  That particular mode is disabled by default and is arguably best left to power users (invoking it with <code>--optimize-int32</code>) as only 5.7.0 can decode as lossless; to earlier versions and players they will be presented as lossy without correction file (and will indeed be lossy with differences around -138 dB down).  


== Limitations ==
== Limitations ==
The following bullet item list is hardly of interest except for special purposes; WavPack supports nearly every input format that any competing codec handles. One exception is the legacy AU/SND, apparently supported only by Monkey's Audio.
The following bullet item list is hardly of interest except for special purposes; WavPack supports nearly every input format that any competing codec handles. One exception is the legacy AU/SND, apparently supported only by Monkey's Audio.  
* DSD: Will reject DST-compressed DSDIFF (which are already compressed heavier than WavPack does) and Wideband Single-bit Data files (apparently, the Tascam and Korg devices which can produce these, can also export to other DSD formats).<br/> Also, DSD files cannot be encoded as hybrid with correction files.
* DSD: Will reject DST-compressed DSDIFF (which are already compressed heavier than WavPack does) and Wideband Single-bit Data files (apparently, the Tascam and Korg devices which can produce these, can also export to other DSD formats).<br/> Also, DSD files cannot be encoded as hybrid with correction files.
* Certain rare files &ndash; largely unsupported by other codecs &ndash; may be played back with technical compromise solutions that are unlikely to concern the average end-user.  Should one encounter one of those rare AIFF files which have a non-integer sampling rate (something WAVE does not support), WavPack will compress them and wvunpack will restore them bit-identically with no loss of information &ndash; but playback will be at integer rate. E.g., a file sampled at 44100.441 Hz will be played back at 0.001 percent wrong speed &ndash; unlikely to be noticed by ear, and more likely to be accepted by an audio player. 
* 64-bit float is not supported.  (Apparently no other lossless audio compressor can support it either.)
* 64-bit float is not supported.  (Apparently no other lossless audio compressor can support it either.)
* wvunpack can ''force output'' to a different format than input, but like every decoder offering such an option, it does not let the user select any version of the output format.  None of the competing codecs can force selection of WAVE format (closest is FLAC, which can enforce RF64 and in an upcoming version will be able to force the original WAVE_FORMAT_PCM over WAVE_FORMAT_EXTENSIBLE); wvunpack's <tt>--wav</tt> will enforce its choice WAVE version (= RF64 iff the file is too big for WAVE, but RF64 cannot be forced otherwise).  Only FLAC and WavPack can enforce AIFF output, and only wvunpack can select little-endian (AIFC type "sowt"), but wvunpack will avoid AIFC as long as the signal can be fit in the original AIFF container.  And although wvunpack can force DSDIFF encodes to DSF and vice versa, it has no DSD encoder and can not convert PCM to DSD.
* wvunpack can ''force output'' to a different format than input, and for AIFF/CAF also select endianness, but it cannot force output to different versions of big-endian AIFF (it will avoid AIFC as long as the signal can be fit in the original AIFF container) nor BW64 &ndash; nor select between WAVE_FORMAT_PCM and WAVE_FORMAT_EXTENSIBLEFew other formats do allow for such output selection; reference FLAC can from 1.4.3 offer some wider choices than wvunpack can.  
* <tt>--import-id3</tt> can currently only import ID3v2.3. (Not ID3v2.4.) Also it has a limit of 1 MB unless <tt>--allow-huge-tags</tt> is specified (use [[Mp3tag]] to copy tags).  Tags > 1 MB are warned against for compatibility reasons, but it is not known what applications may reject such files.
* Although all non-audio will be stored, <code>--import-id3</code> can not ''import'' every type of ID3 tag to APEv2. (5.70 imports more tag types than previous versions, yet some users might want use use e.g. [[Mp3tag]] to copy over more tags from the original.) Also, unless <code>--allow-huge-tags</code> is specified, size is limited to 1 MB; older software might not read larger tagsets (but no known ''playback'' incompatibilities are known).
* Some third-party implementations have limitations and bugs waiting to be fixed.  
* Some file formats have features stored in file headers (like loop points, or for AIFF possibly non-integer sampling rates) which will not be ''visible'' to the end-user when trying to play back the .wv file in a typical player. They are nevertheless available to certain audio editing software plugins, and will in any case be restored upon decoding.
* Some features are unsupported by several applications: in particular, support for correction files is only found in a few players.  
* The most significant third-party implementation (ffmpeg as of version 7.0) has bugs waiting to be fixed.
 
As of 5.5.0 and above, MacOS versions must be built with e.g. HomeBrew, and Windows XP is only supported through a special executable (available in version 5.6.0 at wavpack.com, upgrade from previous unofficial build posted at HA is strongly advised).  WavPack version 5 discontinues some features, but version 4.80 is still available to convert any version 3.x files that might still exist.
 
WavPack has traditionally had less hardware support than FLAC ([[Rockbox]] having been the most notable platform, others listed at https://www.wavpack.com/index.html#Hardware ), but with WavPack playback through Android and iOS players, the distinction between "hardware" and "software" is arguably blurred. The Android OS does not ''natively'' support other lossless audio formats than WAVE and FLAC, so there have been issues getting certain Android solutions to recognize other media files including WavPack.<ref>[https://hydrogenaud.io/index.php/topic,122768 HA thread with link to Android bug report by the Monkey's Audio author]</ref>
 
== Information for users of other codecs (and older WavPack) ==
Parts of this section will be less relevant to users who primarily decode and convert through player software, rather than directly invoking the executables.  WavPack is the only "major" lossless encoder with separate executables for encoding (<code>wavpack</code>) and decoding/info (<code>wvunpack</code>).


WavPack version 5 discontinues some features, like compression to Windows .sfx self-extracting file (cf. OptimFROG) and the <tt>-p</tt> feature.  Furthermore, WavPack version 3.x files are no longer supported. To recompress these files (if any are still around, WavPack 4 was released in 2004) to WavPack 5 files (for the fast decoding-free error checking feature), one must first recompress by WavPack 4.80 (still available) or lower, and then by WavPack 5.  
Even for features that are comparable between codecs, they may behave different &ndash; or default to different behaviour &ndash; out of the purpose they were designed to address, their development, or other design choices.  


As of 5.5.0 and above, MacOS versions must be built with e.g. HomeBrewFor Windows XP, a special executable is required, available at wavpack.com (brought back as of 5.6.0, upgrade is advised).  
* WavPack is designed as a ''file compressor'' for audio files &ndash; this like Monkey's, TAK and OptimFROG, but in contrast to FLAC and ALAC which are ''audio compressors''. The difference is in the ambition to store all non-audio information (and in the correct order).  Using reference FLAC one might "opt in" on non-audio parts by giving options; using WavPack one can "opt out" and discard this information. 
** ''Note: This difference is irrelevant for CD ripping.'' Contrary to a common misconception, CD audio is ''not'' stored as WAVE &ndash; nor in any sort of file.  Thus, using a file compressor gives no more "true" copy of a CD. (WavPack's support for embedded cuesheets might &ndash; depending on player application &ndash; give a better user experience for those who prefer to store one file per CD, but that is not due to how CDs work.)
* MD5 is opt-in (the <code>-m</code> switch) &ndash; even if verification is requested and the MD5 is calculated, it is only written to file if specifically requested. TAK and OptimFROG work similarly in that they also require the user to opt-in on MD5. FLAC, ALAC and Monkey's all work different: FLAC includes MD5 (though some encoders make exceptions under some circumstance), ALAC has nothing such &ndash; and Monkey's MD5s are not comparable with others, as it hashes the encoded bitstream.   
** Also, WavPack computes MD5 using the source's endianness (endianness is like the distinction between "4th of July" and "July 4th"), and so MD5s may differ between WAVE source and AIFF/CAF source for the same audio.  (At least a recent foobar2000 will handle them without giving false warnings.)
* Like Monkey's/TAK/OptimFROG &ndash; but unlike FLAC and ALAC-in-MP4 &ndash; tags are at the end of the file. Consequences for users are that retagging will not trigger full file rewrite, but sometimes applications may spend longer time displaying art and viewing tags.
* Users of "older WavPack" might take note that version 5 discontinues some features, like <code>-p</code>, and also the <code>-e</code> for self-extracting files &ndash; those and other older files can still be converted, but the ancient WavPack 3 with .wav extension requires version 4.80.0 (still available).
** See the [[#File formats, versions, decoding and transcoding support]] section for more details.


WavPack has traditionally had less hardware support than FLAC ([[Rockbox]] having been the most notable platform, others listed at https://www.wavpack.com/index.html#Hardware ), but with WavPack playback through Android and iOS players, the distinction between "hardware" and "software" is arguably blurred. There have been issues getting certain Android solutions to recognize media files including WavPack.<ref>[https://hydrogenaud.io/index.php/topic,122768 HA thread with link to Android bug report by the Monkey's Audio author]</ref>
=== Performance &ndash; file size, CPU load ===
Third-party support for hybrid-encoded lossless playback (the correction files, see below) is known to be limited.
Rewind twenty years, to 2004 hardware costs, compression ratios did matter much more &ndash; also, several formats would be too heavy to even ''play'' on portable devices, and the official WavPack site would warn against the <code>-hh</code> mode for that use even if it were not heavier than the fastest Monkey's Audio mode.
Fast forward to now, enthusiasts will still compare performance even if ordinary users may take note that impact on cost is often negligible. Different considerations may apply when a drive is near full. 
The HA wiki's [[lossless comparison]] article compares speed and compression ratio on CDDA on the respective codecs' ''default'' setting, taken from van Beurden's comparison studies.  The test corpus is chosen to be a "wide" selection, and most music collections are biased in one direction or another genre-wise; users who are concerned about compression might look up the individual sources in the study and/or make a test sample from their own collection.  By and large, the following observations can be made:
* WavPack defaults to a fast codec, between FLAC and Monkey's; is not so heavy on decoding CPU as to cause actual practical problems, although it officially recommends against <code>-hh</code> "for use on vintage portable devices" &ndash; it should be fine on anything modern.  Even <code>-hh</code> seems to decode lighter than Monkey's fastest mode.  
** The "between FLAC and Monkey's" hold for "default encoding and all decoding". Like most modern codecs, WavPack can be set to exert more encoding effort without affecting decoding load: the <code>-x</code> switch. Thus, decoding for e.g. ReplayGain tagging will be slower than e.g. FLAC in all modes, but faster than Monkey's &ndash; and recompressing with a slow <code>-x</code> setting (which can be done in the background) will not make the files any heavier to process later.  (Indeed, <code>-x</code> sometimes makes decoding lighter, although unlikely to be noticed except by measuring it.)
** Playback on Android might be less battery efficient than FLAC, which can take advantage of the OS' native support.  The difference is likely small for power-hungry players (like VLC).
** On the other hand, ''integrity verification'' can be done lightening-fast, without decoding (presuming WavPack 5 file format and WavPack 5 decoder).
* Compressing CDDA: WavPack can compress to slightly smaller files than (reference) FLAC; the difference has diminished with the most recent FLAC releases, but "in return", modern CPU speeds might have made the more expensive WavPack settings more tempting, especially when one can re-encode in the background.
* Compressing high resolution signals and multi-channel: The "extra" resolution might be a mixed bag of upsampling artefacts, tape hiss, sometimes geniune overtones (and for bat enthusiasts, actual interesting audio). There are different kinds of samples one might call "fake high resolution", and different properties of such &ndash; upsampling or bit depth &ndash; are handled different by the codecs.  WavPack is known to handle some properties exceptionally well ("wasted bits" are exploited also by FLAC and TAK, but WavPack and OptimFROG are capable of detecting more "wasteful" patterns; Monkey's and ALAC cannot exploit wasted bits at all) &ndash; and others lesser. Several codecs benefit from spending more effort on high resolution signals, and WavPack users might consider to (re-) compress high resolution and multi-channel with as slow setting as <code>-hx4</code>, presuming it can be done as background recompression where time is not much of an object; decoding load is largely unaffected (sometimes slightly improved) by the high <code>-x</code>.
** For 32-bit float, there is not much competition, and WavPack might be the natural choice for compatibility; it does outcompress Monkey's recently-added float mode.  Those files are not very common in the wild, and users with a sizeable collection of 32-bit files for audio processing will likely choose codec for compatibility with their DAW software.  WavPack 5.7.0's special setting for 32-bit integer converted from 32-bit float might be an option in such situations. 
* Users who compare nearly tied compression levels between codecs, should take into account how metadata storage affect total file size.  WavPack defaults to storing the source's metadata, which may include big album art; on the other hand, FLAC defaults to leaving some kilobytes padding in the file.




= Using WavPack =
= Using WavPack =
WavPack files can be played back in supported players (see below), and several of these can encode to WavPack, invoking the official tools.  However, there are situations where certain WavPack features are accessible only through the WavPack executables directly.  For example, you cannot expect non-audio data (for full file restore) to be preserved when encoding/decoding through ''players'', as they usually pass on only the audio.  Also, the input format might exceed the player's internal decoding; e.g. trying to convert 32-bit integer or DSD with foobar2000 will yield a warning that it will not be lossless (also, converting DSD to PCM leads to files many times the size, being inherently different formats).
For everyday use in what other lossless codecs can do, just play it back in a supported player &ndash; many of which support tagging, and so do several tagging software.  Several of these players can also encode to WavPack, invoking the official tools.   


Unlike most other codecs, WavPack has separate encoding and decoding executables (wavpack and wvunpack).
Certain more advanced uses are not accessible through player software &ndash; not even if they invoke the official tools &ndash; and are best invoked through the WavPack executables directly.  For example, you cannot expect non-audio data (for full file restore) to be preserved when encoding/decoding through ''players'', as they usually pass on only the audio; this is not particular to WavPack, but must be expected if you want to store non-audio chunks in other formats that support it.  Also, WavPack supports input formats that might exceed the player's internal decoding; e.g. trying to convert DSD with foobar2000 will yield a warning that it will not be lossless (also, converting DSD to PCM leads to files many times the size, being inherently different formats), and the same will 32-bit integer in 32-bit foobar2000 (which uses float internally).  


== Encoding/decoding by drag and drop (Windows) ==  
== Encoding/decoding by drag and drop (Windows) ==  
The simplest encoding/decoding might be ''dragging and dropping'' a (supported) file to wavpack.exe (/wvunpack.exe).  Then the file will be encoded/decoded with the default options.  Dropping a .wv file onto wavpack.exe will recompress it, prompting before overwrite (again, using default settings &ndash; possibly a bad deal if it was encoded with high -x switches).  Drag and drop also works on a shortcut to the executable. It is not possible to drop a folder, but from version 5.5.0, there is a way to drag and drop ''several'' files.
The simplest encoding/decoding might be ''dragging and dropping'' a (supported) file to wavpack.exe (/wvunpack.exe).  Then the file will be encoded/decoded with the default options.  Dropping a .wv file onto wavpack.exe will recompress it, prompting before overwrite (again, using default settings &ndash; possibly a bad deal if it was encoded with high <code>-x</code> switches).  Drag and drop also works on a shortcut to the executable. It is not possible to drop a folder, but from version 5.5.0, there is a way to drag and drop ''several'' files.


From version 5.5.0, drag and drop supports ''options'' by renaming the executable.  The user can rename a copy of the executable according to preferred settings, which will be applied to the process upon drag and drop.  The example given by the developer in [https://hydrogenaud.io/index.php/topic,122626.msg1012159.html#msg1012159 in this HA forum post]<ref>[https://hydrogenaud.io/index.php/topic,122626.msg1012159.html#msg1012159 HA forum post on how to rename executable for drag and drop]</ref> uses encoding options that many WavPack users will recommend (better compression than default, verification and MD5 fingerprinting), and novice users can choose to copy that filename for the executable.  For fine-tuning performance or for more specialized tasks, more options are described below.  
From version 5.5.0, drag and drop supports ''options'' by renaming the wavpack/wvunpack executable.  The user can rename a copy of the executable according to preferred settings, which will be applied to the process upon drag and drop.  The example given by the developer in [https://hydrogenaud.io/index.php/topic,122626.msg1012159.html#msg1012159 in this HA forum post]<ref>[https://hydrogenaud.io/index.php/topic,122626.msg1012159.html#msg1012159 HA forum post on how to rename executable for drag and drop]</ref> uses encoding options that many WavPack users will recommend (better compression than default, verification and MD5 fingerprinting), and novice users can choose to copy that filename for the executable.  For fine-tuning performance or for more specialized tasks, more options are described below.  


== Basic command line encoding/decoding [[Windows_command_line_tips|(for Windows: command-line hints here)]] ==  
== Basic command line encoding/decoding [[Windows_command_line_tips|(for Windows: command-line hints here)]] ==  
The basic ''encoding'' usage is <tt>wavpack filename.extension</tt> (which creates <tt>filename.wv</tt>) &ndash; this is what drag and drop accomplishes.  Wildcards are supported, e.g. <tt>wavpack *.wav</tt> (but not simply <tt>wavpack *</tt>).  For a ''single'' input file, one can specify output like e.g. <tt>wavpack infilename.wav -o outfilename.wv</tt> (on Windows, the <tt>-o</tt> can be omitted).  Input file extension ".wav" can be dropped, and output ".wv" extension as well &ndash; but <tt>wavpack foo</tt> will only find foo.wav, not e.g. foo.w64.   
The basic ''encoding'' usage is <code>wavpack filename</code> (which creates <code>filename.wv</code>) &ndash; this is what drag and drop accomplishes.  Wildcards are supported, e.g. <code>wavpack *.wav</code> (but not simply <code>wavpack *</code>).  For a ''single'' input file, one can specify output like e.g. <code>wavpack infilename.wav -o outfilename.wv</code> (on Windows, the <code>-o</code> can be omitted).  Input file extension ".wav" can be dropped, and output ".wv" extension as well &ndash; but <code>wavpack foo</code> will only find foo.wav, not e.g. foo.w64 &ndash; and not a "foo" with no file extension(Power users may take note that for <code>--raw-pcm</code> input, the encoder will not look for foo.wav but rather for foo.raw.)


The basic ''decoding'' usage &ndash; as will be accomplished by drag and drop &ndash; is <tt>wvunpack filename.wv</tt>.  By default, wvunpack will restore the exact same file (metadata and file structure and all; it will know the original file name extension but not the rest of the file name &ndash; timestamp can be stored by using <tt>-t</tt>.) If only audio was encoded (conversion from a ''player'' would usually work this way), output defaults to filename.wav.  
The basic ''decoding'' usage &ndash; as will be accomplished by drag and drop &ndash; is <code>wvunpack filename.wv</code>.  By default, wvunpack will restore the exact same file (metadata and file structure and all; it will know the original file name extension but not the rest of the file name &ndash; timestamp can be stored by using <code>-t</code>.) If only audio was encoded (conversion from a ''player'' would usually work this way), output defaults to filename.wav. Output filename can be specified, and just like for the wavpack encoder, file extensions can be dropped; e.g., <code>wvunpack foo -o bar</code> (or on Windows, dropping the <code>-o</code>) will decode foo.wv to bar.<original file's extension>.  This is arguably advisable: wvunpack will not ''override output format'' by setting file extensionE.g. if the input was a CAF file, <code>wvunpack foo -o bar.w64</code> is still a CAF file, and the user has only managed to mislead themselves.  To force output format, see the [[#Decoding options]] paragraph.
Just like for the wavpack encoder, file extensions can be dropped; e.g., <tt>wvunpack foo bar</tt> will decode foo.wv to bar.<original file's extension>.  This is arguably advisable, as setting a full filename is ''not going to override format'', only make a potentially misleading output extension: E.g. if the input was a CAF file, <tt>wvunpack foo bar.w64</tt> is still a CAF file.  To force output format, see the [[#Decoding options]] paragraph.


=== Several input files ===
=== Several input files ===
Wildcards are supported, like <tt>wavpack *.wav</tt>.  To give several filenames as input to wavpack/wvunpack, there are slight differences between the Windows version and the *n*xes:  
To give several filenames as input to wavpack/wvunpack, other than through wildcards, there are (for historical reasons) slight differences between the Windows version and the *n*xes:  
Windows (requires WavPack 5.5.0): use the <tt>--drop</tt> option as in the above example given by the developer.  It is intended for drag and drop (hence the name of the option) and will write the output to same directory as source.  However it can also be used with command-line:  <tt>wavpack --drop firstfile secondfile</tt> will compress firstfile.wav to firstfile.wv and secondfile.wav to secondfile.wv.  Note that without the <tt>--drop</tt>, the command <tt>wavpack firstfile secondfile</tt> will compress firstfile.wav to secondfile.wv, as <tt>-o</tt> is optional on Windows &ndash; indeed that is why the <tt>--drop</tt> had to be introduced.  An arbitrary number of files can be processed, e.g. <tt>wvunpack --drop firstfile secondfile thirdfile fourthfile fifthfile</tt> will decode firstfile.wv, ..., fifthfile.wv.
Windows (requires WavPack 5.5.0): use the <code>--drop</code> option as in the above example given by the developer.  It is intended for drag and drop (hence the name of the option) and will write the output to same directory as source.  However it can also be used with command-line:  <code>wavpack --drop firstfile secondfile</code> will compress firstfile.wav to firstfile.wv and secondfile.wav to secondfile.wv.  Note that without the <code>--drop</code>, the command <code>wavpack firstfile secondfile</code> will compress firstfile.wav to secondfile.wv, as <code>-o</code> is optional on Windows &ndash; indeed that is why the <code>--drop</code> had to be introduced.  An arbitrary number of files can be processed, e.g. <code>wvunpack --drop firstfile secondfile thirdfile fourthfile fifthfile</code> will decode firstfile.wv, ..., fifthfile.wv.
For *n*x, one can omit the <tt>--drop</tt>.
For *n*x, one can omit the <code>--drop</code>.  


== Applying options ==
== Applying options ==
For tuning performance or other settings, one might want to apply command-line options.  Some external applications can apply options without the user having to type &ndash; e.g. encoding with [[foobar2000]], there are two compression sliders, one for the fast-to-extra-high and one for the <tt>-x</tt> settings (see below) &ndash; but in the Windows GUI one will want to type them in.  Options can be concatenated for short, like for example writing <tt>-hh -x2 -m -v -y</tt> as <tt>-hhx2mvy</tt>.   
For tuning performance or other settings, one might want to apply command-line options.  Some external applications can apply options without the user having to type &ndash; e.g. encoding with [[foobar2000]], there are two compression sliders, one for the fast-to-extra-high and one for the <code>-x</code> settings (see below) &ndash; but for command-line one will have to type them, and also in the Windows GUI.  Options can be concatenated for short, like for example writing <code>-hh -x2 -m -v -y</code> as <code>-hhx2mvy</code>.   


The user should beware that the wavpack encoder and the wvunpack decoder (and wvtag/wvgain) have to "re-use letters".  While some do the same in the wvunpack and wavpack (like <tt>-d</tt> for delete input file, <tt>-y</tt> for "yes to all", <tt>-t</tt> to preserve timestamp, and <tt>-l</tt> for (Windows only) "run with low priority") and others cover the same purpose in both executables (like <tt>-m</tt> and <tt>-v</tt>), the user may be warned that certain letters do not.  E.g. <tt>-b</tt>, <tt>-c</tt>, <tt>-n</tt> cover completely urelated functions upon decoding vs upon encoding.   
The user should beware that the wavpack encoder and the wvunpack decoder (and wvtag/wvgain) have to "re-use letters".  While some do the same in the wvunpack and wavpack (like <code>-d</code> for delete input file, <code>-y</code> for "yes to all", <code>-t</code> to preserve timestamp, and <code>-l</code> for (Windows only) "run with low priority") and others cover the same purpose in both executables (like <code>-m</code> and <code>-v</code>), the user may be warned that certain letters do not.  E.g. <code>-b</code>, <code>-c</code>, <code>-n</code> cover completely urelated functions upon decoding vs upon encoding.   
 
5.7.0 introduces multi-threading options for both encoding and decoding, invoked with <code>--threads=<number 1 to 12></code>, or simply <code>--threads</code> to let WavPack choose.  Multithreading does not reduce overall CPU load, but unless the CPU is already working at max, it will do one or a few files in fewer seconds; thus it is invoked by default for the CoolEdit plugin.  For encoding, it leads to slightly different files, with usually very small size impact.


=== Encoding options (lossless) ===
=== Encoding options (lossless) ===
Encoding using <tt>-hxm</tt> seems a sensible trade-off between compression and CPU load.  The manual (online, or included as wavpack_doc.html in the distribution) gives an exhaustive reference, and the following is merely a selection.
Encoding using <code>-hxm</code> seems a sensible trade-off between compression and CPU load.  Some selected options are described as follows; for an exhaustive refence, see the manual (online, or included as wavpack_doc.html in the distribution).
* Compression.  WavPack has four compression modes that affect compression as well as encoding ''and'' decoding time: fast (<tt>-f</tt>), default, high (<tt>-h</tt>) and very high (<tt>-hh</tt>).  The CPU load of <tt>-hh</tt> is measured to around twice that of <tt>-f</tt> (and could in the early 2000s be too heavy for portable players, although it does decode faster than any Monkey's).  On top these modes, the optional extra processing <tt>-x1</tt> to <tt>-x6</tt> settings will apply extra compression effort that does not increase ''decoding'' CPU load. <tt>-x</tt> without number is synonymous to <tt>-x1</tt>, which is often recommended (in all modes, fast/normal/high/extra high).  The official manual calls <tt>-x4</tt> to <tt>-x6</tt> "extremely slow", but the size gains might be significant for high resolution audio in particular (van Beurden's revision 5, testing <tt>-x4</tt>).   
* Compression.  WavPack has four compression modes that affect compression as well as encoding ''and'' decoding time: fast (<code>-f</code>), default, high (<code>-h</code>) and very high (<code>-hh</code>).  The CPU load of <code>-hh</code> is measured to around twice that of <code>-f</code> (and could in the early 2000s be too heavy for portable players, although it does decode faster than any Monkey's).  On top these modes, the optional extra processing <code>-x1</code> to <code>-x6</code> settings will apply extra compression effort that does not increase ''decoding'' CPU load. <code>-x</code> without number is synonymous to <code>-x1</code>, which is often recommended (in all modes, fast/normal/high/extra high).  The official manual calls <code>-x4</code> to <code>-x6</code> "extremely slow", but the size gains might be significant for high resolution audio in particular (van Beurden's revision 5, testing <code>-x4</code>).   
** 5.5.0 introduces optional switches for the default compression: <tt>-g</tt> for normal mode and <tt>-x0</tt> for "no <tt>-x</tt>".  These are redundant for basic use, but can be used to switch off options already given (e.g. in renamed executables, or custom builds): <tt>-x6 -x0</tt> will switch off the extra processing, and <tt>-h -f -g</tt> will encode as normal, whereas previous versions would abort with an error.
** 5.5.0 introduces optional switches for the default compression: <code>-g</code> for normal mode and <code>-x0</code> for "no <code>-x</code>".  These are redundant for basic use, but can be used to switch off options already given (e.g. in renamed executables, or custom builds): <code>-x6 -x0</code> will switch off the extra processing, and <code>-h -f -g</code> will encode as normal, whereas previous versions would abort with an error.
** With DSD files, there are only two compression settings, normal and high; the option <tt>-f</tt> will select normal, <tt>-h</tt>/<tt>-hh</tt> will both select high, and the <tt>-x</tt> switches are silently ignored.  
** With DSD files, there are only two compression settings, normal and high; the option <code>-f</code> will select normal, <code>-h</code>/<code>-hh</code> will both select high, and the <code>-x</code> switches are silently ignored.  
* Guarding against errors upon encoding: The "<tt>-m</tt>" switch will compute an audio MD5 sum (like FLAC does by default) and store it for later verification.  The "<tt>-v</tt>" switch will verify by decoding the file after encoding and writing the file to disk<ref>[https://hydrogenaud.io/index.php?topic=121714.msg1008108#msg1008108 HA forum comment:] verification checks the written file after closing and reopening</ref>. <tt>-vm</tt> will do both &ndash; that is, calculate the MD5s to verify, and store it.  (Using the corresponding switches in wvunpack will check without producing output file, however wvunpack also has a faster corruption check switch <tt>-vv</tt> for WavPack 5-encoded files.)
* Guarding against errors upon encoding: The "<code>-m</code>" switch will compute an audio MD5 sum (like FLAC does by default) and store it for later verification.  The "<code>-v</code>" switch will verify by decoding the file after it has been written to disk<ref>[https://hydrogenaud.io/index.php?topic=121714.msg1008108#msg1008108 HA forum comment:] verification checks the written file after closing and reopening</ref>. <code>-vm</code> will do both &ndash; that is, calculate the MD5s to verify, and store it.  Using the corresponding switches in wvunpack will check without producing output file, however wvunpack also has a faster corruption check for WavPack 5-encoded files: <code>-vv</code>.
* <tt>--import-id3</tt> will import ID3v2.3 tags (currently not v2.4 nor v2.2) present in the source file &ndash; typically in Sony DSF files &ndash; and convert them to WavPack's preferred APE tags.  (It will still keep the chunk for restoring the original file.)  By default, importing is limited to 1 MB; for more, use <tt>--allow-huge-tags</tt>.  Same option works in wvtag.
* <code>--import-id3</code> will import ID3v2.3/2.4 tags present in the source file &ndash; typically in Sony DSF files &ndash; and convert them to WavPack's preferred APE tags.  (Not all tags are supported, but the full tags chunk will be kept for restoring the original file.)  By default, importing is limited to 1 MB; for more, use <code>--allow-huge-tags</code>.  Same option works in wvtag; indeed, one can encode first and then afterwards "import" the tags from the WavPack file using <code>wvtag --import-id3 wavpackfile.wv</code>; this provided that these data have not been deleted by the following <code>-r</code> option:
* <tt>-r</tt>: remove non-audio chunks.  By default, WavPack will store these in the .wv file for later bit-by-bit restoration of everything, not only the audio. Use <tt>-r</tt> to throw them away and encode audio only &ndash; like encoding through most players appear to do.  
* <code>-r</code>: remove non-audio chunks.  By default, WavPack will store these in the .wv file for later bit-by-bit restoration of everything, not only the audio. Use <code>-r</code> to throw them away and encode audio only &ndash; like encoding through most players appear to do.  
* <tt>-t</tt>: copy input file's time stamp.  (To restore the file with the original time stamp, use <tt>-t</tt> both when encoding and when decoding.)
* <code>-t</code>: copy input file's time stamp.  (To restore the file with the original time stamp, use <code>-t</code> both when encoding and when decoding.)
* <tt>--pause</tt>: (Windows only!) waits for keypress at the end.  Useful for reading output before exit when calling wavpack/wvunpack in a separate window (which both drag-and-drop the Windows front-end do).
* <code>--pause</code>: (Windows only!) waits for keypress at the end.  Useful for reading output before exit when calling wavpack/wvunpack in a separate window (which both drag-and-drop the Windows front-end do).
* <tt>-y</tt>: "yes" to everything.  Use with caution, will overwrite.  From 5.5.0 there is also a <tt>--no-overwrite</tt> that will skip instead of asking to overwrite.
* <code>-y</code>: "yes" to everything.  Use with caution, will overwrite.  From 5.5.0 there is also a <code>--no-overwrite</code> that will skip instead of asking to overwrite.
* <tt>-d</tt>: delete source file upon successful completion.  Again, use with caution.  
* <code>-d</code>: delete source file upon successful completion.  Again, use with caution.  
* <tt>-l</tt> will force WavPack to run at low priority (Windows only)
* <code>-l</code> will force WavPack to run at low priority (Windows only)
* <tt>-c</tt> with <tt>-b</tt> to select lossy quality: hybrid lossless/lossy use, see below.
* <code>-c</code>: this is for hybrid lossless, see below.  


WavPack can recompress .wv files in place (using a temporary file until done).  For example, <tt>wavpack -hx4mvy wavpackfile.wv</tt> will recompress wavpackfile.wv the file in high mode using <tt>-x4</tt> extra processing, write audio MD5 to it, open the temp file and re-read for verification &ndash; and once verified, replace the old wavpackfile.wv. Tags will be transferred.  <tt>wavpack -hx4rlmvy wavpackfile.wv</tt> will also run with low priority (assuming the Windows platform), and will discard non-audio chunks &ndash; that is, the ones used to restore the original file's metadata; the .wv file's APE tags will still be copied.  As an example, one can compress an ID3v2.4-tagged DSF file by drag and drop; WavPack will then store the tag chunk, but WavPack cannot ''import'' v2.4 to its own (APEv2) tags.  Therefore, open both in Mp3tag, and copy the ID3v2.4 tags to the WavPack file. If then you decide that there is no need to restore the original file's ID3v2.4 upon any unpacking, you can apply the <tt>wavpack -hx4rlmvy wavpackfile.wv</tt> command; it will then discard that chunk (but keep the tags that Mp3tag wrote!), recompress using high (silently ignoring the -x4 that has no effect on DSD) with low priority, write an MD5 sum, verify the process and replace the .wv file by the new recompressed file.  
WavPack can recompress .wv files in place (using a temporary file until done).  For example, <code>wavpack -hx4mvy wavpackfile.wv</code> will compress wavpackfile.wv in high mode using <code>-x4</code> extra processing, writing everything (and an audio MD5 checksum) to a temporary file with tags transferred; close and then re-open the temp file to re-read for verification &ndash; and only once verified, replace the old wavpackfile.wv. <code>wavpack -hx4rlmvy wavpackfile.wv</code> will also run with low priority (assuming the Windows platform), and will discard non-audio chunks &ndash; that is, the ones used to restore the original file's metadata; the .wv file's APE tags will still be copied.  Some operations do require recompression even if the user would not demand it; For example, wavpack cannot add MD5 sum to a .wv file without recompressing it. Also, if the user wants to discard the original file's headers/footers, that can be done upon decompression or recompression &ndash; but not by simply removing them from the .wv file.
There is no out-of-the-box facility to recompress based on how heavy the original file was compressed, or to keep the smallest file.  


=== (Incomplete:) hybrid lossless & lossy encoding ===
=== (Incomplete:) hybrid lossless & lossy encoding ===
(Needs to be expanded. Notes: DSD can currently not be hybrid-encoded and floating-point files should not be.  The correction file will be omitted by a lot of applications/players, including ffmpeg; thus, using ffmpeg or ffmpeg-based players to convert/play hybrid-encoded WavPack will be lossy.)
(Needs to be expanded. Notes: DSD can currently not be hybrid-encoded and floating-point files should not be.  The correction file will be omitted by a lot of applications/players, including VLC, mplayer and ffmpeg; thus, using ffmpeg or ffmpeg-based players to convert/play hybrid-encoded WavPack will be lossy. For WavPack in Matroska, there doesn't seem to be any player that will play both the lossy stream and the correction stream, although mkvmerge/mkvextract will import/extract both streams. foobar2000 can play hybrid lossless .wv+.wvc, but will omit a Matroska-encapsulated correction stream.)


Basic use: the <tt>-b</tt> switch &ndash; and for losslessness, with <tt>-c</tt> to create a correction file. The <tt>b</tt> takes a numerical value signifying ''bits per sample'' if < 24 and ''kbit/second'' if 24 to 9600. E.g. <tt>-b12.5</tt> (no space in between, with . even if your locale uses comma for decimal point).
Basic use: the <code>-b</code> switch &ndash; and for losslessness, use <code>-c</code> to create a correction file.  
<tt>wavpack -b234.56 -c filename</tt> will create filename.wv file and correction file filename.wvc.  As long as both are present, playback and decoding (by <tt>wvunpack filename</tt> the ordinary way) will be lossless.
A numerical argument for quality is mandatory: if < 24 it will signify ''bits per sample'' and if > 24 it will signify ''kbit/second''. Decimal separator is . even if your locale uses the comma.  
The file filename.wv &ndash; which is at most 234.56 kbit/s &ndash; can be copied to a different location and played back stand-alone as a lossy compressed file.  The same will happen if the .wvc file is deleted or not found (it has to be same path/filename except with the ".wvc" suffix in place of ".wv") &ndash; or equivalently, if the <tt>-c</tt> is omitted during encoding, then no correction file will be created in the first place. For example:
For example, <code>wavpack -b12.5 filename</code> will create filename.wv of bit rate 12.5 bits per sample. 
<tt>wavpack -b13.5 -hx filename</tt> will create a ''lossy'' filename.wv compressed with the <tt>-hx</tt> option, size constrained to 13.5 bits per sample. (Should 13.5 bits be sufficient for lossless encoding, WavPack will tell you at the end of the encoding process &ndash; but that information is not stored in the file.)
For an example that creates filename.wv at at most 234.56 kilobits per second and a correction file filename.wvc, the following commands will work:
* In all versions, <code>wavpack -b234.56 -c filename</code>. Or equivalently <code>wavpack -cb234.56 filename</code>
* From 5.70, also <code>wavpack -c234.56 filename</code> will do the same. Thus, a user can avoid the "<code>b</code>" altogether, eliminating the risk of loss from forgetting the "<code>c</code>".  
More options can be added, like <code>wavpack -cb234.56 -mhx filename</code> to compress in high mode with extra processing and stores the (''original'' PCM's) MD5 sum. 
When filename.wv and filename.wvc are both present, the original file will be restored completely by decoding the usual way by <code>wvunpack filename</code> (or <code>wvunpack filename.wv</code>, but not <code>wvunpack filename.wvc</code>).  Playback of the .wv+.wvc is also lossless provided the player application supports correction files (like foobar2000, but few do).
<code>filename.wv</code> can be copied to a different location without compression file and played in the same way as if it was encoded as lossy in the first place; the decoder will only look in the same path and for same file name except with .wvc extension.  


WavPack will refuse to recompress lossy-generated .wv to "lossless .wv" as that would make a false pretense of being a lossless file.  It will also refuse so even in the presence of .wvc; you will have to wvunpack it and and then wavpack it again.  
If a high enough lossy quality is specified, it is possible that the file can losslessly contain the entire signal.  If so, WavPack will report at the end of the encoding process &ndash; but that information is not stored in the file.  It can be inferred later from the small .wvc file, and if that is lost: if <code>-m</code> was used upon encoding.
WavPack will refuse to recompress lossy-generated .wv to "lossless .wv" as that would make a false pretense of being a lossless file.  (That goes even in the "that information is not stored in the file" case just mentioned.)  If a lossless hybrid with correction file is recompressed, the default is to create a single-file lossless .wv; from 5.7.0, the old .wvc file will then be removed (as it does no longer belong to any .wv file), but earlier version would need to use the delete switch.
 
Advanced use: The encoder has several options to tune lossy quality through e.g. noise shaping.  


=== Decoding options ===
=== Decoding options ===
In addition to the basic usage above (drag and drop or <tt>wvunpack filename.wv</tt>), the wvunpack executable offers several options.  For use with the Windows front-end or drag and drop, the Windows-only <tt>--pause</tt> (waits for keypress at the end, like for wavpack.exe) is essential to read the output report.  Also Windows-only options like <tt>--drop</tt> and <tt>-l</tt> work as for wavpack.exe, and so do <tt>-d</tt> (use with caution!) and <tt>-y</tt> (ditto!) as well as <tt>-t</tt>.
In addition to the basic usage above (drag and drop or <code>wvunpack filename.wv</code>), the wvunpack executable offers several options.  For use with the Windows front-end or drag and drop, the Windows-only <code>--pause</code> (waits for keypress at the end, like for wavpack.exe) is essential to read the output report.  Also Windows-only options like <code>--drop</code> and <code>-l</code> work as for wavpack.exe, and so do <code>-d</code> (use with caution!) and <code>-y</code> (ditto!) as well as <code>-t</code>.


* Output ''filename'' can be set with <tt>wvunpack infilename.wv -o outfilename </tt> (the <tt>-o</tt> being superfluous on Windows, where &ndash; in the absence of <tt>--drop</tt> &ndash; the second filename will be taken ).  Then wvunpack will affix the file extension of the original file (say, outfilename.wav if the wavpacked file was somefilename.wav).  Specifying a full file name with extension will override the ''name'' but not the ''type'': to do that, output must be forced explicitly.  
* Output ''filename'' can be set with <code>wvunpack infilename.wv -o outfilename </code> (the <code>-o</code> being superfluous on Windows, where &ndash; in the absence of <code>--drop</code> &ndash; the second filename will be assumed to be output name).  Then wvunpack will affix the file extension of the original file (say, outfilename.wav if the wavpacked file was somefilename.wav).  The wavpack encoder detects the file type from content, and so wvunpack will not "fix misleading extensions" automatically; the user can provide a giving full output filename with extension, but note that this will override the ''name'' only but not the ''type''.  To make sure that -o out.aif indeed produces an AIFF, separate switches have to be employed.  
* To force output ''file format,'' one needs to apply options to wvunpack.  The following are for PCM output: <tt>--raw-pcm</tt>, <tt>--wav</tt>, <tt>--w64</tt>, <tt>--caf-be</tt>, <tt>--caf-le</tt>, and from version 5.6.0 on also <tt>--aif</tt> and <tt>--aif-le</tt>.   
* To force output ''file format,'' one needs to apply options to wvunpack.  The following are for PCM output: <code>--raw-pcm</code>, <code>--wav</code>, <code>--w64</code>, <code>--caf-be</code>, <code>--caf-le</code>, and from version 5.6.0 on also <code>--aif</code> and <code>--aif-le</code>.   
** These will delete non-audio chunks and replace them with a fresh file header: there is no option to "unpack to WAVE and restore the original headers if the original file was WAVE".  <tt>wvunpack --wav</tt> will select RF64 if (and only if) exceeding WAVE's 4 GB limit, and wvunpack will select old AIFF over AIFF-C if the audio data permit it.
** These will delete non-audio chunks and replace them with a fresh file header: there is no option to "unpack to WAVE and restore the original headers if the original file was WAVE".  <code>wvunpack --wav</code> will select RF64 if (and only if) exceeding WAVE's 4 GB limit, and wvunpack will select old AIFF over AIFF-C if the audio data permit it.
** For DSD, those format switches will also force a &ndash; necessarily lossy &ndash; conversion to PCM.  To switch losslessly ''between'' DSD formats, there are also <tt>--dsf</tt> and <tt>--dff</tt> (the latter being synonymous to <tt>--dsdiff</tt>) which again delete non-audio chunks.  Note that WavPack cannot force any (also necessarily lossy) conversion ''to'' DSD, having no DSD encoder.
** For DSD, those format switches will also force a &ndash; necessarily lossy &ndash; conversion to PCM.  To switch losslessly ''between'' DSD formats, there are also <code>--dsf</code> and <code>--dff</code> (the latter being synonymous to <code>--dsdiff</code>) which again delete non-audio chunks.  Note that WavPack cannot force any (also necessarily lossy) conversion ''to'' DSD, having no DSD encoder.
** <tt>--raw</tt> outputs both PCM and DSD as headerless streams (lossless for both; <tt>-r</tt> is synonymous; beware that this is not precisely the same as the same letter switch upon encoding).
** <code>--raw</code> outputs both PCM and DSD as headerless streams (lossless for both; <code>-r</code> is synonymous; beware that this is not precisely the same as the same letter switch upon encoding).


In addition to decimating DSD for conversion to PCM, there are other options where power users can utilize certain ''lossy'' operations by wvunpack, e.g. normalizing floating-point files (recommended before conversion to integer), dropping correction files from hybrid encodes &ndash; and <tt>--skip</tt> and/or <tt>--until</tt> to decode only a segment of the file.  See the documentation.  <br/>
In addition to decimating DSD for conversion to PCM, there are other options where power users can utilize certain ''lossy'' operations by wvunpack, e.g. normalizing floating-point files (recommended before conversion to integer), dropping correction files from hybrid encodes &ndash; and <code>--skip</code> and/or <code>--until</code> to decode only a segment of the file.  See the documentation.   
Other options include <tt>-b</tt> to "blindly" decode until end disregarding errors and corruption (potentially useful to save as much as possible from a destroyed file).
Other options include <code>-b</code> to "blindly" decode until end disregarding errors and corruption (potentially useful to save as much as possible from a destroyed file).


wvunpack is also the utility to display information from .wv files even when it does not involve decoding, see the next section. Inter alia, <tt> -s</tt> can be used to find the input file type in case the output extension is misleading (like a .wav extension disguising an AIFF file).  
<code>wvunpack -m</code> will decode with MD5 sum calculation.  If the .wv file had an MD5 sum stored, it will also be displayed for comparison. However, <code>-m</code> will not give an error if they don't match (and if the .wv is lossy without correction file, they won't: the MD5 stored is that of the original).  


=== Other file handling: verification / error checking, and other file info (incomplete) ===
wvunpack is also the utility to display information from .wv files even when it does not involve decoding or file output, see the [[#Other file handling]] subsection.  Inter alia, <code> -s</code> will correctly report the input file ''type'' even if it had a misleading extension (like a .wav extension disguising an AIFF file).
wvunpack can get information about WavPack files without decoding to file:  
 
* <tt>-vv</tt>: Quick verify without decoding (WavPack 5 files only; from 5.5.0 there is also a more verbose <tt>-vvv</tt>).  Quick verify seems to be unavailable outside the official wvunpack; other applications which verify will fall back to the next item, <tt>-v</tt>.  
== <span id="Other file handling"></span>Other file handling (incomplete) ==
* <tt>-v</tt>: Verify (will do a decode to check that everything is OK &ndash; but not write any file).  
The WavPack distribution includes wvunpack, wvtag and wvgain. 
* <tt>-s</tt>/<tt>-ss</tt>: <tt>-s</tt> displays summary of the file, <tt>-ss</tt> a long summary including tags. Also there is <tt>-f</tt> for parseable output, see documentation.
 
* <tt>-n</tt> is the generic "do not decode" for use e.g. to extract tags (which can also be accomplished with the <tt>wvtag</tt> utility, but wvunpack will do if one does not want to write tags):
=== File information with wvunpack (without decoding to file) ===  
* <tt>-x</tt> FIELD: Shows tag, e.g. <tt> -x comment </tt> shows the <comment> field.  <tt>-c</tt> is synonymous to <tt> -x cuesheet</tt>.  Also <tt> wvtag -x </tt> resp. <tt> wvtag -c </tt> do the same thing.  <tt>-xx</tt> (same option for wvtag) can output to file, see documentation.
wvunpack can get information about WavPack files without outputting any uncompressed audio file:
* <code>-vv</code>: Quick verify without decoding (WavPack 5 files only; from 5.5.0 there is also a more verbose <code>-vvv</code>).  Quick verify seems to be unavailable outside the official wvunpack; other applications which verify will fall back to the next item, <code>-v</code>.  
* <code>-vm</code>: Decode and verify, but not write output file.  The "m" will compute the the MD5 sum of the decoded PCM and output it along with the .wv file's stored MD5, if such was present.  Note that the user has to check manually that they match.  A user who never uses <code>-m</code> upon encoding can safely drop the <code>-m</code> from wvunpack too.  Note that absent the "v", <code>wvunpack -m</code> will write output file &ndash; and that <code>wvunpack -mvv</code> is not allowed, as MD5 calculation requires decoding.
* <code>-s</code>/<code>-ss</code>: <code>-s</code> displays summary of the file, <code>-ss</code> a long summary including tags. Also there is <code>-f</code> for parseable output, see documentation.
* <code>-x</code> FIELD: Shows tag, e.g. <code> -x comment </code> shows the <comment> field.  <code>-c</code> is synonymous to <code> -x cuesheet</code>.  Also <code> wvtag -x </code> resp. <code> wvtag -c </code> do the same thing.  <code>-xx</code> (same option for wvtag) can output to file (use <code>-n</code> to avoid decoding) &ndash; see documentation.


=== (To fill in:) Tagging (wvtag) and replaygain management (wvgain) ===
=== (To fill in:) Tagging (wvtag) and replaygain management (wvgain) ===
(... most of these options are available in HA's fave taggers/player?)
(... most of these options are available in HA's fave taggers/player? Except the following, maybe?)  
<code>wvtag --import-id3 wavpackfile.wv</code> will read and "import" ID3 tag stored in wavpackfile.wv's non-audio chunks; this will overwrite existing APEv2. Can also be used with <code>--allow-huge-tags</code>
 
== File formats, versions, decoding and transcoding support ==
Even if WavPack has expanded its feature set over the years, it has gone to lengths to maintain compatibility.  Old WavPack 4.x decoders can restore WavPack 5 files to several file types it cannot encode, but not DSD. 
The TL;DR is that unless one has an ancient portable device or even more ancient files, one will do just fine with the most recent WavPack, and if not then WavPack 4.80 will suffice &ndash; it is still available and can convert ancient WavPack version 3 files. 
Over the years, one might have encountered WavPack files in (at least) the following variants:
 
* .wv (current!) is the file extension used for file formats 4 and 5. Can in most cases be decoded by "anything" (even if the source was e.g. AIFF, which old WavPack cannot read but still restore).  Exceptions:
** WavPack 4 cannot play or restore compressed DSD files (that is new to WavPack 5).  Although FFmpeg's wavpack implementation is version 4-based, DSD and DSD-in-WavPack can still be ''played'' with an FFmpeg-based player. (But not restored, as FFmpeg has no DSD pipeline, so this is for playback or lossy conversion.)
** FFmpeg creates non-compliant files for 17 channels and up.  WavPack 5.7.0 can decode and repair (FFmpeg itself cannot!)
** Mono signals encoded to WavPack 5 might require WavPack version 4.3 (from 2005) or later to play.  It is doubtful that there are hardware players around using older WavPack; should incompatibilities occur, the easiest is likely then to recompress using 4.80.
** To older WavPack versions than 5.7.0, encodes with the new <code>--optimize-int32</code> will be viewed as "lossy without correction file".  They are safe to play (and will apparently only introduce loss from the 24th bit, -138 dB down), but only 5.7.0 can see the lossless version and restore the file completely.
* .wvc, correction files when hybrid lossless encoding is chosen.  Honoured by official WavPack, but users might note that wvpack/wvunpack should be fed the .wv file and will err out if pointed at merely the .wvc file.
* .exe (deprecated): WavPack 4 could compress to Windows self-extracting file (like OptimFROG also offers).  This feature is discontinued in WavPack 5.  Newer versions of the decoder can still play and decode them &ndash; indeed, merely renaming them from .exe to .wv will make them play in players that use the official WavPack library (e.g. foobar2000 will, but VLC will not), and they can be tagged.
** How to recompress with tag transfer: Rename to .wv and run the recompression.
** Similar goes for the 3rd party hack ".iso.wv" which could also be mentioned, and also if a .wv file is stored (uncompressed!) in a .zip container renamed .zip.wv: like for self-extracting files, the official decoder might look further into a file to find WavPack headers, and could find them if the .wv file is put first in an uncompressed container.  Circa 2010 some developer would use the .iso format to contain single WavPack file, and then auxiliary files like rip logs and artwork; renaming it from .iso to .iso.wv would player applications actually play it. Due to efforts from a few enthusiasts when this hack was introduced, iso.wv is mentioned in several players' official and unofficial feature lists, including Wikipedia pages.  These files can be recompressed like the self-extracting files can &ndash; this will however discard ''everything else'' than the WavPack file.
* .wav (pre-2004, long deprecated).  WavPack 3 and below used the .wav extension, which explains the error message "this legacy WavPack file is deprecated, use version 4.80.0 to transcode" if a user tries to wv''un''pack a WAVE file.




= Using WavPack with 3rd party tools (FFmpeg & more) =
= Using WavPack with 3rd party tools (FFmpeg & more) =


Some applications may behave slightly surprising.  FFmpeg has its own WavPack implementation and has a few known peculiarities, some which are expected to be fixed and others of unknown status.  As referenced above Android users may need to use the player application's folder to get WavPack files recognized.  The tl;dr are that as long as it plays, it plays &ndash; but to failsafe against loss of information (e.g. upon conversion), use the official tools.  
Some applications may behave slightly surprising.  FFmpeg has its own WavPack implementation and has a few known peculiarities, some which are expected to be fixed and others of unknown status.  Android users may need to use the player application's folder to get WavPack files recognized.  The tl;dr are that as long as it plays, it plays &ndash; but to safeguard against loss of information (e.g. upon conversion), use the official tools. In particular, hybrid lossless correction files are usually not honoured by 3rd party tools. (A player that ''does'', foobar2000, uses the official WavPack libraries.)


== Splitting WavPack files by cuesheet ==
== Splitting WavPack files by cuesheet ==
WavPack is a format with good support for storing an album as one .wv file with embedded cuesheets, but splitting into tracks by way of cuesheets is not straightforward without external tools. Audio players like [[foobar2000]] which support cue sheets can also split upon conversion.  Other external applications that will do this splitting &ndash; also with more variations of the cue sheet format(s) supported &ndash; include
WavPack is a format with good support for storing an album as one .wv file with embedded (or external) cuesheets, but splitting into tracks by way of cuesheets is not straightforward without external tools. Audio players like [[foobar2000]] which support cue sheets can also split upon conversion.  Other external applications that will do this splitting &ndash; also with more variations of the cue sheet format(s) supported &ndash; include
* [[CUETools]] can if it is CDDA (44.1 kHz 16-bit stereo), and can re-encode back to WavPack.   
* [[CUETools]] can if it is CDDA (44.1 kHz 16-bit stereo), and can re-encode back to WavPack.   
* refalac can decode & split by cuesheets with the appropriate (official) WavPack library DLL file<ref>[https://github.com/nu774/qaac/wiki/refalac-usage refalac usage] includes how to split by cuesheet</ref>, outputting WAVE or ALAC-in-MP4.
* refalac can decode & split by cuesheets with the appropriate (official) WavPack library DLL file<ref>[https://github.com/nu774/qaac/wiki/refalac-usage refalac usage] includes how to split by cuesheet</ref>, outputting WAVE or ALAC-in-MP4.
Both refalac, CUETools and foobar2000 use the official WavPack tools to for the decoding(/encoding).  
Both refalac, CUETools and foobar2000 use the official WavPack tools for the decoding(/encoding).  
 
== <span id="FFmpeg's WavPack implementation"></span>FFmpeg's WavPack implementation: differences and quirks ==
FFmpeg can encode/decode to/from WavPack &ndash; which may be seen as attractive from how it also can transfer metadata in one go &ndash; but with some limitations and maybe unfamiliar behaviour.  <br/> FFmpeg has had some bugs which may cause audio corruption.  Although some fixes were applied with FFmpeg release 6.1, users might beware that players and converters that employ FFmpeg as a decoding engine may or may not update that quickly.
* [Still not fixed as of ffmpeg 6.1] Encoding, multi-channel only: Above 16 channels, when the WavPack 5 format is required, FFmpeg will still attempt encoding to WavPack version 4, but will produce non-compliant files &ndash; that ffmpeg itself might not be able to read.<br/>Official WavPack 5.7.0 can repair those files, at least the "known" defects.
* [Fixed in ffmpeg 6.1] Encoding, 8-bit PCM only: FFmpeg (up to 6.0) will produce broken files with static noise.  No known attempt at recovering them.
* [Fixed in ffmpeg 6.1] Decoding, any format but rare: A bug FFmpeg's WavPack decoder, discovered in August 2022<ref>[https://hydrogenaud.io/index.php/topic,122810 HA forum thread on the ffmpeg bug in .wv decoding]</ref>, will cause dropouts in certain files. The bug is ''"rare"'' in that no such file was discovered in several years. 


== FFmpeg's WavPack implementation: differences and quirks ==
Further limitations in FFmpeg's implementation:
FFmpeg can encode/decode to/from WavPack &ndash; which may be seen as attractive from how it also can transfer metadata in one go &ndash; but with some limitations and maybe unfamiliar behaviourCompression settings are different: the default is fast but not particularly good compression<ref>[https://hydrogenaud.io/index.php?topic=118278.msg976262#msg976262  HA forum comment comparing the compression presets]</ref> &ndash; while on the other end, FFmpeg offers even slower modes than <tt>-hhx6</tt>.
* No MD5 sum and no verification &ndash; although it is possible for power users to set up a command-line to compute audio-only checksums of input, decode output to checksum and compare.  FFmpeg will also only write WavPack 4 files, hence no ''fast verification'' of the bitstream.  (FFmpeg can however decode WavPack 5 files, including converting DSD files to PCM.)
* As a general rule &ndash; not specific to .wv &ndash; FFmpeg will ''not'' honour the input bit depth: for example when outputting WAVE/AIFF, it will default to 16 bits regardless of input bit depthThis default behaviour is not lossless when input bit depth is > 16 bits, and could even induce clipping (with no warning!) if the source is a 32-bit float.  To force lossless decoding of 24-bit/32-bit files (WavPack/FLAC/ALAC/TAK/uncompressed) to WAVE/AIFF, the user must extract the bit depth information and specify the respective 24-bit/32-bit output format using ffmpeg's command-line syntax. <br/> <br/>For an extreme example: <code>FFmpeg -i DSDfile.dsf outfile.wv</code> will not store the DSD &ndash; rather it will convert to floating-point PCM which is then compressed, typically making for several times the file size, with no warning that it is lossy.<br/>
The tl;dr for users who do not have this at their fingertips, is to use other (= official!) decoders when losslessness is desired.
* Correction files ignored, leading to lossy playback/conversion of hybrid-encoded WavPack files with when ffmpeg or ffmpeg-based players are used.
* Loss of information that is not directly audio-related: FFmpeg has no ambition of preserving file structure and (R)IFF chunks, so you will not get the non-audio chunks of the files back when using ffmpeg to encode &ndash; however it ''will'' by default transfer metadata it supports.
* FFmpeg will sometimes &ndash; depending on input format &ndash; output 32-bit WavPack files and lose the information that the source was indeed only 24. Not all players support 32-bit files, and verifying that the operation (or an attempted downconversion to 24) was lossless is not straightforward as even fewer applications are willing to compare a 32-bit and a 24-bit file for differences. <br/>Also for files with bit depth not being 8/16/24/32 is lost; WAVE/AIFF/CAF can handle "17 bit" files by storing 24 and employing a flag to disregard the 7 LSBs, and ffmpeg will lose this flag even when encoding to / decoding from codecs which support it, WavPack and FLAC.  


Some limitations:
FFmpeg's compression settings can be set with <code>-compression_level</code> 0 to 8, which work different than the reference implementation. Like for ALAC compression, FFmpeg has chosen a ''default'' that prioritizes speed over size <ref>[https://hydrogenaud.io/index.php?topic=118278.msg976262#msg976262  HA forum comment comparing the compression presets]</ref> &ndash; while on the other end, FFmpeg's WavPack encoder offers settings even slower than <code>-hhx6</code>. FFmpeg version 7 does some multithreading, although not in the encoding process itself; apparently it offloads the ''input file reading'', improving speed on single-file encoding.
* FFmpeg can decode WavPack 5 files, but will only write WavPack 4 files (hence no ''fast verification''). 
FFmpeg multithreads decoding, and could be fast.
* Above 16 channels, when the WavPack 5 format is required, FFmpeg will still attempt encoding to WavPack but will produce unreadable files. (Unfixed as of October 2022.)
* A rare bug in FFmpeg's WavPack decoder was discovered in August 2022<ref>[https://hydrogenaud.io/index.php/topic,122810 HA forum thread on the ffmpeg bug in .wv decoding]</ref> which will cause dropouts in certain files. (The bug is ''"rare"'' in that no such file was discovered in several years.)  A fix has been coded, and is expected to find its way into official ffmpeg in a few months. However, players and converters that employ ffmpeg as a decoding engine may or may not update that quickly.
* There is potential information loss in using FFmpeg; it will ignore hybrid correction files, so decoding/playing hybrid-encoded WavPack with ffmpeg or ffmpeg-based players will be lossy. Furthermore, ffmpeg will as a general rule ''not'' honour the input bit depth: it will default to 16 bits when outputting WAVE/AIFF, whether or not the input file is 16 bits; this could even induce clipping (with no warning!) if the source is a 32-bit float.  To force lossless decoding of 24-bit/32-bit files (WavPack/FLAC/ALAC/TAK/uncompressed) to WAVE/AIFF, the user must extract the bit depth information and specify the respective 24-bit/32-bit output format using ffmpeg's command-line syntax. The tl;dr for users who do not have this at their fingertips, is to use other (= official!) decoders when losslessness is desired.
* FFmpeg will sometimes &ndash; depending on input format &ndash; output 32-bit WavPack files and lose the information that the source was indeed only 24. Not all players support 32-bit files, and verifying that the operation (or an attempted downconversion to 24) was lossless is not straightforward as even fewer applications are willing to compare a 32-bit and a 24-bit file for differences. Also information that bit depth is not an integer number of bytes, is lost; WAVE/AIFF/CAF can handle "17 bit" files by storing 24 and employing a flag to disregard the 7 LSBs, and ffmpeg will lose this flag even when encoding to / decoding from codecs which support it, WavPack and FLAC.
* Also ffmpeg will discard RIFF chunks and file structure. It has no ambition of preserving file structure &ndash; however it ''will'' by default transfer metadata it supports.  




= Software support (& hardware) =
= Software support (& hardware) =
With Android support and playback through ffmpeg, it might no longer be feasible to maintain a list of applications that can play WavPack files, and the following is  most certainly incomplete &ndash; as is the list at https://www.wavpack.com/#Software .  Also, the distinction between "hardware" and "software" support is not clear in the age of smart devices running Android, and the list at https://www.wavpack.com/#Hardware does not cover those.
The following list is unlikely to be complete, and the same goes for the lists https://www.wavpack.com/#Software and https://www.wavpack.com/#Hardware : In the age of Android-powered devices with ffmpeg-based playback, it is not feasible to list all players which can in one way or another play this or that format, nor to distinguish clearly between hardware players and software players.


== Players ==
== Players ==
Line 184: Line 247:
* [http://aqualung.sourceforge.net/ Aqualung] for GNU/Linux
* [http://aqualung.sourceforge.net/ Aqualung] for GNU/Linux
* Cowon [http://www.jetaudio.com/ JetAudio Player] and CD ripper
* Cowon [http://www.jetaudio.com/ JetAudio Player] and CD ripper
* [http://www.un4seen.com/ XMPlay] Plugin required (WavPack input plugin) and (bass library) to play 'wv' files
* [http://www.un4seen.com/ XMPlay] Plugin required (WavPack input plugin) and (bass library) to play '.wv' files


== Converters, CD rippers etc. ==
== Converters, CD rippers etc. ==
Several of the ''players'', like Cowon JetAudio, foobar2000 and VUplayer, also have converters that can create WavPack files. More:
For conversion (of ''audio'' only), one can use several of the ''players'' listed above, like Cowon JetAudio, foobar2000 and VUplayer &ndash; although some with limitations in the audio pipeline, like for example DSD handling. <br/>
* Custom Windows [http://www.wavpack.com/WavPack_frontend.zip WavPack frontend] (by Speekenbrink)
More software that support conversion to or from WavPack include:
* Custom [http://www.wavpack.com/WavPack_frontend.zip WavPack frontend] (by Speekenbrink) for Windows.
* [http://www.dbpoweramp.com/ dBpowerAMP] Music Converter CD ripper/writer / Audio Player / (official addon)
* [http://www.dbpoweramp.com/ dBpowerAMP] Music Converter CD ripper/writer / Audio Player / (official addon)
* [[fre:ac]] multi-platform CD ripper/converter
* [[fre:ac]] multi-platform CD ripper/converter
Line 211: Line 275:
* [[Audacity]] has WavPack support (using official libraries) from version 3.2.0 (2022)<ref>[https://github.com/audacity/audacity/releases/tag/Audacity-3.2.0 Audacity 3.2.0 release notes]</ref>.
* [[Audacity]] has WavPack support (using official libraries) from version 3.2.0 (2022)<ref>[https://github.com/audacity/audacity/releases/tag/Audacity-3.2.0 Audacity 3.2.0 release notes]</ref>.
* [[Adobe Audition]] and Cool Edit (filter with 32-bit floats & extra info save support)
* [[Adobe Audition]] and Cool Edit (filter with 32-bit floats & extra info save support)
* [https://www.reaper.fm/about.php#technical Reaper] DAW software for Windows / MacOS
* [https://sourceforge.net/projects/sox/ SoX] can read and write WavPack files.  (Write: limited to <code>-hh</code> compression, not file format version 5.)
* [http://www.bunkus.org/videotools/mkvtoolnix/ mkvtoolnix] &ndash; tool to multiplex streams in Matroska container files.
* [http://www.bunkus.org/videotools/mkvtoolnix/ mkvtoolnix] &ndash; tool to multiplex streams in Matroska container files.
''It's worth mentioning the [[Matroska]] guys decided to concentrate on WavPack as the lossless compressor of choice for their container. Quite an honor... :-)''
''It's worth mentioning the [[Matroska]] guys decided to concentrate on WavPack as the lossless compressor of choice for their container. Quite an honor... :-)''
Line 219: Line 285:
* [http://www.wavpack.com/ Official website]
* [http://www.wavpack.com/ Official website]
* [https://github.com/dbry/WavPack Github repository]
* [https://github.com/dbry/WavPack Github repository]
* [http://www.rarewares.org/lossless.html Unofficial compiles] at RareWares, at the moment 5.50 for Windows and 4.32 multiplatform
* [http://www.rarewares.org/lossless.html Unofficial compiles] at RareWares. As of 2023: 5.50 for Windows and 4.32 multiplatform
* [https://en.wikipedia.org/wiki/WavPack WavPack at Wikipedia]
* [https://en.wikipedia.org/wiki/WavPack WavPack at Wikipedia]
* [https://wiki.multimedia.cx/index.php/WavPack WavPack at Multimediawiki] (not updated with version 5)
* [https://wiki.multimedia.cx/index.php/WavPack WavPack at Multimediawiki] (not updated with version 5)
* [[Lossless_comparison| HA Wiki's Lossless Codec Comparison]] originally by [[User:Rjamorim|Rjamorim]]  
* [[Lossless_comparison| HA Wiki's Lossless Codec Comparison]] originally by [[User:Rjamorim|Rjamorim]]  
* An older (2005) performance comparison of lossless audio compressors {{webarchive|https://web.archive.org/web/20151027213336/http://members.home.nl/w.speek/comparison.htm|2015-10-27}} by Speek, using WavPack version 4.0  
* An older (2005) performance comparison of lossless audio compressors {{webarchive|https://web.archive.org/web/20151027213336/http://members.home.nl/w.speek/comparison.htm|2015-10-27}} by Speek, using WavPack version 4.0  
== References ==
<references/>
<references/>



Latest revision as of 15:28, 30 May 2024

WavPack
Official WavPack logo

Hybrid Lossless Audio Compression
Developer(s) David Bryant
Release information
Initial release {{{released}}}
Stable release 5.7.0 (2024-02-29)
Preview release {{{preview_release}}}
Compatibility
Operating system Windows, MacOSX, Linux/BSD/Unix, ...
Additional information
Use Encoder/Decoder
License BSD license
Website http://www.wavpack.com/

WavPack (pronounced "wave-pack") is a lossless audio codec, also offering optionally a hybrid lossless/lossy mode. It is distributed as a free open-source encoder/decoder with a library and a large number of tools, including a Windows GUI and a range of plugins for both audio players and other software. Third party implementations are available, including ffmpeg. WavPack supports and/or can be played back on a large number of platforms/OSes including mobile (Android, iOS), portable (Rockbox) and even web apps.

WavPack is arguably the most feature-rich lossless compressor, supporting a unique range of audio signals including Direct-Stream Digital. Everyday use is supported by a wide range of players and taggers, but conversion is likely safest done with applications that invoke the official tools (rather than e.g. ffmpeg's implementation) – and special features might require the user to apply the WavPack executable directly, for example with drag+drop, see the #Using WavPack section below.

Performance-wise, WavPack defaults to a fast codec – less CPU intensive than ALAC, but typically not as fast as FLAC or TAK, especially in decoding CPU usage.[1] In the age of low-power portable Rockbox-equipped players, WavPack could be seen as a reasonable middle ground between FLAC's low CPU footprint and long battery life, and the smaller files but more CPU-intensive Monkey's Audio[2] – invoking WavPacks high mode and extra compression that would compress to smaller sizes than FLAC.

WavPack has inspired other codecs[3] and their features[4]. For more on WavPack, including on its history and technology, see the Wikipedia entry.


Features

For an end-user considering WavPack as audio format, its feature-richness might be the big selling point. WavPack supports pretty much all the more common features noted at HA Wiki's Lossless Codec Comparison as in the following first list, but several users might consider the more unique features listed under the subsequent headline.

  • Seekable and streaming playback.
  • Error handling: upon playback, it will detect and report corrupted frames, mute to protect against static/noise output, and continue playback. Since version 5, WavPack can also check for corruption without decoding, hence quicker than any decoding format. Optional MD5 audio checksum can also be added upon encoding for file fingerprinting.
  • High-resolution audio support (see next headline).
  • Multichannel support: currently capped at 256 channels, supports WAVEFORMATEXTENSIBLE channel masks.
  • Piping support for encoding, and support for RAW PCM input/output.
  • Non-audio chunks (RIFF and similar) stored; by default, WavPack will not only encode/decode the audio losslessly, but store the non-audio chunks and restore them into a file bit-identical to the original.
  • Tagging: APEv2. (ID3v1 is possible, but not advisable.)
  • Cuesheet support. In practice, some applications handle embedded cuesheets better in WavPack than in some other formats.
  • Unicode support.
  • Can be used in the Matroska container.
  • Windows GUI available.
  • Multithreading (from version 5.7.0).

WavPack also handles bit depths not divisible by 8, e.g. 20-bit audio (found on some DVDs).

Special/unique features

Most of these features are shared with only a few if any notable codecs, or extend to signal types or file types others do not support (comparisons given).

  • DSD support: can losslessly compress Philips DSDIFF and Sony DSF files (see "Using WavPack" below; no other end-user codec compresses DSD.) ID3v2.3/2.4 tags can be imported. wvunpack can select between DSDIFF and DSF out (i.e. 'convert between the two'). wvunpack can also convert DSD to PCM, but not the other way around. (Lossy, as conversion between PCM and DSD necessarily is.)
  • High-resolution support for bit depth 1-bit to 32-bit integer and sampling rates up to gigaherz range radio frequencies, in integer steps. (2 GHz works although only 1 GHz is officially supported; for more UHF, Monkey's Audio, OptimFROG and MPEG-4 ALS support the entire WAVE range up to 4 GiHz.) Can also compress non-integer sampling rates in AIFF/AIFC/CAF (signals the WAVE format cannot contain).
  • 32-bit floating-point supported – also including CoolEdit/Adobe Audition's own float format (use the -a option only if the .wav was generated by CoolEdit/Audition). (This line like OptimFROG.)
  • As much as 256 channels currently supported (from version 5.5.0 on; can be extended to the thousands – more than any codec except MPEG-4 ALS (which is capped at 66536).)
  • Hybrid lossy/lossless mode (can also be used as lossy – OptimFROG also has such a mode.)
  • For LPCM it can read and output to WAVE (including the RF64 format extension used for large files and from 5.70 also BW64), to Sony's Wave64, AIFF/AIFC (both endiannesses) and CAF (ditto) – with full restore of also non-audio parts to bit-by-bit the original file in the original format. (Monkey's/OptimFROG/TAK do the same to the input formats they support.) Also WavPack can handle too large noncompliant "WAVE" files (by default, those will be restored to bit-identical the same as the flawed input file – optionally one can force output to compliant RF64/W64 files).
  • Recompression: Can recompress .wv files in place, with tag transfer. (Like FLAC on .flac files.)
  • Drag and drop support: Dropping a file on to wavpack.exe/wvunpack.exe will encode/decode it to source directory. (Similar to FLAC.) From 5.5.0, one can also apply options to drag and drop by renaming the executable, and drop several files.

Like FLAC/TAK/OptimFROG, WavPack employs a "wasted bits" strategy to handle cases of n "actual bits of signal" zero-padded and stored as N bits; such signals can be found in certain DVDs, but also as "fake high resolution" where a 16-bit signal is merely put in a 24-bit file to look impressive. WavPack handles more "fake high resolution" cases than just zero-padding. 5.7.0 introduces an further improvement to capture similar patterns in 32-bit integer files generated by "naively converting from 32-bit float". That particular mode is disabled by default and is arguably best left to power users (invoking it with --optimize-int32) as only 5.7.0 can decode as lossless; to earlier versions and players they will be presented as lossy without correction file (and will indeed be lossy with differences around -138 dB down).

Limitations

The following bullet item list is hardly of interest except for special purposes; WavPack supports nearly every input format that any competing codec handles. One exception is the legacy AU/SND, apparently supported only by Monkey's Audio.

  • DSD: Will reject DST-compressed DSDIFF (which are already compressed heavier than WavPack does) and Wideband Single-bit Data files (apparently, the Tascam and Korg devices which can produce these, can also export to other DSD formats).
    Also, DSD files cannot be encoded as hybrid with correction files.
  • 64-bit float is not supported. (Apparently no other lossless audio compressor can support it either.)
  • wvunpack can force output to a different format than input, and for AIFF/CAF also select endianness, but it cannot force output to different versions of big-endian AIFF (it will avoid AIFC as long as the signal can be fit in the original AIFF container) nor BW64 – nor select between WAVE_FORMAT_PCM and WAVE_FORMAT_EXTENSIBLE. Few other formats do allow for such output selection; reference FLAC can from 1.4.3 offer some wider choices than wvunpack can.
  • Although all non-audio will be stored, --import-id3 can not import every type of ID3 tag to APEv2. (5.70 imports more tag types than previous versions, yet some users might want use use e.g. Mp3tag to copy over more tags from the original.) Also, unless --allow-huge-tags is specified, size is limited to 1 MB; older software might not read larger tagsets (but no known playback incompatibilities are known).
  • Some file formats have features stored in file headers (like loop points, or for AIFF possibly non-integer sampling rates) which will not be visible to the end-user when trying to play back the .wv file in a typical player. They are nevertheless available to certain audio editing software plugins, and will in any case be restored upon decoding.
  • Some features are unsupported by several applications: in particular, support for correction files is only found in a few players.
  • The most significant third-party implementation (ffmpeg as of version 7.0) has bugs waiting to be fixed.

As of 5.5.0 and above, MacOS versions must be built with e.g. HomeBrew, and Windows XP is only supported through a special executable (available in version 5.6.0 at wavpack.com, upgrade from previous unofficial build posted at HA is strongly advised). WavPack version 5 discontinues some features, but version 4.80 is still available to convert any version 3.x files that might still exist.

WavPack has traditionally had less hardware support than FLAC (Rockbox having been the most notable platform, others listed at https://www.wavpack.com/index.html#Hardware ), but with WavPack playback through Android and iOS players, the distinction between "hardware" and "software" is arguably blurred. The Android OS does not natively support other lossless audio formats than WAVE and FLAC, so there have been issues getting certain Android solutions to recognize other media files including WavPack.[5]

Information for users of other codecs (and older WavPack)

Parts of this section will be less relevant to users who primarily decode and convert through player software, rather than directly invoking the executables. WavPack is the only "major" lossless encoder with separate executables for encoding (wavpack) and decoding/info (wvunpack).

Even for features that are comparable between codecs, they may behave different – or default to different behaviour – out of the purpose they were designed to address, their development, or other design choices.

  • WavPack is designed as a file compressor for audio files – this like Monkey's, TAK and OptimFROG, but in contrast to FLAC and ALAC which are audio compressors. The difference is in the ambition to store all non-audio information (and in the correct order). Using reference FLAC one might "opt in" on non-audio parts by giving options; using WavPack one can "opt out" and discard this information.
    • Note: This difference is irrelevant for CD ripping. Contrary to a common misconception, CD audio is not stored as WAVE – nor in any sort of file. Thus, using a file compressor gives no more "true" copy of a CD. (WavPack's support for embedded cuesheets might – depending on player application – give a better user experience for those who prefer to store one file per CD, but that is not due to how CDs work.)
  • MD5 is opt-in (the -m switch) – even if verification is requested and the MD5 is calculated, it is only written to file if specifically requested. TAK and OptimFROG work similarly in that they also require the user to opt-in on MD5. FLAC, ALAC and Monkey's all work different: FLAC includes MD5 (though some encoders make exceptions under some circumstance), ALAC has nothing such – and Monkey's MD5s are not comparable with others, as it hashes the encoded bitstream.
    • Also, WavPack computes MD5 using the source's endianness (endianness is like the distinction between "4th of July" and "July 4th"), and so MD5s may differ between WAVE source and AIFF/CAF source for the same audio. (At least a recent foobar2000 will handle them without giving false warnings.)
  • Like Monkey's/TAK/OptimFROG – but unlike FLAC and ALAC-in-MP4 – tags are at the end of the file. Consequences for users are that retagging will not trigger full file rewrite, but sometimes applications may spend longer time displaying art and viewing tags.
  • Users of "older WavPack" might take note that version 5 discontinues some features, like -p, and also the -e for self-extracting files – those and other older files can still be converted, but the ancient WavPack 3 with .wav extension requires version 4.80.0 (still available).

Performance – file size, CPU load

Rewind twenty years, to 2004 hardware costs, compression ratios did matter much more – also, several formats would be too heavy to even play on portable devices, and the official WavPack site would warn against the -hh mode for that use even if it were not heavier than the fastest Monkey's Audio mode. Fast forward to now, enthusiasts will still compare performance even if ordinary users may take note that impact on cost is often negligible. Different considerations may apply when a drive is near full. The HA wiki's lossless comparison article compares speed and compression ratio on CDDA on the respective codecs' default setting, taken from van Beurden's comparison studies. The test corpus is chosen to be a "wide" selection, and most music collections are biased in one direction or another genre-wise; users who are concerned about compression might look up the individual sources in the study and/or make a test sample from their own collection. By and large, the following observations can be made:

  • WavPack defaults to a fast codec, between FLAC and Monkey's; is not so heavy on decoding CPU as to cause actual practical problems, although it officially recommends against -hh "for use on vintage portable devices" – it should be fine on anything modern. Even -hh seems to decode lighter than Monkey's fastest mode.
    • The "between FLAC and Monkey's" hold for "default encoding and all decoding". Like most modern codecs, WavPack can be set to exert more encoding effort without affecting decoding load: the -x switch. Thus, decoding for e.g. ReplayGain tagging will be slower than e.g. FLAC in all modes, but faster than Monkey's – and recompressing with a slow -x setting (which can be done in the background) will not make the files any heavier to process later. (Indeed, -x sometimes makes decoding lighter, although unlikely to be noticed except by measuring it.)
    • Playback on Android might be less battery efficient than FLAC, which can take advantage of the OS' native support. The difference is likely small for power-hungry players (like VLC).
    • On the other hand, integrity verification can be done lightening-fast, without decoding (presuming WavPack 5 file format and WavPack 5 decoder).
  • Compressing CDDA: WavPack can compress to slightly smaller files than (reference) FLAC; the difference has diminished with the most recent FLAC releases, but "in return", modern CPU speeds might have made the more expensive WavPack settings more tempting, especially when one can re-encode in the background.
  • Compressing high resolution signals and multi-channel: The "extra" resolution might be a mixed bag of upsampling artefacts, tape hiss, sometimes geniune overtones (and for bat enthusiasts, actual interesting audio). There are different kinds of samples one might call "fake high resolution", and different properties of such – upsampling or bit depth – are handled different by the codecs. WavPack is known to handle some properties exceptionally well ("wasted bits" are exploited also by FLAC and TAK, but WavPack and OptimFROG are capable of detecting more "wasteful" patterns; Monkey's and ALAC cannot exploit wasted bits at all) – and others lesser. Several codecs benefit from spending more effort on high resolution signals, and WavPack users might consider to (re-) compress high resolution and multi-channel with as slow setting as -hx4, presuming it can be done as background recompression where time is not much of an object; decoding load is largely unaffected (sometimes slightly improved) by the high -x.
    • For 32-bit float, there is not much competition, and WavPack might be the natural choice for compatibility; it does outcompress Monkey's recently-added float mode. Those files are not very common in the wild, and users with a sizeable collection of 32-bit files for audio processing will likely choose codec for compatibility with their DAW software. WavPack 5.7.0's special setting for 32-bit integer converted from 32-bit float might be an option in such situations.
  • Users who compare nearly tied compression levels between codecs, should take into account how metadata storage affect total file size. WavPack defaults to storing the source's metadata, which may include big album art; on the other hand, FLAC defaults to leaving some kilobytes padding in the file.


Using WavPack

For everyday use in what other lossless codecs can do, just play it back in a supported player – many of which support tagging, and so do several tagging software. Several of these players can also encode to WavPack, invoking the official tools.

Certain more advanced uses are not accessible through player software – not even if they invoke the official tools – and are best invoked through the WavPack executables directly. For example, you cannot expect non-audio data (for full file restore) to be preserved when encoding/decoding through players, as they usually pass on only the audio; this is not particular to WavPack, but must be expected if you want to store non-audio chunks in other formats that support it. Also, WavPack supports input formats that might exceed the player's internal decoding; e.g. trying to convert DSD with foobar2000 will yield a warning that it will not be lossless (also, converting DSD to PCM leads to files many times the size, being inherently different formats), and the same will 32-bit integer in 32-bit foobar2000 (which uses float internally).

Encoding/decoding by drag and drop (Windows)

The simplest encoding/decoding might be dragging and dropping a (supported) file to wavpack.exe (/wvunpack.exe). Then the file will be encoded/decoded with the default options. Dropping a .wv file onto wavpack.exe will recompress it, prompting before overwrite (again, using default settings – possibly a bad deal if it was encoded with high -x switches). Drag and drop also works on a shortcut to the executable. It is not possible to drop a folder, but from version 5.5.0, there is a way to drag and drop several files.

From version 5.5.0, drag and drop supports options by renaming the wavpack/wvunpack executable. The user can rename a copy of the executable according to preferred settings, which will be applied to the process upon drag and drop. The example given by the developer in in this HA forum post[6] uses encoding options that many WavPack users will recommend (better compression than default, verification and MD5 fingerprinting), and novice users can choose to copy that filename for the executable. For fine-tuning performance or for more specialized tasks, more options are described below.

Basic command line encoding/decoding (for Windows: command-line hints here)

The basic encoding usage is wavpack filename (which creates filename.wv) – this is what drag and drop accomplishes. Wildcards are supported, e.g. wavpack *.wav (but not simply wavpack *). For a single input file, one can specify output like e.g. wavpack infilename.wav -o outfilename.wv (on Windows, the -o can be omitted). Input file extension ".wav" can be dropped, and output ".wv" extension as well – but wavpack foo will only find foo.wav, not e.g. foo.w64 – and not a "foo" with no file extension. (Power users may take note that for --raw-pcm input, the encoder will not look for foo.wav but rather for foo.raw.)

The basic decoding usage – as will be accomplished by drag and drop – is wvunpack filename.wv. By default, wvunpack will restore the exact same file (metadata and file structure and all; it will know the original file name extension but not the rest of the file name – timestamp can be stored by using -t.) If only audio was encoded (conversion from a player would usually work this way), output defaults to filename.wav. Output filename can be specified, and just like for the wavpack encoder, file extensions can be dropped; e.g., wvunpack foo -o bar (or on Windows, dropping the -o) will decode foo.wv to bar.<original file's extension>. This is arguably advisable: wvunpack will not override output format by setting file extension. E.g. if the input was a CAF file, wvunpack foo -o bar.w64 is still a CAF file, and the user has only managed to mislead themselves. To force output format, see the #Decoding options paragraph.

Several input files

To give several filenames as input to wavpack/wvunpack, other than through wildcards, there are (for historical reasons) slight differences between the Windows version and the *n*xes: Windows (requires WavPack 5.5.0): use the --drop option as in the above example given by the developer. It is intended for drag and drop (hence the name of the option) and will write the output to same directory as source. However it can also be used with command-line: wavpack --drop firstfile secondfile will compress firstfile.wav to firstfile.wv and secondfile.wav to secondfile.wv. Note that without the --drop, the command wavpack firstfile secondfile will compress firstfile.wav to secondfile.wv, as -o is optional on Windows – indeed that is why the --drop had to be introduced. An arbitrary number of files can be processed, e.g. wvunpack --drop firstfile secondfile thirdfile fourthfile fifthfile will decode firstfile.wv, ..., fifthfile.wv. For *n*x, one can omit the --drop.

Applying options

For tuning performance or other settings, one might want to apply command-line options. Some external applications can apply options without the user having to type – e.g. encoding with foobar2000, there are two compression sliders, one for the fast-to-extra-high and one for the -x settings (see below) – but for command-line one will have to type them, and also in the Windows GUI. Options can be concatenated for short, like for example writing -hh -x2 -m -v -y as -hhx2mvy.

The user should beware that the wavpack encoder and the wvunpack decoder (and wvtag/wvgain) have to "re-use letters". While some do the same in the wvunpack and wavpack (like -d for delete input file, -y for "yes to all", -t to preserve timestamp, and -l for (Windows only) "run with low priority") and others cover the same purpose in both executables (like -m and -v), the user may be warned that certain letters do not. E.g. -b, -c, -n cover completely urelated functions upon decoding vs upon encoding.

5.7.0 introduces multi-threading options for both encoding and decoding, invoked with --threads=<number 1 to 12>, or simply --threads to let WavPack choose. Multithreading does not reduce overall CPU load, but unless the CPU is already working at max, it will do one or a few files in fewer seconds; thus it is invoked by default for the CoolEdit plugin. For encoding, it leads to slightly different files, with usually very small size impact.

Encoding options (lossless)

Encoding using -hxm seems a sensible trade-off between compression and CPU load. Some selected options are described as follows; for an exhaustive refence, see the manual (online, or included as wavpack_doc.html in the distribution).

  • Compression. WavPack has four compression modes that affect compression as well as encoding and decoding time: fast (-f), default, high (-h) and very high (-hh). The CPU load of -hh is measured to around twice that of -f (and could in the early 2000s be too heavy for portable players, although it does decode faster than any Monkey's). On top these modes, the optional extra processing -x1 to -x6 settings will apply extra compression effort that does not increase decoding CPU load. -x without number is synonymous to -x1, which is often recommended (in all modes, fast/normal/high/extra high). The official manual calls -x4 to -x6 "extremely slow", but the size gains might be significant for high resolution audio in particular (van Beurden's revision 5, testing -x4).
    • 5.5.0 introduces optional switches for the default compression: -g for normal mode and -x0 for "no -x". These are redundant for basic use, but can be used to switch off options already given (e.g. in renamed executables, or custom builds): -x6 -x0 will switch off the extra processing, and -h -f -g will encode as normal, whereas previous versions would abort with an error.
    • With DSD files, there are only two compression settings, normal and high; the option -f will select normal, -h/-hh will both select high, and the -x switches are silently ignored.
  • Guarding against errors upon encoding: The "-m" switch will compute an audio MD5 sum (like FLAC does by default) and store it for later verification. The "-v" switch will verify by decoding the file after it has been written to disk[7]. -vm will do both – that is, calculate the MD5s to verify, and store it. Using the corresponding switches in wvunpack will check without producing output file, however wvunpack also has a faster corruption check for WavPack 5-encoded files: -vv.
  • --import-id3 will import ID3v2.3/2.4 tags present in the source file – typically in Sony DSF files – and convert them to WavPack's preferred APE tags. (Not all tags are supported, but the full tags chunk will be kept for restoring the original file.) By default, importing is limited to 1 MB; for more, use --allow-huge-tags. Same option works in wvtag; indeed, one can encode first and then afterwards "import" the tags from the WavPack file using wvtag --import-id3 wavpackfile.wv; this provided that these data have not been deleted by the following -r option:
  • -r: remove non-audio chunks. By default, WavPack will store these in the .wv file for later bit-by-bit restoration of everything, not only the audio. Use -r to throw them away and encode audio only – like encoding through most players appear to do.
  • -t: copy input file's time stamp. (To restore the file with the original time stamp, use -t both when encoding and when decoding.)
  • --pause: (Windows only!) waits for keypress at the end. Useful for reading output before exit when calling wavpack/wvunpack in a separate window (which both drag-and-drop the Windows front-end do).
  • -y: "yes" to everything. Use with caution, will overwrite. From 5.5.0 there is also a --no-overwrite that will skip instead of asking to overwrite.
  • -d: delete source file upon successful completion. Again, use with caution.
  • -l will force WavPack to run at low priority (Windows only)
  • -c: this is for hybrid lossless, see below.

WavPack can recompress .wv files in place (using a temporary file until done). For example, wavpack -hx4mvy wavpackfile.wv will compress wavpackfile.wv in high mode using -x4 extra processing, writing everything (and an audio MD5 checksum) to a temporary file with tags transferred; close and then re-open the temp file to re-read for verification – and only once verified, replace the old wavpackfile.wv. wavpack -hx4rlmvy wavpackfile.wv will also run with low priority (assuming the Windows platform), and will discard non-audio chunks – that is, the ones used to restore the original file's metadata; the .wv file's APE tags will still be copied. Some operations do require recompression even if the user would not demand it; For example, wavpack cannot add MD5 sum to a .wv file without recompressing it. Also, if the user wants to discard the original file's headers/footers, that can be done upon decompression or recompression – but not by simply removing them from the .wv file. There is no out-of-the-box facility to recompress based on how heavy the original file was compressed, or to keep the smallest file.

(Incomplete:) hybrid lossless & lossy encoding

(Needs to be expanded. Notes: DSD can currently not be hybrid-encoded and floating-point files should not be. The correction file will be omitted by a lot of applications/players, including VLC, mplayer and ffmpeg; thus, using ffmpeg or ffmpeg-based players to convert/play hybrid-encoded WavPack will be lossy. For WavPack in Matroska, there doesn't seem to be any player that will play both the lossy stream and the correction stream, although mkvmerge/mkvextract will import/extract both streams. foobar2000 can play hybrid lossless .wv+.wvc, but will omit a Matroska-encapsulated correction stream.)

Basic use: the -b switch – and for losslessness, use -c to create a correction file. A numerical argument for quality is mandatory: if < 24 it will signify bits per sample and if > 24 it will signify kbit/second. Decimal separator is . even if your locale uses the comma. For example, wavpack -b12.5 filename will create filename.wv of bit rate 12.5 bits per sample. For an example that creates filename.wv at at most 234.56 kilobits per second and a correction file filename.wvc, the following commands will work:

  • In all versions, wavpack -b234.56 -c filename. Or equivalently wavpack -cb234.56 filename
  • From 5.70, also wavpack -c234.56 filename will do the same. Thus, a user can avoid the "b" altogether, eliminating the risk of loss from forgetting the "c".

More options can be added, like wavpack -cb234.56 -mhx filename to compress in high mode with extra processing and stores the (original PCM's) MD5 sum. When filename.wv and filename.wvc are both present, the original file will be restored completely by decoding the usual way by wvunpack filename (or wvunpack filename.wv, but not wvunpack filename.wvc). Playback of the .wv+.wvc is also lossless provided the player application supports correction files (like foobar2000, but few do). filename.wv can be copied to a different location without compression file and played in the same way as if it was encoded as lossy in the first place; the decoder will only look in the same path and for same file name except with .wvc extension.

If a high enough lossy quality is specified, it is possible that the file can losslessly contain the entire signal. If so, WavPack will report at the end of the encoding process – but that information is not stored in the file. It can be inferred later from the small .wvc file, and if that is lost: if -m was used upon encoding. WavPack will refuse to recompress lossy-generated .wv to "lossless .wv" as that would make a false pretense of being a lossless file. (That goes even in the "that information is not stored in the file" case just mentioned.) If a lossless hybrid with correction file is recompressed, the default is to create a single-file lossless .wv; from 5.7.0, the old .wvc file will then be removed (as it does no longer belong to any .wv file), but earlier version would need to use the delete switch.

Advanced use: The encoder has several options to tune lossy quality through e.g. noise shaping.

Decoding options

In addition to the basic usage above (drag and drop or wvunpack filename.wv), the wvunpack executable offers several options. For use with the Windows front-end or drag and drop, the Windows-only --pause (waits for keypress at the end, like for wavpack.exe) is essential to read the output report. Also Windows-only options like --drop and -l work as for wavpack.exe, and so do -d (use with caution!) and -y (ditto!) as well as -t.

  • Output filename can be set with wvunpack infilename.wv -o outfilename (the -o being superfluous on Windows, where – in the absence of --drop – the second filename will be assumed to be output name). Then wvunpack will affix the file extension of the original file (say, outfilename.wav if the wavpacked file was somefilename.wav). The wavpack encoder detects the file type from content, and so wvunpack will not "fix misleading extensions" automatically; the user can provide a giving full output filename with extension, but note that this will override the name only but not the type. To make sure that -o out.aif indeed produces an AIFF, separate switches have to be employed.
  • To force output file format, one needs to apply options to wvunpack. The following are for PCM output: --raw-pcm, --wav, --w64, --caf-be, --caf-le, and from version 5.6.0 on also --aif and --aif-le.
    • These will delete non-audio chunks and replace them with a fresh file header: there is no option to "unpack to WAVE and restore the original headers if the original file was WAVE". wvunpack --wav will select RF64 if (and only if) exceeding WAVE's 4 GB limit, and wvunpack will select old AIFF over AIFF-C if the audio data permit it.
    • For DSD, those format switches will also force a – necessarily lossy – conversion to PCM. To switch losslessly between DSD formats, there are also --dsf and --dff (the latter being synonymous to --dsdiff) which again delete non-audio chunks. Note that WavPack cannot force any (also necessarily lossy) conversion to DSD, having no DSD encoder.
    • --raw outputs both PCM and DSD as headerless streams (lossless for both; -r is synonymous; beware that this is not precisely the same as the same letter switch upon encoding).

In addition to decimating DSD for conversion to PCM, there are other options where power users can utilize certain lossy operations by wvunpack, e.g. normalizing floating-point files (recommended before conversion to integer), dropping correction files from hybrid encodes – and --skip and/or --until to decode only a segment of the file. See the documentation. Other options include -b to "blindly" decode until end disregarding errors and corruption (potentially useful to save as much as possible from a destroyed file).

wvunpack -m will decode with MD5 sum calculation. If the .wv file had an MD5 sum stored, it will also be displayed for comparison. However, -m will not give an error if they don't match (and if the .wv is lossy without correction file, they won't: the MD5 stored is that of the original).

wvunpack is also the utility to display information from .wv files even when it does not involve decoding or file output, see the #Other file handling subsection. Inter alia, -s will correctly report the input file type even if it had a misleading extension (like a .wav extension disguising an AIFF file).

Other file handling (incomplete)

The WavPack distribution includes wvunpack, wvtag and wvgain.

File information with wvunpack (without decoding to file)

wvunpack can get information about WavPack files without outputting any uncompressed audio file:

  • -vv: Quick verify without decoding (WavPack 5 files only; from 5.5.0 there is also a more verbose -vvv). Quick verify seems to be unavailable outside the official wvunpack; other applications which verify will fall back to the next item, -v.
  • -vm: Decode and verify, but not write output file. The "m" will compute the the MD5 sum of the decoded PCM and output it along with the .wv file's stored MD5, if such was present. Note that the user has to check manually that they match. A user who never uses -m upon encoding can safely drop the -m from wvunpack too. Note that absent the "v", wvunpack -m will write output file – and that wvunpack -mvv is not allowed, as MD5 calculation requires decoding.
  • -s/-ss: -s displays summary of the file, -ss a long summary including tags. Also there is -f for parseable output, see documentation.
  • -x FIELD: Shows tag, e.g. -x comment shows the <comment> field. -c is synonymous to -x cuesheet. Also wvtag -x resp. wvtag -c do the same thing. -xx (same option for wvtag) can output to file (use -n to avoid decoding) – see documentation.

(To fill in:) Tagging (wvtag) and replaygain management (wvgain)

(... most of these options are available in HA's fave taggers/player? Except the following, maybe?) wvtag --import-id3 wavpackfile.wv will read and "import" ID3 tag stored in wavpackfile.wv's non-audio chunks; this will overwrite existing APEv2. Can also be used with --allow-huge-tags

File formats, versions, decoding and transcoding support

Even if WavPack has expanded its feature set over the years, it has gone to lengths to maintain compatibility. Old WavPack 4.x decoders can restore WavPack 5 files to several file types it cannot encode, but not DSD. The TL;DR is that unless one has an ancient portable device or even more ancient files, one will do just fine with the most recent WavPack, and if not then WavPack 4.80 will suffice – it is still available and can convert ancient WavPack version 3 files. Over the years, one might have encountered WavPack files in (at least) the following variants:

  • .wv (current!) is the file extension used for file formats 4 and 5. Can in most cases be decoded by "anything" (even if the source was e.g. AIFF, which old WavPack cannot read but still restore). Exceptions:
    • WavPack 4 cannot play or restore compressed DSD files (that is new to WavPack 5). Although FFmpeg's wavpack implementation is version 4-based, DSD and DSD-in-WavPack can still be played with an FFmpeg-based player. (But not restored, as FFmpeg has no DSD pipeline, so this is for playback or lossy conversion.)
    • FFmpeg creates non-compliant files for 17 channels and up. WavPack 5.7.0 can decode and repair (FFmpeg itself cannot!)
    • Mono signals encoded to WavPack 5 might require WavPack version 4.3 (from 2005) or later to play. It is doubtful that there are hardware players around using older WavPack; should incompatibilities occur, the easiest is likely then to recompress using 4.80.
    • To older WavPack versions than 5.7.0, encodes with the new --optimize-int32 will be viewed as "lossy without correction file". They are safe to play (and will apparently only introduce loss from the 24th bit, -138 dB down), but only 5.7.0 can see the lossless version and restore the file completely.
  • .wvc, correction files when hybrid lossless encoding is chosen. Honoured by official WavPack, but users might note that wvpack/wvunpack should be fed the .wv file and will err out if pointed at merely the .wvc file.
  • .exe (deprecated): WavPack 4 could compress to Windows self-extracting file (like OptimFROG also offers). This feature is discontinued in WavPack 5. Newer versions of the decoder can still play and decode them – indeed, merely renaming them from .exe to .wv will make them play in players that use the official WavPack library (e.g. foobar2000 will, but VLC will not), and they can be tagged.
    • How to recompress with tag transfer: Rename to .wv and run the recompression.
    • Similar goes for the 3rd party hack ".iso.wv" which could also be mentioned, and also if a .wv file is stored (uncompressed!) in a .zip container renamed .zip.wv: like for self-extracting files, the official decoder might look further into a file to find WavPack headers, and could find them if the .wv file is put first in an uncompressed container. Circa 2010 some developer would use the .iso format to contain single WavPack file, and then auxiliary files like rip logs and artwork; renaming it from .iso to .iso.wv would player applications actually play it. Due to efforts from a few enthusiasts when this hack was introduced, iso.wv is mentioned in several players' official and unofficial feature lists, including Wikipedia pages. These files can be recompressed like the self-extracting files can – this will however discard everything else than the WavPack file.
  • .wav (pre-2004, long deprecated). WavPack 3 and below used the .wav extension, which explains the error message "this legacy WavPack file is deprecated, use version 4.80.0 to transcode" if a user tries to wvunpack a WAVE file.


Using WavPack with 3rd party tools (FFmpeg & more)

Some applications may behave slightly surprising. FFmpeg has its own WavPack implementation and has a few known peculiarities, some which are expected to be fixed and others of unknown status. Android users may need to use the player application's folder to get WavPack files recognized. The tl;dr are that as long as it plays, it plays – but to safeguard against loss of information (e.g. upon conversion), use the official tools. In particular, hybrid lossless correction files are usually not honoured by 3rd party tools. (A player that does, foobar2000, uses the official WavPack libraries.)

Splitting WavPack files by cuesheet

WavPack is a format with good support for storing an album as one .wv file with embedded (or external) cuesheets, but splitting into tracks by way of cuesheets is not straightforward without external tools. Audio players like foobar2000 which support cue sheets can also split upon conversion. Other external applications that will do this splitting – also with more variations of the cue sheet format(s) supported – include

  • CUETools can if it is CDDA (44.1 kHz 16-bit stereo), and can re-encode back to WavPack.
  • refalac can decode & split by cuesheets with the appropriate (official) WavPack library DLL file[8], outputting WAVE or ALAC-in-MP4.

Both refalac, CUETools and foobar2000 use the official WavPack tools for the decoding(/encoding).

FFmpeg's WavPack implementation: differences and quirks

FFmpeg can encode/decode to/from WavPack – which may be seen as attractive from how it also can transfer metadata in one go – but with some limitations and maybe unfamiliar behaviour.
FFmpeg has had some bugs which may cause audio corruption. Although some fixes were applied with FFmpeg release 6.1, users might beware that players and converters that employ FFmpeg as a decoding engine may or may not update that quickly.

  • [Still not fixed as of ffmpeg 6.1] Encoding, multi-channel only: Above 16 channels, when the WavPack 5 format is required, FFmpeg will still attempt encoding to WavPack version 4, but will produce non-compliant files – that ffmpeg itself might not be able to read.
    Official WavPack 5.7.0 can repair those files, at least the "known" defects.
  • [Fixed in ffmpeg 6.1] Encoding, 8-bit PCM only: FFmpeg (up to 6.0) will produce broken files with static noise. No known attempt at recovering them.
  • [Fixed in ffmpeg 6.1] Decoding, any format but rare: A bug FFmpeg's WavPack decoder, discovered in August 2022[9], will cause dropouts in certain files. The bug is "rare" in that no such file was discovered in several years.

Further limitations in FFmpeg's implementation:

  • No MD5 sum and no verification – although it is possible for power users to set up a command-line to compute audio-only checksums of input, decode output to checksum and compare. FFmpeg will also only write WavPack 4 files, hence no fast verification of the bitstream. (FFmpeg can however decode WavPack 5 files, including converting DSD files to PCM.)
  • As a general rule – not specific to .wv – FFmpeg will not honour the input bit depth: for example when outputting WAVE/AIFF, it will default to 16 bits regardless of input bit depth. This default behaviour is not lossless when input bit depth is > 16 bits, and could even induce clipping (with no warning!) if the source is a 32-bit float. To force lossless decoding of 24-bit/32-bit files (WavPack/FLAC/ALAC/TAK/uncompressed) to WAVE/AIFF, the user must extract the bit depth information and specify the respective 24-bit/32-bit output format using ffmpeg's command-line syntax.

    For an extreme example: FFmpeg -i DSDfile.dsf outfile.wv will not store the DSD – rather it will convert to floating-point PCM which is then compressed, typically making for several times the file size, with no warning that it is lossy.

The tl;dr for users who do not have this at their fingertips, is to use other (= official!) decoders when losslessness is desired.

  • Correction files ignored, leading to lossy playback/conversion of hybrid-encoded WavPack files with when ffmpeg or ffmpeg-based players are used.
  • Loss of information that is not directly audio-related: FFmpeg has no ambition of preserving file structure and (R)IFF chunks, so you will not get the non-audio chunks of the files back when using ffmpeg to encode – however it will by default transfer metadata it supports.
  • FFmpeg will sometimes – depending on input format – output 32-bit WavPack files and lose the information that the source was indeed only 24. Not all players support 32-bit files, and verifying that the operation (or an attempted downconversion to 24) was lossless is not straightforward as even fewer applications are willing to compare a 32-bit and a 24-bit file for differences.
    Also for files with bit depth not being 8/16/24/32 is lost; WAVE/AIFF/CAF can handle "17 bit" files by storing 24 and employing a flag to disregard the 7 LSBs, and ffmpeg will lose this flag even when encoding to / decoding from codecs which support it, WavPack and FLAC.

FFmpeg's compression settings can be set with -compression_level 0 to 8, which work different than the reference implementation. Like for ALAC compression, FFmpeg has chosen a default that prioritizes speed over size [10] – while on the other end, FFmpeg's WavPack encoder offers settings even slower than -hhx6. FFmpeg version 7 does some multithreading, although not in the encoding process itself; apparently it offloads the input file reading, improving speed on single-file encoding. FFmpeg multithreads decoding, and could be fast.


Software support (& hardware)

The following list is unlikely to be complete, and the same goes for the lists https://www.wavpack.com/#Software and https://www.wavpack.com/#Hardware : In the age of Android-powered devices with ffmpeg-based playback, it is not feasible to list all players which can in one way or another play this or that format, nor to distinguish clearly between hardware players and software players.

Players

  • foobar2000 advanced freeware audio player plays/decodes WavPack out of the box on both Windows, MacOS, Android and iOS (Windows: supports encoding if wavpack.exe is installed, and redistributes the official wavpack.exe through its "Free encoder pack" addon for encoding. With ReplayGain & cuesheets support.) Also Boom from the same author.
  • VLC multiplatform media player
  • VUPlayer (official plugin, supports encoding)
  • NullSoft Winamp (plugin with ReplayGain & Media Library support) and Winamp-compatible players
  • Windows Media Player and other directshow-based players (MPC, TCMP, RadLight) (with CoreWavPack directshow filter)
  • Cog Audio player for MacOS X.
  • JRiver Media Center
  • XMMS (with Kuniklo's plugin)
  • LAMIP (official plugin)
  • MPXplay for DOS!
  • Aqualung for GNU/Linux
  • Cowon JetAudio Player and CD ripper
  • XMPlay Plugin required (WavPack input plugin) and (bass library) to play '.wv' files

Converters, CD rippers etc.

For conversion (of audio only), one can use several of the players listed above, like Cowon JetAudio, foobar2000 and VUplayer – although some with limitations in the audio pipeline, like for example DSD handling.
More software that support conversion to or from WavPack include:

Taggers and audio info utilities

Audio editors and other tools

  • Audacity has WavPack support (using official libraries) from version 3.2.0 (2022)[12].
  • Adobe Audition and Cool Edit (filter with 32-bit floats & extra info save support)
  • Reaper DAW software for Windows / MacOS
  • SoX can read and write WavPack files. (Write: limited to -hh compression, not file format version 5.)
  • mkvtoolnix – tool to multiplex streams in Matroska container files.

It's worth mentioning the Matroska guys decided to concentrate on WavPack as the lossless compressor of choice for their container. Quite an honor... :-)

  • PKWare's .zip format compresses audio by WavPack since version 6.3.2 (2007). Beware that there is no expectation that other decompression software handles these zip files; even if PKWare co-designed the format and PKZip was the original .zip implementation, their subsequent compression methods are outside the ISO/IEC standardized zip format specification.


Links

References

  1. Martijn van Beurden: Lossless audio codec comparison archive, all comparisons in this wiki article consistent with CDDA results up to revision 6, 2023, using WavPack 5.6.0.
  2. CodecPerformanceComparison at the Rockbox wiki
  3. Monkey's Audio historical FAQ (archived on October 17, 2000)
  4. OptimFROG's "DualStream" hybrid encoding – apparently WavPack coined this phrase
  5. HA thread with link to Android bug report by the Monkey's Audio author
  6. HA forum post on how to rename executable for drag and drop
  7. HA forum comment: verification checks the written file after closing and reopening
  8. refalac usage includes how to split by cuesheet
  9. HA forum thread on the ffmpeg bug in .wv decoding
  10. HA forum comment comparing the compression presets
  11. HA Wiki: Configuring EAC and WavPack
  12. Audacity 3.2.0 release notes