sound4cl_cdef.h File Reference

C function signature definition for all sound4.cl libraries. More...

#include <stdint.h>
#include <stringapiset.h>
#include <wchar.h>

Go to the source code of this file.

Classes
struct	sound4cl_SOUND4_ProcessInfo

Macros
#define	fs_strdup   wcsdup
	helper for OS dependant file name copy
#define	SOUND4_INVALID_WEBSERVER_ID   ((uint64_t)-1)
#define	SOUND4_WEBSERVER_HTTP_OK   (1<<0)
#define	SOUND4_WEBSERVER_HTTPS_OK   (1<<1)

Typedefs
typedef wchar_t	fs_char
typedef void(*	sound4cl_loggerfn) (enum sound4cl_LogSeverity, const char *)
typedef char *(*	sound4cl_storage_reader) (const fs_char *filename, void *userdata)
typedef void(*	sound4cl_storage_reader_free) (char *content, void *userdata)
typedef int(*	sound4cl_storage_writer) (const fs_char *filename, const char *content, void *userdata)
typedef int(*	sound4cl_storage_exists) (const fs_char *filename, void *userdata)
typedef fs_char **(*	sound4cl_storage_getall) (void *userdata)
typedef void(*	sound4cl_storage_getall_free) (fs_char **all, void *userdata)
typedef int(*	sound4cl_storage_remove) (const fs_char *filename, void *userdata)
typedef int(*	sound4cl_storage_rename) (const fs_char *from, const fs_char *to, void *userdata)

Enumerations
enum	sound4cl_LogSeverity {   sound4cl_none = 0 , sound4cl_fatal = 1 , sound4cl_error = 2 , sound4cl_warning = 3 ,   sound4cl_info = 4 , sound4cl_verbose = 5 , sound4cl_verbose2 = 6 , sound4cl_verbose3 = 7 ,   sound4cl_verbose4 = 8 , sound4cl_verbose5 = 9 }
enum	sound4cl_PresetChange_Kind { change_kind_created = 1 , change_kind_modified , change_kind_deleted }
enum	sound4cl_SampleFormat {   INVALID_FORMAT =0 , S16_LE , S16_BE , S24_LE ,   S24_BE , S32_LE , S32_BE , F32_LE ,   F32_BE , S16_NATIVE =S16_LE , S24_NATIVE =S24_LE , S32_NATIVE =S32_LE ,   F32_NATIVE =F32_LE }

