LameEncoder

java.lang.Object
- de.sciss.jump3r.lowlevel.LameEncoder

public class LameEncoder
extends java.lang.Object

Wrapper for the jump3r encoder.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BITRATE_AUTO`
`static int`	`CHANNEL_MODE_AUTO`
`static int`	`CHANNEL_MODE_DUAL_CHANNEL`
`static int`	`CHANNEL_MODE_JOINT_STEREO`
`static int`	`CHANNEL_MODE_MONO`
`static int`	`CHANNEL_MODE_STEREO`
`static int`	`MPEG_VERSION_1`
`static int`	`MPEG_VERSION_2`
`static int`	`MPEG_VERSION_2DOT5`
`static javax.sound.sampled.AudioFormat.Encoding`	`MPEG1L3`
`static javax.sound.sampled.AudioFormat.Encoding`	`MPEG2DOT5L3`
`static javax.sound.sampled.AudioFormat.Encoding`	`MPEG2L3`
`static java.lang.String`	`P_BITRATE` property key to read/set the bitrate: an Integer value.
`static java.lang.String`	`P_CHMODE` property key to read/set the channel mode: a String, one of "jointstereo", "dual", "mono", "auto" (default).
`static java.lang.String`	`P_QUALITY` property key to read/set the quality: an Integer from 1 (highest) to 9 (lowest).
`static java.lang.String`	`P_VBR` property key to read/set the VBR mode: an instance of Boolean (default: false)
`static int`	`QUALITY_HIGH`
`static int`	`QUALITY_HIGHEST`
`static int`	`QUALITY_LOW`
`static int`	`QUALITY_LOWEST`
`static int`	`QUALITY_MIDDLE`

Constructor Summary

Constructors
Constructor and Description
`LameEncoder()`
`LameEncoder(javax.sound.sampled.AudioFormat sourceFormat)` Initializes the encoder with the given source/PCM format.
`LameEncoder(javax.sound.sampled.AudioFormat sourceFormat, javax.sound.sampled.AudioFormat targetFormat)` Initializes the encoder with the given source/PCM format.
`LameEncoder(javax.sound.sampled.AudioFormat sourceFormat, int bitRate, int channelMode, int quality, boolean VBR)` Initializes the encoder, overriding any parameters set in the audio format's properties or in the system properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`float`	`convertByteArrayToFloat(byte[] bytes, int offset, java.nio.ByteOrder byteOrder)`
`int`	`encodeBuffer(byte[] pcm, int offset, int length, byte[] encoded)` Encode a block of data.
`int`	`encodeFinish(byte[] encoded)`
`int`	`getEffectiveBitRate()`
`int`	`getEffectiveChannelMode()`
`javax.sound.sampled.AudioFormat.Encoding`	`getEffectiveEncoding()`
`javax.sound.sampled.AudioFormat`	`getEffectiveFormat()` Return the audioformat representing the encoded mp3 stream.
`int`	`getEffectiveQuality()`
`int`	`getEffectiveSampleRate()`
`boolean`	`getEffectiveVBR()`
`java.lang.String`	`getEncoderVersion()` returns -1 if string is too short or returns one of the exception constants if everything OK, returns the length of the string
`int`	`getInputBufferSize()`
`int`	`getMP3BufferSize()`
`int`	`getOutputBufferSize()`
`int`	`getPCMBufferSize()` Returns the buffer needed pcm buffer size.
`javax.sound.sampled.AudioFormat`	`getSourceFormat()`
`javax.sound.sampled.AudioFormat`	`getTargetFormat()`
`void`	`setFormat(javax.sound.sampled.AudioFormat sourceFormat, javax.sound.sampled.AudioFormat targetFormat)`
`void`	`setSourceFormat(javax.sound.sampled.AudioFormat sourceFormat)`
`void`	`setTargetFormat(javax.sound.sampled.AudioFormat targetFormat)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MPEG1L3
```
public static final javax.sound.sampled.AudioFormat.Encoding MPEG1L3
```
  - MPEG2L3
```
public static final javax.sound.sampled.AudioFormat.Encoding MPEG2L3
```
  - MPEG2DOT5L3
```
public static final javax.sound.sampled.AudioFormat.Encoding MPEG2DOT5L3
```
  - P_VBR
