BASS.NET API for the Un4seen BASS Audio Library

BassWmaBASS_WMA_EncodeOpenFile Method

BASS.NET API for the Un4seen BASS Audio Library
Initializes WMA encoding to a file.

This overload implements UNICODE filenames. The BASS_UNICODE flag will be added automatically, since all .Net strings are always unicode.

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

public static int BASS_WMA_EncodeOpenFile(
	int freq,
	int chans,
	BASSWMAEncode flags,
	int bitrate,
	string file
)

Parameters

freq
Type: SystemInt32
The sample rate in Hz, or a BASS channel handle if the BASS_WMA_ENCODE_SOURCE flag is specified.
chans
Type: SystemInt32
The number of channels (1=mono, 2=stereo, etc.).
flags
Type: Un4seen.Bass.AddOn.WmaBASSWMAEncode
Any combination of these flags (see BASSWMAEncode):
BASS_SAMPLE_8BITS8-bit sample data. If neither this or the BASS_SAMPLE_FLOAT flags are specified, then 16-bit data is expected.
BASS_SAMPLE_FLOAT32-bit floating-point sample data.
BASS_WMA_ENCODE_STANDARDUse standard WMA encoding. If neither this or the BASS_WMA_ENCODE_PRO flag is specified, then either codec could be used (whichever supports the requested sample format and bitrate).
BASS_WMA_ENCODE_PROUse WMA Professional encoding.
BASS_WMA_ENCODE_VOICEUse WMA voice encoding.
BASS_WMA_ENCODE_VOICE_MIXEDUUse WMA voice encoding in mixed mode.
BASS_WMA_ENCODE_PCMWrite uncompressed PCM data in an ASF container. bitrate is ignored except that it should be non-0.
BASS_WMA_ENCODE_24BITEncode in 24-bit, else 16-bit. 24-bit encoding requires WMA Pro.
BASS_WMA_ENCODE_SCRIPTEnable the specification of tags mid-stream (after encoding has begun).
BASS_UNICODEFile is a Unicode (16-bit characters) filename.
BASS_WMA_ENCODE_SOURCEUse the BASS channel with the handle in freq as the encoder's source. The chansparameter is ignored, as are the BASS_SAMPLE_8BITS and BASS_SAMPLE_FLOAT flags. If the BASSenc add-on is loaded, then the BASS_CONFIG_ENCODE_PRIORITY setting is used to determine where in the channel's DSP chain the encoding is performed, otherwise priority -1000 is used.
BASS_WMA_ENCODE_QUEUEQueue data to feed the encoder asynchronously. This prevents BASS_WMA_EncodeWrite(Int32, IntPtr, Int32) getting blocked by the encoder, but the application should control the rate at which data is encoded, as it is possible to queue too much data for the encoder to handle.
bitrate
Type: SystemInt32
The encoding bitrate (in bits per second, e.g. 128000), or VBR quality (100 or less).
file
Type: SystemString
The filename to write.

Return Value

Type: Int32
If succesful, the new encoder's handle is returned, else 0 is returned. Use BASS_ErrorGetCode to get the error code.
Remarks

The WMA codec expects 16-bit or 24-bit sample data depending on the BASS_WMA_ENCODE_24BIT flag, but BASSWMA will accept 8-bit, 16-bit or floating-point data, and convert it to the appropriate format. Use BASS_WMA_EncodeGetRates(Int32, Int32, BASSWMAEncode) to retrieve a list of the encoding bitrates available for a specific sample format.

Use BASS_WMA_EncodeSetTag(Int32, IntPtr, IntPtr, BASSWMATag) for each tag you wish to set.

Use BASS_WMA_EncodeWrite(Int32, IntPtr, Int32) to encode sample data, and BASS_WMA_EncodeClose(Int32) to finish encoding and close the file.

ERROR CODEDescription
BASS_ERROR_WMAThe Windows Media modules (v9 or above) are not installed.
BASS_ERROR_NOTAVAILNo codec could be found to support the specified sample format and bitrate.
BASS_ERROR_CREATECould not create the file to write the WMA stream.
BASS_ERROR_UNKNOWNSome other mystery problem!

Examples

Initialize encoding 44100hz 16-bit stereo sample data at 128kb/s to a file called "output.wma":
int stream = Bass.BASS_StreamCreateFile("input.mp3", 0L, 0L, BASSFlag.BASS_STREAM_DECODE);
if (stream != 0)
{
  byte[] buffer = new byte[16384]; // 16KB decode buffer
  int enc = BassWma.BASS_WMA_EncodeOpenFile(44100, 2, BASSWMAEncode.BASS_WMA_ENCODE_DEFAULT, 
                    128000, "output.wma");
  while (Bass.BASS_ChannelIsActive(stream) == BASSActive.BASS_ACTIVE_PLAYING)
  {
    int len = Bass.BASS_ChannelGetData(stream, buffer, 16384);
    if (len > 0)
      BassWma.BASS_WMA_EncodeWrite(enc, buffer, len);
  }
  BassWma.BASS_WMA_EncodeClose(enc);
}
See Also

Reference