paraslash 0.4.6
[paraslash.git] / para.h
diff --git a/para.h b/para.h
index 687ad30ef5507ce4ac7221060bda486d1dc97d57..08eb0ee6c20ab1a7779cc3f10de2b5fca094f44b 100644 (file)
--- a/para.h
+++ b/para.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
        typeof(x) _x = (x); \
        _x > 0? _x : -_x; })
 
-/** 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
-
-/** \cond */
-#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(...) do {;} while (0)
-#endif
-
-#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(...) do {;} while (0)
-#endif
-
-#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(...) do {;} while (0)
-#endif
-
-#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(...) do {;} while (0)
-#endif
-
-#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(...) do {;} while (0)
-#endif
-
-#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(...) do {;} while (0)
-#endif
-
-#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
-/** \endcond */
-
 /**
- * define a standard log function that always writes to stderr
+ * Define a standard log function that always writes to stderr.
  *
  * \param loglevel_barrier If the loglevel of the current message
  * is less than that, the message is going to be ignored.
 /** Version text used by various commands if -V switch was given. */
 #define VERSION_TEXT(prefix) "para_" prefix " " PACKAGE_VERSION \
        " (" GIT_VERSION ": " CODENAME ")" "\n" \
-       "Copyright (C) 2009 Andre Noll\n" \
+       "Copyright (C) 2011 Andre Noll\n" \
        "This is free software with ABSOLUTELY NO WARRANTY." \
        " See COPYING for details.\n" \
        "Written by Andre Noll.\n" \
        "Report bugs to <maan@systemlinux.org>.\n"
 
-/** print out \p VERSION_TEXT and exit if version flag was given */
+/** Print out \p VERSION_TEXT and exit if version flag was given. */
 #define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
        if (_args_info_struct.version_given) { \
                printf("%s", VERSION_TEXT(_prefix)); \
                exit(EXIT_SUCCESS); \
        }
 
-/* Sent by para_client to initiate the authentication procedure. */
+/** Sent by para_client to initiate the authentication procedure. */
 #define AUTH_REQUEST_MSG "auth rsa "
-/** sent by para_server for commands that expect a data file */
+/** Sent by para_server for commands that expect a data file. */
 #define AWAITING_DATA_MSG "\nAwaiting Data."
-/** sent by para_server if authentication was successful */
+/** Sent by para_server if authentication was successful. */
 #define PROCEED_MSG "Proceed."
-/** length of the \p PROCEED_MSG string */
+/** Length of the \p PROCEED_MSG string. */
 #define PROCEED_MSG_LEN strlen(PROCEED_MSG)
-/** sent by para_client to indicate the end of the command line */
+/** Sent by para_client to indicate the end of the command line. */
 #define EOC_MSG "\nEnd of Command."
 
 /* exec */
@@ -229,12 +165,38 @@ _static_inline_ long int para_random(unsigned max)
        return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
 }
 
-/** Round up x to a multiple of y */
-#define ROUND_UP(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
+/** 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(x) (sizeof(x) / sizeof((x)[0]))
+#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + _array_size_chk(arr))
 
 /**
  * Wrapper for isspace.
@@ -259,3 +221,94 @@ _static_inline_ long int para_random(unsigned max)
 /** 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"), \
+
+#define SAMPLE_FORMAT(a, b) a
+enum sample_format {SAMPLE_FORMATS};
+#undef SAMPLE_FORMAT
+#define SAMPLE_FORMAT(a, b) b
+
+/** 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
+
+/** \cond */
+#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(...) do {;} while (0)
+#endif
+
+#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(...) do {;} while (0)
+#endif
+
+#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(...) do {;} while (0)
+#endif
+
+#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(...) do {;} while (0)
+#endif
+
+#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(...) do {;} while (0)
+#endif
+
+#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(...) do {;} while (0)
+#endif
+
+#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
+/** \endcond */