Functions
const struct sound4cl_SOUND4_ProcessInfo *	sound4cl_SOUND4_GetProcessInfo ()
const char *	sound4cl_GetVersion ()
unsigned int	sound4cl_GetChunkSizeInFrames ()
unsigned int *	sound4cl_GetPossibleChunkSizeInFrames ()
unsigned int	sound4cl_GetChannelCount ()
unsigned int	sound4cl_GetAudioInputCount ()
unsigned int	sound4cl_GetAudioOutputCount ()
unsigned int	sound4cl_GetSampleRate ()
void	sound4cl_SetLoggerCallback (sound4cl_loggerfn logger)
void	sound4cl_SetLogSeverity (enum sound4cl_LogSeverity severity)
struct sound4cl_CParameters *	sound4cl_NewParameters ()
void	sound4cl_FreeParameters (struct sound4cl_CParameters *params)
void	sound4cl_SetParameter (struct sound4cl_CParameters *params, const char *name, const char *value)
const char *	sound4cl_GetParameter (struct sound4cl_CParameters *params, const char *name)
void	sound4cl_FreeParameterValue (const char *value)
struct sound4cl_CInstance *	sound4cl_InitProcess (const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path)
struct sound4cl_CInstance *	sound4cl_InitProcess2 (const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct sound4cl_CParameters *parameters)
struct sound4cl_CInstance *	sound4cl_InitProcess3 (const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct sound4cl_CParameters *parameters, unsigned int frames_per_chunk)
unsigned int	sound4cl_GetProcessChunkFrames (struct sound4cl_CInstance *instance)
int	sound4cl_TerminateProcess (struct sound4cl_CInstance *instance)
void	sound4cl_ExitProcess (struct sound4cl_CInstance *instance)
struct sound4cl_CBus *	sound4cl_NewBus ()
void	sound4cl_FreeBus (struct sound4cl_CBus *bus)
void	sound4cl_SetInstanceBus (struct sound4cl_CParameters *params, struct sound4cl_CBus *bus)
void	sound4cl_SetPresetManager (struct sound4cl_CParameters *params, sound4cl_storage_reader reader, sound4cl_storage_reader_free, sound4cl_storage_writer writer, sound4cl_storage_exists exists, sound4cl_storage_getall getall, sound4cl_storage_getall_free getall_free, sound4cl_storage_remove remove, sound4cl_storage_rename rename, int IsReadOnly, void *userdata)
void	sound4cl_PresetManager_InformChange (struct sound4cl_CInstance *instance, const fs_char *relative_path, enum sound4cl_PresetChange_Kind change_kind)
void	sound4cl_SetMetadata (struct sound4cl_CInstance *instance, const char *key, const char *value)
void	sound4cl_SetMetadataMulti (struct sound4cl_CInstance *instance, const char **keyvalue)
const char **	sound4cl_GetMetadataInfos (struct sound4cl_CInstance *instance)
void	sound4cl_FreeMetadataInfos (struct sound4cl_CInstance *instance, const char **infos)
void	sound4cl_StartUpdateThread (struct sound4cl_CInstance *instance, unsigned int port)
void	sound4cl_StopUpdateThread (struct sound4cl_CInstance *instance)
int	sound4cl_WaitUpdateThreadReady (struct sound4cl_CInstance *instance, int milliseconds)
void	sound4cl_ProcessAudio (struct sound4cl_CInstance *instance, const float *input, float *output)
void	sound4cl_ProcessAudio_Planar (struct sound4cl_CInstance *instance, float const *const *input, float *const *output)
float *	sound4cl_GetBufferIn (struct sound4cl_CInstance *instance)
float *	sound4cl_GetBufferOut (struct sound4cl_CInstance *instance)
unsigned int	sound4cl_GetEstimatedDelay (struct sound4cl_CInstance *instance)
const char *	sound4cl_GetFormatName (const enum sound4cl_SampleFormat fmt)
enum sound4cl_SampleFormat	sound4cl_GetFormatFromName (const char *name)
unsigned int	sound4cl_GetBytesFromFormat (const enum sound4cl_SampleFormat fmt)
unsigned int	sound4cl_GetMaxPacketFrame (struct sound4cl_CInstance *instance)
unsigned int	sound4cl_AddAudio (struct sound4cl_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum sound4cl_SampleFormat fmt)
unsigned int	sound4cl_AddPadAudio (struct sound4cl_CInstance *instance)
unsigned int	sound4cl_GetOutputCount (struct sound4cl_CInstance *instance)
unsigned int	sound4cl_GetAudio (struct sound4cl_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum sound4cl_SampleFormat fmt)
void	sound4cl_AudioConvertFrom (const uint8_t *payload, float *output, size_t nSpl, enum sound4cl_SampleFormat fmt)
void	sound4cl_AudioConvertTo (const float *input, uint8_t *payload, size_t nSpl, enum sound4cl_SampleFormat fmt)
void	sound4cl_StereoToMono (const float *input, float *output, size_t nFrame)
void	sound4cl_MonoToStereo (const float *input, float *output, size_t nFrame)
void	sound4cl_StereoToMono_Planar (const float *inputL, const float *inputR, float *output, size_t nFrame)
void	sound4cl_MonoToStereo_Planar (const float *input, float *outputL, float *outputR, size_t nFrame)
void	sound4cl_AudioMonoFromLiveStereo (const uint8_t *payload, float *output)
void	sound4cl_AudioMonoToLiveStereo (const float *input, uint8_t *payload)
struct sound4cl_CClientInstance *	sound4cl_NewClient (struct sound4cl_CInstance *instance)
void	sound4cl_DeleteClient (struct sound4cl_CClientInstance *client)
const char *	sound4cl_ProcessJson (struct sound4cl_CClientInstance *client, const char *json_str, int *need_save)
void	sound4cl_FreeJsonAnswer (const char *json_str)
int	sound4cl_SaveState (struct sound4cl_CInstance *instance)
uint64_t	sound4cl_Webserver_tcp (unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port)
uint64_t	sound4cl_Webserver_tcp2 (unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct sound4cl_CParameters *parameters)
uint64_t	sound4cl_Webserver (unsigned int listenport, unsigned int listenport_secure, struct sound4cl_CInstance *instance)
int	sound4cl_Webserver_Stop (uint64_t id, int timeout_ms)
int	sound4cl_Webserver_Status (uint64_t id)
void	sound4cl_Webserver_SetAppHealth (struct sound4cl_CInstance *instance, int httpcode, const char *contenttype, const char *content)
void	sound4cl_Webserver_GetAppHealth (struct sound4cl_CInstance *instance, int *httpcode, char **contenttype, char **content)
void	sound4cl_Webserver_FreeString (char *str)

