com.github.hoary.javaav

Class Decoder

java.lang.Object

com.github.hoary.javaav.Configurable

com.github.hoary.javaav.Coder

com.github.hoary.javaav.Decoder

public class Decoder
extends Coder

Media decoder that currently supports audio and video decoding.

Author:

Alex Andres

Nested Class Summary

Nested classes/interfaces inherited from class com.github.hoary.javaav.Coder

Coder.State

Field Summary

Fields inherited from class com.github.hoary.javaav.Coder

avContext, avFrame, avPacket, codec, gotFrame, state

Fields inherited from class com.github.hoary.javaav.Configurable

audioChannels, bitrate, flags, frameRate, gopSize, imageHeight, imageWidth, mediaType, profile, quality, sampleFormat, sampleRate

Constructor Summary

Constructors

Constructor and Description
Decoder(CodecID codecId) Create new Decoder that decodes media with codec with specified CodecID.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close this Coder and free allocated memory.
AudioFrame	decodeAudio(MediaPacket mediaPacket) Decode a media packet with audio samples into an AudioFrame.
VideoFrame	decodeVideo(MediaPacket mediaPacket) Decode a media packet with video frame data into a VideoFrame.
int	getAudioChannels() Get audio channels.
int	getImageHeight() Get the image height.
int	getImageWidth() Get the image width.
PixelFormat	getPixelFormat() Get pixel format.
SampleFormat	getSampleFormat() Get sample format.
int	getSampleRate() Get sample rate.
void	open(Map<String,String> options) Initializes the Coder with codec options that may contain specific codec parameters.
void	setPixelFormat(PixelFormat format) Set new pixel format.

Methods inherited from class com.github.hoary.javaav.Coder

flush, getBitrate, getFramerate, getGOPSize, getMediaType, getProfile, getQuality

Methods inherited from class com.github.hoary.javaav.Configurable

setAudioChannels, setBitrate, setFlag, setFramerate, setGOPSize, setImageHeight, setImageWidth, setMediaType, setProfile, setQuality, setSampleFormat, setSamplerate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Decoder

public Decoder(CodecID codecId)
        throws JavaAVException

Create new Decoder that decodes media with codec with specified CodecID.

Parameters:

codecId - the codec id.

Throws:

JavaAVException - if decoder could not be created.

Method Detail

open

public void open(Map<String,String> options)
          throws JavaAVException

Description copied from class: Coder

Initializes the Coder with codec options that may contain specific codec parameters.

Overrides:

open in class Coder

Parameters:

options - codec options.

Throws:

JavaAVException - if Coder could not be opened.

close

public void close()

Description copied from class: Coder

Close this Coder and free allocated memory.

Overrides:

close in class Coder

getImageWidth

public int getImageWidth()

Description copied from class: Configurable

Get the image width.

Overrides:

getImageWidth in class Coder

Returns:

image width.

getImageHeight

public int getImageHeight()

Description copied from class: Configurable

Get the image height.

Overrides:

getImageHeight in class Coder

Returns:

image height.

getAudioChannels

public int getAudioChannels()

Description copied from class: Configurable

Get audio channels.

Overrides:

getAudioChannels in class Coder

Returns:

number of audio channels.

getSampleRate

public int getSampleRate()

Description copied from class: Configurable

Get sample rate.

Overrides:

getSampleRate in class Coder

Returns:

sample rate.

getSampleFormat

public SampleFormat getSampleFormat()

Description copied from class: Configurable

Get sample format.

Overrides:

getSampleFormat in class Coder

Returns:

sample format.

getPixelFormat

public PixelFormat getPixelFormat()

Description copied from class: Configurable

Get pixel format.

Overrides:

getPixelFormat in class Coder

Returns:

pixel format.

setPixelFormat

public void setPixelFormat(PixelFormat format)

Description copied from class: Configurable

Set new pixel format.

Overrides:

setPixelFormat in class Configurable

Parameters:

format - pixel format.

decodeAudio

public AudioFrame decodeAudio(MediaPacket mediaPacket)
                       throws JavaAVException

Decode a media packet with audio samples into an AudioFrame.

Parameters:

mediaPacket - packet with audio samples.

Returns:

an AudioFrame with normalized PCM audio samples.

Throws:

JavaAVException - if audio packet could not be decoded.

decodeVideo

public VideoFrame decodeVideo(MediaPacket mediaPacket)
                       throws JavaAVException

Decode a media packet with video frame data into a VideoFrame.

Parameters:

mediaPacket - packet with a video frame.

Returns:

a VideoFrame in which the decoded video frame will be stored.

Throws:

JavaAVException - if video packet could not be decoded.