Mercurial > libavutil.hg
annotate base64.h @ 958:f789d66969a4 libavutil
base64: improve documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:32 +0000 |
parents | e34e8d654ded |
children |
rev | line source |
---|---|
244 | 1 /* |
2 * Copyright (c) 2006 Ryan Martell. (rdm4@martellventures.com) | |
3 * | |
4 * This file is part of FFmpeg. | |
5 * | |
6 * FFmpeg is free software; you can redistribute it and/or | |
7 * modify it under the terms of the GNU Lesser General Public | |
8 * License as published by the Free Software Foundation; either | |
9 * version 2.1 of the License, or (at your option) any later version. | |
10 * | |
11 * FFmpeg is distributed in the hope that it will be useful, | |
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 * Lesser General Public License for more details. | |
15 * | |
16 * You should have received a copy of the GNU Lesser General Public | |
17 * License along with FFmpeg; if not, write to the Free Software | |
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
19 */ | |
20 | |
567 | 21 #ifndef AVUTIL_BASE64_H |
22 #define AVUTIL_BASE64_H | |
344 | 23 |
343 | 24 #include <stdint.h> |
25 | |
244 | 26 /** |
958 | 27 * Decode a base64-encoded string. |
660 | 28 * |
958 | 29 * @param out buffer for decoded data |
30 * @param in null-terminated input string | |
31 * @param out_size size in bytes of the out buffer, must be at | |
32 * least 3/4 of the length of in | |
33 * @return number of bytes written, or a negative value in case of | |
34 * invalid input | |
244 | 35 */ |
659
d3cd35bec3d0
Cosmetics: "* out" -> "*out" for consistency with the other
stefano
parents:
658
diff
changeset
|
36 int av_base64_decode(uint8_t *out, const char *in, int out_size); |
244 | 37 |
38 /** | |
958 | 39 * Encode data to base64 and null-terminate. |
660 | 40 * |
958 | 41 * @param out buffer for encoded data |
42 * @param out_size size in bytes of the output buffer, must be at | |
43 * least AV_BASE64_SIZE(in_size) | |
44 * @param in_size size in bytes of the 'in' buffer | |
45 * @return 'out' or NULL in case of error | |
244 | 46 */ |
658
cc7c1ea68a52
Cosmetics: rename the "size" parameter of av_base64_encode() to "in_size".
stefano
parents:
657
diff
changeset
|
47 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size); |
244 | 48 |
929 | 49 /** |
50 * Calculate the output size needed to base64-encode x bytes. | |
51 */ | |
52 #define AV_BASE64_SIZE(x) (((x)+2) / 3 * 4 + 1) | |
53 | |
567 | 54 #endif /* AVUTIL_BASE64_H */ |