X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=para.h;h=c4c73a3f37661565037fc72ffbf03dc9bef8f20b;hp=1ac056b31bc38d455a41a08c7ef094ea3d7c8090;hb=277ed4a605f68118aff9e671f16c0ac6edb1d55a;hpb=09e1e9039b42f00bcfa64091700d611931618bca diff --git a/para.h b/para.h index 1ac056b3..46efebde 100644 --- a/para.h +++ b/para.h @@ -1,19 +1,7 @@ /* - * Copyright (C) 1997-2006 Andre Noll + * Copyright (C) 1997-2013 Andre Noll * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file para.h global paraslash definitions */ @@ -36,182 +24,264 @@ #include #include /* needed by create_pf_socket */ #include +#include +#include #include "gcc-compat.h" -/* some internal constants */ -#define STRINGSIZE 4096 +/** used in various contexts */ #define MAXLINE 255 +/** Compute the minimum of \a x and \a y. */ +#define PARA_MIN(x, y) ({ \ + typeof(x) _min1 = (x); \ + typeof(y) _min2 = (y); \ + (void) (&_min1 == &_min2); \ + _min1 < _min2 ? _min1 : _min2; }) + +/** Compute the maximum of \a x and \a y. */ +#define PARA_MAX(x, y) ({ \ + typeof(x) _max1 = (x); \ + typeof(y) _max2 = (y); \ + (void) (&_max1 == &_max2); \ + _max1 < _max2 ? _max2 : _max1; }) -#define MIN(a,b) ((a) < (b) ? (a) : (b)) -#define MAX(a,b) ((a) > (b) ? (a) : (b)) -#define ABS(a) ((a) > 0 ? (a) : -(a)) +/** Compute the absolute value of \a x. */ +#define PARA_ABS(x) ({ \ + typeof(x) _x = (x); \ + _x > 0? _x : -_x; }) + + +extern __printf_2_3 void (*para_log)(int, const char*, ...); +/** + * Define a standard log function that always writes to stderr. + * + * \param funcname The name of the function to be defined. + * + * \param loglevel_barrier If the loglevel of the current message + * is less than that, the message is going to be ignored. + * + */ +#define DEFINE_STDERR_LOGGER(funcname, loglevel_barrier) \ + __printf_2_3 void funcname(int ll, const char* fmt,...) \ + { \ + va_list argp; \ + if (ll < loglevel_barrier) \ + return; \ + va_start(argp, fmt); \ + vfprintf(stderr, fmt, argp); \ + va_end(argp); \ + } +/** + * Define the standard log function and activate it. + * + * \param loglevel_barrier See \ref DEFINE_STDERR_LOGGER. + */ +#define INIT_STDERR_LOGGING(loglevel_barrier) \ + DEFINE_STDERR_LOGGER(stderr_log, loglevel_barrier); \ + __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log; -/* Loglevels */ -#define DEBUG 1 -#define INFO 2 -#define NOTICE 3 -#define WARNING 4 -#define ERROR 5 -#define CRIT 6 -#define EMERG 7 +/** Sent by para_client to initiate the authentication procedure. */ +#define AUTH_REQUEST_MSG "auth rsa " +/* exec */ +int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds); +/* time */ +int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff); +long unsigned tv2ms(const struct timeval*); +void d2tv(double, struct timeval*); +void tv_add(const struct timeval*, const struct timeval *, struct timeval *); +void tv_scale(const unsigned long, const struct timeval *, struct timeval *); +void tv_divide(const unsigned long divisor, const struct timeval *tv, + struct timeval *result); +int tv_convex_combination(const long a, const struct timeval *tv1, + const long b, const struct timeval *tv2, + struct timeval *result); +void ms2tv(const long unsigned n, struct timeval *tv); +void compute_chunk_time(long unsigned chunk_num, + struct timeval *chunk_tv, struct timeval *stream_start, + struct timeval *result); + +/** The enum of all status items. */ +enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS}; +extern const char *status_item_list[]; +/** Loop over each status item. */ +#define FOR_EACH_STATUS_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++) +int for_each_stat_item(char *item_buf, size_t num_bytes, + int (*item_handler)(int, char *)); + + +/** + * Return a random non-negative integer in an interval. + * + * \param max Determines maximal possible return value. + * + * \return An integer between zero and \p max - 1, inclusively. + */ +_static_inline_ long int para_random(unsigned max) +{ + return ((max + 0.0) * (random() / (RAND_MAX + 1.0))); +} + +/** + * Simple sanity check for I/O vectors. + * + * \param iov Pointer to the I/O vector to check. + * + * \return True if \a iov points to a non-empty buffer. + */ +_static_inline_ bool iov_valid(const struct iovec *iov) +{ + return iov && iov->iov_len > 0 && iov->iov_base; +} + +/** Round up x to next multiple of y. */ +#define ROUND_UP(x, y) ({ \ + const typeof(y) _divisor = y; \ + ((x) + _divisor - 1) / _divisor * _divisor; }) + +/** Round down x to multiple of y. */ +#define ROUND_DOWN(x, y) ({ \ + const typeof(y) _divisor = y; \ + (x) / _divisor * _divisor; }) + +/** Divide and round up to next integer. */ +#define DIV_ROUND_UP(x, y) ({ \ + typeof(y) _divisor = y; \ + ((x) + _divisor - 1) / _divisor; }) + +/** + * Assert a build-time dependency, as an expression. + * + * \param cond The compile-time condition which must be true. + * + * Compilation will fail if the condition isn't true, or can't be evaluated by + * the compiler. This can be used in an expression: its value is "0". + * + * Taken from ccan. + */ +#define EXPR_BUILD_ASSERT(cond) (sizeof(char [1 - 2 * !(cond)]) - 1) + +/** &a[0] degrades to a pointer: a different type from an array */ +#define _array_size_chk(arr) EXPR_BUILD_ASSERT(\ + !__builtin_types_compatible_p(typeof(arr), typeof(&(arr)[0]))) +/** Get the size of an array */ +#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + _array_size_chk(arr)) + +/** + * Wrapper for isspace. + * NetBSD needs this. + */ +/* + * The values should be cast to an unsigned char first, then to int. + * Why? Because the isdigit (as do all other is/to functions/macros) + * expect a number from 0 upto and including 255 as their (int) argument. + * Because char is signed on most systems, casting it to int immediately + * gives the functions an argument between -128 and 127 (inclusive), + * which they will use as an array index, and which will thus fail + * horribly for characters which have their most significant bit set. + */ +#define para_isspace(c) isspace((int)(unsigned char)(c)) + +/** Data that indicates an eof-condition for a fec-encoded stream. */ +#define FEC_EOF_PACKET "\xec\x0d\xcc\xfe\0\0\0\0" \ + "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" +/** The number of bytes of the \a FEC_EOF_PACKET. */ +#define FEC_EOF_PACKET_LEN 32 + +/** Used to avoid a shortcoming in vim's syntax highlighting. */ +#define EMBRACE(...) { __VA_ARGS__} + +/** A nice cup of STFU for Mr gcc. */ +#define do_nothing do {/* nothing */} while (0) + +/** + * The sample formats supported by paraslash. + * + * It may be determined by one of the following sources: + * + * 1. The decoding filter (para_audiod only). In this case, it is always + * \p SF_S16_LE which is the canonical format used within decoders. + * + * 2. The wav header (para_write only). + * + * 3. The --format option of para_write. + */ +#define SAMPLE_FORMATS \ + SAMPLE_FORMAT(SF_S8, "8 bit signed"), \ + SAMPLE_FORMAT(SF_U8, "8 bit unsigned"), \ + SAMPLE_FORMAT(SF_S16_LE, "16 bit signed, little endian"), \ + SAMPLE_FORMAT(SF_S16_BE, "16 bit signed, big endian"), \ + SAMPLE_FORMAT(SF_U16_LE, "16 bit unsigned, little endian"), \ + SAMPLE_FORMAT(SF_U16_BE, "16 bit unsigned, big endian"), \ + +/** \cond sample_format */ +#define SAMPLE_FORMAT(a, b) a +enum sample_format {SAMPLE_FORMATS}; +#undef SAMPLE_FORMAT +#define SAMPLE_FORMAT(a, b) b +/** \endcond sample_format */ + +/** Debug loglevel, gets really noisy. */ +#define LL_DEBUG 0 +/** Still noisy, but won't fill your disk. */ +#define LL_INFO 1 +/** Normal, but significant event. */ +#define LL_NOTICE 2 +/** Unexpected event that can be handled. */ +#define LL_WARNING 3 +/** Unhandled error condition. */ +#define LL_ERROR 4 +/** System might be unreliable. */ +#define LL_CRIT 5 +/** Last message before exit. */ +#define LL_EMERG 6 +/** Number of all loglevels. */ +#define NUM_LOGLEVELS 7 + +/** Log messages with lower priority than that will not be compiled in. */ #define COMPILE_TIME_LOGLEVEL 0 -#if DEBUG > COMPILE_TIME_LOGLEVEL -#define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, __VA_ARGS__) + +/** \cond log */ +#if LL_DEBUG >= COMPILE_TIME_LOGLEVEL +#define PARA_DEBUG_LOG(f,...) para_log(LL_DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_DEBUG_LOG(...) +#define PARA_DEBUG_LOG(...) do {;} while (0) #endif -#if INFO > COMPILE_TIME_LOGLEVEL -#define PARA_INFO_LOG(f,...) para_log(INFO, "%s: " f, __FUNCTION__, __VA_ARGS__) +#if LL_INFO >= COMPILE_TIME_LOGLEVEL +#define PARA_INFO_LOG(f,...) para_log(LL_INFO, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_INFO_LOG(...) +#define PARA_INFO_LOG(...) do {;} while (0) #endif -#if NOTICE > COMPILE_TIME_LOGLEVEL -#define PARA_NOTICE_LOG(f,...) para_log(NOTICE, "%s: " f, __FUNCTION__, __VA_ARGS__) +#if LL_NOTICE >= COMPILE_TIME_LOGLEVEL +#define PARA_NOTICE_LOG(f,...) para_log(LL_NOTICE, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_NOTICE_LOG(...) +#define PARA_NOTICE_LOG(...) do {;} while (0) #endif -#if WARNING > COMPILE_TIME_LOGLEVEL -#define PARA_WARNING_LOG(f,...) para_log(WARNING, "%s: " f, __FUNCTION__, __VA_ARGS__) +#if LL_WARNING >= COMPILE_TIME_LOGLEVEL +#define PARA_WARNING_LOG(f,...) para_log(LL_WARNING, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_WARNING_LOG(...) +#define PARA_WARNING_LOG(...) do {;} while (0) #endif -#if ERROR > COMPILE_TIME_LOGLEVEL -#define PARA_ERROR_LOG(f,...) para_log(ERROR, "%s: " f, __FUNCTION__, __VA_ARGS__) +#if LL_ERROR >= COMPILE_TIME_LOGLEVEL +#define PARA_ERROR_LOG(f,...) para_log(LL_ERROR, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_ERROR_LOG(...) +#define PARA_ERROR_LOG(...) do {;} while (0) #endif -#if CRIT > COMPILE_TIME_LOGLEVEL -#define PARA_CRIT_LOG(f,...) para_log(CRIT, "%s: " f, __FUNCTION__, __VA_ARGS__) +#if LL_CRIT >= COMPILE_TIME_LOGLEVEL +#define PARA_CRIT_LOG(f,...) para_log(LL_CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_CRIT_LOG(...) +#define PARA_CRIT_LOG(...) do {;} while (0) #endif -#if EMERG > COMPILE_TIME_LOGLEVEL -#define PARA_EMERG_LOG(f,...) para_log(EMERG, "%s: " f, __FUNCTION__, __VA_ARGS__) +#if LL_EMERG >= COMPILE_TIME_LOGLEVEL +#define PARA_EMERG_LOG(f,...) para_log(LL_EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_EMERG_LOG(...) #endif - -#define COPYRIGHT "Copyright (c) 1997-2006 by Andre Noll" - -#define LICENSE "This is free software with ABSOLUTELY NO WARRANTY. " \ - "See COPYING for details." - -#define AWAITING_DATA_MSG "\nAwaiting Data." -#define PROCEED_MSG "\nProceed.\n" -#define PROCEED_MSG_LEN strlen(PROCEED_MSG) -#define EOC_MSG "\nEnd of Command." -#define CHALLENGE_RESPONSE_MSG "challenge_response:" - -/* gui_common */ -int para_open_audiod_pipe(char *); -int read_audiod_pipe(int, void (*)(char *)); - -/* exec */ -int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds); - -/* signal */ -int para_signal_init(void); -int para_install_sighandler(int); -void para_reap_children(void); -pid_t para_reap_child(void); -int para_next_signal(void); - -/* time */ -int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff); -long unsigned tv2ms(const struct timeval*); -void d2tv(double, struct timeval*); -void tv_add(const struct timeval*, const struct timeval *, struct timeval *); -void tv_scale(const unsigned long, const struct timeval *, struct timeval *); -void tv_divide(const unsigned long div, const struct timeval *tv, - struct timeval *result); -int tv_convex_combination(const long a, const struct timeval *tv1, - const long b, const struct timeval *tv2, - struct timeval *result); -void ms2tv(const long unsigned n, struct timeval *tv); - -/* stat */ -enum { - SI_STATUS_BAR, SI_STATUS, SI_NUM_PLAYED, - SI_MTIME, SI_LENGTH_MIN, SI_LENGTH_SEC, - SI_FILE_SIZE, SI_STATUS_FLAGS, SI_FORMAT, - SI_SCORE, SI_AUDIO_INFO1, SI_AUDIO_INFO2, - SI_AUDIO_INFO3, SI_DBINFO1, SI_DBINFO2, - SI_DBINFO3, SI_DECODER_FLAGS, SI_AUDIOD_STATUS, - SI_PLAY_TIME, SI_UPTIME, SI_OFFSET, - SI_LENGTH, SI_STREAM_START, SI_CURRENT_TIME, - SI_AUDIOD_UPTIME, SI_SELECTOR, NUM_STAT_ITEMS -}; - -int stat_item_valid(const char *item); -int stat_line_valid(const char *); -void stat_client_write(char *msg, int itemnum); -int stat_client_add(int fd, long unsigned mask); -void dump_empty_status(void); -unsigned for_each_line(char *, int, void (*)(char *)); - -struct stat_item_data { - const char *prefix, *postfix; - unsigned x, y, len; - int fg, bg, align; -}; - -/* gui_theme */ -struct gui_theme { - const char *name; - const char *author; - int sb_fg, sb_bg; - int cmd_fg, cmd_bg; - int output_fg, output_bg; - int msg_fg, msg_bg; - int err_msg_fg, err_msg_bg; - int welcome_fg, welcome_bg; - int sep_fg, sep_bg; - const char *sep_str; - int default_fg, default_bg; - - int top_lines_default, top_lines_min; - int lines_min, cols_min; - struct stat_item_data data[NUM_STAT_ITEMS]; -}; - -void init_theme(int i, struct gui_theme *); -void next_theme(struct gui_theme *); -void prev_theme(struct gui_theme *); -#define LEFT 1 -#define RIGHT 2 -#define CENTER 3 - - -__printf_2_3 void para_log(int, const char*, ...); - -/* taken from printf man page */ -#define PARA_VSPRINTF(fmt, p) \ -{ \ - int n, size = 100; \ - p = para_malloc(size); \ - while (1) { \ - va_list ap; \ - /* Try to print in the allocated space. */ \ - va_start(ap, fmt); \ - n = vsnprintf(p, size, fmt, ap); \ - va_end(ap); \ - /* If that worked, return the string. */ \ - if (n > -1 && n < size) \ - break; \ - /* Else try again with more space. */ \ - if (n > -1) /* glibc 2.1 */ \ - size = n + 1; /* precisely what is needed */ \ - else /* glibc 2.0 */ \ - size *= 2; /* twice the old size */ \ - p = para_realloc(p, size); \ - } \ -} +/** \endcond log */