BASS.NET API for the Un4seen BASS Audio LibraryEncoderFAAC ClassBASS.NET API for the Un4seen BASS Audio Library
Encoder class implementation for AAC encoding using faac.exe.
Inheritance Hierarchy

SystemObject
  Un4seen.Bass.MiscBaseEncoder
    Un4seen.Bass.MiscEncoderFAAC

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

[SerializableAttribute]
public sealed class EncoderFAAC : BaseEncoder

The EncoderFAAC type exposes the following members.

Constructors

  NameDescription
Public methodEncoderFAAC
Creates an instance of a FAAC 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 (".m4a").
(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 FAAC_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 "lame.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_AAC 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
FAAC 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 methodQuality2Kbps
Converts a quality setting (between 10 and 500) to an approx. bitrate (in kbps).
Public methodSettingsString
Returns the string representation of the current encoder settings.
(Overrides BaseEncoderSettingsString.)
Public methodStart
This method starts the actual FAAC encoder.
(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 fieldFAAC_Bandwidth
-c: Set the bandwidth in Hz (default: -1 automatic, i.e. adapts maximum value to input sample rate).
Public fieldFAAC_Bitrate
-b: Set average bitrate (ABR) to approximately bitrate in kbps.

Max. value is 152 kbps/stereo with a 16 kHz cutoff, can be raised with a higher -c FAAC_Bandwidth setting).

Public fieldFAAC_BlockType
--shortctl: Enforce block type (0 = both (default), 1 = no short; 2 = no long).
Public fieldFAAC_CustomOptions
The custom parameter string, which should be used, if the FAAC_UseCustomOptionsOnly property is set to .
Public fieldFAAC_EnableTNS
--tns: Enable coding of TNS, temporal noise shaping (default is ).
Public fieldFAAC_MpegVersion
--mpeg-vers: Force AAC MPEG version 2 or 4 (-1 use default).
Public fieldFAAC_NoMidSide
--no-midside: Don't use mid/side coding (default is ).
Public fieldFAAC_ObjectType
--obj-type: AAC object type. "LC" (Low Complexity, default), "Main" or "LTP" (Long Term Prediction).
Public fieldFAAC_Quality
-q: Set default variable bitrate (VBR) quantizer quality in percent.
Public fieldFAAC_RawBitstream
-r: Generate raw AAC bitstream (i.e. without any headers, default is ).
Public fieldFAAC_UseCustomOptionsOnly
Use the FAAC_CustomOptions parameter string only (default=).
Public fieldFAAC_UseQualityMode
Gets or Sets, if the Quality mode (FAAC_Quality) will be used (default is ).
Public fieldFAAC_WrapMP4
-w: Wrap AAC data in MP4 container (default is , generating an .m4a output).
Top
Remarks

This class uses the BASS_CTYPE_STREAM_AAC encoder type.

FAAC (faac.exe) must be downloaded separately (e.g. from www.rarewares.org).

Make sure to set the FAAC_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

Reference