o2lite.h

// o2lite.h -- header for o2lite library
//
// Roger B. Dannenberg
// July 2020
 
// Discovery options:
//     o2discovery -- o2's original built-in protocol (default is false)
//         broadcast -- use broadcast to speed things up (default is true)
//     zeroconf -- use ZeroConf for discovery (default is true)
//     clocksync -- o2lite should synchronize with host (can be used with
//         either o2discovery or zeroconf) (default is true)
// Note that macros are "true" if defined, "false" if undefined, and most
//     are inverted, e.g. O2_NO_O2DISCOVERY rather than
//     O2_O2DISCOVERY, because most options are for disabling features;
//     thus, most macros are undefined.
// Here are the macros with their default values:
//     O2_NO_O2DISCOVERY -- O2 is not using built-in discovery; (defined)
//     O2_NO_ZEROCONF -- O2 is not using ZeroConf for discovery; (undefined)
//     O2L_NO_BROADCAST -- O2lite does not broadcast to speed up discovery
//         (undefined). This has no effect if O2_NO_O2DISCOVERY, which is
//         defined by default. The ZeroConf protocol ALWAYS uses broadcast
//         (even if O2L_NO_BROADCAST); it's internal to ZeroConf.
//     O2L_NO_CLOCKSYNC -- O2lite does not synchronize with host (undefined)
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
// NOTE: more includes below after O2_MALLOC is defined
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define O2L_VERSION 0x020000
 
// you can enable/disable O2LDB printing using -DO2LDEBUG=1 or =0 
#if (!defined(O2LDEBUG))
#ifndef NDEBUG
// otherwise default is to enable in debug versions
#define O2LDEBUG 1
#else
#define O2LDEBUG 0
#endif
#endif
 
#define O2LDB if (O2LDEBUG)
 
#define O2LDBV if (O2LDEBUG && verbose)
 
#if defined(O2_NO_O2DISCOVERY) && !defined(O2L_NO_BROADCAST)
#define O2L_NO_BROADCAST 1
#endif
#if defined(O2_NO_O2DISCOVERY) && defined(O2_NO_ZEROCONF)
#error O2_NO_O2DISCOVERY and O2_NO_ZEROCONF are both defined - no discovery
#endif
 
// default is ZEROCONF, so if necessary, disable O2_NO_O2DISCOVERY:
#if !defined(O2_NO_O2DISCOVERY) && !defined(O2_NO_ZEROCONF)
#define O2_NO_O2DISCOVERY
#if !defined(O2L_NO_BROADCAST)
#define O2L_NO_BROADCAST
#endif
#endif
 
#define O2_MALLOC malloc
#define O2_CALLOC calloc
#define O2_FREE free
 
#include "o2base.h"
#include "hostip.h"
 
#define MAX_MSG_LEN 256
#define PORT_MAX 16
 
#define O2L_SUCCESS 0
 
#define O2L_FAIL -1
 
#define O2L_ALREADY_RUNNING -5
 
typedef float o2l_time; // could be double, but this gives 1ms accuracy
                        // for 2.3 hours, or 10ms accuracy for 23 hours
 
#define O2_UDP_FLAG 0
#define O2_TCP_FLAG 1
 
typedef struct o2l_msg {
    int32_t length; // length of flags, timestamp, address, and the rest
    int32_t misc;   // flags and ttl (see O2msg_data)
    double timestamp; // regardless of o2l_time, this is O2time = double
    char address[4];
} o2l_msg, *o2l_msg_ptr;
 
typedef void (*o2l_handler)(o2l_msg_ptr msg, const char *types,
                            void *data, void *info);
 
extern int verbose;
 
extern o2l_time o2l_local_now;
 
#ifdef ESP32
void button_poll();
#endif
 
void o2l_send_start(const char *address, o2l_time time,
                    const char *types, bool tcp);
 
void o2l_send();
 
void o2l_method_new(const char *path, const char *typespec,
                    bool full, o2l_handler h, void *info);
 
o2l_time o2l_local_time();
 
o2l_time o2l_time_get();
 
void o2l_poll();
 
#if ESP32
void connect_to_wifi(const char *hostname, const char *ssid, const char *pwd);
#endif
 
 
int o2l_initialize(const char *ensemble);
 
int o2l_finish();
 
void o2l_add_string(const char *s);
 
void o2l_add_time(double time);
 
#define o2l_add_double(x) o2l_add_time(x)
 
void o2l_add_float(float x);
 
#define o2l_add_int(i) o2l_add_int32(i)
 
