Optimized base64 decode by writing 3 bytes at once.
[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 ## i; \
75     v = i ? (v << 6) + bits : bits; \
76 } while(0)
77
78 int av_base64_decode(uint8_t *out, const char *in_str, int out_size)
79 {
80     uint8_t *dst = out;
81     uint8_t *end = out + out_size;
82     // no sign extension
83     const uint8_t *in = in_str;
84     unsigned bits = 0xff;
85     unsigned v;
86
87     while (end - dst > 3) {
88         BASE64_DEC_STEP(0);
89         BASE64_DEC_STEP(1);
90         BASE64_DEC_STEP(2);
91         BASE64_DEC_STEP(3);
92         // Using AV_WB32 directly confuses compiler
93         v = av_be2ne32(v) >> 8;
94         AV_WN32(dst, v);
95         dst += 3;
96         in += 4;
97     }
98     if (end - dst) {
99         BASE64_DEC_STEP(0);
100         BASE64_DEC_STEP(1);
101         BASE64_DEC_STEP(2);
102         BASE64_DEC_STEP(3);
103         *dst++ = v >> 16;
104         if (end - dst)
105             *dst++ = v >> 8;
106         if (end - dst)
107             *dst++ = v;
108         in += 4;
109     }
110     while (1) {
111         BASE64_DEC_STEP(0);
112         in++;
113         BASE64_DEC_STEP(0);
114         in++;
115         BASE64_DEC_STEP(0);
116         in++;
117         BASE64_DEC_STEP(0);
118         in++;
119     }
120
121 out3:
122     *dst++ = v >> 10;
123     v <<= 2;
124 out2:
125     *dst++ = v >> 4;
126 out1:
127 out0:
128     return bits & 1 ? -1 : dst - out;
129 }
130
131 /*****************************************************************************
132 * b64_encode: Stolen from VLC's http.c.
133 * Simplified by Michael.
134 * Fixed edge cases and made it work from data (vs. strings) by Ryan.
135 *****************************************************************************/
136
137 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size)
138 {
139     static const char b64[] =
140         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
141     char *ret, *dst;
142     unsigned i_bits = 0;
143     int i_shift = 0;
144     int bytes_remaining = in_size;
145
146     if (in_size >= UINT_MAX / 4 ||
147         out_size < AV_BASE64_SIZE(in_size))
148         return NULL;
149     ret = dst = out;
150     while (bytes_remaining > 3) {
151         i_bits = AV_RB32(in);
152         in += 3; bytes_remaining -= 3;
153         *dst++ = b64[ i_bits>>26        ];
154         *dst++ = b64[(i_bits>>20) & 0x3F];
155         *dst++ = b64[(i_bits>>14) & 0x3F];
156         *dst++ = b64[(i_bits>>8 ) & 0x3F];
157     }
158     i_bits = 0;
159     while (bytes_remaining) {
160         i_bits = (i_bits << 8) + *in++;
161         bytes_remaining--;
162         i_shift += 8;
163     }
164     while (i_shift > 0) {
165         *dst++ = b64[(i_bits << 6 >> i_shift) & 0x3f];
166         i_shift -= 6;
167     }
168     while ((dst - ret) & 3)
169         *dst++ = '=';
170     *dst = '\0';
171
172     return ret;
173 }
174
175 #ifdef TEST
176 // LCOV_EXCL_START
177
178 #undef printf
179
180 #define MAX_DATA_SIZE    1024
181 #define MAX_ENCODED_SIZE 2048
182
183 static int test_encode_decode(const uint8_t *data, unsigned int data_size,
184                               const char *encoded_ref)
185 {
186     char  encoded[MAX_ENCODED_SIZE];
187     uint8_t data2[MAX_DATA_SIZE];
188     int data2_size, max_data2_size = MAX_DATA_SIZE;
189
190     if (!av_base64_encode(encoded, MAX_ENCODED_SIZE, data, data_size)) {
191         printf("Failed: cannot encode the input data\n");
192         return 1;
193     }
194     if (encoded_ref && strcmp(encoded, encoded_ref)) {
195         printf("Failed: encoded string differs from reference\n"
196                "Encoded:\n%s\nReference:\n%s\n", encoded, encoded_ref);
197         return 1;
198     }
199
200     if ((data2_size = av_base64_decode(data2, encoded, max_data2_size)) != data_size) {
201         printf("Failed: cannot decode the encoded string\n"
202                "Encoded:\n%s\n", encoded);
203         return 1;
204     }
205     if ((data2_size = av_base64_decode(data2, encoded, data_size)) != data_size) {
206         printf("Failed: cannot decode with minimal buffer\n"
207                "Encoded:\n%s\n", encoded);
208         return 1;
209     }
210     if (memcmp(data2, data, data_size)) {
211         printf("Failed: encoded/decoded data differs from original data\n");
212         return 1;
213     }
214     if (av_base64_decode(NULL, encoded, 0) != 0) {
215         printf("Failed: decode to NULL buffer\n");
216         return 1;
217     }
218     if (strlen(encoded)) {
219         char *end = strchr(encoded, '=');
220         if (!end)
221             end = encoded + strlen(encoded) - 1;
222         *end = '%';
223         if (av_base64_decode(NULL, encoded, 0) >= 0) {
224             printf("Failed: error detection\n");
225             return 1;
226         }
227     }
228
229     printf("Passed!\n");
230     return 0;
231 }
232
233 int main(int argc, char ** argv)
234 {
235     int i, error_count = 0;
236     struct test {
237         const uint8_t *data;
238         const char *encoded_ref;
239     } tests[] = {
240         { "",        ""},
241         { "1",       "MQ=="},
242         { "22",      "MjI="},
243         { "333",     "MzMz"},
244         { "4444",    "NDQ0NA=="},
245         { "55555",   "NTU1NTU="},
246         { "666666",  "NjY2NjY2"},
247         { "abc:def", "YWJjOmRlZg=="},
248     };
249     char in[1024], out[2048];
250
251     printf("Encoding/decoding tests\n");
252     for (i = 0; i < FF_ARRAY_ELEMS(tests); i++)
253         error_count += test_encode_decode(tests[i].data, strlen(tests[i].data), tests[i].encoded_ref);
254
255     if (argc>1 && !strcmp(argv[1], "-t")) {
256         memset(in, 123, sizeof(in));
257         for(i=0; i<10000; i++){
258             START_TIMER
259             av_base64_encode(out, sizeof(out), in, sizeof(in));
260             STOP_TIMER("encode")
261         }
262         for(i=0; i<10000; i++){
263             START_TIMER
264             av_base64_decode(in, out, sizeof(in));
265             STOP_TIMER("decode")
266         }
267
268         for(i=0; i<10000; i++){
269             START_TIMER
270             av_base64_decode(NULL, out, 0);
271             STOP_TIMER("syntax check")
272         }
273     }
274
275     return error_count;
276 }
277
278 // LCOV_EXCL_STOP
279 #endif