FragmentedMp4Extractor


@UnstableApi
class FragmentedMp4Extractor : Extractor


Extracts data from the FMP4 container format.

Summary

Nested types

@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(flag = true, value = )
annotation FragmentedMp4Extractor.Flags

Flags controlling the behavior of the extractor.

Constants

const ExtractorsFactory!

This property is deprecated.

Use newFactory instead.

const Int

Flag to use the source subtitle formats without modification.

const Int

Flag to indicate that the extractor should output an event message metadata track.

const Int

Flag to extract additional sample dependency information, and mark output buffers with BUFFER_FLAG_NOT_DEPENDED_ON.

const Int

Flag to work around an issue in some video streams where every frame is marked as a sync frame.

const Int

Flag to ignore any edit lists in the stream.

const Int

Flag to ignore any tfdt boxes in the stream.

Public constructors

This function is deprecated.

Use FragmentedMp4Extractor instead

This function is deprecated.

Use FragmentedMp4Extractor instead

Constructs an instance.

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?
)

This function is deprecated.

Use FragmentedMp4Extractor instead

FragmentedMp4Extractor(
    subtitleParserFactory: SubtitleParser.Factory!,
    @FragmentedMp4Extractor.Flags flags: Int
)

Constructs an instance.

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?
)

This function is deprecated.

Use FragmentedMp4Extractor instead

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?,
    closedCaptionFormats: (Mutable)List<Format!>!
)

This function is deprecated.

Use FragmentedMp4Extractor instead

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?,
    closedCaptionFormats: (Mutable)List<Format!>!,
    additionalEmsgTrackOutput: TrackOutput?
)

This function is deprecated.

Use FragmentedMp4Extractor instead

FragmentedMp4Extractor(
    subtitleParserFactory: SubtitleParser.Factory!,
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?,
    closedCaptionFormats: (Mutable)List<Format!>!,
    additionalEmsgTrackOutput: TrackOutput?
)

Constructs an instance.

Public functions

ImmutableList<SniffFailure!>!

Returns additional details about the last call to sniff.

Unit

Initializes the extractor with an ExtractorOutput.

java-static ExtractorsFactory!
newFactory(subtitleParserFactory: SubtitleParser.Factory!)

Creates a factory for FragmentedMp4Extractor instances with the provided .

Int
read(input: ExtractorInput!, seekPosition: PositionHolder!)

Extracts data read from a provided ExtractorInput.

Unit

Releases all kept resources.

Unit
seek(position: Long, timeUs: Long)

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.

Protected functions

Track?
modifyTrack(track: Track?)

Inherited Constants

From androidx.media3.extractor.Extractor
const 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.

const Int

Returned by read if the end of the was reached.

const 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 functions

From androidx.media3.extractor.Extractor
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

FACTORY

const val FACTORYExtractorsFactory!

FLAG_EMIT_RAW_SUBTITLE_DATA

const val FLAG_EMIT_RAW_SUBTITLE_DATA = 32: Int

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

FLAG_ENABLE_EMSG_TRACK

const val FLAG_ENABLE_EMSG_TRACK = 4: Int

Flag to indicate that the extractor should output an event message metadata track. Any event messages in the stream will be delivered as samples to this track.

FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES

const val FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES = 64: Int

Flag to extract additional sample dependency information, and mark output buffers with BUFFER_FLAG_NOT_DEPENDED_ON.

This class always marks the samples at the start of each group of picture (GOP) with BUFFER_FLAG_KEY_FRAME. Usually, key frames can be decoded independently, without depending on other samples.

Setting this flag enables elementary stream parsing to identify disposable samples that are not depended on by other samples. Any disposable sample can be safely omitted, and the rest of the track will remain valid.

Supported formats are:

FLAG_WORKAROUND_EVERY_VIDEO_FRAME_IS_SYNC_FRAME

const val FLAG_WORKAROUND_EVERY_VIDEO_FRAME_IS_SYNC_FRAME = 1: Int

Flag to work around an issue in some video streams where every frame is marked as a sync frame. The workaround overrides the sync frame flags in the stream, forcing them to false except for the first sample in each segment.

