lavu/base64: add AV_BASE64_DECODE_SIZE() macro
[ffmpeg.git] / libavutil / base64.h
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
21 #ifndef AVUTIL_BASE64_H
22 #define AVUTIL_BASE64_H
23
24 #include <stdint.h>
25
26 /**
27  * @defgroup lavu_base64 Base64
28  * @ingroup lavu_crypto
29  * @{
30  */
31
32 /**
33  * Decode a base64-encoded string.
34  *
35  * @param out      buffer for decoded data
36  * @param in       null-terminated input string
37  * @param out_size size in bytes of the out buffer, must be at
38  *                 least 3/4 of the length of in, that is AV_BASE64_DECODE_SIZE(strlen(in))
39  * @return         number of bytes written, or a negative value in case of
40  *                 invalid input
41  */
42 int av_base64_decode(uint8_t *out, const char *in, int out_size);
43
44 /**
45  * Calculate the output size in bytes needed to decode a base64 string
46  * with length x to a data buffer.
47  */
48 #define AV_BASE64_DECODE_SIZE(x) ((x) * 3LL / 4)
49
50 /**
51  * Encode data to base64 and null-terminate.
52  *
53  * @param out      buffer for encoded data
54  * @param out_size size in bytes of the out buffer (including the
55  *                 null terminator), must be at least AV_BASE64_SIZE(in_size)
56  * @param in       input buffer containing the data to encode
57  * @param in_size  size in bytes of the in buffer
58  * @return         out or NULL in case of error
59  */
60 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size);
61
62 /**
63  * Calculate the output size needed to base64-encode x bytes to a
64  * null-terminated string.
65  */
66 #define AV_BASE64_SIZE(x)  (((x)+2) / 3 * 4 + 1)
67
68  /**
69   * @}
70   */
71
72 #endif /* AVUTIL_BASE64_H */