Global setup

Get information on the library. More...

Classes
struct	SOUND4_ProcessInfo

Macros
#define	BIGVOICE_AUDIOFRAME_COUNT   12
#define	BIGVOICE_CHANNEL_COUNT   1
#define	BIGVOICE_AUDIO_INPUT_COUNT   1
#define	BIGVOICE_AUDIO_OUTPUT_COUNT   1
#define	BIGVOICE_SAMPLE_RATE   48000

Typedefs
typedef void(*	bigvoice_loggerfn) (enum bigvoice_LogSeverity, const char *)

Enumerations
enum	bigvoice_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 *	bigvoice_GetVersion ()
unsigned int	bigvoice_GetChunkSizeInFrames ()
unsigned int *	bigvoice_GetPossibleChunkSizeInFrames ()
unsigned int	bigvoice_GetChannelCount ()
unsigned int	bigvoice_GetAudioInputCount ()
unsigned int	bigvoice_GetAudioOutputCount ()
unsigned int	bigvoice_GetSampleRate ()
void	bigvoice_SetLoggerCallback (bigvoice_loggerfn logger)
void	bigvoice_SetLogSeverity (enum bigvoice_LogSeverity severity)

Detailed Description

Get information on the library. Set logging mode.

Macro Definition Documentation

BIGVOICE_AUDIO_INPUT_COUNT

#define BIGVOICE_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 bigvoice_GetAudioInputCount()

Definition at line 54 of file sound4.bigvoice.cl.h.

BIGVOICE_AUDIO_OUTPUT_COUNT

#define BIGVOICE_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 bigvoice_GetAudioOutputCount()

Definition at line 60 of file sound4.bigvoice.cl.h.

BIGVOICE_AUDIOFRAME_COUNT

#define BIGVOICE_AUDIOFRAME_COUNT   12

This version number of frames in a process chunk.

Deprecated:

For binary compatibility, this should be runtime checked to be the same as bigvoice_GetChunkSizeInFrames()

Definition at line 42 of file sound4.bigvoice.cl.h.

BIGVOICE_CHANNEL_COUNT

#define BIGVOICE_CHANNEL_COUNT   1

This version number of channels.

Deprecated:

For binary compatibility, this should be runtime checked to be the same as bigvoice_GetChannelCount()

Definition at line 48 of file sound4.bigvoice.cl.h.

BIGVOICE_SAMPLE_RATE

#define BIGVOICE_SAMPLE_RATE   48000

This input/output sample-rate.

Deprecated:

For binary compatibility, this should be runtime checked to be the same as bigvoice_GetSampleRate()

Definition at line 66 of file sound4.bigvoice.cl.h.

Typedef Documentation

bigvoice_loggerfn

typedef void(* bigvoice_loggerfn) (enum bigvoice_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 181 of file sound4.bigvoice.cl.h.

Enumeration Type Documentation

bigvoice_LogSeverity

enum bigvoice_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 162 of file sound4.bigvoice.cl.h.

Function Documentation

bigvoice_GetAudioInputCount()

unsigned int bigvoice_GetAudioInputCount

(

)

Get the number of inputs for this process

Remarks

All inputs have bigvoice_GetChannelCount() channels

Fixed to 1, but should be checked for backward compatibility

Returns

The process input count

bigvoice_GetAudioOutputCount()

unsigned int bigvoice_GetAudioOutputCount

(

)

Get the number of outputs for this process

Remarks

All outputs have bigvoice_GetChannelCount() channels

Fixed to 1, but should be checked for backward compatibility

Returns

The process outputs count

bigvoice_GetChannelCount()

unsigned int bigvoice_GetChannelCount

(

)

Get the number of channels needed by this process

Remarks

Fixed to 1, but should be checked for backward compatibility

Returns

The process channels count

bigvoice_GetChunkSizeInFrames()

unsigned int bigvoice_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 bigvoice_GetChannelCount samples

Remarks

Fixed to 12, but should be checked for backward compatibility

Returns

The process chunk size in frame

Deprecated:

Use bigvoice_GetPossibleChunkSizeInFrames

bigvoice_GetPossibleChunkSizeInFrames()

unsigned int * bigvoice_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 bigvoice_GetChannelCount samples

Returns

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

bigvoice_GetSampleRate()

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

bigvoice_GetVersion()

const char * bigvoice_GetVersion

(

)

Get the process version string

Returns

version string

bigvoice_SetLoggerCallback()

void bigvoice_SetLoggerCallback

(

bigvoice_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.

bigvoice_SetLogSeverity()

void bigvoice_SetLogSeverity

(

enum bigvoice_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