io.humble.video

Class BitStreamFilter

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.BitStreamFilter

public class BitStreamFilter
extends RefCounted

Takes a bit stream and filters bytes passed
in to add, remove, or modify the bit-stream.

Method Summary

Modifier and Type	Method and Description
BitStreamFilter	copyReference() Create a new BitStreamFilter 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.
int	filter(Buffer output, int outputOffset, Buffer input, int inputOffset, int inputSize, Coder coder, String args, boolean isKey) Filter the input buffer into the output buffer.
void	filter(MediaPacket packet, String args) Filters a packet in place (i.e.
String	getName() Get the name of this filter.
BitStreamFilterType	getType() Get the type of this filter.
int	hashCode() Get a hashable value for this object.
static BitStreamFilter	make(BitStreamFilterType type) Create a filter given the type.
static BitStreamFilter	make(String filtername) Create a filter given the name.
String	toString() info about this filter object

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

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

toString

public String toString()

info about this filter object

Overrides:

toString in class Object

Returns:

information about this object

make

public static BitStreamFilter make(String filtername)

Create a filter given the name.

Parameters:

filtername - The name of the filter.

See Also:

BitStreamFilterType

make

public static BitStreamFilter make(BitStreamFilterType type)

Create a filter given the type.

Parameters:

type - The type of the filter.

See Also:

BitStreamFilterType

getType

public BitStreamFilterType getType()

Get the type of this filter.

getName

public String getName()

Get the name of this filter.

filter

public int filter(Buffer output,
                  int outputOffset,
                  Buffer input,
                  int inputOffset,
                  int inputSize,
                  Coder coder,
                  String args,
                  boolean isKey)

Filter the input buffer into the output buffer.

Parameters:

output - The output buffer to copy filtered bytes to.

outputOffset - The offset in output to copy data into.

input - The input buffer to filter.

inputOffset - The number of bytes into input to start filtering at.

inputSize - The number of bytes (from inputOffset) to filter.

coder - The Coder context belong to the Stream that this data will eventually get outputted to.

args - String arguments for the filter call. See the FFmpeg documentation or source code.

isKey - Does this data represent a key packet.

Returns:

The number of bytes copied into output once filtering is done.

Throws:

InvalidArgument - if any parameters are invalid.

FfmpegException - if the filtering fails for any reason.

filter

public void filter(MediaPacket packet,
                   String args)

Filters a packet in place (i.e. the prior contents will be replaced
with the filtered data).

This method assumes packet.getCoder() is the coder that is being used
for outputting the packet to a stream. If this is not the case, use
the other filter mechanism and construct packets yourself.

Parameters:

packet - The packet to filter in place.

args - Text arguments for the filter.

Throws:

InvalidArgument - if output is null.

InvalidArgument - if input is null or not complete.