SOUND4 x1.CLOUD Library [1.4.7]
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 // --------------------------------------------------------------
142 // --------------------------------------------------------------
143 
144 // --------------------------------------------------------------
156 #define CLOUDX1_AUDIOFRAME_COUNT 64
162 #define CLOUDX1_CHANNEL_COUNT 2
168 #define CLOUDX1_AUDIO_INPUT_COUNT 1
174 #define CLOUDX1_AUDIO_OUTPUT_COUNT 1
180 #define CLOUDX1_SAMPLE_RATE 48000
181 
188  size_t struct_size;
189  const char *name;
190  const char *prefix;
191  const char *shortname;
192  const char *version;
193 };
194 
203 
210 
224 
234 
243 
253 
263 
272 
277  none = 0,
278  fatal = 1,
279  error = 2,
280  warning = 3,
281  info = 4,
282  verbose = 5,
283  verbose2 = 6,
284  verbose3 = 7,
285  verbose4 = 8,
286  verbose5 = 9,
287 };
288 
295 typedef void (*cloudx1_loggerfn) (enum cloudx1_LogSeverity, const char *);
296 
307 
316 
319 // --------------------------------------------------------------
325 // --------------------------------------------------------------
329 struct cloudx1_CInstance;
330 
334 struct cloudx1_CParameters;
335 
344 
349 
361 CLOUDX1_DECL void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value);
362 
368 CLOUDX1_DECL const char *cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name);
369 
375 CLOUDX1_DECL void cloudx1_FreeParameterValue(const char *value);
376 
385  const char *LoginKey,
386  const char *RadioName,
387  const char *Access_Key_ID,
388  const char *Access_Key_Secret,
389  const char *save_path
390  );
391 
400  const char *LoginKey,
401  const char *RadioName,
402  const char *Access_Key_ID,
403  const char *Access_Key_Secret,
404  const char *save_path,
405  const struct cloudx1_CParameters *parameters
406  );
407 
453  const char *LoginKey,
454  const char *RadioName,
455  const char *Access_Key_ID,
456  const char *Access_Key_Secret,
457  const char *save_path,
458  const struct cloudx1_CParameters *parameters,
459  unsigned int frames_per_chunk
460  );
461 
474 
485 
492 
495 #if CLOUDX1_HAS_CLOUDBUS
496 // --------------------------------------------------------------
505 struct cloudx1_CBus;
506 
512 CLOUDX1_DECL struct cloudx1_CBus* cloudx1_NewBus();
513 
519 CLOUDX1_DECL void cloudx1_FreeBus(struct cloudx1_CBus *bus);
520 
530 CLOUDX1_DECL void cloudx1_SetInstanceBus(struct cloudx1_CParameters *params, struct cloudx1_CBus *bus);
531 
532 
534 #endif // CLOUDX1_HAS_CLOUDBUS
535 
536 // --------------------------------------------------------------
559 // --------------------------------------------------------------
560 
561 // OS dependent filesystem path char type
562 #ifdef _WIN32
563  typedef wchar_t fs_char;
564 #else // !_WIN32
565  typedef char fs_char;
566 #endif // !_WIN32
567 
575 typedef char * (*cloudx1_storage_reader) (const fs_char *filename, void* userdata);
576 
583 typedef void (*cloudx1_storage_reader_free) (char *content, void* userdata);
584 
593 typedef int (*cloudx1_storage_writer) (const fs_char *filename, const char *content, void* userdata);
594 
602 typedef int (*cloudx1_storage_exists) (const fs_char *filename, void* userdata);
603 
611 typedef fs_char** (*cloudx1_storage_getall) (void* userdata);
612 
619 typedef void (*cloudx1_storage_getall_free) (fs_char**all, void* userdata);
620 
628 typedef int (*cloudx1_storage_remove) (const fs_char *filename, void* userdata);
629 
638 typedef int (*cloudx1_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
639 
659  , cloudx1_storage_writer writer
660  , cloudx1_storage_exists exists
662  , cloudx1_storage_remove remove
663  , cloudx1_storage_rename rename
664  , int IsReadOnly
665  , void* userdata
666  );
667 
675 };
676 
685 CLOUDX1_DECL void cloudx1_PresetManager_InformChange(struct cloudx1_CInstance *instance, const fs_char *relative_path, enum cloudx1_PresetChange_Kind change_kind);
686 
689 // --------------------------------------------------------------
697 // --------------------------------------------------------------
698 
715 CLOUDX1_DECL void cloudx1_SetMetadata(struct cloudx1_CInstance *instance, const char* key, const char* value);
716 
727 CLOUDX1_DECL void cloudx1_SetMetadataMulti(struct cloudx1_CInstance *instance, const char** keyvalue);
728 
737 
744 CLOUDX1_DECL void cloudx1_FreeMetadataInfos(struct cloudx1_CInstance *instance, const char** infos);
745 
748 // --------------------------------------------------------------
753 // --------------------------------------------------------------
754 
767 CLOUDX1_DECL void cloudx1_StartUpdateThread(struct cloudx1_CInstance *instance, unsigned int port);
768 
775 
783 CLOUDX1_DECL int cloudx1_WaitUpdateThreadReady(struct cloudx1_CInstance *instance, int milliseconds);
784 
787 // --------------------------------------------------------------
792 // --------------------------------------------------------------
814 CLOUDX1_DECL void cloudx1_ProcessAudio(struct cloudx1_CInstance *instance, const float *input, float *output );
815 
835  , float const * const *input
836  , float * const *output);
837 
851 
865 
874 
877 // --------------------------------------------------------------
884 // --------------------------------------------------------------
885  #ifdef _MSC_VER
886  #define __BYTE_ORDER__ REG_DWORD
887  #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
888  #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
889  #endif
890 
904 
905  // Native definitions, only links to the physical ones
906  #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
911  #else
916  #endif
917 };
918 
926 
934 
942 
943 
951 
962 CLOUDX1_DECL unsigned int cloudx1_AddAudio(struct cloudx1_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum cloudx1_SampleFormat fmt );
963 
970 CLOUDX1_DECL unsigned int cloudx1_AddPadAudio(struct cloudx1_CInstance *instance);
971 
979 
989 CLOUDX1_DECL unsigned int cloudx1_GetAudio(struct cloudx1_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum cloudx1_SampleFormat fmt );
990 
994 // --------------------------------------------------------------
998 // --------------------------------------------------------------
1009 CLOUDX1_DECL void cloudx1_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum cloudx1_SampleFormat fmt);
1010 
1021 CLOUDX1_DECL void cloudx1_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum cloudx1_SampleFormat fmt);
1022 
1032 CLOUDX1_DECL void cloudx1_StereoToMono(const float *input, float *output, size_t nFrame);
1033 
1043 CLOUDX1_DECL void cloudx1_MonoToStereo(const float *input, float *output, size_t nFrame);
1044 
1055 CLOUDX1_DECL void cloudx1_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
1056 
1067 CLOUDX1_DECL void cloudx1_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
1068 
1075 CLOUDX1_DECL void cloudx1_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
1076 
1083 CLOUDX1_DECL void cloudx1_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
1084 
1087 // --------------------------------------------------------------
1092 // --------------------------------------------------------------
1097 
1107 
1114 
1128 CLOUDX1_DECL const char *cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save);
1129 
1135 CLOUDX1_DECL void cloudx1_FreeJsonAnswer(const char *json_str);
1136 
1149 
1445 #if CLOUDX1_HAS_WEBSERVER
1446 // --------------------------------------------------------------
1454 // --------------------------------------------------------------
1473 CLOUDX1_DECL uint64_t cloudx1_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1474 
1475 // --------------------------------------------------------------
1495 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);
1496 
1514 CLOUDX1_DECL uint64_t cloudx1_Webserver(unsigned int listenport, unsigned int listenport_secure, struct cloudx1_CInstance *instance);
1515 
1525 CLOUDX1_DECL int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms);
1526 
1536 
1541 #define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1542 
1546 #define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1550 #define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1551 
1553 #endif // CLOUDX1_HAS_WEBSERVER
1554 
1555 #ifdef __cplusplus
1556 } // extern "C"
1557 #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)
int cloudx1_Webserver_Status(uint64_t id)
int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms)
#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.