Membrane.MP4.Container (Membrane MP4 plugin v0.36.5)

View Source

Module for parsing and serializing MP4 files.

Bases on MP4 structure specification from Membrane.MP4.Container.Schema.

Summary

Types

box_name_t()
field_name_t()
fields_t()
parse_error_context_t()
serialize_error_context_t()
t()

Functions

box_path(path)

Maps a path in the MP4 box tree into sequence of keys under which that box resides in MP4.

get_box(mp4, path)

Gets a box from a given path in a parsed MP4.

parse(data)

Parses binary data to MP4 according to Membrane.MP4.Container.Schema.schema/0.

parse(data, schema)

Parses binary data to MP4 according to a custom schema.

parse!(data)

Same as parse/1, raises on error.

parse!(data, schema)

Same as parse/2, raises on error.

serialize(mp4)

Serializes MP4 to a binary according to Membrane.MP4.Container.Schema.schema/0.

serialize(mp4, schema)

Serializes MP4 to a binary according to a custom schema.

serialize!(mp4)

Same as serialize/1, raises on error

serialize!(mp4, schema)

Same as serialize/2, raises on error

update_box(mp4, path, parameter_path \\ [], f)

Updates a box at a given path in a parsed MP4.

Types

box_name_t()

@type box_name_t() :: atom()

field_name_t()

@type field_name_t() :: atom()

fields_t()

@type fields_t() :: %{required(field_name_t()) => term() | [term()] | fields_t()}

parse_error_context_t()

@type parse_error_context_t() :: [
  box: box_name_t(),
  field: field_name_t(),
  data: bitstring(),
  reason:
    :box_header
    | {:box_size, header: pos_integer(), actual: pos_integer()}
    | {:non_empty_leftover, binary()}
]

serialize_error_context_t()

@type serialize_error_context_t() :: [box: box_name_t(), field: field_name_t()]

t()

@type t() :: [
  {box_name_t(), %{content: binary()} | %{fields: fields_t(), children: t()}}
]

Functions

box_path(path)

@spec box_path(box_name_t() | [box_name_t()]) :: [atom()]

Maps a path in the MP4 box tree into sequence of keys under which that box resides in MP4.

get_box(mp4, path)

@spec get_box(t(), box_name_t() | [box_name_t()]) :: t()

Gets a box from a given path in a parsed MP4.

parse(data)

@spec parse(binary()) ::
  {:ok, t(), leftover :: binary()} | {:error, parse_error_context_t()}

Parses binary data to MP4 according to Membrane.MP4.Container.Schema.schema/0.

Returns boxes that have been correctly parsed, and the leftover data that is insufficient to constitute a complete box.

parse(data, schema)

@spec parse(binary(), Membrane.MP4.Container.Schema.t()) ::
  {:ok, t(), leftover :: binary()} | {:error, parse_error_context_t()}

Parses binary data to MP4 according to a custom schema.

Returns boxes that have been correctly parsed, and the leftover data that is insufficient to constitute a complete box.

parse!(data)

@spec parse!(binary()) :: {t(), leftover :: binary()}

Same as parse/1, raises on error.

parse!(data, schema)

@spec parse!(binary(), Membrane.MP4.Container.Schema.t()) ::
  {t(), leftover :: binary()}

Same as parse/2, raises on error.

serialize(mp4)

@spec serialize(t()) :: {:ok, binary()} | {:error, serialize_error_context_t()}

Serializes MP4 to a binary according to Membrane.MP4.Container.Schema.schema/0.

serialize(mp4, schema)

@spec serialize(t(), Membrane.MP4.Container.Schema.t()) ::
  {:ok, binary()} | {:error, serialize_error_context_t()}

Serializes MP4 to a binary according to a custom schema.

serialize!(mp4)

@spec serialize!(t()) :: binary()

Same as serialize/1, raises on error

serialize!(mp4, schema)

@spec serialize!(t(), Membrane.MP4.Container.Schema.t()) :: binary()

Same as serialize/2, raises on error

update_box(mp4, path, parameter_path \\ [], f)

@spec update_box(t(), box_name_t() | [box_name_t()], [atom()], (term() -> term())) ::
  t()

Updates a box at a given path in a parsed MP4.

If parameter_path is set, a parameter within a box is updated.