1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000,2001,2002 Josh Coalson
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.
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.
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.
21 #include <string.h> /* for strlen() */
22 #include "private/stream_encoder_framing.h"
23 #include "private/crc.h"
24 #include "FLAC/assert.h"
29 #define max(x,y) ((x)>(y)?(x):(y))
31 static FLAC__bool add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method);
32 static FLAC__bool 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);
34 FLAC__bool FLAC__add_metadata_block(const FLAC__StreamMetadata *metadata, FLAC__BitBuffer *bb)
37 const unsigned vendor_string_length = (unsigned)strlen(FLAC__VENDOR_STRING);
39 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->is_last, FLAC__STREAM_METADATA_IS_LAST_LEN))
42 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->type, FLAC__STREAM_METADATA_TYPE_LEN))
46 * First, for VORBIS_COMMENTs, adjust the length to reflect our vendor string
49 if(metadata->type == FLAC__METADATA_TYPE_VORBIS_COMMENT) {
50 i -= metadata->data.vorbis_comment.vendor_string.length;
51 i += vendor_string_length;
53 FLAC__ASSERT(i < (1u << FLAC__STREAM_METADATA_LENGTH_LEN));
54 if(!FLAC__bitbuffer_write_raw_uint32(bb, i, FLAC__STREAM_METADATA_LENGTH_LEN))
57 switch(metadata->type) {
58 case FLAC__METADATA_TYPE_STREAMINFO:
59 FLAC__ASSERT(metadata->data.stream_info.min_blocksize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN));
60 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.min_blocksize, FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN))
62 FLAC__ASSERT(metadata->data.stream_info.max_blocksize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN));
63 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.max_blocksize, FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN))
65 FLAC__ASSERT(metadata->data.stream_info.min_framesize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN));
66 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.min_framesize, FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN))
68 FLAC__ASSERT(metadata->data.stream_info.max_framesize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN));
69 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.max_framesize, FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN))
71 FLAC__ASSERT(FLAC__format_sample_rate_is_valid(metadata->data.stream_info.sample_rate));
72 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.sample_rate, FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN))
74 FLAC__ASSERT(metadata->data.stream_info.channels > 0);
75 FLAC__ASSERT(metadata->data.stream_info.channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN));
76 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.channels-1, FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN))
78 FLAC__ASSERT(metadata->data.stream_info.bits_per_sample > 0);
79 FLAC__ASSERT(metadata->data.stream_info.bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
80 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.bits_per_sample-1, FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN))
82 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.stream_info.total_samples, FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN))
84 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.stream_info.md5sum, 16))
87 case FLAC__METADATA_TYPE_PADDING:
88 if(!FLAC__bitbuffer_write_zeroes(bb, metadata->length * 8))
91 case FLAC__METADATA_TYPE_APPLICATION:
92 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.application.id, FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8))
94 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.application.data, metadata->length - (FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8)))
97 case FLAC__METADATA_TYPE_SEEKTABLE:
98 for(i = 0; i < metadata->data.seek_table.num_points; i++) {
99 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].sample_number, FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN))
101 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].stream_offset, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
103 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.seek_table.points[i].frame_samples, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
107 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
108 if(!FLAC__bitbuffer_write_raw_uint32_little_endian(bb, vendor_string_length))
110 if(!FLAC__bitbuffer_write_byte_block(bb, FLAC__VENDOR_STRING, vendor_string_length))
112 if(!FLAC__bitbuffer_write_raw_uint32_little_endian(bb, metadata->data.vorbis_comment.num_comments))
114 for(i = 0; i < metadata->data.vorbis_comment.num_comments; i++) {
115 if(!FLAC__bitbuffer_write_raw_uint32_little_endian(bb, metadata->data.vorbis_comment.comments[i].length))
117 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.vorbis_comment.comments[i].entry, metadata->data.vorbis_comment.comments[i].length))
128 FLAC__bool FLAC__frame_add_header(const FLAC__FrameHeader *header, FLAC__bool streamable_subset, FLAC__bool is_last_block, FLAC__BitBuffer *bb)
130 unsigned u, blocksize_hint, sample_rate_hint;
132 FLAC__ASSERT(FLAC__bitbuffer_is_byte_aligned(bb));
134 if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__FRAME_HEADER_SYNC, FLAC__FRAME_HEADER_SYNC_LEN))
137 if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_RESERVED_LEN))
140 FLAC__ASSERT(header->blocksize > 0 && header->blocksize <= FLAC__MAX_BLOCK_SIZE);
142 switch(header->blocksize) {
143 case 192: u = 1; break;
144 case 576: u = 2; break;
145 case 1152: u = 3; break;
146 case 2304: u = 4; break;
147 case 4608: u = 5; break;
148 case 256: u = 8; break;
149 case 512: u = 9; break;
150 case 1024: u = 10; break;
151 case 2048: u = 11; break;
152 case 4096: u = 12; break;
153 case 8192: u = 13; break;
154 case 16384: u = 14; break;
155 case 32768: u = 15; break;
157 if(streamable_subset || is_last_block) {
158 if(header->blocksize <= 0x100)
159 blocksize_hint = u = 6;
161 blocksize_hint = u = 7;
167 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BLOCK_SIZE_LEN))
170 FLAC__ASSERT(FLAC__format_sample_rate_is_valid(header->sample_rate));
171 sample_rate_hint = 0;
172 switch(header->sample_rate) {
173 case 8000: u = 4; break;
174 case 16000: u = 5; break;
175 case 22050: u = 6; break;
176 case 24000: u = 7; break;
177 case 32000: u = 8; break;
178 case 44100: u = 9; break;
179 case 48000: u = 10; break;
180 case 96000: u = 11; break;
182 if(streamable_subset) {
183 if(header->sample_rate % 1000 == 0)
184 sample_rate_hint = u = 12;
185 else if(header->sample_rate % 10 == 0)
186 sample_rate_hint = u = 14;
188 sample_rate_hint = u = 13;
194 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_SAMPLE_RATE_LEN))
197 FLAC__ASSERT(header->channels > 0 && header->channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN) && header->channels <= FLAC__MAX_CHANNELS);
198 switch(header->channel_assignment) {
199 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
200 u = header->channels - 1;
202 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
203 FLAC__ASSERT(header->channels == 2);
206 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
207 FLAC__ASSERT(header->channels == 2);
210 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
211 FLAC__ASSERT(header->channels == 2);
217 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN))
220 FLAC__ASSERT(header->bits_per_sample > 0 && header->bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
221 switch(header->bits_per_sample) {
222 case 8 : u = 1; break;
223 case 12: u = 2; break;
224 case 16: u = 4; break;
225 case 20: u = 5; break;
226 case 24: u = 6; break;
227 default: u = 0; break;
229 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN))
232 if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_ZERO_PAD_LEN))
235 FLAC__ASSERT(header->number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER);
236 if(!FLAC__bitbuffer_write_utf8_uint32(bb, header->number.frame_number))
240 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->blocksize-1, (blocksize_hint==6)? 8:16))
243 switch(sample_rate_hint) {
245 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 1000, 8))
249 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate, 16))
253 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 10, 16))
259 if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__bitbuffer_get_write_crc8(bb), FLAC__FRAME_HEADER_CRC_LEN))
265 FLAC__bool FLAC__subframe_add_constant(const FLAC__Subframe_Constant *subframe, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
270 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) &&
271 (wasted_bits? FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1) : true) &&
272 FLAC__bitbuffer_write_raw_int32(bb, subframe->value, subframe_bps)
278 FLAC__bool FLAC__subframe_add_fixed(const FLAC__Subframe_Fixed *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
282 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))
285 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
288 for(i = 0; i < subframe->order; i++)
289 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
292 if(!add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
294 switch(subframe->entropy_coding_method.type) {
295 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
296 if(!add_residual_partitioned_rice_(bb, subframe->residual, residual_samples, subframe->order, subframe->entropy_coding_method.data.partitioned_rice.contents->parameters, subframe->entropy_coding_method.data.partitioned_rice.contents->raw_bits, subframe->entropy_coding_method.data.partitioned_rice.order))
306 FLAC__bool FLAC__subframe_add_lpc(const FLAC__Subframe_LPC *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
310 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))
313 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
316 for(i = 0; i < subframe->order; i++)
317 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
320 if(!FLAC__bitbuffer_write_raw_uint32(bb, subframe->qlp_coeff_precision-1, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
322 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->quantization_level, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
324 for(i = 0; i < subframe->order; i++)
325 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->qlp_coeff[i], subframe->qlp_coeff_precision))
328 if(!add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
330 switch(subframe->entropy_coding_method.type) {
331 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
332 if(!add_residual_partitioned_rice_(bb, subframe->residual, residual_samples, subframe->order, subframe->entropy_coding_method.data.partitioned_rice.contents->parameters, subframe->entropy_coding_method.data.partitioned_rice.contents->raw_bits, subframe->entropy_coding_method.data.partitioned_rice.order))
342 FLAC__bool FLAC__subframe_add_verbatim(const FLAC__Subframe_Verbatim *subframe, unsigned samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
345 const FLAC__int32 *signal = subframe->data;
347 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))
350 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
353 for(i = 0; i < samples; i++)
354 if(!FLAC__bitbuffer_write_raw_int32(bb, signal[i], subframe_bps))
360 FLAC__bool add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method)
362 if(!FLAC__bitbuffer_write_raw_uint32(bb, method->type, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
364 switch(method->type) {
365 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
366 if(!FLAC__bitbuffer_write_raw_uint32(bb, method->data.partitioned_rice.order, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
375 FLAC__bool 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)
377 if(partition_order == 0) {
380 if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
382 if(rice_parameters[0] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
383 for(i = 0; i < residual_samples; i++) {
384 #ifdef FLAC__SYMMETRIC_RICE
385 if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[i], rice_parameters[0]))
388 if(!FLAC__bitbuffer_write_rice_signed(bb, residual[i], rice_parameters[0]))
394 if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
396 for(i = 0; i < residual_samples; i++) {
397 if(!FLAC__bitbuffer_write_raw_int32(bb, residual[i], raw_bits[0]))
404 unsigned i, j, k = 0, k_last = 0;
405 unsigned partition_samples;
406 const unsigned default_partition_samples = (residual_samples+predictor_order) >> partition_order;
407 for(i = 0; i < (1u<<partition_order); i++) {
408 if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
410 partition_samples = default_partition_samples;
412 partition_samples -= predictor_order;
413 k += partition_samples;
414 if(rice_parameters[i] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
415 for(j = k_last; j < k; j++) {
416 #ifdef FLAC__SYMMETRIC_RICE
417 if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[j], rice_parameters[i]))
420 if(!FLAC__bitbuffer_write_rice_signed(bb, residual[j], rice_parameters[i]))
426 if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
428 for(j = k_last; j < k; j++) {
429 if(!FLAC__bitbuffer_write_raw_int32(bb, residual[j], raw_bits[i]))