io.humble.video

Class Codec

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Codec

public class Codec
extends RefCounted

A codec that can be used either to encode raw data into compressed bitstreams,
or decode compressed data into raw data, or both!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Codec.CodecCapability Capabilities supported by a codec.
static class	Codec.DiscardFlag When decoding, you can instruct streams to discard some packets.
static class	Codec.ID Identify the syntax and semantics of an audio or video encoded bitstream. The principle is roughly: Two decoders with the same ID can decode the same streams. Two encoders with the same ID can encode compatible streams. There may be slight deviations from the principle due to implementation details. From Ffmpeg 2.8

Method Summary

Modifier and Type	Method and Description
boolean	canDecode() Can this codec be used for decoding?
boolean	canEncode() Can this codec be used for encoding?
Codec	copyReference() Create a new Codec object that is actually referring to the exact same underlying native object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
static Codec	findDecodingCodec(Codec.ID id) Find a codec that can be used for decoding.
static Codec	findDecodingCodecByIntID(int id) Find a codec that can be used for decoding.
static Codec	findDecodingCodecByName(String id) Find a codec that can be used for decoding.
static Codec	findEncodingCodec(Codec.ID id) Find a codec that can be used for encoding.
static Codec	findEncodingCodecByIntID(int id) Find a codec that can be used for encoding.
static Codec	findEncodingCodecByName(String id) Find a codec that can be used for encoding.
int	getCapabilities() Get a bitmask of the supported CodecCapability flags.
Codec.ID	getID() Get the ID of this codec as an enumeration.
int	getIDAsInt() Get the ID of this codec, as an integer.
static Codec	getInstalledCodec(int index) Get the ICodec at the given index.
static Collection<Codec>	getInstalledCodecs() Gets a collection of ALL codecs installed on this system.
String	getLongName() Get the long name for this codec.
String	getName() Get the name of the codec.
static int	getNumInstalledCodecs() Capability flags Get the number of installed codecs on this system.
int	getNumSupportedAudioChannelLayouts() Get the number of different audio channel layouts this codec supports for encoding.
int	getNumSupportedAudioFormats() Get the number of different audio sample formats this codec supports for encoding.
int	getNumSupportedAudioSampleRates() Get the number of different audio sample rates this codec supports for encoding.
int	getNumSupportedProfiles() Get the number of supported CodecProfiles this codec supports.
int	getNumSupportedVideoFrameRates() Get the number of frame rates this codec supports for encoding. Not all codecs will report this number.
int	getNumSupportedVideoPixelFormats() Get the number of supported video pixel formats this codec supports for encoding.
AudioChannel.Layout	getSupportedAudioChannelLayout(int index) Get the supported audio channel layout at this index. The value returned is a bit flag representing the different types of audio layout this codec can support.
Collection<AudioChannel.Layout>	getSupportedAudioChannelLayouts() Returns a list of supported audio channel layouts this codec can encode audio in.
AudioFormat.Type	getSupportedAudioFormat(int index) Get the supported sample format at this index.
Collection<AudioFormat.Type>	getSupportedAudioFormats() Returns a list of supported audio sample formats this codec can encode audio in.
int	getSupportedAudioSampleRate(int index) Return the support audio sample rate at the given index.
Collection<Integer>	getSupportedAudioSampleRates() Returns a list of supported audio sample rates this codec can encode audio in.
CodecProfile	getSupportedProfile(int index) Get the supported CodecProfile at this index.
Rational	getSupportedVideoFrameRate(int index) Return the supported frame rate at the given index.
Collection<Rational>	getSupportedVideoFrameRates() Returns a list of supported frame-rates this codec can encode video to.
PixelFormat.Type	getSupportedVideoPixelFormat(int index) Return the supported video pixel format at the given index.
Collection<PixelFormat.Type>	getSupportedVideoPixelFormats() Returns a list of supported pixel formats this codec can encode video in.
MediaDescriptor.Type	getType() Get the type of this codec.
static Codec	guessEncodingCodec(MuxerFormat fmt, String shortName, String url, String mimeType, MediaDescriptor.Type type) Ask us to guess an encoding codec based on the inputs passed in.
boolean	hasCapability(Codec.CodecCapability c) Checks if this codec has the given capability.
int	hashCode() Get a hashable value for this object.
String	toString() Prints the type and id of this codec

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

