source: roaraudio/include/libroarlight/roardmx.h @ 5962:1f27cef8dbfa

Last change on this file since 5962:1f27cef8dbfa was 5962:1f27cef8dbfa, checked in by phi, 8 years ago

added some docs about the inner structure of the packets

File size: 7.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
85// Data format on the wire:
86/*
87 * All packets consist of a header and a body.
88 * The header has the size of 3 Bytes:
89 * 0) version. Must be ROAR_ROARDMX_VERSION.
90 * 1) packet type and flags.
91 * 2) length of body in bytes.
92 *
93 * the type-flags byte consists of the packet type in the lower nibble and
94 * the flags in the upper nibble.
95 *
96 * the header is followd by a body of zero to 255 bytes length.
97 * the content of the body depends on the used type of packet.
98 *
99 * SSET: (simple set) Sets channels to values.
100 *  The body consists of {channel, value}-pairs.
101 *  every entry is 3 byte: hi byte of channel, low byte of channel, value.
102 *
103 * IPO1: not implemented.
104 * IPO4: not implemented.
105 * INC8S: not implemented.
106 * RANGESET: not implemented.
107 * EVENT: transmit simple yet abstract events.
108 * The body is an array of bytes. Each byte represents one event.
109 * Each event has the upper two bits set to the meta type of the event
110 * (beat, on, off, hold) and the lower 6 bits to the type of te event.
111 *
112 * CONTROL: not implemented.
113 */
114
115struct roar_roardmx_message {
116 unsigned char version;
117 unsigned char flags;
118 unsigned char type;
119 size_t        length;
120 unsigned char data[3 /* header */ + ROAR_ROARDMX_DATA_LENGTH /* data */];
121};
122
123// database access:
124int roar_roardmx_str2event(const char * event);
125const char * roar_roardmx_event2str(const int event);
126
127// generic things:
128int roar_roardmx_message_new (struct roar_roardmx_message * mes);
129
130// low level:
131//int roar_roardmx_message_set_flag(struct roar_roardmx_message * mes, unsigned char   flag);
132//int roar_roardmx_message_set_len (struct roar_roardmx_message * mes, size_t          type);
133//int roar_roardmx_message_get_data(struct roar_roardmx_message * mes, unsigned char ** data);
134
135// mdium level:
136int roar_roardmx_message_set_type(struct roar_roardmx_message * mes, unsigned char   type);
137int roar_roardmx_message_get_flag(struct roar_roardmx_message * mes, unsigned char * flag);
138int roar_roardmx_message_get_type(struct roar_roardmx_message * mes, unsigned char * type);
139int roar_roardmx_message_get_len (struct roar_roardmx_message * mes, size_t        * length);
140
141
142// IO:
143int roar_roardmx_message_send(struct roar_roardmx_message * mes, struct roar_vio_calls * vio);
144int roar_roardmx_message_recv(struct roar_roardmx_message * mes, struct roar_vio_calls * vio);
145
146// Data/high level:
147// * *:
148int roar_roardmx_message_numchannels(struct roar_roardmx_message * mes);
149int roar_roardmx_message_add_chanval(struct roar_roardmx_message * mes, uint16_t   channel, unsigned char   val);
150int roar_roardmx_message_get_chanval(struct roar_roardmx_message * mes, uint16_t * channel, unsigned char * val, int index);
151
152// * SSET:
153int roar_roardmx_message_new_sset   (struct roar_roardmx_message * mes);
154
155// * IPO1:
156// Not yet supported.
157// * IPO4:
158// Not yet supported.
159// * INC8S:
160// Not yet supported.
161// * RANGESET:
162// Not yet supported.
163// * EVENT:
164int roar_roardmx_message_new_event(struct roar_roardmx_message * mes);
165int roar_roardmx_message_add_events(struct roar_roardmx_message * mes, const uint8_t * events, size_t len);
166#define roar_roardmx_message_add_event(mes,event) roar_roardmx_message_add_events((mes), &(uint8_t){(event)}, 1)
167int roar_roardmx_message_get_events(struct roar_roardmx_message * mes, const uint8_t ** events, size_t * len);
168
169// * CONTROL:
170// Not yet supported.
171
172#endif
173
174//ll
Note: See TracBrowser for help on using the repository browser.