Macro Definition Documentation

fs_strdup

#define fs_strdup   wcsdup

Definition at line 17 of file sound4cl_cdef.h.

SOUND4_INVALID_WEBSERVER_ID

#define SOUND4_INVALID_WEBSERVER_ID   ((uint64_t)-1)

Definition at line 62 of file sound4cl_cdef.h.

SOUND4_WEBSERVER_HTTP_OK

#define SOUND4_WEBSERVER_HTTP_OK   (1<<0)

Definition at line 63 of file sound4cl_cdef.h.

SOUND4_WEBSERVER_HTTPS_OK

#define SOUND4_WEBSERVER_HTTPS_OK   (1<<1)

Definition at line 64 of file sound4cl_cdef.h.

Typedef Documentation

fs_char

typedef wchar_t fs_char

Definition at line 18 of file sound4cl_cdef.h.

sound4cl_loggerfn

typedef void(* sound4cl_loggerfn) (enum sound4cl_LogSeverity, const char *)

Definition at line 102 of file sound4cl_cdef.h.

sound4cl_storage_exists

typedef int(* sound4cl_storage_exists) (const fs_char *filename, void *userdata)

Definition at line 143 of file sound4cl_cdef.h.

sound4cl_storage_getall

typedef fs_char **(* sound4cl_storage_getall) (void *userdata)

Definition at line 144 of file sound4cl_cdef.h.

sound4cl_storage_getall_free

typedef void(* sound4cl_storage_getall_free) (fs_char **all, void *userdata)

Definition at line 145 of file sound4cl_cdef.h.

sound4cl_storage_reader

typedef char *(* sound4cl_storage_reader) (const fs_char *filename, void *userdata)

Definition at line 140 of file sound4cl_cdef.h.

sound4cl_storage_reader_free

typedef void(* sound4cl_storage_reader_free) (char *content, void *userdata)

Definition at line 141 of file sound4cl_cdef.h.

sound4cl_storage_remove

typedef int(* sound4cl_storage_remove) (const fs_char *filename, void *userdata)

Definition at line 146 of file sound4cl_cdef.h.

sound4cl_storage_rename

typedef int(* sound4cl_storage_rename) (const fs_char *from, const fs_char *to, void *userdata)

Definition at line 147 of file sound4cl_cdef.h.

sound4cl_storage_writer

typedef int(* sound4cl_storage_writer) (const fs_char *filename, const char *content, void *userdata)

Definition at line 142 of file sound4cl_cdef.h.

Enumeration Type Documentation

sound4cl_LogSeverity

enum sound4cl_LogSeverity

Enumerator
sound4cl_none
sound4cl_fatal
sound4cl_error
sound4cl_warning
sound4cl_info
sound4cl_verbose
sound4cl_verbose2
sound4cl_verbose3
sound4cl_verbose4
sound4cl_verbose5

Definition at line 41 of file sound4cl_cdef.h.

