BASS.NET API for the Un4seen BASS Audio LibraryEncoderWavPack ClassBASS.NET API for the Un4seen BASS Audio Library
Encoder class implementation for WavPack encoding using "wavpack.exe".
Inheritance Hierarchy


Namespace: Un4seen.Bass.Misc
Assembly: Bass.Net (in Bass.Net.dll) Version:

public sealed class EncoderWavPack : BaseEncoder

The EncoderWavPack type exposes the following members.


Public methodEncoderWavPack
Creates an instance of a WavPack encoder implementation.

Public propertyChannelBitwidth
This property returns the actual bitwidth of the sample data of the channel (e.g. 8, 16, 32).
(Inherited from BaseEncoder.)
Public propertyChannelHandle
Gets or Sets the channel handle which is used to create the broadcast encoder class.
(Inherited from BaseEncoder.)
Public propertyChannelInfo
Returns the general channel info.
(Inherited from BaseEncoder.)
Public propertyChannelNumChans
This property returns the actual number of channles of the sample data BASS is using with the channel (e.g. 1=mono, 2=stereo, etc.).
(Inherited from BaseEncoder.)
Public propertyChannelSampleRate
This property returns the actual sample rate in Hz of the sample data BASS is using with the channel (e.g. 44100).
(Inherited from BaseEncoder.)
Public propertyDefaultOutputExtension
This return the default extension of an output file for this encoder (".wv").
(Overrides BaseEncoderDefaultOutputExtension.)
Public propertyEffectiveBitrate
Returns the effective encoder bitrate (in kbps) of the output.
(Overrides BaseEncoderEffectiveBitrate.)
Public propertyEncoderCommandLine
Gets the actual encoder command-line string (using all WV_xxx properties).
(Overrides BaseEncoderEncoderCommandLine.)
Public propertyEncoderDirectory
Gets or Sets the encoder's base directory.
(Inherited from BaseEncoder.)
Public propertyEncoderExists
This property return , if the file "wavpack.exe" exists in the EncoderDirectory - else is returned.
(Overrides BaseEncoderEncoderExists.)
Public propertyEncoderHandle
Gets or sets the current HENCODE encoder handle.
(Inherited from BaseEncoder.)
Public propertyEncoderType
Gets a value indicating the type of content. Here BASS_CTYPE_STREAM_WV is always returned.
(Overrides BaseEncoderEncoderType.)
Public propertyForce16Bit
Gets or Sets if a encoding in 16-bit sample data should be forced (default is ).
(Inherited from BaseEncoder.)
Public propertyInputFile
Gets or Sets the input file name to be processed by the encoder (null = STDIN, default).
(Inherited from BaseEncoder.)
Public propertyIsActive
Gets a value indicating if the encoder has been started (see Start(ENCODEPROC, IntPtr, Boolean)) and is active - else will be returned.
(Inherited from BaseEncoder.)
Public propertyIsPaused
Gets a value indicating if the encoder has been paused (see Pause(Boolean)) - else must be returned.
(Inherited from BaseEncoder.)
Public propertyNoLimit
Gets or Sets if encoding should use the CAST_NOLIMIT flag (which is only needed, if the encoder is used for streaming).
(Inherited from BaseEncoder.)
Public propertyOutputFile
Gets or Sets the output file name to be processed by the encoder (null = STDOUT, default).
(Inherited from BaseEncoder.)
Public propertySupportsSTDOUT
WavPack does implement STDOUT, so is always returned.
(Overrides BaseEncoderSupportsSTDOUT.)
Public propertyTAGs
Gets or Sets the TAG_INFO structure associated with the encoder.
(Inherited from BaseEncoder.)
Public propertyUseAsyncQueue
Gets or Sets if encoding should use an async queue (i.e. the BASS_ENCODE_QUEUE flag).
(Inherited from BaseEncoder.)

Public methodDispose
Implement IDisposable.
(Inherited from BaseEncoder.)
Protected methodFinalize
Finalization code.
(Inherited from BaseEncoder.)
Public methodPause
Pauses or resumes an encoder.
(Inherited from BaseEncoder.)
Public methodSettingsString
Returns the string representation of the current encoder settings.
(Overrides BaseEncoderSettingsString.)
Public methodStart
This method starts the actual WavPack encoder. After the encoder was started successfully the EncoderHandle returns a valid HENCODE handle.
(Overrides BaseEncoderStart(ENCODEPROC, IntPtr, Boolean).)
Public methodStop
Stops the encoder (if started).
(Inherited from BaseEncoder.)
Public methodStop(Boolean)
Stops the encoder (if started).
(Inherited from BaseEncoder.)
Public methodToString
Returns the name of the Encoder.
(Overrides ObjectToString.)

Public fieldWV_CalcAvgPeakQuant
-n: Calculate average and peak quantization noise (hybrid only, default is ).
Public fieldWV_ComputeMD5
-m: Compute and store MD5 signature of raw audio data (default is ).
Public fieldWV_CopyTimestamp
-t: Copy input file's time stamp to output file (default is ).
Public fieldWV_CreateCorrectionFile
-c: Create correction file (.wvc) for hybrid mode (=lossless, default is )
Public fieldWV_CustomOptions
The custom parameter string, which should be used, if the WV_UseCustomOptionsOnly property is set to .
Public fieldWV_ExtraProcessing
-x: Extra encode processing (optional n = 1-6 for more/less, 0 = default).
Public fieldWV_FastMode
-f: Fast mode (fast, but some compromise in compression ratio, default is ).
Public fieldWV_HighQuality
-h: High quality (best compression in all modes, but slower, default is ).
Public fieldWV_HybridBitrate
-b: Hybrid compression, 24 - 9600 kbits/second (default is 1024 kbps).
Public fieldWV_IgnoreLength
-i: Ignore length in wav header (no pipe output allowed, default is ).
Public fieldWV_JointStereo
-j0: Joint-stereo override ( = left/right, = mid/side, default is ).
Public fieldWV_LowPriority
-l: Run at low priority (for smoother multitasking, default is ).
Public fieldWV_MaximumHybridCompression
-cc: Maximum hybrid compression (hurts lossy quality and decode speed, default is ).
Public fieldWV_NewRiffHeader
-r: Generate new RIFF wav header (removing extra chunk info, default is ).
Public fieldWV_NoiseShaping
-s: noise shaping override (hybrid only, -1.0 to 1.0, 0.0 = off = default)
Public fieldWV_PracticalFloat
-p = practical float storage (also 32-bit ints, not lossless, default is ).
Public fieldWV_UseCustomOptionsOnly
Use the WV_CustomOptions parameter string only (default=).
Public fieldWV_UseHybrid
Enable hybrid compression? (default is )

This class uses the BASS_CTYPE_STREAM_WV encoder type.

"wavpack.exe" must be downloaded separately (e.g. from or

Make sure to set the WV_xxx flags before retrieving the EncoderCommandLine or calling Start(ENCODEPROC, IntPtr, Boolean).

This implementation uses the automatic DSP system for encoding. Meaning the sending of sample data to the encoder is done automatically when you play the channel (BASS_ChannelPlay(Int32, Boolean)) or call BASS_ChannelGetData(Int32, IntPtr, Int32) (if it's a decoding channel). So there is no need to call BASS_Encode_Write(Int32, IntPtr, Int32) manually!

If you simply want to encode a physical file please also take a look to the EncodeFile(String, String, BaseEncoder, BaseEncoderENCODEFILEPROC, Boolean, Boolean).

See Also