annotate libavutil/common.h @ 9:ea1ba68cf0ed

update to match api changes + add sscc produced source
author Nina Engelhardt <nengel@mailbox.tu-berlin.de>
date Wed, 05 Jun 2013 14:43:26 +0200
parents
children
rev   line source
nengel@2 1 /*
nengel@2 2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
nengel@2 3 *
nengel@2 4 * This file is part of FFmpeg.
nengel@2 5 *
nengel@2 6 * FFmpeg is free software; you can redistribute it and/or
nengel@2 7 * modify it under the terms of the GNU Lesser General Public
nengel@2 8 * License as published by the Free Software Foundation; either
nengel@2 9 * version 2.1 of the License, or (at your option) any later version.
nengel@2 10 *
nengel@2 11 * FFmpeg is distributed in the hope that it will be useful,
nengel@2 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nengel@2 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
nengel@2 14 * Lesser General Public License for more details.
nengel@2 15 *
nengel@2 16 * You should have received a copy of the GNU Lesser General Public
nengel@2 17 * License along with FFmpeg; if not, write to the Free Software
nengel@2 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
nengel@2 19 */
nengel@2 20
nengel@2 21 /**
nengel@2 22 * @file
nengel@2 23 * common internal and external API header
nengel@2 24 */
nengel@2 25
nengel@2 26 #ifndef AVUTIL_COMMON_H
nengel@2 27 #define AVUTIL_COMMON_H
nengel@2 28
nengel@2 29 #include <ctype.h>
nengel@2 30 #include <errno.h>
nengel@2 31 #include <inttypes.h>
nengel@2 32 #include <limits.h>
nengel@2 33 #include <math.h>
nengel@2 34 #include <stdio.h>
nengel@2 35 #include <stdlib.h>
nengel@2 36 #include <string.h>
nengel@2 37 #include "attributes.h"
nengel@2 38
nengel@2 39 //rounded division & shift
nengel@2 40 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
nengel@2 41 /* assume b>0 */
nengel@2 42 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
nengel@2 43 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
nengel@2 44 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
nengel@2 45
nengel@2 46 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
nengel@2 47 #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
nengel@2 48 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
nengel@2 49 #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
nengel@2 50
nengel@2 51 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
nengel@2 52 #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
nengel@2 53 #define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
nengel@2 54
nengel@2 55 /* misc math functions */
nengel@2 56 extern const uint8_t ff_log2_tab[256];
nengel@2 57
nengel@2 58 static inline av_const int av_log2_c(unsigned int v)
nengel@2 59 {
nengel@2 60 int n = 0;
nengel@2 61 if (v & 0xffff0000) {
nengel@2 62 v >>= 16;
nengel@2 63 n += 16;
nengel@2 64 }
nengel@2 65 if (v & 0xff00) {
nengel@2 66 v >>= 8;
nengel@2 67 n += 8;
nengel@2 68 }
nengel@2 69 n += ff_log2_tab[v];
nengel@2 70
nengel@2 71 return n;
nengel@2 72 }
nengel@2 73
nengel@2 74 static inline av_const int av_log2_16bit_c(unsigned int v)
nengel@2 75 {
nengel@2 76 int n = 0;
nengel@2 77 if (v & 0xff00) {
nengel@2 78 v >>= 8;
nengel@2 79 n += 8;
nengel@2 80 }
nengel@2 81 n += ff_log2_tab[v];
nengel@2 82
nengel@2 83 return n;
nengel@2 84 }
nengel@2 85
nengel@2 86 #ifdef HAVE_AV_CONFIG_H
nengel@2 87 # include "config.h"
nengel@2 88 #endif
nengel@2 89
nengel@2 90 /**
nengel@2 91 * Clips a signed integer value into the amin-amax range.
nengel@2 92 * @param a value to clip
nengel@2 93 * @param amin minimum value of the clip range
nengel@2 94 * @param amax maximum value of the clip range
nengel@2 95 * @return clipped value
nengel@2 96 */
nengel@2 97 static inline av_const int av_clip(int a, int amin, int amax)
nengel@2 98 {
nengel@2 99 if (a < amin) return amin;
nengel@2 100 else if (a > amax) return amax;
nengel@2 101 else return a;
nengel@2 102 }
nengel@2 103
nengel@2 104 /**
nengel@2 105 * Clips a signed integer value into the 0-255 range.
nengel@2 106 * @param a value to clip
nengel@2 107 * @return clipped value
nengel@2 108 */
nengel@2 109 static inline av_const uint8_t av_clip_uint8(int a)
nengel@2 110 {
nengel@2 111 if (a&(~0xFF)) return (-a)>>31;
nengel@2 112 else return a;
nengel@2 113 }
nengel@2 114
nengel@2 115 /**
nengel@2 116 * Clips a signed integer value into the 0-65535 range.
nengel@2 117 * @param a value to clip
nengel@2 118 * @return clipped value
nengel@2 119 */
nengel@2 120 static inline av_const uint16_t av_clip_uint16(int a)
nengel@2 121 {
nengel@2 122 if (a&(~0xFFFF)) return (-a)>>31;
nengel@2 123 else return a;
nengel@2 124 }
nengel@2 125
nengel@2 126 /**
nengel@2 127 * Clips a signed integer value into the -32768,32767 range.
nengel@2 128 * @param a value to clip
nengel@2 129 * @return clipped value
nengel@2 130 */
nengel@2 131 static inline av_const int16_t av_clip_int16(int a)
nengel@2 132 {
nengel@2 133 if ((a+0x8000) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
nengel@2 134 else return a;
nengel@2 135 }
nengel@2 136
nengel@2 137 /**
nengel@2 138 * Clips a signed 64-bit integer value into the -2147483648,2147483647 range.
nengel@2 139 * @param a value to clip
nengel@2 140 * @return clipped value
nengel@2 141 */
nengel@2 142 static inline av_const int32_t av_clipl_int32(int64_t a)
nengel@2 143 {
nengel@2 144 if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (a>>63) ^ 0x7FFFFFFF;
nengel@2 145 else return a;
nengel@2 146 }
nengel@2 147
nengel@2 148 /**
nengel@2 149 * Clips a float value into the amin-amax range.
nengel@2 150 * @param a value to clip
nengel@2 151 * @param amin minimum value of the clip range
nengel@2 152 * @param amax maximum value of the clip range
nengel@2 153 * @return clipped value
nengel@2 154 */
nengel@2 155 static inline av_const float av_clipf(float a, float amin, float amax)
nengel@2 156 {
nengel@2 157 if (a < amin) return amin;
nengel@2 158 else if (a > amax) return amax;
nengel@2 159 else return a;
nengel@2 160 }
nengel@2 161
nengel@2 162 /** Computes ceil(log2(x)).
nengel@2 163 * @param x value used to compute ceil(log2(x))
nengel@2 164 * @return computed ceiling of log2(x)
nengel@2 165 */
nengel@2 166 static inline av_const int av_ceil_log2(int x)
nengel@2 167 {
nengel@2 168 return av_log2_c((x - 1) << 1);
nengel@2 169 }
nengel@2 170
nengel@2 171 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
nengel@2 172 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
nengel@2 173
nengel@2 174 /*!
nengel@2 175 * \def GET_UTF8(val, GET_BYTE, ERROR)
nengel@2 176 * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
nengel@2 177 * \param val is the output and should be of type uint32_t. It holds the converted
nengel@2 178 * UCS-4 character and should be a left value.
nengel@2 179 * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
nengel@2 180 * a function or a statement whose return value or evaluated value is of type
nengel@2 181 * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
nengel@2 182 * and up to 7 times in the general case.
nengel@2 183 * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
nengel@2 184 * from GET_BYTE. It should be a statement that jumps out of the macro,
nengel@2 185 * like exit(), goto, return, break, or continue.
nengel@2 186 */
nengel@2 187 #define GET_UTF8(val, GET_BYTE, ERROR)\
nengel@2 188 val= GET_BYTE;\
nengel@2 189 {\
nengel@2 190 int ones= 7 - av_log2(val ^ 255);\
nengel@2 191 if(ones==1)\
nengel@2 192 ERROR\
nengel@2 193 val&= 127>>ones;\
nengel@2 194 while(--ones > 0){\
nengel@2 195 int tmp= GET_BYTE - 128;\
nengel@2 196 if(tmp>>6)\
nengel@2 197 ERROR\
nengel@2 198 val= (val<<6) + tmp;\
nengel@2 199 }\
nengel@2 200 }
nengel@2 201
nengel@2 202 /*!
nengel@2 203 * \def GET_UTF16(val, GET_16BIT, ERROR)
nengel@2 204 * Converts a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form
nengel@2 205 * \param val is the output and should be of type uint32_t. It holds the converted
nengel@2 206 * UCS-4 character and should be a left value.
nengel@2 207 * \param GET_16BIT gets two bytes of UTF-16 encoded data converted to native endianness.
nengel@2 208 * It can be a function or a statement whose return value or evaluated value is of type
nengel@2 209 * uint16_t. It will be executed up to 2 times.
nengel@2 210 * \param ERROR action that should be taken when an invalid UTF-16 surrogate is
nengel@2 211 * returned from GET_BYTE. It should be a statement that jumps out of the macro,
nengel@2 212 * like exit(), goto, return, break, or continue.
nengel@2 213 */
nengel@2 214 #define GET_UTF16(val, GET_16BIT, ERROR)\
nengel@2 215 val = GET_16BIT;\
nengel@2 216 {\
nengel@2 217 unsigned int hi = val - 0xD800;\
nengel@2 218 if (hi < 0x800) {\
nengel@2 219 val = GET_16BIT - 0xDC00;\
nengel@2 220 if (val > 0x3FFU || hi > 0x3FFU)\
nengel@2 221 ERROR\
nengel@2 222 val += (hi<<10) + 0x10000;\
nengel@2 223 }\
nengel@2 224 }\
nengel@2 225
nengel@2 226 /*!
nengel@2 227 * \def PUT_UTF8(val, tmp, PUT_BYTE)
nengel@2 228 * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
nengel@2 229 * \param val is an input-only argument and should be of type uint32_t. It holds
nengel@2 230 * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
nengel@2 231 * val is given as a function it is executed only once.
nengel@2 232 * \param tmp is a temporary variable and should be of type uint8_t. It
nengel@2 233 * represents an intermediate value during conversion that is to be
nengel@2 234 * output by PUT_BYTE.
nengel@2 235 * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
nengel@2 236 * It could be a function or a statement, and uses tmp as the input byte.
nengel@2 237 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
nengel@2 238 * executed up to 4 times for values in the valid UTF-8 range and up to
nengel@2 239 * 7 times in the general case, depending on the length of the converted
nengel@2 240 * Unicode character.
nengel@2 241 */
nengel@2 242 #define PUT_UTF8(val, tmp, PUT_BYTE)\
nengel@2 243 {\
nengel@2 244 int bytes, shift;\
nengel@2 245 uint32_t in = val;\
nengel@2 246 if (in < 0x80) {\
nengel@2 247 tmp = in;\
nengel@2 248 PUT_BYTE\
nengel@2 249 } else {\
nengel@2 250 bytes = (av_log2(in) + 4) / 5;\
nengel@2 251 shift = (bytes - 1) * 6;\
nengel@2 252 tmp = (256 - (256 >> bytes)) | (in >> shift);\
nengel@2 253 PUT_BYTE\
nengel@2 254 while (shift >= 6) {\
nengel@2 255 shift -= 6;\
nengel@2 256 tmp = 0x80 | ((in >> shift) & 0x3f);\
nengel@2 257 PUT_BYTE\
nengel@2 258 }\
nengel@2 259 }\
nengel@2 260 }
nengel@2 261
nengel@2 262 /*!
nengel@2 263 * \def PUT_UTF16(val, tmp, PUT_16BIT)
nengel@2 264 * Converts a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
nengel@2 265 * \param val is an input-only argument and should be of type uint32_t. It holds
nengel@2 266 * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
nengel@2 267 * val is given as a function it is executed only once.
nengel@2 268 * \param tmp is a temporary variable and should be of type uint16_t. It
nengel@2 269 * represents an intermediate value during conversion that is to be
nengel@2 270 * output by PUT_16BIT.
nengel@2 271 * \param PUT_16BIT writes the converted UTF-16 data to any proper destination
nengel@2 272 * in desired endianness. It could be a function or a statement, and uses tmp
nengel@2 273 * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;"
nengel@2 274 * PUT_BYTE will be executed 1 or 2 times depending on input character.
nengel@2 275 */
nengel@2 276 #define PUT_UTF16(val, tmp, PUT_16BIT)\
nengel@2 277 {\
nengel@2 278 uint32_t in = val;\
nengel@2 279 if (in < 0x10000) {\
nengel@2 280 tmp = in;\
nengel@2 281 PUT_16BIT\
nengel@2 282 } else {\
nengel@2 283 tmp = 0xD800 | ((in - 0x10000) >> 10);\
nengel@2 284 PUT_16BIT\
nengel@2 285 tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
nengel@2 286 PUT_16BIT\
nengel@2 287 }\
nengel@2 288 }\
nengel@2 289
nengel@2 290
nengel@2 291
nengel@2 292 #include "mem.h"
nengel@2 293
nengel@2 294 #ifdef HAVE_AV_CONFIG_H
nengel@2 295 # include "internal.h"
nengel@2 296 #endif /* HAVE_AV_CONFIG_H */
nengel@2 297
nengel@2 298 #endif /* AVUTIL_COMMON_H */