org.bytedeco.javacv

Class FrameFilter

java.lang.Object

org.bytedeco.javacv.FrameFilter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

FFmpegFrameFilter

public abstract class FrameFilter
extends Object
implements Closeable

A frame processor that may filter video and audio frames, or both. After calling start(), we can add frames to the graph with push(Frame) and get the filtered ones with pull().

Author:

Samuel Audet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrameFilter.Exception

Field Summary

Fields

Modifier and Type	Field and Description
protected double	aspectRatio
protected String	filters
protected double	frameRate
protected int	imageHeight
protected int	imageWidth
protected int	pixelFormat

Constructor Summary

Constructors

Constructor and Description
FrameFilter()

Method Summary

Modifier and Type	Method and Description
void	close()
static FrameFilter	createDefault(String filtersDescr, int imageWidth, int imageHeight)
void	flush()
double	getAspectRatio()
String	getFilters()
double	getFrameRate()
int	getImageHeight()
int	getImageWidth()
int	getPixelFormat()
abstract Frame	pull()
abstract void	push(Frame frame)
abstract void	release()
void	restart()
void	setAspectRatio(double aspectRatio)
void	setFilters(String filters)
void	setFrameRate(double frameRate)
void	setImageHeight(int imageHeight)
void	setImageWidth(int imageWidth)
void	setPixelFormat(int pixelFormat)
abstract void	start()
abstract void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filters

protected String filters

imageWidth

protected int imageWidth

imageHeight

protected int imageHeight

pixelFormat

protected int pixelFormat

frameRate

protected double frameRate

aspectRatio

protected double aspectRatio

Constructor Detail

FrameFilter

public FrameFilter()

Method Detail

createDefault

public static FrameFilter createDefault(String filtersDescr,
                                        int imageWidth,
                                        int imageHeight)
                                 throws FrameFilter.Exception

Throws:

FrameFilter.Exception

getFilters

public String getFilters()

setFilters

public void setFilters(String filters)

getImageWidth

public int getImageWidth()

setImageWidth

public void setImageWidth(int imageWidth)

getImageHeight

public int getImageHeight()

setImageHeight

public void setImageHeight(int imageHeight)

getPixelFormat

public int getPixelFormat()

setPixelFormat

public void setPixelFormat(int pixelFormat)

getFrameRate

public double getFrameRate()

setFrameRate

public void setFrameRate(double frameRate)

getAspectRatio

public double getAspectRatio()

setAspectRatio

public void setAspectRatio(double aspectRatio)

start

public abstract void start()
                    throws FrameFilter.Exception

Throws:

FrameFilter.Exception

stop

public abstract void stop()
                   throws FrameFilter.Exception

Throws:

FrameFilter.Exception

push

public abstract void push(Frame frame)
                   throws FrameFilter.Exception

Throws:

FrameFilter.Exception

pull

public abstract Frame pull()
                    throws FrameFilter.Exception

Throws:

FrameFilter.Exception

release

public abstract void release()
                      throws FrameFilter.Exception

Throws:

FrameFilter.Exception

close

public void close()
           throws FrameFilter.Exception

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

FrameFilter.Exception

restart

public void restart()
             throws FrameFilter.Exception

Throws:

FrameFilter.Exception

flush

public void flush()
           throws FrameFilter.Exception

Throws:

FrameFilter.Exception