SOUND4 IMPACT.CL Library [1.2.8]
sound4.impact.cl.h
Go to the documentation of this file.
1 
4 #pragma once
5 
6 #include <stdint.h>
7 #ifdef __unix__
8  #include <sys/types.h>
9  #define IMPACT_DECL __attribute__ ((visibility ("default")))
10 #elif defined(_WIN32) || defined(WIN32)
11  #ifdef BUILDING_IMPACT_DLL
12  #define IMPACT_DECL __declspec(dllexport)
13  #else
14  #define IMPACT_DECL __declspec(dllimport)
15  #endif
16 #endif
17 
18 #define IMPACT_HAS_WEBSERVER 1
19 #define IMPACT_HAS_CLOUDBUS 0
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif // __cplusplus
24 
70 // --------------------------------------------------------------
89 // --------------------------------------------------------------
143 // --------------------------------------------------------------
144 
145 // --------------------------------------------------------------
157 #define IMPACT_AUDIOFRAME_COUNT 64
163 #define IMPACT_CHANNEL_COUNT 2
169 #define IMPACT_AUDIO_INPUT_COUNT 1
175 #define IMPACT_AUDIO_OUTPUT_COUNT 1
181 #define IMPACT_SAMPLE_RATE 48000
182 
189  size_t struct_size;
190  const char *name;
191  const char *prefix;
192  const char *shortname;
193  const char *version;
194 };
195 
204 
211 
225 
235 
244 
254 
264 
273 
278  none = 0,
279  fatal = 1,
280  error = 2,
281  warning = 3,
282  info = 4,
283  verbose = 5,
284  verbose2 = 6,
285  verbose3 = 7,
286  verbose4 = 8,
287  verbose5 = 9,
288 };
289 
296 typedef void (*impact_loggerfn) (enum impact_LogSeverity, const char *);
297 
308 
317 
320 // --------------------------------------------------------------
326 // --------------------------------------------------------------
330 struct impact_CInstance;
331 
335 struct impact_CParameters;
336 
345 
350 
362 IMPACT_DECL void impact_SetParameter(struct impact_CParameters *params, const char *name, const char *value);
363 
369 IMPACT_DECL const char *impact_GetParameter(struct impact_CParameters *params, const char *name);
370 
376 IMPACT_DECL void impact_FreeParameterValue(const char *value);
377 
386  const char *LoginKey,
387  const char *RadioName,
388  const char *Access_Key_ID,
389  const char *Access_Key_Secret,
390  const char *save_path
391  );
392 
401  const char *LoginKey,
402  const char *RadioName,
403  const char *Access_Key_ID,
404  const char *Access_Key_Secret,
405  const char *save_path,
406  const struct impact_CParameters *parameters
407  );
408 
454  const char *LoginKey,
455  const char *RadioName,
456  const char *Access_Key_ID,
457  const char *Access_Key_Secret,
458  const char *save_path,
459  const struct impact_CParameters *parameters,
460  unsigned int frames_per_chunk
461  );
462 
475 
486 
493 
496 #if IMPACT_HAS_CLOUDBUS
497 // --------------------------------------------------------------
506 struct impact_CBus;
507 
513 IMPACT_DECL struct impact_CBus* impact_NewBus();
514 
520 IMPACT_DECL void impact_FreeBus(struct impact_CBus *bus);
521 
531 IMPACT_DECL void impact_SetInstanceBus(struct impact_CParameters *params, struct impact_CBus *bus);
532 
533 
535 #endif // IMPACT_HAS_CLOUDBUS
536 
537 // --------------------------------------------------------------
560 // --------------------------------------------------------------
561 
562 // OS dependent filesystem path char type
563 #ifdef _WIN32
564  typedef wchar_t fs_char;
565 #else // !_WIN32
566  typedef char fs_char;
567 #endif // !_WIN32
568 
576 typedef char * (*impact_storage_reader) (const fs_char *filename, void* userdata);
577 
584 typedef void (*impact_storage_reader_free) (char *content, void* userdata);
585 
594 typedef int (*impact_storage_writer) (const fs_char *filename, const char *content, void* userdata);
595 
603 typedef int (*impact_storage_exists) (const fs_char *filename, void* userdata);
604 
612 typedef fs_char** (*impact_storage_getall) (void* userdata);
613 
620 typedef void (*impact_storage_getall_free) (fs_char**all, void* userdata);
621 
629 typedef int (*impact_storage_remove) (const fs_char *filename, void* userdata);
630 
639 typedef int (*impact_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
640 
660  , impact_storage_writer writer
661  , impact_storage_exists exists
663  , impact_storage_remove remove
664  , impact_storage_rename rename
665  , int IsReadOnly
666  , void* userdata
667  );
668 
676 };
677 
686 IMPACT_DECL void impact_PresetManager_InformChange(struct impact_CInstance *instance, const fs_char *relative_path, enum impact_PresetChange_Kind change_kind);
687 
690 // --------------------------------------------------------------
698 // --------------------------------------------------------------
699 
716 IMPACT_DECL void impact_SetMetadata(struct impact_CInstance *instance, const char* key, const char* value);
717 
728 IMPACT_DECL void impact_SetMetadataMulti(struct impact_CInstance *instance, const char** keyvalue);
729 
737 IMPACT_DECL const char** impact_GetMetadataInfos(struct impact_CInstance *instance);
738 
745 IMPACT_DECL void impact_FreeMetadataInfos(struct impact_CInstance *instance, const char** infos);
746 
749 // --------------------------------------------------------------
754 // --------------------------------------------------------------
755 
768 IMPACT_DECL void impact_StartUpdateThread(struct impact_CInstance *instance, unsigned int port);
769 
776 
784 IMPACT_DECL int impact_WaitUpdateThreadReady(struct impact_CInstance *instance, int milliseconds);
785 
788 // --------------------------------------------------------------
793 // --------------------------------------------------------------
815 IMPACT_DECL void impact_ProcessAudio(struct impact_CInstance *instance, const float *input, float *output );
816 
836  , float const * const *input
837  , float * const *output);
838 
852 
866 
875 
878 // --------------------------------------------------------------
885 // --------------------------------------------------------------
886  #ifdef _MSC_VER
887  #define __BYTE_ORDER__ REG_DWORD
888  #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
889  #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
890  #endif
891 
905 
906  // Native definitions, only links to the physical ones
907  #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
912  #else
917  #endif
918 };
919 
927 
935 
943 
944 
952 
963 IMPACT_DECL unsigned int impact_AddAudio(struct impact_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum impact_SampleFormat fmt );
964 
971 IMPACT_DECL unsigned int impact_AddPadAudio(struct impact_CInstance *instance);
972 
979 IMPACT_DECL unsigned int impact_GetOutputCount(struct impact_CInstance *instance);
980 
990 IMPACT_DECL unsigned int impact_GetAudio(struct impact_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum impact_SampleFormat fmt );
991 
995 // --------------------------------------------------------------
999 // --------------------------------------------------------------
1010 IMPACT_DECL void impact_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum impact_SampleFormat fmt);
1011 
1022 IMPACT_DECL void impact_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum impact_SampleFormat fmt);
1023 
1033 IMPACT_DECL void impact_StereoToMono(const float *input, float *output, size_t nFrame);
1034 
1044 IMPACT_DECL void impact_MonoToStereo(const float *input, float *output, size_t nFrame);
1045 
1056 IMPACT_DECL void impact_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
1057 
1068 IMPACT_DECL void impact_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
1069 
1076 IMPACT_DECL void impact_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
1077 
1084 IMPACT_DECL void impact_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
1085 
1088 // --------------------------------------------------------------
1093 // --------------------------------------------------------------
1097 struct impact_CClientInstance;
1098 
1108 
1115 
1129 IMPACT_DECL const char *impact_ProcessJson(struct impact_CClientInstance *client, const char *json_str, int *need_save);
1130 
1136 IMPACT_DECL void impact_FreeJsonAnswer(const char *json_str);
1137 
1150 
1446 #if IMPACT_HAS_WEBSERVER
1447 // --------------------------------------------------------------
1455 // --------------------------------------------------------------
1474 IMPACT_DECL uint64_t impact_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1475 
1476 // --------------------------------------------------------------
1496 IMPACT_DECL uint64_t impact_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct impact_CParameters *parameters);
1497 
1515 IMPACT_DECL uint64_t impact_Webserver(unsigned int listenport, unsigned int listenport_secure, struct impact_CInstance *instance);
1516 
1526 IMPACT_DECL int impact_Webserver_Stop(uint64_t id, int timeout_ms);
1527 
1537 
1542 #define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1543 
1547 #define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1551 #define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1552 
1554 #endif // IMPACT_HAS_WEBSERVER
1555 
1556 #ifdef __cplusplus
1557 } // extern "C"
1558 #endif // __cplusplus
unsigned int impact_GetBytesFromFormat(const enum impact_SampleFormat fmt)
unsigned int impact_AddAudio(struct impact_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum impact_SampleFormat fmt)
impact_SampleFormat
enum impact_SampleFormat impact_GetFormatFromName(const char *name)
const char * impact_GetFormatName(const enum impact_SampleFormat fmt)
unsigned int impact_AddPadAudio(struct impact_CInstance *instance)
unsigned int impact_GetOutputCount(struct impact_CInstance *instance)
unsigned int impact_GetMaxPacketFrame(struct impact_CInstance *instance)
unsigned int impact_GetAudio(struct impact_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum impact_SampleFormat fmt)
@ 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
void impact_FreeJsonAnswer(const char *json_str)
void impact_DeleteClient(struct impact_CClientInstance *client)
int impact_SaveState(struct impact_CInstance *instance)
const char * impact_ProcessJson(struct impact_CClientInstance *client, const char *json_str, int *need_save)
struct impact_CClientInstance * impact_NewClient(struct impact_CInstance *instance)
void impact_AudioMonoFromLiveStereo(const uint8_t *payload, float *output)
void impact_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum impact_SampleFormat fmt)
void impact_MonoToStereo(const float *input, float *output, size_t nFrame)
void impact_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame)
void impact_AudioMonoToLiveStereo(const float *input, uint8_t *payload)
void impact_StereoToMono(const float *input, float *output, size_t nFrame)
void impact_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame)
void impact_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum impact_SampleFormat fmt)
float * impact_GetBufferIn(struct impact_CInstance *instance)
void impact_ProcessAudio(struct impact_CInstance *instance, const float *input, float *output)
unsigned int impact_GetEstimatedDelay(struct impact_CInstance *instance)
float * impact_GetBufferOut(struct impact_CInstance *instance)
void impact_ProcessAudio_Planar(struct impact_CInstance *instance, float const *const *input, float *const *output)
const char * impact_GetVersion()
unsigned int impact_GetAudioOutputCount()
unsigned int impact_GetChunkSizeInFrames()
void impact_SetLoggerCallback(impact_loggerfn logger)
impact_LogSeverity
unsigned int impact_GetChannelCount()
unsigned int * impact_GetPossibleChunkSizeInFrames()
const struct SOUND4_ProcessInfo * SOUND4_GetProcessInfo()
void impact_SetLogSeverity(enum impact_LogSeverity severity)
unsigned int impact_GetSampleRate()
unsigned int impact_GetAudioInputCount()
void(* impact_loggerfn)(enum impact_LogSeverity, const char *)
@ verbose5
@ fatal
@ warning
@ verbose4
@ info
@ none
@ error
@ verbose2
@ verbose3
@ verbose
void impact_SetParameter(struct impact_CParameters *params, const char *name, const char *value)
int impact_TerminateProcess(struct impact_CInstance *instance)
struct impact_CParameters * impact_NewParameters()
void impact_FreeParameters(struct impact_CParameters *params)
void impact_ExitProcess(struct impact_CInstance *instance)
const char * impact_GetParameter(struct impact_CParameters *params, const char *name)
struct impact_CInstance * impact_InitProcess3(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct impact_CParameters *parameters, unsigned int frames_per_chunk)
void impact_FreeParameterValue(const char *value)
unsigned int impact_GetProcessChunkFrames(struct impact_CInstance *instance)
struct impact_CInstance * impact_InitProcess2(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct impact_CParameters *parameters)
struct impact_CInstance * impact_InitProcess(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path)
void impact_FreeMetadataInfos(struct impact_CInstance *instance, const char **infos)
void impact_SetMetadataMulti(struct impact_CInstance *instance, const char **keyvalue)
void impact_SetMetadata(struct impact_CInstance *instance, const char *key, const char *value)
const char ** impact_GetMetadataInfos(struct impact_CInstance *instance)
void impact_SetPresetManager(struct impact_CParameters *params, impact_storage_reader reader, impact_storage_reader_free, impact_storage_writer writer, impact_storage_exists exists, impact_storage_getall getall, impact_storage_getall_free getall_free, impact_storage_remove remove, impact_storage_rename rename, int IsReadOnly, void *userdata)
void impact_PresetManager_InformChange(struct impact_CInstance *instance, const fs_char *relative_path, enum impact_PresetChange_Kind change_kind)
char *(* impact_storage_reader)(const fs_char *filename, void *userdata)
int(* impact_storage_exists)(const fs_char *filename, void *userdata)
int(* impact_storage_remove)(const fs_char *filename, void *userdata)
int(* impact_storage_writer)(const fs_char *filename, const char *content, void *userdata)
void(* impact_storage_getall_free)(fs_char **all, void *userdata)
fs_char **(* impact_storage_getall)(void *userdata)
impact_PresetChange_Kind
void(* impact_storage_reader_free)(char *content, void *userdata)
wchar_t fs_char
int(* impact_storage_rename)(const fs_char *from, const fs_char *to, void *userdata)
@ change_kind_modified
Path has been modified.
@ change_kind_created
Path has been created.
@ change_kind_deleted
Path has been deleted.
void impact_StopUpdateThread(struct impact_CInstance *instance)
void impact_StartUpdateThread(struct impact_CInstance *instance, unsigned int port)
int impact_WaitUpdateThreadReady(struct impact_CInstance *instance, int milliseconds)
int impact_Webserver_Stop(uint64_t id, int timeout_ms)
uint64_t impact_Webserver(unsigned int listenport, unsigned int listenport_secure, struct impact_CInstance *instance)
int impact_Webserver_Status(uint64_t id)
uint64_t impact_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port)
uint64_t impact_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct impact_CParameters *parameters)
#define IMPACT_DECL
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.