xref: /btstack/src/classic/btstack_cvsd_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  * CVSD Packet Loss Concealment
40  *
41  */
42 
43 #ifndef BTSTACK_CVSD_PLC_H
44 #define BTSTACK_CVSD_PLC_H
45 
46 #include <stdint.h>
47 #include "btstack_bool.h"
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 #define BTSTACK_CVSD_PLC_SAMPLE_FORMAT int16_t
54 
55 #define CVSD_FS 60           /* CVSD Frame Size */
56 #define CVSD_N 256           /* Window Length for pattern matching */
57 #define CVSD_M 32            /* Template for matching */
58 #define CVSD_LHIST (CVSD_N+CVSD_FS-1)  /* Length of history buffer required */
59 #define CVSD_RT 18            /*  Reconvergence Time (samples) */
60 #define CVSD_OLAL 8         /*  OverLap-Add Length (samples) */
61 
62 /* PLC State Information */
63 typedef struct cvsd_plc_state {
64     int16_t hist[CVSD_LHIST+CVSD_FS+CVSD_RT+CVSD_OLAL];
65     int16_t bestlag;
66     int     nbf;
67 
68     // number processed samples
69     uint32_t good_samples;
70 
71     // summary of processed good and bad frames
72     int good_frames_nr;
73     int bad_frames_nr;
74     int zero_frames_nr;
75     int frame_count;
76     int max_consecutive_bad_frames_nr;
77 } btstack_cvsd_plc_state_t;
78 
79 // All int16 audio samples are in host endiness
80 void btstack_cvsd_plc_init(btstack_cvsd_plc_state_t *plc_state);
81 void btstack_cvsd_plc_bad_frame(btstack_cvsd_plc_state_t *plc_state, uint16_t num_samples, int16_t *out);
82 void btstack_cvsd_plc_good_frame(btstack_cvsd_plc_state_t *plc_state, uint16_t num_samples, int16_t *in, int16_t *out);
83 void btstack_cvsd_plc_process_data(btstack_cvsd_plc_state_t * state, bool bad_frame, int16_t * in, uint16_t num_samples, int16_t * out);
84 void btstack_cvsd_dump_statistics(btstack_cvsd_plc_state_t * state);
85 
86 // testing only
87 int   btstack_cvsd_plc_pattern_match(BTSTACK_CVSD_PLC_SAMPLE_FORMAT *y);
88 float btstack_cvsd_plc_amplitude_match(btstack_cvsd_plc_state_t *plc_state, uint16_t num_samples, BTSTACK_CVSD_PLC_SAMPLE_FORMAT *y, BTSTACK_CVSD_PLC_SAMPLE_FORMAT bestmatch);
89 BTSTACK_CVSD_PLC_SAMPLE_FORMAT btstack_cvsd_plc_crop_sample(float val);
90 float btstack_cvsd_plc_rcos(int index);
91 
92 #ifdef OCTAVE_OUTPUT
93 void btstack_cvsd_plc_octave_set_base_name(const char * name);
94 #endif
95 
96 #if defined __cplusplus
97 }
98 #endif
99 
100 #endif // BTSTACK_CVSD_PLC_H
101