io.humble.video

Class MediaPicture

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Media

io.humble.video.MediaRaw

io.humble.video.MediaSampled

io.humble.video.MediaPicture

public class MediaPicture
extends MediaSampled

Picture (or video) raw data that can be displayed or modified, and also
encoded by Encoder objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPicture.Type The different types of images that we can set.

Field Summary

Fields inherited from class io.humble.video.Media

DEFAULT_TIME_STAMP_FORMAT

Method Summary

Modifier and Type	Method and Description
MediaPicture	copyReference() Create a new MediaPicture 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	getCodedPictureNumber() picture number in bitstream order
Buffer	getData(int plane) Get any underlying raw data available for this object.
int	getDataPlaneSize(int plane) The total number of bytes in #getData() that represent valid image data.
int	getDisplayPictureNumber() picture number in display order
long	getError(int dataPlane) Get the error flags (if any) that the decoder set for this image on any given plane.
PixelFormat.Type	getFormat()
int	getHeight()
int	getLineSize(int plane) The width in pixels of a line of the image in the given plane. The plane from the data.
int	getNumDataPlanes() Returns the number of data planes in this object.
int	getQuality() quality (between 1 (good) and FF_LAMBDA_MAX (bad))
int	getRepeatPicture() When decoding, this signals how much the picture must be delayed. extra_delay = repeat_pict / (2*fps)
MediaPicture.Type	getType() Get the type of picture this object was decoded from when in a encoded stream (or give a hint to an encoder about how you think it should be encoded).
int	getWidth()
int	hashCode() Get a hashable value for this object.
boolean	isComplete() Returns true if the data in this picture is marked as complete.
boolean	isInterlacedFrame() The content of the picture is interlaced.
boolean	isPaletteChanged() Tell user application that palette has changed from previous frame.
boolean	isTopFieldFirst() If the content is interlaced, is top field displayed first.
static MediaPicture	make(Buffer buffer, int width, int height, PixelFormat.Type format) Create a media picture using a buffer as the memory backing it.
static MediaPicture	make(int width, int height, PixelFormat.Type format) Create a media picture.
static MediaPicture	make(MediaPicture src, boolean copy) Create a media picture from src.
void	setCodedPictureNumber(int n) set picture number
void	setComplete(boolean complete) Set this frame to complete.
void	setDisplayPictureNumber(int n) set picture number in display order
void	setInterlacedFrame(boolean val)
void	setPaletteChange(boolean val)
void	setQuality(int q) set quality.
void	setRepeatPicture(int n)
void	setTopFieldFirst(boolean val)
void	setType(MediaPicture.Type type)
String	toString() info about this picture

Methods inherited from class io.humble.video.MediaSampled

getNumSamples

Methods inherited from class io.humble.video.MediaRaw

getBestEffortTimeStamp, getMetaData, getPacketDts, getPacketDuration, getPacketPts, getPacketSize, getPts, getTimeBase, getTimeStamp, isKey, setTimeBase, setTimeStamp

Methods inherited from class io.humble.video.Media

getFormattedTimeStamp, getFormattedTimeStamp

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

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

Overrides:

copyReference in class MediaSampled

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 MediaSampled

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 MediaSampled

Returns:

the hashable value.

toString

public String toString()

info about this picture

Overrides:

toString in class Object

Returns:

information about this picture

make

public static MediaPicture make(int width,
                                int height,
                                PixelFormat.Type format)

Create a media picture.

Parameters:

width - Number of pixels wide.

height - Number of pixels high.

format - PixelFormat.Type of the MediaPicture

Returns:

A MediaPicture with memory allocated for it.

Throws:

InvalidArgument - if width or height or negative, of format is PixelFormat.Type.PIX_FMT_NONE

make

public static MediaPicture make(Buffer buffer,
                                int width,
                                int height,
                                PixelFormat.Type format)

Create a media picture using a buffer as the memory backing it.

Parameters:

buffer - A buffer of data to use for the image.

width - Number of pixels wide.

height - Number of pixels high.

format - PixelFormat.Type of the MediaPicture

Returns:

A MediaPicture with memory allocated for it.

Throws:

InvalidArgument - if buffer is null or too small for the image, width or height or negative, of format is PixelFormat.Type.PIX_FMT_NONE

make

public static MediaPicture make(MediaPicture src,
                                boolean copy)

Create a media picture from src.

Parameters:

src - A source MediaPicture.

copy - If true then all data is copied from src into the new object. If false, then the new object just copies meta-data but references the same underlying buffers.

Returns:

A MediaPicture

Throws:

InvalidArgument - if src is null.

getData

public Buffer getData(int plane)

Get any underlying raw data available for this object.

Parameters:

plane - The plane number if getFormat() is Planar (rather than packed) image data. Pass zero for packed data.

Returns:

The raw data, or null if not accessible.

getDataPlaneSize

public int getDataPlaneSize(int plane)

The total number of bytes in #getData() that represent valid image data.

Returns:

The size in bytes of that plane of image data.

getNumDataPlanes

public int getNumDataPlanes()

Returns the number of data planes in this object.

getLineSize

public int getLineSize(int plane)

The width in pixels of a line of the image in the given plane.
The plane from the data. Not all images have more than one plane. None have more than 4.

Returns:

The width in pixels, or 0 on error.

setComplete

public void setComplete(boolean complete)

Set this frame to complete.

Overrides:

setComplete in class MediaRaw

Parameters:

complete - is the object complete or not.

See Also:

Media.isComplete()

isComplete

public boolean isComplete()

Returns true if the data in this picture is marked as complete.

Overrides:

isComplete in class Media

Returns:

Has setComplete() been called and the buffer populated.

See Also:

#setComplete(int)

getWidth

public int getWidth()

getHeight

public int getHeight()

getFormat

public PixelFormat.Type getFormat()

getCodedPictureNumber

public int getCodedPictureNumber()

picture number in bitstream order

setCodedPictureNumber

public void setCodedPictureNumber(int n)

set picture number

See Also:

getCodedPictureNumber()

getDisplayPictureNumber

public int getDisplayPictureNumber()

picture number in display order

setDisplayPictureNumber

public void setDisplayPictureNumber(int n)

set picture number in display order

See Also:

getDisplayPictureNumber()

getQuality

public int getQuality()

quality (between 1 (good) and FF_LAMBDA_MAX (bad))

setQuality

public void setQuality(int q)

set quality.

See Also:

getQuality()

getError

public long getError(int dataPlane)

Get the error flags (if any) that the decoder set for this image on any given plane.

Parameters:

dataPlane - The plane to search for error flags.

getRepeatPicture

public int getRepeatPicture()

When decoding, this signals how much the picture must be delayed.
extra_delay = repeat_pict / (2*fps)

setRepeatPicture

public void setRepeatPicture(int n)

isInterlacedFrame

public boolean isInterlacedFrame()

The content of the picture is interlaced.

setInterlacedFrame

public void setInterlacedFrame(boolean val)

isTopFieldFirst

public boolean isTopFieldFirst()

If the content is interlaced, is top field displayed first.

setTopFieldFirst

public void setTopFieldFirst(boolean val)

isPaletteChanged

public boolean isPaletteChanged()

Tell user application that palette has changed from previous frame.

setPaletteChange

public void setPaletteChange(boolean val)

getType

public MediaPicture.Type getType()

Get the type of picture this object was decoded from when in a encoded stream
(or give a hint to an encoder about how you think it should be encoded).

setType

public void setType(MediaPicture.Type type)