cosmetic

[ffmpeg] / libavutil / integer.h

diff --git a/libavutil/integer.h b/libavutil/integer.h
index 1f15225516dd7e4534b5ebf530d728d80ceb9557..f539125d149860cb942c7e7990821e4ace53821e 100644 (file)
--- a/libavutil/integer.h
+++ b/libavutil/integer.h
@@ -17,7 +17,6 @@
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- *
  */
 
 /**
@@ -26,8 +25,10 @@
  * @author Michael Niedermayer <michaelni@gmx.at>
  */
 
-#ifndef INTEGER_H
-#define INTEGER_H
+#ifndef FFMPEG_INTEGER_H
+#define FFMPEG_INTEGER_H
+
+#include <stdint.h>
 
 #define AV_INTEGER_SIZE 8
 
@@ -37,9 +38,23 @@ typedef struct AVInteger{
 
 AVInteger av_add_i(AVInteger a, AVInteger b);
 AVInteger av_sub_i(AVInteger a, AVInteger b);
+
+/**
+ * returns the rounded down value of the logarithm of base 2 of the given AVInteger.
+ * this is simply the index of the most significant bit which is 1. Or 0 of all bits are 0
+ */
 int av_log2_i(AVInteger a);
 AVInteger av_mul_i(AVInteger a, AVInteger b);
+
+/**
+ * returns 0 if a==b, 1 if a>b and -1 if a<b.
+ */
 int av_cmp_i(AVInteger a, AVInteger b);
+
+/**
+ * bitwise shift.
+ * @param s the number of bits by which the value should be shifted right, may be negative for shifting left
+ */
 AVInteger av_shr_i(AVInteger a, int s);
 
 /**
@@ -52,7 +67,17 @@ AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b);
  * returns a/b.
  */
 AVInteger av_div_i(AVInteger a, AVInteger b);
+
+/**
+ * converts the given int64_t to an AVInteger.
+ */
 AVInteger av_int2i(int64_t a);
+
+/**
+ * converts the given AVInteger to an int64_t.
+ * if the AVInteger is too large to fit into an int64_t,
+ * then only the least significant 64bit will be used
+ */
 int64_t av_i2int(AVInteger a);
 
-#endif // INTEGER_H
+#endif /* FFMPEG_INTEGER_H */