736668e18a28b7fca084d97d0cab982a11abab7d
[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 min
27 #undef min
28 #endif
29 #define min(a,b) ((a)<(b)?(a):(b))
30
31 #if defined _MSC_VER || defined __MINW32__
32 /* yet one more hack because of MSVC6: */
33 const FLAC__byte *FLAC__VENDOR_STRING = "reference libFLAC 1.0.4_beta 20020823";
34 #else
35 const FLAC__byte *FLAC__VENDOR_STRING = "reference libFLAC " FLAC__VERSION_STRING " 20020823";
36 #endif
37
38 const FLAC__byte FLAC__STREAM_SYNC_STRING[4] = { 'f','L','a','C' };
39 const unsigned FLAC__STREAM_SYNC = 0x664C6143;
40 const unsigned FLAC__STREAM_SYNC_LEN = 32; /* bits */;
41
42 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN = 16; /* bits */
43 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN = 16; /* bits */
44 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN = 24; /* bits */
45 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN = 24; /* bits */
46 const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN = 20; /* bits */
47 const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN = 3; /* bits */
48 const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN = 5; /* bits */
49 const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN = 36; /* bits */
50 const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN = 128; /* bits */
51
52 const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN = 32; /* bits */
53
54 const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN = 64; /* bits */
55 const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN = 64; /* bits */
56 const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN = 16; /* bits */
57
58 const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER = 0xffffffffffffffff;
59
60 const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN = 32; /* bits */
61 const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN = 32; /* bits */
62
63 const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN = 1; /* bits */
64 const unsigned FLAC__STREAM_METADATA_TYPE_LEN = 7; /* bits */
65 const unsigned FLAC__STREAM_METADATA_LENGTH_LEN = 24; /* bits */
66
67 const unsigned FLAC__FRAME_HEADER_SYNC = 0x3ffe;
68 const unsigned FLAC__FRAME_HEADER_SYNC_LEN = 14; /* bits */
69 const unsigned FLAC__FRAME_HEADER_RESERVED_LEN = 2; /* bits */
70 const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN = 4; /* bits */
71 const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN = 4; /* bits */
72 const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN = 4; /* bits */
73 const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN = 3; /* bits */
74 const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN = 1; /* bits */
75 const unsigned FLAC__FRAME_HEADER_CRC_LEN = 8; /* bits */
76
77 const unsigned FLAC__FRAME_FOOTER_CRC_LEN = 16; /* bits */
78
79 const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN = 2; /* bits */
80 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN = 4; /* bits */
81 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN = 4; /* bits */
82 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN = 5; /* bits */
83
84 const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER = 15; /* == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
85
86 const char * const FLAC__EntropyCodingMethodTypeString[] = {
87         "PARTITIONED_RICE"
88 };
89
90 const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN = 4; /* bits */
91 const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN = 5; /* bits */
92
93 const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN = 1; /* bits */
94 const unsigned FLAC__SUBFRAME_TYPE_LEN = 6; /* bits */
95 const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN = 1; /* bits */
96
97 const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK = 0x00;
98 const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK = 0x02;
99 const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK = 0x10;
100 const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK = 0x40;
101
102 const char * const FLAC__SubframeTypeString[] = {
103         "CONSTANT",
104         "VERBATIM",
105         "FIXED",
106         "LPC"
107 };
108
109 const char * const FLAC__ChannelAssignmentString[] = {
110         "INDEPENDENT",
111         "LEFT_SIDE",
112         "RIGHT_SIDE",
113         "MID_SIDE"
114 };
115
116 const char * const FLAC__FrameNumberTypeString[] = {
117         "FRAME_NUMBER_TYPE_FRAME_NUMBER",
118         "FRAME_NUMBER_TYPE_SAMPLE_NUMBER"
119 };
120
121 const char * const FLAC__MetadataTypeString[] = {
122         "STREAMINFO",
123         "PADDING",
124         "APPLICATION",
125         "SEEKTABLE",
126         "VORBIS_COMMENT"
127 };
128
129 FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate)
130 {
131         if(
132                 sample_rate == 0 ||
133                 sample_rate > FLAC__MAX_SAMPLE_RATE ||
134                 (
135                         sample_rate >= (1u << 16) &&
136                         !(sample_rate % 1000 == 0 || sample_rate % 10 == 0)
137                 )
138         ) {
139                 return false;
140         }
141         else
142                 return true;
143 }
144
145 FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table)
146 {
147         unsigned i;
148         FLAC__uint64 prev_sample_number = 0;
149         FLAC__bool got_prev = false;
150
151         FLAC__ASSERT(0 != seek_table);
152
153         for(i = 0; i < seek_table->num_points; i++) {
154                 if(got_prev) {
155                         if(
156                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
157                                 seek_table->points[i].sample_number <= prev_sample_number
158                         )
159                                 return false;
160                 }
161                 prev_sample_number = seek_table->points[i].sample_number;
162                 got_prev = true;
163         }
164
165         return true;
166 }
167
168 /* used as the sort predicate for qsort() */
169 static int seekpoint_compare_(const FLAC__StreamMetadata_SeekPoint *l, const FLAC__StreamMetadata_SeekPoint *r)
170 {
171         /* we don't just 'return l->sample_number - r->sample_number' since the result (FLAC__int64) might overflow an 'int' */
172         if(l->sample_number == r->sample_number)
173                 return 0;
174         else if(l->sample_number < r->sample_number)
175                 return -1;
176         else
177                 return 1;
178 }
179
180 unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table)
181 {
182         unsigned i, j;
183         FLAC__bool first;
184
185         FLAC__ASSERT(0 != seek_table);
186
187         /* sort the seekpoints */
188         qsort(seek_table->points, seek_table->num_points, sizeof(FLAC__StreamMetadata_SeekPoint), (int (*)(const void *, const void *))seekpoint_compare_);
189
190         /* uniquify the seekpoints */
191         first = true;
192         for(i = j = 0; i < seek_table->num_points; i++) {
193                 if(seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER) {
194                         if(!first) {
195                                 if(seek_table->points[i].sample_number == seek_table->points[j-1].sample_number)
196                                         continue;
197                         }
198                 }
199                 first = false;
200                 seek_table->points[j++] = seek_table->points[i];
201         }
202
203         for(i = j; i < seek_table->num_points; i++) {
204                 seek_table->points[i].sample_number = FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
205                 seek_table->points[i].stream_offset = 0;
206                 seek_table->points[i].frame_samples = 0;
207         }
208
209         return j;
210 }
211
212 unsigned FLAC__format_get_max_rice_partition_order(unsigned blocksize, unsigned predictor_order)
213 {
214         return
215                 FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(
216                         FLAC__format_get_max_rice_partition_order_from_blocksize(blocksize),
217                         blocksize,
218                         predictor_order
219                 );
220 }
221
222 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize(unsigned blocksize)
223 {
224         unsigned max_rice_partition_order = 0;
225         while(!(blocksize & 1)) {
226                 max_rice_partition_order++;
227                 blocksize >>= 1;
228         }
229         return min(FLAC__MAX_RICE_PARTITION_ORDER, max_rice_partition_order);
230 }
231
232 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(unsigned limit, unsigned blocksize, unsigned predictor_order)
233 {
234         unsigned max_rice_partition_order = limit;
235
236         while(max_rice_partition_order > 0 && (blocksize >> max_rice_partition_order) <= predictor_order)
237                 max_rice_partition_order--;
238
239         FLAC__ASSERT(blocksize >> max_rice_partition_order > predictor_order);
240
241         return max_rice_partition_order;
242 }
243
244 void FLAC__format_entropy_coding_method_partitioned_rice_contents_init(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
245 {
246         FLAC__ASSERT(0 != object);
247
248         object->parameters = 0;
249         object->raw_bits = 0;
250         object->capacity_by_order = 0;
251 }
252
253 void FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
254 {
255         FLAC__ASSERT(0 != object);
256
257         if(0 != object->parameters)
258                 free(object->parameters);
259         if(0 != object->raw_bits)
260                 free(object->raw_bits);
261         FLAC__format_entropy_coding_method_partitioned_rice_contents_init(object);
262 }
263
264 FLAC__bool FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(FLAC__EntropyCodingMethod_PartitionedRiceContents *object, unsigned max_partition_order)
265 {
266         FLAC__ASSERT(0 != object);
267
268         FLAC__ASSERT(object->capacity_by_order > 0 || (0 == object->parameters && 0 == object->raw_bits));
269
270         if(object->capacity_by_order < max_partition_order) {
271                 if(0 == (object->parameters = realloc(object->parameters, sizeof(unsigned)*(1 << max_partition_order))))
272                         return false;
273                 if(0 == (object->raw_bits = realloc(object->raw_bits, sizeof(unsigned)*(1 << max_partition_order))))
274                         return false;
275                 object->capacity_by_order = max_partition_order;
276         }
277
278         return true;
279 }