bump version number to 1.1.0
[flac.git] / src / libFLAC / format.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002,2003  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 FLAC_API const char *FLAC__VERSION_STRING = VERSION;
37
38 #if defined _MSC_VER || defined __MINW32__
39 /* yet one more hack because of MSVC6: */
40 FLAC_API const char *FLAC__VENDOR_STRING = "reference libFLAC 1.1.0 20030126";
41 #else
42 FLAC_API const char *FLAC__VENDOR_STRING = "reference libFLAC " VERSION " 20030126";
43 #endif
44
45 FLAC_API const FLAC__byte FLAC__STREAM_SYNC_STRING[4] = { 'f','L','a','C' };
46 FLAC_API const unsigned FLAC__STREAM_SYNC = 0x664C6143;
47 FLAC_API const unsigned FLAC__STREAM_SYNC_LEN = 32; /* bits */;
48
49 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN = 16; /* bits */
50 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN = 16; /* bits */
51 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN = 24; /* bits */
52 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN = 24; /* bits */
53 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN = 20; /* bits */
54 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN = 3; /* bits */
55 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN = 5; /* bits */
56 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN = 36; /* bits */
57 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN = 128; /* bits */
58
59 FLAC_API const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN = 32; /* bits */
60
61 FLAC_API const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN = 64; /* bits */
62 FLAC_API const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN = 64; /* bits */
63 FLAC_API const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN = 16; /* bits */
64
65 FLAC_API const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER = 0xffffffffffffffff;
66
67 FLAC_API const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN = 32; /* bits */
68 FLAC_API const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN = 32; /* bits */
69
70 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN = 64; /* bits */
71 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN = 8; /* bits */
72 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN = 3*8; /* bits */
73
74 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN = 64; /* bits */
75 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN = 8; /* bits */
76 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN = 12*8; /* bits */
77 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN = 1; /* bit */
78 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN = 1; /* bit */
79 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN = 6+13*8; /* bits */
80 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN = 8; /* bits */
81
82 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN = 128*8; /* bits */
83 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN = 64; /* bits */
84 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN = 1; /* bit */
85 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN = 7+258*8; /* bits */
86 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN = 8; /* bits */
87
88 FLAC_API const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN = 1; /* bits */
89 FLAC_API const unsigned FLAC__STREAM_METADATA_TYPE_LEN = 7; /* bits */
90 FLAC_API const unsigned FLAC__STREAM_METADATA_LENGTH_LEN = 24; /* bits */
91
92 FLAC_API const unsigned FLAC__FRAME_HEADER_SYNC = 0x3ffe;
93 FLAC_API const unsigned FLAC__FRAME_HEADER_SYNC_LEN = 14; /* bits */
94 FLAC_API const unsigned FLAC__FRAME_HEADER_RESERVED_LEN = 2; /* bits */
95 FLAC_API const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN = 4; /* bits */
96 FLAC_API const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN = 4; /* bits */
97 FLAC_API const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN = 4; /* bits */
98 FLAC_API const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN = 3; /* bits */
99 FLAC_API const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN = 1; /* bits */
100 FLAC_API const unsigned FLAC__FRAME_HEADER_CRC_LEN = 8; /* bits */
101
102 FLAC_API const unsigned FLAC__FRAME_FOOTER_CRC_LEN = 16; /* bits */
103
104 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN = 2; /* bits */
105 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN = 4; /* bits */
106 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN = 4; /* bits */
107 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN = 5; /* bits */
108
109 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER = 15; /* == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
110
111 FLAC_API const char * const FLAC__EntropyCodingMethodTypeString[] = {
112         "PARTITIONED_RICE"
113 };
114
115 FLAC_API const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN = 4; /* bits */
116 FLAC_API const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN = 5; /* bits */
117
118 FLAC_API const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN = 1; /* bits */
119 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_LEN = 6; /* bits */
120 FLAC_API const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN = 1; /* bits */
121
122 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK = 0x00;
123 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK = 0x02;
124 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK = 0x10;
125 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK = 0x40;
126
127 FLAC_API const char * const FLAC__SubframeTypeString[] = {
128         "CONSTANT",
129         "VERBATIM",
130         "FIXED",
131         "LPC"
132 };
133
134 FLAC_API const char * const FLAC__ChannelAssignmentString[] = {
135         "INDEPENDENT",
136         "LEFT_SIDE",
137         "RIGHT_SIDE",
138         "MID_SIDE"
139 };
140
141 FLAC_API const char * const FLAC__FrameNumberTypeString[] = {
142         "FRAME_NUMBER_TYPE_FRAME_NUMBER",
143         "FRAME_NUMBER_TYPE_SAMPLE_NUMBER"
144 };
145
146 FLAC_API const char * const FLAC__MetadataTypeString[] = {
147         "STREAMINFO",
148         "PADDING",
149         "APPLICATION",
150         "SEEKTABLE",
151         "VORBIS_COMMENT",
152         "CUESHEET"
153 };
154
155 FLAC_API FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate)
156 {
157         if(
158                 sample_rate == 0 ||
159                 sample_rate > FLAC__MAX_SAMPLE_RATE ||
160                 (
161                         sample_rate >= (1u << 16) &&
162                         !(sample_rate % 1000 == 0 || sample_rate % 10 == 0)
163                 )
164         ) {
165                 return false;
166         }
167         else
168                 return true;
169 }
170
171 FLAC_API FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table)
172 {
173         unsigned i;
174         FLAC__uint64 prev_sample_number = 0;
175         FLAC__bool got_prev = false;
176
177         FLAC__ASSERT(0 != seek_table);
178
179         for(i = 0; i < seek_table->num_points; i++) {
180                 if(got_prev) {
181                         if(
182                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
183                                 seek_table->points[i].sample_number <= prev_sample_number
184                         )
185                                 return false;
186                 }
187                 prev_sample_number = seek_table->points[i].sample_number;
188                 got_prev = true;
189         }
190
191         return true;
192 }
193
194 /* used as the sort predicate for qsort() */
195 static int seekpoint_compare_(const FLAC__StreamMetadata_SeekPoint *l, const FLAC__StreamMetadata_SeekPoint *r)
196 {
197         /* we don't just 'return l->sample_number - r->sample_number' since the result (FLAC__int64) might overflow an 'int' */
198         if(l->sample_number == r->sample_number)
199                 return 0;
200         else if(l->sample_number < r->sample_number)
201                 return -1;
202         else
203                 return 1;
204 }
205
206 FLAC_API unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table)
207 {
208         unsigned i, j;
209         FLAC__bool first;
210
211         FLAC__ASSERT(0 != seek_table);
212
213         /* sort the seekpoints */
214         qsort(seek_table->points, seek_table->num_points, sizeof(FLAC__StreamMetadata_SeekPoint), (int (*)(const void *, const void *))seekpoint_compare_);
215
216         /* uniquify the seekpoints */
217         first = true;
218         for(i = j = 0; i < seek_table->num_points; i++) {
219                 if(seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER) {
220                         if(!first) {
221                                 if(seek_table->points[i].sample_number == seek_table->points[j-1].sample_number)
222                                         continue;
223                         }
224                 }
225                 first = false;
226                 seek_table->points[j++] = seek_table->points[i];
227         }
228
229         for(i = j; i < seek_table->num_points; i++) {
230                 seek_table->points[i].sample_number = FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
231                 seek_table->points[i].stream_offset = 0;
232                 seek_table->points[i].frame_samples = 0;
233         }
234
235         return j;
236 }
237
238 FLAC_API FLAC__bool FLAC__format_cuesheet_is_legal(const FLAC__StreamMetadata_CueSheet *cue_sheet, FLAC__bool check_cd_da_subset, const char **violation)
239 {
240         unsigned i, j;
241
242         if(check_cd_da_subset) {
243                 if(cue_sheet->lead_in < 2 * 44100) {
244                         if(violation) *violation = "CD-DA cue sheet must have a lead-in length of at least 2 seconds";
245                         return false;
246                 }
247                 if(cue_sheet->lead_in % 588 != 0) {
248                         if(violation) *violation = "CD-DA cue sheet lead-in length must be evenly divisible by 588 samples";
249                         return false;
250                 }
251         }
252
253         if(cue_sheet->num_tracks == 0) {
254                 if(violation) *violation = "cue sheet must have at least one track (the lead-out)";
255                 return false;
256         }
257
258         if(check_cd_da_subset && cue_sheet->tracks[cue_sheet->num_tracks-1].number != 170) {
259                 if(violation) *violation = "CD-DA cue sheet must have a lead-out track number 170 (0xAA)";
260                 return false;
261         }
262
263         for(i = 0; i < cue_sheet->num_tracks; i++) {
264                 if(cue_sheet->tracks[i].number == 0) {
265                         if(violation) *violation = "cue sheet may not have a track number 0";
266                         return false;
267                 }
268
269                 if(check_cd_da_subset) {
270                         if(!((cue_sheet->tracks[i].number >= 1 && cue_sheet->tracks[i].number <= 99) || cue_sheet->tracks[i].number == 170)) {
271                                 if(violation) *violation = "CD-DA cue sheet track number must be 1-99 or 170";
272                                 return false;
273                         }
274                 }
275
276                 if(check_cd_da_subset && cue_sheet->tracks[i].offset % 588 != 0) {
277                         if(violation) *violation = "CD-DA cue sheet track offset must be evenly divisible by 588 samples";
278                         return false;
279                 }
280
281                 if(i < cue_sheet->num_tracks - 1) {
282                         if(cue_sheet->tracks[i].num_indices == 0) {
283                                 if(violation) *violation = "cue sheet track must have at least one index point";
284                                 return false;
285                         }
286
287                         if(cue_sheet->tracks[i].indices[0].number > 1) {
288                                 if(violation) *violation = "cue sheet track's first index number must be 0 or 1";
289                                 return false;
290                         }
291                 }
292
293                 for(j = 0; j < cue_sheet->tracks[i].num_indices; j++) {
294                         if(check_cd_da_subset && cue_sheet->tracks[i].indices[j].offset % 588 != 0) {
295                                 if(violation) *violation = "CD-DA cue sheet track index offset must be evenly divisible by 588 samples";
296                                 return false;
297                         }
298
299                         if(j > 0) {
300                                 if(cue_sheet->tracks[i].indices[j].number != cue_sheet->tracks[i].indices[j-1].number + 1) {
301                                         if(violation) *violation = "cue sheet track index numbers must increase by 1";
302                                         return false;
303                                 }
304                         }
305                 }
306         }
307
308         return true;
309 }
310
311 /*
312  * These routines are private to libFLAC
313  */
314 unsigned FLAC__format_get_max_rice_partition_order(unsigned blocksize, unsigned predictor_order)
315 {
316         return
317                 FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(
318                         FLAC__format_get_max_rice_partition_order_from_blocksize(blocksize),
319                         blocksize,
320                         predictor_order
321                 );
322 }
323
324 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize(unsigned blocksize)
325 {
326         unsigned max_rice_partition_order = 0;
327         while(!(blocksize & 1)) {
328                 max_rice_partition_order++;
329                 blocksize >>= 1;
330         }
331         return min(FLAC__MAX_RICE_PARTITION_ORDER, max_rice_partition_order);
332 }
333
334 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(unsigned limit, unsigned blocksize, unsigned predictor_order)
335 {
336         unsigned max_rice_partition_order = limit;
337
338         while(max_rice_partition_order > 0 && (blocksize >> max_rice_partition_order) <= predictor_order)
339                 max_rice_partition_order--;
340
341         FLAC__ASSERT(
342                 (max_rice_partition_order == 0 && blocksize >= predictor_order) ||
343                 (max_rice_partition_order > 0 && blocksize >> max_rice_partition_order > predictor_order)
344         );
345
346         return max_rice_partition_order;
347 }
348
349 void FLAC__format_entropy_coding_method_partitioned_rice_contents_init(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
350 {
351         FLAC__ASSERT(0 != object);
352
353         object->parameters = 0;
354         object->raw_bits = 0;
355         object->capacity_by_order = 0;
356 }
357
358 void FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
359 {
360         FLAC__ASSERT(0 != object);
361
362         if(0 != object->parameters)
363                 free(object->parameters);
364         if(0 != object->raw_bits)
365                 free(object->raw_bits);
366         FLAC__format_entropy_coding_method_partitioned_rice_contents_init(object);
367 }
368
369 FLAC__bool FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(FLAC__EntropyCodingMethod_PartitionedRiceContents *object, unsigned max_partition_order)
370 {
371         FLAC__ASSERT(0 != object);
372
373         FLAC__ASSERT(object->capacity_by_order > 0 || (0 == object->parameters && 0 == object->raw_bits));
374
375         if(object->capacity_by_order < max_partition_order) {
376                 if(0 == (object->parameters = (unsigned*)realloc(object->parameters, sizeof(unsigned)*(1 << max_partition_order))))
377                         return false;
378                 if(0 == (object->raw_bits = (unsigned*)realloc(object->raw_bits, sizeof(unsigned)*(1 << max_partition_order))))
379                         return false;
380                 object->capacity_by_order = max_partition_order;
381         }
382
383         return true;
384 }