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