a few words about libavutil

Originally committed as revision 7851 to svn://svn.ffmpeg.org/ffmpeg/trunk

1 files changed, 37 insertions, 0 deletions

diff --git a/doc/avutil.txt b/doc/avutil.txt
new file mode 100644
index 0000000000..c62e361a3a
--- /dev/null
+++ b/doc/avutil.txt
@@ -0,0 +1,37 @@
+AVUtil
+======
+libavutil is a small lightweight library of generally usefull functions
+it is not a library of code which is needed by both libavcodec and libavformat
+
+
+Overview:
+=========
+adler32.c               adler32 checksum
+aes.c                   AES encryption and decryption
+fifo.c                  resizeable first in first out buffer
+intfloat_readwrite.c    portable reading and writing of floating point values
+log.c                   "printf" with context and level
+md5.c                   MD5 Message-Digest Algorithm
+rational.c              code to perform exact calculation with rational numbers
+tree.c                  generic AVL tree
+crc.c                   generic CRC checksumming code
+integer.c               128bit integer math
+lls.c
+mathematics.c           greatest common divisor, integer sqrt, integer log2, ...
+mem.c                   memory allocation routines with guranteed alignment
+softfloat.c
+
+Headers:
+bswap.h                 big/little/native endian conversation code
+x86_cpu.h               a few usefull macros for unifying x86-64 and x86-32 code
+avutil.h
+common.h
+intreadwrite.h          reading and writing of unaligned big, little and native endian integers
+
+
+Goals:
+======
+* Modular (few interdependancies and the possibility of disabling individual parts during ./configure)
+* Small (source and object)
+* Efficient (low cpu and memory usage)
+* Usefull (avoid useless features almost noone needs)