MatroskaExtractor
@UnstableApi
public class MatroskaExtractor implements Extractor
Extracts data from the Matroska and WebM container formats.
Summary
Nested types |
|---|
protected final class MatroskaExtractor.ChapterEntryHolds data corresponding to a single chapter. |
@DocumentedFlags controlling the behavior of the extractor. |
protected final class MatroskaExtractor.TrackHolds data corresponding to a single track. |
Constants |
|
|---|---|
static final ExtractorsFactory |
This field is deprecated. Use |
static final int |
Flag to disable seeking for cues. |
static final int |
Flag to use the source subtitle formats without modification. |
Public constructors |
|---|
|
This method is deprecated. Use |
This method is deprecated. Use |
MatroskaExtractor(SubtitleParser.Factory subtitleParserFactory)Constructs an instance. |
MatroskaExtractor(Constructs an instance. |
Public methods |
|
|---|---|
final void |
init(ExtractorOutput output)Initializes the extractor with an |
static ExtractorsFactory |
newFactory(SubtitleParser.Factory subtitleParserFactory)Creates a factory for |
final int |
read(ExtractorInput input, PositionHolder seekPosition)Extracts data read from a provided |
final void |
release()Releases all kept resources. |
void |
Notifies the extractor that a seek has occurred. |
final boolean |
sniff(ExtractorInput input)Returns whether this extractor can extract samples from the |
Protected methods |
|
|---|---|
void |
@CallSuperCalled when a binary element is encountered. |
void |
@CallSuperCalled when the end of a master element is encountered. |
void |
@CallSuperCalled when a float element is encountered. |
MatroskaExtractor.ChapterEntry |
getCurrentChapter(int currentElementId)Returns the chapter corresponding to the current EditionEntry element. |
MatroskaExtractor.Track |
getCurrentTrack(int currentElementId)Returns the track corresponding to the current TrackEntry element. |
int |
Maps an element ID to a corresponding type. |
void |
handleBlockAddIDExtraData( |
void |
handleBlockAdditionalData( |
void |
@CallSuperCalled when an integer element is encountered. |
boolean |
@CallSuperChecks if the given id is that of a level 1 element. |
void |
@CallSuperCalled when the start of a master element is encountered. |
void |
@CallSuperCalled when a string element is encountered. |
Inherited Constants |
||||||
|---|---|---|---|---|---|---|
|
Inherited methods |
||||
|---|---|---|---|---|
|
Constants
FLAG_DISABLE_SEEK_FOR_CUES
public static final int FLAG_DISABLE_SEEK_FOR_CUES = 1
Flag to disable seeking for cues.
Normally (i.e. when this flag is not set) the extractor will seek to the cues element if its position is specified in the seek head and if it's after the first cluster. Setting this flag disables seeking to the cues element. If the cues element is after the first cluster then the media is treated as being unseekable.
FLAG_EMIT_RAW_SUBTITLE_DATA
public static final int FLAG_EMIT_RAW_SUBTITLE_DATA = 2
Flag to use the source subtitle formats without modification. If unset, subtitles will be transcoded to APPLICATION_MEDIA3_CUES during extraction.
Public constructors
MatroskaExtractor
public MatroskaExtractor(SubtitleParser.Factory subtitleParserFactory)
Constructs an instance.
| Parameters | |
|---|---|
SubtitleParser.Factory subtitleParserFactory |
The |
MatroskaExtractor
public MatroskaExtractor(
SubtitleParser.Factory subtitleParserFactory,
@MatroskaExtractor.Flags int flags
)
Constructs an instance.
| Parameters | |
|---|---|
SubtitleParser.Factory subtitleParserFactory |
The |
@MatroskaExtractor.Flags int flags |
Flags that control the extractor's behavior. |
Public methods
init
public final 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 MatroskaExtractor instances with the provided SubtitleParser.Factory.
read
public final 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
@CallSuper
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 final 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. |
Protected methods
binaryElement
@CallSuper
protected void binaryElement(int id, int contentSize, ExtractorInput input)
Called when a binary element is encountered.
| Throws | |
|---|---|
java.io.IOException |
| See also | |
|---|---|
binaryElement |
endMasterElement
@CallSuper
protected void endMasterElement(int id)
Called when the end of a master element is encountered.
| See also | |
|---|---|
endMasterElement |
floatElement
@CallSuper
protected void floatElement(int id, double value)
Called when a float element is encountered.
| See also | |
|---|---|
floatElement |
getCurrentChapter
protected MatroskaExtractor.ChapterEntry getCurrentChapter(int currentElementId)
Returns the chapter corresponding to the current EditionEntry element.
| Throws | |
|---|---|
androidx.media3.common.ParserException |
if the element id is not in an EditionEntry. |
getCurrentTrack
protected MatroskaExtractor.Track getCurrentTrack(int currentElementId)
Returns the track corresponding to the current TrackEntry element.
| Throws | |
|---|---|
androidx.media3.common.ParserException |
if the element id is not in a TrackEntry. |
getElementType
@CallSuper
@EbmlProcessor.ElementType
protected int getElementType(int id)
Maps an element ID to a corresponding type.
| See also | |
|---|---|
getElementType |
handleBlockAddIDExtraData
protected void handleBlockAddIDExtraData(
MatroskaExtractor.Track track,
ExtractorInput input,
int contentSize
)
| Throws | |
|---|---|
java.io.IOException |
handleBlockAdditionalData
protected void handleBlockAdditionalData(
MatroskaExtractor.Track track,
int blockAdditionalId,
ExtractorInput input,
int contentSize
)
| Throws | |
|---|---|
java.io.IOException |
integerElement
@CallSuper
protected void integerElement(int id, long value)
Called when an integer element is encountered.
| See also | |
|---|---|
integerElement |
isLevel1Element
@CallSuper
protected boolean isLevel1Element(int id)
Checks if the given id is that of a level 1 element.
| See also | |
|---|---|
isLevel1Element |
startMasterElement
@CallSuper
protected void startMasterElement(int id, long contentPosition, long contentSize)
Called when the start of a master element is encountered.
| See also | |
|---|---|
startMasterElement |
stringElement
@CallSuper
protected void stringElement(int id, String value)
Called when a string element is encountered.
| See also | |
|---|---|
stringElement |