cosc.h

Go to the documentation of this file.

#ifndef COSC_H
#define COSC_H




 
#ifndef COSC_API
#ifdef COSC_BUILD_SHARED
#ifdef _MSC_VER
#define COSC_API __declspec(dllexport)
#else
#define COSC_API
#endif
#else /* COSC_BUILD_SHARED */
#if defined(__clang__) || defined(__GNUC__)
#define COSC_API __attribute__ ((visibility ("hidden")))
#else
#define COSC_API
#endif
#endif /* COSC_BUILD_SHARED */
#endif /* COSC_API */






 
#ifndef COSC_NOSTDINT
 
#ifdef __cplusplus
#include <cstdint>
#else
#include <stdint.h>
#endif
 
#ifndef COSC_TYPE_INT32
#define COSC_TYPE_INT32 int32_t
#endif
#ifndef COSC_TYPE_UINT32
#define COSC_TYPE_UINT32 uint32_t
#endif
 
#ifndef COSC_NOINT64
#ifndef COSC_TYPE_INT64
#define COSC_TYPE_INT64 int64_t
#endif
#else
#define COSC_TYPE_INT64 struct cosc_64bits
#endif
 
#ifndef COSC_NOINT64
#ifndef COSC_TYPE_UINT64
#define COSC_TYPE_UINT64 uint64_t
#endif
#else
#define COSC_TYPE_UINT64 struct cosc_64bits
#endif
 
#else /* COSC_NOSTDINT */
 
/* These defaults require int and unsigned int to be exactly 32 bits. */
#ifndef COSC_TYPE_INT32
#define COSC_TYPE_INT32 int
#endif
#ifndef COSC_TYPE_UINT32
#define COSC_TYPE_UINT32 unsigned int
#endif
 
#ifndef COSC_NOINT64
#ifndef COSC_TYPE_INT64
#define COSC_TYPE_INT64 long long
#endif
#else
#define COSC_TYPE_INT64 struct cosc_64bits
#endif
 
#ifndef COSC_NOINT64
#ifndef COSC_TYPE_UINT64
#define COSC_TYPE_UINT64 unsigned long long
#endif
#else
#define COSC_TYPE_UINT64 struct cosc_64bits
#endif
 
#endif /* COSC_NOSTDINT */
 
#ifndef COSC_NOFLOAT32
#ifndef COSC_TYPE_FLOAT32
#define COSC_TYPE_FLOAT32 float
#endif
#else
#define COSC_TYPE_FLOAT32 COSC_TYPE_UINT32
#endif
 
#ifndef COSC_NOFLOAT64
#ifndef COSC_TYPE_FLOAT64
#define COSC_TYPE_FLOAT64 double
#endif
#else
#define COSC_TYPE_FLOAT64 struct cosc_64bits
#endif

#define COSC_INT32MAX 2147483647

#define COSC_INT32MIN ((-2147483647)-1)

#define COSC_UINT32MAX 4294967295

#define COSC_INT64MAX 9223372036854775807LL

#define COSC_INT64MIN ((-9223372036854775807LL)-1)

#define COSC_UINT64MAX 18446744073709551615ULL

typedef COSC_TYPE_UINT32 cosc_uint32;

typedef COSC_TYPE_INT32 cosc_int32;

#define COSC_64BITS_INIT(hi_, lo_) {{(hi_), (lo_)}}

#define COSC_64BITS_SET(bits_, hi_, lo_) do { COSC_64BITS_HI(bits_) = (hi_); COSC_64BITS_LO(bits_) = (lo_); } while (0)

#define COSC_64BITS_HI(bits_) ((bits_)->w[0])

#define COSC_64BITS_LO(bits_) ((bits_)->w[1])


 
#ifndef COSC_NOINT64
#define COSC_INT64_INIT_ZERO 0
#define COSC_INT64_SET_ZERO(ptr) (*(ptr) = 0)
#else
#define COSC_INT64_INIT_ZERO COSC_64BITS_INIT(0, 0)
#define COSC_INT64_SET_ZERO(ptr) COSC_64BITS_SET(ptr, 0, 0)
#endif


 
#ifndef COSC_NOFLOAT64
#define COSC_FLOAT64_INIT_ZERO 0
#define COSC_FLOAT64_SET_ZERO(ptr) (*(ptr) = 0)
#else
#define COSC_FLOAT64_INIT_ZERO COSC_64BITS_INIT(0, 0)
#define COSC_FLOAT64_SET_ZERO(ptr) COSC_64BITS_SET(ptr, 0, 0)
#endif

