common.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484
  1. /*
  2. * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. /**
  21. * @file
  22. * common internal and external API header
  23. */
  24. #ifndef AVUTIL_COMMON_H
  25. #define AVUTIL_COMMON_H
  26. #include <errno.h>
  27. #include <inttypes.h>
  28. #include <limits.h>
  29. #include <math.h>
  30. #include <stdio.h>
  31. #include <stdlib.h>
  32. #include <string.h>
  33. #include "attributes.h"
  34. #include "version.h"
  35. #include "libavutil/avconfig.h"
  36. #if AV_HAVE_BIGENDIAN
  37. # define AV_NE(be, le) (be)
  38. #else
  39. # define AV_NE(be, le) (le)
  40. #endif
  41. //rounded division & shift
  42. #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
  43. /* assume b>0 */
  44. #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
  45. #define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b))
  46. #define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b))
  47. #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
  48. #define FFSIGN(a) ((a) > 0 ? 1 : -1)
  49. #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
  50. #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
  51. #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
  52. #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
  53. #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
  54. #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
  55. #define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
  56. /* misc math functions */
  57. /**
  58. * Reverse the order of the bits of an 8-bits unsigned integer.
  59. */
  60. #if FF_API_AV_REVERSE
  61. extern attribute_deprecated const uint8_t av_reverse[256];
  62. #endif
  63. #ifdef HAVE_AV_CONFIG_H
  64. # include "config.h"
  65. # include "intmath.h"
  66. #endif
  67. /* Pull in unguarded fallback defines at the end of this file. */
  68. #include "common.h"
  69. #ifndef av_log2
  70. av_const int av_log2(unsigned v);
  71. #endif
  72. #ifndef av_log2_16bit
  73. av_const int av_log2_16bit(unsigned v);
  74. #endif
  75. /**
  76. * Clip a signed integer value into the amin-amax range.
  77. * @param a value to clip
  78. * @param amin minimum value of the clip range
  79. * @param amax maximum value of the clip range
  80. * @return clipped value
  81. */
  82. static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
  83. {
  84. #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
  85. if (amin > amax) {
  86. abort();
  87. }
  88. #endif
  89. if (a < amin) {
  90. return amin;
  91. }
  92. else if (a > amax) {
  93. return amax;
  94. }
  95. else {
  96. return a;
  97. }
  98. }
  99. /**
  100. * Clip a signed 64bit integer value into the amin-amax range.
  101. * @param a value to clip
  102. * @param amin minimum value of the clip range
  103. * @param amax maximum value of the clip range
  104. * @return clipped value
  105. */
  106. static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
  107. {
  108. #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
  109. if (amin > amax) {
  110. abort();
  111. }
  112. #endif
  113. if (a < amin) {
  114. return amin;
  115. }
  116. else if (a > amax) {
  117. return amax;
  118. }
  119. else {
  120. return a;
  121. }
  122. }
  123. /**
  124. * Clip a signed integer value into the 0-255 range.
  125. * @param a value to clip
  126. * @return clipped value
  127. */
  128. static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
  129. {
  130. if (a&(~0xFF)) {
  131. return (-a)>>31;
  132. }
  133. else {
  134. return a;
  135. }
  136. }
  137. /**
  138. * Clip a signed integer value into the -128,127 range.
  139. * @param a value to clip
  140. * @return clipped value
  141. */
  142. static av_always_inline av_const int8_t av_clip_int8_c(int a)
  143. {
  144. if ((a+0x80) & ~0xFF) {
  145. return (a>>31) ^ 0x7F;
  146. }
  147. else {
  148. return a;
  149. }
  150. }
  151. /**
  152. * Clip a signed integer value into the 0-65535 range.
  153. * @param a value to clip
  154. * @return clipped value
  155. */
  156. static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
  157. {
  158. if (a&(~0xFFFF)) {
  159. return (-a)>>31;
  160. }
  161. else {
  162. return a;
  163. }
  164. }
  165. /**
  166. * Clip a signed integer value into the -32768,32767 range.
  167. * @param a value to clip
  168. * @return clipped value
  169. */
  170. static av_always_inline av_const int16_t av_clip_int16_c(int a)
  171. {
  172. if ((a+0x8000) & ~0xFFFF) {
  173. return (a>>31) ^ 0x7FFF;
  174. }
  175. else {
  176. return a;
  177. }
  178. }
  179. /**
  180. * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
  181. * @param a value to clip
  182. * @return clipped value
  183. */
  184. static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
  185. {
  186. if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) {
  187. return (a>>63) ^ 0x7FFFFFFF;
  188. }
  189. else {
  190. return (int32_t)a;
  191. }
  192. }
  193. /**
  194. * Clip a signed integer to an unsigned power of two range.
  195. * @param a value to clip
  196. * @param p bit position to clip at
  197. * @return clipped value
  198. */
  199. static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
  200. {
  201. if (a & ~((1<<p) - 1)) {
  202. return -a >> 31 & ((1<<p) - 1);
  203. }
  204. else {
  205. return a;
  206. }
  207. }
  208. /**
  209. * Add two signed 32-bit values with saturation.
  210. *
  211. * @param a one value
  212. * @param b another value
  213. * @return sum with signed saturation
  214. */
  215. static av_always_inline int av_sat_add32_c(int a, int b)
  216. {
  217. return av_clipl_int32((int64_t)a + b);
  218. }
  219. /**
  220. * Add a doubled value to another value with saturation at both stages.
  221. *
  222. * @param a first value
  223. * @param b value doubled and added to a
  224. * @return sum with signed saturation
  225. */
  226. static av_always_inline int av_sat_dadd32_c(int a, int b)
  227. {
  228. return av_sat_add32(a, av_sat_add32(b, b));
  229. }
  230. /**
  231. * Clip a float value into the amin-amax range.
  232. * @param a value to clip
  233. * @param amin minimum value of the clip range
  234. * @param amax maximum value of the clip range
  235. * @return clipped value
  236. */
  237. static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
  238. {
  239. #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
  240. if (amin > amax) {
  241. abort();
  242. }
  243. #endif
  244. if (a < amin) {
  245. return amin;
  246. }
  247. else if (a > amax) {
  248. return amax;
  249. }
  250. else {
  251. return a;
  252. }
  253. }
  254. /** Compute ceil(log2(x)).
  255. * @param x value used to compute ceil(log2(x))
  256. * @return computed ceiling of log2(x)
  257. */
  258. static av_always_inline av_const int av_ceil_log2_c(int x)
  259. {
  260. return av_log2((x - 1) << 1);
  261. }
  262. /**
  263. * Count number of bits set to one in x
  264. * @param x value to count bits of
  265. * @return the number of bits set to one in x
  266. */
  267. static av_always_inline av_const int av_popcount_c(uint32_t x)
  268. {
  269. x -= (x >> 1) & 0x55555555;
  270. x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
  271. x = (x + (x >> 4)) & 0x0F0F0F0F;
  272. x += x >> 8;
  273. return (x + (x >> 16)) & 0x3F;
  274. }
  275. /**
  276. * Count number of bits set to one in x
  277. * @param x value to count bits of
  278. * @return the number of bits set to one in x
  279. */
  280. static av_always_inline av_const int av_popcount64_c(uint64_t x)
  281. {
  282. return av_popcount((uint32_t)x) + av_popcount(x >> 32);
  283. }
  284. #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
  285. #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
  286. /**
  287. * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
  288. *
  289. * @param val Output value, must be an lvalue of type uint32_t.
  290. * @param GET_BYTE Expression reading one byte from the input.
  291. * Evaluated up to 7 times (4 for the currently
  292. * assigned Unicode range). With a memory buffer
  293. * input, this could be *ptr++.
  294. * @param ERROR Expression to be evaluated on invalid input,
  295. * typically a goto statement.
  296. */
  297. #define GET_UTF8(val, GET_BYTE, ERROR)\
  298. val= GET_BYTE;\
  299. {\
  300. uint32_t top = (val & 128) >> 1;\
  301. if ((val & 0xc0) == 0x80)\
  302. ERROR\
  303. while (val & top) {\
  304. int tmp= GET_BYTE - 128;\
  305. if(tmp>>6)\
  306. ERROR\
  307. val= (val<<6) + tmp;\
  308. top <<= 5;\
  309. }\
  310. val &= (top << 1) - 1;\
  311. }
  312. /**
  313. * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
  314. *
  315. * @param val Output value, must be an lvalue of type uint32_t.
  316. * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
  317. * to native byte order. Evaluated one or two times.
  318. * @param ERROR Expression to be evaluated on invalid input,
  319. * typically a goto statement.
  320. */
  321. #define GET_UTF16(val, GET_16BIT, ERROR)\
  322. val = GET_16BIT;\
  323. {\
  324. unsigned int hi = val - 0xD800;\
  325. if (hi < 0x800) {\
  326. val = GET_16BIT - 0xDC00;\
  327. if (val > 0x3FFU || hi > 0x3FFU)\
  328. ERROR\
  329. val += (hi<<10) + 0x10000;\
  330. }\
  331. }\
  332. /**
  333. * @def PUT_UTF8(val, tmp, PUT_BYTE)
  334. * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
  335. * @param val is an input-only argument and should be of type uint32_t. It holds
  336. * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
  337. * val is given as a function it is executed only once.
  338. * @param tmp is a temporary variable and should be of type uint8_t. It
  339. * represents an intermediate value during conversion that is to be
  340. * output by PUT_BYTE.
  341. * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
  342. * It could be a function or a statement, and uses tmp as the input byte.
  343. * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
  344. * executed up to 4 times for values in the valid UTF-8 range and up to
  345. * 7 times in the general case, depending on the length of the converted
  346. * Unicode character.
  347. */
  348. #define PUT_UTF8(val, tmp, PUT_BYTE)\
  349. {\
  350. int bytes, shift;\
  351. uint32_t in = val;\
  352. if (in < 0x80) {\
  353. tmp = in;\
  354. PUT_BYTE\
  355. } else {\
  356. bytes = (av_log2(in) + 4) / 5;\
  357. shift = (bytes - 1) * 6;\
  358. tmp = (256 - (256 >> bytes)) | (in >> shift);\
  359. PUT_BYTE\
  360. while (shift >= 6) {\
  361. shift -= 6;\
  362. tmp = 0x80 | ((in >> shift) & 0x3f);\
  363. PUT_BYTE\
  364. }\
  365. }\
  366. }
  367. /**
  368. * @def PUT_UTF16(val, tmp, PUT_16BIT)
  369. * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
  370. * @param val is an input-only argument and should be of type uint32_t. It holds
  371. * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
  372. * val is given as a function it is executed only once.
  373. * @param tmp is a temporary variable and should be of type uint16_t. It
  374. * represents an intermediate value during conversion that is to be
  375. * output by PUT_16BIT.
  376. * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
  377. * in desired endianness. It could be a function or a statement, and uses tmp
  378. * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;"
  379. * PUT_BYTE will be executed 1 or 2 times depending on input character.
  380. */
  381. #define PUT_UTF16(val, tmp, PUT_16BIT)\
  382. {\
  383. uint32_t in = val;\
  384. if (in < 0x10000) {\
  385. tmp = in;\
  386. PUT_16BIT\
  387. } else {\
  388. tmp = 0xD800 | ((in - 0x10000) >> 10);\
  389. PUT_16BIT\
  390. tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
  391. PUT_16BIT\
  392. }\
  393. }\
  394. #include "mem.h"
  395. #ifdef HAVE_AV_CONFIG_H
  396. # include "internal.h"
  397. #endif /* HAVE_AV_CONFIG_H */
  398. #endif /* AVUTIL_COMMON_H */
  399. /*
  400. * The following definitions are outside the multiple inclusion guard
  401. * to ensure they are immediately available in intmath.h.
  402. */
  403. #ifndef av_ceil_log2
  404. # define av_ceil_log2 av_ceil_log2_c
  405. #endif
  406. #ifndef av_clip
  407. # define av_clip av_clip_c
  408. #endif
  409. #ifndef av_clip64
  410. # define av_clip64 av_clip64_c
  411. #endif
  412. #ifndef av_clip_uint8
  413. # define av_clip_uint8 av_clip_uint8_c
  414. #endif
  415. #ifndef av_clip_int8
  416. # define av_clip_int8 av_clip_int8_c
  417. #endif
  418. #ifndef av_clip_uint16
  419. # define av_clip_uint16 av_clip_uint16_c
  420. #endif
  421. #ifndef av_clip_int16
  422. # define av_clip_int16 av_clip_int16_c
  423. #endif
  424. #ifndef av_clipl_int32
  425. # define av_clipl_int32 av_clipl_int32_c
  426. #endif
  427. #ifndef av_clip_uintp2
  428. # define av_clip_uintp2 av_clip_uintp2_c
  429. #endif
  430. #ifndef av_sat_add32
  431. # define av_sat_add32 av_sat_add32_c
  432. #endif
  433. #ifndef av_sat_dadd32
  434. # define av_sat_dadd32 av_sat_dadd32_c
  435. #endif
  436. #ifndef av_clipf
  437. # define av_clipf av_clipf_c
  438. #endif
  439. #ifndef av_popcount
  440. # define av_popcount av_popcount_c
  441. #endif
  442. #ifndef av_popcount64
  443. # define av_popcount64 av_popcount64_c
  444. #endif