io.humble.video

Class Encoder

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.Coder

io.humble.video.Encoder

public class Encoder
extends Coder

Encodes MediaAudio, MediaPicture or MediaSubtitle objects into MediaPacket 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
Encoder	copyReference() Create a new Encoder object that is actually referring to the exact same underlying native object.
void	encode(MediaPacket output, MediaSampled media) Encode the given Media using this encoder. Callers should call this repeatedly on a media object ntil we consume all the media. Also, when done in order to flush the encoder, caller should call this method passing in 0 (null) for media to tell the encoder to flush any data it was keeping a hold of.
void	encodeAudio(MediaPacket output, MediaAudio samples) Encode the given MediaAudio using this encoder. Callers should call this repeatedly on a set of samples until we consume all the samples. Also, when done in order to flush the encoder, caller should call this method passing in 0 (null) for samples to tell the encoder to flush any data it was keeping a hold of.
void	encodeVideo(MediaPacket output, MediaPicture picture) Encode the given MediaPicture using this encoder. The MediaPicture will allocate a buffer to use internally for this, and will free it when the frame destroys itself. Also, when done in order to flush the encoder, caller should call this method passing in 0 (null) for frame to tell the encoder to flush any data it was keeping a hold of.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
long	getNumDroppedFrames() the number of media object the encoder had to drop (i.e.
int	hashCode() Get a hashable value for this object.
static Encoder	make(Codec codec) Create a Encoder that will use the given Codec.
static Encoder	make(Coder src) Creates a Encoder from a given Encoder
void	open(KeyValueBag inputOptions, KeyValueBag unsetOptions) Open this Coder, using the given bag of Codec-specific options.

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, 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 Encoder copyReference()

Create a new Encoder 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.

getNumDroppedFrames

public long getNumDroppedFrames()

the number of media object the encoder had to drop (i.e. skip
encoding) in order to ensure that time stamp values are
monotonically increasing. See https://code.google.com/p/xuggle/issues/detail?id=180
for details on why this is.

make

public static Encoder make(Codec codec)

Create a Encoder that will use the given Codec.

Returns:

a Encoder

Throws:

InvalidArgument - if codec is null or codec cannot decode.

make

public static Encoder make(Coder src)

Creates a Encoder from a given Encoder

Returns:

a Encoder

Throws:

InvalidArgument - if src is null

open

public void open(KeyValueBag inputOptions,
                 KeyValueBag unsetOptions)

Open this Coder, using the given bag of Codec-specific options.

Overrides:

open in class Coder

Parameters:

inputOptions - If non-null, a bag of codec-specific options.

unsetOptions - If non-null, the bag will be emptied and then filled with
the options in inputOptions that were not set.

encodeVideo

public void encodeVideo(MediaPacket output,
                        MediaPicture picture)

Encode the given MediaPicture using this encoder.

The MediaPicture will allocate a buffer to use internally for this, and
will free it when the frame destroys itself.

Also, when done in order to flush the encoder, caller should call
this method passing in 0 (null) for frame to tell the encoder
to flush any data it was keeping a hold of.

Parameters:

output - [out] The packet to encode into. Caller should check
MediaPacket.isComplete() after call to find out if we had enough
information to encode a full packet.

picture - [in] The picture to encode

Note: caller must ensure that output has sufficient space to
contain a full packet. Alas, there is currently no way to
query an encoder to find out the maximum packet size that
can be output (bummer, I know). That leaves the caller two
options. (1) You can call Packet.make() before each encode
call, and then the encoder will automagically create the correct
sized buffer for that call (but if you reuse the packet, it
may be too small for the next caller). Or (2) you can call
Packet.make(int) with a value that will be larger than your
max packet size (in which case you can reuse the packet).

encodeAudio

public void encodeAudio(MediaPacket output,
                        MediaAudio samples)

Encode the given MediaAudio using this encoder.

Callers should call this repeatedly on a set of samples until
we consume all the samples.

Also, when done in order to flush the encoder, caller should call
this method passing in 0 (null) for samples to tell the encoder
to flush any data it was keeping a hold of.

Parameters:

output - [out] The packet to encode into. Caller should check
MediaPacket.isComplete() after call to find out if we had enough
information to encode a full packet.

samples - [in] The samples to consume

Note: caller must ensure that output has sufficient space to
contain a full packet. Alas, there is currently no way to
query an encoder to find out the maximum packet size that
can be output (bummer, I know). That leaves the caller two
options. (1) You can call Packet.make() before each encode
call, and then the encoder will automagically create the correct
sized buffer for that call (but if you reuse the packet, it
may be too small for the next caller). Or (2) you can call
Packet.make(int) with a value that will be larger than your
max packet size (in which case you can reuse the packet).

encode

public void encode(MediaPacket output,
                   MediaSampled media)

Encode the given Media using this encoder.

Callers should call this repeatedly on a media object ntil
we consume all the media.

Also, when done in order to flush the encoder, caller should call
this method passing in 0 (null) for media to tell the encoder
to flush any data it was keeping a hold of.

Parameters:

output - [out] The packet to encode into. Caller should check
MediaPacket.isComplete() after call to find out if we had enough
information to encode a full packet.


Note: caller must ensure that output has sufficient space to
contain a full packet. Alas, there is currently no way to
query an encoder to find out the maximum packet size that
can be output (bummer, I know). That leaves the caller two
options. (1) You can call Packet.make() before each encode
call, and then the encoder will automagically create the correct
sized buffer for that call (but if you reuse the packet, it
may be too small for the next caller). Or (2) you can call
Packet.make(int) with a value that will be larger than your
max packet size (in which case you can reuse the packet).

Throws:

throws - an exception if getCodecType() and the underlying
media object do not align (e.g. if you pass in a MediaPicture but the
CodecType is audio data).