io.humble.video

Class FilterGraph

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.FilterGraph

public class FilterGraph
extends Configurable

Creates a graph (or map) of Filter objects that can modify MediaRaw
objects to do lots of advanced stuff like edge-detection, cropping,
blurring, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterGraph.AutoConvertFlag
static class	FilterGraph.State States a graph can be in.

Method Summary

Modifier and Type	Method and Description
FilterAudioSink	addAudioSink(String name, int sampleRate, AudioChannel.Layout channelLayout, AudioFormat.Type format) Add a FilterAudioSink.
FilterAudioSource	addAudioSource(String name, int sampleRate, AudioChannel.Layout channelLayout, AudioFormat.Type format, Rational timeBase) Add a FilterAudioSource.
Filter	addFilter(FilterType type, String name) Add a filter with the given name to the graph.
FilterPictureSink	addPictureSink(String name, PixelFormat.Type format) Add a FilterPictureSink.
FilterPictureSource	addPictureSource(String name, int width, int height, PixelFormat.Type format, Rational timeBase, Rational pixelAspectRatio) Add a FilterPictureSource.
FilterGraph	copyReference() Create a new FilterGraph 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.
FilterGraph.AutoConvertFlag	getAutoConvert()
String	getDisplayString()
Filter	getFilter(String name)
int	getNumSinks()
int	getNumSources()
FilterSink	getSink(int index)
FilterSink	getSink(String name)
FilterSource	getSource(int index)
FilterSource	getSource(String name)
FilterGraph.State	getState()
int	hashCode() Get a hashable value for this object.
static FilterGraph	make() Creates a new FilterGraph.
void	open(String filterDescription) Add a graph described by a string to a graph.
void	queueCommand(String target, String command, String arguments, int flags, double ts) Queue a command for one or more filter instances.
String	sendCommand(String target, String command, String arguments, int flags)
void	setAutoConvert(FilterGraph.AutoConvertFlag value) Should this graph auto-convert audio or pictures into the formats different filters require (rather than require the user to construct a graph with all filters sets correctly).

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, toString, wait, wait, wait

Method Detail

copyReference

public FilterGraph copyReference()

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

Overrides:

copyReference in class Configurable

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 Configurable

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 Configurable

Returns:

the hashable value.

make

public static FilterGraph make()

Creates a new FilterGraph.

addFilter

public Filter addFilter(FilterType type,
                        String name)

Add a filter with the given name to the graph.

Returns:

An object that refers to the new filter.

getFilter

public Filter getFilter(String name)

Returns:

the filter with the given name, or null if not found.

addAudioSource

public FilterAudioSource addAudioSource(String name,
                                        int sampleRate,
                                        AudioChannel.Layout channelLayout,
                                        AudioFormat.Type format,
                                        Rational timeBase)

Add a FilterAudioSource.

Parameters:

name - the name; must be unique in graph

timeBase - timebase of frames that will be input. If null 1/sampleRate is assumed.

sampleRate - the audio sample rate

format - the sample format

Returns:

The FilterSource that was added.

Throws:

RuntimeException - if name is already in graph.

InvalidArgument - if any argument is invalid.

addPictureSource

public FilterPictureSource addPictureSource(String name,
                                            int width,
                                            int height,
                                            PixelFormat.Type format,
                                            Rational timeBase,
                                            Rational pixelAspectRatio)

Add a FilterPictureSource.

Parameters:

name - the name; must be unique in graph

width - the width in pixels of MediaPicture objects that will be added to this source.

height - the height in pixels of MediaPicture objects that will be added to this source.

format - the pixel format

timeBase - timebase of frames that will be input. If null, 1/Global.DEFAULT_PTS_PER_SECOND is assumed.

pixelAspectRatio - pixel aspect ratio. If null, 1/1 is assumed.

Returns:

The FilterSource that was added.

Throws:

RuntimeException - if name is already in graph.

InvalidArgument - if any argument is invalid.

addAudioSink

public FilterAudioSink addAudioSink(String name,
                                    int sampleRate,
                                    AudioChannel.Layout channelLayout,
                                    AudioFormat.Type format)

Add a FilterAudioSink.

Parameters:

name - the name; must be unique in graph

sampleRate - the audio sample rate

format - the sample format

Returns:

The FilterAudioSink that was added.

Throws:

RuntimeException - if name is already in graph.

InvalidArgument - if any argument is invalid.

addPictureSink

public FilterPictureSink addPictureSink(String name,
                                        PixelFormat.Type format)

Add a FilterPictureSink.

Parameters:

name - the name; must be unique in graph

format - the pixel format desired of pictures taken from this sink.

Returns:

The FilterPictureSink that was added.

Throws:

RuntimeException - if name is already in graph.

InvalidArgument - if any argument is invalid.

getNumSources

public int getNumSources()

Returns:

number of FilterSource added so far.

getSource

public FilterSource getSource(int index)

Parameters:

index - The n'th of #getNumSoruces() FilterSources attached to this FilterGraph.

Returns:

the FilterSource

Throws:

InvalidArgument - if index < 0 || index >= #getNumSources()

getSource

public FilterSource getSource(String name)

Parameters:

name - unique name of a FilterSource in this FilterGraph. Should have been added with #addSource(FilterSource,String).

Throws:

PropertyNotFoundException - if not in graph.

getNumSinks

public int getNumSinks()

Returns:

number of FilterSink added so far.

getSink

public FilterSink getSink(int index)

Parameters:

index - The n'th of #getNumSoruces() FilterSinks attached to this FilterGraph.

Returns:

the FilterSink

Throws:

InvalidArgument - if index < 0 || index >= #getNumSinks()

getSink

public FilterSink getSink(String name)

Parameters:

name - unique name of a FilterSink in this FilterGraph. Should have been added with #addSink(FilterSink,String).

Throws:

PropertyNotFoundException - if not in graph.

setAutoConvert

public void setAutoConvert(FilterGraph.AutoConvertFlag value)

Should this graph auto-convert audio or pictures into the formats
different filters require (rather than require the user to construct
a graph with all filters sets correctly).

Parameters:

value - whether to auto-convert with MediaPictureResampler or MediaAudioResampler objects.

getAutoConvert

public FilterGraph.AutoConvertFlag getAutoConvert()

Returns:

does this graph auto convert MediaPicture and MediaRaw objects to different
dimensions/sample-rates/channels/etc. when
pulling them through the graph.

open

public void open(String filterDescription)

Add a graph described by a string to a graph. For any Sinks or Sources
the caller must have called #addSource or #addSink before
this call.

Parameters:

filterDescription - The filter string to be parsed, in FFmpeg libavfilter format.

Throws:

RuntimeException - if any inputs or outputs are open (i.e. each filter
in the graph must either point to another filter on all inputs or outputs, or point to
a FilterSink or FilterSource when done).

sendCommand

public String sendCommand(String target,
                          String command,
                          String arguments,
                          int flags)

queueCommand

public void queueCommand(String target,
                         String command,
                         String arguments,
                         int flags,
                         double ts)

Queue a command for one or more filter instances.

Parameters:

target - the filter(s) to which the command should be sent
"all" sends to all filters
otherwise it can be a filter or filter instance name
which will send the command to all matching filters.

command - the command to sent, for handling simplicity all commands must be alphanummeric only

arguments - the argument for the command

ts - time at which the command should be sent to the filter

Note: As this executes commands after this function returns, no return code
from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.

getDisplayString

public String getDisplayString()

getState

public FilterGraph.State getState()