View Source Membrane.Matroska.Parser.EBML (Membrane Matroska plugin v0.5.1)

Helper functions for decoding and encoding EBML elements.

EBML RFC: https://datatracker.ietf.org/doc/html/rfc8794

Note that this module does not support parsing Master Elements with unknown data size https://datatracker.ietf.org/doc/html/rfc8794#name-unknown-data-size

Summary

Types

element_type_t()

Functions

decode_element(bytes)

Returns an EBML element's name, type, and data

decode_element_name(element)

Returns the name associated with the EBML ELEMENT_ID of the first Element in the input binary.

decode_vint(bytes)

Returns the number encoded in the VINT_DATA field of the first VINT in the input binary

parse_binary(bytes)
parse_date(arg)
parse_float(arg)
parse_integer(bytes)
parse_master(bytes, schema)
parse_string(bytes)
parse_uint(bytes)
parse_utf8(bytes)

Types

Link to this type

element_type_t()

View Source 
@type element_type_t() ::
  :integer | :uint | :float | :string | :utf_8 | :date | :master | :binary

Functions

Link to this function

decode_element(bytes)

View Source 
@spec decode_element(binary()) ::
  {:ok, {name :: atom(), data :: binary(), rest :: binary()}}
  | {:error, :need_more_bytes}

Returns an EBML element's name, type, and data

Link to this function

decode_element_name(element)

View Source 
@spec decode_element_name(binary()) ::
  {:ok, {atom(), binary()}} | {:error, :need_more_bytes}

Returns the name associated with the EBML ELEMENT_ID of the first Element in the input binary.

EMBL elements are identified by the hexadecimal representation of the entire leading VINT including WIDTH, MARKER and DATA

Link to this function

decode_vint(bytes)

View Source 
@spec decode_vint(binary()) ::
  {:ok, {non_neg_integer(), binary()}} | {:error, :need_more_bytes}

Returns the number encoded in the VINT_DATA field of the first VINT in the input binary

Link to this function

parse_binary(bytes)

View Source 
@spec parse_binary(binary()) :: binary()
Link to this function

parse_date(arg)

View Source 
@spec parse_date(binary()) :: :calendar.datetime()
Link to this function

parse_float(arg)

View Source 
@spec parse_float(binary()) :: float()
Link to this function

parse_integer(bytes)

View Source 
@spec parse_integer(binary()) :: integer()
Link to this function

parse_master(bytes, schema)

View Source 
@spec parse_master(binary(), function()) :: list()
Link to this function

parse_string(bytes)

View Source 
@spec parse_string(binary()) :: binary()
Link to this function

parse_uint(bytes)

View Source 
@spec parse_uint(binary()) :: non_neg_integer()
Link to this function

parse_utf8(bytes)

View Source 
@spec parse_utf8(binary()) :: binary()