UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Macros | Typedefs | Functions
radaudio_decoder.h File Reference
#include "egttypes.h"
#include <stddef.h>

Go to the source code of this file.

Classes

struct  RadAudioInfo
 

Macros

#define RADAUDIO_DECODER_AT_EOF   -1
 
#define RADAUDIO_DECODER_INCOMPLETE_DATA   -2
 
#define RADAUDIO_DECODER_INVALID_DATA   -3
 
#define RADAUDIO_DECODER_START_OF_STREAM   -4
 
#define RADAUDIO_DECODER_INTERNAL_ERROR   -5
 
#define RADAUDIO_DECODER_MAX_OUTPUT_SAMPLES_PER_CHANNEL_PER_CHUNK   1024
 
#define RADAUDIO_DECODER_LIBRARY_VERSION   1
 
#define RADAUDIO_DECODER_HAS_INTERLEAVING
 
#define RADAUDIO_STREAM_HEADER_SIZE   128
 
#define RR_STRING_JOIN3(arg1, arg2, arg3)   RR_STRING_JOIN_DELAY3(arg1, arg2, arg3)
 
#define RR_STRING_JOIN_DELAY3(arg1, arg2, arg3)   RR_STRING_JOIN_IMMEDIATE3(arg1, arg2, arg3)
 
#define RR_STRING_JOIN_IMMEDIATE3(arg1, arg2, arg3)   arg1 ## arg2 ## arg3
 
#define RADAUDIO_DECODER_NAME(name)   RR_STRING_JOIN( name##_, RADAUDIO_DECODER_LIBRARY_VERSION )
 
#define RadAudioDecoderMemoryRequired   RADAUDIO_DECODER_NAME(RadAudioDecoderMemoryRequired)
 
#define RadAudioDecoderOpen   RADAUDIO_DECODER_NAME(RadAudioDecoderOpen)
 
#define RadAudioDecoderGetInfo   RADAUDIO_DECODER_NAME(RadAudioDecoderGetInfo)
 
#define RadAudioDecoderGetInfoHeader   RADAUDIO_DECODER_NAME(RadAudioDecoderGetInfoHeader)
 
#define RadAudioDecoderDecodeChunk   RADAUDIO_DECODER_NAME(RadAudioDecoderDecodeChunk)
 
#define RadAudioDecoderGetProfileData   RADAUDIO_DECODER_NAME(RadAudioDecoderGetProfileData)
 
#define RadAudioDecoderDidSeek   RADAUDIO_DECODER_NAME(RadAudioDecoderDidSeek)
 
#define RadAudioDecoderGetChunkLength   RADAUDIO_DECODER_NAME(RadAudioDecoderGetChunkLength)
 
#define RadAudioInterleave   RADAUDIO_DECODER_NAME(RadAudioInterleave)
 
#define RadAudio1ChToS16   RADAUDIO_DECODER_NAME(RadAudio1ChToS16)
 
#define RadAudioInterleave2ChToS16   RADAUDIO_DECODER_NAME(RadAudioInterleave2ChToS16)
 
#define RadAudioInterleave4ChToS16   RADAUDIO_DECODER_NAME(RadAudioInterleave4ChToS16)
 

Typedefs

typedef struct RadAudioDecoder RadAudioDecoder
 

Functions

RADDEFFUNC size_t RadAudioDecoderMemoryRequired (U8 *stream_header, size_t stream_header_bytes_valid)
 
RADDEFFUNC RadAudioDecoder * RadAudioDecoderOpen (U8 *stream_header, size_t stream_header_bytes_valid, void *mem, size_t memsize, size_t *out_header_size)
 
RADDEFFUNC void RadAudioDecoderGetInfo (const RadAudioDecoder *radaudio_decoder, RadAudioInfo *out_info)
 
RADDEFFUNC size_t RadAudioDecoderGetInfoHeader (U8 *stream_header, size_t stream_header_bytes_valid, RadAudioInfo *out_info)
 
