rename encoder_framing.c to stream_encoder_framing.c
[platform/upstream/flac.git] / src / libFLAC / stream_encoder_framing.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001  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/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 bool subframe_add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method);
31 static bool subframe_add_residual_partitioned_rice_(FLAC__BitBuffer *bb, const int32 residual[], const unsigned residual_samples, const unsigned predictor_order, const unsigned rice_parameters[], const unsigned raw_bits[], const unsigned partition_order);
32
33 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_SEEKTABLE:
85                         for(i = 0; i < metadata->data.seek_table.num_points; i++) {
86                                 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].sample_number, FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN))
87                                         return false;
88                                 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].stream_offset, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
89                                         return false;
90                                 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.seek_table.points[i].frame_samples, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
91                                         return false;
92                         }
93                         break;
94                 default:
95                         FLAC__ASSERT(0);
96         }
97
98         return true;
99 }
100
101 bool FLAC__frame_add_header(const FLAC__FrameHeader *header, bool streamable_subset, bool is_last_block, FLAC__BitBuffer *bb)
102 {
103         unsigned u, crc8_start, blocksize_hint, sample_rate_hint;
104         byte crc8;
105
106         FLAC__ASSERT(bb->bits == 0); /* assert that we're byte-aligned before writing */
107
108         crc8_start = bb->bytes;
109
110         if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__FRAME_HEADER_SYNC, FLAC__FRAME_HEADER_SYNC_LEN))
111                 return false;
112
113         if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_RESERVED_LEN))
114                 return false;
115
116         FLAC__ASSERT(header->blocksize > 0 && header->blocksize <= FLAC__MAX_BLOCK_SIZE);
117         blocksize_hint = 0;
118         switch(header->blocksize) {
119                 case   192: u = 1; break;
120                 case   576: u = 2; break;
121                 case  1152: u = 3; break;
122                 case  2304: u = 4; break;
123                 case  4608: u = 5; break;
124                 case   256: u = 8; break;
125                 case   512: u = 9; break;
126                 case  1024: u = 10; break;
127                 case  2048: u = 11; break;
128                 case  4096: u = 12; break;
129                 case  8192: u = 13; break;
130                 case 16384: u = 14; break;
131                 case 32768: u = 15; break;
132                 default:
133                         if(streamable_subset || is_last_block) {
134                                 if(header->blocksize <= 0x100)
135                                         blocksize_hint = u = 6;
136                                 else
137                                         blocksize_hint = u = 7;
138                         }
139                         else
140                                 u = 0;
141                         break;
142         }
143         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BLOCK_SIZE_LEN))
144                 return false;
145
146         FLAC__ASSERT(header->sample_rate > 0 && header->sample_rate < (1u << FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN));
147         sample_rate_hint = 0;
148         switch(header->sample_rate) {
149                 case  8000: u = 4; break;
150                 case 16000: u = 5; break;
151                 case 22050: u = 6; break;
152                 case 24000: u = 7; break;
153                 case 32000: u = 8; break;
154                 case 44100: u = 9; break;
155                 case 48000: u = 10; break;
156                 case 96000: u = 11; break;
157                 default:
158                         if(streamable_subset) {
159                                 if(header->sample_rate % 1000 == 0)
160                                         sample_rate_hint = u = 12;
161                                 else if(header->sample_rate % 10 == 0)
162                                         sample_rate_hint = u = 14;
163                                 else
164                                         sample_rate_hint = u = 13;
165                         }
166                         else
167                                 u = 0;
168                         break;
169         }
170         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_SAMPLE_RATE_LEN))
171                 return false;
172
173         FLAC__ASSERT(header->channels > 0 && header->channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN) && header->channels <= FLAC__MAX_CHANNELS);
174         switch(header->channel_assignment) {
175                 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
176                         u = header->channels - 1;
177                         break;
178                 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
179                         FLAC__ASSERT(header->channels == 2);
180                         u = 8;
181                         break;
182                 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
183                         FLAC__ASSERT(header->channels == 2);
184                         u = 9;
185                         break;
186                 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
187                         FLAC__ASSERT(header->channels == 2);
188                         u = 10;
189                         break;
190                 default:
191                         FLAC__ASSERT(0);
192         }
193         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN))
194                 return false;
195
196         FLAC__ASSERT(header->bits_per_sample > 0 && header->bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
197         switch(header->bits_per_sample) {
198                 case 8 : u = 1; break;
199                 case 12: u = 2; break;
200                 case 16: u = 4; break;
201                 case 20: u = 5; break;
202                 case 24: u = 6; break;
203                 default: u = 0; break;
204         }
205         if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN))
206                 return false;
207
208         if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_ZERO_PAD_LEN))
209                 return false;
210
211         if(!FLAC__bitbuffer_write_utf8_uint32(bb, header->number.frame_number))
212                 return false;
213
214         if(blocksize_hint)
215                 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->blocksize-1, (blocksize_hint==6)? 8:16))
216                         return false;
217
218         switch(sample_rate_hint) {
219                 case 12:
220                         if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 1000, 8))
221                                 return false;
222                         break;
223                 case 13:
224                         if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate, 16))
225                                 return false;
226                         break;
227                 case 14:
228                         if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 10, 16))
229                                 return false;
230                         break;
231         }
232
233         /* write the CRC */
234         FLAC__ASSERT(bb->buffer[crc8_start] == 0xff); /* MAGIC NUMBER for the first byte of the sync code */
235         FLAC__ASSERT(bb->bits == 0); /* assert that we're byte-aligned */
236         crc8 = FLAC__crc8(bb->buffer+crc8_start, bb->bytes-crc8_start);
237         if(!FLAC__bitbuffer_write_raw_uint32(bb, crc8, FLAC__FRAME_HEADER_CRC_LEN))
238                 return false;
239
240         return true;
241 }
242
243 bool FLAC__subframe_add_constant(const FLAC__Subframe_Constant *subframe, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
244 {
245         bool ok;
246
247         ok =
248                 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) &&
249                 (wasted_bits? FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1) : true) &&
250                 FLAC__bitbuffer_write_raw_int32(bb, subframe->value, subframe_bps)
251         ;
252
253         return ok;
254 }
255
256 bool FLAC__subframe_add_fixed(const FLAC__Subframe_Fixed *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
257 {
258         unsigned i;
259
260         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))
261                 return false;
262         if(wasted_bits)
263                 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
264                         return false;
265
266         for(i = 0; i < subframe->order; i++)
267                 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
268                         return false;
269
270         if(!subframe_add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
271                 return false;
272         switch(subframe->entropy_coding_method.type) {
273                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
274                         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))
275                                 return false;
276                         break;
277                 default:
278                         FLAC__ASSERT(0);
279         }
280
281         return true;
282 }
283
284 bool FLAC__subframe_add_lpc(const FLAC__Subframe_LPC *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
285 {
286         unsigned i;
287
288         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))
289                 return false;
290         if(wasted_bits)
291                 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
292                         return false;
293
294         for(i = 0; i < subframe->order; i++)
295                 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
296                         return false;
297
298         if(!FLAC__bitbuffer_write_raw_uint32(bb, subframe->qlp_coeff_precision-1, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
299                 return false;
300         if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->quantization_level, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
301                 return false;
302         for(i = 0; i < subframe->order; i++)
303                 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->qlp_coeff[i], subframe->qlp_coeff_precision))
304                         return false;
305
306         if(!subframe_add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
307                 return false;
308         switch(subframe->entropy_coding_method.type) {
309                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
310                         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))
311                                 return false;
312                         break;
313                 default:
314                         FLAC__ASSERT(0);
315         }
316
317         return true;
318 }
319
320 bool FLAC__subframe_add_verbatim(const FLAC__Subframe_Verbatim *subframe, unsigned samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
321 {
322         unsigned i;
323         const int32 *signal = subframe->data;
324
325         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))
326                 return false;
327         if(wasted_bits)
328                 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
329                         return false;
330
331         for(i = 0; i < samples; i++)
332                 if(!FLAC__bitbuffer_write_raw_int32(bb, signal[i], subframe_bps))
333                         return false;
334
335         return true;
336 }
337
338 bool subframe_add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method)
339 {
340         if(!FLAC__bitbuffer_write_raw_uint32(bb, method->type, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
341                 return false;
342         switch(method->type) {
343                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
344                         if(!FLAC__bitbuffer_write_raw_uint32(bb, method->data.partitioned_rice.order, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
345                                 return false;
346                         break;
347                 default:
348                         FLAC__ASSERT(0);
349         }
350         return true;
351 }
352
353 bool subframe_add_residual_partitioned_rice_(FLAC__BitBuffer *bb, const int32 residual[], const unsigned residual_samples, const unsigned predictor_order, const unsigned rice_parameters[], const unsigned raw_bits[], const unsigned partition_order)
354 {
355         if(partition_order == 0) {
356                 unsigned i;
357
358                 if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
359                         return false;
360                 if(rice_parameters[0] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
361                         for(i = 0; i < residual_samples; i++) {
362 #ifdef FLAC__SYMMETRIC_RICE
363                                 if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[i], rice_parameters[0]))
364                                         return false;
365 #else
366                                 if(!FLAC__bitbuffer_write_rice_signed(bb, residual[i], rice_parameters[0]))
367                                         return false;
368 #endif
369                         }
370                 }
371                 else {
372                         if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
373                                 return false;
374                         for(i = 0; i < residual_samples; i++) {
375                                 if(!FLAC__bitbuffer_write_raw_int32(bb, residual[i], raw_bits[0]))
376                                         return false;
377                         }
378                 }
379                 return true;
380         }
381         else {
382                 unsigned i, j, k = 0, k_last = 0;
383                 unsigned partition_samples;
384                 const unsigned default_partition_samples = (residual_samples+predictor_order) >> partition_order;
385                 for(i = 0; i < (1u<<partition_order); i++) {
386                         if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
387                                 return false;
388                         partition_samples = default_partition_samples;
389                         if(i == 0)
390                                 partition_samples -= predictor_order;
391                         k += partition_samples;
392                         if(rice_parameters[i] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
393                                 for(j = k_last; j < k; j++) {
394 #ifdef FLAC__SYMMETRIC_RICE
395                                         if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[j], rice_parameters[i]))
396                                                 return false;
397 #else
398                                         if(!FLAC__bitbuffer_write_rice_signed(bb, residual[j], rice_parameters[i]))
399                                                 return false;
400 #endif
401                                 }
402                         }
403                         else {
404                                 if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
405                                         return false;
406                                 for(j = k_last; j < k; j++) {
407                                         if(!FLAC__bitbuffer_write_raw_int32(bb, residual[j], raw_bits[i]))
408                                                 return false;
409                                 }
410                         }
411                         k_last = k;
412                 }
413                 return true;
414         }
415 }