copyReference

public Codec copyReference()

Create a new Codec object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class RefCounted

Returns:

the new Java object.

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

toString

public String toString()

Prints the type and id of this codec

Overrides:

toString in class Object

Returns:

the type and id

getInstalledCodecs

public static Collection<Codec> getInstalledCodecs()

Gets a collection of ALL codecs installed on this system.

Returns:

A collection of all installed codecs.

getSupportedVideoFrameRates

public Collection<Rational> getSupportedVideoFrameRates()

Returns a list of supported frame-rates this codec can encode video to.

Not all codecs support reporting this, in which case the returned list will be empty.

Returns:

a list

getSupportedVideoPixelFormats

public Collection<PixelFormat.Type> getSupportedVideoPixelFormats()

Returns a list of supported pixel formats this codec can encode video in.

Not all codecs support reporting this, in which case the returned list will be empty.

Returns:

a list

getSupportedAudioSampleRates

public Collection<Integer> getSupportedAudioSampleRates()

Returns a list of supported audio sample rates this codec can encode audio in.

Not all codecs support reporting this, in which case the returned list will be empty.

Returns:

a list

getSupportedAudioFormats

public Collection<AudioFormat.Type> getSupportedAudioFormats()

Returns a list of supported audio sample formats this codec can encode audio in.

Not all codecs support reporting this, in which case the returned list will be empty.

Returns:

a list

getSupportedAudioChannelLayouts

public Collection<AudioChannel.Layout> getSupportedAudioChannelLayouts()

Returns a list of supported audio channel layouts this codec can encode audio in.

Not all codecs support reporting this, in which case the returned list will be empty.

Returns:

a list

hasCapability

public boolean hasCapability(Codec.CodecCapability c)

Checks if this codec has the given capability.

Parameters:

c - Capability to check.

getCapabilities

public int getCapabilities()

Get a bitmask of the supported CodecCapability flags.

getName

public String getName()

Get the name of the codec.

Returns:

The name of this Codec.

getIDAsInt

public int getIDAsInt()

Get the ID of this codec, as an integer.

Returns:

the ID of this codec, as an integer.

getID

public Codec.ID getID()

Get the ID of this codec as an enumeration.

Returns:

the ID of this codec, an enum ID

getType

public MediaDescriptor.Type getType()

Get the type of this codec.

Returns:

The type of this Codec, as a enum Type

canDecode

public boolean canDecode()

Can this codec be used for decoding?

Returns:

Can this Codec decode?

canEncode

public boolean canEncode()

Can this codec be used for encoding?

Returns:

Can this Codec encode?

findEncodingCodec

public static Codec findEncodingCodec(Codec.ID id)

Find a codec that can be used for encoding.

Parameters:

id - The id of the codec

Returns:

the codec, or null if we can't find it.

findEncodingCodecByIntID

public static Codec findEncodingCodecByIntID(int id)

Find a codec that can be used for encoding.

Parameters:

id - The id of the codec, as an integer.

Returns:

the codec, or null if we can't find it.

findEncodingCodecByName

public static Codec findEncodingCodecByName(String id)

Find a codec that can be used for encoding.

Parameters:

id - The id of the codec, as a FFMPEG short-name string
(for example, "mpeg4").

Returns:

the codec, or null if we can't find it.

findDecodingCodec

public static Codec findDecodingCodec(Codec.ID id)

Find a codec that can be used for decoding.

Parameters:

id - The id of the codec

Returns:

the codec, or null if we can't find it.

findDecodingCodecByIntID

public static Codec findDecodingCodecByIntID(int id)

Find a codec that can be used for decoding.

Parameters:

id - The id of the codec, as an integer

Returns:

the codec, or null if we can't find it.

findDecodingCodecByName

public static Codec findDecodingCodecByName(String id)

Find a codec that can be used for decoding.

Parameters:

id - The id of the codec, as a FFMPEG short-name string
(for example, "mpeg4")

Returns:

the codec, or null if we can't find it.

guessEncodingCodec

