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