Class SubtitleExtractor

  • All Implemented Interfaces:
    Extractor

    public class SubtitleExtractor
    extends Object
    implements Extractor
    Generic extractor for extracting subtitles from various subtitle formats.
    • Constructor Detail

      • SubtitleExtractor

        public SubtitleExtractor​(SubtitleDecoder subtitleDecoder,
                                 Format format)
        Parameters:
        subtitleDecoder - The decoder used for decoding the subtitle data. The extractor will release the decoder in release().
        format - Format that describes subtitle data.
    • Method Detail

      • sniff

        public boolean sniff​(ExtractorInput input)
                      throws IOException
        Description copied from interface: Extractor
        Returns whether this extractor can extract samples from the ExtractorInput, which must provide data from the start of the stream.

        If true is returned, the input's reading position may have been modified. Otherwise, only its peek position may have been modified.

        Specified by:
        sniff in interface Extractor
        Parameters:
        input - The ExtractorInput from which data should be peeked/read.
        Returns:
        Whether this extractor can read the provided input.
        Throws:
        IOException - If an error occurred reading from the input.
      • read

        public int read​(ExtractorInput input,
                        PositionHolder seekPosition)
                 throws IOException
        Description copied from interface: Extractor
        Extracts data read from a provided ExtractorInput. Must not be called before Extractor.init(ExtractorOutput).

        A single call to this method will block until some progress has been made, but will not block for longer than this. Hence each call will consume only a small amount of input data.

        In the common case, Extractor.RESULT_CONTINUE is returned to indicate that the ExtractorInput passed to the next read is required to provide data continuing from the position in the stream reached by the returning call. If the extractor requires data to be provided from a different position, then that position is set in seekPosition and Extractor.RESULT_SEEK is returned. If the extractor reached the end of the data provided by the ExtractorInput, then Extractor.RESULT_END_OF_INPUT is returned.

        When this method throws an IOException, extraction may continue by providing an ExtractorInput with an unchanged read position to a subsequent call to this method.

        Specified by:
        read in interface Extractor
        Parameters:
        input - The ExtractorInput from which data should be read.
        seekPosition - If Extractor.RESULT_SEEK is returned, this holder is updated to hold the position of the required data.
        Returns:
        One of the RESULT_ values defined in this interface.
        Throws:
        IOException - If an error occurred reading from or parsing the input.
      • seek

        public void seek​(long position,
                         long timeUs)
        Description copied from interface: Extractor
        Notifies the extractor that a seek has occurred.

        Following a call to this method, the ExtractorInput passed to the next invocation of Extractor.read(ExtractorInput, PositionHolder) is required to provide data starting from position in the stream. Valid random access positions are the start of the stream and positions that can be obtained from any SeekMap passed to the ExtractorOutput.

        Specified by:
        seek in interface Extractor
        Parameters:
        position - The byte offset in the stream from which data will be provided.
        timeUs - The seek time in microseconds.