com.github.hoary.javaav

Class Coder

java.lang.Object

com.github.hoary.javaav.Configurable

com.github.hoary.javaav.Coder

Direct Known Subclasses:

Decoder, Encoder

public abstract class Coder
extends Configurable

Coder is an abstract representation of an encoder or decoder. This class provides basic functionality to initialize and close this Coders codec. For an implementation see Encoder and Decoder.

Author:

Alex Andres

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Coder.State Coder state indicates whether the Coder is opened or closed.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.googlecode.javacv.cpp.avcodec.AVCodecContext	avContext The codec context.
protected com.googlecode.javacv.cpp.avutil.AVFrame	avFrame Output data of decoder.
protected com.googlecode.javacv.cpp.avcodec.AVPacket	avPacket Input data for decoder.
protected Codec	codec The chosen codec.
protected int[]	gotFrame Indicates whether last frame was encoded or decoded.
protected Coder.State	state Current coder state.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close this Coder and free allocated memory.
void	flush() Flush buffers, should be called when seeking or switching to a different stream.
int	getAudioChannels() Get audio channels.
int	getBitrate() Get bitrate.
double	getFramerate() Get the frame rate.
int	getGOPSize() Get group of pictures.
int	getImageHeight() Get the image height.
int	getImageWidth() Get the image width.
MediaType	getMediaType() Get the media type, audio, video, etc.
PixelFormat	getPixelFormat() Get pixel format.
int	getProfile() Get profile.
double	getQuality() Get quality.
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.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

gotFrame

protected int[] gotFrame

Indicates whether last frame was encoded or decoded.

avContext

protected com.googlecode.javacv.cpp.avcodec.AVCodecContext avContext

The codec context.

avFrame

protected com.googlecode.javacv.cpp.avutil.AVFrame avFrame

Output data of decoder. Input data for encoder.

avPacket

protected com.googlecode.javacv.cpp.avcodec.AVPacket avPacket

Input data for decoder. Output data of encoder.

codec

protected final Codec codec

The chosen codec.

state

protected Coder.State state

Current coder state.

Method Detail

open

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

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

Parameters:

options - codec options.

Throws:

JavaAVException - if Coder could not be opened.

close

public void close()

Close this Coder and free allocated memory.

flush

public void flush()

Flush buffers, should be called when seeking or switching to a different stream.

getMediaType

public MediaType getMediaType()

Description copied from class: Configurable

Get the media type, audio, video, etc.

Overrides:

getMediaType in class Configurable

Returns:

media type.

getImageWidth

public int getImageWidth()

Description copied from class: Configurable

Get the image width.

Overrides:

getImageWidth in class Configurable

Returns:

image width.

getImageHeight

public int getImageHeight()

Description copied from class: Configurable

Get the image height.

Overrides:

getImageHeight in class Configurable

Returns:

image height.

getGOPSize

public int getGOPSize()

Description copied from class: Configurable

Get group of pictures.

Overrides:

getGOPSize in class Configurable

Returns:

group of pictures.

getPixelFormat

public PixelFormat getPixelFormat()

Description copied from class: Configurable

Get pixel format.

Overrides:

getPixelFormat in class Configurable

Returns:

pixel format.

getSampleFormat

public SampleFormat getSampleFormat()

Description copied from class: Configurable

Get sample format.

Overrides:

getSampleFormat in class Configurable

Returns:

sample format.

getBitrate

public int getBitrate()

Description copied from class: Configurable

Get bitrate.

Overrides:

getBitrate in class Configurable

Returns:

bitrate.

getFramerate

public double getFramerate()

Description copied from class: Configurable

Get the frame rate.

Overrides:

getFramerate in class Configurable

Returns:

frame rate.

getSampleRate

public int getSampleRate()

Description copied from class: Configurable

Get sample rate.

Overrides:

getSampleRate in class Configurable

Returns:

sample rate.

getAudioChannels

public int getAudioChannels()

Description copied from class: Configurable

Get audio channels.

Overrides:

getAudioChannels in class Configurable

Returns:

number of audio channels.

getQuality

public double getQuality()

Description copied from class: Configurable

Get quality.

Overrides:

getQuality in class Configurable

Returns:

quality.

getProfile

public int getProfile()

Description copied from class: Configurable

Get profile.

Overrides:

getProfile in class Configurable

Returns:

profile.