summaryrefslogtreecommitdiff
path: root/include/osm
diff options
context:
space:
mode:
Diffstat (limited to 'include/osm')
-rw-r--r--include/osm/device.h37
-rw-r--r--include/osm/types.h109
2 files changed, 146 insertions, 0 deletions
diff --git a/include/osm/device.h b/include/osm/device.h
index edf9c12..f774179 100644
--- a/include/osm/device.h
+++ b/include/osm/device.h
@@ -1,6 +1,8 @@
#ifndef OSM_DEVICE_H
#define OSM_DEVICE_H
+#include <stdint.h>
+
#include <osm/utils.h>
/*
@@ -19,4 +21,39 @@ typedef struct {
Vector inputs, outputs;
} OSMDevice;
+// Device datapoint
+
+/// Raw data (rarely used)
+#define OSM_TYPE_RAW 0 ///< Raw data that a script or extrnal program could process
+
+#define OSM_TYPE_BOOL 1 ///< Boolean type
+#define OSM_TYPE_INT 2 ///< Integer type
+#define OSM_TYPE_FLOAT 3 ///< Floating point type
+#define OSM_TYPE_COLOR 4 ///< Color type
+#define OSM_TYPE_SELECT 5 ///< Selection type
+#define OSM_TYPE_TIME 6 ///< Time type (duration)
+#define OSM_TYPE_DATE 7 ///< Date type (exact date/time)
+
+#define OSM_DDF_INPUT 0b0001 ///< This datapoint can be read
+#define OSM_DDF_OUTPUT 0b0010 ///< This datapoint can be written
+#define OSM_DDF_RANGE 0b0100 ///< This datapoint can be interpreted as two values which create a range
+#define OSM_DDF_RANGED 0b1000 ///< This datapoint must be between a certain range
+
+/// The device datapoint
+typedef struct {
+ uint64_t id; /// Unique id of the datapoint
+ uint8_t *name; /// Name of the datapoint in UTF-8
+ uint8_t type; /// Datatype of datapoint
+ uint8_t flags; /// Datapoint flags
+} OSMDatapoint;
+
+/// Attempt to read a datapoint from a device
+/// returns nonzero error code on failure
+int osm_read_datapoint(OSMDevice *dev, OSMDatapoint *dat, void *in);
+
+/// Attempt to write a datapoint to a device
+/// returns nonzero error code on failure
+int osm_write_datapoint(OSMDevice *dev, OSMDatapoint *dat, void *out);
+
+
#endif
diff --git a/include/osm/types.h b/include/osm/types.h
new file mode 100644
index 0000000..5120098
--- /dev/null
+++ b/include/osm/types.h
@@ -0,0 +1,109 @@
+#ifndef OSM_TYPES_H
+#define OSM_TYPES_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+/*
+ * Defines all types which can be transfered reliably across
+ * a device connection
+ */
+
+// Raw data
+typedef struct {
+ uint32_t length;
+} OSMRaw;
+
+
+
+// Bools
+
+#define OSMTrue 1
+#define OSMFalse 0
+
+/// Represents a bool
+typedef uint8_t OSMBool;
+
+
+
+// Numeric
+
+/// Represents an integer
+typedef int64_t OSMInteger;
+/// Represents a floating point (IEEE 754 64 bit)
+typedef uint64_t OSMFloat;
+
+/// Represents the broken down floating point number
+typedef struct {
+ uint8_t sign;
+ uint16_t mantissa;
+ uint64_t fraction;
+} OSMFloatBreakdown;
+
+/// Break a OSMFloat into it's constituant parts
+OSMFloatBreakdown osm_break_float(OSMFloat f);
+/// Break a native float into constituant parts
+OSMFloatBreakdown osm_break_native_float(double d);
+
+/// Convert an osm float to a native one
+double osm_float_to_native(OSMFloat f);
+/// Convert a native float to an osm one
+OSMFloat osm_native_to_float(double d);
+
+/// Check whether a float is NaN
+bool osm_is_nan(OSMFloat f);
+
+/// Check whether a float is infinity
+/// if positive infinity, returns 1
+/// if negative infinity, returns -1
+/// otherwise returns 0
+uint8_t osm_is_infinity(OSMFloat f);
+
+
+
+// Color
+
+/// Color struct with support for extra channels (up to 255)
+/// each channel has a range from 0-255
+typedef struct {
+ uint8_t
+ r,
+ g,
+ b;
+
+ uint8_t extra;
+ uint8_t *ex;
+ uint8_t **ex_names; /// Extra channel names encoded in UTF-8
+} OSMColor;
+
+/// Output rgb from a color struct
+uint32_t osm_to_rgb(OSMColor color);
+
+/// Output color struct from 24-bit RGB
+OSMColor osm_rgb_to_color(uint8_t r, uint8_t g, uint8_t b);
+
+/// Parse a 32-bit integer as a 24-bit color.
+/// Assumes r, g, and b channels are stores in
+/// the lower 24 bits of the number.
+OSMColor osm_int_to_color(uint32_t c);
+
+/// Deep copy a color struct
+OSMColor osm_color_copy(OSMColor color);
+
+/// Free a color struct
+void osm_color_free(OSMColor color);
+
+
+
+// Selection
+
+typedef struct {
+ /// TODO: Should getting selection options be an async operation?
+} OSMSelect;
+
+
+
+// TODO: Time, others
+
+
+#endif