common.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  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 <ctype.h>
  27. #include <errno.h>
  28. #include <inttypes.h>
  29. #include <limits.h>
  30. #include <math.h>
  31. #include <stdio.h>
  32. #include <stdlib.h>
  33. #include <string.h>
  34. #include "attributes.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. extern const uint8_t ff_log2_tab[256];
  58. /**
  59. * Reverse the order of the bits of an 8-bits unsigned integer.
  60. */
  61. extern const uint8_t av_reverse[256];
  62. static av_always_inline av_const int av_log2_c(unsigned int v)
  63. {
  64. int n = 0;
  65. if (v & 0xffff0000) {
  66. v >>= 16;
  67. n += 16;
  68. }
  69. if (v & 0xff00) {
  70. v >>= 8;
  71. n += 8;
  72. }
  73. n += ff_log2_tab[v];
  74. return n;
  75. }
  76. static av_always_inline av_const int av_log2_16bit_c(unsigned int v)
  77. {
  78. int n = 0;
  79. if (v & 0xff00) {
  80. v >>= 8;
  81. n += 8;
  82. }
  83. n += ff_log2_tab[v];
  84. return n;
  85. }
  86. #ifdef HAVE_AV_CONFIG_H
  87. # include "config.h"
  88. # include "intmath.h"
  89. #endif
  90. /* Pull in unguarded fallback defines at the end of this file. */
  91. #include "common.h"
  92. /**
  93. * Clip a signed integer value into the amin-amax range.
  94. * @param a value to clip
  95. * @param amin minimum value of the clip range
  96. * @param amax maximum value of the clip range
  97. * @return clipped value
  98. */
  99. static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
  100. {
  101. if (a < amin) {
  102. return amin;
  103. }
  104. else if (a > amax) {
  105. return amax;
  106. }
  107. else {
  108. return a;
  109. }
  110. }
  111. /**
  112. * Clip a signed integer value into the 0-255 range.
  113. * @param a value to clip
  114. * @return clipped value
  115. */
  116. static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
  117. {
  118. if (a&(~0xFF)) {
  119. return (-a)>>31;
  120. }
  121. else {
  122. return a;
  123. }
  124. }
  125. /**
  126. * Clip a signed integer value into the -128,127 range.
  127. * @param a value to clip
  128. * @return clipped value
  129. */
  130. static av_always_inline av_const int8_t av_clip_int8_c(int a)
  131. {
  132. if ((a+0x80) & ~0xFF) {
  133. return (a>>31) ^ 0x7F;
  134. }
  135. else {
  136. return a;
  137. }
  138. }
  139. /**
  140. * Clip a signed integer value into the 0-65535 range.
  141. * @param a value to clip
  142. * @return clipped value
  143. */
  144. static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
  145. {
  146. if (a&(~0xFFFF)) {
  147. return (-a)>>31;
  148. }
  149. else {
  150. return a;
  151. }
  152. }
  153. /**
  154. * Clip a signed integer value into the -32768,32767 range.
  155. * @param a value to clip
  156. * @return clipped value
  157. */
  158. static av_always_inline av_const int16_t av_clip_int16_c(int a)
  159. {
  160. if ((a+0x8000) & ~0xFFFF) {
  161. return (a>>31) ^ 0x7FFF;
  162. }
  163. else {
  164. return a;
  165. }
  166. }
  167. /**
  168. * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
  169. * @param a value to clip
  170. * @return clipped value
  171. */
  172. static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
  173. {
  174. if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) {
  175. return (a>>63) ^ 0x7FFFFFFF;
  176. }
  177. else {
  178. return (int32_t)a;
  179. }
  180. }
  181. /**
  182. * Clip a signed integer to an unsigned power of two range.
  183. * @param a value to clip
  184. * @param p bit position to clip at
  185. * @return clipped value
  186. */
  187. static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
  188. {
  189. if (a & ~((1<<p) - 1)) {
  190. return -a >> 31 & ((1<<p) - 1);
  191. }
  192. else {
  193. return a;
  194. }
  195. }
  196. /**
  197. * Add two signed 32-bit values with saturation.
  198. *
  199. * @param a one value
  200. * @param b another value
  201. * @return sum with signed saturation
  202. */
  203. static av_always_inline int av_sat_add32_c(int a, int b)
  204. {
  205. return av_clipl_int32((int64_t)a + b);
  206. }
  207. /**
  208. * Add a doubled value to another value with saturation at both stages.
  209. *
  210. * @param a first value
  211. * @param b value doubled and added to a
  212. * @return sum with signed saturation
  213. */
  214. static av_always_inline int av_sat_dadd32_c(int a, int b)
  215. {
  216. return av_sat_add32(a, av_sat_add32(b, b));
  217. }
  218. /**
  219. * Clip a float value into the amin-amax range.
  220. * @param a value to clip
  221. * @param amin minimum value of the clip range
  222. * @param amax maximum value of the clip range
  223. * @return clipped value
  224. */
  225. static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
  226. {
  227. if (a < amin) {
  228. return amin;
  229. }
  230. else if (a > amax) {
  231. return amax;
  232. }
  233. else {
  234. return a;
  235. }
  236. }
  237. /** Compute ceil(log2(x)).
  238. * @param x value used to compute ceil(log2(x))
  239. * @return computed ceiling of log2(x)
  240. */
  241. static av_always_inline av_const int av_ceil_log2_c(int x)
  242. {
  243. return av_log2((x - 1) << 1);
  244. }
  245. /**
  246. * Count number of bits set to one in x
  247. * @param x value to count bits of
  248. * @return the number of bits set to one in x
  249. */
  250. static av_always_inline av_const int av_popcount_c(uint32_t x)
  251. {
  252. x -= (x >> 1) & 0x55555555;
  253. x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
  254. x = (x + (x >> 4)) & 0x0F0F0F0F;
  255. x += x >> 8;
  256. return (x + (x >> 16)) & 0x3F;
  257. }
  258. /**
  259. * Count number of bits set to one in x
  260. * @param x value to count bits of
  261. * @return the number of bits set to one in x
  262. */
  263. static av_always_inline av_const int av_popcount64_c(uint64_t x)
  264. {
  265. return av_popcount((uint32_t)x) + av_popcount(x >> 32);
  266. }
  267. #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
  268. #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
  269. /**
  270. * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
  271. *
  272. * @param val Output value, must be an lvalue of type uint32_t.
  273. * @param GET_BYTE Expression reading one byte from the input.
  274. * Evaluated up to 7 times (4 for the currently
  275. * assigned Unicode range). With a memory buffer
  276. * input, this could be *ptr++.
  277. * @param ERROR Expression to be evaluated on invalid input,
  278. * typically a goto statement.
  279. */
  280. #define GET_UTF8(val, GET_BYTE, ERROR)\
  281. val= GET_BYTE;\
  282. {\
  283. int ones= 7 - av_log2(val ^ 255);\
  284. if(ones==1)\
  285. ERROR\
  286. val&= 127>>ones;\
  287. while(--ones > 0){\
  288. int tmp= GET_BYTE - 128;\
  289. if(tmp>>6)\
  290. ERROR\
  291. val= (val<<6) + tmp;\
  292. }\
  293. }
  294. /**
  295. * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
  296. *
  297. * @param val Output value, must be an lvalue of type uint32_t.
  298. * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
  299. * to native byte order. Evaluated one or two times.
  300. * @param ERROR Expression to be evaluated on invalid input,
  301. * typically a goto statement.
  302. */
  303. #define GET_UTF16(val, GET_16BIT, ERROR)\
  304. val = GET_16BIT;\
  305. {\
  306. unsigned int hi = val - 0xD800;\
  307. if (hi < 0x800) {\
  308. val = GET_16BIT - 0xDC00;\
  309. if (val > 0x3FFU || hi > 0x3FFU)\
  310. ERROR\
  311. val += (hi<<10) + 0x10000;\
  312. }\
  313. }\
  314. /**
  315. * @def PUT_UTF8(val, tmp, PUT_BYTE)
  316. * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
  317. * @param val is an input-only argument and should be of type uint32_t. It holds
  318. * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
  319. * val is given as a function it is executed only once.
  320. * @param tmp is a temporary variable and should be of type uint8_t. It
  321. * represents an intermediate value during conversion that is to be
  322. * output by PUT_BYTE.
  323. * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
  324. * It could be a function or a statement, and uses tmp as the input byte.
  325. * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
  326. * executed up to 4 times for values in the valid UTF-8 range and up to
  327. * 7 times in the general case, depending on the length of the converted
  328. * Unicode character.
  329. */
  330. #define PUT_UTF8(val, tmp, PUT_BYTE)\
  331. {\
  332. int bytes, shift;\
  333. uint32_t in = val;\
  334. if (in < 0x80) {\
  335. tmp = in;\
  336. PUT_BYTE\
  337. } else {\
  338. bytes = (av_log2(in) + 4) / 5;\
  339. shift = (bytes - 1) * 6;\
  340. tmp = (256 - (256 >> bytes)) | (in >> shift);\
  341. PUT_BYTE\
  342. while (shift >= 6) {\
  343. shift -= 6;\
  344. tmp = 0x80 | ((in >> shift) & 0x3f);\
  345. PUT_BYTE\
  346. }\
  347. }\
  348. }
  349. /**
  350. * @def PUT_UTF16(val, tmp, PUT_16BIT)
  351. * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
  352. * @param val is an input-only argument and should be of type uint32_t. It holds
  353. * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
  354. * val is given as a function it is executed only once.
  355. * @param tmp is a temporary variable and should be of type uint16_t. It
  356. * represents an intermediate value during conversion that is to be
  357. * output by PUT_16BIT.
  358. * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
  359. * in desired endianness. It could be a function or a statement, and uses tmp
  360. * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;"
  361. * PUT_BYTE will be executed 1 or 2 times depending on input character.
  362. */
  363. #define PUT_UTF16(val, tmp, PUT_16BIT)\
  364. {\
  365. uint32_t in = val;\
  366. if (in < 0x10000) {\
  367. tmp = in;\
  368. PUT_16BIT\
  369. } else {\
  370. tmp = 0xD800 | ((in - 0x10000) >> 10);\
  371. PUT_16BIT\
  372. tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
  373. PUT_16BIT\
  374. }\
  375. }\
  376. #include "mem.h"
  377. #ifdef HAVE_AV_CONFIG_H
  378. # include "internal.h"
  379. #endif /* HAVE_AV_CONFIG_H */
  380. #endif /* AVUTIL_COMMON_H */
  381. /*
  382. * The following definitions are outside the multiple inclusion guard
  383. * to ensure they are immediately available in intmath.h.
  384. */
  385. #ifndef av_log2
  386. # define av_log2 av_log2_c
  387. #endif
  388. #ifndef av_log2_16bit
  389. # define av_log2_16bit av_log2_16bit_c
  390. #endif
  391. #ifndef av_ceil_log2
  392. # define av_ceil_log2 av_ceil_log2_c
  393. #endif
  394. #ifndef av_clip
  395. # define av_clip av_clip_c
  396. #endif
  397. #ifndef av_clip_uint8
  398. # define av_clip_uint8 av_clip_uint8_c
  399. #endif
  400. #ifndef av_clip_int8
  401. # define av_clip_int8 av_clip_int8_c
  402. #endif
  403. #ifndef av_clip_uint16
  404. # define av_clip_uint16 av_clip_uint16_c
  405. #endif
  406. #ifndef av_clip_int16
  407. # define av_clip_int16 av_clip_int16_c
  408. #endif
  409. #ifndef av_clipl_int32
  410. # define av_clipl_int32 av_clipl_int32_c
  411. #endif
  412. #ifndef av_clip_uintp2
  413. # define av_clip_uintp2 av_clip_uintp2_c
  414. #endif
  415. #ifndef av_sat_add32
  416. # define av_sat_add32 av_sat_add32_c
  417. #endif
  418. #ifndef av_sat_dadd32
  419. # define av_sat_dadd32 av_sat_dadd32_c
  420. #endif
  421. #ifndef av_clipf
  422. # define av_clipf av_clipf_c
  423. #endif
  424. #ifndef av_popcount
  425. # define av_popcount av_popcount_c
  426. #endif
  427. #ifndef av_popcount64
  428. # define av_popcount64 av_popcount64_c
  429. #endif