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 <stdlib.h> /* for qsort() */
22 #include "FLAC/assert.h"
23 #include "FLAC/format.h"
24 #include "private/format.h"
33 #define min(a,b) ((a)<(b)?(a):(b))
35 /* VERSION should come from configure */
36 const char *FLAC__VERSION_STRING = VERSION;
38 #if defined _MSC_VER || defined __MINW32__
39 /* yet one more hack because of MSVC6: */
40 const char *FLAC__VENDOR_STRING = "reference libFLAC 1.0.4 20020924";
42 const char *FLAC__VENDOR_STRING = "reference libFLAC " VERSION " 20020924";
45 const FLAC__byte FLAC__STREAM_SYNC_STRING[4] = { 'f','L','a','C' };
46 const unsigned FLAC__STREAM_SYNC = 0x664C6143;
47 const unsigned FLAC__STREAM_SYNC_LEN = 32; /* bits */;
49 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN = 16; /* bits */
50 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN = 16; /* bits */
51 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN = 24; /* bits */
52 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN = 24; /* bits */
53 const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN = 20; /* bits */
54 const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN = 3; /* bits */
55 const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN = 5; /* bits */
56 const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN = 36; /* bits */
57 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN = 128; /* bits */
59 const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN = 32; /* bits */
61 const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN = 64; /* bits */
62 const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN = 64; /* bits */
63 const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN = 16; /* bits */
65 const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER = 0xffffffffffffffff;
67 const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN = 32; /* bits */
68 const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN = 32; /* bits */
70 const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN = 1; /* bits */
71 const unsigned FLAC__STREAM_METADATA_TYPE_LEN = 7; /* bits */
72 const unsigned FLAC__STREAM_METADATA_LENGTH_LEN = 24; /* bits */
74 const unsigned FLAC__FRAME_HEADER_SYNC = 0x3ffe;
75 const unsigned FLAC__FRAME_HEADER_SYNC_LEN = 14; /* bits */
76 const unsigned FLAC__FRAME_HEADER_RESERVED_LEN = 2; /* bits */
77 const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN = 4; /* bits */
78 const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN = 4; /* bits */
79 const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN = 4; /* bits */
80 const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN = 3; /* bits */
81 const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN = 1; /* bits */
82 const unsigned FLAC__FRAME_HEADER_CRC_LEN = 8; /* bits */
84 const unsigned FLAC__FRAME_FOOTER_CRC_LEN = 16; /* bits */
86 const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN = 2; /* bits */
87 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN = 4; /* bits */
88 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN = 4; /* bits */
89 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN = 5; /* bits */
91 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER = 15; /* == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
93 const char * const FLAC__EntropyCodingMethodTypeString[] = {
97 const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN = 4; /* bits */
98 const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN = 5; /* bits */
100 const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN = 1; /* bits */
101 const unsigned FLAC__SUBFRAME_TYPE_LEN = 6; /* bits */
102 const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN = 1; /* bits */
104 const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK = 0x00;
105 const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK = 0x02;
106 const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK = 0x10;
107 const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK = 0x40;
109 const char * const FLAC__SubframeTypeString[] = {
116 const char * const FLAC__ChannelAssignmentString[] = {
123 const char * const FLAC__FrameNumberTypeString[] = {
124 "FRAME_NUMBER_TYPE_FRAME_NUMBER",
125 "FRAME_NUMBER_TYPE_SAMPLE_NUMBER"
128 const char * const FLAC__MetadataTypeString[] = {
136 FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate)
140 sample_rate > FLAC__MAX_SAMPLE_RATE ||
142 sample_rate >= (1u << 16) &&
143 !(sample_rate % 1000 == 0 || sample_rate % 10 == 0)
152 FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table)
155 FLAC__uint64 prev_sample_number = 0;
156 FLAC__bool got_prev = false;
158 FLAC__ASSERT(0 != seek_table);
160 for(i = 0; i < seek_table->num_points; i++) {
163 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
164 seek_table->points[i].sample_number <= prev_sample_number
168 prev_sample_number = seek_table->points[i].sample_number;
175 /* used as the sort predicate for qsort() */
176 static int seekpoint_compare_(const FLAC__StreamMetadata_SeekPoint *l, const FLAC__StreamMetadata_SeekPoint *r)
178 /* we don't just 'return l->sample_number - r->sample_number' since the result (FLAC__int64) might overflow an 'int' */
179 if(l->sample_number == r->sample_number)
181 else if(l->sample_number < r->sample_number)
187 unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table)
192 FLAC__ASSERT(0 != seek_table);
194 /* sort the seekpoints */
195 qsort(seek_table->points, seek_table->num_points, sizeof(FLAC__StreamMetadata_SeekPoint), (int (*)(const void *, const void *))seekpoint_compare_);
197 /* uniquify the seekpoints */
199 for(i = j = 0; i < seek_table->num_points; i++) {
200 if(seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER) {
202 if(seek_table->points[i].sample_number == seek_table->points[j-1].sample_number)
207 seek_table->points[j++] = seek_table->points[i];
210 for(i = j; i < seek_table->num_points; i++) {
211 seek_table->points[i].sample_number = FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
212 seek_table->points[i].stream_offset = 0;
213 seek_table->points[i].frame_samples = 0;
219 unsigned FLAC__format_get_max_rice_partition_order(unsigned blocksize, unsigned predictor_order)
222 FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(
223 FLAC__format_get_max_rice_partition_order_from_blocksize(blocksize),
229 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize(unsigned blocksize)
231 unsigned max_rice_partition_order = 0;
232 while(!(blocksize & 1)) {
233 max_rice_partition_order++;
236 return min(FLAC__MAX_RICE_PARTITION_ORDER, max_rice_partition_order);
239 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(unsigned limit, unsigned blocksize, unsigned predictor_order)
241 unsigned max_rice_partition_order = limit;
243 while(max_rice_partition_order > 0 && (blocksize >> max_rice_partition_order) <= predictor_order)
244 max_rice_partition_order--;
246 FLAC__ASSERT(blocksize >> max_rice_partition_order > predictor_order);
248 return max_rice_partition_order;
251 void FLAC__format_entropy_coding_method_partitioned_rice_contents_init(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
253 FLAC__ASSERT(0 != object);
255 object->parameters = 0;
256 object->raw_bits = 0;
257 object->capacity_by_order = 0;
260 void FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
262 FLAC__ASSERT(0 != object);
264 if(0 != object->parameters)
265 free(object->parameters);
266 if(0 != object->raw_bits)
267 free(object->raw_bits);
268 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(object);
271 FLAC__bool FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(FLAC__EntropyCodingMethod_PartitionedRiceContents *object, unsigned max_partition_order)
273 FLAC__ASSERT(0 != object);
275 FLAC__ASSERT(object->capacity_by_order > 0 || (0 == object->parameters && 0 == object->raw_bits));
277 if(object->capacity_by_order < max_partition_order) {
278 if(0 == (object->parameters = realloc(object->parameters, sizeof(unsigned)*(1 << max_partition_order))))
280 if(0 == (object->raw_bits = realloc(object->raw_bits, sizeof(unsigned)*(1 << max_partition_order))))
282 object->capacity_by_order = max_partition_order;