new blurb-based bitbuffer design changes
[platform/upstream/flac.git] / src / libFLAC / stream_encoder_framing.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002  Josh Coalson
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA  02111-1307, USA.
18  */
19
20 #include <stdio.h>
21 #include "private/stream_encoder_framing.h"
22 #include "private/crc.h"
23 #include "FLAC/assert.h"
24
25 #ifdef max
26 #undef max
27 #endif
28 #define max(x,y) ((x)>(y)?(x):(y))
29
30 static FLAC__bool subframe_add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method);
31 static FLAC__bool subframe_add_residual_partitioned_rice_(FLAC__BitBuffer *bb, const FLAC__int32 residual[], const unsigned residual_samples, const unsigned predictor_order, const unsigned rice_parameters[], const unsigned raw_bits[], const unsigned partition_order);
32
33 FLAC__bool FLAC__add_metadata_block(const FLAC__StreamMetaData *metadata, FLAC__BitBuffer *bb)
34 {
35         unsigned i;
36
37         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->is_last, FLAC__STREAM_METADATA_IS_LAST_LEN))
38                 return false;
39
40         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->type, FLAC__STREAM_METADATA_TYPE_LEN))
41                 return false;
42
43         FLAC__ASSERT(metadata->length < (1u << FLAC__STREAM_METADATA_LENGTH_LEN));
44         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->length, FLAC__STREAM_METADATA_LENGTH_LEN))
45                 return false;
46
47         switch(metadata->type) {
48                 case FLAC__METADATA_TYPE_STREAMINFO:
49                         FLAC__ASSERT(metadata->data.stream_info.min_blocksize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN));
50                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.min_blocksize, FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN))
51                                 return false;
52                         FLAC__ASSERT(metadata->data.stream_info.max_blocksize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN));
53                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.max_blocksize, FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN))
54                                 return false;
55                         FLAC__ASSERT(metadata->data.stream_info.min_framesize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN));
56                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.min_framesize, FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN))
57                                 return false;
58                         FLAC__ASSERT(metadata->data.stream_info.max_framesize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN));
59                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.max_framesize, FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN))
60                                 return false;
61                         FLAC__ASSERT(metadata->data.stream_info.sample_rate > 0);
62                         FLAC__ASSERT(metadata->data.stream_info.sample_rate < (1u << FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN));
63                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.sample_rate, FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN))
64                                 return false;
65                         FLAC__ASSERT(metadata->data.stream_info.channels > 0);
66                         FLAC__ASSERT(metadata->data.stream_info.channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN));
67                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.channels-1, FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN))
68                                 return false;
69                         FLAC__ASSERT(metadata->data.stream_info.bits_per_sample > 0);
70                         FLAC__ASSERT(metadata->data.stream_info.bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
71                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.bits_per_sample-1, FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN))
72                                 return false;
73                         if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.stream_info.total_samples, FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN))
74                                 return false;
75                         for(i = 0; i < 16; i++) {
76                                 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.md5sum[i], 8))
77                                         return false;
78                         }
79                         break;
80                 case FLAC__METADATA_TYPE_PADDING:
81                         if(!FLAC__bitbuffer_write_zeroes(bb, metadata->length * 8))
82                                 return false;
83                         break;
84                 case FLAC__METADATA_TYPE_APPLICATION:
85                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.application.id[0], 8))
86                                 return false;
87                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.application.id[1], 8))
88                                 return false;
89                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.application.id[2], 8))
90                                 return false;
91                         if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.application.id[3], 8))
92                                 return false;
93                         for(i = 0; i < metadata->length; i++) {
94                                 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.application.data[i], 8))
95                                         return false;
96                         }
97                         break;
98                 case FLAC__METADATA_TYPE_SEEKTABLE:
99                         for(i = 0; i < metadata->data.seek_table.num_points; i++) {
100                                 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].sample_number, FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN))
101                                         return false;
102                                 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].stream_offset, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
103                                         return false;
104                                 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.seek_table.points[i].frame_samples, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
105                                         return false;
106                         }
107                         break;
108                 default:
109                         FLAC__ASSERT(0);
110         }
111
112         return true;
113 }
114
115 FLAC__bool FLAC__frame_add_header(const FLAC__FrameHeader *header, FLAC__bool streamable_subset, FLAC__bool is_last_block, FLAC__BitBuffer *bb)
116 {
117         unsigned u, blocksize_hint, sample_rate_hint;
118
119         FLAC__ASSERT(FLAC__bitbuffer_is_byte_aligned(bb));
120
121         if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__FRAME_HEADER_SYNC, FLAC__FRAME_HEADER_SYNC_LEN))
122                 return false;
123
124         if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_RESERVED_LEN))
125                 return false;
126
127         FLAC__ASSERT(header->blocksize > 0 && header->blocksize <= FLAC__MAX_BLOCK_SIZE);
128         blocksize_hint = 0;
129         switch(header->blocksize) {
130                 case   192: u = 1; break;
131                 case   576: u = 2; break;
132                 case  1152: u = 3; break;
133                 case  2304: u = 4; break;
134                 case  4608: u = 5; break;
135                 case   256: u = 8; break;
136                 case   512: u = 9; break;
137                 case  1024: u = 10; break;
138                 case  2048: u = 11; break;
139                 case  4096: u = 12; break;
140                 case  8192: u = 13; break;
141                 case 16384: u = 14; break;
142                 case 32768: u = 15; break;
143                 default:
144                         if(streamable_subset || is_last_block) {
145                                 if(header->blocksize <= 0x100)
146                                         blocksize_hint = u = 6;
147                                 else
148                                         blocksize_hint = u = 7;
149                         }
150                         else
151                                 u = 0;
152                         break;
153         }
154         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BLOCK_SIZE_LEN))
155                 return false;
156
157         FLAC__ASSERT(header->sample_rate > 0 && header->sample_rate < (1u << FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN));
158         sample_rate_hint = 0;
159         switch(header->sample_rate) {
160                 case  8000: u = 4; break;
161                 case 16000: u = 5; break;
162                 case 22050: u = 6; break;
163                 case 24000: u = 7; break;
164                 case 32000: u = 8; break;
165                 case 44100: u = 9; break;
166                 case 48000: u = 10; break;
167                 case 96000: u = 11; break;
168                 default:
169                         if(streamable_subset) {
170                                 if(header->sample_rate % 1000 == 0)
171                                         sample_rate_hint = u = 12;
172                                 else if(header->sample_rate % 10 == 0)
173                                         sample_rate_hint = u = 14;
174                                 else
175                                         sample_rate_hint = u = 13;
176                         }
177                         else
178                                 u = 0;
179                         break;
180         }
181         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_SAMPLE_RATE_LEN))
182                 return false;
183
184         FLAC__ASSERT(header->channels > 0 && header->channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN) && header->channels <= FLAC__MAX_CHANNELS);
185         switch(header->channel_assignment) {
186                 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
187                         u = header->channels - 1;
188                         break;
189                 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
190                         FLAC__ASSERT(header->channels == 2);
191                         u = 8;
192                         break;
193                 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
194                         FLAC__ASSERT(header->channels == 2);
195                         u = 9;
196                         break;
197                 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
198                         FLAC__ASSERT(header->channels == 2);
199                         u = 10;
200                         break;
201                 default:
202                         FLAC__ASSERT(0);
203         }
204         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN))
205                 return false;
206
207         FLAC__ASSERT(header->bits_per_sample > 0 && header->bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
208         switch(header->bits_per_sample) {
209                 case 8 : u = 1; break;
210                 case 12: u = 2; break;
211                 case 16: u = 4; break;
212                 case 20: u = 5; break;
213                 case 24: u = 6; break;
214                 default: u = 0; break;
215         }
216         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN))
217                 return false;
218
219         if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_ZERO_PAD_LEN))
220                 return false;
221
222         FLAC__ASSERT(header->number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER);
223         if(!FLAC__bitbuffer_write_utf8_uint32(bb, header->number.frame_number))
224                 return false;
225
226         if(blocksize_hint)
227                 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->blocksize-1, (blocksize_hint==6)? 8:16))
228                         return false;
229
230         switch(sample_rate_hint) {
231                 case 12:
232                         if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 1000, 8))
233                                 return false;
234                         break;
235                 case 13:
236                         if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate, 16))
237                                 return false;
238                         break;
239                 case 14:
240                         if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 10, 16))
241                                 return false;
242                         break;
243         }
244
245         /* write the CRC */
246         if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__bitbuffer_get_write_crc8(bb), FLAC__FRAME_HEADER_CRC_LEN))
247                 return false;
248
249         return true;
250 }
251
252 FLAC__bool FLAC__subframe_add_constant(const FLAC__Subframe_Constant *subframe, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
253 {
254         FLAC__bool ok;
255
256         ok =
257                 FLAC__bitbuffer_write_raw_uint32(bb, FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK | (wasted_bits? 1:0), FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN) &&
258                 (wasted_bits? FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1) : true) &&
259                 FLAC__bitbuffer_write_raw_int32(bb, subframe->value, subframe_bps)
260         ;
261
262         return ok;
263 }
264
265 FLAC__bool FLAC__subframe_add_fixed(const FLAC__Subframe_Fixed *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
266 {
267         unsigned i;
268
269         if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK | (subframe->order<<1) | (wasted_bits? 1:0), FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN))
270                 return false;
271         if(wasted_bits)
272                 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
273                         return false;
274
275         for(i = 0; i < subframe->order; i++)
276                 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
277                         return false;
278
279         if(!subframe_add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
280                 return false;
281         switch(subframe->entropy_coding_method.type) {
282                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
283                         if(!subframe_add_residual_partitioned_rice_(bb, subframe->residual, residual_samples, subframe->order, subframe->entropy_coding_method.data.partitioned_rice.parameters, subframe->entropy_coding_method.data.partitioned_rice.raw_bits, subframe->entropy_coding_method.data.partitioned_rice.order))
284                                 return false;
285                         break;
286                 default:
287                         FLAC__ASSERT(0);
288         }
289
290         return true;
291 }
292
293 FLAC__bool FLAC__subframe_add_lpc(const FLAC__Subframe_LPC *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
294 {
295         unsigned i;
296
297         if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK | ((subframe->order-1)<<1) | (wasted_bits? 1:0), FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN))
298                 return false;
299         if(wasted_bits)
300                 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
301                         return false;
302
303         for(i = 0; i < subframe->order; i++)
304                 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
305                         return false;
306
307         if(!FLAC__bitbuffer_write_raw_uint32(bb, subframe->qlp_coeff_precision-1, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
308                 return false;
309         if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->quantization_level, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
310                 return false;
311         for(i = 0; i < subframe->order; i++)
312                 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->qlp_coeff[i], subframe->qlp_coeff_precision))
313                         return false;
314
315         if(!subframe_add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
316                 return false;
317         switch(subframe->entropy_coding_method.type) {
318                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
319                         if(!subframe_add_residual_partitioned_rice_(bb, subframe->residual, residual_samples, subframe->order, subframe->entropy_coding_method.data.partitioned_rice.parameters, subframe->entropy_coding_method.data.partitioned_rice.raw_bits, subframe->entropy_coding_method.data.partitioned_rice.order))
320                                 return false;
321                         break;
322                 default:
323                         FLAC__ASSERT(0);
324         }
325
326         return true;
327 }
328
329 FLAC__bool FLAC__subframe_add_verbatim(const FLAC__Subframe_Verbatim *subframe, unsigned samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
330 {
331         unsigned i;
332         const FLAC__int32 *signal = subframe->data;
333
334         if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK | (wasted_bits? 1:0), FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN))
335                 return false;
336         if(wasted_bits)
337                 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
338                         return false;
339
340         for(i = 0; i < samples; i++)
341                 if(!FLAC__bitbuffer_write_raw_int32(bb, signal[i], subframe_bps))
342                         return false;
343
344         return true;
345 }
346
347 FLAC__bool subframe_add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method)
348 {
349         if(!FLAC__bitbuffer_write_raw_uint32(bb, method->type, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
350                 return false;
351         switch(method->type) {
352                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
353                         if(!FLAC__bitbuffer_write_raw_uint32(bb, method->data.partitioned_rice.order, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
354                                 return false;
355                         break;
356                 default:
357                         FLAC__ASSERT(0);
358         }
359         return true;
360 }
361
362 FLAC__bool subframe_add_residual_partitioned_rice_(FLAC__BitBuffer *bb, const FLAC__int32 residual[], const unsigned residual_samples, const unsigned predictor_order, const unsigned rice_parameters[], const unsigned raw_bits[], const unsigned partition_order)
363 {
364         if(partition_order == 0) {
365                 unsigned i;
366
367                 if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
368                         return false;
369                 if(rice_parameters[0] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
370                         for(i = 0; i < residual_samples; i++) {
371 #ifdef FLAC__SYMMETRIC_RICE
372                                 if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[i], rice_parameters[0]))
373                                         return false;
374 #else
375                                 if(!FLAC__bitbuffer_write_rice_signed(bb, residual[i], rice_parameters[0]))
376                                         return false;
377 #endif
378                         }
379                 }
380                 else {
381                         if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
382                                 return false;
383                         for(i = 0; i < residual_samples; i++) {
384                                 if(!FLAC__bitbuffer_write_raw_int32(bb, residual[i], raw_bits[0]))
385                                         return false;
386                         }
387                 }
388                 return true;
389         }
390         else {
391                 unsigned i, j, k = 0, k_last = 0;
392                 unsigned partition_samples;
393                 const unsigned default_partition_samples = (residual_samples+predictor_order) >> partition_order;
394                 for(i = 0; i < (1u<<partition_order); i++) {
395                         if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
396                                 return false;
397                         partition_samples = default_partition_samples;
398                         if(i == 0)
399                                 partition_samples -= predictor_order;
400                         k += partition_samples;
401                         if(rice_parameters[i] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
402                                 for(j = k_last; j < k; j++) {
403 #ifdef FLAC__SYMMETRIC_RICE
404                                         if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[j], rice_parameters[i]))
405                                                 return false;
406 #else
407                                         if(!FLAC__bitbuffer_write_rice_signed(bb, residual[j], rice_parameters[i]))
408                                                 return false;
409 #endif
410                                 }
411                         }
412                         else {
413                                 if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
414                                         return false;
415                                 for(j = k_last; j < k; j++) {
416                                         if(!FLAC__bitbuffer_write_raw_int32(bb, residual[j], raw_bits[i]))
417                                                 return false;
418                                 }
419                         }
420                         k_last = k;
421                 }
422                 return true;
423         }
424 }