SOUND4 x1.CLOUD Library [1.4.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 
68 // --------------------------------------------------------------
87 // --------------------------------------------------------------
140 // --------------------------------------------------------------
141 
142 // --------------------------------------------------------------
154 #define CLOUDX1_AUDIOFRAME_COUNT 64
160 #define CLOUDX1_CHANNEL_COUNT 2
166 #define CLOUDX1_AUDIO_INPUT_COUNT 1
172 #define CLOUDX1_AUDIO_OUTPUT_COUNT 1
178 #define CLOUDX1_SAMPLE_RATE 48000
179 
186 
200 
210 
219 
229 
239 
248 
253  none = 0,
254  fatal = 1,
255  error = 2,
256  warning = 3,
257  info = 4,
258  verbose = 5,
259  verbose2 = 6,
260  verbose3 = 7,
261  verbose4 = 8,
262  verbose5 = 9,
263 };
264 
271 typedef void (*cloudx1_loggerfn) (enum cloudx1_LogSeverity, const char *);
272 
283 
292 
295 // --------------------------------------------------------------
301 // --------------------------------------------------------------
305 struct cloudx1_CInstance;
306 
310 struct cloudx1_CParameters;
311 
320 
325 
337 CLOUDX1_DECL void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value);
338 
344 CLOUDX1_DECL const char *cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name);
345 
351 CLOUDX1_DECL void cloudx1_FreeParameterValue(const char *value);
352 
361  const char *LoginKey,
362  const char *RadioName,
363  const char *AWS_Access_ID,
364  const char *AWS_Access_Secret,
365  const char *save_path
366  );
367 
376  const char *LoginKey,
377  const char *RadioName,
378  const char *AWS_Access_ID,
379  const char *AWS_Access_Secret,
380  const char *save_path,
381  const struct cloudx1_CParameters *parameters
382  );
383 
429  const char *LoginKey,
430  const char *RadioName,
431  const char *AWS_Access_ID,
432  const char *AWS_Access_Secret,
433  const char *save_path,
434  const struct cloudx1_CParameters *parameters,
435  unsigned int frames_per_chunk
436  );
437 
450 
461 
468 
471 #if CLOUDX1_HAS_CLOUDBUS
472 // --------------------------------------------------------------
481 struct cloudx1_CBus;
482 
488 CLOUDX1_DECL struct cloudx1_CBus* cloudx1_NewBus();
489 
495 CLOUDX1_DECL void cloudx1_FreeBus(struct cloudx1_CBus *bus);
496 
506 CLOUDX1_DECL void cloudx1_SetInstanceBus(struct cloudx1_CParameters *params, struct cloudx1_CBus *bus);
507 
508 
510 #endif // CLOUDX1_HAS_CLOUDBUS
511 
512 // --------------------------------------------------------------
535 // --------------------------------------------------------------
536 
537 // OS dependent filesystem path char type
538 #ifdef _WIN32
539  typedef wchar_t fs_char;
540 #else // !_WIN32
541  typedef char fs_char;
542 #endif // !_WIN32
543 
551 typedef char * (*cloudx1_storage_reader) (const fs_char *filename, void* userdata);
552 
559 typedef void (*cloudx1_storage_reader_free) (char *content, void* userdata);
560 
569 typedef int (*cloudx1_storage_writer) (const fs_char *filename, const char *content, void* userdata);
570 
578 typedef int (*cloudx1_storage_exists) (const fs_char *filename, void* userdata);
579 
587 typedef fs_char** (*cloudx1_storage_getall) (void* userdata);
588 
595 typedef void (*cloudx1_storage_getall_free) (fs_char**all, void* userdata);
596 
604 typedef int (*cloudx1_storage_remove) (const fs_char *filename, void* userdata);
605 
614 typedef int (*cloudx1_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
615 
635  , cloudx1_storage_writer writer
636  , cloudx1_storage_exists exists
638  , cloudx1_storage_remove remove
639  , cloudx1_storage_rename rename
640  , int IsReadOnly
641  , void* userdata
642  );
643 
651 };
652 
661 CLOUDX1_DECL void cloudx1_PresetManager_InformChange(struct cloudx1_CInstance *instance, const fs_char *relative_path, enum cloudx1_PresetChange_Kind change_kind);
662 
665 // --------------------------------------------------------------
673 // --------------------------------------------------------------
674 
688 CLOUDX1_DECL void cloudx1_SetMetadata(struct cloudx1_CInstance *instance, const char* key, const char* value);
689 
698 
705 CLOUDX1_DECL void cloudx1_FreeMetadataInfos(struct cloudx1_CInstance *instance, const char** infos);
706 
709 // --------------------------------------------------------------
714 // --------------------------------------------------------------
715 
728 CLOUDX1_DECL void cloudx1_StartUpdateThread(struct cloudx1_CInstance *instance, unsigned int port);
729 
736 
744 CLOUDX1_DECL int cloudx1_WaitUpdateThreadReady(struct cloudx1_CInstance *instance, int milliseconds);
745 
748 // --------------------------------------------------------------
753 // --------------------------------------------------------------
775 CLOUDX1_DECL void cloudx1_ProcessAudio(struct cloudx1_CInstance *instance, const float *input, float *output );
776 
796  , float const * const *input
797  , float * const *output);
798 
812 
826 
835 
838 // --------------------------------------------------------------
845 // --------------------------------------------------------------
846  #ifdef _MSC_VER
847  #define __BYTE_ORDER__ REG_DWORD
848  #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
849  #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
850  #endif
851 
865 
866  // Native definitions, only links to the physical ones
867  #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
872  #else
877  #endif
878 };
879 
887 
895 
903 
904 
912 
923 CLOUDX1_DECL unsigned int cloudx1_AddAudio(struct cloudx1_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum cloudx1_SampleFormat fmt );
924 
931 CLOUDX1_DECL unsigned int cloudx1_AddPadAudio(struct cloudx1_CInstance *instance);
932 
940 
950 CLOUDX1_DECL unsigned int cloudx1_GetAudio(struct cloudx1_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum cloudx1_SampleFormat fmt );
951 
955 // --------------------------------------------------------------
959 // --------------------------------------------------------------
970 CLOUDX1_DECL void cloudx1_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum cloudx1_SampleFormat fmt);
971 
982 CLOUDX1_DECL void cloudx1_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum cloudx1_SampleFormat fmt);
983 
993 CLOUDX1_DECL void cloudx1_StereoToMono(const float *input, float *output, size_t nFrame);
994 
1004 CLOUDX1_DECL void cloudx1_MonoToStereo(const float *input, float *output, size_t nFrame);
1005 
1016 CLOUDX1_DECL void cloudx1_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
1017 
1028 CLOUDX1_DECL void cloudx1_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
1029 
1036 CLOUDX1_DECL void cloudx1_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
1037 
1044 CLOUDX1_DECL void cloudx1_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
1045 
1048 // --------------------------------------------------------------
1053 // --------------------------------------------------------------
1058 
1068 
1075 
1089 CLOUDX1_DECL const char *cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save);
1090 
1096 CLOUDX1_DECL void cloudx1_FreeJsonAnswer(const char *json_str);
1097 
1110 
1406 #if CLOUDX1_HAS_WEBSERVER
1407 // --------------------------------------------------------------
1415 // --------------------------------------------------------------
1434 CLOUDX1_DECL uint64_t cloudx1_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1435 
1436 // --------------------------------------------------------------
1456 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);
1457 
1475 CLOUDX1_DECL uint64_t cloudx1_Webserver(unsigned int listenport, unsigned int listenport_secure, struct cloudx1_CInstance *instance);
1476 
1486 CLOUDX1_DECL int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms);
1487 
1497 
1502 #define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1503 
1507 #define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1511 #define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1512 
1514 #endif // CLOUDX1_HAS_WEBSERVER
1515 
1516 #ifdef __cplusplus
1517 } // extern "C"
1518 #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()
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
struct cloudx1_CInstance * cloudx1_InitProcess(const char *LoginKey, const char *RadioName, const char *AWS_Access_ID, const char *AWS_Access_Secret, const char *save_path)
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_InitProcess2(const char *LoginKey, const char *RadioName, const char *AWS_Access_ID, const char *AWS_Access_Secret, const char *save_path, const struct cloudx1_CParameters *parameters)
struct cloudx1_CInstance * cloudx1_InitProcess3(const char *LoginKey, const char *RadioName, const char *AWS_Access_ID, const char *AWS_Access_Secret, const char *save_path, const struct cloudx1_CParameters *parameters, unsigned int frames_per_chunk)
const char * cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name)
unsigned int cloudx1_GetProcessChunkFrames(struct cloudx1_CInstance *instance)
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)
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