FFURLInputStream (FFSampledSP 0.9.56 API)

java.lang.Object
- java.io.InputStream
- - com.tagtraum.ffsampledsp.FFNativePeerInputStream
  - - com.tagtraum.ffsampledsp.FFURLInputStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class FFURLInputStream
extends FFNativePeerInputStream
```
Audio stream capable of decoding resources via FFmpeg.

Author:

Hendrik Schreiber

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_FILE_BUFFER_SIZE` Default I/O buffer size for `file:` URLs when no explicit value is configured: 1048576 bytes (1 MB).
`static int`	`DEFAULT_URL_BUFFER_SIZE` Default I/O buffer size for non-`file:` URLs when no explicit value is configured: 65536 bytes (64 KB).
`static String`	`FILE_BUFFER_SIZE_PROPERTY` Name of the system property that overrides `DEFAULT_FILE_BUFFER_SIZE` for `file:` URLs when no explicit buffer size is supplied to a constructor.
`static String`	`URL_BUFFER_SIZE_PROPERTY` Name of the system property that overrides `DEFAULT_URL_BUFFER_SIZE` for non-`file:` URLs when no explicit buffer size is supplied to a constructor.

Fields inherited from class com.tagtraum.ffsampledsp.FFNativePeerInputStream
nativeBuffer, pointer

Constructor Summary

Constructors
Constructor and Description
`FFURLInputStream(URL url)` Opens the first audio stream from the given URL using the default I/O buffer size.
`FFURLInputStream(URL url, int streamIndex)` Opens the specified audio stream index from the given URL using the default I/O buffer size.
`FFURLInputStream(URL url, int streamIndex, int fileBufferSize)` Opens the specified audio stream index from the given URL with an explicit file I/O buffer size.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`close(long pointer)` Closes the native peer and releases all resources held by it.
`protected void`	`fillNativeBuffer()` Fills `FFNativePeerInputStream.nativeBuffer` with new data.
`static int`	`getDefaultBufferSize(URL url)` Returns the default I/O buffer size for the given URL.
`static int`	`getDefaultFileBufferSize()` Returns the I/O buffer size to use for `file:` URLs when none is specified explicitly.
`static int`	`getDefaultUrlBufferSize()` Returns the I/O buffer size to use for non-`file:` URLs when none is specified explicitly.
`int`	`getFileBufferSize()` Returns the file I/O buffer size configured for this stream.
`boolean`	`isSeekable()` Returns `true` if this stream supports seeking.
`void`	`seek(long time, TimeUnit timeUnit)` Seeks to the given position in the stream.
`String`	`toString()`

Methods inherited from class com.tagtraum.ffsampledsp.FFNativePeerInputStream
close, finalize, isOpen, read, read

Methods inherited from class java.io.InputStream
available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_FILE_BUFFER_SIZE
```
public static final int DEFAULT_FILE_BUFFER_SIZE
```
    Default I/O buffer size for file: URLs when no explicit value is configured: 1048576 bytes (1 MB).
    
    See Also:
    
    FILE_BUFFER_SIZE_PROPERTY, Constant Field Values
  - FILE_BUFFER_SIZE_PROPERTY
```
public static final String FILE_BUFFER_SIZE_PROPERTY
```
    Name of the system property that overrides DEFAULT_FILE_BUFFER_SIZE for file: URLs when no explicit buffer size is supplied to a constructor. The property value must be a positive integer representing the desired buffer size in bytes.
    Example: -Dffsampledsp.fileBufferSize=524288 sets a 512 KB buffer.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_URL_BUFFER_SIZE
```
public static final int DEFAULT_URL_BUFFER_SIZE
```
    Default I/O buffer size for non-file: URLs when no explicit value is configured: 65536 bytes (64 KB). A smaller value is used here to reduce latency when streaming over a slow network.
    
    See Also:
    
    URL_BUFFER_SIZE_PROPERTY, Constant Field Values
  - URL_BUFFER_SIZE_PROPERTY
```
public static final String URL_BUFFER_SIZE_PROPERTY
```
    Name of the system property that overrides DEFAULT_URL_BUFFER_SIZE for non-file: URLs when no explicit buffer size is supplied to a constructor. The property value must be a positive integer representing the desired buffer size in bytes.
    Example: -Dffsampledsp.urlBufferSize=32768 sets a 32 KB buffer.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FFURLInputStream
```
public FFURLInputStream(URL url)
                 throws IOException,
                        UnsupportedAudioFileException
```
    Opens the first audio stream from the given URL using the default I/O buffer size.
    For file: URLs the buffer size comes from "ffsampledsp.fileBufferSize", falling back to DEFAULT_FILE_BUFFER_SIZE. For all other URLs it comes from "ffsampledsp.urlBufferSize", falling back to DEFAULT_URL_BUFFER_SIZE.
    
    Parameters:
    
    url - URL of the audio resource to decode
    
    Throws:
    
    IOException - if an I/O error occurs
    
    UnsupportedAudioFileException - if the URL points to an unsupported or DRM-protected file
    
    See Also:
    
    FILE_BUFFER_SIZE_PROPERTY, URL_BUFFER_SIZE_PROPERTY
  - FFURLInputStream
