BASS.NET API for the Un4seen BASS Audio LibraryEncoderFLAC ClassBASS.NET API for the Un4seen BASS Audio Library
Encoder class implementation for FLAC encoding using "flac.exe".
Inheritance Hierarchy

SystemObject
  Un4seen.Bass.MiscBaseEncoder
    Un4seen.Bass.MiscEncoderFLAC

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

[SerializableAttribute]
public sealed class EncoderFLAC : BaseEncoder

The EncoderFLAC type exposes the following members.

Constructors

  NameDescription
Public methodEncoderFLAC
Creates an instance of a FLAC encoder implementation.
Top
Properties

  NameDescription
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 (".flac").
(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 FLAC_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 "flac.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_FLAC is returned (or BASS_CTYPE_STREAM_FLAC_OGG if FLAC_UseOgg is set to to ).
(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
FLAC implements 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.)
Top
Methods

  NameDescription
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 FLAC 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.)
Top
Fields

  NameDescription
Public fieldFLAC_Blocksize
-b: Specify the blocksize in samples (the default is 1152 for -l 0, else 4608).
Public fieldFLAC_CompressionLevel
-0..-8: Defines the compression level (default is 5) between 0 (fast) and 8 (best).
Public fieldFLAC_CustomOptions
The custom parameter string, which should be used, if the FLAC_UseCustomOptionsOnly property is set to .
Public fieldFLAC_Lax
--lax: Allow encoder to generate non-Subset files (default is ).
Public fieldFLAC_NoPadding
--no-padding: Suppress writing a PADDING block of 4096 bytes (default is ).
Public fieldFLAC_Padding
-P: Tell the encoder to write a PADDING metadata block of the given length (in bytes) after the STREAMINFO block (default is off).
Public fieldFLAC_ReplayGain
--replay-gain: Calculate ReplayGain values and store in Vorbis comments (default is ).
Public fieldFLAC_UseCustomOptionsOnly
Use the FLAC_CustomOptions parameter string only (default=).
Public fieldFLAC_UseOgg
--ogg: When encoding, generate Ogg FLAC output instead of native FLAC (default is ).
Public fieldFLAC_Verify
-V: Verify a correct encoding by decoding the output in parallel and comparing to the original (default is ).
Top
Remarks

This class uses the BASS_CTYPE_STREAM_FLAC encoder type.

"flac.exe" must be downloaded separately (e.g. from www.rarewares.org). FLAC also needs the "libmmd.dll", which is also available at rarewares.org.

Make sure to set the FLAC_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).

FLAC 'cuesheets' and the 'skip' and 'until' properties are not supported in this implementation by default, but you might add them with the FLAC_CustomOptions parameter.

See Also

Reference