Check that palctrl is available on init instead of crashing when trying to use
[ffmpeg.git] / libavcodec / mlp.h
1 /*
2  * MLP codec common header file
3  * Copyright (c) 2007-2008 Ian Caulfield
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVCODEC_MLP_H
23 #define AVCODEC_MLP_H
24
25 #include <stdint.h>
26
27 #include "avcodec.h"
28
29 /** Last possible matrix channel for each codec */
30 #define MAX_MATRIX_CHANNEL_MLP      5
31 #define MAX_MATRIX_CHANNEL_TRUEHD   7
32 /** Maximum number of channels in a valid stream.
33  *  MLP   : 5.1 + 2 noise channels -> 8 channels
34  *  TrueHD: 7.1                    -> 8 channels
35  */
36 #define MAX_CHANNELS                8
37
38 /** Maximum number of matrices used in decoding; most streams have one matrix
39  *  per output channel, but some rematrix a channel (usually 0) more than once.
40  */
41 #define MAX_MATRICES_MLP            6
42 #define MAX_MATRICES_TRUEHD         8
43 #define MAX_MATRICES                8
44
45 /** Maximum number of substreams that can be decoded.
46  *  MLP's limit is 2. TrueHD supports at least up to 3.
47  */
48 #define MAX_SUBSTREAMS      3
49
50 /** maximum sample frequency seen in files */
51 #define MAX_SAMPLERATE      192000
52
53 /** maximum number of audio samples within one access unit */
54 #define MAX_BLOCKSIZE       (40 * (MAX_SAMPLERATE / 48000))
55 /** next power of two greater than MAX_BLOCKSIZE */
56 #define MAX_BLOCKSIZE_POW2  (64 * (MAX_SAMPLERATE / 48000))
57
58 /** number of allowed filters */
59 #define NUM_FILTERS         2
60
61 /** The maximum number of taps in IIR and FIR filters. */
62 #define MAX_FIR_ORDER       8
63 #define MAX_IIR_ORDER       4
64
65 /** Code that signals end of a stream. */
66 #define END_OF_STREAM       0xd234d234
67
68 #define FIR 0
69 #define IIR 1
70
71 /** filter data */
72 typedef struct {
73     uint8_t     order; ///< number of taps in filter
74     uint8_t     shift; ///< Right shift to apply to output of filter.
75
76     int32_t     state[MAX_FIR_ORDER];
77 } FilterParams;
78
79 /** sample data coding information */
80 typedef struct {
81     FilterParams filter_params[NUM_FILTERS];
82     int32_t     coeff[NUM_FILTERS][MAX_FIR_ORDER];
83
84     int16_t     huff_offset;      ///< Offset to apply to residual values.
85     int32_t     sign_huff_offset; ///< sign/rounding-corrected version of huff_offset
86     uint8_t     codebook;         ///< Which VLC codebook to use to read residuals.
87     uint8_t     huff_lsbs;        ///< Size of residual suffix not encoded using VLC.
88 } ChannelParams;
89
90 /** Tables defining the Huffman codes.
91  *  There are three entropy coding methods used in MLP (four if you count
92  *  "none" as a method). These use the same sequences for codes starting with
93  *  00 or 01, but have different codes starting with 1.
94  */
95 extern const uint8_t ff_mlp_huffman_tables[3][18][2];
96
97 /** MLP uses checksums that seem to be based on the standard CRC algorithm, but
98  *  are not (in implementation terms, the table lookup and XOR are reversed).
99  *  We can implement this behavior using a standard av_crc on all but the
100  *  last element, then XOR that with the last element.
101  */
102 uint8_t  ff_mlp_checksum8 (const uint8_t *buf, unsigned int buf_size);
103 uint16_t ff_mlp_checksum16(const uint8_t *buf, unsigned int buf_size);
104
105 /** Calculate an 8-bit checksum over a restart header -- a non-multiple-of-8
106  *  number of bits, starting two bits into the first byte of buf.
107  */
108 uint8_t ff_mlp_restart_checksum(const uint8_t *buf, unsigned int bit_size);
109
110 /** XOR together all the bytes of a buffer.
111  *  Does this belong in dspcontext?
112  */
113 uint8_t ff_mlp_calculate_parity(const uint8_t *buf, unsigned int buf_size);
114
115 void ff_mlp_init_crc(void);
116
117 /** XOR four bytes into one. */
118 static inline uint8_t xor_32_to_8(uint32_t value)
119 {
120     value ^= value >> 16;
121     value ^= value >>  8;
122     return value;
123 }
124
125 #endif /* AVCODEC_MLP_H */