Use config.h rather than passing all defs in CFLAGS
[flac.git] / src / libFLAC / format.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 <stdlib.h> /* for qsort() */
22 #include "FLAC/assert.h"
23 #include "FLAC/format.h"
24 #include "private/format.h"
25
26 #ifdef HAVE_CONFIG_H
27 #include <config.h>
28 #endif
29
30 #ifdef min
31 #undef min
32 #endif
33 #define min(a,b) ((a)<(b)?(a):(b))
34
35 /* VERSION should come from configure */
36 const char *FLAC__VERSION_STRING = VERSION;
37
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";
41 #else
42 const char *FLAC__VENDOR_STRING = "reference libFLAC " VERSION " 20020924";
43 #endif
44
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 */;
48
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 */
58
59 const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN = 32; /* bits */
60
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 */
64
65 const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER = 0xffffffffffffffff;
66
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 */
69
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 */
73
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 */
83
84 const unsigned FLAC__FRAME_FOOTER_CRC_LEN = 16; /* bits */
85
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 */
90
91 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER = 15; /* == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
92
93 const char * const FLAC__EntropyCodingMethodTypeString[] = {
94         "PARTITIONED_RICE"
95 };
96
97 const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN = 4; /* bits */
98 const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN = 5; /* bits */
99
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 */
103
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;
108
109 const char * const FLAC__SubframeTypeString[] = {
110         "CONSTANT",
111         "VERBATIM",
112         "FIXED",
113         "LPC"
114 };
115
116 const char * const FLAC__ChannelAssignmentString[] = {
117         "INDEPENDENT",
118         "LEFT_SIDE",
119         "RIGHT_SIDE",
120         "MID_SIDE"
121 };
122
123 const char * const FLAC__FrameNumberTypeString[] = {
124         "FRAME_NUMBER_TYPE_FRAME_NUMBER",
125         "FRAME_NUMBER_TYPE_SAMPLE_NUMBER"
126 };
127
128 const char * const FLAC__MetadataTypeString[] = {
129         "STREAMINFO",
130         "PADDING",
131         "APPLICATION",
132         "SEEKTABLE",
133         "VORBIS_COMMENT"
134 };
135
136 FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate)
137 {
138         if(
139                 sample_rate == 0 ||
140                 sample_rate > FLAC__MAX_SAMPLE_RATE ||
141                 (
142                         sample_rate >= (1u << 16) &&
143                         !(sample_rate % 1000 == 0 || sample_rate % 10 == 0)
144                 )
145         ) {
146                 return false;
147         }
148         else
149                 return true;
150 }
151
152 FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table)
153 {
154         unsigned i;
155         FLAC__uint64 prev_sample_number = 0;
156         FLAC__bool got_prev = false;
157
158         FLAC__ASSERT(0 != seek_table);
159
160         for(i = 0; i < seek_table->num_points; i++) {
161                 if(got_prev) {
162                         if(
163                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
164                                 seek_table->points[i].sample_number <= prev_sample_number
165                         )
166                                 return false;
167                 }
168                 prev_sample_number = seek_table->points[i].sample_number;
169                 got_prev = true;
170         }
171
172         return true;
173 }
174
175 /* used as the sort predicate for qsort() */
176 static int seekpoint_compare_(const FLAC__StreamMetadata_SeekPoint *l, const FLAC__StreamMetadata_SeekPoint *r)
177 {
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)
180                 return 0;
181         else if(l->sample_number < r->sample_number)
182                 return -1;
183         else
184                 return 1;
185 }
186
187 unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table)
188 {
189         unsigned i, j;
190         FLAC__bool first;
191
192         FLAC__ASSERT(0 != seek_table);
193
194         /* sort the seekpoints */
195         qsort(seek_table->points, seek_table->num_points, sizeof(FLAC__StreamMetadata_SeekPoint), (int (*)(const void *, const void *))seekpoint_compare_);
196
197         /* uniquify the seekpoints */
198         first = true;
199         for(i = j = 0; i < seek_table->num_points; i++) {
200                 if(seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER) {
201                         if(!first) {
202                                 if(seek_table->points[i].sample_number == seek_table->points[j-1].sample_number)
203                                         continue;
204                         }
205                 }
206                 first = false;
207                 seek_table->points[j++] = seek_table->points[i];
208         }
209
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;
214         }
215
216         return j;
217 }
218
219 unsigned FLAC__format_get_max_rice_partition_order(unsigned blocksize, unsigned predictor_order)
220 {
221         return
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),
224                         blocksize,
225                         predictor_order
226                 );
227 }
228
229 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize(unsigned blocksize)
230 {
231         unsigned max_rice_partition_order = 0;
232         while(!(blocksize & 1)) {
233                 max_rice_partition_order++;
234                 blocksize >>= 1;
235         }
236         return min(FLAC__MAX_RICE_PARTITION_ORDER, max_rice_partition_order);
237 }
238
239 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(unsigned limit, unsigned blocksize, unsigned predictor_order)
240 {
241         unsigned max_rice_partition_order = limit;
242
243         while(max_rice_partition_order > 0 && (blocksize >> max_rice_partition_order) <= predictor_order)
244                 max_rice_partition_order--;
245
246         FLAC__ASSERT(blocksize >> max_rice_partition_order > predictor_order);
247
248         return max_rice_partition_order;
249 }
250
251 void FLAC__format_entropy_coding_method_partitioned_rice_contents_init(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
252 {
253         FLAC__ASSERT(0 != object);
254
255         object->parameters = 0;
256         object->raw_bits = 0;
257         object->capacity_by_order = 0;
258 }
259
260 void FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
261 {
262         FLAC__ASSERT(0 != object);
263
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);
269 }
270
271 FLAC__bool FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(FLAC__EntropyCodingMethod_PartitionedRiceContents *object, unsigned max_partition_order)
272 {
273         FLAC__ASSERT(0 != object);
274
275         FLAC__ASSERT(object->capacity_by_order > 0 || (0 == object->parameters && 0 == object->raw_bits));
276
277         if(object->capacity_by_order < max_partition_order) {
278                 if(0 == (object->parameters = realloc(object->parameters, sizeof(unsigned)*(1 << max_partition_order))))
279                         return false;
280                 if(0 == (object->raw_bits = realloc(object->raw_bits, sizeof(unsigned)*(1 << max_partition_order))))
281                         return false;
282                 object->capacity_by_order = max_partition_order;
283         }
284
285         return true;
286 }