Commit | Line | Data |
---|---|---|
cf714d85 | 1 | /* |
2 | * This file is part of DisOrder | |
3 | * Copyright (C) 2005, 2006, 2007 Richard Kettlewell | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation; either version 2 of the License, or | |
8 | * (at your option) any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but | |
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with this program; if not, write to the Free Software | |
17 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | |
18 | * USA | |
19 | */ | |
20 | /** @file server/speaker.h | |
21 | * @brief Speaker process | |
22 | */ | |
23 | #ifndef SPEAKER_H | |
24 | #define SPEAKER_H | |
25 | ||
26 | #ifdef WORDS_BIGENDIAN | |
27 | # define MACHINE_AO_FMT AO_FMT_BIG | |
28 | #else | |
29 | # define MACHINE_AO_FMT AO_FMT_LITTLE | |
30 | #endif | |
31 | ||
5a7c42a8 | 32 | /** @brief Minimum number of frames to try to play at once |
cf714d85 | 33 | * |
5a7c42a8 | 34 | * The main loop will only attempt to play any audio when this many |
35 | * frames are available (or the current track has reached the end). | |
36 | * The actual number of frames it attempts to play will often be | |
37 | * larger than this (up to three times). | |
cf714d85 | 38 | * |
39 | * For ALSA we request a buffer of three times this size and set the low | |
40 | * watermark to this amount. The goal is then to keep between 1 and 3 times | |
41 | * this many frames in play. | |
42 | * | |
5a7c42a8 | 43 | * For other we attempt to play up to three times this many frames per |
cf714d85 | 44 | * shot. In practice we will often only send much less than this. |
45 | */ | |
46 | #define FRAMES 4096 | |
47 | ||
48 | /** @brief Bytes to send per network packet | |
a684c959 RK |
49 | * |
50 | * This is the maximum number of bytes we pass to write(2); to determine actual | |
51 | * packet sizes, add a UDP header and an IP header (and a link layer header if | |
52 | * it's the link layer size you care about). | |
cf714d85 | 53 | * |
54 | * Don't make this too big or arithmetic will start to overflow. | |
55 | */ | |
a684c959 | 56 | #define NETWORK_BYTES (1500-8/*UDP*/-40/*IP*/-8/*conservatism*/) |
cf714d85 | 57 | |
58 | /** @brief Maximum RTP playahead (ms) */ | |
936cf6f2 | 59 | #define RTP_AHEAD_MS 100 |
cf714d85 | 60 | |
61 | /** @brief Maximum number of FDs to poll for */ | |
62 | #define NFDS 256 | |
63 | ||
64 | /** @brief Track structure | |
65 | * | |
66 | * Known tracks are kept in a linked list. Usually there will be at most two | |
67 | * of these but rearranging the queue can cause there to be more. | |
68 | */ | |
69 | struct track { | |
6d2d327c RK |
70 | /** @brief Next track */ |
71 | struct track *next; | |
72 | ||
73 | /** @brief Input file descriptor */ | |
cf714d85 | 74 | int fd; /* input FD */ |
6d2d327c RK |
75 | |
76 | /** @brief Track ID */ | |
77 | char id[24]; | |
78 | ||
79 | /** @brief Start position of data in buffer */ | |
80 | size_t start; | |
81 | ||
82 | /** @brief Number of bytes of data in buffer */ | |
83 | size_t used; | |
84 | ||
85 | /** @brief Set @c fd is at EOF */ | |
86 | int eof; | |
87 | ||
88 | /** @brief Total number of frames played */ | |
89 | unsigned long long played; | |
90 | ||
91 | /** @brief Slot in @ref fds */ | |
92 | int slot; | |
93 | ||
f5a03f58 RK |
94 | /** @brief Set when playable |
95 | * | |
96 | * A track becomes playable whenever it fills its buffer or reaches EOF; it | |
97 | * stops being playable when it entirely empties its buffer. Tracks start | |
98 | * out life not playable. | |
99 | */ | |
100 | int playable; | |
101 | ||
6d2d327c RK |
102 | /** @brief Input buffer |
103 | * | |
104 | * 1Mbyte is enough for nearly 6s of 44100Hz 16-bit stereo | |
105 | */ | |
106 | char buffer[1048576]; | |
cf714d85 | 107 | }; |
108 | ||
109 | /** @brief Structure of a backend */ | |
110 | struct speaker_backend { | |
111 | /** @brief Which backend this is | |
112 | * | |
113 | * @c -1 terminates the list. | |
114 | */ | |
115 | int backend; | |
116 | ||
117 | /** @brief Flags | |
118 | * | |
6d2d327c | 119 | * This field is currently not used and must be 0. |
cf714d85 | 120 | */ |
121 | unsigned flags; | |
cf714d85 | 122 | |
123 | /** @brief Initialization | |
124 | * | |
125 | * Called once at startup. This is responsible for one-time setup | |
126 | * operations, for instance opening a network socket to transmit to. | |
127 | * | |
128 | * When writing to a native sound API this might @b not imply opening the | |
129 | * native sound device - that might be done by @c activate below. | |
130 | */ | |
131 | void (*init)(void); | |
132 | ||
133 | /** @brief Activation | |
134 | * @return 0 on success, non-0 on error | |
135 | * | |
136 | * Called to activate the output device. | |
137 | * | |
5a7c42a8 | 138 | * On input @ref device_state may be anything. If it is @ref |
139 | * device_open then the device is already open but might be using | |
140 | * the wrong sample format. The device should be reconfigured to | |
141 | * use the right sample format. | |
142 | * | |
143 | * If it is @ref device_error then a retry is underway and an | |
144 | * attempt to recover or re-open the device (with the right sample | |
145 | * format) should be made. | |
146 | * | |
147 | * If it is @ref device_closed then the device should be opened with | |
148 | * the right sample format. | |
149 | * | |
717ba987 RK |
150 | * Some devices are effectively always open and have no error state, in which |
151 | * case this callback can be NULL. Note that @ref device_state still | |
152 | * switches between @ref device_open and @ref device_closed in this case. | |
cf714d85 | 153 | */ |
5a7c42a8 | 154 | void (*activate)(void); |
cf714d85 | 155 | |
156 | /** @brief Play sound | |
157 | * @param frames Number of frames to play | |
158 | * @return Number of frames actually played | |
5a7c42a8 | 159 | * |
160 | * If an error occurs (and it is not immediately recovered) this | |
161 | * should set @ref device_state to @ref device_error. | |
cf714d85 | 162 | */ |
163 | size_t (*play)(size_t frames); | |
164 | ||
165 | /** @brief Deactivation | |
166 | * | |
5a7c42a8 | 167 | * Called to deactivate the sound device. This is the inverse of @c |
168 | * activate above. | |
169 | * | |
170 | * For sound devices that are open all the time and have no error | |
171 | * state, this callback can be NULL. Note that @ref device_state | |
0e4472a0 | 172 | * still switches between @ref device_open and @ref device_closed in |
5a7c42a8 | 173 | * this case. |
cf714d85 | 174 | */ |
175 | void (*deactivate)(void); | |
176 | ||
177 | /** @brief Called before poll() | |
e84fb5f0 | 178 | * @param timeoutp Pointer to timeout |
cf714d85 | 179 | * |
e84fb5f0 RK |
180 | * Called before the call to poll(). |
181 | * | |
182 | * If desirable, should call addfd() to update the FD array and stash the | |
183 | * slot number somewhere safe. This will only be called if @ref device_state | |
184 | * is @ref device_open. | |
185 | * | |
186 | * @p timeoutp points to the poll timeout value in milliseconds. It may be | |
187 | * reduced, but never increased. | |
cf714d85 | 188 | */ |
e84fb5f0 | 189 | void (*beforepoll)(int *timeoutp); |
cf714d85 | 190 | |
191 | /** @brief Called after poll() | |
5a7c42a8 | 192 | * @return 1 if output device ready for play, 0 otherwise |
cf714d85 | 193 | * |
5a7c42a8 | 194 | * Called after the call to poll(). This will only be called if |
195 | * @ref device_state = @ref device_open. | |
cf714d85 | 196 | * |
5a7c42a8 | 197 | * The return value should be 1 if the device was ready to play, or |
198 | * 0 if it was not. | |
cf714d85 | 199 | */ |
5a7c42a8 | 200 | int (*ready)(void); |
cf714d85 | 201 | }; |
202 | ||
5a7c42a8 | 203 | /** @brief Possible device states */ |
204 | enum device_states { | |
205 | /** @brief The device is closed */ | |
206 | device_closed, | |
207 | ||
208 | /** @brief The device is open and ready to receive sound | |
209 | * | |
210 | * The current device sample format is potentially part of this state. | |
211 | */ | |
212 | device_open, | |
213 | ||
214 | /** @brief An error has occurred on the device | |
215 | * | |
216 | * This state is used to ensure that a small interval is left | |
217 | * between retrying the device. If errors just set @ref | |
218 | * device_closed then the main loop would busy-wait on broken output | |
219 | * devices. | |
220 | * | |
221 | * The current device sample format is potentially part of this state. | |
222 | */ | |
223 | device_error | |
224 | }; | |
cf714d85 | 225 | |
5a7c42a8 | 226 | extern enum device_states device_state; |
5a7c42a8 | 227 | extern struct track *tracks; |
cf714d85 | 228 | extern struct track *playing; |
229 | ||
1c3f1e73 | 230 | extern const struct speaker_backend network_backend; |
231 | extern const struct speaker_backend alsa_backend; | |
232 | extern const struct speaker_backend command_backend; | |
937be4c0 | 233 | extern const struct speaker_backend coreaudio_backend; |
e99d42b1 | 234 | extern const struct speaker_backend oss_backend; |
1c3f1e73 | 235 | |
236 | extern struct pollfd fds[NFDS]; | |
237 | extern int fdno; | |
6d2d327c | 238 | extern size_t bpf; |
1c3f1e73 | 239 | extern int idled; |
240 | ||
241 | int addfd(int fd, int events); | |
1c3f1e73 | 242 | void abandon(void); |
243 | ||
cf714d85 | 244 | #endif /* SPEAKER_H */ |
245 | ||
246 | /* | |
247 | Local Variables: | |
248 | c-basic-offset:2 | |
249 | comment-column:40 | |
250 | fill-column:79 | |
251 | indent-tabs-mode:nil | |
252 | End: | |
253 | */ |