Mercurial > libavutil.hg
changeset 660:396c27769b0e libavutil
Document the av_base64_encode/decode functions.
See the thread:
"[PATCH] Improve documentation for libavutil/base64.h".
| author | stefano |
|---|---|
| date | Sun, 08 Feb 2009 21:23:15 +0000 |
| parents | d3cd35bec3d0 |
| children | ac3fc6cb4781 |
| files | base64.h |
| diffstat | 1 files changed, 15 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/base64.h Sun Feb 08 21:19:04 2009 +0000 +++ b/base64.h Sun Feb 08 21:23:15 2009 +0000 @@ -24,15 +24,25 @@ #include <stdint.h> /** - * Decodes Base64. - * Parameter order is the same as strncpy(). + * Decodes the base64-encoded string in \p in and puts the decoded + * data in \p out. + * + * @param out_size size in bytes of the \p out buffer, it should be at + * least 3/4 of the length of \p in + * @return the number of bytes written, or a negative value in case of + * error */ int av_base64_decode(uint8_t *out, const char *in, int out_size); /** - * Encodes Base64. - * @param src data, not a string - * @param buf output string + * Encodes in base64 the data in \p in and puts the resulting string + * in \p out. + * + * @param out_size size in bytes of the \p out string, it should be at + * least ((\p in_size + 2) / 3) * 4 + 1 + * @param in_size size in bytes of the \p in buffer + * @return the string containing the encoded data, or NULL in case of + * error */ char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size);