Current section

Files

Jump to
wavex lib wavex riff_header.ex
Raw

lib/wavex/riff_header.ex

defmodule Wavex.RIFFHeader do
@moduledoc """
Reading a RIFF header.
"""
alias Wavex.Error.{UnexpectedEOF, UnexpectedID}
alias Wavex.Utils
defstruct [:size]
@type t :: %__MODULE__{size: pos_integer}
@doc ~S"""
Read a RIFF header.
## Examples
[sapp.org, 2018-04-30, Microsoft WAVE soundfile format](http://soundfile.sapp.org/doc/WaveFormat/)
iex> Wavex.RIFFHeader.read(<<
...> 0x52, 0x49, 0x46, 0x46, # R I F F
...> 0x24, 0x08, 0x00, 0x00, # 38
...> 0x57, 0x41, 0x56, 0x45 # W A V E
...> >>)
{:ok, %Wavex.RIFFHeader{size: 2084}, ""}
iex> Wavex.RIFFHeader.read(<<"RIFX", 0, 0, 0, 0, "WAVE">>)
{:error, %Wavex.Error.UnexpectedID{expected: "RIFF", actual: "RIFX"}}
"""
@spec read(binary) :: {:ok, t, binary} | {:error, UnexpectedEOF.t() | UnexpectedID.t()}
def read(binary) do
with {:ok, etc} <- Utils.read_id(binary, "RIFF"),
<<size::32-little, etc::binary>> <- etc,
{:ok, etc} <- Utils.read_id(etc, "WAVE") do
{:ok, %__MODULE__{size: size}, etc}
else
value when is_binary(value) -> {:error, %UnexpectedEOF{}}
{:error, _} = error -> error
end
end
end