BASS.NET API for the Un4seen BASS Audio Library

EncoderNeroAAC Class

BASS.NET API for the Un4seen BASS Audio Library
Encoder class implementation for the Nero Digital AAC encoder using "neroAacEnc.exe".
Inheritance Hierarchy

SystemObject
  Un4seen.Bass.MiscBaseEncoder
    Un4seen.Bass.MiscEncoderNeroAAC

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

[SerializableAttribute]
public sealed class EncoderNeroAAC : BaseEncoder

The EncoderNeroAAC type exposes the following members.

Constructors

  NameDescription
Public methodEncoderNeroAAC
Creates an instance of a Nero Digital AAC 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 NERO_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 "neroAacEnc.exe" or "neroAacEnc_sse2.exe" (depending on your NERO_UseSSE setting) 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 propertyIsStreaming
Is this instance used for streaming? When set to true, some internal encoder options might be set. Default is false.
(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
Nero Digital Aac does NOT implement STDOUT, so FASLE 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 Nero Digial Aac encoder.
(Overrides BaseEncoderStart(ENCODEPROC, IntPtr, Boolean).)
Public methodStop
Stops the encoder immediately (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 fieldNERO_2Pass
-2pass: Enables two-pass encoding mode. Note that two-pass mode requires a physical file as input, rather than STDIN.
Public fieldNERO_2PassPeriod
-2passperiod: Overrides two-pass encoding bitrate averaging period, in milliseconds. Specify 0 (zero) to use least restrictive value possible (default).
Public fieldNERO_Bitrate
-br: Choose a nominal bitrate to encode at. Attempt to encode at a bitrate averaging this. Takes an argument in kbps.
Public fieldNERO_CustomOptions
The custom parameter string, which should be used, if the NERO_UseCustomOptionsOnly property is set to .
Public fieldNERO_HE
-he: Forces use of HE AAC profile, HEv2 features disabled (default is ).
Public fieldNERO_HEv2
-hev2: Forces use of HEv2 AAC profile (default is ).
Public fieldNERO_HintTrack
-hinttrack: Generates an RTP hint track in output MP4 file (default is ).
Public fieldNERO_LC
-lc: Forces use of LC AAC profile, HE features disabled (default is ).
Public fieldNERO_Quality
-q: Specify quality between 0.00 (low) and 1.00 (high) (default=0.4), instead of specifying a particular bitrate (NERO_Bitrate).
Public fieldNERO_UseCBR
-cbr: Enables the constant bitrate mode (default is ). When enabled CBR is generated, else VBR is generated.
Public fieldNERO_UseCustomOptionsOnly
Use the NERO_CustomOptions parameter string only (default=).
Public fieldNERO_UseQualityMode
Use Quality-Mode? (default is ).
Public fieldNERO_UseSSE
Specifies, if the "neroAacEnc.exe" (, default) or the "neroAacEnc_sse2.exe" () command-line tool should be used.
Top
Remarks

This class uses the BASS_CTYPE_STREAM_AAC encoder type.

The NeroAac Encoder must be downloaded separately (e.g. from www.nero.com).

Since "neroAacEnc.exe" does support 8-, 16-, and 32-bit(IEEE float) sample data as input, no BASS_ENCODE_FP_ flag will be used.

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

There are two versions: "neroEncAac.exe" and "neroAacEnc_sse2.exe" out there (one is highly optimized for SSE etc.). This encoder implementation supports both versions see the NERO_UseSSE property for details.

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