xref: /btstack/src/classic/btstack_sbc_plc.c (revision 046b44372d25c7bd6fe78e5cf6e5176a1979f437)
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 MATTHIAS
24  * RINGWALD 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 #define BTSTACK_FILE__ "btstack_sbc_plc.c"
39 
40 /*
41  * btstack_sbc_plc.c
42  *
43  */
44 
45 #include <stdint.h>
46 #include <stdio.h>
47 #include <stdlib.h>
48 #include <string.h>
49 
50 #include "btstack_sbc_plc.h"
51 #include "btstack_debug.h"
52 
53 #define SAMPLE_FORMAT int16_t
54 
55 static uint8_t indices0[] = { 0xad, 0x00, 0x00, 0xc5, 0x00, 0x00, 0x00, 0x00, 0x77, 0x6d,
56 0xb6, 0xdd, 0xdb, 0x6d, 0xb7, 0x76, 0xdb, 0x6d, 0xdd, 0xb6, 0xdb, 0x77, 0x6d,
57 0xb6, 0xdd, 0xdb, 0x6d, 0xb7, 0x76, 0xdb, 0x6d, 0xdd, 0xb6, 0xdb, 0x77, 0x6d,
58 0xb6, 0xdd, 0xdb, 0x6d, 0xb7, 0x76, 0xdb, 0x6d, 0xdd, 0xb6, 0xdb, 0x77, 0x6d,
59 0xb6, 0xdd, 0xdb, 0x6d, 0xb7, 0x76, 0xdb, 0x6c};
60 
61 /* Raised COSine table for OLA */
62 static float rcos[SBC_OLAL] = {
63     0.99148655f,0.96623611f,0.92510857f,0.86950446f,
64     0.80131732f,0.72286918f,0.63683150f,0.54613418f,
65     0.45386582f,0.36316850f,0.27713082f,0.19868268f,
66     0.13049554f,0.07489143f,0.03376389f,0.00851345f};
67 
68 // taken from http://www.codeproject.com/Articles/69941/Best-Square-Root-Method-Algorithm-Function-Precisi
69 // Algorithm: Babylonian Method + some manipulations on IEEE 32 bit floating point representation
70 static float sqrt3(const float x){
71     union {
72         int i;
73         float x;
74     } u;
75     u.x = x;
76     u.i = (1<<29) + (u.i >> 1) - (1<<22);
77 
78     // Two Babylonian Steps (simplified from:)
79     // u.x = 0.5f * (u.x + x/u.x);
80     // u.x = 0.5f * (u.x + x/u.x);
81     u.x =       u.x + x/u.x;
82     u.x = 0.25f*u.x + x/u.x;
83 
84     return u.x;
85 }
86 
87 static float absolute(float x){
88      if (x < 0) x = -x;
89      return x;
90 }
91 
92 static float CrossCorrelation(SAMPLE_FORMAT *x, SAMPLE_FORMAT *y){
93     float num = 0;
94     float den = 0;
95     float x2 = 0;
96     float y2 = 0;
97     int   m;
98     for (m=0;m<SBC_M;m++){
99         num+=((float)x[m])*y[m];
100         x2+=((float)x[m])*x[m];
101         y2+=((float)y[m])*y[m];
102     }
103     den = (float)sqrt3(x2*y2);
104     return num/den;
105 }
106 
107 static int PatternMatch(SAMPLE_FORMAT *y){
108     float maxCn = -999999.0;  // large negative number
109     int   bestmatch = 0;
110     float Cn;
111     int   n;
112     for (n=0;n<SBC_N;n++){
113         Cn = CrossCorrelation(&y[SBC_LHIST-SBC_M], &y[n]);
114         if (Cn>maxCn){
115             bestmatch=n;
116             maxCn = Cn;
117         }
118     }
119     return bestmatch;
120 }
121 
122 static float AmplitudeMatch(SAMPLE_FORMAT *y, SAMPLE_FORMAT bestmatch) {
123     int   i;
124     float sumx = 0;
125     float sumy = 0.000001f;
126     float sf;
127 
128     for (i=0;i<SBC_FS;i++){
129         sumx += absolute(y[SBC_LHIST-SBC_FS+i]);
130         sumy += absolute(y[bestmatch+i]);
131     }
132     sf = sumx/sumy;
133     // This is not in the paper, but limit the scaling factor to something reasonable to avoid creating artifacts
134     if (sf<0.75f) sf=0.75f;
135     if (sf>1.0f) sf=1.0f;
136     return sf;
137 }
138 
139 static SAMPLE_FORMAT crop_sample(float val){
140     float croped_val = val;
141     if (croped_val > 32767.0)  croped_val= 32767.0;
142     if (croped_val < -32768.0) croped_val=-32768.0;
143     return (SAMPLE_FORMAT) croped_val;
144 }
145 
146 uint8_t * btstack_sbc_plc_zero_signal_frame(void){
147     return (uint8_t *)&indices0;
148 }
149 
150 void btstack_sbc_plc_init(btstack_sbc_plc_state_t *plc_state){
151     plc_state->nbf=0;
152     plc_state->bestlag=0;
153     // printf("size\n");
154     memset(plc_state->hist,0,sizeof(plc_state->hist));
155 }
156 
157 #ifdef OCTAVE_OUTPUT
158 typedef enum {
159     OCTAVE_FRAME_TYPE_UNKNOWN = 0,
160     OCTAVE_FRAME_TYPE_GOOD,
161     OCTAVE_FRAME_TYPE_BAD
162 } octave_frame_type_t;
163 
164 static const char * octave_frame_type_name[] = {
165     "unknown",
166     "good",
167     "bad"
168 };
169 
170 static octave_frame_type_t octave_frame_type;
171 static char octave_base_name[1000];
172 
173 const char * octave_frame_type2str(int index){
174     if (index <= 0 || index >= sizeof(octave_frame_type_t)) return octave_frame_type_name[0];
175     return octave_frame_type_name[index];
176 }
177 
178 void btstack_sbc_plc_octave_set_base_name(const char * base_name){
179     strcpy(octave_base_name, base_name);
180     printf("OCTAVE: base name set to %s\n", octave_base_name);
181 }
182 
183 static void octave_fprintf_array_int16(FILE * oct_file, char * name, int data_len, int16_t * data){
184     fprintf(oct_file, "%s = [", name);
185     int i;
186     for (i = 0; i < data_len - 1; i++){
187         fprintf(oct_file, "%d, ", data[i]);
188     }
189     fprintf(oct_file, "%d", data[i]);
190     fprintf(oct_file, "%s", "];\n");
191 }
192 
193 static FILE * open_octave_file(btstack_sbc_plc_state_t *plc_state, octave_frame_type_t frame_type){
194     char oct_file_name[1200];
195     octave_frame_type = frame_type;
196     sprintf(oct_file_name, "%s_octave_plc_%d_%s.m", octave_base_name, plc_state->frame_count, octave_frame_type2str(octave_frame_type));
197 
198     FILE * oct_file = fopen(oct_file_name, "wb");
199     if (oct_file == NULL){
200         printf("OCTAVE: could not open file %s\n", oct_file_name);
201         return NULL;
202     }
203     printf("OCTAVE: opened file %s\n", oct_file_name);
204     return oct_file;
205 }
206 
207 static void octave_fprintf_plot_history_frame(btstack_sbc_plc_state_t *plc_state, FILE * oct_file, int frame_nr){
208     char title[100];
209     char hist_name[10];
210     sprintf(hist_name, "hist%d", plc_state->nbf);
211 
212     octave_fprintf_array_int16(oct_file, hist_name, SBC_LHIST, plc_state->hist);
213 
214     fprintf(oct_file, "y = [min(%s):1000:max(%s)];\n", hist_name, hist_name);
215     fprintf(oct_file, "x = zeros(1, size(y,2));\n");
216     fprintf(oct_file, "b = [0: %d];\n", SBC_LHIST+SBC_FS+SBC_RT+SBC_OLAL);
217 
218     int pos = SBC_FS;
219     fprintf(oct_file, "shift_x = x + %d;\n", pos);
220 
221     pos = SBC_LHIST - 1;
222     fprintf(oct_file, "lhist_x = x + %d;\n", pos);
223     pos += SBC_OLAL;
224     fprintf(oct_file, "lhist_olal1_x = x + %d;\n", pos);
225     pos += SBC_FS - SBC_OLAL;
226     fprintf(oct_file, "lhist_fs_x = x + %d;\n", pos);
227     pos += SBC_OLAL;
228     fprintf(oct_file, "lhist_olal2_x = x + %d;\n", pos);
229     pos += SBC_RT;
230     fprintf(oct_file, "lhist_rt_x = x + %d;\n", pos);
231 
232     fprintf(oct_file, "pattern_window_x = x + %d;\n", SBC_LHIST - SBC_M);
233 
234     fprintf(oct_file, "hf = figure();\n");
235     sprintf(title, "PLC %s frame %d", octave_frame_type2str(octave_frame_type), frame_nr);
236 
237     fprintf(oct_file, "hold on;\n");
238     fprintf(oct_file, "h1 = plot(%s); \n", hist_name);
239 
240     fprintf(oct_file, "title(\"%s\");\n", title);
241 
242     fprintf(oct_file, "plot(lhist_x, y, 'k'); \n");
243     fprintf(oct_file, "text(max(lhist_x) - 10, max(y)+1000, 'lhist'); \n");
244 
245     fprintf(oct_file, "plot(lhist_olal1_x, y, 'k'); \n");
246     fprintf(oct_file, "text(max(lhist_olal1_x) - 10, max(y)+1000, 'OLAL'); \n");
247 
248     fprintf(oct_file, "plot(lhist_fs_x, y, 'k'); \n");
249     fprintf(oct_file, "text(max(lhist_fs_x) - 10, max(y)+1000, 'FS'); \n");
250 
251     fprintf(oct_file, "plot(lhist_olal2_x, y, 'k'); \n");
252     fprintf(oct_file, "text(max(lhist_olal2_x) - 10, max(y)+1000, 'OLAL'); \n");
253 
254     fprintf(oct_file, "plot(lhist_rt_x, y, 'k');\n");
255     fprintf(oct_file, "text(max(lhist_rt_x) - 10, max(y)+1000, 'RT'); \n");
256 
257     if (octave_frame_type == OCTAVE_FRAME_TYPE_GOOD) return;
258 
259     int x0 = plc_state->bestlag;
260     int x1 = plc_state->bestlag + SBC_M - 1;
261     fprintf(oct_file, "plot(b(%d:%d), %s(%d:%d), 'rd'); \n", x0, x1, hist_name, x0, x1);
262     fprintf(oct_file, "text(%d - 10, -10, 'bestlag'); \n", x0);
263 
264     x0 = plc_state->bestlag + SBC_M ;
265     x1 = plc_state->bestlag + SBC_M + SBC_FS - 1;
266     fprintf(oct_file, "plot(b(%d:%d), %s(%d:%d), 'kd'); \n", x0, x1, hist_name, x0, x1);
267 
268     x0 = SBC_LHIST - SBC_M;
269     x1 = SBC_LHIST - 1;
270     fprintf(oct_file, "plot(b(%d:%d), %s(%d:%d), 'rd'); \n", x0, x1, hist_name, x0, x1);
271     fprintf(oct_file, "plot(pattern_window_x, y, 'g'); \n");
272     fprintf(oct_file, "text(max(pattern_window_x) - 10, max(y)+1000, 'M'); \n");
273 }
274 
275 static void octave_fprintf_plot_output(btstack_sbc_plc_state_t *plc_state, FILE * oct_file){
276     if (!oct_file) return;
277     char out_name[10];
278     sprintf(out_name, "out%d", plc_state->nbf);
279     int x0  = SBC_LHIST;
280     int x1  = x0 + SBC_FS - 1;
281     octave_fprintf_array_int16(oct_file, out_name, SBC_FS, plc_state->hist+x0);
282     fprintf(oct_file, "h2 = plot(b(%d:%d), %s, 'cd'); \n", x0, x1, out_name);
283 
284     char rest_hist_name[10];
285     sprintf(rest_hist_name, "rest%d", plc_state->nbf);
286     x0  = SBC_LHIST + SBC_FS;
287     x1  = x0 + SBC_OLAL + SBC_RT - 1;
288     octave_fprintf_array_int16(oct_file, rest_hist_name, SBC_OLAL + SBC_RT, plc_state->hist+x0);
289     fprintf(oct_file, "h3 = plot(b(%d:%d), %s, 'kd'); \n", x0, x1, rest_hist_name);
290 
291     char new_hist_name[10];
292     sprintf(new_hist_name, "hist%d", plc_state->nbf);
293     octave_fprintf_array_int16(oct_file, new_hist_name, SBC_LHIST, plc_state->hist);
294     fprintf(oct_file, "h4 = plot(%s, 'r--'); \n", new_hist_name);
295 
296     fprintf(oct_file, "legend ([h1, h2, h3, h4], {\"hist\", \"out\", \"rest\", \"new hist\"}, \"location\", \"northeast\");\n ");
297 
298     char fig_name[1200];
299     sprintf(fig_name, "../%s_octave_plc_%d_%s", octave_base_name, plc_state->frame_count, octave_frame_type2str(octave_frame_type));
300     fprintf(oct_file, "print(hf, \"%s.jpg\", \"-djpg\");", fig_name);
301 }
302 #endif
303 
304 
305 void btstack_sbc_plc_bad_frame(btstack_sbc_plc_state_t *plc_state, SAMPLE_FORMAT *ZIRbuf, SAMPLE_FORMAT *out){
306     float val;
307     int   i = 0;
308     float sf = 1;
309     plc_state->nbf++;
310 
311     plc_state->bad_frames_nr++;
312     plc_state->frame_count++;
313     if (plc_state->max_consecutive_bad_frames_nr < plc_state->nbf){
314         plc_state->max_consecutive_bad_frames_nr = plc_state->nbf;
315     }
316 
317     if (plc_state->nbf==1){
318         // printf("first bad frame\n");
319         // Perform pattern matching to find where to replicate
320         plc_state->bestlag = PatternMatch(plc_state->hist);
321     }
322 
323 #ifdef OCTAVE_OUTPUT
324     FILE * oct_file = open_octave_file(plc_state, OCTAVE_FRAME_TYPE_BAD);
325     if (oct_file){
326         octave_fprintf_plot_history_frame(plc_state, oct_file, plc_state->frame_count);
327     }
328 #endif
329 
330     if (plc_state->nbf==1){
331         // the replication begins after the template match
332         plc_state->bestlag += SBC_M;
333 
334         // Compute Scale Factor to Match Amplitude of Substitution Packet to that of Preceding Packet
335         sf = AmplitudeMatch(plc_state->hist, plc_state->bestlag);
336         // printf("sf Apmlitude Match %f, new data %d, bestlag+M %d\n", sf, ZIRbuf[0], plc_state->hist[plc_state->bestlag]);
337         for (i=0;i<SBC_OLAL;i++){
338             float left  = ZIRbuf[i];
339             float right = sf*plc_state->hist[plc_state->bestlag+i];
340             val = left*rcos[i] + right*rcos[SBC_OLAL-1-i];
341             // val = sf*plc_state->hist[plc_state->bestlag+i];
342             plc_state->hist[SBC_LHIST+i] = crop_sample(val);
343         }
344 
345         for (;i<SBC_FS;i++){
346             val = sf*plc_state->hist[plc_state->bestlag+i];
347             plc_state->hist[SBC_LHIST+i] = crop_sample(val);
348         }
349 
350         for (;i<SBC_FS+SBC_OLAL;i++){
351             float left  = sf*plc_state->hist[plc_state->bestlag+i];
352             float right = plc_state->hist[plc_state->bestlag+i];
353             val = left*rcos[i-SBC_FS]+right*rcos[SBC_OLAL-1-i+SBC_FS];
354             plc_state->hist[SBC_LHIST+i] = crop_sample(val);
355         }
356 
357         for (;i<SBC_FS+SBC_RT+SBC_OLAL;i++){
358             plc_state->hist[SBC_LHIST+i] = plc_state->hist[plc_state->bestlag+i];
359         }
360     } else {
361         // printf("succesive bad frame nr %d\n", plc_state->nbf);
362         for (;i<SBC_FS+SBC_RT+SBC_OLAL;i++){
363             plc_state->hist[SBC_LHIST+i] = plc_state->hist[plc_state->bestlag+i];
364         }
365     }
366     for (i=0;i<SBC_FS;i++){
367         out[i] = plc_state->hist[SBC_LHIST+i];
368     }
369 
370    // shift the history buffer
371     for (i=0;i<SBC_LHIST+SBC_RT+SBC_OLAL;i++){
372         plc_state->hist[i] = plc_state->hist[i+SBC_FS];
373     }
374 
375 #ifdef OCTAVE_OUTPUT
376     if (oct_file){
377         octave_fprintf_plot_output(plc_state, oct_file);
378         fclose(oct_file);
379     }
380 #endif
381 }
382 
383 void btstack_sbc_plc_good_frame(btstack_sbc_plc_state_t *plc_state, SAMPLE_FORMAT *in, SAMPLE_FORMAT *out){
384     float val;
385     int i = 0;
386     plc_state->good_frames_nr++;
387     plc_state->frame_count++;
388 
389 #ifdef OCTAVE_OUTPUT
390     FILE * oct_file = NULL;
391     if (plc_state->nbf>0){
392         oct_file = open_octave_file(plc_state, OCTAVE_FRAME_TYPE_GOOD);
393         if (oct_file){
394             octave_fprintf_plot_history_frame(plc_state, oct_file, plc_state->frame_count);
395         }
396     }
397 #endif
398 
399     if (plc_state->nbf>0){
400         for (i=0;i<SBC_RT;i++){
401             out[i] = plc_state->hist[SBC_LHIST+i];
402         }
403 
404         for (i = SBC_RT;i<SBC_RT+SBC_OLAL;i++){
405             float left  = plc_state->hist[SBC_LHIST+i];
406             float right = in[i];
407             val = left*rcos[i-SBC_RT] + right*rcos[SBC_OLAL+SBC_RT-1-i];
408             out[i] = crop_sample(val);
409         }
410     }
411 
412     for (;i<SBC_FS;i++){
413         out[i] = in[i];
414     }
415     // Copy the output to the history buffer
416     for (i=0;i<SBC_FS;i++){
417         plc_state->hist[SBC_LHIST+i] = out[i];
418     }
419 
420     // shift the history buffer
421     for (i=0;i<SBC_LHIST;i++){
422         plc_state->hist[i] = plc_state->hist[i+SBC_FS];
423     }
424 
425 #ifdef OCTAVE_OUTPUT
426     if (oct_file){
427         octave_fprintf_plot_output(plc_state, oct_file);
428         fclose(oct_file);
429     }
430 #endif
431     plc_state->nbf=0;
432 }
433 
434 void btstack_sbc_dump_statistics(btstack_sbc_plc_state_t * state){
435     log_info("Good frames: %d\n", state->good_frames_nr);
436     log_info("Bad frames: %d\n", state->bad_frames_nr);
437     log_info("Max Consecutive bad frames: %d\n", state->max_consecutive_bad_frames_nr);
438 }
439