Cosmetics: add do {} while 0 to macro.
[ffmpeg.git] / libavutil / base64.c
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 /**
22  * @file
23  * @brief Base64 encode/decode
24  * @author Ryan Martell <rdm4@martellventures.com> (with lots of Michael)
25  */
26
27 #include "common.h"
28 #include "base64.h"
29 #include "intreadwrite.h"
30
31 /* ---------------- private code */
32 static const uint8_t map2[256] =
33 {
34     0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
35     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
36     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
37     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
38     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
39     0xff, 0xff, 0xff,
40
41     0x3e, 0xff, 0xff, 0xff, 0x3f, 0x34, 0x35, 0x36,
42     0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0xff,
43     0xff, 0xff, 0xfe, 0xff, 0xff, 0xff, 0x00, 0x01,
44     0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09,
45     0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11,
46     0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19,
47     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1a, 0x1b,
48     0x1c, 0x1d, 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23,
49     0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b,
50     0x2c, 0x2d, 0x2e, 0x2f, 0x30, 0x31, 0x32, 0x33,
51
52                       0xff, 0xff, 0xff, 0xff, 0xff,
53     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
54     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
55     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
56     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
57     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
58     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
59     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
60     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
61     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
62     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
63     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
64     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
65     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
66     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
67     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
68     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
69 };
70
71 #define BASE64_DEC_STEP(i) do { \
72     bits = map2[in[i]]; \
73     if (bits & 0x80) \
74         goto out; \
75     v = (v << 6) + bits; \
76     if (i & 3) \
77         *dst++ = v >> (6 - 2 * (i & 3)); \
78 } while(0)
79
80 int av_base64_decode(uint8_t *out, const char *in_str, int out_size)
81 {
82     int v;
83     uint8_t *dst = out;
84     uint8_t *end = out + out_size;
85     // no sign extension
86     const uint8_t *in = in_str;
87     unsigned bits = 0xff;
88
89     v = 0;
90     while (end - dst > 2) {
91         BASE64_DEC_STEP(0);
92         BASE64_DEC_STEP(1);
93         BASE64_DEC_STEP(2);
94         BASE64_DEC_STEP(3);
95         in += 4;
96     }
97     if (end - dst) {
98         BASE64_DEC_STEP(0);
99         BASE64_DEC_STEP(1);
100         if (end - dst) {
101             BASE64_DEC_STEP(2);
102             in++;
103         }
104         in += 2;
105     }
106     while (1) {
107         BASE64_DEC_STEP(0);
108         in++;
109         BASE64_DEC_STEP(0);
110         in++;
111         BASE64_DEC_STEP(0);
112         in++;
113         BASE64_DEC_STEP(0);
114         in++;
115     }
116
117 out:
118     return bits & 1 ? -1 : dst - out;
119 }
120
121 /*****************************************************************************
122 * b64_encode: Stolen from VLC's http.c.
123 * Simplified by Michael.
124 * Fixed edge cases and made it work from data (vs. strings) by Ryan.
125 *****************************************************************************/
126
127 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size)
128 {
129     static const char b64[] =
130         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
131     char *ret, *dst;
132     unsigned i_bits = 0;
133     int i_shift = 0;
134     int bytes_remaining = in_size;
135
136     if (in_size >= UINT_MAX / 4 ||
137         out_size < AV_BASE64_SIZE(in_size))
138         return NULL;
139     ret = dst = out;
140     while (bytes_remaining > 3) {
141         i_bits = AV_RB32(in);
142         in += 3; bytes_remaining -= 3;
143         *dst++ = b64[ i_bits>>26        ];
144         *dst++ = b64[(i_bits>>20) & 0x3F];
145         *dst++ = b64[(i_bits>>14) & 0x3F];
146         *dst++ = b64[(i_bits>>8 ) & 0x3F];
147     }
148     i_bits = 0;
149     while (bytes_remaining) {
150         i_bits = (i_bits << 8) + *in++;
151         bytes_remaining--;
152         i_shift += 8;
153     }
154     while (i_shift > 0) {
155         *dst++ = b64[(i_bits << 6 >> i_shift) & 0x3f];
156         i_shift -= 6;
157     }
158     while ((dst - ret) & 3)
159         *dst++ = '=';
160     *dst = '\0';
161
162     return ret;
163 }
164
165 #ifdef TEST
166 // LCOV_EXCL_START
167
168 #undef printf
169
170 #define MAX_DATA_SIZE    1024
171 #define MAX_ENCODED_SIZE 2048
172
173 static int test_encode_decode(const uint8_t *data, unsigned int data_size,
174                               const char *encoded_ref)
175 {
176     char  encoded[MAX_ENCODED_SIZE];
177     uint8_t data2[MAX_DATA_SIZE];
178     int data2_size, max_data2_size = MAX_DATA_SIZE;
179
180     if (!av_base64_encode(encoded, MAX_ENCODED_SIZE, data, data_size)) {
181         printf("Failed: cannot encode the input data\n");
182         return 1;
183     }
184     if (encoded_ref && strcmp(encoded, encoded_ref)) {
185         printf("Failed: encoded string differs from reference\n"
186                "Encoded:\n%s\nReference:\n%s\n", encoded, encoded_ref);
187         return 1;
188     }
189
190     if ((data2_size = av_base64_decode(data2, encoded, max_data2_size)) != data_size) {
191         printf("Failed: cannot decode the encoded string\n"
192                "Encoded:\n%s\n", encoded);
193         return 1;
194     }
195     if ((data2_size = av_base64_decode(data2, encoded, data_size)) != data_size) {
196         printf("Failed: cannot decode with minimal buffer\n"
197                "Encoded:\n%s\n", encoded);
198         return 1;
199     }
200     if (memcmp(data2, data, data_size)) {
201         printf("Failed: encoded/decoded data differs from original data\n");
202         return 1;
203     }
204     if (av_base64_decode(NULL, encoded, 0) != 0) {
205         printf("Failed: decode to NULL buffer\n");
206         return 1;
207     }
208     if (strlen(encoded)) {
209         char *end = strchr(encoded, '=');
210         if (!end)
211             end = encoded + strlen(encoded) - 1;
212         *end = '%';
213         if (av_base64_decode(NULL, encoded, 0) >= 0) {
214             printf("Failed: error detection\n");
215             return 1;
216         }
217     }
218
219     printf("Passed!\n");
220     return 0;
221 }
222
223 int main(int argc, char ** argv)
224 {
225     int i, error_count = 0;
226     struct test {
227         const uint8_t *data;
228         const char *encoded_ref;
229     } tests[] = {
230         { "",        ""},
231         { "1",       "MQ=="},
232         { "22",      "MjI="},
233         { "333",     "MzMz"},
234         { "4444",    "NDQ0NA=="},
235         { "55555",   "NTU1NTU="},
236         { "666666",  "NjY2NjY2"},
237         { "abc:def", "YWJjOmRlZg=="},
238     };
239     char in[1024], out[2048];
240
241     printf("Encoding/decoding tests\n");
242     for (i = 0; i < FF_ARRAY_ELEMS(tests); i++)
243         error_count += test_encode_decode(tests[i].data, strlen(tests[i].data), tests[i].encoded_ref);
244
245     if (argc>1 && !strcmp(argv[1], "-t")) {
246         memset(in, 123, sizeof(in));
247         for(i=0; i<10000; i++){
248             START_TIMER
249             av_base64_encode(out, sizeof(out), in, sizeof(in));
250             STOP_TIMER("encode")
251         }
252         for(i=0; i<10000; i++){
253             START_TIMER
254             av_base64_decode(in, out, sizeof(in));
255             STOP_TIMER("decode")
256         }
257
258         for(i=0; i<10000; i++){
259             START_TIMER
260             av_base64_decode(NULL, out, 0);
261             STOP_TIMER("syntax check")
262         }
263     }
264
265     return error_count;
266 }
267
268 // LCOV_EXCL_STOP
269 #endif