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