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