Classes
struct	SOUND4_ProcessInfo

Macros
#define	CLOUDX1_AUDIOFRAME_COUNT 64

#define	CLOUDX1_CHANNEL_COUNT 2

#define	CLOUDX1_AUDIO_INPUT_COUNT 1

#define	CLOUDX1_AUDIO_OUTPUT_COUNT 1

#define	CLOUDX1_SAMPLE_RATE 48000

Typedefs
typedef void(*	cloudx1_loggerfn) (enum cloudx1_LogSeverity, const char *)

Enumerations
enum	cloudx1_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 *	cloudx1_GetVersion ()

unsigned int	cloudx1_GetChunkSizeInFrames ()

unsigned int *	cloudx1_GetPossibleChunkSizeInFrames ()

unsigned int	cloudx1_GetChannelCount ()

unsigned int	cloudx1_GetAudioInputCount ()

unsigned int	cloudx1_GetAudioOutputCount ()

unsigned int	cloudx1_GetSampleRate ()

void	cloudx1_SetLoggerCallback (cloudx1_loggerfn logger)

void	cloudx1_SetLogSeverity (enum cloudx1_LogSeverity severity)

Detailed Description

Get information on the library. Set logging mode

Macro Definition Documentation

◆ CLOUDX1_AUDIO_INPUT_COUNT

#define CLOUDX1_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 cloudx1_GetAudioInputCount()

Definition at line 173 of file sound4.x1.cloud.h.

◆ CLOUDX1_AUDIO_OUTPUT_COUNT

#define CLOUDX1_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 cloudx1_GetAudioOutputCount()

Definition at line 179 of file sound4.x1.cloud.h.

◆ CLOUDX1_AUDIOFRAME_COUNT

#define CLOUDX1_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 cloudx1_GetChunkSizeInFrames()

Definition at line 161 of file sound4.x1.cloud.h.

◆ CLOUDX1_CHANNEL_COUNT

#define CLOUDX1_CHANNEL_COUNT 2

This version number of channels.

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

Definition at line 167 of file sound4.x1.cloud.h.

◆ CLOUDX1_SAMPLE_RATE

#define CLOUDX1_SAMPLE_RATE 48000

This input/output sample-rate.

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

Definition at line 185 of file sound4.x1.cloud.h.

Typedef Documentation

◆ cloudx1_loggerfn

typedef void(* cloudx1_loggerfn) (enum cloudx1_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 300 of file sound4.x1.cloud.h.

Enumeration Type Documentation

◆ cloudx1_LogSeverity

enum cloudx1_LogSeverity

The logging levels

Enumerator
none
fatal
error
warning
info
verbose
verbose2
verbose3
verbose4
verbose5

Definition at line 281 of file sound4.x1.cloud.h.

Function Documentation

◆ cloudx1_GetAudioInputCount()

unsigned int cloudx1_GetAudioInputCount ( )

Get the number of inputs for this process

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

Returns: The process input count

◆ cloudx1_GetAudioOutputCount()

unsigned int cloudx1_GetAudioOutputCount ( )

Get the number of outputs for this process

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

Returns: The process outputs count

◆ cloudx1_GetChannelCount()

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

◆ cloudx1_GetChunkSizeInFrames()

unsigned int cloudx1_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 cloudx1_GetChannelCount samples

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

Returns: The process chunk size in frame

Deprecated:: Use cloudx1_GetPossibleChunkSizeInFrames

◆ cloudx1_GetPossibleChunkSizeInFrames()

unsigned int * cloudx1_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 cloudx1_GetChannelCount samples

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

◆ cloudx1_GetSampleRate()

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

◆ cloudx1_GetVersion()

const char * cloudx1_GetVersion ( )

Get the process version string

Returns: version string

◆ cloudx1_SetLoggerCallback()

void cloudx1_SetLoggerCallback ( cloudx1_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.

◆ cloudx1_SetLogSeverity()

void cloudx1_SetLogSeverity ( enum cloudx1_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