@UnstableApi
public final class AviExtractor implements Extractor

Extracts data from the AVI container format.

Spec: https://docs.microsoft.com/en-us/windows/win32/directshow/avi-riff-file-reference.

Summary

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

Flags controlling the behavior of the extractor.

Constants
static final int

Flag to use the source subtitle formats without modification.
static final int
FOURCC_AVI_ = 541677121
static final int
FOURCC_JUNK = 1263424842
static final int
FOURCC_LIST = 1414744396
static final int
FOURCC_RIFF = 1179011410
static final int
FOURCC_auds = 1935963489
static final int
FOURCC_avih = 1751742049
static final int
FOURCC_hdrl = 1819436136
static final int
FOURCC_idx1 = 829973609
static final int
FOURCC_movi = 1769369453
static final int
FOURCC_strf = 1718776947
static final int
FOURCC_strh = 1752331379
static final int
FOURCC_strl = 1819440243
static final int
FOURCC_strn = 1852994675
static final int
FOURCC_txts = 1937012852
static final int
FOURCC_vids = 1935960438

Public constructors

This method is deprecated.

Use AviExtractor instead.
AviExtractor(
    @AviExtractor.Flags int extractorFlags,
    SubtitleParser.Factory subtitleParserFactory
)

Constructs an instance.

Public methods
void

Initializes the extractor with an ExtractorOutput.
int
read(ExtractorInput input, PositionHolder seekPosition)

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

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.

FOURCC_AVI_

public static final int FOURCC_AVI_ = 541677121

FOURCC_JUNK

public static final int FOURCC_JUNK = 1263424842

FOURCC_LIST

public static final int FOURCC_LIST = 1414744396

FOURCC_RIFF

public static final int FOURCC_RIFF = 1179011410

FOURCC_auds

public static final int FOURCC_auds = 1935963489

FOURCC_avih

public static final int FOURCC_avih = 1751742049

FOURCC_hdrl

public static final int FOURCC_hdrl = 1819436136

FOURCC_idx1

public static final int FOURCC_idx1 = 829973609

FOURCC_movi

public static final int FOURCC_movi = 1769369453

FOURCC_strf

public static final int FOURCC_strf = 1718776947

FOURCC_strh

public static final int FOURCC_strh = 1752331379

FOURCC_strl

public static final int FOURCC_strl = 1819440243

FOURCC_strn

public static final int FOURCC_strn = 1852994675

FOURCC_txts

public static final int FOURCC_txts = 1937012852

FOURCC_vids

public static final int FOURCC_vids = 1935960438

Public constructors

AviExtractor

public AviExtractor()

AviExtractor

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

Constructs an instance.

Parameters
@AviExtractor.Flags int extractorFlags

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

The SubtitleParser.Factory for parsing subtitles during extraction.

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.

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 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.