xref: /btstack/src/btstack_base64_decoder.h (revision 9ea49f801ca9d49a65636d9ce376c8a09ffa18c0)
1 /*
2  * Copyright (C) 2018 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /**
39  * @title base64 Decoder
40  *
41  */
42 
43 #ifndef BTSTACK_BASE_64_DECODER_H
44 #define BTSTACK_BASE_64_DECODER_H
45 
46 #include <stdint.h>
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 typedef struct {
53     uint8_t pos;
54     uint8_t value;
55 } btstack_base64_decoder_t;
56 
57 /* API_START */
58 
59 #define BTSTACK_BASE64_DECODER_MORE     -1
60 #define BTSTACK_BASE64_DECODER_COMPLETE -2
61 #define BTSTACK_BASE64_DECODER_INVALID  -3
62 #define BTSTACK_BASE64_DECODER_FULL     -4
63 
64 /**
65  * @brief Initialize base64 decoder
66  * @param context
67  */
68 void btstack_base64_decoder_init(btstack_base64_decoder_t * context);
69 
70 /**
71  * @brief Decode single byte
72  * @brief context
73  * @returns value, or BTSTACK_BASE64_DECODER_MORE, BTSTACK_BASE64_DECODER_COMPLETE, BTSTACK_BASE64_DECODER_INVALID
74  */
75 int  btstack_base64_decoder_process_byte(btstack_base64_decoder_t * context, uint8_t c);
76 
77 /**
78  * @brief Decode block
79  * @brief input_data base64 encoded message
80  * @brief input_size
81  * @breif output_buffer
82  * @brief output_max_size
83  * @return output_size or BTSTACK_BASE64_DECODER_INVALID, BTSTACK_BASE64_DECODER_FULL
84  */
85 int btstack_base64_decoder_process_block(const uint8_t * input_data, uint32_t input_size, uint8_t * output_buffer, uint32_t output_max_size);
86 
87 /* API_END */
88 
89 #if defined __cplusplus
90 }
91 #endif
92 
93 #endif // BTSTACK_BASE_64_DECODER_H