@UnstableApi
public final class TsExtractor implements Extractor

Extracts data from the MPEG-2 TS container format.

Summary

Nested types
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(flag = true, value = )
public annotation TsExtractor.Flags

Flags controlling the behavior of the extractor.
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(value = )
public annotation TsExtractor.Mode

Modes for the extractor.

Constants
static final int
static final ExtractorsFactory

This field is deprecated.

Use newFactory instead.
static final int

Flag to use the source subtitle formats without modification.
static final int

Enable single PMT mode, map TrackOutputs by their type (instead of PID) and ignore continuity counters.
static final int

Behave as defined in ISO/IEC 13818-1.
static final int

Assume only one PMT will be contained in the stream, even if more are declared by the PAT.
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int

Public constructors

This method is deprecated.

Use TsExtractor instead.
TsExtractor(
    @DefaultTsPayloadReaderFactory.Flags int defaultTsPayloadReaderFlags
)

This method is deprecated.

Use TsExtractor instead.
TsExtractor(SubtitleParser.Factory subtitleParserFactory)

Constructs an instance.
TsExtractor(
    @TsExtractor.Flags int extractorFlags,
    SubtitleParser.Factory subtitleParserFactory
)

Constructs an instance.
TsExtractor(
    @TsExtractor.Mode int mode,
    @DefaultTsPayloadReaderFactory.Flags int defaultTsPayloadReaderFlags,
    int timestampSearchBytes
)

This method is deprecated.

Use TsExtractor instead.
TsExtractor(
    @TsExtractor.Mode int mode,
    TimestampAdjuster timestampAdjuster,
    TsPayloadReader.Factory payloadReaderFactory
)

This method is deprecated.

Use TsExtractor instead.
TsExtractor(
    @TsExtractor.Mode int mode,
    TimestampAdjuster timestampAdjuster,
    TsPayloadReader.Factory payloadReaderFactory,
    int timestampSearchBytes
)

This method is deprecated.

Use TsExtractor instead.
TsExtractor(
    @TsExtractor.Mode int mode,
    @TsExtractor.Flags int extractorFlags,
    SubtitleParser.Factory subtitleParserFactory,
    TimestampAdjuster timestampAdjuster,
    TsPayloadReader.Factory payloadReaderFactory,
    int timestampSearchBytes
)

Constructs an instance.

Public methods
void

Initializes the extractor with an ExtractorOutput.
static ExtractorsFactory
newFactory(SubtitleParser.Factory subtitleParserFactory)

Creates a factory for TsExtractor instances with the provided .
int

Extracts data read from a provided ExtractorInput.
void

Releases all kept resources.
void
seek(long position, long timeUs)

Notifies the extractor that a seek has occurred.
boolean

Returns whether this extractor can extract samples from the ExtractorInput, which must provide data from the start of the stream.

Inherited Constants
From androidx.media3.extractor.Extractor
static final int

Returned by read if the ExtractorInput passed to the next read is required to provide data continuing from the position in the stream reached by the returning call.
static final int

Returned by read if the end of the was reached.
static final int

Returned by read if the ExtractorInput passed to the next read is required to provide data starting from a specified position in the stream.

Inherited methods
From androidx.media3.extractor.Extractor
List<SniffFailure>

Returns additional details about the last call to sniff.
Extractor

Returns the 'real' Extractor implementation if this is a delegating instance, or this if this instance does the extraction directly without delegating (the default behaviour).

Constants

DEFAULT_TIMESTAMP_SEARCH_BYTES

public static final int DEFAULT_TIMESTAMP_SEARCH_BYTES = 112800

FACTORY

public static final ExtractorsFactory FACTORY

FLAG_EMIT_RAW_SUBTITLE_DATA

public static final int FLAG_EMIT_RAW_SUBTITLE_DATA = 1

Flag to use the source subtitle formats without modification. If unset, subtitles will be transcoded to APPLICATION_MEDIA3_CUES during extraction.

MODE_HLS

public static final int MODE_HLS = 2

Enable single PMT mode, map TrackOutputs by their type (instead of PID) and ignore continuity counters.

MODE_MULTI_PMT

public static final int MODE_MULTI_PMT = 0

Behave as defined in ISO/IEC 13818-1.

MODE_SINGLE_PMT

public static final int MODE_SINGLE_PMT = 1

Assume only one PMT will be contained in the stream, even if more are declared by the PAT.

TS_PACKET_SIZE

public static final int TS_PACKET_SIZE = 188

TS_STREAM_TYPE_AAC_ADTS

public static final int TS_STREAM_TYPE_AAC_ADTS = 15

TS_STREAM_TYPE_AAC_LATM

public static final int TS_STREAM_TYPE_AAC_LATM = 17

TS_STREAM_TYPE_AC3

public static final int TS_STREAM_TYPE_AC3 = 129

TS_STREAM_TYPE_AC4

public static final int TS_STREAM_TYPE_AC4 = 172

TS_STREAM_TYPE_AIT

public static final int TS_STREAM_TYPE_AIT = 257

TS_STREAM_TYPE_DC2_H262

public static final int TS_STREAM_TYPE_DC2_H262 = 128

TS_STREAM_TYPE_DTS

public static final int TS_STREAM_TYPE_DTS = 138

TS_STREAM_TYPE_DTS_HD

public static final int TS_STREAM_TYPE_DTS_HD = 136

TS_STREAM_TYPE_DTS_UHD

public static final int TS_STREAM_TYPE_DTS_UHD = 139

TS_STREAM_TYPE_DVBSUBS

public static final int TS_STREAM_TYPE_DVBSUBS = 89

TS_STREAM_TYPE_E_AC3

public static final int TS_STREAM_TYPE_E_AC3 = 135

