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 FLAC__ASSERT(metadata->data.vorbis_comment.vendor_string.length == 0 || 0 != metadata->data.vorbis_comment.vendor_string.entry);
51 i -= metadata->data.vorbis_comment.vendor_string.length;
52 i += vendor_string_length;
54 FLAC__ASSERT(i < (1u << FLAC__STREAM_METADATA_LENGTH_LEN));
55 if(!FLAC__bitbuffer_write_raw_uint32(bb, i, FLAC__STREAM_METADATA_LENGTH_LEN))
58 switch(metadata->type) {
59 case FLAC__METADATA_TYPE_STREAMINFO:
60 FLAC__ASSERT(metadata->data.stream_info.min_blocksize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN));
61 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.min_blocksize, FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN))
63 FLAC__ASSERT(metadata->data.stream_info.max_blocksize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN));
64 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.max_blocksize, FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN))
66 FLAC__ASSERT(metadata->data.stream_info.min_framesize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN));
67 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.min_framesize, FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN))
69 FLAC__ASSERT(metadata->data.stream_info.max_framesize < (1u << FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN));
70 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.max_framesize, FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN))
72 FLAC__ASSERT(FLAC__format_sample_rate_is_valid(metadata->data.stream_info.sample_rate));
73 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.sample_rate, FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN))
75 FLAC__ASSERT(metadata->data.stream_info.channels > 0);
76 FLAC__ASSERT(metadata->data.stream_info.channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN));
77 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.channels-1, FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN))
79 FLAC__ASSERT(metadata->data.stream_info.bits_per_sample > 0);
80 FLAC__ASSERT(metadata->data.stream_info.bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
81 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.stream_info.bits_per_sample-1, FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN))
83 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.stream_info.total_samples, FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN))
85 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.stream_info.md5sum, 16))
88 case FLAC__METADATA_TYPE_PADDING:
89 if(!FLAC__bitbuffer_write_zeroes(bb, metadata->length * 8))
92 case FLAC__METADATA_TYPE_APPLICATION:
93 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.application.id, FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8))
95 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.application.data, metadata->length - (FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8)))
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))
102 if(!FLAC__bitbuffer_write_raw_uint64(bb, metadata->data.seek_table.points[i].stream_offset, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
104 if(!FLAC__bitbuffer_write_raw_uint32(bb, metadata->data.seek_table.points[i].frame_samples, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
108 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
109 if(!FLAC__bitbuffer_write_raw_uint32_little_endian(bb, vendor_string_length))
111 if(!FLAC__bitbuffer_write_byte_block(bb, (const FLAC__byte*)FLAC__VENDOR_STRING, vendor_string_length))
113 if(!FLAC__bitbuffer_write_raw_uint32_little_endian(bb, metadata->data.vorbis_comment.num_comments))
115 for(i = 0; i < metadata->data.vorbis_comment.num_comments; i++) {
116 if(!FLAC__bitbuffer_write_raw_uint32_little_endian(bb, metadata->data.vorbis_comment.comments[i].length))
118 if(!FLAC__bitbuffer_write_byte_block(bb, metadata->data.vorbis_comment.comments[i].entry, metadata->data.vorbis_comment.comments[i].length))
129 FLAC__bool FLAC__frame_add_header(const FLAC__FrameHeader *header, FLAC__bool streamable_subset, FLAC__bool is_last_block, FLAC__BitBuffer *bb)
131 unsigned u, blocksize_hint, sample_rate_hint;
133 FLAC__ASSERT(FLAC__bitbuffer_is_byte_aligned(bb));
135 if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__FRAME_HEADER_SYNC, FLAC__FRAME_HEADER_SYNC_LEN))
138 if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_RESERVED_LEN))
141 FLAC__ASSERT(header->blocksize > 0 && header->blocksize <= FLAC__MAX_BLOCK_SIZE);
143 switch(header->blocksize) {
144 case 192: u = 1; break;
145 case 576: u = 2; break;
146 case 1152: u = 3; break;
147 case 2304: u = 4; break;
148 case 4608: u = 5; break;
149 case 256: u = 8; break;
150 case 512: u = 9; break;
151 case 1024: u = 10; break;
152 case 2048: u = 11; break;
153 case 4096: u = 12; break;
154 case 8192: u = 13; break;
155 case 16384: u = 14; break;
156 case 32768: u = 15; break;
158 if(streamable_subset || is_last_block) {
159 if(header->blocksize <= 0x100)
160 blocksize_hint = u = 6;
162 blocksize_hint = u = 7;
168 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BLOCK_SIZE_LEN))
171 FLAC__ASSERT(FLAC__format_sample_rate_is_valid(header->sample_rate));
172 sample_rate_hint = 0;
173 switch(header->sample_rate) {
174 case 8000: u = 4; break;
175 case 16000: u = 5; break;
176 case 22050: u = 6; break;
177 case 24000: u = 7; break;
178 case 32000: u = 8; break;
179 case 44100: u = 9; break;
180 case 48000: u = 10; break;
181 case 96000: u = 11; break;
183 if(streamable_subset) {
184 if(header->sample_rate % 1000 == 0)
185 sample_rate_hint = u = 12;
186 else if(header->sample_rate % 10 == 0)
187 sample_rate_hint = u = 14;
189 sample_rate_hint = u = 13;
195 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_SAMPLE_RATE_LEN))
198 FLAC__ASSERT(header->channels > 0 && header->channels <= (1u << FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN) && header->channels <= FLAC__MAX_CHANNELS);
199 switch(header->channel_assignment) {
200 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
201 u = header->channels - 1;
203 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
204 FLAC__ASSERT(header->channels == 2);
207 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
208 FLAC__ASSERT(header->channels == 2);
211 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
212 FLAC__ASSERT(header->channels == 2);
218 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN))
221 FLAC__ASSERT(header->bits_per_sample > 0 && header->bits_per_sample <= (1u << FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN));
222 switch(header->bits_per_sample) {
223 case 8 : u = 1; break;
224 case 12: u = 2; break;
225 case 16: u = 4; break;
226 case 20: u = 5; break;
227 case 24: u = 6; break;
228 default: u = 0; break;
230 if(!FLAC__bitbuffer_write_raw_uint32(bb, u, FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN))
233 if(!FLAC__bitbuffer_write_raw_uint32(bb, 0, FLAC__FRAME_HEADER_ZERO_PAD_LEN))
236 FLAC__ASSERT(header->number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER);
237 if(!FLAC__bitbuffer_write_utf8_uint32(bb, header->number.frame_number))
241 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->blocksize-1, (blocksize_hint==6)? 8:16))
244 switch(sample_rate_hint) {
246 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 1000, 8))
250 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate, 16))
254 if(!FLAC__bitbuffer_write_raw_uint32(bb, header->sample_rate / 10, 16))
260 if(!FLAC__bitbuffer_write_raw_uint32(bb, FLAC__bitbuffer_get_write_crc8(bb), FLAC__FRAME_HEADER_CRC_LEN))
266 FLAC__bool FLAC__subframe_add_constant(const FLAC__Subframe_Constant *subframe, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
271 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) &&
272 (wasted_bits? FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1) : true) &&
273 FLAC__bitbuffer_write_raw_int32(bb, subframe->value, subframe_bps)
279 FLAC__bool FLAC__subframe_add_fixed(const FLAC__Subframe_Fixed *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
283 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))
286 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
289 for(i = 0; i < subframe->order; i++)
290 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
293 if(!add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
295 switch(subframe->entropy_coding_method.type) {
296 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
297 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))
307 FLAC__bool FLAC__subframe_add_lpc(const FLAC__Subframe_LPC *subframe, unsigned residual_samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
311 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))
314 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
317 for(i = 0; i < subframe->order; i++)
318 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->warmup[i], subframe_bps))
321 if(!FLAC__bitbuffer_write_raw_uint32(bb, subframe->qlp_coeff_precision-1, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
323 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->quantization_level, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
325 for(i = 0; i < subframe->order; i++)
326 if(!FLAC__bitbuffer_write_raw_int32(bb, subframe->qlp_coeff[i], subframe->qlp_coeff_precision))
329 if(!add_entropy_coding_method_(bb, &subframe->entropy_coding_method))
331 switch(subframe->entropy_coding_method.type) {
332 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
333 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))
343 FLAC__bool FLAC__subframe_add_verbatim(const FLAC__Subframe_Verbatim *subframe, unsigned samples, unsigned subframe_bps, unsigned wasted_bits, FLAC__BitBuffer *bb)
346 const FLAC__int32 *signal = subframe->data;
348 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))
351 if(!FLAC__bitbuffer_write_unary_unsigned(bb, wasted_bits-1))
354 for(i = 0; i < samples; i++)
355 if(!FLAC__bitbuffer_write_raw_int32(bb, signal[i], subframe_bps))
361 FLAC__bool add_entropy_coding_method_(FLAC__BitBuffer *bb, const FLAC__EntropyCodingMethod *method)
363 if(!FLAC__bitbuffer_write_raw_uint32(bb, method->type, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
365 switch(method->type) {
366 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
367 if(!FLAC__bitbuffer_write_raw_uint32(bb, method->data.partitioned_rice.order, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
376 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)
378 if(partition_order == 0) {
381 if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
383 if(rice_parameters[0] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
384 for(i = 0; i < residual_samples; i++) {
385 #ifdef FLAC__SYMMETRIC_RICE
386 if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[i], rice_parameters[0]))
389 if(!FLAC__bitbuffer_write_rice_signed(bb, residual[i], rice_parameters[0]))
395 if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[0], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
397 for(i = 0; i < residual_samples; i++) {
398 if(!FLAC__bitbuffer_write_raw_int32(bb, residual[i], raw_bits[0]))
405 unsigned i, j, k = 0, k_last = 0;
406 unsigned partition_samples;
407 const unsigned default_partition_samples = (residual_samples+predictor_order) >> partition_order;
408 for(i = 0; i < (1u<<partition_order); i++) {
409 if(!FLAC__bitbuffer_write_raw_uint32(bb, rice_parameters[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN))
411 partition_samples = default_partition_samples;
413 partition_samples -= predictor_order;
414 k += partition_samples;
415 if(rice_parameters[i] < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
416 for(j = k_last; j < k; j++) {
417 #ifdef FLAC__SYMMETRIC_RICE
418 if(!FLAC__bitbuffer_write_symmetric_rice_signed(bb, residual[j], rice_parameters[i]))
421 if(!FLAC__bitbuffer_write_rice_signed(bb, residual[j], rice_parameters[i]))
427 if(!FLAC__bitbuffer_write_raw_uint32(bb, raw_bits[i], FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
429 for(j = k_last; j < k; j++) {
430 if(!FLAC__bitbuffer_write_raw_int32(bb, residual[j], raw_bits[i]))