use VERSION macro for version instead of hardcoding it
[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 typedef enum {
57         FLAC__METADATA_TYPE_ENCODING = 0
58 } FLAC__MetaDataType;
59
60 /*****************************************************************************
61  *
62  * 16: minimum blocksize (in samples) of all blocks in the stream
63  * 16: maximum blocksize (in samples) of all blocks in the stream
64  * 24: minimum framesize (in bytes) of all frames in the stream; 0 => unknown
65  * 24: maximum framesize (in bytes) of all frames in the stream; 0 => unknown
66  * 20: sample rate in Hz, 0 is invalid
67  *  3: (number of channels)-1
68  *  5: (bits per sample)-1
69  * 36: total samples, 0 => unknown
70  *128: MD5 digest of the original unencoded audio data
71  *---- -----------------
72  * 34  bytes total
73  */
74 typedef struct {
75         unsigned min_blocksize, max_blocksize;
76         unsigned min_framesize, max_framesize;
77         unsigned sample_rate;
78         unsigned channels;
79         unsigned bits_per_sample;
80         uint64 total_samples;
81         byte md5sum[16];
82 } FLAC__StreamMetaData_Encoding;
83
84 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MIN_BLOCK_SIZE_LEN; /* = 16 bits */
85 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MAX_BLOCK_SIZE_LEN; /* = 16 bits */
86 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MIN_FRAME_SIZE_LEN; /* = 24 bits */
87 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MAX_FRAME_SIZE_LEN; /* = 24 bits */
88 extern const unsigned FLAC__STREAM_METADATA_ENCODING_SAMPLE_RATE_LEN; /* = 20 bits */
89 extern const unsigned FLAC__STREAM_METADATA_ENCODING_CHANNELS_LEN; /* = 3 bits */
90 extern const unsigned FLAC__STREAM_METADATA_ENCODING_BITS_PER_SAMPLE_LEN; /* = 5 bits */
91 extern const unsigned FLAC__STREAM_METADATA_ENCODING_TOTAL_SAMPLES_LEN; /* = 36 bits */
92 extern const unsigned FLAC__STREAM_METADATA_ENCODING_MD5SUM_LEN; /* = 128 bits */
93 extern const unsigned FLAC__STREAM_METADATA_ENCODING_LENGTH; /* = 34 bytes */
94
95 /*****************************************************************************
96  *
97  *  1: =1 if this is the last meta-data block, else =0
98  *  7: meta-data type (c.f. FLAC__MetaDataType)
99  * 24: length (in bytes) of the block-specific data to follow
100  *---- -----------------
101  *  4  bytes total
102  */
103 typedef struct {
104         FLAC__MetaDataType type;
105         bool is_last;
106         unsigned length; /* in bytes */
107         union {
108                 FLAC__StreamMetaData_Encoding encoding;
109         } data;
110 } FLAC__StreamMetaData;
111
112 extern const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN; /* = 1 bits */
113 extern const unsigned FLAC__STREAM_METADATA_TYPE_LEN; /* = 7 bits */
114 extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /* = 24 bits */
115
116 /*****************************************************************************/
117
118 typedef enum {
119         FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE = 0
120 } FLAC__EntropyCodingMethodType;
121
122 /*****************************************************************************
123  *
124  *  4: partition order => (2 ** order) subdivisions
125  */
126 typedef struct {
127         unsigned order;
128         unsigned parameters[1 << FLAC__MAX_RICE_PARTITION_ORDER];
129 } FLAC__EntropyCodingMethod_PartitionedRice;
130
131 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN; /* = 4 bits */
132 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN; /* = 4 bits */
133
134 /*****************************************************************************
135  *
136  *  2: entropy coding method:
137  *     00: partitioned rice coding
138  *     01-11: reserved
139  *  ?: entropy coding method data
140  */
141 typedef struct {
142         FLAC__EntropyCodingMethodType type;
143         union {
144                 FLAC__EntropyCodingMethod_PartitionedRice partitioned_rice;
145         } data;
146 } FLAC__EntropyCodingMethod;
147
148 extern const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN; /* = 2 bits */
149
150 /*****************************************************************************/
151
152 typedef enum {
153         FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT = 0,
154         FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE = 1,
155         FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE = 2,
156         FLAC__CHANNEL_ASSIGNMENT_MID_SIDE = 3
157 } FLAC__ChannelAssignment;
158
159 /*****************************************************************************
160  *
161  *  9: sync code '111111110'
162  *  3: blocksize in samples
163  *        000: get from stream header => implies constant blocksize throughout stream
164  *        001: 192 samples (AES/EBU) => implies constant blocksize throughout stream
165  *        010-101: 576 * (2^(2-n)) samples, i.e. 576/1152/2304/4608 => implies constant blocksize throughout stream
166  *        110: get 8 bit (blocksize-1) from end of header => variable blocksize throughout stream unless it's the last frame
167  *        111: get 16 bit (blocksize-1) from end of header => variable blocksize throughout stream unless it's the last frame
168  *  4: sample rate:
169  *        0000: get from stream header
170  *        0001-0011: reserved
171  *        0100: 8kHz
172  *        0101: 16kHz
173  *        0110: 22.05kHz
174  *        0111: 24kHz
175  *        1000: 32kHz
176  *        1001: 44.1kHz
177  *        1010: 48kHz
178  *        1011: 96kHz
179  *        1100: get 8 bit sample rate (in kHz) from end of header
180  *        1101: get 16 bit sample rate (in Hz) from end of header
181  *        1110: get 16 bit sample rate (in tens of Hz) from end of header
182  *        1111: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
183  *  4: channel assignment
184  *     0000-0111: (number of independent channels)-1.  when == 0001, channel 0 is the left channel and channel 1 is the right
185  *     1000: left/side stereo : channel 0 is the left             channel, channel 1 is the side(difference) channel
186  *     1001: right/side stereo: channel 0 is the side(difference) channel, channel 1 is the right            channel
187  *     1010: mid/side stereo  : channel 0 is the mid(average)     channel, channel 1 is the side(difference) channel
188  *     1011-1111: reserved
189  *  3: sample size in bits
190  *        000: get from stream header
191  *        001: 8 bits per sample
192  *        010: 12 bits per sample
193  *        011: reserved
194  *        100: 16 bits per sample
195  *        101: 20 bits per sample
196  *        110: 24 bits per sample
197  *        111: reserved
198  *  1: zero pad, to prevent sync-fooling string of 1s (use to check for erroneous sync)
199  *  ?: if(variable blocksize)
200  *        8-56: 'UTF-8' coded sample number (decoded number is 0-36 bits) (use to check for erroneous sync)
201  *     else
202  *        8-48: 'UTF-8' coded frame number (decoded number is 0-31 bits) (use to check for erroneous sync)
203  *  ?: if(blocksize bits == 11x)
204  *        8/16 bit (blocksize-1)
205  *  ?: if(sample rate bits == 11xx)
206  *        8/16 bit sample rate
207  *  8: CRC-8 (polynomial = x^8 + x^2 + x + 1) of everything before the crc, including the sync code
208  */
209 typedef struct {
210         unsigned blocksize; /* in samples */
211         unsigned sample_rate; /* in Hz */
212         unsigned channels;
213         FLAC__ChannelAssignment channel_assignment;
214         unsigned bits_per_sample;
215         union {
216                 uint32 frame_number;
217                 uint64 sample_number;
218         } number;
219 } FLAC__FrameHeader;
220
221 extern const unsigned FLAC__FRAME_HEADER_SYNC; /* = 0x1fe */
222 extern const unsigned FLAC__FRAME_HEADER_SYNC_LEN; /* = 9 bits */
223 extern const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN; /* = 3 bits */
224 extern const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN; /* = 4 bits */
225 extern const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN; /* = 4 bits */
226 extern const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN; /* = 3 bits */
227 extern const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN; /* = 1 bit */
228 extern const unsigned FLAC__FRAME_HEADER_CRC8_LEN; /* = 8 bits */
229
230 /*****************************************************************************/
231
232 typedef enum {
233         FLAC__SUBFRAME_TYPE_CONSTANT = 0,
234         FLAC__SUBFRAME_TYPE_VERBATIM = 1,
235         FLAC__SUBFRAME_TYPE_FIXED = 2,
236         FLAC__SUBFRAME_TYPE_LPC = 3
237 } FLAC__SubframeType;
238
239 /*****************************************************************************
240  *
241  * n: constant value for signal; n = frame's bits-per-sample
242  */
243 typedef struct {
244         int32 value;
245 } FLAC__SubframeHeader_Constant;
246
247 /*****************************************************************************
248  *
249  * n*i: unencoded signal; n = frame's bits-per-sample, i = frame's blocksize
250  */
251 /* There is no (trivial) for structure FLAC__SubframeHeader_Verbatim */
252
253 /*****************************************************************************
254  *
255  *  n: unencoded warm-up samples (n = fixed-predictor order * bits per sample)
256  *  ?: entropy coding method info
257  *  ?: encoded residual ((blocksize minus fixed-predictor order) samples)
258  *  The order is stored in the main subframe header
259  */
260 typedef struct {
261         FLAC__EntropyCodingMethod entropy_coding_method;
262         unsigned order;
263         int32 warmup[FLAC__MAX_FIXED_ORDER];
264 } FLAC__SubframeHeader_Fixed;
265
266 /*****************************************************************************
267  *
268  *  n: unencoded warm-up samples (n = lpc order * bits per sample)
269  *  4: (qlp coeff precision in bits)-1 (1111 = invalid, use to check for erroneous sync)
270  *  5: qlp shift needed in bits (signed)
271  *  n: unencoded predictor coefficients (n = lpc order * qlp coeff precision)
272  *  ?: entropy coding method info
273  *  ?: encoded residual ((blocksize minus lpc order) samples)
274  *  The order is stored in the main subframe header
275  */
276 typedef struct {
277         FLAC__EntropyCodingMethod entropy_coding_method;
278         unsigned order;
279         unsigned qlp_coeff_precision;
280         int quantization_level;
281         int32 qlp_coeff[FLAC__MAX_LPC_ORDER];
282         int32 warmup[FLAC__MAX_LPC_ORDER];
283 } FLAC__SubframeHeader_LPC;
284
285 extern const unsigned FLAC__SUBFRAME_HEADER_LPC_QLP_COEFF_PRECISION_LEN; /* = 4 bits */
286 extern const unsigned FLAC__SUBFRAME_HEADER_LPC_QLP_SHIFT_LEN; /* = 5 bits */
287
288 /*****************************************************************************
289  *
290  *  8: subframe type
291  *       xxxxxxx1: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
292  *       00000000: constant value
293  *       00000010: verbatim
294  *       000001x0: reserved
295  *       00001xx0: reserved
296  *       0001xxx0: fixed predictor, xxx=order <= 4, else reserved
297  *       001xxxx0: reserved
298  *       01xxxxx0: lpc, xxxxx=order-1
299  *       1xxxxxxx: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
300  *  ?: subframe-specific header (c.f. FLAC__SubframeHeader_*)
301  */
302 typedef struct {
303         FLAC__SubframeType type;
304         union {
305                 FLAC__SubframeHeader_Constant constant;
306                 FLAC__SubframeHeader_Fixed fixed;
307                 FLAC__SubframeHeader_LPC lpc;
308         } data; /* data will be undefined for FLAC__SUBFRAME_TYPE_VERBATIM */
309 } FLAC__SubframeHeader;
310
311 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_CONSTANT; /* = 0x00 */
312 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_VERBATIM; /* = 0x02 */
313 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_FIXED; /* = 0x10 */
314 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_LPC; /* = 0x40 */
315 extern const unsigned FLAC__SUBFRAME_HEADER_TYPE_LEN; /* = 8 bits */
316
317 /*****************************************************************************/
318
319 #endif