SOUND4 IMPACT FM.CL Library [2.0.0]
Loading...
Searching...
No Matches
sound4.impactfm.cl.h
Go to the documentation of this file.
1
4#pragma once
5
6#ifdef __unix__
7 #include <sys/types.h>
8 #define IMPACTFM_DECL __attribute__ ((visibility ("default")))
9#elif defined(_WIN32) || defined(WIN32)
10 #include <windows.h>
11 #ifdef BUILDING_IMPACTFM_DLL
12 #define IMPACTFM_DECL __declspec(dllexport)
13 #else
14 #define IMPACTFM_DECL __declspec(dllimport)
15 #endif
16 #ifdef _MSC_VER
17 #pragma warning(disable : 4996)
18 #endif
19#elif defined(__APPLE__)
20 #include <sys/types.h>
21 #define IMPACTFM_DECL __attribute__ ((visibility ("default")))
22#endif
23#include <stdint.h>
24
25#define IMPACTFM_HAS_WEBSERVER 1
26#define IMPACTFM_HAS_CLOUDBUS 0
27
28#ifdef __cplusplus
29extern "C" {
30#endif // __cplusplus
31
32// --------------------------------------------------------------
46#define IMPACTFM_AUDIOFRAME_COUNT 64
52#define IMPACTFM_CHANNEL_COUNT 2
58#define IMPACTFM_AUDIO_INPUT_COUNT 1
64#define IMPACTFM_AUDIO_OUTPUT_COUNT 1
70#define IMPACTFM_SAMPLE_RATE 48000
71
78 size_t struct_size;
79 const char *name;
80 const char *prefix;
81 const char *shortname;
82 const char *version;
83};
84
93
100
114
124
133
143
153
162
178
185typedef void (*impactfm_loggerfn) (enum impactfm_LogSeverity, const char *);
186
198
207
210// --------------------------------------------------------------
218// --------------------------------------------------------------
222struct impactfm_CInstance;
223
228
237
242
254IMPACTFM_DECL void impactfm_SetParameter(struct impactfm_CParameters *params, const char *name, const char *value);
255
261IMPACTFM_DECL const char *impactfm_GetParameter(struct impactfm_CParameters *params, const char *name);
262
269
278 const char *LoginKey,
279 const char *RadioName,
280 const char *Access_Key_ID,
281 const char *Access_Key_Secret,
282 const char *save_path
283 );
284
293 const char *LoginKey,
294 const char *RadioName,
295 const char *Access_Key_ID,
296 const char *Access_Key_Secret,
297 const char *save_path,
298 const struct impactfm_CParameters *parameters
299 );
300
329 const char *LoginKey,
330 const char *RadioName,
331 const char *Access_Key_ID,
332 const char *Access_Key_Secret,
333 const char *save_path,
334 const struct impactfm_CParameters *parameters,
335 unsigned int frames_per_chunk
336 );
337
350
361
368
371#if IMPACTFM_HAS_CLOUDBUS
372// --------------------------------------------------------------
382struct impactfm_CBus;
383
389IMPACTFM_DECL struct impactfm_CBus* impactfm_NewBus();
390
396IMPACTFM_DECL void impactfm_FreeBus(struct impactfm_CBus *bus);
397
407IMPACTFM_DECL void impactfm_SetInstanceBus(struct impactfm_CParameters *params, struct impactfm_CBus *bus);
408
409
411#endif // IMPACTFM_HAS_CLOUDBUS
412
413// --------------------------------------------------------------
414// Tracing (Windows only)
415// --------------------------------------------------------------
416#ifdef _WIN32
417#ifndef TLG_HAVE_EVENT_SET_INFORMATION // TraceLoggingProvider.h has not been included
418 struct _tlgProvider_t;
419 typedef struct _tlgProvider_t const* TraceLoggingHProvider;
420#endif // !TLG_HAVE_EVENT_SET_INFORMATION
421// --------------------------------------------------------------
436IMPACTFM_DECL void impactfm_SetInstanceTracing(struct impactfm_CParameters *params, TraceLoggingHProvider tracing_provider, GUID activity_guid);
437
446
448#endif // _WIN32
449
450// --------------------------------------------------------------
473// --------------------------------------------------------------
474
475// OS dependent filesystem path char type
476#ifdef _WIN32
477 typedef wchar_t fs_char;
478#else // !_WIN32
479 typedef char fs_char;
480#endif // !_WIN32
481
489typedef char * (*impactfm_storage_reader) (const fs_char *filename, void* userdata);
490
497typedef void (*impactfm_storage_reader_free) (char *content, void* userdata);
498
507typedef int (*impactfm_storage_writer) (const fs_char *filename, const char *content, void* userdata);
508
516typedef int (*impactfm_storage_exists) (const fs_char *filename, void* userdata);
517
525typedef fs_char** (*impactfm_storage_getall) (void* userdata);
526
533typedef void (*impactfm_storage_getall_free) (fs_char**all, void* userdata);
534
542typedef int (*impactfm_storage_remove) (const fs_char *filename, void* userdata);
543
552typedef int (*impactfm_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
553
578 , int IsReadOnly
579 , void* userdata
580 );
581
590
600
603// --------------------------------------------------------------
611// --------------------------------------------------------------
612
629IMPACTFM_DECL void impactfm_SetMetadata(struct impactfm_CInstance *instance, const char* key, const char* value);
630
641IMPACTFM_DECL void impactfm_SetMetadataMulti(struct impactfm_CInstance *instance, const char** keyvalue);
642
651
658IMPACTFM_DECL void impactfm_FreeMetadataInfos(struct impactfm_CInstance *instance, const char** infos);
659
662// --------------------------------------------------------------
669// --------------------------------------------------------------
670
683IMPACTFM_DECL void impactfm_StartUpdateThread(struct impactfm_CInstance *instance, unsigned int port);
684
691
700
703// --------------------------------------------------------------
710// --------------------------------------------------------------
732IMPACTFM_DECL void impactfm_ProcessAudio(struct impactfm_CInstance *instance, const float *input, float *output );
733
753 , float const * const *input
754 , float * const *output);
755
769
783
794
797// --------------------------------------------------------------
807// --------------------------------------------------------------
812 char *id;
814 unsigned int sample_rate;
815 unsigned int channel_count;
816 const float *buffer;
817};
818
827
834
845
857IMPACTFM_DECL unsigned int impactfm_GetAuxiliaryAudioEstimatedDelay(struct impactfm_CInstance *instance, const char* id);
858
861// --------------------------------------------------------------
870// --------------------------------------------------------------
871 #ifdef _MSC_VER
872 #define __BYTE_ORDER__ REG_DWORD
873 #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
874 #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
875 #endif
876
890
891 // Native definitions, only links to the physical ones
892 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
897 #else
902 #endif
903};
904
912
920
928
929
937
948IMPACTFM_DECL unsigned int impactfm_AddAudio(struct impactfm_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum impactfm_SampleFormat fmt );
949
957
965
975IMPACTFM_DECL unsigned int impactfm_GetAudio(struct impactfm_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum impactfm_SampleFormat fmt );
976
980// --------------------------------------------------------------
987// --------------------------------------------------------------
998IMPACTFM_DECL void impactfm_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum impactfm_SampleFormat fmt);
999
1010IMPACTFM_DECL void impactfm_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum impactfm_SampleFormat fmt);
1011
1021IMPACTFM_DECL void impactfm_StereoToMono(const float *input, float *output, size_t nFrame);
1022
1032IMPACTFM_DECL void impactfm_MonoToStereo(const float *input, float *output, size_t nFrame);
1033
1044IMPACTFM_DECL void impactfm_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
1045
1056IMPACTFM_DECL void impactfm_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
1057
1064IMPACTFM_DECL void impactfm_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
1065
1072IMPACTFM_DECL void impactfm_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
1073
1080
1091
1114 , size_t payl_ch, size_t payl_ch_offset
1115 , enum impactfm_ConverterTargetMode target_mode);
1116
1121
1131IMPACTFM_DECL void impactfm_AudioConverter_From(struct impactfm_CAudioConverter *converter, const uint8_t *payload, float *output);
1132
1142IMPACTFM_DECL void impactfm_AudioConverter_To(struct impactfm_CAudioConverter *converter, const float *input, uint8_t *payload);
1143
1146// --------------------------------------------------------------
1153// --------------------------------------------------------------
1158
1168
1175
1189IMPACTFM_DECL const char *impactfm_ProcessJson(struct impactfm_CClientInstance *client, const char *json_str, int *need_save);
1190
1196IMPACTFM_DECL void impactfm_FreeJsonAnswer(const char *json_str);
1197
1210
1213#if IMPACTFM_HAS_WEBSERVER
1214// --------------------------------------------------------------
1232// --------------------------------------------------------------
1240IMPACTFM_DECL uint64_t impactfm_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1241
1242// --------------------------------------------------------------
1262IMPACTFM_DECL uint64_t impactfm_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct impactfm_CParameters *parameters);
1263
1283IMPACTFM_DECL uint64_t impactfm_Webserver(unsigned int listenport, unsigned int listenport_secure, struct impactfm_CInstance *instance);
1284
1294IMPACTFM_DECL int impactfm_Webserver_Stop(uint64_t id, int timeout_ms);
1295
1305
1316IMPACTFM_DECL void impactfm_Webserver_SetAppHealth(struct impactfm_CInstance *instance, int httpcode, const char *contenttype, const char *content);
1317
1326IMPACTFM_DECL void impactfm_Webserver_GetAppHealth(struct impactfm_CInstance *instance, int* httpcode, char** contenttype, char** content);
1327
1334
1339#define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1340
1344#define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1348#define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1349
1351#endif // IMPACTFM_HAS_WEBSERVER
1352
1353#ifdef __cplusplus
1354} // extern "C"
1355#endif // __cplusplus
impactfm_SampleFormat
unsigned int impactfm_AddAudio(struct impactfm_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum impactfm_SampleFormat fmt)
unsigned int impactfm_GetMaxPacketFrame(struct impactfm_CInstance *instance)
unsigned int impactfm_GetAudio(struct impactfm_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum impactfm_SampleFormat fmt)
const char * impactfm_GetFormatName(const enum impactfm_SampleFormat fmt)
unsigned int impactfm_AddPadAudio(struct impactfm_CInstance *instance)
unsigned int impactfm_GetOutputCount(struct impactfm_CInstance *instance)
unsigned int impactfm_GetBytesFromFormat(const enum impactfm_SampleFormat fmt)
enum impactfm_SampleFormat impactfm_GetFormatFromName(const char *name)
@ F32_NATIVE
32-bit floating-point, native
@ INVALID_FORMAT
Invalid.
@ S16_NATIVE
16-bit signed integer, native
@ F32_LE
32-bit floating-point, little-endian
@ S16_BE
16-bit signed integer, big-endian
@ S32_BE
32-bit signed integer, big-endian
@ S24_BE
24-bit signed integer, big-endian
@ S16_LE
16-bit signed integer, little-endian
@ F32_BE
32-bit floating-point, big-endian
@ S32_NATIVE
32-bit signed integer, native
@ S24_LE
24-bit signed integer, little-endian
@ S32_LE
32-bit signed integer, little-endian
@ S24_NATIVE
24-bit signed integer, native
unsigned int impactfm_GetAuxiliaryAudioEstimatedDelay(struct impactfm_CInstance *instance, const char *id)
struct SOUND4_AuxiliaryOutputInfos ** impactfm_GetAuxiliaryAudioOutputInfos(struct impactfm_CInstance *instance)
void impactfm_FreeAuxiliaryAudioInfos(struct SOUND4_AuxiliaryOutputInfos **infos)
int impactfm_ActivateAuxiliaryAudioID(struct impactfm_CInstance *instance, const char *id)
void impactfm_FreeJsonAnswer(const char *json_str)
const char * impactfm_ProcessJson(struct impactfm_CClientInstance *client, const char *json_str, int *need_save)
int impactfm_SaveState(struct impactfm_CInstance *instance)
struct impactfm_CClientInstance * impactfm_NewClient(struct impactfm_CInstance *instance)
void impactfm_DeleteClient(struct impactfm_CClientInstance *client)
void impactfm_StereoToMono(const float *input, float *output, size_t nFrame)
void impactfm_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum impactfm_SampleFormat fmt)
void impactfm_MonoToStereo(const float *input, float *output, size_t nFrame)
void impactfm_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame)
impactfm_ConverterTargetMode
void impactfm_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame)
struct impactfm_CAudioConverter * impactfm_GetAudioConverter(enum impactfm_SampleFormat fmt, size_t nFrame, size_t payl_ch, size_t payl_ch_offset, enum impactfm_ConverterTargetMode target_mode)
void impactfm_AudioConverter_From(struct impactfm_CAudioConverter *converter, const uint8_t *payload, float *output)
void impactfm_AudioConverter_To(struct impactfm_CAudioConverter *converter, const float *input, uint8_t *payload)
void impactfm_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum impactfm_SampleFormat fmt)
void impactfm_AudioMonoToLiveStereo(const float *input, uint8_t *payload)
void impactfm_AudioMonoFromLiveStereo(const uint8_t *payload, float *output)
void impactfm_FreeAudioConverter(struct impactfm_CAudioConverter *converter)
@ ConverterTargetMode_Mono
Mono process (using mono extract/payload)
@ ConverterTargetMode_StereoToMono
Mono process, using stereo extract/payload (converts stereo to mono)
@ ConverterTargetMode_AsInput
Same channels as input (no extract/insert)
@ ConverterTargetMode_Stereo
Stereo process (using stereo extract/payload)
@ ConverterTargetMode_MonoToStereo
Stereo process, using mono extract/payload (converts mono to stereo)
unsigned int impactfm_GetEstimatedDelay(struct impactfm_CInstance *instance)
float * impactfm_GetBufferOut(struct impactfm_CInstance *instance)
float * impactfm_GetBufferIn(struct impactfm_CInstance *instance)
void impactfm_ProcessAudio_Planar(struct impactfm_CInstance *instance, float const *const *input, float *const *output)
void impactfm_ProcessAudio(struct impactfm_CInstance *instance, const float *input, float *output)
impactfm_LogSeverity
const struct SOUND4_ProcessInfo * SOUND4_GetProcessInfo()
void impactfm_SetLoggerCallback(impactfm_loggerfn logger)
unsigned int impactfm_GetChannelCount()
unsigned int impactfm_GetAudioInputCount()
unsigned int * impactfm_GetPossibleChunkSizeInFrames()
const char * impactfm_GetVersion()
unsigned int impactfm_GetChunkSizeInFrames()
unsigned int impactfm_GetAudioOutputCount()
void(* impactfm_loggerfn)(enum impactfm_LogSeverity, const char *)
unsigned int impactfm_GetSampleRate()
void impactfm_SetLogSeverity(enum impactfm_LogSeverity severity)
@ verbose5
verbose5
@ fatal
fatal error
@ warning
warning
@ verbose4
verbose4
@ info
info
@ none
Not used.
@ error
error
@ verbose2
verbose2
@ verbose3
verbose3
@ verbose
verbose
void impactfm_SetParameter(struct impactfm_CParameters *params, const char *name, const char *value)
void impactfm_FreeParameterValue(const char *value)
struct impactfm_CInstance * impactfm_InitProcess3(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct impactfm_CParameters *parameters, unsigned int frames_per_chunk)
struct impactfm_CInstance * impactfm_InitProcess2(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct impactfm_CParameters *parameters)
int impactfm_TerminateProcess(struct impactfm_CInstance *instance)
void impactfm_ExitProcess(struct impactfm_CInstance *instance)
struct impactfm_CParameters * impactfm_NewParameters()
const char * impactfm_GetParameter(struct impactfm_CParameters *params, const char *name)
void impactfm_FreeParameters(struct impactfm_CParameters *params)
unsigned int impactfm_GetProcessChunkFrames(struct impactfm_CInstance *instance)
struct impactfm_CInstance * impactfm_InitProcess(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path)
void impactfm_SetMetadataMulti(struct impactfm_CInstance *instance, const char **keyvalue)
void impactfm_FreeMetadataInfos(struct impactfm_CInstance *instance, const char **infos)
void impactfm_SetMetadata(struct impactfm_CInstance *instance, const char *key, const char *value)
const char ** impactfm_GetMetadataInfos(struct impactfm_CInstance *instance)
int(* impactfm_storage_remove)(const fs_char *filename, void *userdata)
fs_char **(* impactfm_storage_getall)(void *userdata)
int(* impactfm_storage_rename)(const fs_char *from, const fs_char *to, void *userdata)
impactfm_PresetChange_Kind
void impactfm_SetPresetManager(struct impactfm_CParameters *params, impactfm_storage_reader reader, impactfm_storage_reader_free, impactfm_storage_writer writer, impactfm_storage_exists exists, impactfm_storage_getall getall, impactfm_storage_getall_free getall_free, impactfm_storage_remove remove, impactfm_storage_rename rename, int IsReadOnly, void *userdata)
void impactfm_PresetManager_InformChange(struct impactfm_CInstance *instance, const fs_char *relative_path, enum impactfm_PresetChange_Kind change_kind)
int(* impactfm_storage_exists)(const fs_char *filename, void *userdata)
void(* impactfm_storage_reader_free)(char *content, void *userdata)
void(* impactfm_storage_getall_free)(fs_char **all, void *userdata)
int(* impactfm_storage_writer)(const fs_char *filename, const char *content, void *userdata)
char *(* impactfm_storage_reader)(const fs_char *filename, void *userdata)
wchar_t fs_char
@ change_kind_modified
Path has been modified.
@ change_kind_created
Path has been created.
@ change_kind_deleted
Path has been deleted.
void impactfm_SetInstanceTracing(struct impactfm_CParameters *params, TraceLoggingHProvider tracing_provider, GUID activity_guid)
void impactfm_SetInstanceTracingProcessActivity(struct impactfm_CInstance *instance, GUID activity_guid)
void impactfm_StopUpdateThread(struct impactfm_CInstance *instance)
int impactfm_WaitUpdateThreadReady(struct impactfm_CInstance *instance, int milliseconds)
void impactfm_StartUpdateThread(struct impactfm_CInstance *instance, unsigned int port)
int impactfm_Webserver_Status(uint64_t id)
uint64_t impactfm_Webserver(unsigned int listenport, unsigned int listenport_secure, struct impactfm_CInstance *instance)
void impactfm_Webserver_GetAppHealth(struct impactfm_CInstance *instance, int *httpcode, char **contenttype, char **content)
uint64_t impactfm_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port)
int impactfm_Webserver_Stop(uint64_t id, int timeout_ms)
void impactfm_Webserver_FreeString(char *str)
uint64_t impactfm_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct impactfm_CParameters *parameters)
void impactfm_Webserver_SetAppHealth(struct impactfm_CInstance *instance, int httpcode, const char *contenttype, const char *content)
#define IMPACTFM_DECL
struct _tlgProvider_t const * TraceLoggingHProvider
const float * buffer
The output buffer of the output. See impactfm_ProcessAudio for format.
char * id
The ID of the output (fixed across versions)
char * description
The description of the output.
unsigned int sample_rate
The sampling rate of this output.
unsigned int channel_count
The number of channels of this output.
const char * version
Library version.
const char * shortname
A short name of the processor, single word.
const char * prefix
The prefix of this processor functions.
size_t struct_size
The size of total this structure, for compatibility checking.
const char * name
The name of the processor.