Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

325 lines
13KB

  1. /*
  2. * Carla common defines
  3. * Copyright (C) 2011-2022 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  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. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. #ifndef CARLA_DEFINES_H_INCLUDED
  18. #define CARLA_DEFINES_H_INCLUDED
  19. /* IDE Helper */
  20. #ifndef REAL_BUILD
  21. # include "config.h"
  22. #endif
  23. /* Compatibility with non-clang compilers */
  24. #ifndef __has_feature
  25. # define __has_feature(x) 0
  26. #endif
  27. #ifndef __has_extension
  28. # define __has_extension __has_feature
  29. #endif
  30. /* Set Version */
  31. #define CARLA_VERSION_HEX 0x020501
  32. #define CARLA_VERSION_STRING "2.5.1"
  33. #define CARLA_VERSION_STRMIN "2.5"
  34. /* Check OS */
  35. #if defined(WIN64) || defined(_WIN64) || defined(__WIN64__) || defined(_M_ARM64)
  36. # define CARLA_OS_WIN64
  37. #elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(_M_ARM)
  38. # define CARLA_OS_WIN32
  39. #elif defined(__APPLE__)
  40. # define CARLA_OS_MAC
  41. #elif defined(__HAIKU__)
  42. # define CARLA_OS_HAIKU
  43. #elif defined(__linux__) || defined(__linux)
  44. # define CARLA_OS_LINUX
  45. #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
  46. # define CARLA_OS_BSD
  47. #elif defined(__GNU__)
  48. # define CARLA_OS_GNU_HURD
  49. #elif defined(__EMSCRIPTEN__)
  50. # define CARLA_OS_WASM
  51. #else
  52. # warning Unsupported platform!
  53. #endif
  54. #if defined(CARLA_OS_WIN32) || defined(CARLA_OS_WIN64)
  55. # define CARLA_OS_WIN
  56. #elif defined(CARLA_OS_BSD) || defined(CARLA_OS_GNU_HURD) || defined(CARLA_OS_LINUX) || defined(CARLA_OS_MAC)
  57. # define CARLA_OS_UNIX
  58. #endif
  59. #if defined(__LP64__) || defined(_LP64) || defined(__arm64__) || defined(__aarch64__) || defined(CARLA_OS_WIN64)
  60. # define CARLA_OS_64BIT
  61. #endif
  62. /* Check for C++11 support */
  63. #if defined(HAVE_CPP11_SUPPORT)
  64. # if HAVE_CPP11_SUPPORT
  65. # define CARLA_PROPER_CPP11_SUPPORT
  66. # endif
  67. #elif defined(__cplusplus)
  68. # if __cplusplus >= 201103L || (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 405 && defined(__GXX_EXPERIMENTAL_CXX0X__)) || __has_extension(cxx_noexcept)
  69. # define CARLA_PROPER_CPP11_SUPPORT
  70. # if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) < 407 && ! defined(__clang__)) || (defined(__clang__) && ! __has_extension(cxx_override_control))
  71. # define override // gcc4.7+ only
  72. # define final // gcc4.7+ only
  73. # endif
  74. # endif
  75. #endif
  76. #if defined(__cplusplus) && ! defined(CARLA_PROPER_CPP11_SUPPORT)
  77. # define noexcept throw()
  78. # define override
  79. # define final
  80. # define nullptr NULL
  81. #endif
  82. /* Common includes */
  83. #ifdef __cplusplus
  84. # include <cstddef>
  85. #else
  86. # include <stdbool.h>
  87. # include <stddef.h>
  88. #endif
  89. /* Define various string format types */
  90. #if defined(CARLA_OS_WIN64)
  91. # define P_INT64 "%lli"
  92. # define P_UINT64 "%llu"
  93. # define P_INTPTR "%lli"
  94. # define P_UINTPTR "%llx"
  95. # define P_SIZE "%llu"
  96. # define P_SSIZE "%lli"
  97. #elif defined(CARLA_OS_WIN32)
  98. # define P_INT64 "%lli"
  99. # define P_UINT64 "%llu"
  100. # define P_INTPTR "%i"
  101. # define P_UINTPTR "%x"
  102. # define P_SIZE "%u"
  103. # define P_SSIZE "%i"
  104. #elif defined(CARLA_OS_WASM)
  105. # define P_INT64 "%lli"
  106. # define P_UINT64 "%llu"
  107. # define P_INTPTR "%li"
  108. # define P_UINTPTR "%lx"
  109. # define P_SIZE "%lu"
  110. # define P_SSIZE "%li"
  111. #elif defined(CARLA_OS_MAC)
  112. # define P_INT64 "%lli"
  113. # define P_UINT64 "%llu"
  114. # define P_INTPTR "%li"
  115. # define P_UINTPTR "%lx"
  116. # define P_SIZE "%lu"
  117. # define P_SSIZE "%li"
  118. #elif (defined(__WORDSIZE) && __WORDSIZE == 64) || \
  119. (defined(__SIZE_WIDTH__) && __SIZE_WIDTH__ == 64) || \
  120. (defined(CARLA_OS_HAIKU) && defined(CARLA_OS_64BIT))
  121. # define P_INT64 "%li"
  122. # define P_UINT64 "%lu"
  123. # define P_INTPTR "%li"
  124. # define P_UINTPTR "%lx"
  125. # define P_SIZE "%lu"
  126. # define P_SSIZE "%li"
  127. #else
  128. # define P_INT64 "%lli"
  129. # define P_UINT64 "%llu"
  130. # define P_INTPTR "%i"
  131. # define P_UINTPTR "%x"
  132. # define P_SIZE "%u"
  133. # define P_SSIZE "%i"
  134. #endif
  135. /* Define BINARY_NATIVE */
  136. #if defined(CARLA_OS_WIN)
  137. # ifdef CARLA_OS_WIN64
  138. # define BINARY_NATIVE BINARY_WIN64
  139. # else
  140. # define BINARY_NATIVE BINARY_WIN32
  141. # endif
  142. #else
  143. # ifdef CARLA_OS_64BIT
  144. # define BINARY_NATIVE BINARY_POSIX64
  145. # else
  146. # define BINARY_NATIVE BINARY_POSIX32
  147. # endif
  148. #endif
  149. /* Define CARLA_ASSERT* */
  150. #if defined(CARLA_NO_ASSERTS)
  151. # define CARLA_ASSERT(cond)
  152. # define CARLA_ASSERT_INT(cond, value)
  153. # define CARLA_ASSERT_INT2(cond, v1, v2)
  154. #elif defined(NDEBUG)
  155. # define CARLA_ASSERT CARLA_SAFE_ASSERT
  156. # define CARLA_ASSERT_INT CARLA_SAFE_ASSERT_INT
  157. # define CARLA_ASSERT_INT2 CARLA_SAFE_ASSERT_INT2
  158. #else
  159. # define CARLA_ASSERT(cond) assert(cond)
  160. # define CARLA_ASSERT_INT(cond, value) assert(cond)
  161. # define CARLA_ASSERT_INT2(cond, v1, v2) assert(cond)
  162. #endif
  163. /* Define CARLA_SAFE_ASSERT* */
  164. #define CARLA_SAFE_ASSERT(cond) if (__builtin_expect(!(cond),0)) carla_safe_assert (#cond, __FILE__, __LINE__);
  165. #define CARLA_SAFE_ASSERT_INT(cond, value) if (__builtin_expect(!(cond),0)) carla_safe_assert_int (#cond, __FILE__, __LINE__, static_cast<int>(value));
  166. #define CARLA_SAFE_ASSERT_INT2(cond, v1, v2) if (__builtin_expect(!(cond),0)) carla_safe_assert_int2 (#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2));
  167. #define CARLA_SAFE_ASSERT_UINT(cond, value) if (__builtin_expect(!(cond),0)) carla_safe_assert_uint (#cond, __FILE__, __LINE__, static_cast<uint>(value));
  168. #define CARLA_SAFE_ASSERT_UINT2(cond, v1, v2) if (__builtin_expect(!(cond),0)) carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2));
  169. #define CARLA_SAFE_ASSERT_BREAK(cond) if (__builtin_expect(!(cond),0)) { carla_safe_assert(#cond, __FILE__, __LINE__); break; }
  170. #define CARLA_SAFE_ASSERT_CONTINUE(cond) if (__builtin_expect(!(cond),0)) { carla_safe_assert(#cond, __FILE__, __LINE__); continue; }
  171. #define CARLA_SAFE_ASSERT_RETURN(cond, ret) if (__builtin_expect(!(cond),0)) { carla_safe_assert(#cond, __FILE__, __LINE__); return ret; }
  172. #define CARLA_CUSTOM_SAFE_ASSERT(msg, cond) if (__builtin_expect(!(cond),0)) carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__);
  173. #define CARLA_CUSTOM_SAFE_ASSERT_BREAK(msg, cond) if (__builtin_expect(!(cond),0)) { carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); break; }
  174. #define CARLA_CUSTOM_SAFE_ASSERT_CONTINUE(msg, cond) if (__builtin_expect(!(cond),0)) { carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); continue; }
  175. #define CARLA_CUSTOM_SAFE_ASSERT_RETURN(msg, cond, ret) if (__builtin_expect(!(cond),0)) { carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); return ret; }
  176. #define CARLA_CUSTOM_SAFE_ASSERT_ONCE_BREAK(msg, cond) if (__builtin_expect(!(cond),0)) { static bool _p; if (!_p) { _p = true; carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); } break; }
  177. #define CARLA_CUSTOM_SAFE_ASSERT_ONCE_CONTINUE(msg, cond) if (__builtin_expect(!(cond),0)) { static bool _p; if (!_p) { _p = true; carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); } continue; }
  178. #define CARLA_CUSTOM_SAFE_ASSERT_ONCE_RETURN(msg, cond, ret) if (__builtin_expect(!(cond),0)) { static bool _p; if (!_p) { _p = true; carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); } return ret; }
  179. #define CARLA_SAFE_ASSERT_INT_BREAK(cond, value) if (__builtin_expect(!(cond),0)) { carla_safe_assert_int(#cond, __FILE__, __LINE__, static_cast<int>(value); break; }
  180. #define CARLA_SAFE_ASSERT_INT_CONTINUE(cond, value) if (__builtin_expect(!(cond),0)) { carla_safe_assert_int(#cond, __FILE__, __LINE__, static_cast<int>(value)); continue; }
  181. #define CARLA_SAFE_ASSERT_INT_RETURN(cond, value, ret) if (__builtin_expect(!(cond),0)) { carla_safe_assert_int(#cond, __FILE__, __LINE__, static_cast<int>(value)); return ret; }
  182. #define CARLA_SAFE_ASSERT_INT2_BREAK(cond, v1, v2) if (__builtin_expect(!(cond),0)) { carla_safe_assert_int2(#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2)); break; }
  183. #define CARLA_SAFE_ASSERT_INT2_CONTINUE(cond, v1, v2) if (__builtin_expect(!(cond),0)) { carla_safe_assert_int2(#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2)); continue; }
  184. #define CARLA_SAFE_ASSERT_INT2_RETURN(cond, v1, v2, ret) if (__builtin_expect(!(cond),0)) { carla_safe_assert_int2(#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2)); return ret; }
  185. #define CARLA_SAFE_ASSERT_UINT_BREAK(cond, value) if (__builtin_expect(!(cond),0)) { carla_safe_assert_uint(#cond, __FILE__, __LINE__, static_cast<uint>(value); break; }
  186. #define CARLA_SAFE_ASSERT_UINT_CONTINUE(cond, value) if (__builtin_expect(!(cond),0)) { carla_safe_assert_uint(#cond, __FILE__, __LINE__, static_cast<uint>(value)); continue; }
  187. #define CARLA_SAFE_ASSERT_UINT_RETURN(cond, value, ret) if (__builtin_expect(!(cond),0)) { carla_safe_assert_uint(#cond, __FILE__, __LINE__, static_cast<uint>(value)); return ret; }
  188. #define CARLA_SAFE_ASSERT_UINT2_BREAK(cond, v1, v2) if (__builtin_expect(!(cond),0)) { carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2)); break; }
  189. #define CARLA_SAFE_ASSERT_UINT2_CONTINUE(cond, v1, v2) if (__builtin_expect(!(cond),0)) { carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2)); continue; }
  190. #define CARLA_SAFE_ASSERT_UINT2_RETURN(cond, v1, v2, ret) if (__builtin_expect(!(cond),0)) { carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2)); return ret; }
  191. #if defined(__GNUC__) && defined(CARLA_PROPER_CPP11_SUPPORT) && ! defined(__clang__)
  192. # define CARLA_CATCH_UNWIND catch (abi::__forced_unwind&) { throw; }
  193. # if __GNUC__ >= 6
  194. # pragma GCC diagnostic push
  195. # pragma GCC diagnostic ignored "-Wterminate"
  196. # endif
  197. #else
  198. # define CARLA_CATCH_UNWIND
  199. #endif
  200. /* Define CARLA_SAFE_EXCEPTION */
  201. #define CARLA_SAFE_EXCEPTION(msg) CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); }
  202. #define CARLA_SAFE_EXCEPTION_BREAK(msg) CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); break; }
  203. #define CARLA_SAFE_EXCEPTION_CONTINUE(msg) CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); continue; }
  204. #define CARLA_SAFE_EXCEPTION_RETURN(msg, ret) CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); return ret; }
  205. /* Define CARLA_DECLARE_NON_COPYABLE */
  206. #ifdef CARLA_PROPER_CPP11_SUPPORT
  207. # define CARLA_DECLARE_NON_COPYABLE(ClassName) \
  208. private: \
  209. ClassName(ClassName&) = delete; \
  210. ClassName(const ClassName&) = delete; \
  211. ClassName& operator=(ClassName&) = delete; \
  212. ClassName& operator=(const ClassName&) = delete;
  213. #else
  214. # define CARLA_DECLARE_NON_COPYABLE(ClassName) \
  215. private: \
  216. ClassName(ClassName&); \
  217. ClassName(const ClassName&); \
  218. ClassName& operator=(ClassName&); \
  219. ClassName& operator=(const ClassName&);
  220. #endif
  221. /* Define CARLA_PREVENT_HEAP_ALLOCATION */
  222. #ifdef CARLA_PROPER_CPP11_SUPPORT
  223. # define CARLA_PREVENT_HEAP_ALLOCATION \
  224. private: \
  225. static void* operator new(std::size_t) = delete; \
  226. static void operator delete(void*) = delete;
  227. #else
  228. # define CARLA_PREVENT_HEAP_ALLOCATION \
  229. private: \
  230. static void* operator new(std::size_t); \
  231. static void operator delete(void*);
  232. #endif
  233. /* Define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION */
  234. #ifdef CARLA_PROPER_CPP11_SUPPORT
  235. # define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION \
  236. private: \
  237. static void* operator new(std::size_t) = delete;
  238. #else
  239. # define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION \
  240. private: \
  241. static void* operator new(std::size_t);
  242. #endif
  243. /* CARLA_VISIBLE_SYMBOL */
  244. #if defined(CARLA_OS_WIN) && ! defined(__WINE__)
  245. # ifdef BUILDING_CARLA
  246. # define CARLA_VISIBLE_SYMBOL __declspec (dllexport)
  247. # else
  248. # define CARLA_VISIBLE_SYMBOL __declspec (dllimport)
  249. # endif
  250. #else
  251. # define CARLA_VISIBLE_SYMBOL __attribute__ ((visibility("default")))
  252. #endif
  253. /* Define CARLA_API */
  254. #if defined(BUILD_BRIDGE) || defined(STATIC_PLUGIN_TARGET)
  255. # define CARLA_API
  256. #else
  257. # define CARLA_API CARLA_VISIBLE_SYMBOL
  258. #endif
  259. /* Define CARLA_EXTERN_C */
  260. #ifdef __cplusplus
  261. # define CARLA_EXTERN_C extern "C"
  262. #else
  263. # define CARLA_EXTERN_C
  264. #endif
  265. /* Define CARLA_*_EXPORT */
  266. #ifdef BUILD_BRIDGE
  267. # define CARLA_API_EXPORT CARLA_EXTERN_C
  268. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C
  269. #else
  270. # define CARLA_API_EXPORT CARLA_EXTERN_C CARLA_API
  271. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C CARLA_VISIBLE_SYMBOL
  272. #endif
  273. /* Define CARLA_OS_SEP */
  274. #ifdef CARLA_OS_WIN
  275. # define CARLA_OS_SEP '\\'
  276. # define CARLA_OS_SEP_STR "\\"
  277. # define CARLA_OS_SPLIT ';'
  278. # define CARLA_OS_SPLIT_STR ";"
  279. #else
  280. # define CARLA_OS_SEP '/'
  281. # define CARLA_OS_SEP_STR "/"
  282. # define CARLA_OS_SPLIT ':'
  283. # define CARLA_OS_SPLIT_STR ":"
  284. #endif
  285. /* Useful typedefs */
  286. typedef unsigned char uchar;
  287. typedef unsigned short int ushort;
  288. typedef unsigned int uint;
  289. typedef unsigned long int ulong;
  290. typedef unsigned long long int ulonglong;
  291. #endif /* CARLA_DEFINES_H_INCLUDED */