[FFmpeg-devel] [PATCH] Improve documentation for libavutil/base64.h
Sun Jan 25 00:27:23 CET 2009
On Sat, Jan 24, 2009 at 09:26:43PM +0100, Stefano Sabatini wrote:
> in the patch I'm also changing the parameter names, I think they're
> more meaningful now, also I'm applying the distinction between size
> (size in bytes of a data buffer) and lenght, intended as the number of
> characters in a string *but* the last one, which looks consistent with
> the terminology of the C language (sizeof(...), strlen(...)).
> FFmpeg = Fast and Fantastic Minimal Philosofic Entertaining God
> Index: libavutil/base64.h
> --- libavutil/base64.h (revision 16736)
> +++ libavutil/base64.h (working copy)
> @@ -25,16 +25,26 @@
> #include <stdint.h>
> - * decodes base64
> - * param order as strncpy()
> + * Decode the base-64 string in \p src and put the decoded data in \p
> + * dst.
av_base64_decode() decodes the base-64 string in ...
av_base64_decode() decode the base-64 string in ...
> + *
> + * @param dst_size size in bytes of the \p dst buffer, it has to be at
> + * least 3/4 of the length of \p src
> + * @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_length);
> +int av_base64_decode(uint8_t *dst, const char *src, int dst_size);
> - * encodes base64
> - * @param src data, not a string
> - * @param buf output string
> + * Encode in base-64 the data in \p src and put the resulting string
> + * in \p dst.
> + *
> + * @param dst_len lenght of the \p dst string, it has to be at least
> + * \p src_size * 4 / 3 + 12.
>From where do you have this number?
Is it due tp base64 or our implementation?
API and implementation are 2 seperate things. The API should
document exactly what is needed for both sides to interact, the implementation
details should not be documented in any way in the public header.
Michael GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB
While the State exists there can be no freedom; when there is freedom there
will be no State. -- Vladimir Lenin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Size: 189 bytes
Desc: Digital signature
More information about the ffmpeg-devel