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