RADDEFFUNC int RadAudioDecoderDecodeChunk (RadAudioDecoder *radaudio_decoder, const U8 *data, size_t data_avail, size_t *data_consumed, F32 *(output_samples[2]), size_t max_samples)
 
RADDEFFUNC int RadAudioDecoderGetChunkLength (RadAudioDecoder *radaudio_decoder, const U8 *data, size_t data_avail)
 
RADDEFFUNC void RadAudioDecoderDidSeek (RadAudioDecoder *radaudio_decoder)
 
RADDEFFUNC void RadAudioInterleave (S16 *output, float const **inputs, U32 input_count, U32 samples)
 
RADDEFFUNC int RadAudio1ChToS16 (S16 *output, float const *input, U32 samples)
 
RADDEFFUNC int RadAudioInterleave2ChToS16 (S16 *output, float const *input_left, float const *input_right, U32 samples)
 
RADDEFFUNC int RadAudioInterleave4ChToS16 (S16 *output, float const *input_left, float const *input_right, float const *input_back_left, float const *input_back_right, U32 samples)
 

Macro Definition Documentation

◆ RadAudio1ChToS16

#define RadAudio1ChToS16   RADAUDIO_DECODER_NAME(RadAudio1ChToS16)

◆ RADAUDIO_DECODER_AT_EOF

#define RADAUDIO_DECODER_AT_EOF   -1

◆ RADAUDIO_DECODER_HAS_INTERLEAVING

#define RADAUDIO_DECODER_HAS_INTERLEAVING

◆ RADAUDIO_DECODER_INCOMPLETE_DATA

#define RADAUDIO_DECODER_INCOMPLETE_DATA   -2

◆ RADAUDIO_DECODER_INTERNAL_ERROR

#define RADAUDIO_DECODER_INTERNAL_ERROR   -5

◆ RADAUDIO_DECODER_INVALID_DATA

#define RADAUDIO_DECODER_INVALID_DATA   -3

◆ RADAUDIO_DECODER_LIBRARY_VERSION

#define RADAUDIO_DECODER_LIBRARY_VERSION   1

◆ RADAUDIO_DECODER_MAX_OUTPUT_SAMPLES_PER_CHANNEL_PER_CHUNK

#define RADAUDIO_DECODER_MAX_OUTPUT_SAMPLES_PER_CHANNEL_PER_CHUNK   1024

◆ RADAUDIO_DECODER_NAME

#define RADAUDIO_DECODER_NAME (   name)    RR_STRING_JOIN( name##_, RADAUDIO_DECODER_LIBRARY_VERSION )

◆ RADAUDIO_DECODER_START_OF_STREAM

#define RADAUDIO_DECODER_START_OF_STREAM   -4

◆ RADAUDIO_STREAM_HEADER_SIZE

#define RADAUDIO_STREAM_HEADER_SIZE   128

◆ RadAudioDecoderDecodeChunk

#define RadAudioDecoderDecodeChunk   RADAUDIO_DECODER_NAME(RadAudioDecoderDecodeChunk)

◆ RadAudioDecoderDidSeek

#define RadAudioDecoderDidSeek   RADAUDIO_DECODER_NAME(RadAudioDecoderDidSeek)

◆ RadAudioDecoderGetChunkLength

#define RadAudioDecoderGetChunkLength   RADAUDIO_DECODER_NAME(RadAudioDecoderGetChunkLength)

◆ RadAudioDecoderGetInfo

#define RadAudioDecoderGetInfo   RADAUDIO_DECODER_NAME(RadAudioDecoderGetInfo)

◆ RadAudioDecoderGetInfoHeader

#define RadAudioDecoderGetInfoHeader   RADAUDIO_DECODER_NAME(RadAudioDecoderGetInfoHeader)

◆ RadAudioDecoderGetProfileData

#define RadAudioDecoderGetProfileData   RADAUDIO_DECODER_NAME(RadAudioDecoderGetProfileData)

◆ RadAudioDecoderMemoryRequired

