Get information on the library. More...

Classes
struct	SOUND4_ProcessInfo

Macros
#define	IMPACTFM_AUDIOFRAME_COUNT 64

#define	IMPACTFM_CHANNEL_COUNT 2

#define	IMPACTFM_AUDIO_INPUT_COUNT 1

#define	IMPACTFM_AUDIO_OUTPUT_COUNT 1

#define	IMPACTFM_SAMPLE_RATE 48000

Typedefs
typedef void(*	impactfm_loggerfn) (enum impactfm_LogSeverity, const char *)

Enumerations
enum	impactfm_LogSeverity { none = 0 , fatal = 1 , error = 2 , warning = 3 , info = 4 , verbose = 5 , verbose2 = 6 , verbose3 = 7 , verbose4 = 8 , verbose5 = 9 }

Functions
const struct SOUND4_ProcessInfo *	SOUND4_GetProcessInfo ()

const char *	impactfm_GetVersion ()

unsigned int	impactfm_GetChunkSizeInFrames ()

unsigned int *	impactfm_GetPossibleChunkSizeInFrames ()

unsigned int	impactfm_GetChannelCount ()

unsigned int	impactfm_GetAudioInputCount ()

unsigned int	impactfm_GetAudioOutputCount ()

unsigned int	impactfm_GetSampleRate ()

void	impactfm_SetLoggerCallback (impactfm_loggerfn logger)

void	impactfm_SetLogSeverity (enum impactfm_LogSeverity severity)

Detailed Description

Get information on the library. Set logging mode.

Macro Definition Documentation

◆ IMPACTFM_AUDIO_INPUT_COUNT

#define IMPACTFM_AUDIO_INPUT_COUNT 1

This version number of inputs for this process.

Deprecated:: For binary compatibility, this should be runtime checked to be the same as impactfm_GetAudioInputCount()

Definition at line 58 of file sound4.impactfm.cl.h.

◆ IMPACTFM_AUDIO_OUTPUT_COUNT

#define IMPACTFM_AUDIO_OUTPUT_COUNT 1

This version number of outputs for this process.

Deprecated:: For binary compatibility, this should be runtime checked to be the same as impactfm_GetAudioOutputCount()

Definition at line 64 of file sound4.impactfm.cl.h.

◆ IMPACTFM_AUDIOFRAME_COUNT

#define IMPACTFM_AUDIOFRAME_COUNT 64

This version number of frames in a process chunk.

Deprecated:: For binary compatibility, this should be runtime checked to be the same as impactfm_GetChunkSizeInFrames()

Definition at line 46 of file sound4.impactfm.cl.h.

◆ IMPACTFM_CHANNEL_COUNT

#define IMPACTFM_CHANNEL_COUNT 2

This version number of channels.

Deprecated:: For binary compatibility, this should be runtime checked to be the same as impactfm_GetChannelCount()

Definition at line 52 of file sound4.impactfm.cl.h.

◆ IMPACTFM_SAMPLE_RATE

#define IMPACTFM_SAMPLE_RATE 48000

This input/output sample-rate.

Deprecated:: For binary compatibility, this should be runtime checked to be the same as impactfm_GetSampleRate()

Definition at line 70 of file sound4.impactfm.cl.h.

Typedef Documentation

◆ impactfm_loggerfn

typedef void(* impactfm_loggerfn) (enum impactfm_LogSeverity, const char *)

The logging callback format

Warning: Do not block/wait in the callback, it can be called from any place in code

Note: In all library, all char* are UTF-8 encoded

Definition at line 185 of file sound4.impactfm.cl.h.

Enumeration Type Documentation

◆ impactfm_LogSeverity

enum impactfm_LogSeverity

The logging levels

Enumerator
none	Not used.
fatal	fatal error
error	error
warning	warning
info	info
verbose	verbose
verbose2	verbose2
verbose3	verbose3
verbose4	verbose4
verbose5	verbose5

Definition at line 166 of file sound4.impactfm.cl.h.

Function Documentation

◆ impactfm_GetAudioInputCount()

unsigned int impactfm_GetAudioInputCount ( )

Get the number of inputs for this process

Remarks: All inputs have impactfm_GetChannelCount() channels; Fixed to 1, but should be checked for backward compatibility

Returns: The process input count

◆ impactfm_GetAudioOutputCount()

unsigned int impactfm_GetAudioOutputCount ( )

Get the number of outputs for this process

Remarks: All outputs have impactfm_GetChannelCount() channels; Fixed to 1, but should be checked for backward compatibility

Returns: The process outputs count

◆ impactfm_GetChannelCount()

unsigned int impactfm_GetChannelCount ( )

Get the number of channels needed by this process

Remarks: Fixed to 2, but should be checked for backward compatibility

Returns: The process channels count

◆ impactfm_GetChunkSizeInFrames()

unsigned int impactfm_GetChunkSizeInFrames ( )

Get the default number of frames in a process chunk.

The output will be available only by chunks of this size.

Note: A Frame is a set of impactfm_GetChannelCount samples

Remarks: Fixed to 64, but should be checked for backward compatibility

Returns: The process chunk size in frame

Deprecated:: Use impactfm_GetPossibleChunkSizeInFrames

◆ impactfm_GetPossibleChunkSizeInFrames()

unsigned int * impactfm_GetPossibleChunkSizeInFrames ( )

Get the possibles number of frames in a process chunk.

The output will be available only by chunks of this size.

Note: A Frame is a set of impactfm_GetChannelCount samples

Returns: An array of possible process chunk size in frame, ending with 0

◆ impactfm_GetSampleRate()

unsigned int impactfm_GetSampleRate ( )

Get the processing sample-rate

Remarks: For now, always return 48000, but should be checked for backward compatibility

Returns: The process sample-rate in Hz

◆ impactfm_GetVersion()

const char * impactfm_GetVersion ( )

Get the process version string

Returns: version string

◆ impactfm_SetLoggerCallback()

void impactfm_SetLoggerCallback ( impactfm_loggerfn logger )

Set a callback for logging

If not set, a default logger prints to stderr.

Warning: Do not block/wait in the callback, it can be called from any place in code; The message pointer is only valid for the duration of the call: copy the string if you need to keep it

Parameters

logger A C callback called for logging.

◆ impactfm_SetLogSeverity()

void impactfm_SetLogSeverity ( enum impactfm_LogSeverity severity )

Change the global log severity

Logs above this level will not be printed.

Parameters

severity Log severity

◆ SOUND4_GetProcessInfo()

const struct SOUND4_ProcessInfo * SOUND4_GetProcessInfo ( )

Get this processor description

Common to all SOUND4 processors.

Returns: the process description

Classes

Macros

Typedefs

Enumerations

Functions