sound4cl_PresetChange_Kind

enum sound4cl_PresetChange_Kind

Enumerator
change_kind_created	Path has been created.
change_kind_modified	Path has been modified.
change_kind_deleted	Path has been deleted.

Definition at line 57 of file sound4cl_cdef.h.

sound4cl_SampleFormat

enum sound4cl_SampleFormat

Supported formats for audio I/O

Enumerator
INVALID_FORMAT	Invalid.
S16_LE	16-bit signed integer, little-endian
S16_BE	16-bit signed integer, big-endian
S24_LE	24-bit signed integer, little-endian
S24_BE	24-bit signed integer, big-endian
S32_LE	32-bit signed integer, little-endian
S32_BE	32-bit signed integer, big-endian
F32_LE	32-bit floating-point, little-endian
F32_BE	32-bit floating-point, big-endian
S16_NATIVE	16-bit signed integer, native
S24_NATIVE	24-bit signed integer, native
S32_NATIVE	32-bit signed integer, native
F32_NATIVE	32-bit floating-point, native

Definition at line 69 of file sound4cl_cdef.h.

Function Documentation

sound4cl_AddAudio()

unsigned int sound4cl_AddAudio	(	struct sound4cl_CInstance *	instance,
		const uint8_t *	payload,
		unsigned int	nFrame,
		enum sound4cl_SampleFormat	fmt
	)

sound4cl_AddPadAudio()

unsigned int sound4cl_AddPadAudio

(

struct sound4cl_CInstance *

instance

)

sound4cl_AudioConvertFrom()

void sound4cl_AudioConvertFrom	(	const uint8_t *	payload,
		float *	output,
		size_t	nSpl,
		enum sound4cl_SampleFormat	fmt
	)

sound4cl_AudioConvertTo()

void sound4cl_AudioConvertTo	(	const float *	input,
		uint8_t *	payload,
		size_t	nSpl,
		enum sound4cl_SampleFormat	fmt
	)

sound4cl_AudioMonoFromLiveStereo()

void sound4cl_AudioMonoFromLiveStereo	(	const uint8_t *	payload,
		float *	output
	)

sound4cl_AudioMonoToLiveStereo()

void sound4cl_AudioMonoToLiveStereo	(	const float *	input,
		uint8_t *	payload
	)

sound4cl_DeleteClient()

void sound4cl_DeleteClient

(

struct sound4cl_CClientInstance *

client

)

sound4cl_ExitProcess()

void sound4cl_ExitProcess

(

struct sound4cl_CInstance *

instance

)

sound4cl_FreeBus()

void sound4cl_FreeBus

(

struct sound4cl_CBus *

bus

)

sound4cl_FreeJsonAnswer()

void sound4cl_FreeJsonAnswer

(

const char *

json_str

)

sound4cl_FreeMetadataInfos()

void sound4cl_FreeMetadataInfos	(	struct sound4cl_CInstance *	instance,
		const char **	infos
	)

sound4cl_FreeParameters()

void sound4cl_FreeParameters

(

struct sound4cl_CParameters *

params

)

sound4cl_FreeParameterValue()

void sound4cl_FreeParameterValue

(

const char *

value

)

sound4cl_GetAudio()

unsigned int sound4cl_GetAudio	(	struct sound4cl_CInstance *	instance,
		uint8_t *	payload,
		unsigned int	max_nFrame,
		enum sound4cl_SampleFormat	fmt
	)

sound4cl_GetAudioInputCount()

unsigned int sound4cl_GetAudioInputCount

(

)

sound4cl_GetAudioOutputCount()

unsigned int sound4cl_GetAudioOutputCount

(

)

sound4cl_GetBufferIn()

float * sound4cl_GetBufferIn

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetBufferOut()

float * sound4cl_GetBufferOut

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetBytesFromFormat()

unsigned int sound4cl_GetBytesFromFormat

(

const enum sound4cl_SampleFormat

fmt

)

sound4cl_GetChannelCount()

unsigned int sound4cl_GetChannelCount

