com.tagtraum.ffsampledsp

Class FFAudioFileReader

java.lang.Object

javax.sound.sampled.spi.AudioFileReader

com.tagtraum.ffsampledsp.FFAudioFileReader

public class FFAudioFileReader
extends AudioFileReader

Open URLs/files or streams and returns a AudioFileFormat instance.

Author:

Hendrik Schreiber

Constructor Summary

Constructors

Constructor and Description
FFAudioFileReader() Creates a new FFAudioFileReader.

Method Summary

Modifier and Type	Method and Description
AudioFileFormat	getAudioFileFormat(File file)
AudioFileFormat	getAudioFileFormat(InputStream stream)
AudioFileFormat	getAudioFileFormat(URL url)
AudioFileFormat[]	getAudioFileFormats(File file) Returns one or more AudioFileFormats for the given file.
AudioFileFormat[]	getAudioFileFormats(InputStream stream) Returns all AudioFileFormats detected in the given stream.
AudioFileFormat[]	getAudioFileFormats(URL url) Returns one or more AudioFileFormats for the given file.
AudioInputStream	getAudioInputStream(File file)
AudioInputStream	getAudioInputStream(File file, int streamIndex) Allows you to open a specific audio stream from the given file.
AudioInputStream	getAudioInputStream(File file, int streamIndex, int fileBufferSize) Allows you to open a specific audio stream from the given file with an explicit file I/O buffer size.
AudioInputStream	getAudioInputStream(InputStream stream)
AudioInputStream	getAudioInputStream(InputStream stream, int streamIndex) Allows you to open a specific audio stream from the given stream.
AudioInputStream	getAudioInputStream(URL url)
AudioInputStream	getAudioInputStream(URL url, int streamIndex) Allows you to open a specific audio stream from the given URL.
AudioInputStream	getAudioInputStream(URL url, int streamIndex, int fileBufferSize) Allows you to open a specific audio stream from the given URL with an explicit file I/O buffer size.

Methods inherited from class java.lang.Object

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

Constructor Detail

FFAudioFileReader

public FFAudioFileReader()

Creates a new FFAudioFileReader.

Method Detail

getAudioFileFormats

public AudioFileFormat[] getAudioFileFormats(InputStream stream)
                                      throws UnsupportedAudioFileException,
                                             IOException

Returns all AudioFileFormats detected in the given stream. The stream must support InputStream.mark(int).

Parameters:

stream - mark-supporting input stream to probe

Returns:

array of detected audio file formats

Throws:

UnsupportedAudioFileException - if the stream cannot be recognised as a supported format

IOException - if an I/O error occurs or the stream does not support mark

getAudioFileFormat

public AudioFileFormat getAudioFileFormat(InputStream stream)
                                   throws UnsupportedAudioFileException,
                                          IOException

Specified by:

getAudioFileFormat in class AudioFileReader

Throws:

UnsupportedAudioFileException

IOException

getAudioFileFormat

public AudioFileFormat getAudioFileFormat(File file)
                                   throws UnsupportedAudioFileException,
                                          IOException

Specified by:

getAudioFileFormat in class AudioFileReader

Throws:

UnsupportedAudioFileException

IOException

getAudioFileFormats

public AudioFileFormat[] getAudioFileFormats(File file)
                                      throws UnsupportedAudioFileException,
                                             IOException

Returns one or more AudioFileFormats for the given file. Multiple objects are returned, if the file contains multiple streams, e.g. for STEM files.

Parameters:

file - file

Returns:

one or more AudioFileFormats for the given URL

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

See Also:

www.stems-music.com, getAudioFileFormat(File)

getAudioFileFormats

public AudioFileFormat[] getAudioFileFormats(URL url)
                                      throws UnsupportedAudioFileException,
                                             IOException

Returns one or more AudioFileFormats for the given file. Multiple objects are returned, if the file contains multiple streams, e.g. for Stem files.

Parameters:

url - url

Returns:

one or more AudioFileFormats for the given URL

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

See Also:

www.stems-music.com, getAudioFileFormat(URL)

getAudioFileFormat

public AudioFileFormat getAudioFileFormat(URL url)
                                   throws UnsupportedAudioFileException,
                                          IOException

Specified by:

getAudioFileFormat in class AudioFileReader

Throws:

UnsupportedAudioFileException

IOException

getAudioInputStream

public AudioInputStream getAudioInputStream(InputStream stream)
                                     throws UnsupportedAudioFileException,
                                            IOException

Specified by:

getAudioInputStream in class AudioFileReader

Throws:

UnsupportedAudioFileException

IOException

getAudioInputStream

