OLD | NEW |
1 /** | 1 /** |
2 * \file lzma/stream_flags.h | 2 * \file lzma/stream_flags.h |
3 * \brief .xz Stream Header and Stream Footer encoder and decoder | 3 * \brief .xz Stream Header and Stream Footer encoder and decoder |
4 */ | 4 */ |
5 | 5 |
6 /* | 6 /* |
7 * Author: Lasse Collin | 7 * Author: Lasse Collin |
8 * | 8 * |
9 * This file has been put into the public domain. | 9 * This file has been put into the public domain. |
10 * You can do whatever you want with this file. | 10 * You can do whatever you want with this file. |
(...skipping 73 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
84 * names of these variables may change. | 84 * names of these variables may change. |
85 * | 85 * |
86 * (We will never be able to use all of these since Stream Flags | 86 * (We will never be able to use all of these since Stream Flags |
87 * is just two bytes plus Backward Size of four bytes. But it's | 87 * is just two bytes plus Backward Size of four bytes. But it's |
88 * nice to have the proper types when they are needed.) | 88 * nice to have the proper types when they are needed.) |
89 */ | 89 */ |
90 lzma_reserved_enum reserved_enum1; | 90 lzma_reserved_enum reserved_enum1; |
91 lzma_reserved_enum reserved_enum2; | 91 lzma_reserved_enum reserved_enum2; |
92 lzma_reserved_enum reserved_enum3; | 92 lzma_reserved_enum reserved_enum3; |
93 lzma_reserved_enum reserved_enum4; | 93 lzma_reserved_enum reserved_enum4; |
94 lzma_reserved_enum reserved_enum5; | |
95 lzma_reserved_enum reserved_enum6; | |
96 lzma_bool reserved_bool1; | 94 lzma_bool reserved_bool1; |
97 lzma_bool reserved_bool2; | 95 lzma_bool reserved_bool2; |
98 lzma_bool reserved_bool3; | 96 lzma_bool reserved_bool3; |
99 lzma_bool reserved_bool4; | 97 lzma_bool reserved_bool4; |
100 lzma_bool reserved_bool5; | 98 lzma_bool reserved_bool5; |
101 lzma_bool reserved_bool6; | 99 lzma_bool reserved_bool6; |
102 lzma_bool reserved_bool7; | 100 lzma_bool reserved_bool7; |
103 lzma_bool reserved_bool8; | 101 lzma_bool reserved_bool8; |
104 uint32_t reserved_int1; | 102 uint32_t reserved_int1; |
105 uint32_t reserved_int2; | 103 uint32_t reserved_int2; |
106 uint32_t reserved_int3; | |
107 uint32_t reserved_int4; | |
108 | 104 |
109 } lzma_stream_flags; | 105 } lzma_stream_flags; |
110 | 106 |
111 | 107 |
112 /** | 108 /** |
113 * \brief Encode Stream Header | 109 * \brief Encode Stream Header |
114 * | 110 * |
115 * \param options Stream Header options to be encoded. | 111 * \param options Stream Header options to be encoded. |
116 * options->backward_size is ignored and doesn't | 112 * options->backward_size is ignored and doesn't |
117 * need to be initialized. | 113 * need to be initialized. |
(...skipping 23 matching lines...) Expand all Loading... |
141 * - LZMA_PROG_ERROR: Invalid options. | 137 * - LZMA_PROG_ERROR: Invalid options. |
142 */ | 138 */ |
143 extern LZMA_API(lzma_ret) lzma_stream_footer_encode( | 139 extern LZMA_API(lzma_ret) lzma_stream_footer_encode( |
144 const lzma_stream_flags *options, uint8_t *out) | 140 const lzma_stream_flags *options, uint8_t *out) |
145 lzma_nothrow lzma_attr_warn_unused_result; | 141 lzma_nothrow lzma_attr_warn_unused_result; |
146 | 142 |
147 | 143 |
148 /** | 144 /** |
149 * \brief Decode Stream Header | 145 * \brief Decode Stream Header |
150 * | 146 * |
151 * \param options Stream Header options to be encoded. | 147 * \param options Target for the decoded Stream Header options. |
152 * \param in Beginning of the input buffer of | 148 * \param in Beginning of the input buffer of |
153 * LZMA_STREAM_HEADER_SIZE bytes. | 149 * LZMA_STREAM_HEADER_SIZE bytes. |
154 * | 150 * |
155 * options->backward_size is always set to LZMA_VLI_UNKNOWN. This is to | 151 * options->backward_size is always set to LZMA_VLI_UNKNOWN. This is to |
156 * help comparing Stream Flags from Stream Header and Stream Footer with | 152 * help comparing Stream Flags from Stream Header and Stream Footer with |
157 * lzma_stream_flags_compare(). | 153 * lzma_stream_flags_compare(). |
158 * | 154 * |
159 * \return - LZMA_OK: Decoding was successful. | 155 * \return - LZMA_OK: Decoding was successful. |
160 * - LZMA_FORMAT_ERROR: Magic bytes don't match, thus the given | 156 * - LZMA_FORMAT_ERROR: Magic bytes don't match, thus the given |
161 * buffer cannot be Stream Header. | 157 * buffer cannot be Stream Header. |
(...skipping 14 matching lines...) Expand all Loading... |
176 * when decoding non-first Stream. | 172 * when decoding non-first Stream. |
177 */ | 173 */ |
178 extern LZMA_API(lzma_ret) lzma_stream_header_decode( | 174 extern LZMA_API(lzma_ret) lzma_stream_header_decode( |
179 lzma_stream_flags *options, const uint8_t *in) | 175 lzma_stream_flags *options, const uint8_t *in) |
180 lzma_nothrow lzma_attr_warn_unused_result; | 176 lzma_nothrow lzma_attr_warn_unused_result; |
181 | 177 |
182 | 178 |
183 /** | 179 /** |
184 * \brief Decode Stream Footer | 180 * \brief Decode Stream Footer |
185 * | 181 * |
186 * \param options Stream Header options to be encoded. | 182 * \param options Target for the decoded Stream Header options. |
187 * \param in Beginning of the input buffer of | 183 * \param in Beginning of the input buffer of |
188 * LZMA_STREAM_HEADER_SIZE bytes. | 184 * LZMA_STREAM_HEADER_SIZE bytes. |
189 * | 185 * |
190 * \return - LZMA_OK: Decoding was successful. | 186 * \return - LZMA_OK: Decoding was successful. |
191 * - LZMA_FORMAT_ERROR: Magic bytes don't match, thus the given | 187 * - LZMA_FORMAT_ERROR: Magic bytes don't match, thus the given |
192 * buffer cannot be Stream Footer. | 188 * buffer cannot be Stream Footer. |
193 * - LZMA_DATA_ERROR: CRC32 doesn't match, thus the Stream Footer | 189 * - LZMA_DATA_ERROR: CRC32 doesn't match, thus the Stream Footer |
194 * is corrupt. | 190 * is corrupt. |
195 * - LZMA_OPTIONS_ERROR: Unsupported options are present | 191 * - LZMA_OPTIONS_ERROR: Unsupported options are present |
196 * in Stream Footer. | 192 * in Stream Footer. |
(...skipping 21 matching lines...) Expand all Loading... |
218 * compared or validated. | 214 * compared or validated. |
219 * - LZMA_DATA_ERROR: The structures differ. | 215 * - LZMA_DATA_ERROR: The structures differ. |
220 * - LZMA_OPTIONS_ERROR: version in either structure is greater | 216 * - LZMA_OPTIONS_ERROR: version in either structure is greater |
221 * than the maximum supported version (currently zero). | 217 * than the maximum supported version (currently zero). |
222 * - LZMA_PROG_ERROR: Invalid value, e.g. invalid check or | 218 * - LZMA_PROG_ERROR: Invalid value, e.g. invalid check or |
223 * backward_size. | 219 * backward_size. |
224 */ | 220 */ |
225 extern LZMA_API(lzma_ret) lzma_stream_flags_compare( | 221 extern LZMA_API(lzma_ret) lzma_stream_flags_compare( |
226 const lzma_stream_flags *a, const lzma_stream_flags *b) | 222 const lzma_stream_flags *a, const lzma_stream_flags *b) |
227 lzma_nothrow lzma_attr_pure; | 223 lzma_nothrow lzma_attr_pure; |
OLD | NEW |