io.humble.video

Class Muxer

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.Container

io.humble.video.Muxer

public class Muxer
extends Container

A Container that MediaPacket objects can be written to.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Muxer.State Muxers can only be in one of these states.

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

Container.Flag

Method Summary

Modifier and Type	Method and Description
MuxerStream	addNewStream(Coder coder) Adds a new stream that will have packets written to it. Note on thread safety: Callers must ensure that the coder is not encoding or decoding packets at the same time that Muxer#open or Muxer#close is being called.
void	close() Close the muxer and write any trailers. Note: Calls MUST call this method -- it will not automatically be called when the object is finalized as some muxers struggle when you write trailers on a different thread (the finalizer thread) than the header was written on.
Muxer	copyReference() Create a new Muxer 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.
MuxerFormat	getFormat() Get the MuxerFormat associated with this Muxer or null if unknown.
int	getNumStreams() Get the number of streams in this container.
int	getOutputBufferLength() Return the output buffer length.
Muxer.State	getState() Get the current state of the Muxer.
MuxerStream	getStream(int position) Get the MuxerStream at the given position.
String	getURL() Get the URL the Muxer was opened with. May return null if unknown.
int	hashCode() Get a hashable value for this object.
static Muxer	make(String filename, MuxerFormat format, String formatName) Creates a new muxer. One of the three passed in parameter must be non-null.
void	open(KeyValueBag inputOptions, KeyValueBag outputOptions) Open the Muxer and write any headers.
void	setOutputBufferLength(int size) Set the buffer length Humble Video will suggest to FFMPEG for writing output data. If called when a Container is open, the call is ignored and -1 is returned.
String	toString()
boolean	write(MediaPacket packet, boolean forceInterleave) Writes the given packet to the Muxer.

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

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

Overrides:

copyReference in class Container

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 Container

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 Container

Returns:

the hashable value.

toString

public String toString()

Overrides:

toString in class Container

make

public static Muxer make(String filename,
                         MuxerFormat format,
                         String formatName)

Creates a new muxer.

One of the three passed in parameter must be non-null. If the muxer requires a URL to write to,
then that must be specified.

Parameters:

format - If non null, this will be the format this muxer assumes it is writting packets in.

filename - The filename/url to open. If format is null, this will also be examined to guess actual format.

formatName - The formatname of the muxer to use. This will only be examined if format is null.

Returns:

a Muxer

Throws:

InvalidArgument - if all parameters are null.

getURL

public String getURL()

Get the URL the Muxer was opened with.
May return null if unknown.

Returns:

the URL opened, or null.

getFormat

public MuxerFormat getFormat()

Get the MuxerFormat associated with this Muxer
or null if unknown.

getState

public Muxer.State getState()

Get the current state of the Muxer.

open

public void open(KeyValueBag inputOptions,
                 KeyValueBag outputOptions)
          throws InterruptedException,
                 IOException

Open the Muxer and write any headers.

Parameters:

inputOptions - muxer-specific options to set before opening the muxer. Can be null.

outputOptions - if non null, the passed in bag will be emptied, and the filled
with any options from inputOptions that could not be set on the muxer.

Throws:

InterruptedException

IOException

close

public void close()

Close the muxer and write any trailers.

Note: Calls MUST call this method -- it will not automatically be called
when the object is finalized as some muxers struggle when you write trailers
on a different thread (the finalizer thread) than the header was written on.

getNumStreams

public int getNumStreams()
                  throws InterruptedException,
                         IOException

Get the number of streams in this container.

Overrides:

getNumStreams in class Container

Returns:

The number of streams in this container.

Throws:

InterruptedException

IOException

setOutputBufferLength

public void setOutputBufferLength(int size)

Set the buffer length Humble Video will suggest to FFMPEG for writing output data.

If called when a Container is open, the call is ignored and -1 is returned.

Parameters:

size - The suggested buffer size.

Throws:

InvalidArgument - if size <= 0

getOutputBufferLength

public int getOutputBufferLength()

Return the output buffer length.

Returns:

The input buffer length Humble Video told FFMPEG to assume.
0 means FFMPEG should choose it's own size (and it'll probably be 32768).

addNewStream

public MuxerStream addNewStream(Coder coder)

Adds a new stream that will have packets written to it.

Note on thread safety: Callers must ensure that the coder is not encoding or decoding
packets at the same time that Muxer#open or Muxer#close is being called.

Parameters:

coder - The coder that will be used for packets written to this stream.

Throws:

InvalidArgument - if encoder is null.

InvalidArgument - if encoder is not open.

getStream

public MuxerStream getStream(int position)
                      throws InterruptedException,
                             IOException

Get the MuxerStream at the given position.

Throws:

InterruptedException

IOException

write

public boolean write(MediaPacket packet,
                     boolean forceInterleave)

Writes the given packet to the Muxer.

Parameters:

packet - The packet to write.

forceInterleave - If true, this Muxer will ensure that all packets are interleaved across streams
(i.e. monotonically increasing timestamps in the Muxer container). If false, then the caller
is responsible for ensuring the interleaving is valid for the container. Note this method is faster
if forceInterleave is false.

Returns:

true if all data has been flushed, false if data remains to be flushed.

Throws:

InvalidArgument - if packet is null.

InvalidArgument - if packet is not complete.

RuntimeException - for other errors.