Class DefaultExtractorInput

    • Constructor Detail

      • DefaultExtractorInput

        public DefaultExtractorInput​(DataReader dataReader,
                                     long position,
                                     long length)
        Parameters:
        dataReader - The wrapped DataReader.
        position - The initial position in the stream.
        length - The length of the stream, or C.LENGTH_UNSET if it is unknown.
    • Method Detail

      • read

        public int read​(byte[] target,
                        int offset,
                        int length)
                 throws IOException
        Description copied from interface: ExtractorInput
        Reads up to length bytes from the input and resets the peek position.

        This method blocks until at least one byte of data can be read, the end of the input is detected, or an exception is thrown.

        Specified by:
        read in interface DataReader
        Specified by:
        read in interface ExtractorInput
        Parameters:
        target - A target array into which data should be written.
        offset - The offset into the target array at which to write.
        length - The maximum number of bytes to read from the input.
        Returns:
        The number of bytes read, or C.RESULT_END_OF_INPUT if the input has ended.
        Throws:
        IOException - If an error occurs reading from the input.
      • readFully

        public boolean readFully​(byte[] target,
                                 int offset,
                                 int length,
                                 boolean allowEndOfInput)
                          throws IOException
        Description copied from interface: ExtractorInput
        Like ExtractorInput.read(byte[], int, int), but reads the requested length in full.
        Specified by:
        readFully in interface ExtractorInput
        Parameters:
        target - A target array into which data should be written.
        offset - The offset into the target array at which to write.
        length - The number of bytes to read from the input.
        allowEndOfInput - True if encountering the end of the input having read no data is allowed, and should result in false being returned. False if it should be considered an error, causing an EOFException to be thrown. See note in class Javadoc.
        Returns:
        True if the read was successful. False if allowEndOfInput=true and the end of the input was encountered having read no data.
        Throws:
        EOFException - If the end of input was encountered having partially satisfied the read (i.e. having read at least one byte, but fewer than length), or if no bytes were read and allowEndOfInput is false.
        IOException - If an error occurs reading from the input.
      • readFully

        public void readFully​(byte[] target,
                              int offset,
                              int length)
                       throws IOException
        Description copied from interface: ExtractorInput
        Specified by:
        readFully in interface ExtractorInput
        Parameters:
        target - A target array into which data should be written.
        offset - The offset into the target array at which to write.
        length - The number of bytes to read from the input.
        Throws:
        EOFException - If the end of input was encountered.
        IOException - If an error occurs reading from the input.
      • skipFully

        public boolean skipFully​(int length,
                                 boolean allowEndOfInput)
                          throws IOException
        Description copied from interface: ExtractorInput
        Like ExtractorInput.readFully(byte[], int, int, boolean), except the data is skipped instead of read.
        Specified by:
        skipFully in interface ExtractorInput
        Parameters:
        length - The number of bytes to skip from the input.
        allowEndOfInput - True if encountering the end of the input having skipped no data is allowed, and should result in false being returned. False if it should be considered an error, causing an EOFException to be thrown. See note in class Javadoc.
        Returns:
        True if the skip was successful. False if allowEndOfInput=true and the end of the input was encountered having skipped no data.
        Throws:
        EOFException - If the end of input was encountered having partially satisfied the skip (i.e. having skipped at least one byte, but fewer than length), or if no bytes were skipped and allowEndOfInput is false.
        IOException - If an error occurs reading from the input.
      • peek

        public int peek​(byte[] target,
                        int offset,
                        int length)
                 throws IOException
        Description copied from interface: ExtractorInput
        Peeks up to length bytes from the peek position. The current read position is left unchanged.

        This method blocks until at least one byte of data can be peeked, the end of the input is detected, or an exception is thrown.

        Calling ExtractorInput.resetPeekPosition() resets the peek position to equal the current read position, so the caller can peek the same data again. Reading or skipping also resets the peek position.

        Specified by:
        peek in interface ExtractorInput
        Parameters:
        target - A target array into which data should be written.
        offset - The offset into the target array at which to write.
        length - The maximum number of bytes to peek from the input.
        Returns:
        The number of bytes peeked, or C.RESULT_END_OF_INPUT if the input has ended.
        Throws:
        IOException - If an error occurs peeking from the input.
      • peekFully

        public boolean peekFully​(byte[] target,
                                 int offset,
                                 int length,
                                 boolean allowEndOfInput)
                          throws IOException
        Description copied from interface: ExtractorInput
        Like ExtractorInput.peek(byte[], int, int), but peeks the requested length in full.
        Specified by:
        peekFully in interface ExtractorInput
        Parameters:
        target - A target array into which data should be written.
        offset - The offset into the target array at which to write.
        length - The number of bytes to peek from the input.
        allowEndOfInput - True if encountering the end of the input having peeked no data is allowed, and should result in false being returned. False if it should be considered an error, causing an EOFException to be thrown. See note in class Javadoc.
        Returns:
        True if the peek was successful. False if allowEndOfInput=true and the end of the input was encountered having peeked no data.
        Throws:
        EOFException - If the end of input was encountered having partially satisfied the peek (i.e. having peeked at least one byte, but fewer than length), or if no bytes were peeked and allowEndOfInput is false.
        IOException - If an error occurs peeking from the input.
      • peekFully

        public void peekFully​(byte[] target,
                              int offset,
                              int length)
                       throws IOException
        Description copied from interface: ExtractorInput
        Specified by:
        peekFully in interface ExtractorInput
        Parameters:
        target - A target array into which data should be written.
        offset - The offset into the target array at which to write.
        length - The number of bytes to peek from the input.
        Throws:
        EOFException - If the end of input was encountered.
        IOException - If an error occurs peeking from the input.
      • advancePeekPosition

        public boolean advancePeekPosition​(int length,
                                           boolean allowEndOfInput)
                                    throws IOException
        Description copied from interface: ExtractorInput
        Advances the peek position by length bytes. Like ExtractorInput.peekFully(byte[], int, int, boolean) except the data is skipped instead of read.
        Specified by:
        advancePeekPosition in interface ExtractorInput
        Parameters:
        length - The number of bytes by which to advance the peek position.
        allowEndOfInput - True if encountering the end of the input before advancing is allowed, and should result in false being returned. False if it should be considered an error, causing an EOFException to be thrown. See note in class Javadoc.
        Returns:
        True if advancing the peek position was successful. False if allowEndOfInput=true and the end of the input was encountered before advancing over any data.
        Throws:
        EOFException - If the end of input was encountered having partially advanced (i.e. having advanced by at least one byte, but fewer than length), or if the end of input was encountered before advancing and allowEndOfInput is false.
        IOException - If an error occurs advancing the peek position.
      • resetPeekPosition

        public void resetPeekPosition()
        Description copied from interface: ExtractorInput
        Resets the peek position to equal the current read position.
        Specified by:
        resetPeekPosition in interface ExtractorInput
      • getPeekPosition

        public long getPeekPosition()
        Description copied from interface: ExtractorInput
        Returns the current peek position (byte offset) in the stream.
        Specified by:
        getPeekPosition in interface ExtractorInput
        Returns:
        The peek position (byte offset) in the stream.
      • getPosition

        public long getPosition()
        Description copied from interface: ExtractorInput
        Returns the current read position (byte offset) in the stream.
        Specified by:
        getPosition in interface ExtractorInput
        Returns:
        The read position (byte offset) in the stream.
      • setRetryPosition

        public <E extends Throwable> void setRetryPosition​(long position,
                                                           E e)
                                                    throws E extends Throwable
        Description copied from interface: ExtractorInput
        Called when reading fails and the required retry position is different from the last position. After setting the retry position it throws the given Throwable.
        Specified by:
        setRetryPosition in interface ExtractorInput
        Type Parameters:
        E - Type of Throwable to be thrown.
        Parameters:
        position - The required retry position.
        e - Throwable to be thrown.
        Throws:
        E - The given Throwable object.
        E extends Throwable