fix a calcuation bug in FLAC__lpc_compute_best_order()
[flac.git] / src / libFLAC / format.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include <stdio.h>
33 #include <stdlib.h> /* for qsort() */
34 #include "FLAC/assert.h"
35 #include "FLAC/format.h"
36 #include "private/format.h"
37
38 #ifdef HAVE_CONFIG_H
39 #include <config.h>
40 #endif
41
42 #ifdef min
43 #undef min
44 #endif
45 #define min(a,b) ((a)<(b)?(a):(b))
46
47 /* adjust for compilers that can't understand using LLU suffix for uint64_t literals */
48 #ifdef _MSC_VER
49 #define FLAC__U64L(x) x
50 #else
51 #define FLAC__U64L(x) x##LLU
52 #endif
53
54 /* VERSION should come from configure */
55 FLAC_API const char *FLAC__VERSION_STRING = VERSION;
56
57 #if defined _MSC_VER || defined __MINW32__
58 /* yet one more hack because of MSVC6: */
59 /*@@@@@@WAS:FLAC_API const char *FLAC__VENDOR_STRING = "reference libFLAC 1.1.2 20050205";*/
60 FLAC_API const char *FLAC__VENDOR_STRING = "reference libFLAC CVS 20060425";
61 #else
62 FLAC_API const char *FLAC__VENDOR_STRING = "reference libFLAC " VERSION " 20060425";
63 #endif
64
65 FLAC_API const FLAC__byte FLAC__STREAM_SYNC_STRING[4] = { 'f','L','a','C' };
66 FLAC_API const unsigned FLAC__STREAM_SYNC = 0x664C6143;
67 FLAC_API const unsigned FLAC__STREAM_SYNC_LEN = 32; /* bits */
68
69 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN = 16; /* bits */
70 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN = 16; /* bits */
71 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN = 24; /* bits */
72 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN = 24; /* bits */
73 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN = 20; /* bits */
74 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN = 3; /* bits */
75 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN = 5; /* bits */
76 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN = 36; /* bits */
77 FLAC_API const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN = 128; /* bits */
78
79 FLAC_API const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN = 32; /* bits */
80
81 FLAC_API const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN = 64; /* bits */
82 FLAC_API const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN = 64; /* bits */
83 FLAC_API const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN = 16; /* bits */
84
85 FLAC_API const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER = FLAC__U64L(0xffffffffffffffff);
86
87 FLAC_API const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN = 32; /* bits */
88 FLAC_API const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN = 32; /* bits */
89
90 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN = 64; /* bits */
91 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN = 8; /* bits */
92 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN = 3*8; /* bits */
93
94 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN = 64; /* bits */
95 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN = 8; /* bits */
96 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN = 12*8; /* bits */
97 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN = 1; /* bit */
98 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN = 1; /* bit */
99 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN = 6+13*8; /* bits */
100 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN = 8; /* bits */
101
102 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN = 128*8; /* bits */
103 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN = 64; /* bits */
104 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN = 1; /* bit */
105 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN = 7+258*8; /* bits */
106 FLAC_API const unsigned FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN = 8; /* bits */
107
108 FLAC_API const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN = 1; /* bits */
109 FLAC_API const unsigned FLAC__STREAM_METADATA_TYPE_LEN = 7; /* bits */
110 FLAC_API const unsigned FLAC__STREAM_METADATA_LENGTH_LEN = 24; /* bits */
111
112 FLAC_API const unsigned FLAC__FRAME_HEADER_SYNC = 0x3ffe;
113 FLAC_API const unsigned FLAC__FRAME_HEADER_SYNC_LEN = 14; /* bits */
114 FLAC_API const unsigned FLAC__FRAME_HEADER_RESERVED_LEN = 2; /* bits */
115 FLAC_API const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN = 4; /* bits */
116 FLAC_API const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN = 4; /* bits */
117 FLAC_API const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN = 4; /* bits */
118 FLAC_API const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN = 3; /* bits */
119 FLAC_API const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN = 1; /* bits */
120 FLAC_API const unsigned FLAC__FRAME_HEADER_CRC_LEN = 8; /* bits */
121
122 FLAC_API const unsigned FLAC__FRAME_FOOTER_CRC_LEN = 16; /* bits */
123
124 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN = 2; /* bits */
125 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN = 4; /* bits */
126 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN = 4; /* bits */
127 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN = 5; /* bits */
128
129 FLAC_API const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER = 15; /* == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
130
131 FLAC_API const char * const FLAC__EntropyCodingMethodTypeString[] = {
132         "PARTITIONED_RICE"
133 };
134
135 FLAC_API const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN = 4; /* bits */
136 FLAC_API const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN = 5; /* bits */
137
138 FLAC_API const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN = 1; /* bits */
139 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_LEN = 6; /* bits */
140 FLAC_API const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN = 1; /* bits */
141
142 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK = 0x00;
143 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK = 0x02;
144 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK = 0x10;
145 FLAC_API const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK = 0x40;
146
147 FLAC_API const char * const FLAC__SubframeTypeString[] = {
148         "CONSTANT",
149         "VERBATIM",
150         "FIXED",
151         "LPC"
152 };
153
154 FLAC_API const char * const FLAC__ChannelAssignmentString[] = {
155         "INDEPENDENT",
156         "LEFT_SIDE",
157         "RIGHT_SIDE",
158         "MID_SIDE"
159 };
160
161 FLAC_API const char * const FLAC__FrameNumberTypeString[] = {
162         "FRAME_NUMBER_TYPE_FRAME_NUMBER",
163         "FRAME_NUMBER_TYPE_SAMPLE_NUMBER"
164 };
165
166 FLAC_API const char * const FLAC__MetadataTypeString[] = {
167         "STREAMINFO",
168         "PADDING",
169         "APPLICATION",
170         "SEEKTABLE",
171         "VORBIS_COMMENT",
172         "CUESHEET"
173 };
174
175 FLAC_API FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate)
176 {
177         if(
178                 sample_rate == 0 ||
179                 sample_rate > FLAC__MAX_SAMPLE_RATE ||
180                 (
181                         sample_rate >= (1u << 16) &&
182                         !(sample_rate % 1000 == 0 || sample_rate % 10 == 0)
183                 )
184         ) {
185                 return false;
186         }
187         else
188                 return true;
189 }
190
191 FLAC_API FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table)
192 {
193         unsigned i;
194         FLAC__uint64 prev_sample_number = 0;
195         FLAC__bool got_prev = false;
196
197         FLAC__ASSERT(0 != seek_table);
198
199         for(i = 0; i < seek_table->num_points; i++) {
200                 if(got_prev) {
201                         if(
202                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
203                                 seek_table->points[i].sample_number <= prev_sample_number
204                         )
205                                 return false;
206                 }
207                 prev_sample_number = seek_table->points[i].sample_number;
208                 got_prev = true;
209         }
210
211         return true;
212 }
213
214 /* used as the sort predicate for qsort() */
215 static int seekpoint_compare_(const FLAC__StreamMetadata_SeekPoint *l, const FLAC__StreamMetadata_SeekPoint *r)
216 {
217         /* we don't just 'return l->sample_number - r->sample_number' since the result (FLAC__int64) might overflow an 'int' */
218         if(l->sample_number == r->sample_number)
219                 return 0;
220         else if(l->sample_number < r->sample_number)
221                 return -1;
222         else
223                 return 1;
224 }
225
226 FLAC_API unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table)
227 {
228         unsigned i, j;
229         FLAC__bool first;
230
231         FLAC__ASSERT(0 != seek_table);
232
233         /* sort the seekpoints */
234         qsort(seek_table->points, seek_table->num_points, sizeof(FLAC__StreamMetadata_SeekPoint), (int (*)(const void *, const void *))seekpoint_compare_);
235
236         /* uniquify the seekpoints */
237         first = true;
238         for(i = j = 0; i < seek_table->num_points; i++) {
239                 if(seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER) {
240                         if(!first) {
241                                 if(seek_table->points[i].sample_number == seek_table->points[j-1].sample_number)
242                                         continue;
243                         }
244                 }
245                 first = false;
246                 seek_table->points[j++] = seek_table->points[i];
247         }
248
249         for(i = j; i < seek_table->num_points; i++) {
250                 seek_table->points[i].sample_number = FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
251                 seek_table->points[i].stream_offset = 0;
252                 seek_table->points[i].frame_samples = 0;
253         }
254
255         return j;
256 }
257
258 /*
259  * also disallows non-shortest-form encodings, c.f.
260  *   http://www.unicode.org/versions/corrigendum1.html
261  * and a more clear explanation at the end of this section:
262  *   http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
263  */
264 static __inline unsigned utf8len_(const FLAC__byte *utf8)
265 {
266         FLAC__ASSERT(0 != utf8);
267         if ((utf8[0] & 0x80) == 0) {
268                 return 1;
269         }
270         else if ((utf8[0] & 0xE0) == 0xC0 && (utf8[1] & 0xC0) == 0x80) {
271                 if ((utf8[0] & 0xFE) == 0xC0) /* overlong sequence check */
272                         return 0;
273                 return 2;
274         }
275         else if ((utf8[0] & 0xF0) == 0xE0 && (utf8[1] & 0xC0) == 0x80 && (utf8[2] & 0xC0) == 0x80) {
276                 if (utf8[0] == 0xE0 && (utf8[1] & 0xE0) == 0x80) /* overlong sequence check */
277                         return 0;
278                 /* illegal surrogates check (U+D800...U+DFFF and U+FFFE...U+FFFF) */
279                 if (utf8[0] == 0xED && (utf8[1] & 0xE0) == 0xA0) /* D800-DFFF */
280                         return 0;
281                 if (utf8[0] == 0xEF && utf8[1] == 0xBF && (utf8[2] & 0xFE) == 0xBE) /* FFFE-FFFF */
282                         return 0;
283                 return 3;
284         }
285         else if ((utf8[0] & 0xF8) == 0xF0 && (utf8[1] & 0xC0) == 0x80 && (utf8[2] & 0xC0) == 0x80 && (utf8[3] & 0xC0) == 0x80) {
286                 if (utf8[0] == 0xF0 && (utf8[1] & 0xF0) == 0x80) /* overlong sequence check */
287                         return 0;
288                 return 4;
289         }
290         else if ((utf8[0] & 0xFC) == 0xF8 && (utf8[1] & 0xC0) == 0x80 && (utf8[2] & 0xC0) == 0x80 && (utf8[3] & 0xC0) == 0x80 && (utf8[4] & 0xC0) == 0x80) {
291                 if (utf8[0] == 0xF8 && (utf8[1] & 0xF8) == 0x80) /* overlong sequence check */
292                         return 0;
293                 return 5;
294         }
295         else if ((utf8[0] & 0xFE) == 0xFC && (utf8[1] & 0xC0) == 0x80 && (utf8[2] & 0xC0) == 0x80 && (utf8[3] & 0xC0) == 0x80 && (utf8[4] & 0xC0) == 0x80 && (utf8[5] & 0xC0) == 0x80) {
296                 if (utf8[0] == 0xFC && (utf8[1] & 0xFC) == 0x80) /* overlong sequence check */
297                         return 0;
298                 return 6;
299         }
300         else {
301                 return 0;
302         }
303 }
304
305 FLAC_API FLAC__bool FLAC__format_vorbiscomment_entry_name_is_legal(const char *name)
306 {
307         char c;
308         for(c = *name; c; c = *(++name))
309                 if(c < 0x20 || c == 0x3d || c > 0x7d)
310                         return false;
311         return true;
312 }
313
314 FLAC_API FLAC__bool FLAC__format_vorbiscomment_entry_value_is_legal(const FLAC__byte *value, unsigned length)
315 {
316         if(length == (unsigned)(-1)) {
317                 while(*value) {
318                         unsigned n = utf8len_(value);
319                         if(n == 0)
320                                 return false;
321                         value += n;
322                 }
323         }
324         else {
325                 const FLAC__byte *end = value + length;
326                 while(value < end) {
327                         unsigned n = utf8len_(value);
328                         if(n == 0)
329                                 return false;
330                         value += n;
331                 }
332                 if(value != end)
333                         return false;
334         }
335         return true;
336 }
337
338 FLAC_API FLAC__bool FLAC__format_vorbiscomment_entry_is_legal(const FLAC__byte *entry, unsigned length)
339 {
340         const FLAC__byte *s, *end;
341
342         for(s = entry, end = s + length; s < end && *s != '='; s++) {
343                 if(*s < 0x20 || *s > 0x7D)
344                         return false;
345         }
346         if(s == end)
347                 return false;
348
349         s++; /* skip '=' */
350
351         while(s < end) {
352                 unsigned n = utf8len_(s);
353                 if(n == 0)
354                         return false;
355                 s += n;
356         }
357         if(s != end)
358                 return false;
359
360         return true;
361 }
362
363 FLAC_API FLAC__bool FLAC__format_cuesheet_is_legal(const FLAC__StreamMetadata_CueSheet *cue_sheet, FLAC__bool check_cd_da_subset, const char **violation)
364 {
365         unsigned i, j;
366
367         if(check_cd_da_subset) {
368                 if(cue_sheet->lead_in < 2 * 44100) {
369                         if(violation) *violation = "CD-DA cue sheet must have a lead-in length of at least 2 seconds";
370                         return false;
371                 }
372                 if(cue_sheet->lead_in % 588 != 0) {
373                         if(violation) *violation = "CD-DA cue sheet lead-in length must be evenly divisible by 588 samples";
374                         return false;
375                 }
376         }
377
378         if(cue_sheet->num_tracks == 0) {
379                 if(violation) *violation = "cue sheet must have at least one track (the lead-out)";
380                 return false;
381         }
382
383         if(check_cd_da_subset && cue_sheet->tracks[cue_sheet->num_tracks-1].number != 170) {
384                 if(violation) *violation = "CD-DA cue sheet must have a lead-out track number 170 (0xAA)";
385                 return false;
386         }
387
388         for(i = 0; i < cue_sheet->num_tracks; i++) {
389                 if(cue_sheet->tracks[i].number == 0) {
390                         if(violation) *violation = "cue sheet may not have a track number 0";
391                         return false;
392                 }
393
394                 if(check_cd_da_subset) {
395                         if(!((cue_sheet->tracks[i].number >= 1 && cue_sheet->tracks[i].number <= 99) || cue_sheet->tracks[i].number == 170)) {
396                                 if(violation) *violation = "CD-DA cue sheet track number must be 1-99 or 170";
397                                 return false;
398                         }
399                 }
400
401                 if(check_cd_da_subset && cue_sheet->tracks[i].offset % 588 != 0) {
402                         if(violation) {
403                                 if(i == cue_sheet->num_tracks-1) /* the lead-out track... */
404                                         *violation = "CD-DA cue sheet lead-out offset must be evenly divisible by 588 samples";
405                                 else
406                                         *violation = "CD-DA cue sheet track offset must be evenly divisible by 588 samples";
407                         }
408                         return false;
409                 }
410
411                 if(i < cue_sheet->num_tracks - 1) {
412                         if(cue_sheet->tracks[i].num_indices == 0) {
413                                 if(violation) *violation = "cue sheet track must have at least one index point";
414                                 return false;
415                         }
416
417                         if(cue_sheet->tracks[i].indices[0].number > 1) {
418                                 if(violation) *violation = "cue sheet track's first index number must be 0 or 1";
419                                 return false;
420                         }
421                 }
422
423                 for(j = 0; j < cue_sheet->tracks[i].num_indices; j++) {
424                         if(check_cd_da_subset && cue_sheet->tracks[i].indices[j].offset % 588 != 0) {
425                                 if(violation) *violation = "CD-DA cue sheet track index offset must be evenly divisible by 588 samples";
426                                 return false;
427                         }
428
429                         if(j > 0) {
430                                 if(cue_sheet->tracks[i].indices[j].number != cue_sheet->tracks[i].indices[j-1].number + 1) {
431                                         if(violation) *violation = "cue sheet track index numbers must increase by 1";
432                                         return false;
433                                 }
434                         }
435                 }
436         }
437
438         return true;
439 }
440
441 /*
442  * These routines are private to libFLAC
443  */
444 unsigned FLAC__format_get_max_rice_partition_order(unsigned blocksize, unsigned predictor_order)
445 {
446         return
447                 FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(
448                         FLAC__format_get_max_rice_partition_order_from_blocksize(blocksize),
449                         blocksize,
450                         predictor_order
451                 );
452 }
453
454 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize(unsigned blocksize)
455 {
456         unsigned max_rice_partition_order = 0;
457         while(!(blocksize & 1)) {
458                 max_rice_partition_order++;
459                 blocksize >>= 1;
460         }
461         return min(FLAC__MAX_RICE_PARTITION_ORDER, max_rice_partition_order);
462 }
463
464 unsigned FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(unsigned limit, unsigned blocksize, unsigned predictor_order)
465 {
466         unsigned max_rice_partition_order = limit;
467
468         while(max_rice_partition_order > 0 && (blocksize >> max_rice_partition_order) <= predictor_order)
469                 max_rice_partition_order--;
470
471         FLAC__ASSERT(
472                 (max_rice_partition_order == 0 && blocksize >= predictor_order) ||
473                 (max_rice_partition_order > 0 && blocksize >> max_rice_partition_order > predictor_order)
474         );
475
476         return max_rice_partition_order;
477 }
478
479 void FLAC__format_entropy_coding_method_partitioned_rice_contents_init(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
480 {
481         FLAC__ASSERT(0 != object);
482
483         object->parameters = 0;
484         object->raw_bits = 0;
485         object->capacity_by_order = 0;
486 }
487
488 void FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(FLAC__EntropyCodingMethod_PartitionedRiceContents *object)
489 {
490         FLAC__ASSERT(0 != object);
491
492         if(0 != object->parameters)
493                 free(object->parameters);
494         if(0 != object->raw_bits)
495                 free(object->raw_bits);
496         FLAC__format_entropy_coding_method_partitioned_rice_contents_init(object);
497 }
498
499 FLAC__bool FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(FLAC__EntropyCodingMethod_PartitionedRiceContents *object, unsigned max_partition_order)
500 {
501         FLAC__ASSERT(0 != object);
502
503         FLAC__ASSERT(object->capacity_by_order > 0 || (0 == object->parameters && 0 == object->raw_bits));
504
505         if(object->capacity_by_order < max_partition_order) {
506                 if(0 == (object->parameters = (unsigned*)realloc(object->parameters, sizeof(unsigned)*(1 << max_partition_order))))
507                         return false;
508                 if(0 == (object->raw_bits = (unsigned*)realloc(object->raw_bits, sizeof(unsigned)*(1 << max_partition_order))))
509                         return false;
510                 object->capacity_by_order = max_partition_order;
511         }
512
513         return true;
514 }