#define RadAudioDecoderMemoryRequired   RADAUDIO_DECODER_NAME(RadAudioDecoderMemoryRequired)

◆ RadAudioDecoderOpen

#define RadAudioDecoderOpen   RADAUDIO_DECODER_NAME(RadAudioDecoderOpen)

◆ RadAudioInterleave

#define RadAudioInterleave   RADAUDIO_DECODER_NAME(RadAudioInterleave)

◆ RadAudioInterleave2ChToS16

#define RadAudioInterleave2ChToS16   RADAUDIO_DECODER_NAME(RadAudioInterleave2ChToS16)

◆ RadAudioInterleave4ChToS16

#define RadAudioInterleave4ChToS16   RADAUDIO_DECODER_NAME(RadAudioInterleave4ChToS16)

◆ RR_STRING_JOIN3

#define RR_STRING_JOIN3 (   arg1,
  arg2,
  arg3 
)    RR_STRING_JOIN_DELAY3(arg1, arg2, arg3)

◆ RR_STRING_JOIN_DELAY3

#define RR_STRING_JOIN_DELAY3 (   arg1,
  arg2,
  arg3 
)    RR_STRING_JOIN_IMMEDIATE3(arg1, arg2, arg3)

◆ RR_STRING_JOIN_IMMEDIATE3

#define RR_STRING_JOIN_IMMEDIATE3 (   arg1,
  arg2,
  arg3 
)    arg1 ## arg2 ## arg3

Typedef Documentation

◆ RadAudioDecoder

typedef struct RadAudioDecoder RadAudioDecoder

Function Documentation

◆ RadAudio1ChToS16()

RADDEFFUNC int RadAudio1ChToS16 ( S16 *  output,
float const *  input,
U32  samples 
)

◆ RadAudioDecoderDecodeChunk()

RADDEFFUNC int RadAudioDecoderDecodeChunk ( RadAudioDecoder *  radaudio_decoder,
const U8 *  data,
size_t  data_avail,
size_t *  data_consumed,
F32 *  output_samples[2],
size_t  max_samples 
)

◆ RadAudioDecoderDidSeek()

RADDEFFUNC void RadAudioDecoderDidSeek ( RadAudioDecoder *  radaudio_decoder)

◆ RadAudioDecoderGetChunkLength()

RADDEFFUNC int RadAudioDecoderGetChunkLength ( RadAudioDecoder *  radaudio_decoder,
const U8 *  data,
size_t  data_avail 
)

◆ RadAudioDecoderGetInfo()

RADDEFFUNC void RadAudioDecoderGetInfo ( const RadAudioDecoder *  radaudio_decoder,
RadAudioInfo *  out_info 
)

◆ RadAudioDecoderGetInfoHeader()

RADDEFFUNC size_t RadAudioDecoderGetInfoHeader ( U8 *  stream_header,
size_t  stream_header_bytes_valid,
RadAudioInfo *  out_info 
)

◆ RadAudioDecoderMemoryRequired()

RADDEFFUNC size_t RadAudioDecoderMemoryRequired ( U8 *  stream_header,
size_t  stream_header_bytes_valid 
)

◆ RadAudioDecoderOpen()

RADDEFFUNC RadAudioDecoder * RadAudioDecoderOpen ( U8 *  stream_header,
size_t  stream_header_bytes_valid,
void *  mem,
size_t  memsize,
size_t *  out_header_size 
)

◆ RadAudioInterleave()

RADDEFFUNC void RadAudioInterleave ( S16 *  output,
float const **  inputs,
U32  input_count,
U32  samples 
)

◆ RadAudioInterleave2ChToS16()

RADDEFFUNC int RadAudioInterleave2ChToS16 ( S16 *  output,
float const *  input_left,
float const *  input_right,
U32  samples 
)

◆ RadAudioInterleave4ChToS16()

RADDEFFUNC int RadAudioInterleave4ChToS16 ( S16 *  output,
float const *  input_left,
float const *  input_right,
float const *  input_back_left,
float const *  input_back_right,
U32  samples 
)