miniDSP
A small C library for audio DSP
Loading...
Searching...
No Matches
minidsp_internal.h File Reference

Internal header for cross-file dependencies within the minidsp module. More...

#include "minidsp.h"

Go to the source code of this file.

Macros

#define MD_CHECK(cond, code, msg, retval)
 Check a precondition in a function that returns a value.
#define MD_CHECK_VOID(cond, code, msg)
 Check a precondition in a void function.

Functions

void md_report_error (MD_ErrorCode code, const char *func_name, const char *message)
 Report a precondition violation to the active error handler.
void md_gcc_teardown (void)
 Tear down the GCC-PHAT FFT cache and reset its cached length.
void md_steg_teardown (void)
 Tear down the BFSK sine carrier cache.

Detailed Description

Internal header for cross-file dependencies within the minidsp module.

This header is NOT part of the public API. It declares symbols shared between the split minidsp_*.c translation units but not exposed to library consumers.

Definition in file minidsp_internal.h.

Macro Definition Documentation

◆ MD_CHECK

#define MD_CHECK ( cond,
code,
msg,
retval )
Value:
do { \
if (!(cond)) { \
md_report_error((code), __func__, (msg)); \
return (retval); \
} \
} while (0)

Check a precondition in a function that returns a value.

On failure: report the error, then return retval.

Definition at line 27 of file minidsp_internal.h.

◆ MD_CHECK_VOID

#define MD_CHECK_VOID ( cond,
code,
msg )
Value:
do { \
if (!(cond)) { \
md_report_error((code), __func__, (msg)); \
return; \
} \
} while (0)

Check a precondition in a void function.

On failure: report the error, then return.

Definition at line 38 of file minidsp_internal.h.

Function Documentation

◆ md_gcc_teardown()

void md_gcc_teardown ( void )

Tear down the GCC-PHAT FFT cache and reset its cached length.

Called only from MD_shutdown().

Definition at line 146 of file minidsp_gcc.c.

◆ md_report_error()

void md_report_error ( MD_ErrorCode code,
const char * func_name,
const char * message )

Report a precondition violation to the active error handler.

Definition at line 36 of file minidsp_error.c.

◆ md_steg_teardown()

void md_steg_teardown ( void )

Tear down the BFSK sine carrier cache.

Called only from MD_shutdown().

Definition at line 247 of file minidsp_steg.c.