io.humble.video

Class MediaPictureResampler

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.MediaResampler

io.humble.video.MediaPictureResampler

public class MediaPictureResampler
extends MediaResampler

Converts MediaPicture objects of a given width, height and format to a new
width, height or format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPictureResampler.Flag

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

MediaResampler.State

Method Summary

Modifier and Type	Method and Description
MediaPictureResampler	copyReference() Create a new MediaPictureResampler 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.
PixelFormat.Type	getInputFormat() Get the input pixel format.
int	getInputHeight() Get the height in pixels we expect on the input frame to the resampler.
int	getInputWidth() Get the width in pixels we expect on the input frame to the resampler.
PixelFormat.Type	getOutputFormat() Get the output pixel format.
int	getOutputHeight() Get the output height, in pixels.
int	getOutputWidth() Get the output width, in pixels.
int	hashCode() Get a hashable value for this object.
static MediaPictureResampler	make(int outputWidth, int outputHeight, PixelFormat.Type outputFmt, int inputWidth, int inputHeight, PixelFormat.Type inputFmt, int flags) Get a new picture resampler.
void	open() Opens the resampler so it can be ready for resampling. You should NOT set options after you open this object.
int	resample(MediaSampled out, MediaSampled in) Resample in to out based on the resampler parameters. Resamples the in picture based on the parameters set when this resampler was constructed.
int	resamplePicture(MediaPicture out, MediaPicture in) A more precisely typed way to call #resample
String	toString()

Methods inherited from class io.humble.video.MediaResampler

getState

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

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

Overrides:

copyReference in class MediaResampler

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 MediaResampler

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 MediaResampler

Returns:

the hashable value.

toString

public String toString()

Overrides:

toString in class Object

getInputWidth

public int getInputWidth()

Get the width in pixels we expect on the input frame to the resampler.

Returns:

The width we expect on the input frame to the resampler.

getInputHeight

public int getInputHeight()

Get the height in pixels we expect on the input frame to the resampler.

Returns:

The height we expect on the input frame to the resampler.

getInputFormat

public PixelFormat.Type getInputFormat()

Get the input pixel format.

Returns:

The pixel format we expect on the input frame to the resampler.

getOutputWidth

public int getOutputWidth()

Get the output width, in pixels.

Returns:

The width we will resample the output frame to

getOutputHeight

public int getOutputHeight()

Get the output height, in pixels.

Returns:

The height we will resample the output frame to

getOutputFormat

public PixelFormat.Type getOutputFormat()

Get the output pixel format.

Returns:

The pixel format we will resample the output frame to

open

public void open()

Opens the resampler so it can be ready for resampling.
You should NOT set options after you open this object.

resample

public int resample(MediaSampled out,
                    MediaSampled in)

Resample in to out based on the resampler parameters.

Resamples the in picture based on the parameters set when
this resampler was constructed.

Overrides:

resample in class MediaResampler

Parameters:

out - The picture we'll resample to. Check
MediaPicture#isComplete() after the call.

in - The picture we'll resample from.

Throws:

InvalidArgument - if in our out does not match the parameters this
resampler was set with.

resamplePicture

public int resamplePicture(MediaPicture out,
                           MediaPicture in)

A more precisely typed way to call #resample

make

public static MediaPictureResampler make(int outputWidth,
                                         int outputHeight,
                                         PixelFormat.Type outputFmt,
                                         int inputWidth,
                                         int inputHeight,
                                         PixelFormat.Type inputFmt,
                                         int flags)

Get a new picture resampler.

Parameters:

outputWidth - The width in pixels you want to output frame to have.

outputHeight - The height in pixels you want to output frame to have.

outputFmt - The pixel format of the output frame.

inputWidth - The width in pixels the input frame will be in.

inputHeight - The height in pixels the input frame will be in.

inputFmt - The pixel format of the input frame.

Returns:

a new object, or null if we cannot allocate one.