SOUND4 x1.CLOUD Library [1.5.1]
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 #endif
17 
18 #define CLOUDX1_HAS_WEBSERVER 1
19 #define CLOUDX1_HAS_CLOUDBUS 0
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif // __cplusplus
24 
70 // --------------------------------------------------------------
89 // --------------------------------------------------------------
144 // --------------------------------------------------------------
145 
146 // --------------------------------------------------------------
158 #define CLOUDX1_AUDIOFRAME_COUNT 64
164 #define CLOUDX1_CHANNEL_COUNT 2
170 #define CLOUDX1_AUDIO_INPUT_COUNT 1
176 #define CLOUDX1_AUDIO_OUTPUT_COUNT 1
182 #define CLOUDX1_SAMPLE_RATE 48000
183 
190  size_t struct_size;
191  const char *name;
192  const char *prefix;
193  const char *shortname;
194  const char *version;
195 };
196 
205 
212 
226 
236 
245 
255 
265 
274 
279  none = 0,
280  fatal = 1,
281  error = 2,
282  warning = 3,
283  info = 4,
284  verbose = 5,
285  verbose2 = 6,
286  verbose3 = 7,
287  verbose4 = 8,
288  verbose5 = 9,
289 };
290 
297 typedef void (*cloudx1_loggerfn) (enum cloudx1_LogSeverity, const char *);
298 
309 
318 
321 // --------------------------------------------------------------
327 // --------------------------------------------------------------
331 struct cloudx1_CInstance;
332 
336 struct cloudx1_CParameters;
337 
346 
351 
363 CLOUDX1_DECL void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value);
364 
370 CLOUDX1_DECL const char *cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name);
371 
377 CLOUDX1_DECL void cloudx1_FreeParameterValue(const char *value);
378 
387  const char *LoginKey,
388  const char *RadioName,
389  const char *Access_Key_ID,
390  const char *Access_Key_Secret,
391  const char *save_path
392  );
393 
402  const char *LoginKey,
403  const char *RadioName,
404  const char *Access_Key_ID,
405  const char *Access_Key_Secret,
406  const char *save_path,
407  const struct cloudx1_CParameters *parameters
408  );
409 
455  const char *LoginKey,
456  const char *RadioName,
457  const char *Access_Key_ID,
458  const char *Access_Key_Secret,
459  const char *save_path,
460  const struct cloudx1_CParameters *parameters,
461  unsigned int frames_per_chunk
462  );
463 
476 
487 
494 
497 #if CLOUDX1_HAS_CLOUDBUS
498 // --------------------------------------------------------------
507 struct cloudx1_CBus;
508 
514 CLOUDX1_DECL struct cloudx1_CBus* cloudx1_NewBus();
515 
521 CLOUDX1_DECL void cloudx1_FreeBus(struct cloudx1_CBus *bus);
522 
532 CLOUDX1_DECL void cloudx1_SetInstanceBus(struct cloudx1_CParameters *params, struct cloudx1_CBus *bus);
533 
534 
536 #endif // CLOUDX1_HAS_CLOUDBUS
537 
538 // --------------------------------------------------------------
561 // --------------------------------------------------------------
562 
563 // OS dependent filesystem path char type
564 #ifdef _WIN32
565  typedef wchar_t fs_char;
566 #else // !_WIN32
567  typedef char fs_char;
568 #endif // !_WIN32
569 
577 typedef char * (*cloudx1_storage_reader) (const fs_char *filename, void* userdata);
578 
585 typedef void (*cloudx1_storage_reader_free) (char *content, void* userdata);
586 
595 typedef int (*cloudx1_storage_writer) (const fs_char *filename, const char *content, void* userdata);
596 
604 typedef int (*cloudx1_storage_exists) (const fs_char *filename, void* userdata);
605 
613 typedef fs_char** (*cloudx1_storage_getall) (void* userdata);
614 
621 typedef void (*cloudx1_storage_getall_free) (fs_char**all, void* userdata);
622 
630 typedef int (*cloudx1_storage_remove) (const fs_char *filename, void* userdata);
631 
640 typedef int (*cloudx1_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
641 
661  , cloudx1_storage_writer writer
662  , cloudx1_storage_exists exists
664  , cloudx1_storage_remove remove
665  , cloudx1_storage_rename rename
666  , int IsReadOnly
667  , void* userdata
668  );
669 
677 };
678 
687 CLOUDX1_DECL void cloudx1_PresetManager_InformChange(struct cloudx1_CInstance *instance, const fs_char *relative_path, enum cloudx1_PresetChange_Kind change_kind);
688 
691 // --------------------------------------------------------------
699 // --------------------------------------------------------------
700 
717 CLOUDX1_DECL void cloudx1_SetMetadata(struct cloudx1_CInstance *instance, const char* key, const char* value);
718 
729 CLOUDX1_DECL void cloudx1_SetMetadataMulti(struct cloudx1_CInstance *instance, const char** keyvalue);
730 
739 
746 CLOUDX1_DECL void cloudx1_FreeMetadataInfos(struct cloudx1_CInstance *instance, const char** infos);
747 
750 // --------------------------------------------------------------
755 // --------------------------------------------------------------
756 
769 CLOUDX1_DECL void cloudx1_StartUpdateThread(struct cloudx1_CInstance *instance, unsigned int port);
770 
777 
785 CLOUDX1_DECL int cloudx1_WaitUpdateThreadReady(struct cloudx1_CInstance *instance, int milliseconds);
786 
789 // --------------------------------------------------------------
794 // --------------------------------------------------------------
816 CLOUDX1_DECL void cloudx1_ProcessAudio(struct cloudx1_CInstance *instance, const float *input, float *output );
817 
837  , float const * const *input
838  , float * const *output);
839 
853 
867 
876 
879 // --------------------------------------------------------------
886 // --------------------------------------------------------------
887  #ifdef _MSC_VER
888  #define __BYTE_ORDER__ REG_DWORD
889  #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
890  #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
891  #endif
892 
906 
907  // Native definitions, only links to the physical ones
908  #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
913  #else
918  #endif
919 };
920 
928 
936 
944 
945 
953 
964 CLOUDX1_DECL unsigned int cloudx1_AddAudio(struct cloudx1_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum cloudx1_SampleFormat fmt );
965 
972 CLOUDX1_DECL unsigned int cloudx1_AddPadAudio(struct cloudx1_CInstance *instance);
973 
981 
991 CLOUDX1_DECL unsigned int cloudx1_GetAudio(struct cloudx1_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum cloudx1_SampleFormat fmt );
992 
996 // --------------------------------------------------------------
1000 // --------------------------------------------------------------
1011 CLOUDX1_DECL void cloudx1_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum cloudx1_SampleFormat fmt);
1012 
1023 CLOUDX1_DECL void cloudx1_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum cloudx1_SampleFormat fmt);
1024 
1034 CLOUDX1_DECL void cloudx1_StereoToMono(const float *input, float *output, size_t nFrame);
1035 
1045 CLOUDX1_DECL void cloudx1_MonoToStereo(const float *input, float *output, size_t nFrame);
1046 
1057 CLOUDX1_DECL void cloudx1_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
1058 
1069 CLOUDX1_DECL void cloudx1_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
1070 
1077 CLOUDX1_DECL void cloudx1_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
1078 
1085 CLOUDX1_DECL void cloudx1_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
1086 
1089 // --------------------------------------------------------------
1094 // --------------------------------------------------------------
1099 
1109 
1116 
1130 CLOUDX1_DECL const char *cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save);
1131 
1137 CLOUDX1_DECL void cloudx1_FreeJsonAnswer(const char *json_str);
1138 
1151 
1447 #if CLOUDX1_HAS_WEBSERVER
1448 // --------------------------------------------------------------
1456 // --------------------------------------------------------------
1475 CLOUDX1_DECL uint64_t cloudx1_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1476 
1477 // --------------------------------------------------------------
1497 CLOUDX1_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);
1498 
1516 CLOUDX1_DECL uint64_t cloudx1_Webserver(unsigned int listenport, unsigned int listenport_secure, struct cloudx1_CInstance *instance);
1517 
1527 CLOUDX1_DECL int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms);
1528 
1538 
1549 CLOUDX1_DECL void cloudx1_Webserver_SetAppHealth(struct cloudx1_CInstance *instance, int httpcode, const char *contenttype, const char *content);
1550 
1559 CLOUDX1_DECL void cloudx1_Webserver_GetAppHealth(struct cloudx1_CInstance *instance, int* httpcode, char** contenttype, char** content);
1560 
1567 
1572 #define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1573 
1577 #define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1581 #define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1582 
1584 #endif // CLOUDX1_HAS_WEBSERVER
1585 
1586 #ifdef __cplusplus
1587 } // extern "C"
1588 #endif // __cplusplus
enum cloudx1_SampleFormat cloudx1_GetFormatFromName(const char *name)
cloudx1_SampleFormat
unsigned int cloudx1_GetOutputCount(struct cloudx1_CInstance *instance)
const char * cloudx1_GetFormatName(const enum cloudx1_SampleFormat fmt)
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
int cloudx1_SaveState(struct cloudx1_CInstance *instance)
struct cloudx1_CClientInstance * cloudx1_NewClient(struct cloudx1_CInstance *instance)
void cloudx1_DeleteClient(struct cloudx1_CClientInstance *client)
void cloudx1_FreeJsonAnswer(const char *json_str)
const char * cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save)
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_GetBufferIn(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_GetBufferOut(struct cloudx1_CInstance *instance)
unsigned int cloudx1_GetAudioInputCount()
const char * cloudx1_GetVersion()
cloudx1_LogSeverity
unsigned int cloudx1_GetChunkSizeInFrames()
unsigned int * cloudx1_GetPossibleChunkSizeInFrames()
unsigned int cloudx1_GetAudioOutputCount()
unsigned int cloudx1_GetChannelCount()
void cloudx1_SetLoggerCallback(cloudx1_loggerfn logger)
unsigned int cloudx1_GetSampleRate()
const struct SOUND4_ProcessInfo * SOUND4_GetProcessInfo()
void(* cloudx1_loggerfn)(enum cloudx1_LogSeverity, const char *)
void cloudx1_SetLogSeverity(enum cloudx1_LogSeverity severity)
@ verbose5
@ fatal
@ warning
@ verbose4
@ info
@ none
@ error
@ verbose2
@ verbose3
@ verbose
void cloudx1_FreeParameterValue(const char *value)
void cloudx1_ExitProcess(struct cloudx1_CInstance *instance)
void cloudx1_FreeParameters(struct cloudx1_CParameters *params)
struct cloudx1_CParameters * cloudx1_NewParameters()
void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value)
int cloudx1_TerminateProcess(struct cloudx1_CInstance *instance)
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)
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)
const char * cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name)
unsigned int cloudx1_GetProcessChunkFrames(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_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)
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)
fs_char **(* cloudx1_storage_getall)(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)
char *(* cloudx1_storage_reader)(const fs_char *filename, void *userdata)
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.