Document ff_des_encdec
authorReimar Döffinger <Reimar.Doeffinger@gmx.de>
Sat, 20 Oct 2007 14:45:07 +0000 (14:45 +0000)
committerReimar Döffinger <Reimar.Doeffinger@gmx.de>
Sat, 20 Oct 2007 14:45:07 +0000 (14:45 +0000)
Originally committed as revision 10822 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavutil/des.h

index d9fe7a4..66dac3b 100644 (file)
 #ifndef FFMPEG_DES_H
 #define FFMPEG_DES_H
 
+/**
+ * \brief en- or decrypt an 64-bit block of data with DES
+ * \param in data to process.
+ * \param key key to use for en-/decryption.
+ * \param decrypt if 0 encrypt, else decrypt.
+ * \return processed data
+ *
+ * If your input data is in 8-bit blocks treat it as big-endian
+ * (use e.g. AV_RB64 and AV_WB64).
+ */
 uint64_t ff_des_encdec(uint64_t in, uint64_t key, int decrypt);
 
 #endif /* FFMPEG_DES_H */