Package com.avpkit.core

Class SimpleMediaFile

java.lang.Object

com.avpkit.core.SimpleMediaFile

All Implemented Interfaces:

ISimpleMediaFile

public class SimpleMediaFile
extends java.lang.Object
implements ISimpleMediaFile

An implementation of ISimpleMediaFile. Provides a generic bag of attributes about a SimpleMediaFile.

Constructor Summary

Constructors

Constructor	Description
SimpleMediaFile()	Create a new SimpleMediaFile.
SimpleMediaFile(ISimpleMediaFile src)	Create a new SimpleMediaFile from an existing SimpleMediaFile.

Method Summary

Modifier and Type	Method	Description
int	getAudioBitRate()	Get the audio bit rate
int	getAudioChannels()	Get the number of audio channels
ICodec.ID	getAudioCodec()	Get the audio codec set on this configuration object.
IAudioSamples.Format	getAudioSampleFormat()	Get the audio sample format.
int	getAudioSampleRate()	Get the audio sample rate.
IRational	getAudioTimeBase()	Get the time base used when encoding or decoding audio.
IContainerFormat	getContainerFormat()	Get the container format, if known, for this container.
ITimeValue	getDuration()	Get the duration that we'll assume for the stream we're representing.
java.lang.String	getURL()	Return the URL for this stream.
int	getVideoBitRate()	Get the video bit rate
ICodec.ID	getVideoCodec()	Get the video codec that packets are encoded with.
IRational	getVideoFrameRate()	Get the Video Frame Rate
int	getVideoGlobalQuality()	Get the VideoGlobalQuality setting.
int	getVideoHeight()	Get the video height of video frames broadcasted
int	getVideoNumPicturesInGroupOfPictures()	Get the GOPS.
IPixelFormat.Type	getVideoPixelFormat()	Return the pixel format to use
IRational	getVideoTimeBase()	Get the timebase that packets should be encoded with.
int	getVideoWidth()	Get the video width of video frames broadcasted
boolean	hasAudio()	Tells whether or not the output stream should have audio
boolean	hasVideo()	Tells whether or not the output stream should have video
boolean	isAudioBitRateKnown()	is the audio bit rate known?
boolean	isAudioChannelsKnown()	are the # of audio channels known?
boolean	isAudioSampleRateKnown()	is the audio sample rate known?
boolean	isVideoBitRateKnown()	is the video bit rate known?
boolean	isVideoGlobalQualityKnown()	is the global quality setting known?
boolean	isVideoHeightKnown()	is the video height known?
boolean	isVideoNumPicturesInGroupOfPicturesKnown()	is the MPEG number of pictures in a group of pictures known?
boolean	isVideoPixelFormatKnown()	is the video pixel format known?
boolean	isVideoWidthKnown()	is the video width known?
void	setAudioBitRate(int bitRate)	Set the audio bitrate
void	setAudioBitRateKnown(boolean audioBitRateKnown)	set if the audio bit rate is known.
void	setAudioChannels(int numChannels)	Set the number of audio channels.
void	setAudioChannelsKnown(boolean audioChannelsKnown)	set if the audio channels are known
void	setAudioCodec(ICodec.ID audioCodec)	Set the audio codec to use.
void	setAudioSampleFormat(IAudioSamples.Format aFormat)	Set the audio sample format you want to use in this file.
void	setAudioSampleRate(int sampleRate)	Set the audio sample rate
void	setAudioSampleRateKnown(boolean audioSampleRateKnown)	set if the audio sample rate is known.
void	setAudioTimeBase(IRational aTimeBase)	Set the time base to use when encoding or decoding audio
void	setContainerFormat(IContainerFormat aFormat)	Sets the container format for this stream
void	setDuration(ITimeValue duration)	Set the duration that we'll assume for the stream we're representing.
void	setHasAudio(boolean hasAudio)	Set whether you want the output stream to have audio
void	setHasVideo(boolean hasVideo)	Set whether you want the output stream to have video
void	setURL(java.lang.String uRL)	Set the URL that this stream contains info for.
void	setVideoBitRate(int bitRate)	Set the timebase that we encode video for.
void	setVideoBitRateKnown(boolean videoBitRateKnown)	set if the video bit rate is known.
void	setVideoCodec(ICodec.ID videoCodec)	Set the video codec that packets are encoded with.
void	setVideoFrameRate(IRational frameRate)	Set the Video Frame Rate as a rational.
void	setVideoGlobalQuality(int quality)	Set the default quality quality setting for video.
void	setVideoGlobalQualityKnown(boolean videoGlobalQualityKnown)	set if the global quality setting is known.
void	setVideoHeight(int height)	Set the height of the video frames in broadcasted packets
void	setVideoHeightKnown(boolean videoHeightKnown)	set if the video height is known.
void	setVideoNumPicturesInGroupOfPictures(int gops)	Set the MPEG2 Num Pictures In Group Of Pictures (GOPS) settings
void	setVideoNumPicturesInGroupOfPicturesKnown(boolean videoGOPSKnown)	set if the MPEG number of pictures in a group of pictures is known?
void	setVideoPixelFormat(IPixelFormat.Type pixelFormat)	Sets the pixel format to use
void	setVideoPixelFormatKnown(boolean videoPixelFormatKnown)	set if the video pixel format is known.
void	setVideoTimeBase(IRational timeBase)	Set the TimeBase that video packets are encoded with.
void	setVideoWidth(int width)	Set the width of the video frames in broadcasted packets
void	setVideoWidthKnown(boolean videoWidthKnown)	set if the video width is known.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMediaFile

public SimpleMediaFile()

Create a new SimpleMediaFile.

SimpleMediaFile

public SimpleMediaFile(ISimpleMediaFile src)

Create a new SimpleMediaFile from an existing SimpleMediaFile. All values are shallow copied.

Parameters:

src - The value to copy.

Throws:

java.lang.IllegalArgumentException - if src is null

Method Detail

getAudioBitRate

public int getAudioBitRate()

Get the audio bit rate

Specified by:

getAudioBitRate in interface ISimpleMediaFile

Returns:

bit rate, in Hz.

getAudioChannels

public int getAudioChannels()

Get the number of audio channels

Specified by:

getAudioChannels in interface ISimpleMediaFile

Returns:

number of audio channels

getAudioSampleRate

public int getAudioSampleRate()

Get the audio sample rate.

Specified by:

getAudioSampleRate in interface ISimpleMediaFile

Returns:

sample rate, in Hz.

setAudioBitRate

public void setAudioBitRate(int bitRate)

Set the audio bitrate

Specified by:

setAudioBitRate in interface ISimpleMediaFile

Parameters:

bitRate - bitrate to use

setAudioChannels

public void setAudioChannels(int numChannels)

Set the number of audio channels.

Specified by:

setAudioChannels in interface ISimpleMediaFile

Parameters:

numChannels - Number of channels; only 1 or 2 supported

setAudioSampleRate

public void setAudioSampleRate(int sampleRate)

Set the audio sample rate

Specified by:

setAudioSampleRate in interface ISimpleMediaFile

Parameters:

sampleRate - Audio sample rate in Hz (e.g. 22050)

getAudioCodec

public ICodec.ID getAudioCodec()

Get the audio codec set on this configuration object.

Specified by:

getAudioCodec in interface ISimpleMediaFile

Returns:

The audiocodec. if null, a user may guess the codec from other information.

setAudioCodec

public void setAudioCodec(ICodec.ID audioCodec)

Set the audio codec to use.

Specified by:

setAudioCodec in interface ISimpleMediaFile

Parameters:

audioCodec - The audio codec to use; if null, a user may guess the codec from other information.

getVideoCodec

public ICodec.ID getVideoCodec()

Get the video codec that packets are encoded with.

Specified by:

getVideoCodec in interface ISimpleMediaFile

Returns:

the video codec

getVideoHeight

public int getVideoHeight()

Get the video height of video frames broadcasted

Specified by:

getVideoHeight in interface ISimpleMediaFile

Returns:

height in pixels

getVideoWidth

public int getVideoWidth()

Get the video width of video frames broadcasted

Specified by:

getVideoWidth in interface ISimpleMediaFile

Returns:

width in pixels

getVideoBitRate

public int getVideoBitRate()

Get the video bit rate

Specified by:

getVideoBitRate in interface ISimpleMediaFile

Returns:

video bit rate

setVideoCodec

public void setVideoCodec(ICodec.ID videoCodec)

Set the video codec that packets are encoded with.

Specified by:

setVideoCodec in interface ISimpleMediaFile

Parameters:

videoCodec - video codec that packets are encoded with.

setVideoHeight

public void setVideoHeight(int height)

Set the height of the video frames in broadcasted packets

Specified by:

setVideoHeight in interface ISimpleMediaFile

Parameters:

height - height in pixels

setVideoWidth

public void setVideoWidth(int width)

Set the width of the video frames in broadcasted packets

Specified by:

setVideoWidth in interface ISimpleMediaFile

Parameters:

width - width in pixels

getVideoTimeBase

public IRational getVideoTimeBase()

Get the timebase that packets should be encoded with.

Specified by:

getVideoTimeBase in interface ISimpleMediaFile

Returns:

The timebase or null if unknown.

setVideoTimeBase

public void setVideoTimeBase(IRational timeBase)

Set the TimeBase that video packets are encoded with.

Specified by:

setVideoTimeBase in interface ISimpleMediaFile

Parameters:

timeBase - The timebase to use with this configuration, or null if unknowbn.

setVideoBitRate

public void setVideoBitRate(int bitRate)

Set the timebase that we encode video for.

Specified by:

setVideoBitRate in interface ISimpleMediaFile

Parameters:

bitRate - The bitrate to use for encoding video

getVideoPixelFormat

public IPixelFormat.Type getVideoPixelFormat()

Return the pixel format to use

Specified by:

getVideoPixelFormat in interface ISimpleMediaFile

Returns:

The pixel format.

setVideoPixelFormat

public void setVideoPixelFormat(IPixelFormat.Type pixelFormat)

Sets the pixel format to use

Specified by:

setVideoPixelFormat in interface ISimpleMediaFile

Parameters:

pixelFormat - Pixel format

getVideoFrameRate

public IRational getVideoFrameRate()

Get the Video Frame Rate

Specified by:

getVideoFrameRate in interface ISimpleMediaFile

Returns:

The video frame rate, or null if unknown

See Also:

ISimpleMediaFile.setVideoFrameRate(IRational)

getVideoGlobalQuality

public int getVideoGlobalQuality()

Get the VideoGlobalQuality setting.

Specified by:

getVideoGlobalQuality in interface ISimpleMediaFile

Returns:

The global quality for video

See Also:

ISimpleMediaFile.setVideoGlobalQuality(int)

getVideoNumPicturesInGroupOfPictures

public int getVideoNumPicturesInGroupOfPictures()

Get the GOPS.

Specified by:

getVideoNumPicturesInGroupOfPictures in interface ISimpleMediaFile

Returns:

The GOPS

See Also:

ISimpleMediaFile.setVideoNumPicturesInGroupOfPictures(int)

setVideoFrameRate

public void setVideoFrameRate(IRational frameRate)

Set the Video Frame Rate as a rational.

Specified by:

setVideoFrameRate in interface ISimpleMediaFile

Parameters:

frameRate - The frame rate (e.g. 15/1), or null if unknown.

setVideoGlobalQuality

public void setVideoGlobalQuality(int quality)

Set the default quality quality setting for video. 0 is highest quality. > 0 is decreasing quality.

Specified by:

setVideoGlobalQuality in interface ISimpleMediaFile

Parameters:

quality - The quality to use.

setVideoNumPicturesInGroupOfPictures

public void setVideoNumPicturesInGroupOfPictures(int gops)

Set the MPEG2 Num Pictures In Group Of Pictures (GOPS) settings

Specified by:

setVideoNumPicturesInGroupOfPictures in interface ISimpleMediaFile

Parameters:

gops - Set the GOPS

hasAudio

public boolean hasAudio()

Tells whether or not the output stream should have audio

Specified by:

hasAudio in interface ISimpleMediaFile

Returns:

Should the output stream have audio?

hasVideo

public boolean hasVideo()

Tells whether or not the output stream should have video

Specified by:

hasVideo in interface ISimpleMediaFile

Returns:

Should the output stream have video?

setHasAudio

public void setHasAudio(boolean hasAudio)

Set whether you want the output stream to have audio

Specified by:

setHasAudio in interface ISimpleMediaFile

Parameters:

hasAudio - Whether you want the output stream to have audio

setHasVideo

public void setHasVideo(boolean hasVideo)

Set whether you want the output stream to have video

Specified by:

setHasVideo in interface ISimpleMediaFile

Parameters:

hasVideo - Whether you want the output stream to have video

getContainerFormat

public IContainerFormat getContainerFormat()

Get the container format, if known, for this container.

Specified by:

getContainerFormat in interface ISimpleMediaFile

Returns:

The container format

setContainerFormat

public void setContainerFormat(IContainerFormat aFormat)

Sets the container format for this stream

Specified by:

setContainerFormat in interface ISimpleMediaFile

Parameters:

aFormat - The container format

getAudioTimeBase

public IRational getAudioTimeBase()

Get the time base used when encoding or decoding audio.

Specified by:

getAudioTimeBase in interface ISimpleMediaFile

Returns:

the timebase, or null if unknown.

setAudioTimeBase

public void setAudioTimeBase(IRational aTimeBase)

Set the time base to use when encoding or decoding audio

Specified by:

setAudioTimeBase in interface ISimpleMediaFile

Parameters:

aTimeBase - The timebase to use, or null if unknown.

setAudioBitRateKnown

public void setAudioBitRateKnown(boolean audioBitRateKnown)

set if the audio bit rate is known.

Specified by:

setAudioBitRateKnown in interface ISimpleMediaFile

Parameters:

audioBitRateKnown - the audioBitRateKnown to set

isAudioBitRateKnown

public boolean isAudioBitRateKnown()

is the audio bit rate known?

Specified by:

isAudioBitRateKnown in interface ISimpleMediaFile

Returns:

the audioBitRateKnown

setAudioChannelsKnown

public void setAudioChannelsKnown(boolean audioChannelsKnown)

set if the audio channels are known

Specified by:

setAudioChannelsKnown in interface ISimpleMediaFile

Parameters:

audioChannelsKnown - the audioChannelsKnown to set

isAudioChannelsKnown

public boolean isAudioChannelsKnown()

are the # of audio channels known?

Specified by:

isAudioChannelsKnown in interface ISimpleMediaFile

Returns:

the audioChannelsKnown

setAudioSampleRateKnown

public void setAudioSampleRateKnown(boolean audioSampleRateKnown)

set if the audio sample rate is known.

Specified by:

setAudioSampleRateKnown in interface ISimpleMediaFile

Parameters:

audioSampleRateKnown - the audioSampleRateKnown to set

isAudioSampleRateKnown

public boolean isAudioSampleRateKnown()

is the audio sample rate known?

Specified by:

isAudioSampleRateKnown in interface ISimpleMediaFile

Returns:

the audioSampleRateKnown

setVideoHeightKnown

public void setVideoHeightKnown(boolean videoHeightKnown)

set if the video height is known.

Specified by:

setVideoHeightKnown in interface ISimpleMediaFile

Parameters:

videoHeightKnown - the videoHeightKnown to set

isVideoHeightKnown

public boolean isVideoHeightKnown()

is the video height known?

Specified by:

isVideoHeightKnown in interface ISimpleMediaFile

Returns:

the videoHeightKnown

setVideoWidthKnown

public void setVideoWidthKnown(boolean videoWidthKnown)

set if the video width is known.

Specified by:

setVideoWidthKnown in interface ISimpleMediaFile