(

)

sound4cl_GetChunkSizeInFrames()

unsigned int sound4cl_GetChunkSizeInFrames

(

)

sound4cl_GetEstimatedDelay()

unsigned int sound4cl_GetEstimatedDelay

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetFormatFromName()

enum sound4cl_SampleFormat sound4cl_GetFormatFromName

(

const char *

name

)

sound4cl_GetFormatName()

const char * sound4cl_GetFormatName

(

const enum sound4cl_SampleFormat

fmt

)

sound4cl_GetMaxPacketFrame()

unsigned int sound4cl_GetMaxPacketFrame

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetMetadataInfos()

const char ** sound4cl_GetMetadataInfos

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetOutputCount()

unsigned int sound4cl_GetOutputCount

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetParameter()

const char * sound4cl_GetParameter	(	struct sound4cl_CParameters *	params,
		const char *	name
	)

sound4cl_GetPossibleChunkSizeInFrames()

unsigned int * sound4cl_GetPossibleChunkSizeInFrames

(

)

sound4cl_GetProcessChunkFrames()

unsigned int sound4cl_GetProcessChunkFrames

(

struct sound4cl_CInstance *

instance

)

sound4cl_GetSampleRate()

unsigned int sound4cl_GetSampleRate

(

)

sound4cl_GetVersion()

const char * sound4cl_GetVersion

(

)

sound4cl_InitProcess()

struct sound4cl_CInstance * sound4cl_InitProcess	(	const char *	LoginKey,
		const char *	RadioName,
		const char *	Access_Key_ID,
		const char *	Access_Key_Secret,
		const char *	save_path
	)

sound4cl_InitProcess2()

struct sound4cl_CInstance * sound4cl_InitProcess2	(	const char *	LoginKey,
		const char *	RadioName,
		const char *	Access_Key_ID,
		const char *	Access_Key_Secret,
		const char *	save_path,
		const struct sound4cl_CParameters *	parameters
	)

sound4cl_InitProcess3()

struct sound4cl_CInstance * sound4cl_InitProcess3	(	const char *	LoginKey,
		const char *	RadioName,
		const char *	Access_Key_ID,
		const char *	Access_Key_Secret,
		const char *	save_path,
		const struct sound4cl_CParameters *	parameters,
		unsigned int	frames_per_chunk
	)

sound4cl_MonoToStereo()

void sound4cl_MonoToStereo	(	const float *	input,
		float *	output,
		size_t	nFrame
	)

sound4cl_MonoToStereo_Planar()

void sound4cl_MonoToStereo_Planar	(	const float *	input,
		float *	outputL,
		float *	outputR,
		size_t	nFrame
	)

sound4cl_NewBus()

struct sound4cl_CBus * sound4cl_NewBus

(

)

sound4cl_NewClient()

struct sound4cl_CClientInstance * sound4cl_NewClient

(

struct sound4cl_CInstance *

instance

)

sound4cl_NewParameters()

struct sound4cl_CParameters * sound4cl_NewParameters

(

)

sound4cl_PresetManager_InformChange()

void sound4cl_PresetManager_InformChange	(	struct sound4cl_CInstance *	instance,
		const fs_char *	relative_path,
		enum sound4cl_PresetChange_Kind	change_kind
	)

sound4cl_ProcessAudio()

void sound4cl_ProcessAudio	(	struct sound4cl_CInstance *	instance,
		const float *	input,
		float *	output
	)

sound4cl_ProcessAudio_Planar()

void sound4cl_ProcessAudio_Planar	(	struct sound4cl_CInstance *	instance,
		float const *const *	input,
		float *const *	output
	)

sound4cl_ProcessJson()

const char * sound4cl_ProcessJson	(	struct sound4cl_CClientInstance *	client,
		const char *	json_str,
		int *	need_save
	)

sound4cl_SaveState()

int sound4cl_SaveState

(

struct sound4cl_CInstance *

instance

)

sound4cl_SetInstanceBus()

