[FFmpeg-devel] [PATCH] Improve documentation for libavutil/base64.h

[Michael Niedermayer]

On Sat, Feb 07, 2009 at 01:27:15AM +0100, Stefano Sabatini wrote:
> On date Wednesday 2009-01-28 01:03:29 +0100, Stefano Sabatini encoded:
> [...]
> > Index: libavutil/base64.h
> > ===================================================================
> > --- libavutil/base64.h	(revision 16838)
> > +++ libavutil/base64.h	(working copy)
> > @@ -25,16 +25,29 @@
> >  #include <stdint.h>
> >  
> >  /**
> > - * decodes base64
> > - * param order as strncpy()
> > + * Decodes the base64-encoded string in \p src and puts the decoded
> > + * data in \p dst.
> > + *
> > + * @param dst_size size in bytes of the \p dst buffer, it should 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
> > + * Encodes in base64 the data in \p src and puts the resulting string
> > + * in \p dst.
> > + *
> > + * @param dst_size size in bytes of the \p dst string
> > + * @warning While the encoded string size is 4/3 * N + 1, N being the
> > + * smaller multiple of 3 greater than or equal to \p src_size, you may
> > + * need to overallocate by few bytes the \p dst buffer, or the
> > + * function may fail.
> > + * @param src_size size in bytes of the \p src buffer
> > + * @return the string containing the encoded data, or NULL in case of
> > + * error
> >   */
> > -char *av_base64_encode(char * buf, int buf_len, const uint8_t * src, int len);
> > +char *av_base64_encode(char *dst, int dst_size, const uint8_t *src, int src_size);
> >  
> >  #endif /* AVUTIL_BASE64_H */
> 
> Ping?

rejected :)
"While the encoded string size is 4/3 * N + 1, N being the
smaller multiple of 3 greater than or equal to \p src_size"

that be confusing
i dont remember exactly but possibly i suggested a clean variant already
somewhere in the thread but then maybe not ...


[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Opposition brings concord. Out of discord comes the fairest harmony.
-- Heraclitus
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20090207/2d4531d5/attachment.pgp>