license header consistency cosmetics
[ffmpeg.git] / libavutil / integer.h
index 6680e79..2a1df34 100644 (file)
@@ -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
- *
  */
 
 /**
@@ -29,6 +28,8 @@
 #ifndef INTEGER_H
 #define INTEGER_H
 
+#include <stdint.h>
+
 #define AV_INTEGER_SIZE 8
 
 typedef struct AVInteger{
@@ -37,6 +38,11 @@ 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);