struct cosc_64bits
{

    cosc_uint32 w[2];
 
};

typedef COSC_TYPE_INT64 cosc_int64;

typedef COSC_TYPE_UINT64 cosc_uint64;

typedef COSC_TYPE_FLOAT32 cosc_float32;

typedef COSC_TYPE_FLOAT64 cosc_float64;

#define COSC_SIZE_MAX 2147483644

#define COSC_PADMUST(sz) (4 - ((cosc_uint32)(sz) & 3))

#define COSC_PAD(sz) (COSC_PADMUST(sz) & 3)

#define COSC_LEVEL_TYPE_BUNDLE 'B'

#define COSC_LEVEL_TYPE_MESSAGE 'M'

#define COSC_LEVEL_TYPE_BLOB 'b'

#define COSC_SERIAL_PSIZE 1

#define COSC_EOVERRUN -2

#define COSC_ESIZEMAX -3

#define COSC_ETYPE -4

#define COSC_EPSIZE -5

#define COSC_EINVAL -6

#define COSC_ELEVELMAX -7

#define COSC_ELEVELTYPE -8

#define COSC_EPSIZEFLAG -9

#define COSC_EMSGTYPE -10

union cosc_value
{

    cosc_int32 i;

    cosc_float32 f;

    struct
    {

        const char *s;

        cosc_int32 length;
 
    } s;

    struct
    {

        const void *b;

        cosc_int32 size;
 
    } b;

    cosc_int64 h;

    cosc_uint64 t;

    cosc_float64 d;

    cosc_int32 c;

    cosc_uint32 r;

    unsigned char m[4];
 
};

struct cosc_message
{

    const char *address;

    cosc_int32 address_n;

    const char *typetag;

    cosc_int32 typetag_n;

    union
    {

        const union cosc_value *write;

        union cosc_value *read;
 
    } values;

    cosc_int32 values_n;
 
};

#define COSC_SERIAL_ISWRITER(serial_) ((serial_)->wbuffer != 0)

#define COSC_SERIAL_ISREADER(serial_) ((serial_)->rbuffer != 0)

struct cosc_level
{

    cosc_int32 type;

    cosc_int32 start;

    cosc_int32 size_max;

    cosc_int32 size;

    cosc_int32 ttstart;

    cosc_int32 ttend;

    cosc_int32 ttindex;
 
};

struct cosc_serial
{

    unsigned char *wbuffer;

    const unsigned char *rbuffer;

    cosc_int32 buffer_size;

    struct cosc_level *levels;

    cosc_int32 level_max;

    cosc_int32 level;

    cosc_int32 size;

    cosc_uint32 flags;
 
};
 
