com.github.hoary.javaav

Class Codec

java.lang.Object

com.github.hoary.javaav.Codec

public class Codec
extends Object

Codecs are usually used by encoders and decoders. To create a Codec use the getEncoderById(CodecID) or getEncoderByName(String), for decoder respectively.

Author:

Alex Andres

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDecode() Determines whether this Codec is a decoder.
boolean	canEncode() Determines whether this Codec is a encoder.
int	getCapabilities() Get the codec capabilities.
static Codec	getDecoderById(CodecID codecId) Create a new decoder with specified codec id.
static Codec	getDecoderByName(String avCodecName) Create a new decoder with specified codec name.
static Codec	getEncoderById(CodecID codecId) Create a new encoder with specified codec id.
static Codec	getEncoderByName(String avCodecName) Create a new encoder with specified codec name.
CodecID	getID() Get the id of this Codec.
static String[]	getInstalledCodecs() Get all names of codecs that are compiled into FFmpeg.
String	getName() Get the short name of this Codec.
String	getNameLong() Get the long name of this Codec.
ChannelLayout[]	getSupportedChannelLayouts() Get all supported channel layouts by this Codec.
Integer[]	getSupportedFrameRates() Get all supported frame rates by this Codec.
PixelFormat[]	getSupportedPixelFormats() Get all supported pixel formats by this Codec.
SampleFormat[]	getSupportedSampleFormats() Get all supported sample formats by this Codec.
Integer[]	getSupportedSampleRates() Get all supported sample rates by this Codec.
MediaType	getType() Get the media type of this Codec.
boolean	hasCapability(CodecCapability flag) Determines whether this Codec has the specified capability.

Methods inherited from class java.lang.Object

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

Method Detail

getEncoderById

public static Codec getEncoderById(CodecID codecId)
                            throws JavaAVException

Create a new encoder with specified codec id.

Parameters:

codecId - the codec id.

Returns:

a new encoder.

Throws:

JavaAVException - if encoder could not be created.

getDecoderById

public static Codec getDecoderById(CodecID codecId)
                            throws JavaAVException

Create a new decoder with specified codec id.

Parameters:

codecId - the codec id.

Returns:

a new decoder.

Throws:

JavaAVException - if decoder could not be created.

getEncoderByName

public static Codec getEncoderByName(String avCodecName)
                              throws JavaAVException

Create a new encoder with specified codec name.

Parameters:

avCodecName - the codec name.

Returns:

a new encoder.

Throws:

JavaAVException - if encoder could not be created.

getDecoderByName

public static Codec getDecoderByName(String avCodecName)
                              throws JavaAVException

Create a new decoder with specified codec name.

Parameters:

avCodecName - the codec name.

Returns:

a new decoder.

Throws:

JavaAVException - if decoder could not be created.

getInstalledCodecs

public static String[] getInstalledCodecs()

Get all names of codecs that are compiled into FFmpeg.

Returns:

short codec names that the current FFmpeg version supports.

getName

public String getName()

Get the short name of this Codec.

Returns:

the short name of this Codec.

getNameLong

public String getNameLong()

Get the long name of this Codec.

Returns:

the long name of this Codec.

getID

public CodecID getID()

Get the id of this Codec.

Returns:

codec id.

getType

public MediaType getType()

Get the media type of this Codec.

Returns:

the media type of this Codec.

canDecode

public boolean canDecode()

Determines whether this Codec is a decoder.

Returns:

true if this Codec is a decoder, false otherwise.

canEncode

public boolean canEncode()

Determines whether this Codec is a encoder.

Returns:

true if this Codec is a encoder, false otherwise.

getCapabilities

public int getCapabilities()

Get the codec capabilities.

Returns:

codec capabilities.

hasCapability

public boolean hasCapability(CodecCapability flag)

Determines whether this Codec has the specified capability.

Parameters:

flag - the codec capability.

Returns:

true if codec has the specified capability, false otherwise.

getSupportedSampleFormats

public SampleFormat[] getSupportedSampleFormats()

Get all supported sample formats by this Codec. If this Codec is not an audio codec, then null is returned.

Returns:

all supported sample formats by this Codec.

getSupportedSampleRates

public Integer[] getSupportedSampleRates()

Get all supported sample rates by this Codec. If this Codec is not an audio codec, then null is returned. The sample rates are ordered in ascending order.

Returns:

all supported sample rates by this Codec.

getSupportedFrameRates

public Integer[] getSupportedFrameRates()

Get all supported frame rates by this Codec. If this Codec is not a video codec, then null is returned. The frame rates are ordered in ascending order.

Returns:

all supported frame rates by this Codec.

getSupportedChannelLayouts

public ChannelLayout[] getSupportedChannelLayouts()

Get all supported channel layouts by this Codec. If this Codec is not an audio codec, then null is returned.

Returns:

all supported channel layouts by this Codec.

getSupportedPixelFormats

public PixelFormat[] getSupportedPixelFormats()

Get all supported pixel formats by this Codec. If this Codec is not a video codec, then null is returned. The pixel formats are ordered in ascending order.

Returns:

all supported pixel formats by this Codec.