void o2l_add_int32(int32_t i);
 
bool o2l_get_error();
 
double o2l_get_timestamp();
 
double o2l_get_time();
 
#define o2l_get_double() o2l_get_time()
 
float o2l_get_float();
 
int32_t o2l_get_int32();
 
#define o2l_get_int(i) o2l_get_int32(i)
 
char *o2l_get_string();
 
void o2l_set_services(const char *services);
 
extern char o2l_remote_ip_port[16];
 
extern int o2l_bridge_id;
 
// define IS_BIG_ENDIAN, IS_LITTLE_ENDIAN, and swap64(i),
// swap32(i), and swap16(i)
#if WIN32
#elif ESP32
// LITTLE_ENDIAN, BYTE_ORDER are defined already
#define IS_BIG_ENDIAN (BYTE_ORDER != LITTLE_ENDIAN)
// WIN32 requires predefinition of IS_BIG_ENDIAN=1 or IS_BIG_ENDIAN=0
#else
 #ifdef __APPLE__
  // OS X endian.h is in MacOSX10.8.sdk/usr/include/machine/endian.h:
  #include "machine/endian.h" 
  #define LITTLE_ENDIAN __DARWIN_LITTLE_ENDIAN
 #else
  #include <endian.h>
  #define LITTLE_ENDIAN __LITTLE_ENDIAN
  #define BYTE_ORDER __BYTE_ORDER
 #endif
 #define IS_BIG_ENDIAN (BYTE_ORDER != LITTLE_ENDIAN)
#endif
#define IS_LITTLE_ENDIAN (!(IS_BIG_ENDIAN))
#if IS_LITTLE_ENDIAN
#define o2lswap16(i) ((((i) >> 8) & 0xff) | (((i) & 0xff) << 8))
#define o2lswap32(i) ((((i) >> 24) & 0xff) | (((i) & 0xff0000) >> 8) | \
                   (((i) & 0xff00) << 8) | (((i) & 0xff) << 24))
#define o2lswap64(i) ((((uint64_t) o2lswap32(i)) << 32) | o2lswap32((i) >> 32))
#else
#define o2lswap16(i) (i)
#define o2lswap32(i) (i)
#define o2lswap64(i) (i)
#endif
 
 
/************************************************************/
/****************** Discovery API ***************************/
/************************************************************/
 
#ifdef WIN32
#include <winsock2.h>
#else
#include <sys/select.h>
#endif
 
// There are about 4 different discovery implementations, even for O2lite.
// To avoid massive amounts of conditional compilation to support each
// protocol, the implementations are separated into multiple files:
//     o2liteavahi.c -- Avahi (linux only)
//     o2litebonjour.c -- Avahi (Apple, Windows)
//     o2liteo2disc.c -- Apple, Windows, Linux o2 discovery (non-standard)
// All files use conditional compilation at the top level so they may be
// compiled and linked together, but you only need to link with one, e.g.
// o2liteavahi.c for linux, o2litebonjour.c for Apple and Windows.
//
// Each file implements these functions which are called from o2lite.c:
 
// o2ldisc_init() -- called in o2l_initialize() for
//     implementation-specific actions
int o2ldisc_init(const char *ensemble);
 
// o2ldisc_poll() -- called before select(), which polls sockets. Here, you
//     can add_socket() to add to the read_set passed to select or poll for
//     timeouts.
void o2ldisc_poll();
 
// o2ldisc_events() -- called to check for incoming messages or socket errors
void o2ldisc_events(fd_set *readset);
 
/**********************************************************************/
/* Internal symbols declared for use by Discovery API Implementations */
/**********************************************************************/
#ifndef WIN32
#define INVALID_SOCKET -1
#define SOCKET_ERROR -1
typedef int SOCKET;  // we use SOCKET to denote the type of a socket
#endif
 
extern SOCKET tcp_sock;
extern const char *o2l_ensemble;
extern struct sockaddr_in udp_server_sa;
extern int udp_recv_port;
extern SOCKET udp_recv_sock;
 
bool o2l_is_valid_proc_name(const char *name, int port,
                            char *internal_ip, int *udp_port);
 
int o2l_parse_version(const char *vers, int vers_len);
 
int o2l_address_init(struct sockaddr_in *sa, const char *ip, int port_num,
                     bool tcp);
 
void o2l_network_connect(const char *ip, int port);
 
void o2l_add_socket(SOCKET s);
 
int o2l_bind_recv_socket(SOCKET sock, int *port);
 
 
#ifdef __cplusplus
}
#endif