Mp4Extractor
@UnstableApi
public final class Mp4Extractor implements Extractor
Extracts data from the MP4 container format.
Summary
Nested types |
|---|
@DocumentedFlags controlling the behavior of the extractor. |
Constants |
|
|---|---|
static final ExtractorsFactory |
This field is deprecated. Use |
static final int |
|
static final int |
Flag to mark the first video track encountered as |
static final int |
Flag to omit allocating and populating the large per-sample arrays (offsets, sizes, timestamps, flags) within |
static final int |
Flag to extract the auxiliary tracks from the MP4 With Auxiliary Tracks Extension (MP4-AT) file format. |
static final int |
This field is deprecated. Use |
static final int |
Flag to extract |
static final int |
Flag to extract additional sample dependency information, and mark output buffers with |
static final int |
Flag to extract additional sample dependency information, and mark output buffers with |
static final int |
Flag to ignore any edit lists in the stream. |
Public constructors |
|---|
|
This method is deprecated. Use |
This method is deprecated. Use |
Mp4Extractor(SubtitleParser.Factory subtitleParserFactory)Creates a new extractor for unfragmented MP4 streams. |
Mp4Extractor(Creates a new extractor for unfragmented MP4 streams, using the specified flags to control the extractor's behavior. |
Public methods |
|
|---|---|
static int |
@Mp4Extractor.FlagsReturns |
long[] |
getSampleTimestampsUs(int trackId)Returns the list of sample timestamps of a |
ImmutableList<SniffFailure> |
Returns additional details about the last call to |
void |
init(ExtractorOutput output)Initializes the extractor with an |
static ExtractorsFactory |
newFactory(SubtitleParser.Factory subtitleParserFactory)Creates a factory for |
int |
read(ExtractorInput input, PositionHolder seekPosition)Extracts data read from a provided |
void |
release()Releases all kept resources. |
void |
seek(long position, long timeUs)Notifies the extractor that a seek has occurred. |
boolean |
sniff(ExtractorInput input)Returns whether this extractor can extract samples from the |
Inherited Constants |
||||||
|---|---|---|---|---|---|---|
|
Inherited methods |
||
|---|---|---|
|
Constants
FLAG_MARK_FIRST_VIDEO_TRACK_WITH_MAIN_ROLE
public static final int FLAG_MARK_FIRST_VIDEO_TRACK_WITH_MAIN_ROLE = 8
Flag to mark the first video track encountered as ROLE_FLAG_MAIN and all subsequent video tracks as ROLE_FLAG_ALTERNATE.
FLAG_OMIT_TRACK_SAMPLE_TABLE
public static final int FLAG_OMIT_TRACK_SAMPLE_TABLE = 256
Flag to omit allocating and populating the large per-sample arrays (offsets, sizes, timestamps, flags) within TrackSampleTable. This is used to reduce memory consumption in metadata retrieval scenarios where individual sample data is not required.
FLAG_READ_AUXILIARY_TRACKS
public static final int FLAG_READ_AUXILIARY_TRACKS = 64
Flag to extract the auxiliary tracks from the MP4 With Auxiliary Tracks Extension (MP4-AT) file format.
Either primary video tracks or auxiliary tracks (but not both) will be extracted based on the flag.
If the flag is set but the auxiliary tracks are not present, then it fallbacks to extract primary tracks instead.
See the file format at https://developer.android.com/media/platform/mp4-at-file-format.
FLAG_READ_SEF_DATA
public static final int FLAG_READ_SEF_DATA = 4
Flag to extract SlowMotionData metadata from Samsung Extension Format (SEF) slow motion videos.
FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES
public static final int FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES = 32
Flag to extract additional sample dependency information, and mark output buffers with BUFFER_FLAG_NOT_DEPENDED_ON for H.264 video.
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.
FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES_H265
public static final int FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES_H265 = 128
Flag to extract additional sample dependency information, and mark output buffers with BUFFER_FLAG_NOT_DEPENDED_ON for H.265 video.
FLAG_WORKAROUND_IGNORE_EDIT_LISTS
public static final int FLAG_WORKAROUND_IGNORE_EDIT_LISTS = 1
Flag to ignore any edit lists in the stream.
Public constructors
Mp4Extractor
public Mp4Extractor(SubtitleParser.Factory subtitleParserFactory)
Creates a new extractor for unfragmented MP4 streams.
| Parameters | |
|---|---|
SubtitleParser.Factory subtitleParserFactory |
The |
Mp4Extractor
public Mp4Extractor(
SubtitleParser.Factory subtitleParserFactory,
@Mp4Extractor.Flags int flags
)
Creates a new extractor for unfragmented MP4 streams, using the specified flags to control the extractor's behavior.
| Parameters | |
|---|---|
SubtitleParser.Factory subtitleParserFactory |
The |
@Mp4Extractor.Flags int flags |
Flags that control the extractor's behavior. |
Public methods
codecsToParseWithinGopSampleDependenciesAsFlags
@Mp4Extractor.Flags
public static int codecsToParseWithinGopSampleDependenciesAsFlags(
@C.VideoCodecFlags int videoCodecFlags
)
Returns Flags denoting if an extractor should parse within GOP sample dependencies.
| Parameters | |
|---|---|
@C.VideoCodecFlags int videoCodecFlags |
The set of codecs for which to parse within GOP sample dependencies. |
getSampleTimestampsUs
public long[] getSampleTimestampsUs(int trackId)
Returns the list of sample timestamps of a trackId, in microseconds.
| Parameters | |
|---|---|
int trackId |
The id of the track to get the sample timestamps. |
| Returns | |
|---|---|
long[] |
The corresponding sample timestmaps of the track. |
getSniffFailureDetails
public ImmutableList<SniffFailure> getSniffFailureDetails()
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
public void init(ExtractorOutput output)
Initializes the extractor with an ExtractorOutput. Called at most once.
| Parameters | |
|---|---|
ExtractorOutput output |
An |
newFactory
public static ExtractorsFactory newFactory(SubtitleParser.Factory subtitleParserFactory)
Creates a factory for Mp4Extractor instances with the provided SubtitleParser.Factory.
read
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 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 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 |
PositionHolder seekPosition |
If |
| Returns | |
|---|---|
int |
One of the |
| Throws | |
|---|---|
java.io.IOException |
If an error occurred reading from or parsing the input. |
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 |
| Returns | |
|---|---|
boolean |
Whether this extractor can read the provided input. |
| Throws | |
|---|---|
java.io.IOException |
If an error occurred reading from the input. |