rearrange to make more sense
[flac.git] / include / FLAC / format.h
1 /* libFLAC - Free Lossless Audio Coder library
2  * Copyright (C) 2000,2001  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 #ifndef FLAC__FORMAT_H
21 #define FLAC__FORMAT_H
22
23 #include "ordinals.h"
24
25 /* changing the following values to be higher will break the framing and hence the stream format, so DON'T! */
26 #define FLAC__MIN_BLOCK_SIZE (16u)
27 #define FLAC__MAX_BLOCK_SIZE (65535u)
28 #define FLAC__MAX_CHANNELS (8u)
29 /*NOTE: only up to 24 because of the current predictor coefficient quantization and the fact we use int32s for all work */
30 #define FLAC__MAX_BITS_PER_SAMPLE (24u)
31 /* the following is ((2 ** 20) - 1) div 10 */
32 #define FLAC__MAX_SAMPLE_RATE (1048570u)
33 #define FLAC__MAX_LPC_ORDER (32u)
34 #define FLAC__MIN_QLP_COEFF_PRECISION (5u)
35 /* changing this also means changing all of fixed.c and more, so DON'T! */
36 #define FLAC__MAX_FIXED_ORDER (4u)
37 #define FLAC__MAX_RICE_PARTITION_ORDER (15u)
38
39 /* VERSION comes from configure */
40 #define FLAC__VERSION_STRING VERSION
41 extern const unsigned FLAC__MAJOR_VERSION;
42 extern const unsigned FLAC__MINOR_VERSION;
43
44 extern const byte     FLAC__STREAM_SYNC_STRING[4]; /* = "fLaC" */;
45 extern const unsigned FLAC__STREAM_SYNC; /* = 0x664C6143 */;
46 extern const unsigned FLAC__STREAM_SYNC_LEN; /* = 32 bits */;
47
48
49 /*****************************************************************************
50  *
51  * NOTE: Within the bitstream, all fixed-width numbers are big-endian coded.
52  *       All numbers are unsigned unless otherwise noted.
53  *
54  *****************************************************************************/
55
56
57 /*****************************************************************************
58  *
59  * Subframe structures
60  *
61  *****************************************************************************/
62
63 /*****************************************************************************/
64
65 typedef enum {
66         FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE = 0
67 } FLAC__EntropyCodingMethodType;
68
69 /*****************************************************************************
70  *
71  *  4: partition order => (2 ** order) subdivisions
72  */
73 typedef struct {
74         unsigned order;
75         unsigned parameters[1 << FLAC__MAX_RICE_PARTITION_ORDER];
76 } FLAC__EntropyCodingMethod_PartitionedRice;
77
78 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN; /* = 4 bits */
79 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN; /* = 4 bits */
80
81 /*****************************************************************************
82  *
83  *  2: entropy coding method:
84  *     00: partitioned rice coding
85  *     01-11: reserved
86  *  ?: entropy coding method data
87  */
88 typedef struct {
89         FLAC__EntropyCodingMethodType type;
90         union {
91                 FLAC__EntropyCodingMethod_PartitionedRice partitioned_rice;
92         } data;
93 } FLAC__EntropyCodingMethod;
94
95 extern const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN; /* = 2 bits */
96
97 /*****************************************************************************/
98
99 typedef enum {
100         FLAC__SUBFRAME_TYPE_CONSTANT = 0,
101         FLAC__SUBFRAME_TYPE_VERBATIM = 1,
102         FLAC__SUBFRAME_TYPE_FIXED = 2,
103         FLAC__SUBFRAME_TYPE_LPC = 3
104 } FLAC__SubframeType;
105
106 /*****************************************************************************
107  *
108  * n: constant value for signal; n = frame's bits-per-sample
109  */
110 typedef struct {
111         int32 value;
112 } FLAC__SubframeHeader_Constant;
113
114 /*****************************************************************************
115  *
116  * n*i: unencoded signal; n = frame's bits-per-sample, i = frame's blocksize
117  */
118 /* There is no (trivial) for structure FLAC__SubframeHeader_Verbatim */
119
120 /*****************************************************************************
121  *
122  *  n: unencoded warm-up samples (n = fixed-predictor order * bits per sample)
123  *  ?: entropy coding method info
124  *  ?: encoded residual ((blocksize minus fixed-predictor order) samples)
125  *  The order is stored in the main subframe header
126  */
127 typedef struct {
128         FLAC__EntropyCodingMethod entropy_coding_method;
129         unsigned order;
130         int32 warmup[FLAC__MAX_FIXED_ORDER];
131 } FLAC__SubframeHeader_Fixed;
132
133 /*****************************************************************************
134  *
135  *  n: unencoded warm-up samples (n = lpc order * bits per sample)
136  *  4: (qlp coeff precision in bits)-1 (1111 = invalid, use to check for erroneous sync)
137  *  5: qlp shift needed in bits (signed)
138  *  n: unencoded predictor coefficients (n = lpc order * qlp coeff precision)
139  *  ?: entropy coding method info
140  *  ?: encoded residual ((blocksize minus lpc order) samples)
141  *  The order is stored in the main subframe header
142  */
143 typedef struct {
144         FLAC__EntropyCodingMethod entropy_coding_method;
145         unsigned order;
146         unsigned qlp_coeff_precision;
147         int quantization_level;
148         int32 qlp_coeff[FLAC__MAX_LPC_ORDER];
149         int32 warmup[FLAC__MAX_LPC_ORDER];
150 } FLAC__SubframeHeader_LPC;
151
152 extern const unsigned FLAC__SUBFRAME_HEADER_LPC_QLP_COEFF_PRECISION_LEN; /* = 4 bits */
153 extern const unsigned FLAC__SUBFRAME_HEADER_LPC_QLP_SHIFT_LEN; /* = 5 bits */
154
155 /*****************************************************************************
156  *
157  *  8: subframe type
158  *       xxxxxxx1: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
159  *       00000000: constant value
160  *       00000010: verbatim
161  *       000001x0: reserved
162  *       00001xx0: reserved
163  *       0001xxx0: fixed predictor, xxx=order <= 4, else reserved
164  *       001xxxx0: reserved
165  *       01xxxxx0: lpc, xxxxx=order-1
166  *       1xxxxxxx: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
167  *  ?: subframe-specific header (c.f. FLAC__SubframeHeader_*)
168  */
169 typedef struct {
170         FLAC__SubframeType type;
171         union {
172                 FLAC__SubframeHeader_Constant constant;
173                 FLAC__SubframeHeader_Fixed fixed;
174                 FLAC__SubframeHeader_LPC lpc;
175         } data; /* data will be undefined for FLAC__SUBFRAME_TYPE_VERBATIM */
176 } FLAC__SubframeHeader;
177
178 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_CONSTANT; /* = 0x00 */
179 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_VERBATIM; /* = 0x02 */
180 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_FIXED; /* = 0x10 */
181 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_LPC; /* = 0x40 */
182 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_LEN; /* = 8 bits */
183
184 typedef struct {
185         FLAC__SubframeHeader header;
186         const int32 *data;
187 } FLAC__Subframe;
188
189 /*****************************************************************************/
190
191
192 /*****************************************************************************
193  *
194  * Frame structures
195  *
196  *****************************************************************************/
197
198 typedef enum {
199         FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT = 0,
200         FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE = 1,
201         FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE = 2,
202         FLAC__CHANNEL_ASSIGNMENT_MID_SIDE = 3
203 } FLAC__ChannelAssignment;
204
205 /*****************************************************************************
206  *
207  *  9: sync code '111111110'
208  *  3: blocksize in samples
209  *        000: get from stream header => implies constant blocksize throughout stream
210  *        001: 192 samples (AES/EBU) => implies constant blocksize throughout stream
211  *        010-101: 576 * (2^(2-n)) samples, i.e. 576/1152/2304/4608 => implies constant blocksize throughout stream
212  *        110: get 8 bit (blocksize-1) from end of header => variable blocksize throughout stream unless it's the last frame
213  *        111: get 16 bit (blocksize-1) from end of header => variable blocksize throughout stream unless it's the last frame
214  *  4: sample rate:
215  *        0000: get from stream header
216  *        0001-0011: reserved
217  *        0100: 8kHz
218  *        0101: 16kHz
219  *        0110: 22.05kHz
220  *        0111: 24kHz
221  *        1000: 32kHz
222  *        1001: 44.1kHz
223  *        1010: 48kHz
224  *        1011: 96kHz
225  *        1100: get 8 bit sample rate (in kHz) from end of header
226  *        1101: get 16 bit sample rate (in Hz) from end of header
227  *        1110: get 16 bit sample rate (in tens of Hz) from end of header
228  *        1111: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
229  *  4: channel assignment
230  *     0000-0111: (number of independent channels)-1.  when == 0001, channel 0 is the left channel and channel 1 is the right
231  *     1000: left/side stereo : channel 0 is the left             channel, channel 1 is the side(difference) channel
232  *     1001: right/side stereo: channel 0 is the side(difference) channel, channel 1 is the right            channel
233  *     1010: mid/side stereo  : channel 0 is the mid(average)     channel, channel 1 is the side(difference) channel
234  *     1011-1111: reserved
235  *  3: sample size in bits
236  *        000: get from stream header
237  *        001: 8 bits per sample
238  *        010: 12 bits per sample
239  *        011: reserved
240  *        100: 16 bits per sample
241  *        101: 20 bits per sample
242  *        110: 24 bits per sample
243  *        111: reserved
244  *  1: zero pad, to prevent sync-fooling string of 1s (use to check for erroneous sync)
245  *  ?: if(variable blocksize)
246  *        8-56: 'UTF-8' coded sample number (decoded number is 0-36 bits) (use to check for erroneous sync)
247  *     else
248  *        8-48: 'UTF-8' coded frame number (decoded number is 0-31 bits) (use to check for erroneous sync)
249  *  ?: if(blocksize bits == 11x)
250  *        8/16 bit (blocksize-1)
251  *  ?: if(sample rate bits == 11xx)
252  *        8/16 bit sample rate
253  *  8: CRC-8 (polynomial = x^8 + x^2 + x + 1) of everything before the crc, including the sync code
254  */
255 typedef struct {
256         unsigned blocksize; /* in samples */
257         unsigned sample_rate; /* in Hz */
258         unsigned channels;
259         FLAC__ChannelAssignment channel_assignment;
260         unsigned bits_per_sample;
261         union {
262                 uint32 frame_number;
263                 uint64 sample_number;
264         } number;
265 } FLAC__FrameHeader;
266
267 extern const unsigned FLAC__FRAME_HEADER_SYNC; /* = 0x1fe */
268 extern const unsigned FLAC__FRAME_HEADER_SYNC_LEN; /* = 9 bits */
269 extern const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN; /* = 3 bits */
270 extern const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN; /* = 4 bits */
271 extern const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN; /* = 4 bits */
272 extern const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN; /* = 3 bits */
273 extern const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN; /* = 1 bit */
274 extern const unsigned FLAC__FRAME_HEADER_CRC8_LEN; /* = 8 bits */
275
276 typedef struct {
277         FLAC__FrameHeader header;
278         FLAC__Subframe subframes[FLAC__MAX_CHANNELS];
279 } FLAC__Frame;
280
281 /*****************************************************************************/
282
283
284 /*****************************************************************************
285  *
286  * Meta-data structures
287  *
288  *****************************************************************************/
289
290 typedef enum {
291         FLAC__METADATA_TYPE_ENCODING = 0
292 } FLAC__MetaDataType;
293
294 /*****************************************************************************
295  *
296  * 16: minimum blocksize (in samples) of all blocks in the stream
297  * 16: maximum blocksize (in samples) of all blocks in the stream
298  * 24: minimum framesize (in bytes) of all frames in the stream; 0 => unknown
299  * 24: maximum framesize (in bytes) of all frames in the stream; 0 => unknown
300  * 20: sample rate in Hz, 0 is invalid
301  *  3: (number of channels)-1
302  *  5: (bits per sample)-1
303  * 36: total samples, 0 => unknown
304  *128: MD5 digest of the original unencoded audio data
305  *---- -----------------
306  * 34  bytes total
307  */
308 typedef struct {
309         unsigned min_blocksize, max_blocksize;
310         unsigned min_framesize, max_framesize;
311         unsigned sample_rate;
312         unsigned channels;
313         unsigned bits_per_sample;
314         uint64 total_samples;
315         byte md5sum[16];
316 } FLAC__StreamMetaData_Encoding;
317
318 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MIN_BLOCK_SIZE_LEN; /* = 16 bits */
319 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MAX_BLOCK_SIZE_LEN; /* = 16 bits */
320 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MIN_FRAME_SIZE_LEN; /* = 24 bits */
321 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MAX_FRAME_SIZE_LEN; /* = 24 bits */
322 extern const unsigned FLAC__STREAM_METADATA_ENCODING_SAMPLE_RATE_LEN; /* = 20 bits */
323 extern const unsigned FLAC__STREAM_METADATA_ENCODING_CHANNELS_LEN; /* = 3 bits */
324 extern const unsigned FLAC__STREAM_METADATA_ENCODING_BITS_PER_SAMPLE_LEN; /* = 5 bits */
325 extern const unsigned FLAC__STREAM_METADATA_ENCODING_TOTAL_SAMPLES_LEN; /* = 36 bits */
326 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MD5SUM_LEN; /* = 128 bits */
327 extern const unsigned FLAC__STREAM_METADATA_ENCODING_LENGTH; /* = 34 bytes */
328
329 /*****************************************************************************
330  *
331  *  1: =1 if this is the last meta-data block, else =0
332  *  7: meta-data type (c.f. FLAC__MetaDataType)
333  * 24: length (in bytes) of the block-specific data to follow
334  *---- -----------------
335  *  4  bytes total
336  */
337 typedef struct {
338         FLAC__MetaDataType type;
339         bool is_last;
340         unsigned length; /* in bytes */
341         union {
342                 FLAC__StreamMetaData_Encoding encoding;
343         } data;
344 } FLAC__StreamMetaData;
345
346 extern const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN; /* = 1 bits */
347 extern const unsigned FLAC__STREAM_METADATA_TYPE_LEN; /* = 7 bits */
348 extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /* = 24 bits */
349
350 /*****************************************************************************/
351
352
353 /*****************************************************************************
354  *
355  * Stream structures
356  *
357  *****************************************************************************/
358
359 typedef struct {
360         FLAC__StreamMetaData_Encoding metadata;
361         FLAC__Frame *frames;
362 } FLAC__Stream;
363
364 /*****************************************************************************/
365
366 #endif