SOUND4 x1.CLOUD Library [1.5.6]
Loading...
Searching...
No Matches
sound4.x1.cloud.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 CLOUDX1_DECL __attribute__ ((visibility ("default")))
10#elif defined(_WIN32) || defined(WIN32)
11 #ifdef BUILDING_CLOUDX1_DLL
12 #define CLOUDX1_DECL __declspec(dllexport)
13 #else
14 #define CLOUDX1_DECL __declspec(dllimport)
15 #endif
16#elif defined(__APPLE__)
17 #include <sys/types.h>
18 #define CLOUDX1_DECL __attribute__ ((visibility ("default")))
19#endif
20
21#define CLOUDX1_HAS_WEBSERVER 1
22#define CLOUDX1_HAS_CLOUDBUS 0
23
24#ifdef __cplusplus
25extern "C" {
26#endif // __cplusplus
27
28// --------------------------------------------------------------
42#define CLOUDX1_AUDIOFRAME_COUNT 64
48#define CLOUDX1_CHANNEL_COUNT 2
54#define CLOUDX1_AUDIO_INPUT_COUNT 1
60#define CLOUDX1_AUDIO_OUTPUT_COUNT 1
66#define CLOUDX1_SAMPLE_RATE 48000
67
74 size_t struct_size;
75 const char *name;
76 const char *prefix;
77 const char *shortname;
78 const char *version;
79};
80
89
96
110
120
129
139
149
158
174
181typedef void (*cloudx1_loggerfn) (enum cloudx1_LogSeverity, const char *);
182
193
202
205// --------------------------------------------------------------
213// --------------------------------------------------------------
217struct cloudx1_CInstance;
218
223
232
237
249CLOUDX1_DECL void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value);
250
256CLOUDX1_DECL const char *cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name);
257
264
273 const char *LoginKey,
274 const char *RadioName,
275 const char *Access_Key_ID,
276 const char *Access_Key_Secret,
277 const char *save_path
278 );
279
288 const char *LoginKey,
289 const char *RadioName,
290 const char *Access_Key_ID,
291 const char *Access_Key_Secret,
292 const char *save_path,
293 const struct cloudx1_CParameters *parameters
294 );
295
324 const char *LoginKey,
325 const char *RadioName,
326 const char *Access_Key_ID,
327 const char *Access_Key_Secret,
328 const char *save_path,
329 const struct cloudx1_CParameters *parameters,
330 unsigned int frames_per_chunk
331 );
332
345
356
363
366#if CLOUDX1_HAS_CLOUDBUS
367// --------------------------------------------------------------
377struct cloudx1_CBus;
378
384CLOUDX1_DECL struct cloudx1_CBus* cloudx1_NewBus();
385
391CLOUDX1_DECL void cloudx1_FreeBus(struct cloudx1_CBus *bus);
392
402CLOUDX1_DECL void cloudx1_SetInstanceBus(struct cloudx1_CParameters *params, struct cloudx1_CBus *bus);
403
404
406#endif // CLOUDX1_HAS_CLOUDBUS
407
408// --------------------------------------------------------------
431// --------------------------------------------------------------
432
433// OS dependent filesystem path char type
434#ifdef _WIN32
435 typedef wchar_t fs_char;
436#else // !_WIN32
437 typedef char fs_char;
438#endif // !_WIN32
439
447typedef char * (*cloudx1_storage_reader) (const fs_char *filename, void* userdata);
448
455typedef void (*cloudx1_storage_reader_free) (char *content, void* userdata);
456
465typedef int (*cloudx1_storage_writer) (const fs_char *filename, const char *content, void* userdata);
466
474typedef int (*cloudx1_storage_exists) (const fs_char *filename, void* userdata);
475
483typedef fs_char** (*cloudx1_storage_getall) (void* userdata);
484
491typedef void (*cloudx1_storage_getall_free) (fs_char**all, void* userdata);
492
500typedef int (*cloudx1_storage_remove) (const fs_char *filename, void* userdata);
501
510typedef int (*cloudx1_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
511
536 , int IsReadOnly
537 , void* userdata
538 );
539
548
557CLOUDX1_DECL void cloudx1_PresetManager_InformChange(struct cloudx1_CInstance *instance, const fs_char *relative_path, enum cloudx1_PresetChange_Kind change_kind);
558
561// --------------------------------------------------------------
569// --------------------------------------------------------------
570
587CLOUDX1_DECL void cloudx1_SetMetadata(struct cloudx1_CInstance *instance, const char* key, const char* value);
588
599CLOUDX1_DECL void cloudx1_SetMetadataMulti(struct cloudx1_CInstance *instance, const char** keyvalue);
600
609
616CLOUDX1_DECL void cloudx1_FreeMetadataInfos(struct cloudx1_CInstance *instance, const char** infos);
617
620// --------------------------------------------------------------
627// --------------------------------------------------------------
628
641CLOUDX1_DECL void cloudx1_StartUpdateThread(struct cloudx1_CInstance *instance, unsigned int port);
642
649
657CLOUDX1_DECL int cloudx1_WaitUpdateThreadReady(struct cloudx1_CInstance *instance, int milliseconds);
658
661// --------------------------------------------------------------
668// --------------------------------------------------------------
690CLOUDX1_DECL void cloudx1_ProcessAudio(struct cloudx1_CInstance *instance, const float *input, float *output );
691
711 , float const * const *input
712 , float * const *output);
713
727
741
752
755// --------------------------------------------------------------
764// --------------------------------------------------------------
765 #ifdef _MSC_VER
766 #define __BYTE_ORDER__ REG_DWORD
767 #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
768 #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
769 #endif
770
784
785 // Native definitions, only links to the physical ones
786 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
791 #else
796 #endif
797};
798
806
814
822
823
831
842CLOUDX1_DECL unsigned int cloudx1_AddAudio(struct cloudx1_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum cloudx1_SampleFormat fmt );
843
851
859
869CLOUDX1_DECL unsigned int cloudx1_GetAudio(struct cloudx1_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum cloudx1_SampleFormat fmt );
870
874// --------------------------------------------------------------
881// --------------------------------------------------------------
892CLOUDX1_DECL void cloudx1_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum cloudx1_SampleFormat fmt);
893
904CLOUDX1_DECL void cloudx1_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum cloudx1_SampleFormat fmt);
905
915CLOUDX1_DECL void cloudx1_StereoToMono(const float *input, float *output, size_t nFrame);
916
926CLOUDX1_DECL void cloudx1_MonoToStereo(const float *input, float *output, size_t nFrame);
927
938CLOUDX1_DECL void cloudx1_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
939
950CLOUDX1_DECL void cloudx1_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
951
958CLOUDX1_DECL void cloudx1_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
959
966CLOUDX1_DECL void cloudx1_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
967
970// --------------------------------------------------------------
977// --------------------------------------------------------------
982
992
999
1013CLOUDX1_DECL const char *cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save);
1014
1020CLOUDX1_DECL void cloudx1_FreeJsonAnswer(const char *json_str);
1021
1034
1037#if CLOUDX1_HAS_WEBSERVER
1038// --------------------------------------------------------------
1053// --------------------------------------------------------------
1061CLOUDX1_DECL uint64_t cloudx1_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1062
1063// --------------------------------------------------------------
1083CLOUDX1_DECL uint64_t cloudx1_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct cloudx1_CParameters *parameters);
1084
1102CLOUDX1_DECL uint64_t cloudx1_Webserver(unsigned int listenport, unsigned int listenport_secure, struct cloudx1_CInstance *instance);
1103
1113CLOUDX1_DECL int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms);
1114
1124
1135CLOUDX1_DECL void cloudx1_Webserver_SetAppHealth(struct cloudx1_CInstance *instance, int httpcode, const char *contenttype, const char *content);
1136
1145CLOUDX1_DECL void cloudx1_Webserver_GetAppHealth(struct cloudx1_CInstance *instance, int* httpcode, char** contenttype, char** content);
1146
1153
1158#define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1159
1163#define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1167#define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1168
1170#endif // CLOUDX1_HAS_WEBSERVER
1171
1172#ifdef __cplusplus
1173} // extern "C"
1174#endif // __cplusplus
enum cloudx1_SampleFormat cloudx1_GetFormatFromName(const char *name)
cloudx1_SampleFormat
const char * cloudx1_GetFormatName(const enum cloudx1_SampleFormat fmt)
unsigned int cloudx1_GetOutputCount(struct cloudx1_CInstance *instance)
unsigned int cloudx1_AddAudio(struct cloudx1_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum cloudx1_SampleFormat fmt)
unsigned int cloudx1_AddPadAudio(struct cloudx1_CInstance *instance)
unsigned int cloudx1_GetBytesFromFormat(const enum cloudx1_SampleFormat fmt)
unsigned int cloudx1_GetAudio(struct cloudx1_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum cloudx1_SampleFormat fmt)
unsigned int cloudx1_GetMaxPacketFrame(struct cloudx1_CInstance *instance)
@ 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
struct cloudx1_CClientInstance * cloudx1_NewClient(struct cloudx1_CInstance *instance)
int cloudx1_SaveState(struct cloudx1_CInstance *instance)
void cloudx1_DeleteClient(struct cloudx1_CClientInstance *client)
const char * cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save)
void cloudx1_FreeJsonAnswer(const char *json_str)
void cloudx1_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum cloudx1_SampleFormat fmt)
void cloudx1_AudioMonoToLiveStereo(const float *input, uint8_t *payload)
void cloudx1_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame)
void cloudx1_StereoToMono(const float *input, float *output, size_t nFrame)
void cloudx1_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum cloudx1_SampleFormat fmt)
void cloudx1_MonoToStereo(const float *input, float *output, size_t nFrame)
void cloudx1_AudioMonoFromLiveStereo(const uint8_t *payload, float *output)
void cloudx1_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame)
float * cloudx1_GetBufferOut(struct cloudx1_CInstance *instance)
void cloudx1_ProcessAudio_Planar(struct cloudx1_CInstance *instance, float const *const *input, float *const *output)
void cloudx1_ProcessAudio(struct cloudx1_CInstance *instance, const float *input, float *output)
unsigned int cloudx1_GetEstimatedDelay(struct cloudx1_CInstance *instance)
float * cloudx1_GetBufferIn(struct cloudx1_CInstance *instance)
unsigned int * cloudx1_GetPossibleChunkSizeInFrames()
unsigned int cloudx1_GetAudioInputCount()
const struct SOUND4_ProcessInfo * SOUND4_GetProcessInfo()
cloudx1_LogSeverity
unsigned int cloudx1_GetChunkSizeInFrames()
unsigned int cloudx1_GetAudioOutputCount()
unsigned int cloudx1_GetChannelCount()
void cloudx1_SetLoggerCallback(cloudx1_loggerfn logger)
unsigned int cloudx1_GetSampleRate()
const char * cloudx1_GetVersion()
void(* cloudx1_loggerfn)(enum cloudx1_LogSeverity, const char *)
void cloudx1_SetLogSeverity(enum cloudx1_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 cloudx1_FreeParameterValue(const char *value)
void cloudx1_ExitProcess(struct cloudx1_CInstance *instance)
void cloudx1_FreeParameters(struct cloudx1_CParameters *params)
void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value)
struct cloudx1_CParameters * cloudx1_NewParameters()
int cloudx1_TerminateProcess(struct cloudx1_CInstance *instance)
struct cloudx1_CInstance * cloudx1_InitProcess2(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct cloudx1_CParameters *parameters)
const char * cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name)
unsigned int cloudx1_GetProcessChunkFrames(struct cloudx1_CInstance *instance)
struct cloudx1_CInstance * cloudx1_InitProcess(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path)
struct cloudx1_CInstance * cloudx1_InitProcess3(const char *LoginKey, const char *RadioName, const char *Access_Key_ID, const char *Access_Key_Secret, const char *save_path, const struct cloudx1_CParameters *parameters, unsigned int frames_per_chunk)
const char ** cloudx1_GetMetadataInfos(struct cloudx1_CInstance *instance)
void cloudx1_SetMetadata(struct cloudx1_CInstance *instance, const char *key, const char *value)
void cloudx1_FreeMetadataInfos(struct cloudx1_CInstance *instance, const char **infos)
void cloudx1_SetMetadataMulti(struct cloudx1_CInstance *instance, const char **keyvalue)
int(* cloudx1_storage_remove)(const fs_char *filename, void *userdata)
cloudx1_PresetChange_Kind
int(* cloudx1_storage_writer)(const fs_char *filename, const char *content, void *userdata)
fs_char **(* cloudx1_storage_getall)(void *userdata)
char *(* cloudx1_storage_reader)(const fs_char *filename, void *userdata)
void cloudx1_SetPresetManager(struct cloudx1_CParameters *params, cloudx1_storage_reader reader, cloudx1_storage_reader_free, cloudx1_storage_writer writer, cloudx1_storage_exists exists, cloudx1_storage_getall getall, cloudx1_storage_getall_free getall_free, cloudx1_storage_remove remove, cloudx1_storage_rename rename, int IsReadOnly, void *userdata)
void(* cloudx1_storage_reader_free)(char *content, void *userdata)
int(* cloudx1_storage_rename)(const fs_char *from, const fs_char *to, void *userdata)
int(* cloudx1_storage_exists)(const fs_char *filename, void *userdata)
void cloudx1_PresetManager_InformChange(struct cloudx1_CInstance *instance, const fs_char *relative_path, enum cloudx1_PresetChange_Kind change_kind)
void(* cloudx1_storage_getall_free)(fs_char **all, 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 cloudx1_StartUpdateThread(struct cloudx1_CInstance *instance, unsigned int port)
int cloudx1_WaitUpdateThreadReady(struct cloudx1_CInstance *instance, int milliseconds)
void cloudx1_StopUpdateThread(struct cloudx1_CInstance *instance)
uint64_t cloudx1_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct cloudx1_CParameters *parameters)
uint64_t cloudx1_Webserver(unsigned int listenport, unsigned int listenport_secure, struct cloudx1_CInstance *instance)
uint64_t cloudx1_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port)
void cloudx1_Webserver_FreeString(char *str)
int cloudx1_Webserver_Status(uint64_t id)
int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms)
void cloudx1_Webserver_GetAppHealth(struct cloudx1_CInstance *instance, int *httpcode, char **contenttype, char **content)
void cloudx1_Webserver_SetAppHealth(struct cloudx1_CInstance *instance, int httpcode, const char *contenttype, const char *content)
#define CLOUDX1_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.