EncoderFLAC Class

[SerializableAttribute]
public sealed class EncoderFLAC : BaseEncoder

<SerializableAttribute>
Public NotInheritable Class EncoderFLAC
	Inherits BaseEncoder

The EncoderFLAC type exposes the following members.

	Name	Description
	EncoderFLAC	Creates an instance of a FLAC encoder implementation.

	Name	Description
	ChannelBitwidth	This property returns the actual bitwidth of the sample data of the channel (e.g. 8, 16, 32). (Inherited from BaseEncoder.)
	ChannelHandle	Gets or Sets the channel handle which is used to create the broadcast encoder class. (Inherited from BaseEncoder.)
	ChannelInfo	Returns the general channel info. (Inherited from BaseEncoder.)
	ChannelNumChans	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.)
	ChannelSampleRate	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.)
	DefaultOutputExtension	This return the default extension of an output file for this encoder (".flac"). (Overrides BaseEncoderDefaultOutputExtension.)
	EffectiveBitrate	Returns the effective encoder bitrate (in kbps) of the output. (Overrides BaseEncoderEffectiveBitrate.)
	EncoderCommandLine	Gets the actual encoder command-line string (using all FLAC_xxx properties). (Overrides BaseEncoderEncoderCommandLine.)
	EncoderDirectory	Gets or Sets the encoder's base directory. (Inherited from BaseEncoder.)
	EncoderExists	This property return , if the file "flac.exe" exists in the EncoderDirectory - else is returned. (Overrides BaseEncoderEncoderExists.)
	EncoderHandle	Gets or sets the current HENCODE encoder handle. (Inherited from BaseEncoder.)
	EncoderType	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.)
	Force16Bit	Gets or Sets if a encoding in 16-bit sample data should be forced (default is ). (Inherited from BaseEncoder.)
	InputFile	Gets or Sets the input file name to be processed by the encoder (null = STDIN, default). (Inherited from BaseEncoder.)
	IsActive	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.)
	IsPaused	Gets a value indicating if the encoder has been paused (see Pause(Boolean)) - else must be returned. (Inherited from BaseEncoder.)
	IsStreaming	Is this instance used for streaming? When set to true, some internal encoder options might be set. Default is false. (Inherited from BaseEncoder.)
	NoLimit	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.)
	OutputFile	Gets or Sets the output file name to be processed by the encoder (null = STDOUT, default). (Inherited from BaseEncoder.)
	SupportsSTDOUT	FLAC implements STDOUT, so is always returned. (Overrides BaseEncoderSupportsSTDOUT.)
	TAGs	Gets or Sets the TAG_INFO structure associated with the encoder. (Inherited from BaseEncoder.)
	UseAsyncQueue	Gets or Sets if encoding should use an async queue (i.e. the BASS_ENCODE_QUEUE flag). (Inherited from BaseEncoder.)

	Name	Description
	Dispose	Implement IDisposable. (Inherited from BaseEncoder.)
	Finalize	Finalization code. (Inherited from BaseEncoder.)
	Pause	Pauses or resumes an encoder. (Inherited from BaseEncoder.)
	SettingsString	Returns the string representation of the current encoder settings. (Overrides BaseEncoderSettingsString.)
	Start	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).)
	Stop	Stops the encoder immediately (if started). (Inherited from BaseEncoder.)
	Stop(Boolean)	Stops the encoder (if started). (Inherited from BaseEncoder.)
	ToString	Returns the name of the Encoder. (Overrides ObjectToString.)

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

"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.

Reference