wavex v0.2.7 Wavex.RIFFHeader
Reading a RIFF header.
Link to this section Summary
Functions
Read a RIFF header
Link to this section Types
Link to this section Functions
Link to this function
read(binary)
read(binary()) :: {:ok, t(), binary()} | {:error, Wavex.Error.UnexpectedEOF.t() | Wavex.Error.UnexpectedID.t()}
Read a RIFF header.
Examples
sapp.org, 2018-04-30, Microsoft WAVE soundfile format
iex> Wavex.RIFFHeader.read(<<
...> 0x52, 0x49, 0x46, 0x46, # R I F F
...> 0x24, 0x08, 0x00, 0x00, # 2084
...> 0x57, 0x41, 0x56, 0x45 # W A V E
...> >>)
{:ok, %Wavex.RIFFHeader{size: 2084}, ""}
Bytes 1-4 must read "RIFF"
to indicate the Resource Interchange File Format.
Reading a different id returns an error.
iex> Wavex.RIFFHeader.read(<<"RIFX", 0, 0, 0, 0, "WAVE">>)
{:error, %Wavex.Error.UnexpectedID{expected: "RIFF", actual: "RIFX"}}
Bytes 9-12 must read "WAVE"
to indicate a waveform audio file. Reading a
different id returns an error.
iex> Wavex.RIFFHeader.read(<<"RIFF", 0, 0, 0, 0, "AVI ">>)
{:error, %Wavex.Error.UnexpectedID{expected: "WAVE", actual: "AVI "}}
A binary must be at least 12 bytes to contain a RIFF header.
iex> Wavex.RIFFHeader.read(<<"RIFF", 0, 0>>)
{:error, %Wavex.Error.UnexpectedEOF{}}
Generally, the following holds for any x
:
not is_binary(x) or String.length(x) >= 12 or
Wavex.RIFFHeader.read(x) == %Wavex.Error.UnexpectedEOF{}