Macros
#define	IMPACT_AUDIOFRAME_COUNT 64

#define	IMPACT_CHANNEL_COUNT 2

#define	IMPACT_AUDIO_INPUT_COUNT 1

#define	IMPACT_AUDIO_OUTPUT_COUNT 1

#define	IMPACT_SAMPLE_RATE 48000

Typedefs
typedef void(*	impact_loggerfn) (enum impact_LogSeverity, const char *)

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

Functions
const char *	impact_GetVersion ()

unsigned int	impact_GetChunkSizeInFrames ()

unsigned int *	impact_GetPossibleChunkSizeInFrames ()

unsigned int	impact_GetChannelCount ()

unsigned int	impact_GetAudioInputCount ()

unsigned int	impact_GetAudioOutputCount ()

unsigned int	impact_GetSampleRate ()

void	impact_SetLoggerCallback (impact_loggerfn logger)

void	impact_SetLogSeverity (enum impact_LogSeverity severity)

Detailed Description

Get information on the library. Set logging mode

Macro Definition Documentation

◆ IMPACT_AUDIO_INPUT_COUNT

#define IMPACT_AUDIO_INPUT_COUNT 1

This version number of inputs for this process.

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

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

◆ IMPACT_AUDIO_OUTPUT_COUNT

#define IMPACT_AUDIO_OUTPUT_COUNT 1

This version number of outputs for this process.

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

Definition at line 172 of file sound4.impact.cl.h.

◆ IMPACT_AUDIOFRAME_COUNT

#define IMPACT_AUDIOFRAME_COUNT 64

This version number of frames in a process chunk.

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

Definition at line 154 of file sound4.impact.cl.h.

◆ IMPACT_CHANNEL_COUNT

#define IMPACT_CHANNEL_COUNT 2

This version number of channels.

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

Definition at line 160 of file sound4.impact.cl.h.

◆ IMPACT_SAMPLE_RATE

#define IMPACT_SAMPLE_RATE 48000

This input/output sample-rate.

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

Definition at line 178 of file sound4.impact.cl.h.

Typedef Documentation

◆ impact_loggerfn

typedef void(* impact_loggerfn) (enum impact_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 271 of file sound4.impact.cl.h.

Enumeration Type Documentation

◆ impact_LogSeverity

enum impact_LogSeverity

The logging levels

Enumerator
none
fatal
error
warning
info
verbose
verbose2
verbose3
verbose4
verbose5

Definition at line 252 of file sound4.impact.cl.h.

Function Documentation

◆ impact_GetAudioInputCount()

unsigned int impact_GetAudioInputCount ( )

Get the number of inputs for this process

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

Returns: The process input count

◆ impact_GetAudioOutputCount()

unsigned int impact_GetAudioOutputCount ( )

Get the number of outputs for this process

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

Returns: The process outputs count

◆ impact_GetChannelCount()

unsigned int impact_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

◆ impact_GetChunkSizeInFrames()

unsigned int impact_GetChunkSizeInFrames ( )

Get the 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 impact_GetChannelCount samples

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

Returns: The process chunk size in frame

Deprecated:: Use impact_GetPossibleChunkSizeInFrames

◆ impact_GetPossibleChunkSizeInFrames()

unsigned int* impact_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 impact_GetChannelCount samples

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

◆ impact_GetSampleRate()

unsigned int impact_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

◆ impact_GetVersion()

const char* impact_GetVersion ( )

Get the process version string

Returns: version string

◆ impact_SetLoggerCallback()

void impact_SetLoggerCallback ( impact_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

Parameters

logger A C callback called for logging.

◆ impact_SetLogSeverity()

void impact_SetLogSeverity ( enum impact_LogSeverity severity )

Change the global log severity

Logs above this level will not be printed.