RepoMirrors/ffmpeg
1
0
Fork 0
mirror of https://git.ffmpeg.org/ffmpeg.git synced 2024-12-23 07:42:51 +00:00
Code Issues Projects Releases Wiki Activity

Document the av_base64_encode/decode functions.

Browse Source 
See the thread:
"[PATCH] Improve documentation for libavutil/base64.h".

Originally committed as revision 17074 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Stefano Sabatini 2009-02-08 21:23:15 +00:00
parent 4d8eb2e899
commit 74afdc5535
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
libavutil/base64.h
View File

@ -24,15 +24,25 @@
#include <stdint.h> #include <stdint.h>
/** /**
* Decodes Base64. * Decodes the base64-encoded string in \p in and puts the decoded
* Parameter order is the same as strncpy(). * 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); int av_base64_decode(uint8_t *out, const char *in, int out_size);
/** /**
* Encodes Base64. * Encodes in base64 the data in \p in and puts the resulting string
* @param src data, not a string * in \p out.
* @param buf output string *
* @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); char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size);