Epok Engine

EPOK RUNTIME

epok::fmv::decode_frame

Function · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Decodes one frame into `out`: the MDEC decode command followed by the run-length codes, padded with end-of-block codes to whole 32-word DMA blocks.

Belongs to
epok::fmv
Header
fmv_bitstream.hpp
Overloads
1

Declaration

Declaration
inline BsResult decode_frame(const uint8_t *frame, uint32_t bytes, uint32_t width, uint32_t height, uint32_t *out, uint32_t capacity, bool tv_levels = false)

Decodes one frame into `out`: the MDEC decode command followed by the run-length codes, padded with end-of-block codes to whole 32-word DMA blocks.

ParameterTypeMeaning
frameconst uint8_t *Not documented; consult the linked header.
bytesuint32_tNot documented; consult the linked header.
widthuint32_tNot documented; consult the linked header.
heightuint32_tNot documented; consult the linked header.
outuint32_t *Not documented; consult the linked header.
capacityuint32_tNot documented; consult the linked header.
tv_levelsboolNot documented; consult the linked header.

Returns: BsResult. Consult the linked header for its meaning.

Example sketch

C++ example
#include "fmv_bitstream.hpp"

// Assume these named values have been initialized with valid data:
// const uint8_t * frame
// uint32_t bytes
// uint32_t width
// uint32_t height
// uint32_t * out
// uint32_t capacity
// bool tv_levels

auto result = epok::fmv::decode_frame(frame, bytes, width, height, out, capacity, tv_levels);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/fmv_bitstream.hpp:291

Related members