public AudioInputStream getAudioInputStream(URL url)
                                     throws UnsupportedAudioFileException,
                                            IOException

Specified by:

getAudioInputStream in class AudioFileReader

Throws:

UnsupportedAudioFileException

IOException

getAudioInputStream

public AudioInputStream getAudioInputStream(File file)
                                     throws UnsupportedAudioFileException,
                                            IOException

Specified by:

getAudioInputStream in class AudioFileReader

Throws:

UnsupportedAudioFileException

IOException

getAudioInputStream

public AudioInputStream getAudioInputStream(InputStream stream,
                                            int streamIndex)
                                     throws UnsupportedAudioFileException,
                                            IOException

Allows you to open a specific audio stream from the given stream. Useful for Stems.

Parameters:

stream - stream

streamIndex - audio stream index

Returns:

audio stream

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

IndexOutOfBoundsException - if the index is not valid.

See Also:

getAudioInputStream(URL), getAudioInputStream(File, int)

getAudioInputStream

public AudioInputStream getAudioInputStream(URL url,
                                            int streamIndex)
                                     throws UnsupportedAudioFileException,
                                            IOException

Allows you to open a specific audio stream from the given URL. Useful for Stems.

The FFmpeg file I/O buffer size is determined by the system property, falling back to FFURLInputStream.DEFAULT_FILE_BUFFER_SIZE if the property is not set.

Parameters:

url - url

streamIndex - audio stream index

Returns:

audio stream

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

IndexOutOfBoundsException - if the index is not valid.

See Also:

getAudioInputStream(URL), getAudioInputStream(File, int), getAudioInputStream(URL, int, int)

getAudioInputStream

public AudioInputStream getAudioInputStream(URL url,
                                            int streamIndex,
                                            int fileBufferSize)
                                     throws UnsupportedAudioFileException,
                                            IOException

Allows you to open a specific audio stream from the given URL with an explicit file I/O buffer size. Useful for Stems.

The fileBufferSize controls the size of the FFmpeg internal read buffer, passed as AVFormatContext.io_buffer_size. Larger values reduce system-call overhead and improve throughput for bulk transcoding or analysis at the cost of higher per-stream memory use. Use FFURLInputStream.DEFAULT_FILE_BUFFER_SIZE (1 MB) as a baseline for bulk work.

Parameters:

url - url

streamIndex - audio stream index

fileBufferSize - FFmpeg file I/O buffer size in bytes; must be positive

Returns:

audio stream

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

IndexOutOfBoundsException - if the index is not valid.

IllegalArgumentException - if fileBufferSize is not positive

See Also:

getAudioInputStream(URL, int), FFURLInputStream.DEFAULT_FILE_BUFFER_SIZE, FFURLInputStream.FILE_BUFFER_SIZE_PROPERTY

getAudioInputStream

public AudioInputStream getAudioInputStream(File file,
                                            int streamIndex)
                                     throws UnsupportedAudioFileException,
                                            IOException

Allows you to open a specific audio stream from the given file. Useful for Stems.

The FFmpeg file I/O buffer size is determined by the system property, falling back to FFURLInputStream.DEFAULT_FILE_BUFFER_SIZE if the property is not set.

Parameters:

file - file

streamIndex - audio stream index

Returns:

audio stream

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

IndexOutOfBoundsException - if the index is not valid.

See Also:

getAudioInputStream(URL, int), getAudioInputStream(File), getAudioInputStream(File, int, int)

getAudioInputStream

public AudioInputStream getAudioInputStream(File file,
                                            int streamIndex,
                                            int fileBufferSize)
                                     throws UnsupportedAudioFileException,
                                            IOException

Allows you to open a specific audio stream from the given file with an explicit file I/O buffer size. Useful for Stems.

The fileBufferSize controls the size of the FFmpeg internal read buffer, passed as AVFormatContext.io_buffer_size. Larger values reduce system-call overhead and improve throughput for bulk transcoding or analysis at the cost of higher per-stream memory use. Use FFURLInputStream.DEFAULT_FILE_BUFFER_SIZE (1 MB) as a baseline for bulk work.

Parameters:

file - file

streamIndex - audio stream index

fileBufferSize - FFmpeg file I/O buffer size in bytes; must be positive

Returns:

audio stream

Throws:

UnsupportedAudioFileException - if the audio is not supported

IOException - if an IO error occurs

IndexOutOfBoundsException - if the index is not valid.

IllegalArgumentException - if fileBufferSize is not positive

See Also:

getAudioInputStream(File, int), getAudioInputStream(URL, int, int), FFURLInputStream.DEFAULT_FILE_BUFFER_SIZE, FFURLInputStream.FILE_BUFFER_SIZE_PROPERTY