Browse code

libavutil: document side effects of macros

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

Christophe Gisquet authored on 2014/07/11 03:49:06
Showing 1 changed files
... ...
@@ -50,6 +50,14 @@ typedef union {
50 50
  * AV_[RW][BLN](16|24|32|48|64) and AV_(COPY|SWAP|ZERO)(64|128) macros.
51 51
  * Preprocessor symbols must be defined, even if these are implemented
52 52
  * as inline functions.
53
+ *
54
+ * R/W means read/write, B/L/N means big/little/native endianness.
55
+ * The following macros require aligned access, compared to their
56
+ * unaligned variants: AV_(COPY|SWAP|ZERO)(64|128), AV_[RW]N[8-64]A.
57
+ * Incorrect usage may range from abysmal performance to crash
58
+ * depending on the platform.
59
+ *
60
+ * The unaligned variants are AV_[RW][BLN][8-64] and AV_COPY*U.
53 61
  */
54 62
 
55 63
 #ifdef HAVE_AV_CONFIG_H