```
public FFURLInputStream(URL url,
                        int streamIndex)
                 throws IOException,
                        UnsupportedAudioFileException
```
    Opens the specified audio stream index from the given URL using the default I/O buffer size.
    For file: URLs the buffer size comes from "ffsampledsp.fileBufferSize", falling back to DEFAULT_FILE_BUFFER_SIZE. For all other URLs it comes from "ffsampledsp.urlBufferSize", falling back to DEFAULT_URL_BUFFER_SIZE.
    
    Parameters:
    
    url - URL of the audio resource to decode
    
    streamIndex - zero-based index of the audio stream to open
    
    Throws:
    
    IOException - if an I/O error occurs
    
    UnsupportedAudioFileException - if the URL points to an unsupported or DRM-protected file
    
    See Also:
    
    FILE_BUFFER_SIZE_PROPERTY, URL_BUFFER_SIZE_PROPERTY
  - FFURLInputStream
```
public FFURLInputStream(URL url,
                        int streamIndex,
                        int fileBufferSize)
                 throws IOException,
                        UnsupportedAudioFileException
```
    Opens the specified audio stream index from the given URL with an explicit file I/O buffer size.
    The fileBufferSize is passed directly to FFmpeg as the AVFormatContext io_buffer_size, controlling the size of the internal read buffer used when reading from disk or network. Larger values reduce system-call overhead and improve throughput for bulk transcoding or analysis at the cost of higher memory usage per stream. A value of DEFAULT_FILE_BUFFER_SIZE (1 MB) is suitable for most use cases.
    
    Parameters:
    
    url - URL of the audio resource to decode
    
    streamIndex - zero-based index of the audio stream to open
    
    fileBufferSize - FFmpeg file I/O buffer size in bytes; must be positive
    
    Throws:
    
    IOException - if an I/O error occurs
    
    UnsupportedAudioFileException - if the URL points to an unsupported or DRM-protected file
    
    IllegalArgumentException - if fileBufferSize is not positive
- Method Detail
  - getFileBufferSize
```
public int getFileBufferSize()
```
    Returns the file I/O buffer size configured for this stream.
    
    Returns:
    
    the FFmpeg file I/O buffer size in bytes
  - getDefaultFileBufferSize
```
public static int getDefaultFileBufferSize()
```
    Returns the I/O buffer size to use for file: URLs when none is specified explicitly. Reads the "ffsampledsp.fileBufferSize" system property; falls back to DEFAULT_FILE_BUFFER_SIZE if the property is absent or not a positive integer.
    
    Returns:
    
    effective default file I/O buffer size in bytes
  - getDefaultUrlBufferSize
```
public static int getDefaultUrlBufferSize()
```
    Returns the I/O buffer size to use for non-file: URLs when none is specified explicitly. Reads the "ffsampledsp.urlBufferSize" system property; falls back to DEFAULT_URL_BUFFER_SIZE if the property is absent or not a positive integer.
    
    Returns:
    
    effective default URL I/O buffer size in bytes
  - getDefaultBufferSize
```
public static int getDefaultBufferSize(URL url)
```
    Returns the default I/O buffer size for the given URL. Delegates to getDefaultFileBufferSize() for file: URLs and to getDefaultUrlBufferSize() for all others.
    
    Parameters:
    
    url - URL whose scheme determines which default applies
    
    Returns:
    
    effective default I/O buffer size in bytes
  - isSeekable
```
public boolean isSeekable()
```
    Description copied from class: FFNativePeerInputStream
    
    Returns true if this stream supports seeking.
    
    Specified by:
    
    isSeekable in class FFNativePeerInputStream
    
    Returns:
    
    true if seeking is supported
    
    See Also:
    
    FFAudioInputStream.isSeekable()
  - seek
```
public void seek(long time,
                 TimeUnit timeUnit)
          throws UnsupportedOperationException,
                 IOException
```
    Description copied from class: FFNativePeerInputStream
    
    Seeks to the given position in the stream.
    
    Specified by:
    
    seek in class FFNativePeerInputStream
    
    Parameters:
    
    time - position to seek to
    
    timeUnit - unit of time
    
    Throws:
    
    IOException - if an IO error occurs
    
    UnsupportedOperationException
    
    See Also:
    
    FFAudioInputStream.seek(long, java.util.concurrent.TimeUnit)
  - fillNativeBuffer
```
protected void fillNativeBuffer()
                         throws IOException
```
    Description copied from class: FFNativePeerInputStream
    
    Fills FFNativePeerInputStream.nativeBuffer with new data.
    
    Specified by:
    
    fillNativeBuffer in class FFNativePeerInputStream
    
    Throws:
    
    IOException - if an IO error occurs
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - close
```
protected void close(long pointer)
              throws IOException
```
    Description copied from class: FFNativePeerInputStream
    
    Closes the native peer and releases all resources held by it.
    
    Specified by:
    
    close in class FFNativePeerInputStream
    
    Parameters:
    
    pointer - pointer
    
    Throws:
    
    IOException - if an IO error occurs

Class FFURLInputStream

Field Summary

Fields inherited from class com.tagtraum.ffsampledsp.FFNativePeerInputStream

Constructor Summary

Method Summary

Methods inherited from class com.tagtraum.ffsampledsp.FFNativePeerInputStream

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FILE_BUFFER_SIZE

FILE_BUFFER_SIZE_PROPERTY

DEFAULT_URL_BUFFER_SIZE

URL_BUFFER_SIZE_PROPERTY

Constructor Detail

FFURLInputStream

FFURLInputStream

FFURLInputStream

Method Detail

getFileBufferSize

getDefaultFileBufferSize

getDefaultUrlBufferSize

getDefaultBufferSize

isSeekable

seek

fillNativeBuffer

toString

close