This flag does nothing if the stream is not a video stream.

FLAG_WORKAROUND_IGNORE_EDIT_LISTS

const val FLAG_WORKAROUND_IGNORE_EDIT_LISTS = 16: Int

Flag to ignore any edit lists in the stream.

FLAG_WORKAROUND_IGNORE_TFDT_BOX

const val FLAG_WORKAROUND_IGNORE_TFDT_BOX = 2: Int

Flag to ignore any tfdt boxes in the stream.

Public constructors

FragmentedMp4Extractor

FragmentedMp4Extractor()

FragmentedMp4Extractor

FragmentedMp4Extractor(@FragmentedMp4Extractor.Flags flags: Int)

FragmentedMp4Extractor

FragmentedMp4Extractor(subtitleParserFactory: SubtitleParser.Factory!)

Constructs an instance.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

FragmentedMp4Extractor

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?
)

FragmentedMp4Extractor

FragmentedMp4Extractor(
    subtitleParserFactory: SubtitleParser.Factory!,
    @FragmentedMp4Extractor.Flags flags: Int
)

Constructs an instance.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

@FragmentedMp4Extractor.Flags flags: Int

Flags that control the extractor's behavior.

FragmentedMp4Extractor

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?
)

FragmentedMp4Extractor

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?,
    closedCaptionFormats: (Mutable)List<Format!>!
)

FragmentedMp4Extractor

FragmentedMp4Extractor(
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?,
    closedCaptionFormats: (Mutable)List<Format!>!,
    additionalEmsgTrackOutput: TrackOutput?
)

FragmentedMp4Extractor

FragmentedMp4Extractor(
    subtitleParserFactory: SubtitleParser.Factory!,
    @FragmentedMp4Extractor.Flags flags: Int,
    timestampAdjuster: TimestampAdjuster?,
    sideloadedTrack: Track?,
    closedCaptionFormats: (Mutable)List<Format!>!,
    additionalEmsgTrackOutput: TrackOutput?
)

Constructs an instance.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

@FragmentedMp4Extractor.Flags flags: Int

Flags that control the extractor's behavior.

timestampAdjuster: TimestampAdjuster?

Adjusts sample timestamps. May be null if no adjustment is needed.

sideloadedTrack: Track?

Sideloaded track information, in the case that the extractor will not receive a moov box in the input data. Null if a moov box is expected.

closedCaptionFormats: (Mutable)List<Format!>!

For tracks that contain SEI messages, the formats of the closed caption channels to expose.

additionalEmsgTrackOutput: TrackOutput?

An extra track output that will receive all emsg messages targeting the player, even if FLAG_ENABLE_EMSG_TRACK is not set. Null if special handling of emsg messages for players is not required.

Public functions

getSniffFailureDetails

fun getSniffFailureDetails(): ImmutableList<SniffFailure!>!

Returns additional details about the last call to sniff. The returned list may be empty if no additional details are available, or the last sniff call returned true.

This only contains details that were discovered before sniff returned false, it is not an exhaustive list of issues which, if resolved, would cause the file to be successfully sniffed.

init

fun init(output: ExtractorOutput!): Unit

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

Parameters
output: ExtractorOutput!

An ExtractorOutput to receive extracted data.

newFactory

java-static fun newFactory(subtitleParserFactory: SubtitleParser.Factory!): ExtractorsFactory!

Creates a factory for FragmentedMp4Extractor instances with the provided .

read

fun read(input: ExtractorInput!, seekPosition: PositionHolder!): Int

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
input: ExtractorInput!

The ExtractorInput from which data should be read.

seekPosition: PositionHolder!

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

fun release(): Unit

Releases all kept resources.

seek

fun seek(position: Long, timeUs: Long): Unit

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
position: Long

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

timeUs: Long

The seek time in microseconds.

sniff

fun sniff(input: ExtractorInput!): Boolean

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
input: ExtractorInput!

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.

Protected functions

modifyTrack

protected fun modifyTrack(track: Track?): Track?