io.humble.video

Class Decoder

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.Coder

io.humble.video.Decoder

public class Decoder
extends Coder

Decodes MediaPacket objects into MediaAudio, MediaPicture or MediaSubtitle objects.

Nested Class Summary

Nested classes/interfaces inherited from class io.humble.video.Coder

Coder.Flag, Coder.Flag2, Coder.State

Method Summary

Modifier and Type	Method and Description
Decoder	copyReference() Create a new Decoder object that is actually referring to the exact same underlying native object.
int	decode(MediaSampled output, MediaPacket packet, int byteOffset) Decode this packet into output.
int	decodeAudio(MediaAudio output, MediaPacket packet, int byteOffset) Decode this packet into output.
int	decodeVideo(MediaPicture output, MediaPacket packet, int byteOffset) Decode this packet into output. The caller is responsible for allocating the MediaPicture object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
void	flush() Flush this Decoder, getting rid of any cached packets (call after seek). Next packet given to decode should be a key packet.
int	hashCode() Get a hashable value for this object.
static Decoder	make(Codec codec) Create a Decoder that will use the given Codec.
static Decoder	make(Coder src) Creates a Decoder from a given Coder (either an encoder or a decoder).

Methods inherited from class io.humble.video.Coder

getChannelLayout, getChannels, getCodec, getCodecID, getCodecType, getFlag, getFlag2, getFlags, getFlags2, getFrameCount, getFrameSize, getHeight, getPixelFormat, getSampleFormat, getSampleRate, getState, getTimeBase, getWidth, open, setChannelLayout, setChannels, setFlag, setFlag2, setFlags, setFlags2, setHeight, setPixelFormat, setSampleFormat, setSampleRate, setTimeBase, setWidth, toString

Methods inherited from class io.humble.video.Configurable

getNumProperties, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsInt, getPropertyAsLong, getPropertyAsRational, getPropertyAsString, getPropertyMetaData, getPropertyMetaData, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

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 Decoder copyReference()

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

Overrides:

copyReference in class Coder

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 Coder

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 Coder

Returns:

the hashable value.

make

public static Decoder make(Codec codec)

Create a Decoder that will use the given Codec.

Returns:

a Decoder

Throws:

InvalidArgument - if codec is null or codec cannot decode.

make

public static Decoder make(Coder src)

Creates a Decoder from a given Coder (either an encoder or a decoder).

Returns:

a Decoder

Throws:

InvalidArgument - if src is null

flush

public void flush()

Flush this Decoder, getting rid of any cached packets (call after seek).
Next packet given to decode should be a key packet.

decodeAudio

public int decodeAudio(MediaAudio output,
                       MediaPacket packet,
                       int byteOffset)

Decode this packet into output. It will
try to fill up the audio samples object, starting
from the byteOffset inside this packet.

The caller is responsible for allocating the
MediaAudio object. This function will overwrite
any data in the samples object.

Parameters:

output - The MediaAudio we decode to. Caller must check if it is complete on return.

packet - The packet we're attempting to decode from.

byteOffset - Where in the packet payload to start decoding

Returns:

number of bytes actually processed from the packet, or negative for error

decodeVideo

public int decodeVideo(MediaPicture output,
                       MediaPacket packet,
                       int byteOffset)

Decode this packet into output.

The caller is responsible for allocating the
MediaPicture object. This function will potentially
overwrite any data in the frame object, but
you should pass the same MediaPicture into this function
repeatedly until Media.isComplete() is true.

Note on memory for MediaPicture: For a multitude of reasons,
if you created MediaPicture from a buffer, decodeVideo will discard
it and replace it with a buffer that is aligned correctly for different
CPUs and different codecs. If you must have a copy of the image data
in memory managed by you, then pass in a MediaPicture allocated without
a buffer to DecodeVideo, and then copy that into your own media picture.

Parameters:

output - The MediaPicture we decode. Caller must check if it is complete on return.

packet - The packet we're attempting to decode from.

byteOffset - Where in the packet payload to start decoding

Returns:

number of bytes actually processed from the packet, or negative for error

decode

public int decode(MediaSampled output,
                  MediaPacket packet,
                  int byteOffset)

Decode this packet into output. It will
try to fill up the media object, starting
from the byteOffset inside this packet.

The caller is responsible for allocating the
correct underlying Media object. This function will overwrite
any data in the samples object.

Parameters:

output - The Media we decode to. Caller must check if it is complete on return.

packet - The packet we're attempting to decode from.

byteOffset - Where in the packet payload to start decoding

Returns:

number of bytes actually processed from the packet, or negative for error

Throws:

InvalidArgument - if the media type is not compatible with this decoder.

See Also:

decodeVideo
, decodeAudio