BASS.NET API for the Un4seen BASS Audio LibraryEncoderTwoLAME ClassBASS.NET API for the Un4seen BASS Audio Library
Encoder class implementation for MP2 TwoLAME encoding using "twolame.exe".
Inheritance Hierarchy

SystemObject
  Un4seen.Bass.MiscBaseEncoder
    Un4seen.Bass.MiscEncoderTwoLAME

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

[SerializableAttribute]
public sealed class EncoderTwoLAME : BaseEncoder

The EncoderTwoLAME type exposes the following members.

Constructors

  NameDescription
Public methodEncoderTwoLAME
Creates an instance of a TwoLAME 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 (".mp2").
(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 TWO_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 "twolame.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_MP2 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
TwoLAME 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 TwoLAME 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 fieldTWO_ATH
-l: Set the ATH level. Default level is 0.0 (which will not use the property).
Public fieldTWO_Bitrate
-b: Choose a total bitrate to encode at. Takes an argument in kbps (default is 256 kbps).
Public fieldTWO_Copyright
-c: Turn on Copyright flag in output bitstream (default is ).
Public fieldTWO_CustomOptions
The custom parameter string, which should be used, if the TWO_UseCustomOptionsOnly property is set to .
Public fieldTWO_DeEmphasis
-e: Set the de-emphasis type (None, CCIT, 50/15ms). Default is None.
Public fieldTWO_Downmix
-a: Downmix from stereo to mono? (default is ).
Public fieldTWO_Energy
-E: Turn on energy level extensions (default is ).
Public fieldTWO_MaxBitrate
-B: Specify a maximum bitrate in kbps when in VBR mode.
Public fieldTWO_Mode
-m: The encoding mode (Stereo, Joint stereo, DualChannel, Mono, default is Auto).
Public fieldTWO_NonOriginal
-o: Turn off Original flag in output bitstream (default is ).
Public fieldTWO_Padding
-d: Turn on padding in output bitstream (default is ).
Public fieldTWO_Protect
-p: Enable CRC error protection in output bitstream. An extra 16-bit checksum is added to each frame (default is ).
Public fieldTWO_PsycModel
-P: The psychoacoustic model (PAM) TwoLAME should use (-1 to 4).
Public fieldTWO_Quick
-q: Enable quick mode (if value is geater than 0 (zero)). Only re-calculate psycho-acoustic model every specified number of frames (default is 0).
Public fieldTWO_Reserve
-R: Reserve specified number of bits in the each from of the output bitstream (default is 0, which will not use this property).
Public fieldTWO_Scale
--scale: Scale input data (multiply PCM data). Set to 1.0 (default) for no scaling.
Public fieldTWO_UseCustomOptionsOnly
Use the TWO_CustomOptions parameter string only (default=).
Public fieldTWO_UseVBR
-v: Enable the VBR (variable bitrate) mode (default is ).
Public fieldTWO_VBRLevel
-V: Enable VBR and set a quality level from -50 to 50 (default is disbaled).
Top
Remarks

This class uses the BASS_CTYPE_STREAM_MP2 encoder type.

"twolame.exe" must be downloaded separately (e.g. from www.rarewares.org or www.twolame.org). TwoLAME is a fork of the tooLAME project, so don't mix it up. TwoLAME is a very good and stable freeware MP2 encoder.

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