comparison adler32.h @ 959:082e51609a90 libavutil

adler32: add API documentation

958:f789d66969a4

#define AVUTIL_ADLER32_H

#include <stdint.h>
#include "attributes.h"

unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf,
                                unsigned int len) av_pure;

#endif /* AVUTIL_ADLER32_H */

959:082e51609a90

#define AVUTIL_ADLER32_H

#include <stdint.h>
#include "attributes.h"

/**
 * Calculate the Adler32 checksum of a buffer.
 *
 * Passing the return value to a subsequent av_adler32_update() call
 * allows the checksum of multiple buffers to be calculated as though
 * they were concatenated.
 *
 * @param adler initial checksum value
 * @param buf   pointer to input buffer
 * @param len   size of input buffer
 * @return      updated checksum
 */
unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf,
                                unsigned int len) av_pure;

#endif /* AVUTIL_ADLER32_H */