@UnstableApi
class Mp4Extractor : Extractor, SeekMap


Extracts data from the MP4 container format.

Summary

Nested types

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

Flags controlling the behavior of the extractor.

Constants

const ExtractorsFactory!

This property is deprecated.

Use newFactory instead.

const Int
const Int

Flag to mark the first video track encountered as ROLE_FLAG_MAIN and all subsequent video tracks as ROLE_FLAG_ALTERNATE.

const Int

Flag to extract the editable video tracks.

const Int

Flag to extract MotionPhotoMetadata from HEIC motion photos following the Google Photos Motion Photo File Format V1.1.

const Int

Flag to extract SlowMotionData metadata from Samsung Extension Format (SEF) slow motion videos.

const Int

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

const Int

Flag to ignore any edit lists in the stream.

Public constructors

This function is deprecated.

Use Mp4Extractor instead

This function is deprecated.

Use Mp4Extractor instead

Mp4Extractor(subtitleParserFactory: SubtitleParser.Factory!)

Creates a new extractor for unfragmented MP4 streams.

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

Creates a new extractor for unfragmented MP4 streams, using the specified flags to control the extractor's behavior.

Public functions

LongArray<Long>!

Returns the list of sample timestamps of a trackId, in microseconds.

SeekMap.SeekPoints!

Obtains seek points for the specified seek time in microseconds.

SeekMap.SeekPoints!
getSeekPoints(timeUs: Long, trackId: Int)

Equivalent to getSeekPoints, except it adds the trackId parameter.

ImmutableList<SniffFailure!>!

Returns additional details about the last call to sniff.

Unit

Initializes the extractor with an ExtractorOutput.

Boolean

Returns whether seeking is supported.

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

Creates a factory for Mp4Extractor 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.

Public properties

Long

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 = 16: Int

FLAG_MARK_FIRST_VIDEO_TRACK_WITH_MAIN_ROLE

const val FLAG_MARK_FIRST_VIDEO_TRACK_WITH_MAIN_ROLE = 8: Int

Flag to mark the first video track encountered as ROLE_FLAG_MAIN and all subsequent video tracks as ROLE_FLAG_ALTERNATE.

FLAG_READ_EDITABLE_VIDEO_TRACKS

const val FLAG_READ_EDITABLE_VIDEO_TRACKS = 64: Int

Flag to extract the editable video tracks.

Either primary video tracks or editable video tracks (but not both) will be extracted based on the flag.

If the flag is set but the editable video tracks are not present, then it fallbacks to extract primary tracks instead.

FLAG_READ_MOTION_PHOTO_METADATA

const val FLAG_READ_MOTION_PHOTO_METADATA = 2: Int

Flag to extract MotionPhotoMetadata from HEIC motion photos following the Google Photos Motion Photo File Format V1.1.

As playback is not supported for motion photos, this flag should only be used for metadata retrieval use cases.

FLAG_READ_SEF_DATA

const val FLAG_READ_SEF_DATA = 4: Int

Flag to extract SlowMotionData metadata from Samsung Extension Format (SEF) slow motion videos.

FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES

const val FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES = 32: 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_IGNORE_EDIT_LISTS

const val FLAG_WORKAROUND_IGNORE_EDIT_LISTS = 1: Int

Flag to ignore any edit lists in the stream.

Public constructors

Mp4Extractor

Mp4Extractor()

Mp4Extractor

Mp4Extractor(@Mp4Extractor.Flags flags: Int)

Mp4Extractor

Mp4Extractor(subtitleParserFactory: SubtitleParser.Factory!)

Creates a new extractor for unfragmented MP4 streams.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

Mp4Extractor

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

Creates a new extractor for unfragmented MP4 streams, using the specified flags to control the extractor's behavior.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

@Mp4Extractor.Flags flags: Int

Flags that control the extractor's behavior.

Public functions

getSampleTimestampsUs

fun getSampleTimestampsUs(trackId: Int): LongArray<Long>!

Returns the list of sample timestamps of a trackId, in microseconds.

Parameters
trackId: Int

The id of the track to get the sample timestamps.

Returns
LongArray<Long>!

The corresponding sample timestmaps of the track.

getSeekPoints

fun getSeekPoints(timeUs: Long): SeekMap.SeekPoints!

Obtains seek points for the specified seek time in microseconds. The returned will contain one or two distinct seek points.

Two seek points [A, B] are returned in the case that seeking can only be performed to discrete points in time, there does not exist a seek point at exactly the requested time, and there exist seek points on both sides of it. In this case A and B are the closest seek points before and after the requested time. A single seek point is returned in all other cases.

Parameters
timeUs: Long

A seek time in microseconds.

Returns
SeekMap.SeekPoints!

The corresponding seek points.

getSeekPoints

fun getSeekPoints(timeUs: Long, trackId: Int): SeekMap.SeekPoints!

Equivalent to getSeekPoints, except it adds the trackId parameter.

Parameters
timeUs: Long

A seek time in microseconds.

trackId: Int

The id of the track on which to seek for SeekPoints. May be INDEX_UNSET if the extractor is expected to define the strategy for generating .

Returns
SeekMap.SeekPoints!

The corresponding seek points.

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.

isSeekable

fun isSeekable(): Boolean

Returns whether seeking is supported.

Returns
Boolean

Whether seeking is supported.

newFactory

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

Creates a factory for Mp4Extractor 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.

Public properties

durationUs

val durationUsLong