Class VorbisUtil
- java.lang.Object
-
- com.google.android.exoplayer2.extractor.VorbisUtil
-
public final class VorbisUtil extends Object
Utility methods for parsing Vorbis streams.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVorbisUtil.CommentHeaderVorbis comment header.static classVorbisUtil.ModeVorbis setup header modes.static classVorbisUtil.VorbisIdHeaderVorbis identification header.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static intiLog(int x)Returns ilog(x), which is the index of the highest set bit inx.static MetadataparseVorbisComments(List<String> vorbisComments)Builds aMetadatainstance from a list of Vorbis Comments.static VorbisUtil.CommentHeaderreadVorbisCommentHeader(ParsableByteArray headerData)Reads a Vorbis comment header.static VorbisUtil.CommentHeaderreadVorbisCommentHeader(ParsableByteArray headerData, boolean hasMetadataHeader, boolean hasFramingBit)Reads a Vorbis comment header.static VorbisUtil.VorbisIdHeaderreadVorbisIdentificationHeader(ParsableByteArray headerData)Reads a Vorbis identification header fromheaderData.static VorbisUtil.Mode[]readVorbisModes(ParsableByteArray headerData, int channels)This method reads the modes which are located at the very end of the Vorbis setup header.static booleanverifyVorbisHeaderCapturePattern(int headerType, ParsableByteArray header, boolean quiet)Verifies whether the next bytes inheaderare a Vorbis header of the givenheaderType.
-
-
-
Method Detail
-
iLog
public static int iLog(int x)
Returns ilog(x), which is the index of the highest set bit inx.- Parameters:
x- the value of which the ilog should be calculated.- Returns:
- ilog(x)
- See Also:
- Vorbis spec
-
readVorbisIdentificationHeader
public static VorbisUtil.VorbisIdHeader readVorbisIdentificationHeader(ParsableByteArray headerData) throws ParserException
Reads a Vorbis identification header fromheaderData.- Parameters:
headerData- aParsableByteArraywrapping the header data.- Returns:
- a
VorbisUtil.VorbisIdHeaderwith meta data. - Throws:
ParserException- thrown if invalid capture pattern is detected.- See Also:
- Vorbis spec/Identification header
-
readVorbisCommentHeader
public static VorbisUtil.CommentHeader readVorbisCommentHeader(ParsableByteArray headerData) throws ParserException
Reads a Vorbis comment header.- Parameters:
headerData- AParsableByteArraywrapping the header data.- Returns:
- A
VorbisUtil.CommentHeaderwith all the comments. - Throws:
ParserException- If an error occurs parsing the comment header.- See Also:
- Vorbis spec/Comment header
-
readVorbisCommentHeader
public static VorbisUtil.CommentHeader readVorbisCommentHeader(ParsableByteArray headerData, boolean hasMetadataHeader, boolean hasFramingBit) throws ParserException
Reads a Vorbis comment header.The data provided may not contain the Vorbis metadata common header and the framing bit.
- Parameters:
headerData- AParsableByteArraywrapping the header data.hasMetadataHeader- Whether theheaderDatacontains a Vorbis metadata common header preceding the comment header.hasFramingBit- Whether theheaderDatacontains a framing bit.- Returns:
- A
VorbisUtil.CommentHeaderwith all the comments. - Throws:
ParserException- If an error occurs parsing the comment header.- See Also:
- Vorbis spec/Comment header
-
parseVorbisComments
@Nullable public static Metadata parseVorbisComments(List<String> vorbisComments)
Builds aMetadatainstance from a list of Vorbis Comments.METADATA_BLOCK_PICTURE comments will be transformed into
PictureFrameentries. All others will be transformed intoVorbisCommententries.- Parameters:
vorbisComments- The raw input of comments, as a key-value pair KEY=VAL.- Returns:
- The fully parsed Metadata instance. Null if no vorbis comments could be parsed.
-
verifyVorbisHeaderCapturePattern
public static boolean verifyVorbisHeaderCapturePattern(int headerType, ParsableByteArray header, boolean quiet) throws ParserExceptionVerifies whether the next bytes inheaderare a Vorbis header of the givenheaderType.- Parameters:
headerType- the type of the header expected.header- the alleged header bytes.quiet- iftrueno exceptions are thrown. Insteadfalseis returned.- Returns:
- the number of bytes read.
- Throws:
ParserException- thrown if header type or capture pattern is not as expected.
-
readVorbisModes
public static VorbisUtil.Mode[] readVorbisModes(ParsableByteArray headerData, int channels) throws ParserException
This method reads the modes which are located at the very end of the Vorbis setup header. That's why we need to partially decode or at least read the entire setup header to know where to start reading the modes.- Parameters:
headerData- aParsableByteArraycontaining setup header data.channels- the number of channels.- Returns:
- an array of
VorbisUtil.Modes. - Throws:
ParserException- thrown if bit stream is invalid.- See Also:
- Vorbis spec/Setup header
-
-