source: roaraudio/include/libroarlight/roardmx.h @ 6001:872d916b8ca0

Last change on this file since 6001:872d916b8ca0 was 6001:872d916b8ca0, checked in by phi, 10 years ago

added some support for CONTROL messages to libroarlight's RoarDMX support

File size: 10.1 KB
Line 
1//roardmx.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2009-2014
5 *
6 *  This file is part of libroar a part of RoarAudio,
7 *  a cross-platform sound system for both, home and professional use.
8 *  See README for details.
9 *
10 *  This file is free software; you can redistribute it and/or modify
11 *  it under the terms of the GNU General Public License version 3
12 *  as published by the Free Software Foundation.
13 *
14 *  libroar is distributed in the hope that it will be useful,
15 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 *  GNU General Public License for more details.
18 *
19 *  You should have received a copy of the GNU General Public License
20 *  along with this software; see the file COPYING.  If not, write to
21 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 *  Boston, MA 02110-1301, USA.
23 *
24 *  NOTE for everyone want's to change something and send patches:
25 *  read README and HACKING! There a addition information on
26 *  the license of this document you need to read before you send
27 *  any patches.
28 *
29 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
30 *  or libpulse*:
31 *  The libs libroaresd, libroararts and libroarpulse link this lib
32 *  and are therefore GPL. Because of this it may be illigal to use
33 *  them with any software that uses libesd, libartsc or libpulse*.
34 */
35
36#ifndef _LIBROARLIGHT_ROARDMX_H_
37#define _LIBROARLIGHT_ROARDMX_H_
38
39#include "libroarlight.h"
40
41#define ROAR_ROARDMX_VERSION        0x00
42
43#define ROAR_ROARDMX_MASK_FLAGS     0xF0
44#define ROAR_ROARDMX_MASK_TYPE      0x0F
45
46#define ROAR_ROARDMX_DATA_LENGTH    ((1<<(sizeof(char)*8))-1) /* 255 */
47
48// we have a offset of one nibble, see ROAR_ROARDMX_MASK_FLAGS
49#define ROAR_ROARDMX_FLAG_PACKED    0x10
50
51#define ROAR_ROARDMX_TYPE_SSET      0x00 /* simple set */
52#define ROAR_ROARDMX_TYPE_IPO1      0x01 /* linear interploation */
53#define ROAR_ROARDMX_TYPE_IPOLIN    ROAR_ROARDMX_TYPE_IPO1
54#define ROAR_ROARDMX_TYPE_IPO4      0x02 /* poly5 interpolation (a*t^4 + b*t^3 + c*t^2 + d*t + e) */
55#define ROAR_ROARDMX_TYPE_INC8S     0x03 /* signed 8 bit increment */
56#define ROAR_ROARDMX_TYPE_RANGESET  0x04 /* like simple set but set ranges of channels */
57#define ROAR_ROARDMX_TYPE_EVENT     0x0E /* used to transmit simple events like step, blackout and stuff */
58#define ROAR_ROARDMX_TYPE_CONTROL   0x0F /* Used to transmit other control information like codec version */
59
60// Events:
61// event types (ETYPE) will be bit or-ed with event.
62#define ROAR_ROARDMX_MASK_EVENT     0x3F
63#define ROAR_ROARDMX_MASK_ETYPE     0xC0
64
65#define ROAR_ROARDMX_ETYPE_BEAT     0x00 /* event happens NOW */
66#define ROAR_ROARDMX_ETYPE_OFF      0x40 /* event ended */
67#define ROAR_ROARDMX_ETYPE_ON       0x80 /* event started */
68#define ROAR_ROARDMX_ETYPE_HOLD     0xC0 /* event is still running, used as keep-alive */
69
70// events: must be in range 0x00 to 0x3F.
71#define ROAR_ROARDMX_EVENT_NONE     0x00 /* can be used as keep-alive or padding */
72#define ROAR_ROARDMX_EVENT_STEP     0x01
73#define ROAR_ROARDMX_EVENT_TAP      0x02
74#define ROAR_ROARDMX_EVENT_BEAT     0x03 /* audio signal generated beat */
75#define ROAR_ROARDMX_EVENT_BLACKOUT 0x04 /* set all light channels to zero */
76#define ROAR_ROARDMX_EVENT_FULLON   0x05 /* set all light channels to full intensity */
77#define ROAR_ROARDMX_EVENT_FLASH    0x06 /* like fullon but can also use strobe. */
78#define ROAR_ROARDMX_EVENT_STROBE   0x07 /* triggers all strobes */
79#define ROAR_ROARDMX_EVENT_STROBEREADY 0x08 /* strobe is ready */
80#define ROAR_ROARDMX_EVENT_STROBELOAD  0x09 /* strobe is loading */
81#define ROAR_ROARDMX_EVENT_FOG      0x0A /* triggers all fog machines */
82#define ROAR_ROARDMX_EVENT_FOGREADY 0x0B /* Fog machine is ready */
83#define ROAR_ROARDMX_EVENT_FOGHEAT  0x0C /* Fog machine is heating up */
84#define ROAR_ROARDMX_EVENT_USER0    0x30 /* User defined event #0  */
85#define ROAR_ROARDMX_EVENT_USER1    0x31 /* User defined event #1  */
86#define ROAR_ROARDMX_EVENT_USER2    0x32 /* User defined event #2  */
87#define ROAR_ROARDMX_EVENT_USER3    0x33 /* User defined event #3  */
88#define ROAR_ROARDMX_EVENT_USER4    0x34 /* User defined event #4  */
89#define ROAR_ROARDMX_EVENT_USER5    0x35 /* User defined event #5  */
90#define ROAR_ROARDMX_EVENT_USER6    0x36 /* User defined event #6  */
91#define ROAR_ROARDMX_EVENT_USER7    0x37 /* User defined event #7  */
92#define ROAR_ROARDMX_EVENT_USER8    0x38 /* User defined event #8  */
93#define ROAR_ROARDMX_EVENT_USER9    0x39 /* User defined event #9  */
94#define ROAR_ROARDMX_EVENT_USER10   0x3A /* User defined event #10 */
95#define ROAR_ROARDMX_EVENT_USER11   0x3B /* User defined event #11 */
96#define ROAR_ROARDMX_EVENT_USER12   0x3C /* User defined event #12 */
97#define ROAR_ROARDMX_EVENT_USER13   0x3D /* User defined event #13 */
98#define ROAR_ROARDMX_EVENT_USER14   0x3E /* User defined event #14 */
99#define ROAR_ROARDMX_EVENT_USER15   0x3F /* User defined event #15 */
100
101/* subcommands for ROAR_ROARDMX_TYPE_CONTROL: */
102#define ROAR_ROARDMX_CTL_VERSION    0x00 /* Version of Codec */
103#define ROAR_ROARDMX_CTL_SYNC       0x01 /* Sync state */
104
105/* Flags for ROAR_ROARDMX_CTL_SYNC: */
106#define ROAR_ROARDMX_SYNC_DIRTY     0x01 /* global state is not sync, some more data needs to be send first */
107#define ROAR_ROARDMX_SYNC_CLEAN     0x02 /* global state is sync */
108#define ROAR_ROARDMX_SYNC_SOF       0x03 /* start of frame */
109#define ROAR_ROARDMX_SYNC_EOF       0x04 /* end of frame */
110#define ROAR_ROARDMX_SYNC_CLOCK     0x80 /* clock tick */
111
112// Data format on the wire:
113/*
114 * All packets consist of a header and a body.
115 * The header has the size of 3 Bytes:
116 * 0) version. Must be ROAR_ROARDMX_VERSION.
117 * 1) packet type and flags.
118 * 2) length of body in bytes.
119 *
120 * the type-flags byte consists of the packet type in the lower nibble and
121 * the flags in the upper nibble.
122 *
123 * the header is followd by a body of zero to 255 bytes length.
124 * the content of the body depends on the used type of packet.
125 *
126 * SSET: (simple set) Sets channels to values.
127 *  The body consists of {channel, value}-pairs.
128 *  Every entry is 3 byte: hi byte of channel, low byte of channel, value.
129 *
130 * IPO1: not implemented.
131 * IPO4: not implemented.
132 * INC8S: not implemented.
133 * RANGESET: Sets ranges of channels.
134 *  The body consists of {start, stop, value}-trippels.
135 *  Every entry is 5 byte: hi byte of start channel, low byte of start channel,
136 *  hi byte of end channel, low byte of end channel and value.
137 *
138 * EVENT: transmit simple yet abstract events.
139 * The body is an array of bytes. Each byte represents one event.
140 * Each event has the upper two bits set to the meta type of the event
141 * (beat, on, off, hold) and the lower 6 bits to the type of te event.
142 *
143 * CONTROL: transmit other control information.
144 * The body consists of a version byte followed by a command byte.
145 * The version byte is always zero by this standard.
146 * The command byte is one of ROAR_ROARDMX_CTL_*
147 * The rest of body depends on both the version and command byte.
148 * For command=VERSION packets the rest of the body is a single byte with the value
149 * of zero as of this standard.
150 * For command=SYNC packets the rest of the body is a single byte which is a bitarray
151 * for flags defined above as ROAR_ROARDMX_SYNC_*.
152 */
153
154struct roar_roardmx_message {
155 unsigned char version;
156 unsigned char flags;
157 unsigned char type;
158 size_t        length;
159 unsigned char data[3 /* header */ + ROAR_ROARDMX_DATA_LENGTH /* data */];
160};
161
162// database access:
163int roar_roardmx_str2event(const char * event);
164const char * roar_roardmx_event2str(const int event);
165
166// generic things:
167int roar_roardmx_message_new (struct roar_roardmx_message * mes);
168
169// low level:
170//int roar_roardmx_message_set_flag(struct roar_roardmx_message * mes, unsigned char   flag);
171//int roar_roardmx_message_set_len (struct roar_roardmx_message * mes, size_t          type);
172//int roar_roardmx_message_get_data(struct roar_roardmx_message * mes, unsigned char ** data);
173
174// mdium level:
175int roar_roardmx_message_set_type(struct roar_roardmx_message * mes, unsigned char   type);
176int roar_roardmx_message_get_flag(struct roar_roardmx_message * mes, unsigned char * flag);
177int roar_roardmx_message_get_type(struct roar_roardmx_message * mes, unsigned char * type);
178int roar_roardmx_message_get_len (struct roar_roardmx_message * mes, size_t        * length);
179
180
181// IO:
182int roar_roardmx_message_send(struct roar_roardmx_message * mes, struct roar_vio_calls * vio);
183int roar_roardmx_message_recv(struct roar_roardmx_message * mes, struct roar_vio_calls * vio);
184
185// Data/high level:
186// * *:
187int roar_roardmx_message_numchannels(struct roar_roardmx_message * mes); // also works for rangesets
188int roar_roardmx_message_add_chanval(struct roar_roardmx_message * mes, uint16_t   channel, unsigned char   val);
189int roar_roardmx_message_get_chanval(struct roar_roardmx_message * mes, uint16_t * channel, unsigned char * val, int index);
190
191// * SSET:
192int roar_roardmx_message_new_sset   (struct roar_roardmx_message * mes);
193
194// * IPO1:
195// Not yet supported.
196// * IPO4:
197// Not yet supported.
198// * INC8S:
199// Not yet supported.
200// * RANGESET:
201int roar_roardmx_message_new_rangeset(struct roar_roardmx_message * mes);
202int roar_roardmx_message_add_rangeval(struct roar_roardmx_message * mes, uint16_t   start, uint16_t   end, unsigned char   val);
203int roar_roardmx_message_get_rangeval(struct roar_roardmx_message * mes, uint16_t * start, uint16_t * end, unsigned char * val, int index);
204
205// * EVENT:
206int roar_roardmx_message_new_event(struct roar_roardmx_message * mes);
207int roar_roardmx_message_add_events(struct roar_roardmx_message * mes, const uint8_t * events, size_t len);
208#define roar_roardmx_message_add_event(mes,event) roar_roardmx_message_add_events((mes), &(uint8_t){(event)}, 1)
209int roar_roardmx_message_get_events(struct roar_roardmx_message * mes, const uint8_t ** events, size_t * len);
210
211// * CONTROL:
212int roar_roardmx_message_new_version(struct roar_roardmx_message * mes, uint8_t version);
213int roar_roardmx_message_new_sync(struct roar_roardmx_message * mes, uint8_t flags);
214int roar_roardmx_message_get_subcommand(struct roar_roardmx_message * mes);
215int roar_roardmx_message_get_ctl_version(struct roar_roardmx_message * mes);
216int roar_roardmx_message_get_ctl_flags(struct roar_roardmx_message * mes);
217
218#endif
219
220//ll
Note: See TracBrowser for help on using the repository browser.