chiark / gitweb /
More clang-inspired fixes
[disorder] / lib / speaker-protocol.h
CommitLineData
ea410ba1 1/*
2 * This file is part of DisOrder
5aff007d 3 * Copyright (C) 2005, 2007, 2008 Richard Kettlewell
ea410ba1 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
ea410ba1 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
ea410ba1 8 * (at your option) any later version.
e7eb3a27
RK
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
ea410ba1 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
ea410ba1 17 */
fbf86993 18/** @file lib/speaker-protocol.h
ea410ba1 19 * @brief Speaker/server protocol support
20 *
21 * This file defines the protocol by which the main server and the speaker
22 * process communicate.
23 */
24
cf714d85 25#ifndef SPEAKER_PROTOCOL_H
26#define SPEAKER_PROTOCOL_H
ea410ba1 27
929f577e
RK
28#include "byte-order.h"
29
ea410ba1 30/** @brief A message from the main server to the speaker, or vica versa */
31struct speaker_message {
32 /** @brief Message type
33 *
34 * Messges from the main server:
ea410ba1 35 * - @ref SM_PLAY
36 * - @ref SM_PAUSE
37 * - @ref SM_RESUME
38 * - @ref SM_CANCEL
39 * - @ref SM_RELOAD
40 *
41 * Messages from the speaker:
42 * - @ref SM_PAUSED
43 * - @ref SM_FINISHED
44 * - @ref SM_PLAYING
2b2a5fed 45 * - @ref SM_UNKNOWN
2a1c84fb 46 * - @ref SM_ARRIVED
ea410ba1 47 */
48 int type;
49
50 /** @brief Message-specific data */
51 long data;
52
53 /** @brief Track ID (including 0 terminator) */
54 char id[24]; /* ID including terminator */
55};
56
57/* messages from the main DisOrder server */
ea410ba1 58
59/** @brief Play track @c id
60 *
61 * The track must already have been prepared.
62 */
63#define SM_PLAY 1
64
65/** @brief Pause current track */
66#define SM_PAUSE 2
67
68/** @brief Resume current track */
69#define SM_RESUME 3
70
71/** @brief Cancel track @c id */
72#define SM_CANCEL 4
73
74/** @brief Reload configuration */
75#define SM_RELOAD 5
76
77/* messages from the speaker */
78/** @brief Paused track @c id, @c data seconds in
79 *
80 * There is no @c SM_RESUMED, instead @ref SM_PLAYING is sent after the track
81 * starts playing again.
82 */
83#define SM_PAUSED 128
84
85/** @brief Finished playing track @c id */
86#define SM_FINISHED 129
87
2b2a5fed
RK
88/** @brief Never heard of track @c id */
89#define SM_UNKNOWN 130
90
ea410ba1 91/** @brief Currently track @c id, @c data seconds in
92 *
93 * This is sent from time to time while a track is playing.
94 */
95#define SM_PLAYING 131
96
937be4c0
RK
97/** @brief Speaker process is ready
98 *
99 * This is sent once at startup when the speaker has finished its
100 * initialization. */
101#define SM_READY 132
102
819f5988
RK
103/** @brief Cancelled track @c id which wasn't playing */
104#define SM_STILLBORN 133
105
2a1c84fb
RK
106/** @brief A connection for track @c id arrived */
107#define SM_ARRIVED 134
108
84aa9f93
RK
109void speaker_send(int fd, const struct speaker_message *sm);
110/* Send a message. */
ea410ba1 111
84aa9f93
RK
112int speaker_recv(int fd, struct speaker_message *sm);
113/* Receive a message. Return 0 on EOF, +ve if a message is read, -1 on EAGAIN,
114 * terminates on any other error. */
ea410ba1 115
6d2d327c
RK
116/** @brief One chunk in a stream */
117struct stream_header {
937be4c0
RK
118 /** @brief Number of bytes */
119 uint32_t nbytes;
120
6d2d327c
RK
121 /** @brief Frames per second */
122 uint32_t rate;
123
124 /** @brief Samples per frames */
125 uint8_t channels;
126
127 /** @brief Bits per sample */
128 uint8_t bits;
129
130 /** @brief Endianness */
131 uint8_t endian;
6d2d327c
RK
132} attribute((packed));
133
134static inline int formats_equal(const struct stream_header *a,
135 const struct stream_header *b) {
136 return (a->rate == b->rate
137 && a->channels == b->channels
138 && a->bits == b->bits
139 && a->endian == b->endian);
140}
141
cf714d85 142#endif /* SPEAKER_PROTOCOL_H */
ea410ba1 143
144/*
145Local Variables:
146c-basic-offset:2
147comment-column:40
148fill-column:79
149indent-tabs-mode:nil
150End:
151*/