org.openimaj.video.xuggle

Class XuggleAudio

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.video.xuggle.XuggleAudio

All Implemented Interfaces:

Iterable<SampleChunk>

public class XuggleAudio
extends AudioStream

A wrapper for the Xuggle audio decoding system into the OpenIMAJ audio system.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

8 Jun 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XuggleAudio.ChunkGetter

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
XuggleAudio(File file) Default constructor that takes the file to read.
XuggleAudio(File file, boolean loop) Default constructor that takes the file to read.
XuggleAudio(InputStream stream) Construct a xuggle audio object from the stream.
XuggleAudio(String url) Default constructor that takes the location of a file to read.
XuggleAudio(String u, boolean loop) Default constructor that takes the location of a file to read.
XuggleAudio(URL u) Default constructor that takes the location of a file to read.
XuggleAudio(URL u, boolean loop) Default constructor that takes the location of a file to read.

Method Summary

Modifier and Type	Method and Description
void	close() Close the audio stream.
long	getLength() Returns the length of the audio stream in milliseconds.
SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
void	reset() Reset the audio stream.
void	seek(long timestamp) Seeks the audio to the given timestamp.

Methods inherited from class org.openimaj.audio.AudioStream

iterator

Methods inherited from class org.openimaj.audio.Audio

getFormat, setFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XuggleAudio

public XuggleAudio(File file)

Default constructor that takes the file to read.

Parameters:

file - The file to read.

XuggleAudio

public XuggleAudio(File file,
                   boolean loop)

Default constructor that takes the file to read.

Parameters:

file - The file to read.

loop - Whether to loop indefinitely

XuggleAudio

public XuggleAudio(URL u)

Default constructor that takes the location of a file to read. This can either be a filename or a URL.

Parameters:

u - The URL of the file to read

XuggleAudio

public XuggleAudio(URL u,
                   boolean loop)

Default constructor that takes the location of a file to read. This can either be a filename or a URL.

Parameters:

u - The URL of the file to read

loop - Whether to loop indefinitely

XuggleAudio

public XuggleAudio(String url)

Default constructor that takes the location of a file to read. This can either be a filename or a URL.

Parameters:

url - The URL of the file to read

XuggleAudio

public XuggleAudio(String u,
                   boolean loop)

Default constructor that takes the location of a file to read. This can either be a filename or a URL. The second parameter determines whether the file will loop indefinitely. If so, nextSampleChunk() will never return null; otherwise this method will return null at the end of the video.

Parameters:

u - The URL of the file to read

loop - Whether to loop indefinitely

XuggleAudio

public XuggleAudio(InputStream stream)

Construct a xuggle audio object from the stream.

Parameters:

stream - The stream

Method Detail

nextSampleChunk

public SampleChunk nextSampleChunk()

Retrieve the next SampleChunk from the audio stream.

Specified by:

nextSampleChunk in class AudioStream

Returns:

The next sample chunk in the audio stream.

See Also:

AudioStream.nextSampleChunk()

reset

public void reset()

Reset the audio stream.

Specified by:

reset in class AudioStream

See Also:

AudioStream.reset()

getLength

public long getLength()

Returns the length of the audio stream in milliseconds. If the length is unknown (for a live stream for example), then this method should return -1.

Specified by:

getLength in class AudioStream

Returns:

The length in milliseconds, or -1

See Also:

AudioStream.getLength()

seek

public void seek(long timestamp)

Seeks the audio to the given timestamp. The timestamp of the audio should be checked after calling seek() as the seek method may not succeed if the stream does not support seeking.

Overrides:

seek in class AudioStream

Parameters:

timestamp - The timestamp to seek to

See Also:

AudioStream.seek(long)

close

public void close()

Close the audio stream.