diff options
author | James Almer <jamrial@gmail.com> | 2013-06-14 05:42:57 -0300 |
---|---|---|
committer | Michael Niedermayer <michaelni@gmx.at> | 2013-06-15 02:22:39 +0200 |
commit | c4f932f4d7450fb68bbc104b07d90896b37e9e92 (patch) | |
tree | f78d9b1bed0fe760390048b5d0776506cc8e426e | |
parent | 321906d3419b9d5a33fff36fb26618fd53ea7f94 (diff) | |
download | ffmpeg-c4f932f4d7450fb68bbc104b07d90896b37e9e92.tar.gz |
lavu/md5: Add doxy
Mostly a copy&paste from other hash functions, with changes
where required.
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
-rw-r--r-- | libavutil/md5.h | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/libavutil/md5.h b/libavutil/md5.h index 60daa93a3c..79702c88c2 100644 --- a/libavutil/md5.h +++ b/libavutil/md5.h @@ -36,10 +36,42 @@ extern const int av_md5_size; struct AVMD5; +/** + * Allocate an AVMD5 context. + */ struct AVMD5 *av_md5_alloc(void); + +/** + * Initialize MD5 hashing. + * + * @param ctx pointer to the function context (of size av_md5_size) + */ void av_md5_init(struct AVMD5 *ctx); + +/** + * Update hash value. + * + * @param ctx hash function context + * @param src input data to update hash with + * @param len input data length + */ void av_md5_update(struct AVMD5 *ctx, const uint8_t *src, int len); + +/** + * Finish hashing and output digest value. + * + * @param ctx hash function context + * @param dst buffer where output digest value is stored + */ void av_md5_final(struct AVMD5 *ctx, uint8_t *dst); + +/** + * Hash an array of data. + * + * @param dst The output buffer to write the digest into + * @param src The data to hash + * @param len The length of the data, in bytes + */ void av_md5_sum(uint8_t *dst, const uint8_t *src, const int len); /** |