Parameters:

videoWidthKnown - the videoWidthKnown to set

isVideoWidthKnown

public boolean isVideoWidthKnown()

is the video width known?

Specified by:

isVideoWidthKnown in interface ISimpleMediaFile

Returns:

the videoWidthKnown

setVideoBitRateKnown

public void setVideoBitRateKnown(boolean videoBitRateKnown)

set if the video bit rate is known.

Specified by:

setVideoBitRateKnown in interface ISimpleMediaFile

Parameters:

videoBitRateKnown - the videoBitRateKnown to set

isVideoBitRateKnown

public boolean isVideoBitRateKnown()

is the video bit rate known?

Specified by:

isVideoBitRateKnown in interface ISimpleMediaFile

Returns:

the videoBitRateKnown

setVideoNumPicturesInGroupOfPicturesKnown

public void setVideoNumPicturesInGroupOfPicturesKnown(boolean videoGOPSKnown)

set if the MPEG number of pictures in a group of pictures is known?

Specified by:

setVideoNumPicturesInGroupOfPicturesKnown in interface ISimpleMediaFile

Parameters:

videoGOPSKnown - the videoGOPSKnown to set

isVideoNumPicturesInGroupOfPicturesKnown

public boolean isVideoNumPicturesInGroupOfPicturesKnown()

is the MPEG number of pictures in a group of pictures known?

Specified by:

isVideoNumPicturesInGroupOfPicturesKnown in interface ISimpleMediaFile

Returns:

the videoGOPSKnown

setVideoGlobalQualityKnown

public void setVideoGlobalQualityKnown(boolean videoGlobalQualityKnown)

set if the global quality setting is known.

Specified by:

setVideoGlobalQualityKnown in interface ISimpleMediaFile

Parameters:

videoGlobalQualityKnown - the videoGlobalQualityKnown to set

isVideoGlobalQualityKnown

public boolean isVideoGlobalQualityKnown()

is the global quality setting known?

Specified by:

isVideoGlobalQualityKnown in interface ISimpleMediaFile

Returns:

the videoGlobalQualityKnown

setVideoPixelFormatKnown

public void setVideoPixelFormatKnown(boolean videoPixelFormatKnown)

set if the video pixel format is known.

Specified by:

setVideoPixelFormatKnown in interface ISimpleMediaFile

Parameters:

videoPixelFormatKnown - the videoPixelFormatKnown to set

isVideoPixelFormatKnown

public boolean isVideoPixelFormatKnown()

is the video pixel format known?

Specified by:

isVideoPixelFormatKnown in interface ISimpleMediaFile

Returns:

the videoPixelFormatKnown

setDuration

public void setDuration(ITimeValue duration)

Set the duration that we'll assume for the stream we're representing.

Specified by:

setDuration in interface ISimpleMediaFile

Parameters:

duration - the duration to assume for this file. null means unknown.

getDuration

public ITimeValue getDuration()

Get the duration that we'll assume for the stream we're representing.

Specified by:

getDuration in interface ISimpleMediaFile

Returns:

the duration, or null if unknown.

setURL

public void setURL(java.lang.String uRL)

Set the URL that this stream contains info for.

Specified by:

setURL in interface ISimpleMediaFile

Parameters:

uRL - The url, including protocol string, or null if unknown.

getURL

public java.lang.String getURL()

Return the URL for this stream.

Specified by:

getURL in interface ISimpleMediaFile

Returns:

The URL, or null if unknown.

getAudioSampleFormat

public IAudioSamples.Format getAudioSampleFormat()

Get the audio sample format.

Specified by:

getAudioSampleFormat in interface ISimpleMediaFile

Returns:

The audio sample format. Defaults to IAudioSamples.Format.FMT_S16 if not specified.

setAudioSampleFormat

public void setAudioSampleFormat(IAudioSamples.Format aFormat)

Set the audio sample format you want to use in this file.

Specified by:

setAudioSampleFormat in interface ISimpleMediaFile

Parameters:

aFormat - The sample format to use.