xref: /btstack/src/classic/btstack_sbc_plc.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2016 BlueKitchen GmbH
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  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /**
39  * SBC Packet Loss Concealment
40  *
41  */
42 
43 #ifndef BTSTACK_SBC_PLC_H
44 #define BTSTACK_SBC_PLC_H
45 
46 #include <stdint.h>
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 #define SBC_FS 120          /* SBC Frame Size */
53 #define SBC_N 512           /* 32ms - Window Length for pattern matching */
54 #define SBC_M 64            /* 4ms - Template for matching */
55 #define SBC_LHIST (SBC_N+SBC_FS-1)  /* Length of history buffer required */
56 #define SBC_RT 36           /* SBC Reconvergence Time (samples) */
57 #define SBC_OLAL 16         /* OverLap-Add Length (samples) */
58 
59 /* PLC State Information */
60 typedef struct sbc_plc_state {
61     int16_t hist[SBC_LHIST+SBC_FS+SBC_RT+SBC_OLAL];
62     int16_t bestlag;
63     int     nbf;
64 
65     // summary of processed good and bad frames
66     int good_frames_nr;
67     int bad_frames_nr;
68     int frame_count;
69     int max_consecutive_bad_frames_nr;
70 } btstack_sbc_plc_state_t;
71 
72 // All int16 audio samples are in host endiness
73 void btstack_sbc_plc_init(btstack_sbc_plc_state_t *plc_state);
74 void btstack_sbc_plc_bad_frame(btstack_sbc_plc_state_t *plc_state, int16_t *ZIRbuf, int16_t *out);
75 void btstack_sbc_plc_good_frame(btstack_sbc_plc_state_t *plc_state, int16_t *in, int16_t *out);
76 uint8_t * btstack_sbc_plc_zero_signal_frame(void);
77 void btstack_sbc_dump_statistics(btstack_sbc_plc_state_t * state);
78 
79 #ifdef OCTAVE_OUTPUT
80 void btstack_sbc_plc_octave_set_base_name(const char * name);
81 #endif
82 
83 #if defined __cplusplus
84 }
85 #endif
86 
87 #endif // BTSTACK_SBC_PLC_H
88