```
public static final java.lang.String P_VBR
```
    property key to read/set the VBR mode: an instance of Boolean (default: false)
    
    See Also:
    
    Constant Field Values
  - P_CHMODE
```
public static final java.lang.String P_CHMODE
```
    property key to read/set the channel mode: a String, one of "jointstereo", "dual", "mono", "auto" (default).
    
    See Also:
    
    Constant Field Values
  - P_BITRATE
```
public static final java.lang.String P_BITRATE
```
    property key to read/set the bitrate: an Integer value. Set to -1 for default bitrate.
    
    See Also:
    
    Constant Field Values
  - P_QUALITY
```
public static final java.lang.String P_QUALITY
```
    property key to read/set the quality: an Integer from 1 (highest) to 9 (lowest).
    
    See Also:
    
    Constant Field Values
  - MPEG_VERSION_2
```
public static final int MPEG_VERSION_2
```
    See Also:
    
    Constant Field Values
  - MPEG_VERSION_1
```
public static final int MPEG_VERSION_1
```
    See Also:
    
    Constant Field Values
  - MPEG_VERSION_2DOT5
```
public static final int MPEG_VERSION_2DOT5
```
    See Also:
    
    Constant Field Values
  - QUALITY_LOWEST
```
public static final int QUALITY_LOWEST
```
    See Also:
    
    Constant Field Values
  - QUALITY_LOW
```
public static final int QUALITY_LOW
```
    See Also:
    
    Constant Field Values
  - QUALITY_MIDDLE
```
public static final int QUALITY_MIDDLE
```
    See Also:
    
    Constant Field Values
  - QUALITY_HIGH
```
public static final int QUALITY_HIGH
```
    See Also:
    
    Constant Field Values
  - QUALITY_HIGHEST
```
public static final int QUALITY_HIGHEST
```
    See Also:
    
    Constant Field Values
  - CHANNEL_MODE_STEREO
```
public static final int CHANNEL_MODE_STEREO
```
    See Also:
    
    Constant Field Values
  - CHANNEL_MODE_JOINT_STEREO
```
public static final int CHANNEL_MODE_JOINT_STEREO
```
    See Also:
    
    Constant Field Values
  - CHANNEL_MODE_DUAL_CHANNEL
```
public static final int CHANNEL_MODE_DUAL_CHANNEL
```
    See Also:
    
    Constant Field Values
  - CHANNEL_MODE_MONO
```
public static final int CHANNEL_MODE_MONO
```
    See Also:
    
    Constant Field Values
  - CHANNEL_MODE_AUTO
```
public static final int CHANNEL_MODE_AUTO
```
    See Also:
    
    Constant Field Values
  - BITRATE_AUTO
```
public static final int BITRATE_AUTO
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LameEncoder
```
public LameEncoder()
```
  - LameEncoder
```
public LameEncoder(javax.sound.sampled.AudioFormat sourceFormat)
```
    Initializes the encoder with the given source/PCM format. The default mp3 encoding parameters are used, see DEFAULT_BITRATE, DEFAULT_CHANNEL_MODE, DEFAULT_QUALITY, and DEFAULT_VBR.
    
    Throws:
    
    java.lang.IllegalArgumentException - when parameters are not supported by LAME.
  - LameEncoder
```
public LameEncoder(javax.sound.sampled.AudioFormat sourceFormat,
                   javax.sound.sampled.AudioFormat targetFormat)
```
    Initializes the encoder with the given source/PCM format. The mp3 parameters are read from the targetFormat's properties. For any parameter that is not set, global system properties are queried for backwards tritonus compatibility. Last, parameters will use the default values DEFAULT_BITRATE, DEFAULT_CHANNEL_MODE, DEFAULT_QUALITY, and DEFAULT_VBR.
    
    Throws:
    
    java.lang.IllegalArgumentException - when parameters are not supported by LAME.
  - LameEncoder
```
public LameEncoder(javax.sound.sampled.AudioFormat sourceFormat,
                   int bitRate,
                   int channelMode,
                   int quality,
                   boolean VBR)
