RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

base64: improve documentation 

Originally committed as revision 23905 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Måns Rullgård 2010-06-30 20:09:32 +00:00
parent 49bd8e4b84
commit ffd31cfef3
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
libavutil/base64.h
View File

@ -24,25 +24,25 @@
#include <stdint.h> #include <stdint.h>
/** /**
* Decode the base64-encoded string in in and put the decoded * Decode a base64-encoded string.
* data in out.
* *
* @param out_size size in bytes of the out buffer, it should be at * @param out buffer for decoded data
* @param in null-terminated input string
* @param out_size size in bytes of the out buffer, must be at
* least 3/4 of the length of in * least 3/4 of the length of in
* @return the number of bytes written, or a negative value in case of * @return number of bytes written, or a negative value in case of
* error * invalid input
*/ */
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);
/** /**
* Encode in base64 the data in in and put the resulting string * Encode data to base64 and null-terminate.
* in out.
* *
* @param out_size size in bytes of the out string, it should be at * @param out buffer for encoded data
* least ((in_size + 2) / 3) * 4 + 1 * @param out_size size in bytes of the output buffer, must be at
* @param in_size size in bytes of the in buffer * least AV_BASE64_SIZE(in_size)
* @return the string containing the encoded data, or NULL in case of * @param in_size size in bytes of the 'in' buffer
* error * @return 'out' 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);