SOUND4 x1.CLOUD Library [1.5.5]
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
73// --------------------------------------------------------------
92// --------------------------------------------------------------
158// --------------------------------------------------------------
159
160// --------------------------------------------------------------
172#define CLOUDX1_AUDIOFRAME_COUNT 64
178#define CLOUDX1_CHANNEL_COUNT 2
184#define CLOUDX1_AUDIO_INPUT_COUNT 1
190#define CLOUDX1_AUDIO_OUTPUT_COUNT 1
196#define CLOUDX1_SAMPLE_RATE 48000
197
204 size_t struct_size;
205 const char *name;
206 const char *prefix;
207 const char *shortname;
208 const char *version;
209};
210
219
226
240
250
259
269
279
288
304
311typedef void (*cloudx1_loggerfn) (enum cloudx1_LogSeverity, const char *);
312
323
332
335// --------------------------------------------------------------
341// --------------------------------------------------------------
345struct cloudx1_CInstance;
346
351
360
365
377CLOUDX1_DECL void cloudx1_SetParameter(struct cloudx1_CParameters *params, const char *name, const char *value);
378
384CLOUDX1_DECL const char *cloudx1_GetParameter(struct cloudx1_CParameters *params, const char *name);
385
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 );
407
416 const char *LoginKey,
417 const char *RadioName,
418 const char *Access_Key_ID,
419 const char *Access_Key_Secret,
420 const char *save_path,
421 const struct cloudx1_CParameters *parameters
422 );
423
469 const char *LoginKey,
470 const char *RadioName,
471 const char *Access_Key_ID,
472 const char *Access_Key_Secret,
473 const char *save_path,
474 const struct cloudx1_CParameters *parameters,
475 unsigned int frames_per_chunk
476 );
477
490
501
508
511#if CLOUDX1_HAS_CLOUDBUS
512// --------------------------------------------------------------
521struct cloudx1_CBus;
522
528CLOUDX1_DECL struct cloudx1_CBus* cloudx1_NewBus();
529
535CLOUDX1_DECL void cloudx1_FreeBus(struct cloudx1_CBus *bus);
536
546CLOUDX1_DECL void cloudx1_SetInstanceBus(struct cloudx1_CParameters *params, struct cloudx1_CBus *bus);
547
548
550#endif // CLOUDX1_HAS_CLOUDBUS
551
552// --------------------------------------------------------------
575// --------------------------------------------------------------
576
577// OS dependent filesystem path char type
578#ifdef _WIN32
579 typedef wchar_t fs_char;
580#else // !_WIN32
581 typedef char fs_char;
582#endif // !_WIN32
583
591typedef char * (*cloudx1_storage_reader) (const fs_char *filename, void* userdata);
592
599typedef void (*cloudx1_storage_reader_free) (char *content, void* userdata);
600
609typedef int (*cloudx1_storage_writer) (const fs_char *filename, const char *content, void* userdata);
610
618typedef int (*cloudx1_storage_exists) (const fs_char *filename, void* userdata);
619
627typedef fs_char** (*cloudx1_storage_getall) (void* userdata);
628
635typedef void (*cloudx1_storage_getall_free) (fs_char**all, void* userdata);
636
644typedef int (*cloudx1_storage_remove) (const fs_char *filename, void* userdata);
645
654typedef int (*cloudx1_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
655
680 , int IsReadOnly
681 , void* userdata
682 );
683
692
701CLOUDX1_DECL void cloudx1_PresetManager_InformChange(struct cloudx1_CInstance *instance, const fs_char *relative_path, enum cloudx1_PresetChange_Kind change_kind);
702
705// --------------------------------------------------------------
713// --------------------------------------------------------------
714
731CLOUDX1_DECL void cloudx1_SetMetadata(struct cloudx1_CInstance *instance, const char* key, const char* value);
732
743CLOUDX1_DECL void cloudx1_SetMetadataMulti(struct cloudx1_CInstance *instance, const char** keyvalue);
744
753
760CLOUDX1_DECL void cloudx1_FreeMetadataInfos(struct cloudx1_CInstance *instance, const char** infos);
761
764// --------------------------------------------------------------
769// --------------------------------------------------------------
770
783CLOUDX1_DECL void cloudx1_StartUpdateThread(struct cloudx1_CInstance *instance, unsigned int port);
784
791
799CLOUDX1_DECL int cloudx1_WaitUpdateThreadReady(struct cloudx1_CInstance *instance, int milliseconds);
800
803// --------------------------------------------------------------
808// --------------------------------------------------------------
830CLOUDX1_DECL void cloudx1_ProcessAudio(struct cloudx1_CInstance *instance, const float *input, float *output );
831
851 , float const * const *input
852 , float * const *output);
853
867
881
890
893// --------------------------------------------------------------
900// --------------------------------------------------------------
901 #ifdef _MSC_VER
902 #define __BYTE_ORDER__ REG_DWORD
903 #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
904 #define __ORDER_BIG_ENDIAN__ REG_DWORD_BIG_ENDIAN
905 #endif
906
920
921 // Native definitions, only links to the physical ones
922 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
927 #else
932 #endif
933};
934
942
950
958
959
967
978CLOUDX1_DECL unsigned int cloudx1_AddAudio(struct cloudx1_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum cloudx1_SampleFormat fmt );
979
987
995
1005CLOUDX1_DECL unsigned int cloudx1_GetAudio(struct cloudx1_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum cloudx1_SampleFormat fmt );
1006
1010// --------------------------------------------------------------
1014// --------------------------------------------------------------
1025CLOUDX1_DECL void cloudx1_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum cloudx1_SampleFormat fmt);
1026
1037CLOUDX1_DECL void cloudx1_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum cloudx1_SampleFormat fmt);
1038
1048CLOUDX1_DECL void cloudx1_StereoToMono(const float *input, float *output, size_t nFrame);
1049
1059CLOUDX1_DECL void cloudx1_MonoToStereo(const float *input, float *output, size_t nFrame);
1060
1071CLOUDX1_DECL void cloudx1_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
1072
1083CLOUDX1_DECL void cloudx1_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
1084
1091CLOUDX1_DECL void cloudx1_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
1092
1099CLOUDX1_DECL void cloudx1_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
1100
1103// --------------------------------------------------------------
1108// --------------------------------------------------------------
1113
1123
1130
1144CLOUDX1_DECL const char *cloudx1_ProcessJson(struct cloudx1_CClientInstance *client, const char *json_str, int *need_save);
1145
1151CLOUDX1_DECL void cloudx1_FreeJsonAnswer(const char *json_str);
1152
1165
1461#if CLOUDX1_HAS_WEBSERVER
1462// --------------------------------------------------------------
1475// --------------------------------------------------------------
1494CLOUDX1_DECL uint64_t cloudx1_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
1495
1496// --------------------------------------------------------------
1516CLOUDX1_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);
1517
1535CLOUDX1_DECL uint64_t cloudx1_Webserver(unsigned int listenport, unsigned int listenport_secure, struct cloudx1_CInstance *instance);
1536
1546CLOUDX1_DECL int cloudx1_Webserver_Stop(uint64_t id, int timeout_ms);
1547
1557
1568CLOUDX1_DECL void cloudx1_Webserver_SetAppHealth(struct cloudx1_CInstance *instance, int httpcode, const char *contenttype, const char *content);
1569
1578CLOUDX1_DECL void cloudx1_Webserver_GetAppHealth(struct cloudx1_CInstance *instance, int* httpcode, char** contenttype, char** content);
1579
1586
1591#define SOUND4_INVALID_WEBSERVER_ID ((uint64_t)-1)
1592
1596#define SOUND4_WEBSERVER_HTTP_OK (1<<0)
1600#define SOUND4_WEBSERVER_HTTPS_OK (1<<1)
1601
1603#endif // CLOUDX1_HAS_WEBSERVER
1604
1605#ifdef __cplusplus
1606} // extern "C"
1607#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
@ 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)
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.