void sound4cl_SetInstanceBus	(	struct sound4cl_CParameters *	params,
		struct sound4cl_CBus *	bus
	)

sound4cl_SetLoggerCallback()

void sound4cl_SetLoggerCallback

(

sound4cl_loggerfn

logger

)

sound4cl_SetLogSeverity()

void sound4cl_SetLogSeverity

(

enum sound4cl_LogSeverity

severity

)

sound4cl_SetMetadata()

void sound4cl_SetMetadata	(	struct sound4cl_CInstance *	instance,
		const char *	key,
		const char *	value
	)

sound4cl_SetMetadataMulti()

void sound4cl_SetMetadataMulti	(	struct sound4cl_CInstance *	instance,
		const char **	keyvalue
	)

sound4cl_SetParameter()

void sound4cl_SetParameter	(	struct sound4cl_CParameters *	params,
		const char *	name,
		const char *	value
	)

sound4cl_SetPresetManager()

void sound4cl_SetPresetManager	(	struct sound4cl_CParameters *	params,
		sound4cl_storage_reader	reader,
		sound4cl_storage_reader_free	,
		sound4cl_storage_writer	writer,
		sound4cl_storage_exists	exists,
		sound4cl_storage_getall	getall,
		sound4cl_storage_getall_free	getall_free,
		sound4cl_storage_remove	remove,
		sound4cl_storage_rename	rename,
		int	IsReadOnly,
		void *	userdata
	)

sound4cl_SOUND4_GetProcessInfo()

const struct sound4cl_SOUND4_ProcessInfo * sound4cl_SOUND4_GetProcessInfo

(

)

sound4cl_StartUpdateThread()

void sound4cl_StartUpdateThread	(	struct sound4cl_CInstance *	instance,
		unsigned int	port
	)

sound4cl_StereoToMono()

void sound4cl_StereoToMono	(	const float *	input,
		float *	output,
		size_t	nFrame
	)

sound4cl_StereoToMono_Planar()

void sound4cl_StereoToMono_Planar	(	const float *	inputL,
		const float *	inputR,
		float *	output,
		size_t	nFrame
	)

sound4cl_StopUpdateThread()

void sound4cl_StopUpdateThread

(

struct sound4cl_CInstance *

instance

)

sound4cl_TerminateProcess()

int sound4cl_TerminateProcess

(

struct sound4cl_CInstance *

instance

)

sound4cl_WaitUpdateThreadReady()

int sound4cl_WaitUpdateThreadReady	(	struct sound4cl_CInstance *	instance,
		int	milliseconds
	)

sound4cl_Webserver()

uint64_t sound4cl_Webserver	(	unsigned int	listenport,
		unsigned int	listenport_secure,
		struct sound4cl_CInstance *	instance
	)

sound4cl_Webserver_FreeString()

void sound4cl_Webserver_FreeString

(

char *

str

)

sound4cl_Webserver_GetAppHealth()

void sound4cl_Webserver_GetAppHealth	(	struct sound4cl_CInstance *	instance,
		int *	httpcode,
		char **	contenttype,
		char **	content
	)

sound4cl_Webserver_SetAppHealth()

void sound4cl_Webserver_SetAppHealth	(	struct sound4cl_CInstance *	instance,
		int	httpcode,
		const char *	contenttype,
		const char *	content
	)

sound4cl_Webserver_Status()

int sound4cl_Webserver_Status

(

uint64_t

id

)

sound4cl_Webserver_Stop()

int sound4cl_Webserver_Stop	(	uint64_t	id,
		int	timeout_ms
	)

sound4cl_Webserver_tcp()

uint64_t sound4cl_Webserver_tcp	(	unsigned int	listenport,
		unsigned int	listenport_secure,
		const char *	socket_ip,
		unsigned int	socket_port
	)

sound4cl_Webserver_tcp2()

uint64_t sound4cl_Webserver_tcp2	(	unsigned int	listenport,
		unsigned int	listenport_secure,
		const char *	socket_ip,
		unsigned int	socket_port,
		const struct sound4cl_CParameters *	parameters
	)