```
    Initializes the encoder, overriding any parameters set in the audio format's properties or in the system properties.
    
    Throws:
    
    java.lang.IllegalArgumentException - when parameters are not supported by LAME.
- Method Detail
  - setSourceFormat
```
public void setSourceFormat(javax.sound.sampled.AudioFormat sourceFormat)
```
  - setTargetFormat
```
public void setTargetFormat(javax.sound.sampled.AudioFormat targetFormat)
```
  - setFormat
```
public void setFormat(javax.sound.sampled.AudioFormat sourceFormat,
                      javax.sound.sampled.AudioFormat targetFormat)
```
  - getEncoderVersion
```
public java.lang.String getEncoderVersion()
```
    returns -1 if string is too short or returns one of the exception constants if everything OK, returns the length of the string
  - getPCMBufferSize
```
public int getPCMBufferSize()
```
    Returns the buffer needed pcm buffer size. The passed parameter is a wished buffer size. The implementation of the encoder may return a lower or higher buffer size. The encoder must be initalized (i.e. not closed) at this point. A return value of <0 denotes an error.
  - getMP3BufferSize
```
public int getMP3BufferSize()
```
  - getInputBufferSize
```
public int getInputBufferSize()
```
  - getOutputBufferSize
```
public int getOutputBufferSize()
```
  - encodeBuffer
```
public int encodeBuffer(byte[] pcm,
                        int offset,
                        int length,
                        byte[] encoded)
                 throws java.lang.ArrayIndexOutOfBoundsException
```
    Encode a block of data. Throws IllegalArgumentException when parameters are wrong. When the encoded array is too small, an ArrayIndexOutOfBoundsException is thrown. length should be the value returned by getPCMBufferSize.
    
    Returns:
    
    the number of bytes written to encoded. May be 0.
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException
  - encodeFinish
```
public int encodeFinish(byte[] encoded)
```
  - close
```
public void close()
```
  - getEffectiveFormat
```
public javax.sound.sampled.AudioFormat getEffectiveFormat()
```
    Return the audioformat representing the encoded mp3 stream. The format object will have the following properties:
    - quality: an Integer, 1 (highest) to 9 (lowest)
    - bitrate: an Integer, 32...320 kbit/s
    - chmode: channel mode, a String, one of "jointstereo", "dual", "mono", "auto" (default).
    - vbr: a Boolean
    - encoder.version: a string with the version of the encoder
    - encoder.name: a string with the name of the encoder
  - getEffectiveQuality
```
public int getEffectiveQuality()
```
  - getEffectiveBitRate
```
public int getEffectiveBitRate()
```
  - getEffectiveChannelMode
```
public int getEffectiveChannelMode()
```
  - getEffectiveVBR
```
public boolean getEffectiveVBR()
```
  - getEffectiveSampleRate
```
public int getEffectiveSampleRate()
```
  - getEffectiveEncoding
```
public javax.sound.sampled.AudioFormat.Encoding getEffectiveEncoding()
```
  - convertByteArrayToFloat
```
public final float convertByteArrayToFloat(byte[] bytes,
                                           int offset,
                                           java.nio.ByteOrder byteOrder)
```
  - getSourceFormat
```
public javax.sound.sampled.AudioFormat getSourceFormat()
```
  - getTargetFormat
```
public javax.sound.sampled.AudioFormat getTargetFormat()
```

Class LameEncoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MPEG1L3

MPEG2L3

MPEG2DOT5L3

P_VBR

P_CHMODE

P_BITRATE

P_QUALITY

MPEG_VERSION_2

MPEG_VERSION_1

MPEG_VERSION_2DOT5

QUALITY_LOWEST

QUALITY_LOW

QUALITY_MIDDLE

QUALITY_HIGH

QUALITY_HIGHEST

CHANNEL_MODE_STEREO

CHANNEL_MODE_JOINT_STEREO

CHANNEL_MODE_DUAL_CHANNEL

CHANNEL_MODE_MONO

CHANNEL_MODE_AUTO

BITRATE_AUTO

Constructor Detail

LameEncoder

LameEncoder

LameEncoder

LameEncoder

Method Detail

setSourceFormat

setTargetFormat

setFormat

getEncoderVersion

getPCMBufferSize

getMP3BufferSize

getInputBufferSize

getOutputBufferSize

encodeBuffer

encodeFinish

close

getEffectiveFormat

getEffectiveQuality

getEffectiveBitRate

getEffectiveChannelMode

getEffectiveVBR

getEffectiveSampleRate

getEffectiveEncoding

convertByteArrayToFloat

getSourceFormat

getTargetFormat