public static Codec guessEncodingCodec(MuxerFormat fmt,
                                       String shortName,
                                       String url,
                                       String mimeType,
                                       MediaDescriptor.Type type)

Ask us to guess an encoding codec based on the inputs
passed in.

You must pass in at least one non null fmt, shortName,
url or mime_type.

Parameters:

fmt - A SinkFormat for the container you'll want to encode into.

shortName - The FFMPEG short name of the codec (e.g. "mpeg4").

url - The URL you'll be writing packets to.

mimeType - The mime type of the container.

type - The codec type.

Returns:

the codec, or null if we can't find it.

getLongName

public String getLongName()

Get the long name for this codec.

Returns:

the long name.

getNumInstalledCodecs

public static int getNumInstalledCodecs()

Capability flags

Get the number of installed codecs on this system.

Returns:

the number of installed codecs.

getInstalledCodec

public static Codec getInstalledCodec(int index)

Get the ICodec at the given index.

Parameters:

index - the index in our list

Returns:

the codec, or null if index < 0 or index >=
#getNumInstalledCodecs()

getNumSupportedVideoFrameRates

public int getNumSupportedVideoFrameRates()

Get the number of frame rates this codec supports for encoding.
Not all codecs will report this number.

Returns:

the number or 0 if we don't know.

getSupportedVideoFrameRate

public Rational getSupportedVideoFrameRate(int index)

Return the supported frame rate at the given index.

Parameters:

index - the index in our list.

Returns:

the frame rate, or null if unknown, if index <0 or
if index >= #getNumSupportedVideoFrameRates()

getNumSupportedVideoPixelFormats

public int getNumSupportedVideoPixelFormats()

Get the number of supported video pixel formats this codec supports
for encoding. Not all codecs will report this.

Returns:

the number or 0 if we don't know.

getSupportedVideoPixelFormat

public PixelFormat.Type getSupportedVideoPixelFormat(int index)

Return the supported video pixel format at the given index.

Parameters:

index - the index in our list.

Returns:

the pixel format, or IPixelFormat.Type#NONE if unknown,
if index <0 or
if index >= #getNumSupportedVideoPixelFormats()

getNumSupportedAudioSampleRates

public int getNumSupportedAudioSampleRates()

Get the number of different audio sample rates this codec supports
for encoding. Not all codecs will report this.

Returns:

the number or 0 if we don't know.

getSupportedAudioSampleRate

public int getSupportedAudioSampleRate(int index)

Return the support audio sample rate at the given index.

Parameters:

index - the index in our list.

Returns:

the sample rate, or 0 if unknown, index < 0 or
index >= #getNumSupportedAudioSampleRates()

getNumSupportedAudioFormats

public int getNumSupportedAudioFormats()

Get the number of different audio sample formats this codec supports
for encoding. Not all codecs will report this.

Returns:

the number or 0 if we don't know.

getSupportedAudioFormat

public AudioFormat.Type getSupportedAudioFormat(int index)

Get the supported sample format at this index.

Parameters:

index - the index in our list.

Returns:

the format, or AudioFormat.Type.SAMPLE_FMT_NONE if
unknown, index < 0 or index >=
#getNumSupportedAudioSampleFormats().

getNumSupportedAudioChannelLayouts

public int getNumSupportedAudioChannelLayouts()

Get the number of different audio channel layouts this codec supports
for encoding. Not all codecs will report this.

Returns:

the number or 0 if we don't know.

getSupportedAudioChannelLayout

public AudioChannel.Layout getSupportedAudioChannelLayout(int index)

Get the supported audio channel layout at this index.

The value returned is a bit flag representing the different
types of audio layout this codec can support. Test the values
by bit-comparing them to the AudioChannel.Layout
enum types.

Parameters:

index - the index

Returns:

the channel layout, or 0 if unknown, index < 0 or
index >= #getNumSupportedAudioChannelLayouts.

getNumSupportedProfiles

public int getNumSupportedProfiles()

Get the number of supported CodecProfiles this codec
supports.

getSupportedProfile

public CodecProfile getSupportedProfile(int index)

Get the supported CodecProfile at this index.

Parameters:

index - the index

Returns:

A CodecProfile, or null if unknown, index < 0
or lindex >= #getNumSupportedProfiles.