1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file para.h global paraslash definitions */
12 #include <time.h> /* time(), localtime() */
25 #include "gcc-compat.h"
27 /** used in various contexts */
30 /** Compute the minimum of \a x and \a y. */
31 #define PARA_MIN(x, y) ({ \
32 typeof(x) _min1 = (x); \
33 typeof(y) _min2 = (y); \
34 (void) (&_min1 == &_min2); \
35 _min1 < _min2 ? _min1 : _min2; })
37 /** Compute the maximum of \a x and \a y. */
38 #define PARA_MAX(x, y) ({ \
39 typeof(x) _max1 = (x); \
40 typeof(y) _max2 = (y); \
41 (void) (&_max1 == &_max2); \
42 _max1 < _max2 ? _max2 : _max1; })
44 /** Compute the absolute value of \a x. */
45 #define PARA_ABS(x) ({ \
49 extern __printf_2_3 void (*para_log)(int, const char*, ...);
51 * Define a standard log function that always writes to stderr.
53 * \param funcname The name of the function to be defined.
55 * \param loglevel_barrier If the loglevel of the current message
56 * is less than that, the message is going to be ignored.
59 #define DEFINE_STDERR_LOGGER(funcname, loglevel_barrier) \
60 static __printf_2_3 void funcname(int ll, const char* fmt,...) \
63 if (ll < loglevel_barrier) \
65 va_start(argp, fmt); \
66 vfprintf(stderr, fmt, argp); \
70 * Define the standard log function and activate it.
72 * \param loglevel_barrier See \ref DEFINE_STDERR_LOGGER.
74 #define INIT_STDERR_LOGGING(loglevel_barrier) \
75 DEFINE_STDERR_LOGGER(stderr_log, loglevel_barrier); \
76 __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
78 /** Sent by para_client to initiate the authentication procedure. */
79 #define AUTH_REQUEST_MSG "auth rsa "
82 int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds);
85 int tv_diff(const struct timeval *b, const struct timeval *a,
86 struct timeval *diff);
87 long unsigned tv2ms(const struct timeval *tv);
88 void tv_add(const struct timeval *a, const struct timeval *b,
90 void tv_scale(const unsigned long mult, const struct timeval *tv,
91 struct timeval *result);
92 void tv_divide(const unsigned long divisor, const struct timeval *tv,
93 struct timeval *result);
94 int tv_convex_combination(const long a, const struct timeval *tv1,
95 const long b, const struct timeval *tv2,
96 struct timeval *result);
97 void ms2tv(long unsigned n, struct timeval *tv);
98 void compute_chunk_time(long unsigned chunk_num,
99 struct timeval *chunk_tv, struct timeval *stream_start,
100 struct timeval *result);
101 struct timeval *clock_get_realtime(struct timeval *tv);
104 * Return a random non-negative integer in an interval.
106 * \param max Determines maximal possible return value.
108 * \return An integer between zero and \p max - 1, inclusively.
110 _static_inline_ long int para_random(unsigned max)
112 return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
116 * Simple sanity check for I/O vectors.
118 * \param iov Pointer to the I/O vector to check.
120 * \return True if \a iov points to a non-empty buffer.
122 _static_inline_ bool iov_valid(const struct iovec *iov)
124 return iov && iov->iov_len > 0 && iov->iov_base;
127 /** Round up x to next multiple of y. */
128 #define ROUND_UP(x, y) ({ \
129 const typeof(y) _divisor = y; \
130 ((x) + _divisor - 1) / _divisor * _divisor; })
132 /** Round down x to multiple of y. */
133 #define ROUND_DOWN(x, y) ({ \
134 const typeof(y) _divisor = y; \
135 (x) / _divisor * _divisor; })
137 /** Divide and round up to next integer. */
138 #define DIV_ROUND_UP(x, y) ({ \
139 typeof(y) _divisor = y; \
140 ((x) + _divisor - 1) / _divisor; })
143 * Assert a build-time dependency, as an expression.
145 * \param cond The compile-time condition which must be true.
147 * Compilation will fail if the condition isn't true, or can't be evaluated by
148 * the compiler. This can be used in an expression: its value is "0".
152 #define EXPR_BUILD_ASSERT(cond) (sizeof(char [1 - 2 * !(cond)]) - 1)
154 /** &a[0] degrades to a pointer: a different type from an array */
155 #define _array_size_chk(arr) EXPR_BUILD_ASSERT(\
156 !__builtin_types_compatible_p(typeof(arr), typeof(&(arr)[0])))
157 /** Get the size of an array */
158 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + _array_size_chk(arr))
161 * Wrapper for isspace.
165 * The values should be cast to an unsigned char first, then to int.
166 * Why? Because the isdigit (as do all other is/to functions/macros)
167 * expect a number from 0 upto and including 255 as their (int) argument.
168 * Because char is signed on most systems, casting it to int immediately
169 * gives the functions an argument between -128 and 127 (inclusive),
170 * which they will use as an array index, and which will thus fail
171 * horribly for characters which have their most significant bit set.
173 #define para_isspace(c) isspace((int)(unsigned char)(c))
175 /** Data that indicates an eof-condition for a fec-encoded stream. */
176 #define FEC_EOF_PACKET "\xec\x0d\xcc\xfe\0\0\0\0" \
177 "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0"
178 /** The number of bytes of the \a FEC_EOF_PACKET. */
179 #define FEC_EOF_PACKET_LEN 32
181 /** Used to avoid a shortcoming in vim's syntax highlighting. */
182 #define EMBRACE(...) { __VA_ARGS__}
184 /** A nice cup of STFU for Mr gcc. */
185 #define do_nothing do {/* nothing */} while (0)
188 * The sample formats supported by paraslash.
190 * It may be determined by one of the following sources:
192 * 1. The decoding filter (para_audiod only). In this case, it is always
193 * \p SF_S16_LE which is the canonical format used within decoders.
195 * 2. The wav header (para_write only).
197 * 3. The --sample-format option of para_write.
199 #define SAMPLE_FORMATS \
200 SAMPLE_FORMAT(SF_S8, "8 bit signed"), \
201 SAMPLE_FORMAT(SF_U8, "8 bit unsigned"), \
202 SAMPLE_FORMAT(SF_S16_LE, "16 bit signed, little endian"), \
203 SAMPLE_FORMAT(SF_S16_BE, "16 bit signed, big endian"), \
204 SAMPLE_FORMAT(SF_U16_LE, "16 bit unsigned, little endian"), \
205 SAMPLE_FORMAT(SF_U16_BE, "16 bit unsigned, big endian"), \
207 /** \cond sample_format */
208 #define SAMPLE_FORMAT(a, b) a
209 enum sample_format {SAMPLE_FORMATS};
211 #define SAMPLE_FORMAT(a, b) b
212 /** \endcond sample_format */
214 /** Debug, Info, etc. */
215 enum loglevels {LOGLEVELS, NUM_LOGLEVELS};
217 #define PARA_DEBUG_LOG(f,...) para_log(LL_DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
218 #define PARA_INFO_LOG(f,...) para_log(LL_INFO, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
219 #define PARA_NOTICE_LOG(f,...) para_log(LL_NOTICE, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
220 #define PARA_WARNING_LOG(f,...) para_log(LL_WARNING, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
221 #define PARA_ERROR_LOG(f,...) para_log(LL_ERROR, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
222 #define PARA_CRIT_LOG(f,...) para_log(LL_CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
223 #define PARA_EMERG_LOG(f,...) para_log(LL_EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
225 /** \cond status_items */
226 #define STATUS_ITEMS \
227 STATUS_ITEM(basename) \
228 STATUS_ITEM(status) \
229 STATUS_ITEM(num_played) \
231 STATUS_ITEM(bitrate) \
232 STATUS_ITEM(frequency) \
233 STATUS_ITEM(file_size) \
234 STATUS_ITEM(status_flags) \
235 STATUS_ITEM(format) \
237 STATUS_ITEM(techinfo) \
238 STATUS_ITEM(afs_mode) \
239 STATUS_ITEM(attributes_txt) \
240 STATUS_ITEM(decoder_flags) \
241 STATUS_ITEM(audiod_status) \
242 STATUS_ITEM(play_time) \
243 STATUS_ITEM(attributes_bitmap) \
244 STATUS_ITEM(offset) \
245 STATUS_ITEM(seconds_total) \
246 STATUS_ITEM(stream_start) \
247 STATUS_ITEM(current_time) \
248 STATUS_ITEM(audiod_uptime) \
249 STATUS_ITEM(image_id) \
250 STATUS_ITEM(lyrics_id) \
251 STATUS_ITEM(duration) \
252 STATUS_ITEM(directory) \
253 STATUS_ITEM(lyrics_name) \
254 STATUS_ITEM(image_name) \
257 STATUS_ITEM(channels) \
258 STATUS_ITEM(last_played) \
259 STATUS_ITEM(num_chunks) \
260 STATUS_ITEM(chunk_time) \
261 STATUS_ITEM(amplification) \
262 STATUS_ITEM(artist) \
266 STATUS_ITEM(comment) \
267 STATUS_ITEM(max_chunk_size) \
269 #define STATUS_ITEM(_name) SI_ ##_name,
270 enum status_items {STATUS_ITEMS NUM_STAT_ITEMS};
272 #define STATUS_ITEM(_name) #_name,
273 /** \endcond status items */
275 extern const char *status_item_list[];
276 /** Loop over each status item. */
277 #define FOR_EACH_STATUS_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
278 int for_each_stat_item(char *item_buf, size_t num_bytes,
279 int (*item_handler)(int, char *));