1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000,2001 Josh Coalson
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.
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.
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.
20 #ifndef FLAC__FORMAT_H
21 #define FLAC__FORMAT_H
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 #define FLAC__MIN_BITS_PER_SAMPLE (4u)
30 /*NOTE: only up to 24 because of the current predictor coefficient quantization and the fact we use int32s for all work */
31 #define FLAC__MAX_BITS_PER_SAMPLE (24u)
32 /* the following is ((2 ** 20) - 1) div 10 */
33 #define FLAC__MAX_SAMPLE_RATE (1048570u)
34 #define FLAC__MAX_LPC_ORDER (32u)
35 #define FLAC__MIN_QLP_COEFF_PRECISION (5u)
36 /* changing FLAC__MAX_FIXED_ORDER also means changing all of fixed.c and more, so DON'T! */
37 #define FLAC__MAX_FIXED_ORDER (4u)
38 #define FLAC__MAX_RICE_PARTITION_ORDER (15u)
40 /* VERSION should come from configure */
42 #define FLAC__VERSION_STRING VERSION
44 #define FLAC__VERSION_STRING "0.10"
47 extern const byte FLAC__STREAM_SYNC_STRING[4]; /* = "fLaC" */;
48 extern const unsigned FLAC__STREAM_SYNC; /* = 0x664C6143 */;
49 extern const unsigned FLAC__STREAM_SYNC_LEN; /* = 32 bits */;
52 /*****************************************************************************
54 * NOTE: Within the bitstream, all fixed-width numbers are big-endian coded.
55 * All numbers are unsigned unless otherwise noted.
57 *****************************************************************************/
60 /*****************************************************************************
64 *****************************************************************************/
66 /*****************************************************************************/
69 FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE = 0
70 } FLAC__EntropyCodingMethodType;
71 extern const char *FLAC__EntropyCodingMethodTypeString[];
73 /*****************************************************************************
75 * 4: partition order => (2 ** order) subdivisions
79 unsigned parameters[1 << FLAC__MAX_RICE_PARTITION_ORDER];
80 unsigned raw_bits[1 << FLAC__MAX_RICE_PARTITION_ORDER];
81 } FLAC__EntropyCodingMethod_PartitionedRice;
83 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN; /* = 4 bits */
84 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN; /* = 4 bits */
85 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN; /* = 5 bits */
87 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER; /* = (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
89 /*****************************************************************************
91 * 2: entropy coding method:
92 * 00: partitioned rice coding
94 * ?: entropy coding method data
97 FLAC__EntropyCodingMethodType type;
99 FLAC__EntropyCodingMethod_PartitionedRice partitioned_rice;
101 } FLAC__EntropyCodingMethod;
103 extern const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN; /* = 2 bits */
105 /*****************************************************************************/
108 FLAC__SUBFRAME_TYPE_CONSTANT = 0,
109 FLAC__SUBFRAME_TYPE_VERBATIM = 1,
110 FLAC__SUBFRAME_TYPE_FIXED = 2,
111 FLAC__SUBFRAME_TYPE_LPC = 3
112 } FLAC__SubframeType;
113 extern const char *FLAC__SubframeTypeString[];
115 /*****************************************************************************
117 * n: constant value for signal; n = frame's bits-per-sample
121 } FLAC__Subframe_Constant;
123 /*****************************************************************************
125 * n*i: unencoded signal; n = frame's bits-per-sample, i = frame's blocksize
129 } FLAC__Subframe_Verbatim;
131 /*****************************************************************************
133 * n: unencoded warm-up samples (n = fixed-predictor order * bits per sample)
134 * ?: entropy coding method info
135 * ?: encoded residual ((blocksize minus fixed-predictor order) samples)
136 * The order is stored in the main subframe header
139 FLAC__EntropyCodingMethod entropy_coding_method;
141 int32 warmup[FLAC__MAX_FIXED_ORDER];
142 const int32 *residual;
143 } FLAC__Subframe_Fixed;
145 /*****************************************************************************
147 * n: unencoded warm-up samples (n = lpc order * bits per sample)
148 * 4: (qlp coeff precision in bits)-1 (1111 = invalid, use to check for erroneous sync)
149 * 5: qlp shift needed in bits (signed)
150 * n: unencoded predictor coefficients (n = lpc order * qlp coeff precision)
151 * ?: entropy coding method info
152 * ?: encoded residual ((blocksize minus lpc order) samples)
153 * The order is stored in the main subframe header
156 FLAC__EntropyCodingMethod entropy_coding_method;
158 unsigned qlp_coeff_precision;
159 int quantization_level;
160 int32 qlp_coeff[FLAC__MAX_LPC_ORDER];
161 int32 warmup[FLAC__MAX_LPC_ORDER];
162 const int32 *residual;
163 } FLAC__Subframe_LPC;
165 extern const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN; /* = 4 bits */
166 extern const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN; /* = 5 bits */
168 /*****************************************************************************
170 * 1: zero pad, to prevent sync-fooling string of 1s (use to check for erroneous sync)
172 * 000000: constant value
176 * 001xxx: fixed predictor, xxx=order <= 4, else reserved
178 * 1xxxxx: lpc, xxxxx=order-1
179 * 1: 'wasted bits' flag
180 * 0: no wasted bits in source subblock
181 * 1: all samples in source subblock contain n 0 least significant bits. n-1 follows, unary coded, i.e. n=3, 001 follows, n=7, 0000001 follows.
182 * ?: unary coded (n-1)
183 * ?: subframe-specific data (c.f. FLAC__Subframe_*)
186 FLAC__SubframeType type;
188 FLAC__Subframe_Constant constant;
189 FLAC__Subframe_Fixed fixed;
190 FLAC__Subframe_LPC lpc;
191 FLAC__Subframe_Verbatim verbatim;
193 unsigned wasted_bits;
196 extern const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN; /* = 1 bit */
197 extern const unsigned FLAC__SUBFRAME_TYPE_LEN; /* = 6 bits */
198 extern const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN; /* = 1 bit */
200 extern const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK; /* = 0x00 */
201 extern const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK; /* = 0x02 */
202 extern const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK; /* = 0x10 */
203 extern const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK; /* = 0x40 */
205 /*****************************************************************************/
208 /*****************************************************************************
212 *****************************************************************************/
215 FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT = 0,
216 FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE = 1,
217 FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE = 2,
218 FLAC__CHANNEL_ASSIGNMENT_MID_SIDE = 3
219 } FLAC__ChannelAssignment;
220 extern const char *FLAC__ChannelAssignmentString[];
222 /*****************************************************************************
224 * 14: sync code '11111111111110'
226 * 00: currently required value
228 * 4: blocksize in samples
229 * 0000: get from stream header => implies constant blocksize throughout stream
230 * 0001: 192 samples (AES/EBU) => implies constant blocksize throughout stream
231 * 0010-0101: 576 * (2^(n-2)) samples, i.e. 576/1152/2304/4608 => implies constant blocksize throughout stream
232 * 0110: get 8 bit (blocksize-1) from end of header => possibly variable blocksize throughout stream unless it's the last frame
233 * 0111: get 16 bit (blocksize-1) from end of header => possibly variable blocksize throughout stream unless it's the last frame
234 * 1000-1111: 256 * (2^(n-8)) samples, i.e. 256/512/1024/2048/4096/8192/16384/32768 => implies constant blocksize throughout stream
236 * 0000: get from stream header
237 * 0001-0011: reserved
246 * 1100: get 8 bit sample rate (in kHz) from end of header
247 * 1101: get 16 bit sample rate (in Hz) from end of header
248 * 1110: get 16 bit sample rate (in tens of Hz) from end of header
249 * 1111: invalid, to prevent sync-fooling string of 1s (use to check for erroneous sync)
250 * 4: channel assignment
251 * 0000-0111: (number of independent channels)-1. when == 0001, channel 0 is the left channel and channel 1 is the right
252 * 1000: left/side stereo : channel 0 is the left channel, channel 1 is the side(difference) channel
253 * 1001: right/side stereo: channel 0 is the side(difference) channel, channel 1 is the right channel
254 * 1010: mid/side stereo : channel 0 is the mid(average) channel, channel 1 is the side(difference) channel
255 * 1011-1111: reserved
256 * 3: sample size in bits
257 * 000: get from stream header
258 * 001: 8 bits per sample
259 * 010: 12 bits per sample
261 * 100: 16 bits per sample
262 * 101: 20 bits per sample
263 * 110: 24 bits per sample
265 * 1: zero pad, to prevent sync-fooling string of 1s (use to check for erroneous sync)
266 * ?: if(variable blocksize)
267 * 8-56: 'UTF-8' coded sample number (decoded number is 0-36 bits) (use to check for erroneous sync)
269 * 8-48: 'UTF-8' coded frame number (decoded number is 0-31 bits) (use to check for erroneous sync)
270 * ?: if(blocksize bits == 11x)
271 * 8/16 bit (blocksize-1)
272 * ?: if(sample rate bits == 11xx)
273 * 8/16 bit sample rate
274 * 8: CRC-8 (polynomial = x^8 + x^2 + x^1 + x^0, initialized with 0) of everything before the crc, including the sync code
277 unsigned blocksize; /* in samples */
278 unsigned sample_rate; /* in Hz */
280 FLAC__ChannelAssignment channel_assignment;
281 unsigned bits_per_sample;
284 uint64 sample_number;
289 extern const unsigned FLAC__FRAME_HEADER_SYNC; /* = 0x3ffe */
290 extern const unsigned FLAC__FRAME_HEADER_SYNC_LEN; /* = 14 bits */
291 extern const unsigned FLAC__FRAME_HEADER_RESERVED_LEN; /* = 2 bits */
292 extern const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN; /* = 4 bits */
293 extern const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN; /* = 4 bits */
294 extern const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN; /* = 4 bits */
295 extern const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN; /* = 3 bits */
296 extern const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN; /* = 1 bit */
297 extern const unsigned FLAC__FRAME_HEADER_CRC_LEN; /* = 8 bits */
299 /*****************************************************************************
301 * 16: CRC-16 (polynomial = x^16 + x^15 + x^2 + x^0, initialized with 0) of everything before the crc, back to and including the frame header sync code
307 extern const unsigned FLAC__FRAME_FOOTER_CRC_LEN; /* = 16 bits */
310 FLAC__FrameHeader header;
311 FLAC__Subframe subframes[FLAC__MAX_CHANNELS];
312 FLAC__FrameFooter footer;
315 /*****************************************************************************/
318 /*****************************************************************************
320 * Meta-data structures
322 *****************************************************************************/
325 FLAC__METADATA_TYPE_STREAMINFO = 0,
326 FLAC__METADATA_TYPE_PADDING = 1,
327 FLAC__METADATA_TYPE_APPLICATION = 2,
328 FLAC__METADATA_TYPE_SEEKTABLE = 3
329 } FLAC__MetaDataType;
330 extern const char *FLAC__MetaDataTypeString[];
332 /*****************************************************************************
334 * 16: minimum blocksize (in samples) of all blocks in the stream
335 * 16: maximum blocksize (in samples) of all blocks in the stream
336 * 24: minimum framesize (in bytes) of all frames in the stream; 0 => unknown
337 * 24: maximum framesize (in bytes) of all frames in the stream; 0 => unknown
338 * 20: sample rate in Hz, 0 is invalid
339 * 3: (number of channels)-1
340 * 5: (bits per sample)-1
341 * 36: total samples, 0 => unknown
342 *128: MD5 digest of the original unencoded audio data
343 *---- -----------------
347 unsigned min_blocksize, max_blocksize;
348 unsigned min_framesize, max_framesize;
349 unsigned sample_rate;
351 unsigned bits_per_sample;
352 uint64 total_samples;
354 } FLAC__StreamMetaData_StreamInfo;
356 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN; /* = 16 bits */
357 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN; /* = 16 bits */
358 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN; /* = 24 bits */
359 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN; /* = 24 bits */
360 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN; /* = 20 bits */
361 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN; /* = 3 bits */
362 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN; /* = 5 bits */
363 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN; /* = 36 bits */
364 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN; /* = 128 bits */
365 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_LENGTH; /* = 34 bytes */
367 /*****************************************************************************
370 *----- -----------------
374 int dummy; /* conceptually this is an empty struct since we don't store the padding bytes */
375 /* empty structs are allowed by C++ but not C, hence the 'dummy' */
376 } FLAC__StreamMetaData_Padding;
378 /*****************************************************************************
380 * 32: Registered application ID
381 * n: Application data
382 *------- -----------------
388 } FLAC__StreamMetaData_Application;
390 extern const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN; /* = 32 bits */
392 /*****************************************************************************
394 * 64: sample number of target frame
395 * 64: offset, in bytes, of target frame with respect to beginning of first frame
396 * 16: number of samples in the target frame
397 *----- -----------------
401 uint64 sample_number;
402 uint64 stream_offset;
403 unsigned frame_samples;
404 } FLAC__StreamMetaData_SeekPoint;
406 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN; /* = 64 bits */
407 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN; /* = 64 bits */
408 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN; /* = 16 bits */
409 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_LEN; /* = 18 bytes */
411 extern const uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER; /* = 0xffffffffffffffff */
413 /*****************************************************************************
415 * 0: num_points is implied by the metadata block 'length' field (i.e. num_points = length / 18)
416 * n*18*8: seek points (n = num_points, 18 is the size of a seek point in bytes)
417 * ------- -----------------
420 * NOTE: the seek points must be sorted by ascending sample number.
421 * NOTE: each seek point's sample number must be the first sample of the target frame.
422 * NOTE: each seek point's sample number must be unique within the table.
423 * NOTE: existence of a SEEKTABLE block implies a correct setting of total_samples in the stream_info block.
424 * NOTE: behavior is undefined when more than one SEEKTABLE block is present in a stream.
428 FLAC__StreamMetaData_SeekPoint *points;
429 } FLAC__StreamMetaData_SeekTable;
431 /*****************************************************************************
433 * 1: =1 if this is the last meta-data block, else =0
434 * 7: meta-data type (c.f. FLAC__MetaDataType)
435 * 24: length (in bytes) of the block-specific data to follow
436 *---- -----------------
440 FLAC__MetaDataType type;
442 unsigned length; /* in bytes */
444 FLAC__StreamMetaData_StreamInfo stream_info;
445 FLAC__StreamMetaData_Padding padding;
446 FLAC__StreamMetaData_Application application;
447 FLAC__StreamMetaData_SeekTable seek_table;
449 } FLAC__StreamMetaData;
451 extern const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN; /* = 1 bits */
452 extern const unsigned FLAC__STREAM_METADATA_TYPE_LEN; /* = 7 bits */
453 extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /* = 24 bits */
455 /*****************************************************************************/
458 /*****************************************************************************
462 *****************************************************************************/
465 FLAC__StreamMetaData_StreamInfo stream_info;
469 /*****************************************************************************/