TS_STREAM_TYPE_H262

public static final int TS_STREAM_TYPE_H262 = 2

TS_STREAM_TYPE_H263

public static final int TS_STREAM_TYPE_H263 = 16

TS_STREAM_TYPE_H264

public static final int TS_STREAM_TYPE_H264 = 27

TS_STREAM_TYPE_H265

public static final int TS_STREAM_TYPE_H265 = 36

TS_STREAM_TYPE_HDMV_DTS

public static final int TS_STREAM_TYPE_HDMV_DTS = 130

TS_STREAM_TYPE_ID3

public static final int TS_STREAM_TYPE_ID3 = 21

TS_STREAM_TYPE_MHAS

public static final int TS_STREAM_TYPE_MHAS = 45

TS_STREAM_TYPE_MPA

public static final int TS_STREAM_TYPE_MPA = 3

TS_STREAM_TYPE_MPA_LSF

public static final int TS_STREAM_TYPE_MPA_LSF = 4

TS_STREAM_TYPE_SPLICE_INFO

public static final int TS_STREAM_TYPE_SPLICE_INFO = 134

TS_SYNC_BYTE

public static final int TS_SYNC_BYTE = 71

Public constructors

TsExtractor

public TsExtractor()

TsExtractor

public TsExtractor(
    @DefaultTsPayloadReaderFactory.Flags int defaultTsPayloadReaderFlags
)

TsExtractor

public TsExtractor(SubtitleParser.Factory subtitleParserFactory)

Constructs an instance.

Parameters
SubtitleParser.Factory subtitleParserFactory

The SubtitleParser.Factory for parsing subtitles during extraction.

TsExtractor

public TsExtractor(
    @TsExtractor.Flags int extractorFlags,
    SubtitleParser.Factory subtitleParserFactory
)

Constructs an instance.

Parameters
@TsExtractor.Flags int extractorFlags

Flags that control the extractor's behavior.
SubtitleParser.Factory subtitleParserFactory

The SubtitleParser.Factory for parsing subtitles during extraction.

TsExtractor

public TsExtractor(
    @TsExtractor.Mode int mode,
    @DefaultTsPayloadReaderFactory.Flags int defaultTsPayloadReaderFlags,
    int timestampSearchBytes
)

TsExtractor

public TsExtractor(
    @TsExtractor.Mode int mode,
    TimestampAdjuster timestampAdjuster,
    TsPayloadReader.Factory payloadReaderFactory
)

TsExtractor

public TsExtractor(
    @TsExtractor.Mode int mode,
    TimestampAdjuster timestampAdjuster,
    TsPayloadReader.Factory payloadReaderFactory,
    int timestampSearchBytes
)

TsExtractor

public TsExtractor(
    @TsExtractor.Mode int mode,
    @TsExtractor.Flags int extractorFlags,
    SubtitleParser.Factory subtitleParserFactory,
    TimestampAdjuster timestampAdjuster,
    TsPayloadReader.Factory payloadReaderFactory,
    int timestampSearchBytes
)

Constructs an instance.

Parameters
@TsExtractor.Mode int mode

Mode for the extractor. One of MODE_MULTI_PMT, MODE_SINGLE_PMT and MODE_HLS.
@TsExtractor.Flags int extractorFlags

Flags that control the extractor's behavior.
SubtitleParser.Factory subtitleParserFactory

The SubtitleParser.Factory for parsing subtitles during extraction.
TimestampAdjuster timestampAdjuster

A timestamp adjuster for offsetting and scaling sample timestamps.
TsPayloadReader.Factory payloadReaderFactory

Factory for injecting a custom set of payload readers.
int timestampSearchBytes

The number of bytes searched from a given position in the stream to find a PCR timestamp. If this value is too small, the duration might be unknown and seeking might not be supported for high bitrate progressive streams. Setting a large value for this field might be inefficient though because the extractor stores a buffer of timestampSearchBytes bytes when determining the duration or when performing a seek operation. The default value is DEFAULT_TIMESTAMP_SEARCH_BYTES. If the number of bytes left in the stream from the current position is less than timestampSearchBytes, the search is performed on the bytes left.

Public methods

init

public void init(ExtractorOutput output)

Initializes the extractor with an ExtractorOutput. Called at most once.

Parameters
ExtractorOutput output

An ExtractorOutput to receive extracted data.

newFactory

public static ExtractorsFactory newFactory(SubtitleParser.Factory subtitleParserFactory)

Creates a factory for TsExtractor instances with the provided .

read

@Extractor.ReadResult
public int read(ExtractorInput input, PositionHolder seekPosition)

Extracts data read from a provided ExtractorInput. Must not be called before init.

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, RESULT_CONTINUE is returned to indicate that the 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 RESULT_SEEK is returned. If the extractor reached the end of the data provided by the ExtractorInput, then 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.

Parameters
ExtractorInput input

The ExtractorInput from which data should be read.
PositionHolder seekPosition

If RESULT_SEEK is returned, this holder is updated to hold the position of the required data.
Returns
int

One of the RESULT_ values defined in this interface.
Throws
java.io.IOException

If an error occurred reading from or parsing the input.

release

public void release()

Releases all kept resources.

seek

public void seek(long position, long timeUs)

Notifies the extractor that a seek has occurred.

Following a call to this method, the ExtractorInput passed to the next invocation of read 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.

Parameters
long position

The byte offset in the stream from which data will be provided.
long timeUs

The seek time in microseconds.

sniff

public boolean sniff(ExtractorInput input)

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.

Parameters
ExtractorInput input

The ExtractorInput from which data should be peeked/read.
Returns
boolean

Whether this extractor can read the provided input.
Throws
java.io.IOException

If an error occurred reading from the input.