#ifdef __cplusplus
extern "C" {
#endif

COSC_API cosc_int32 cosc_feature_int64(void);

COSC_API cosc_int32 cosc_feature_float32(void);

COSC_API cosc_int32 cosc_feature_float64(void);

COSC_API cosc_int32 cosc_feature_swap(void);

COSC_API cosc_int32 cosc_feature_array(void);

COSC_API cosc_int32 cosc_feature_pattern(void);

COSC_API cosc_int32 cosc_feature_timetag(void);

COSC_API cosc_int32 cosc_feature_fltconv(void);

COSC_API cosc_int32 cosc_feature_writer(void);

COSC_API cosc_int32 cosc_feature_reader(void);

COSC_API cosc_int32 cosc_big_endian(void);

COSC_API cosc_int32 cosc_address_char_validate(
    cosc_int32 c
);

COSC_API cosc_int32 cosc_address_validate(
    const char *address,
    cosc_int32 address_n,
    cosc_int32 *invalid
);

COSC_API cosc_int32 cosc_typetag_char_validate(
    cosc_int32 c
);

COSC_API cosc_int32 cosc_typetag_validate(
    const char *typetag,
    cosc_int32 typetag_n,
    cosc_int32 *invalid
);

COSC_API cosc_int32 cosc_typetag_payload(
    char *s,
    cosc_int32 s_n,
    const char *typetag,
    cosc_int32 typetag_n,
    cosc_int32 *array_members
);
 
#ifndef COSC_NOPATTERN

COSC_API cosc_int32 cosc_pattern_char_validate(
    cosc_int32 c
);

COSC_API cosc_int32 cosc_pattern_validate(
    const char *s,
    cosc_int32 s_n,
    cosc_int32 *invalid
);

COSC_API cosc_int32 cosc_pattern_match(
    const char *s,
    cosc_int32 s_n,
    const char *pattern,
    cosc_int32 pattern_n
);

COSC_API cosc_int32 cosc_signature_match(
    const void *buffer,
    cosc_int32 size,
    const char *apattern,
    cosc_int32 apattern_n,
    const char *tpattern,
    cosc_int32 tpattern_n,
    cosc_int32 prefix
);
 
#endif /* !COSC_NOPATTERN */
 
#ifndef COSC_NOTIMETAG

COSC_API cosc_uint32 cosc_timetag_to_time(
    cosc_uint64 timetag,
    cosc_uint32 *nanos
);

COSC_API cosc_uint64 cosc_time_to_timetag(
    cosc_uint32 seconds,
    cosc_uint32 nanos
);
 
#endif /* !COSC_NOTIMETAG */
 
#ifndef COSC_NOFLTCONV

COSC_API cosc_float32 cosc_float64_to_float32(
    cosc_float64 value
);

COSC_API cosc_float64 cosc_float32_to_float64(
    cosc_float32 value
);
 
#endif /* !COSC_NOFLTCONV */

COSC_API cosc_int32 cosc_write_uint32(
    void *buffer,
    cosc_int32 size,
    cosc_uint32 value
);

COSC_API cosc_int32 cosc_read_uint32(
    const void *buffer,
    cosc_int32 size,
    cosc_uint32 *value
);

COSC_API cosc_int32 cosc_write_int32(
    void *buffer,
    cosc_int32 size,
    cosc_int32 value
);

COSC_API cosc_int32 cosc_read_int32(
    const void *buffer,
    cosc_int32 size,
    cosc_int32 *value
);

COSC_API cosc_int32 cosc_write_float32(
    void *buffer,
    cosc_int32 size,
    cosc_float32 value
);

COSC_API cosc_int32 cosc_read_float32(
    const void *buffer,
    cosc_int32 size,
    cosc_float32 *value
);

COSC_API cosc_int32 cosc_write_uint64(
    void *buffer,
    cosc_int32 size,
    cosc_uint64 value
);

COSC_API cosc_int32 cosc_read_uint64(
    const void *buffer,
    cosc_int32 size,
    cosc_uint64 *value
);

COSC_API cosc_int32 cosc_write_int64(
    void *buffer,
    cosc_int32 size,
    cosc_int64 value
);

COSC_API cosc_int32 cosc_read_int64(
    const void *buffer,
    cosc_int32 size,
    cosc_int64 *value
);

COSC_API cosc_int32 cosc_write_float64(
    void *buffer,
    cosc_int32 size,
    cosc_float64 value
);

COSC_API cosc_int32 cosc_read_float64(
    const void *buffer,
    cosc_int32 size,
    cosc_float64 *value
);

COSC_API cosc_int32 cosc_write_string(
    void *buffer,
    cosc_int32 size,
    const char *value,
    cosc_int32 value_n,
    cosc_int32 *length
);

COSC_API cosc_int32 cosc_read_string(
    const void *buffer,
    cosc_int32 size,
    char *value,
    cosc_int32 value_n,
    cosc_int32 *length
);

COSC_API cosc_int32 cosc_write_blob(
    void *buffer,
    cosc_int32 size,
    const void *value,
    cosc_int32 value_n
);

COSC_API cosc_int32 cosc_read_blob(
    const void *buffer,
    cosc_int32 size,
    void *value,
    cosc_int32 value_n,
    const void **data,
    cosc_int32 *data_size
);

COSC_API cosc_int32 cosc_write_char(
    void *buffer,
    cosc_int32 size,
    cosc_int32 value
);

COSC_API cosc_int32 cosc_read_char(
    const void *buffer,
    cosc_int32 size,
    cosc_int32 *value
);

COSC_API cosc_int32 cosc_write_midi(
    void *buffer,
    cosc_int32 size,
    const unsigned char value[4]
);

COSC_API cosc_int32 cosc_read_midi(
    const void *buffer,
    cosc_int32 size,
    unsigned char value[4]
);

COSC_API cosc_int32 cosc_write_bundle(
    void *buffer,
    cosc_int32 size,
    cosc_uint64 timetag,
    cosc_int32 psize
);

COSC_API cosc_int32 cosc_read_bundle(
    const void *buffer,
    cosc_int32 size,
    cosc_uint64 *timetag,
    cosc_int32 *psize
);

COSC_API cosc_int32 cosc_write_signature(
    void *buffer,
    cosc_int32 size,
    const char *address,
    cosc_int32 address_n,
    const char *typetag,
    cosc_int32 typetag_n,
    cosc_int32 psize
);

COSC_API cosc_int32 cosc_read_signature(
    const void *buffer,
    cosc_int32 size,
    const char **address,
    cosc_int32 *address_n,
    const char **typetag,
    cosc_int32 *typetag_n,
    cosc_int32 *psize
);

COSC_API cosc_int32 cosc_write_value(
    void *buffer,
    cosc_int32 size,
    char type,
    const union cosc_value *value
);

COSC_API cosc_int32 cosc_read_value(
    const void *buffer,
    cosc_int32 size,
    char type,
    union cosc_value *value
);

COSC_API cosc_int32 cosc_write_values(
    void *buffer,
    cosc_int32 size,
    const char *types,
    cosc_int32 types_n,
    const union cosc_value *values,
    cosc_int32 values_n,
    cosc_int32 *value_count
);

COSC_API cosc_int32 cosc_read_values(
    const void *buffer,
    cosc_int32 size,
    const char *types,
    cosc_int32 types_n,
    union cosc_value *values,
    cosc_int32 values_n,
    cosc_int32 *value_count,
    cosc_int32 exit_early
);

COSC_API cosc_int32 cosc_write_message(
    void *buffer,
    cosc_int32 size,
    const struct cosc_message *message,
    cosc_int32 psize,
    cosc_int32 *value_count
);

COSC_API cosc_int32 cosc_read_message(
    const void *buffer,
    cosc_int32 size,
    struct cosc_message *message,
    cosc_int32 *psize,
    cosc_int32 *value_count,
    cosc_int32 exit_early
);
 
#if !defined(COSC_NOSTDLIB) && !defined(COSC_NODUMP)

COSC_API cosc_int32 cosc_value_dump(
    char *s,
    cosc_int32 n,
    char type,
    const union cosc_value *value
);

COSC_API cosc_int32 cosc_message_dump(
    char *s,
    cosc_int32 n,
    const struct cosc_message *message
);
 
#endif /* !COSC_NOSTDLIB && !COSC_NODUMP */
 
#if !defined(COSC_NOWRITER) || !defined(COSC_NOREADER)

COSC_API cosc_int32 cosc_serial_get_buffer_size(
    const struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_serial_get_size(
    const struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_serial_get_msgtype(
    const struct cosc_serial *serial
);

COSC_API void cosc_serial_reset(
    struct cosc_serial *serial
);
 
#endif /* !COSC_NOWRITER && !COSC_NOREADER */
 
#ifndef COSC_NOWRITER

COSC_API void cosc_writer_setup(
    struct cosc_serial *serial,
    void *buffer,
    cosc_int32 buffer_size,
    struct cosc_level *levels,
    cosc_int32 level_max,
    cosc_uint32 flags
);

COSC_API cosc_int32 cosc_writer_start_bundle(
    struct cosc_serial *serial,
    cosc_uint64 timetag
);

COSC_API cosc_int32 cosc_writer_end_bundle(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_writer_start_message(
    struct cosc_serial *serial,
    const char *address,
    cosc_int32 address_n,
    const char *typetag,
    cosc_int32 typetag_n
);

COSC_API cosc_int32 cosc_writer_end_message(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_writer_start_blob(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_writer_end_blob(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_writer_uint32(
    struct cosc_serial *serial,
    cosc_uint32 value
);

COSC_API cosc_int32 cosc_writer_int32(
    struct cosc_serial *serial,
    cosc_int32 value
);

COSC_API cosc_int32 cosc_writer_float32(
    struct cosc_serial *serial,
    cosc_float32 value
);

COSC_API cosc_int32 cosc_writer_uint64(
    struct cosc_serial *serial,
    cosc_uint64 value
);

COSC_API cosc_int32 cosc_writer_int64(
    struct cosc_serial *serial,
    cosc_int64 value
);

COSC_API cosc_int32 cosc_writer_float64(
    struct cosc_serial *serial,
    cosc_float64 value
);

COSC_API cosc_int32 cosc_writer_string(
    struct cosc_serial *serial,
    const char *value,
    cosc_int32 value_n,
    cosc_int32 *length
);

COSC_API cosc_int32 cosc_writer_blob(
    struct cosc_serial *serial,
    const void *value,
    cosc_int32 value_n
);

COSC_API cosc_int32 cosc_writer_char(
    struct cosc_serial *serial,
    cosc_int32 value
);

COSC_API cosc_int32 cosc_writer_midi(
    struct cosc_serial *serial,
    const unsigned char value[4]
);

COSC_API cosc_int32 cosc_writer_value(
    struct cosc_serial *serial,
    cosc_int32 type,
    const union cosc_value *value
);

COSC_API cosc_int32 cosc_writer_message(
    struct cosc_serial *serial,
    const struct cosc_message *message,
    cosc_int32 *value_count
);

COSC_API cosc_int32 cosc_writer_bytes(
    struct cosc_serial *serial,
    const void *value,
    cosc_int32 value_n
);

COSC_API cosc_int32 cosc_writer_skip(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_writer_repeat(
    struct cosc_serial *serial
);
 
#endif /* !COSC_NOWRITER */
 
#ifndef COSC_NOREADER

COSC_API void cosc_reader_setup(
    struct cosc_serial *serial,
    const void *buffer,
    cosc_int32 buffer_size,
    struct cosc_level *levels,
    cosc_int32 level_max,
    cosc_uint32 flags
);

COSC_API cosc_int32 cosc_reader_peek_bundle(
    struct cosc_serial *serial,
    cosc_uint64 *timetag,
    cosc_int32 *psize
);

COSC_API cosc_int32 cosc_reader_start_bundle(
    struct cosc_serial *serial,
    cosc_uint64 *timetag
);

COSC_API cosc_int32 cosc_reader_end_bundle(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_reader_start_message(
    struct cosc_serial *serial,
    const char **address,
    cosc_int32 *address_n,
    const char **typetag,
    cosc_int32 *typetag_n
);

COSC_API cosc_int32 cosc_reader_end_message(
    struct cosc_serial *serial,
    cosc_int32 exit_early
);

COSC_API cosc_int32 cosc_reader_start_blob(
    struct cosc_serial *serial,
    cosc_int32 *value_size
);

COSC_API cosc_int32 cosc_reader_end_blob(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_reader_uint32(
    struct cosc_serial *serial,
    cosc_uint32 *value
);

COSC_API cosc_int32 cosc_reader_int32(
    struct cosc_serial *serial,
    cosc_int32 *value
);

COSC_API cosc_int32 cosc_reader_float32(
    struct cosc_serial *serial,
    cosc_float32 *value
);

COSC_API cosc_int32 cosc_reader_uint64(
    struct cosc_serial *serial,
    cosc_uint64 *value
);

COSC_API cosc_int32 cosc_reader_int64(
    struct cosc_serial *serial,
    cosc_int64 *value
);

COSC_API cosc_int32 cosc_reader_float64(
    struct cosc_serial *serial,
    cosc_float64 *value
);

COSC_API cosc_int32 cosc_reader_string(
    struct cosc_serial *serial,
    char *value,
    cosc_int32 value_n,
    cosc_int32 *length
);

COSC_API cosc_int32 cosc_reader_blob(
    struct cosc_serial *serial,
    void *value,
    cosc_int32 value_n,
    const void **data,
    cosc_int32 *data_size
);

COSC_API cosc_int32 cosc_reader_char(
    struct cosc_serial *serial,
    cosc_int32 *value
);

COSC_API cosc_int32 cosc_reader_midi(
    struct cosc_serial *serial,
    unsigned char value[4]
);

COSC_API cosc_int32 cosc_reader_value(
    struct cosc_serial *serial,
    cosc_int32 type,
    union cosc_value *value
);

COSC_API cosc_int32 cosc_reader_message(
    struct cosc_serial *serial,
    struct cosc_message *message,
    cosc_int32 *value_count,
    cosc_int32 exit_early
);

COSC_API cosc_int32 cosc_reader_bytes(
    struct cosc_serial *serial,
    void *value,
    cosc_int32 value_n
);

COSC_API cosc_int32 cosc_reader_skip(
    struct cosc_serial *serial
);

COSC_API cosc_int32 cosc_reader_repeat(
    struct cosc_serial *serial
);
 
#endif /* !COSC_NOREADER */
 
#ifdef __cplusplus
}
#endif
 
#endif