ffmpeg.libavutil.base64 source code

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