src/libFLAC/format.c

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