io.humble.video

Class FilterLink

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.FilterLink

public class FilterLink
extends RefCounted

A link between two Filters in a FilterGraph.

Method Summary

Modifier and Type	Method and Description
FilterLink	copyReference() Create a new FilterLink 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.
AudioChannel.Layout	getChannelLayout()
FilterGraph	getFilterGraph() Get the FilterGraph this FilterLink belongs to.
int	getHeight()
Filter	getInputFilter()
String	getInputPadName()
MediaDescriptor.Type	getInputPadType()
MediaDescriptor.Type	getMediaType()
Filter	getOutputFilter()
String	getOutputPadName()
MediaDescriptor.Type	getOutputPadType()
Rational	getPixelAspectRatio()
PixelFormat.Type	getPixelFormat()
AudioFormat.Type	getSampleFormat()
int	getSampleRate()
Rational	getTimeBase() Define the time base used by the PTS of the frames/samples which will pass through this link. During the configuration stage, each filter is supposed to change only the output timebase, while the timebase of the input link is assumed to be an unchangeable property.
int	getWidth()
int	hashCode() Get a hashable value for this object.
void	insertFilter(Filter filter, int srcPadIndex, int dstPadIndex) Insert a filter into this link between the current input and output.

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

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

getFilterGraph

public FilterGraph getFilterGraph()

Get the FilterGraph this FilterLink belongs to.

getInputFilter

public Filter getInputFilter()

Returns:

the input filter for this link.

getInputPadName

public String getInputPadName()

Returns:

the input pad name for this link.

getInputPadType

public MediaDescriptor.Type getInputPadType()

Returns:

the input pad type for this link. Should be the same as #getMediaType().

getOutputFilter

public Filter getOutputFilter()

Returns:

the output filter for this link.

getOutputPadName

public String getOutputPadName()

Returns:

the output pad name for this link.

getOutputPadType

public MediaDescriptor.Type getOutputPadType()

Returns:

the output pad type for this link. Should be the same as #getMediaType().

getMediaType

public MediaDescriptor.Type getMediaType()

Returns:

the MediaDescriptor.Type for this link.

getWidth

public int getWidth()

Returns:

width of video agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_VIDEO.

getHeight

public int getHeight()

Returns:

height of video agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_VIDEO.

getPixelFormat

public PixelFormat.Type getPixelFormat()

Returns:

pixel format of video agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_VIDEO.

getPixelAspectRatio

public Rational getPixelAspectRatio()

Returns:

pixel aspect ratio of video agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_VIDEO.

getChannelLayout

public AudioChannel.Layout getChannelLayout()

Returns:

channel layout agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_AUDIO.

getSampleRate

public int getSampleRate()

Returns:

sample rate agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_AUDIO.

getSampleFormat

public AudioFormat.Type getSampleFormat()

Returns:

sample format agreed between the input filter and output filter if MediaDescriptor.Type = MediaDescriptor.Type.MEDIA_AUDIO.

getTimeBase

public Rational getTimeBase()

Define the time base used by the PTS of the frames/samples
which will pass through this link.
During the configuration stage, each filter is supposed to
change only the output timebase, while the timebase of the
input link is assumed to be an unchangeable property.

Returns:

the timebase

insertFilter

public void insertFilter(Filter filter,
                         int srcPadIndex,
                         int dstPadIndex)

Insert a filter into this link between the current input and output.

Parameters:

filter - filter to insert

srcPadIndex - the index of the pad on filter to connect the output of the start of the prior link to.

dstPadIndex - the index of the pad on filter to connect the input of the end of the prior link to.