Tuning the hybrid bit-rate split
[opus.git] / src / opus_encoder.h
1 /* Copyright (c) 2010 Xiph.Org Foundation
2    Written by Jean-Marc Valin */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef OPUS_ENCODER_H
33 #define OPUS_ENCODER_H
34
35 #include "celt.h"
36 #include "opus.h"
37 #include "SKP_Silk_SDK_API.h"
38
39 /* FIXME: This is only valid for 48 kHz */
40 #define ENCODER_DELAY_COMPENSATION 130
41
42 struct OpusEncoder {
43         CELTEncoder *celt_enc;
44         SKP_SILK_SDK_EncControlStruct silk_mode;
45         void        *silk_enc;
46         int          channels;
47         int          stream_channels;
48
49     int          mode;
50         int          bandwidth;
51     /* Sampling rate (at the API level) */
52     int          Fs;
53     int          use_vbr;
54     int          bitrate_bps;
55
56     short        delay_buffer[ENCODER_DELAY_COMPENSATION*2];
57
58 #ifdef OPUS_TEST_RANGE_CODER_STATE
59     int          rangeFinal;
60 #endif
61 };
62
63
64 #endif /* OPUS_ENCODER_H */
65