finish merging doxygen updates from issue #5605
[asterisk/asterisk.git] / fskmodem.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * 
8  * Includes code and algorithms from the Zapata library.
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief FSK Modulator/Demodulator 
24  *
25  */
26
27 #include <stdio.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/fskmodem.h"
34
35 #define NBW     2
36 #define BWLIST  {75,800}
37 #define NF      6
38 #define FLIST {1400,1800,1200,2200,1300,2100}
39
40 #define STATE_SEARCH_STARTBIT   0
41 #define STATE_SEARCH_STARTBIT2  1
42 #define STATE_SEARCH_STARTBIT3  2
43 #define STATE_GET_BYTE                  3
44
45 static inline float get_sample(short **buffer, int *len)
46 {
47         float retval;
48         retval = (float) **buffer / 256;
49         (*buffer)++;
50         (*len)--;
51         return retval;
52 }
53
54 #define GET_SAMPLE get_sample(&buffer, len)
55
56 /* Coeficientes para filtros de entrada                                 */
57 /* Tabla de coeficientes, generada a partir del programa "mkfilter"     */
58 /* Formato: coef[IDX_FREC][IDX_BW][IDX_COEF]                            */
59 /* IDX_COEF=0   =>      1/GAIN                                          */
60 /* IDX_COEF=1-6 =>      Coeficientes y[n]                               */
61
62 static double coef_in[NF][NBW][8]={
63 #include "coef_in.h"
64 };
65
66 /* Coeficientes para filtro de salida                                   */
67 /* Tabla de coeficientes, generada a partir del programa "mkfilter"     */
68 /* Formato: coef[IDX_BW][IDX_COEF]                                      */
69 /* IDX_COEF=0   =>      1/GAIN                                          */
70 /* IDX_COEF=1-6 =>      Coeficientes y[n]                               */
71
72 static double coef_out[NBW][8]={
73 #include "coef_out.h"
74 };
75
76
77 /*! Filtro pasa-banda para frecuencia de MARCA */
78 static inline float filtroM(fsk_data *fskd,float in)
79 {
80         int i,j;
81         double s;
82         double *pc;
83         
84         pc=&coef_in[fskd->f_mark_idx][fskd->bw][0];
85         fskd->fmxv[(fskd->fmp+6)&7]=in*(*pc++);
86         
87         s=(fskd->fmxv[(fskd->fmp+6)&7] - fskd->fmxv[fskd->fmp]) + 3 * (fskd->fmxv[(fskd->fmp+2)&7] - fskd->fmxv[(fskd->fmp+4)&7]);
88         for (i=0,j=fskd->fmp;i<6;i++,j++) s+=fskd->fmyv[j&7]*(*pc++);
89         fskd->fmyv[j&7]=s;
90         fskd->fmp++; fskd->fmp&=7;
91         return s;
92 }
93
94 /*! Filtro pasa-banda para frecuencia de ESPACIO */
95 static inline float filtroS(fsk_data *fskd,float in)
96 {
97         int i,j;
98         double s;
99         double *pc;
100         
101         pc=&coef_in[fskd->f_space_idx][fskd->bw][0];
102         fskd->fsxv[(fskd->fsp+6)&7]=in*(*pc++);
103         
104         s=(fskd->fsxv[(fskd->fsp+6)&7] - fskd->fsxv[fskd->fsp]) + 3 * (fskd->fsxv[(fskd->fsp+2)&7] - fskd->fsxv[(fskd->fsp+4)&7]);
105         for (i=0,j=fskd->fsp;i<6;i++,j++) s+=fskd->fsyv[j&7]*(*pc++);
106         fskd->fsyv[j&7]=s;
107         fskd->fsp++; fskd->fsp&=7;
108         return s;
109 }
110
111 /*! Filtro pasa-bajos para datos demodulados */
112 static inline float filtroL(fsk_data *fskd,float in)
113 {
114         int i,j;
115         double s;
116         double *pc;
117         
118         pc=&coef_out[fskd->bw][0];
119         fskd->flxv[(fskd->flp + 6) & 7]=in * (*pc++); 
120         
121         s=     (fskd->flxv[fskd->flp]       + fskd->flxv[(fskd->flp+6)&7]) +
122           6  * (fskd->flxv[(fskd->flp+1)&7] + fskd->flxv[(fskd->flp+5)&7]) +
123           15 * (fskd->flxv[(fskd->flp+2)&7] + fskd->flxv[(fskd->flp+4)&7]) +
124           20 *  fskd->flxv[(fskd->flp+3)&7]; 
125         
126         for (i=0,j=fskd->flp;i<6;i++,j++) s+=fskd->flyv[j&7]*(*pc++);
127         fskd->flyv[j&7]=s;
128         fskd->flp++; fskd->flp&=7;
129         return s;
130 }
131
132 static inline int demodulador(fsk_data *fskd, float *retval, float x)
133 {
134         float xS,xM;
135
136         fskd->cola_in[fskd->pcola]=x;
137         
138         xS=filtroS(fskd,x);
139         xM=filtroM(fskd,x);
140
141         fskd->cola_filtro[fskd->pcola]=xM-xS;
142
143         x=filtroL(fskd,xM*xM - xS*xS);
144         
145         fskd->cola_demod[fskd->pcola++]=x;
146         fskd->pcola &= (NCOLA-1);
147
148         *retval = x;
149         return(0);
150 }
151
152 static int get_bit_raw(fsk_data *fskd, short *buffer, int *len)
153 {
154         /* Esta funcion implementa un DPLL para sincronizarse con los bits */
155         float x,spb,spb2,ds;
156         int f;
157
158         spb=fskd->spb; 
159         if (fskd->spb == 7) spb = 8000.0 / 1200.0;
160         ds=spb/32.;
161         spb2=spb/2.;
162
163         for (f=0;;){
164                 if (demodulador(fskd,&x, GET_SAMPLE)) return(-1);
165                 if ((x*fskd->x0)<0) {   /* Transicion */
166                         if (!f) {
167                                 if (fskd->cont<(spb2)) fskd->cont+=ds; else fskd->cont-=ds;
168                                 f=1;
169                         }
170                 }
171                 fskd->x0=x;
172                 fskd->cont+=1.;
173                 if (fskd->cont>spb) {
174                         fskd->cont-=spb;
175                         break;
176                 }
177         }
178         f=(x>0)?0x80:0;
179         return(f);
180 }
181
182 int fsk_serie(fsk_data *fskd, short *buffer, int *len, int *outbyte)
183 {
184         int a;
185         int i,j,n1,r;
186         int samples=0;
187         int olen;
188         switch(fskd->state) {
189                 /* Pick up where we left off */
190         case STATE_SEARCH_STARTBIT2:
191                 goto search_startbit2;
192         case STATE_SEARCH_STARTBIT3:
193                 goto search_startbit3;
194         case STATE_GET_BYTE:
195                 goto getbyte;
196         }
197         /* Esperamos bit de start       */
198         do {
199 /* this was jesus's nice, reasonable, working (at least with RTTY) code
200 to look for the beginning of the start bit. Unfortunately, since TTY/TDD's
201 just start sending a start bit with nothing preceding it at the beginning
202 of a transmission (what a LOSING design), we cant do it this elegantly */
203 /*
204                 if (demodulador(zap,&x1)) return(-1);
205                 for(;;) {
206                         if (demodulador(zap,&x2)) return(-1);
207                         if (x1>0 && x2<0) break;
208                         x1=x2;
209                 }
210 */
211 /* this is now the imprecise, losing, but functional code to detect the
212 beginning of a start bit in the TDD sceanario. It just looks for sufficient
213 level to maybe, perhaps, guess, maybe that its maybe the beginning of
214 a start bit, perhaps. This whole thing stinks! */
215                 if (demodulador(fskd,&fskd->x1,GET_SAMPLE)) return(-1);
216                 samples++;
217                 for(;;)
218                    {
219 search_startbit2:                  
220                         if (!*len) {
221                                 fskd->state = STATE_SEARCH_STARTBIT2;
222                                 return 0;
223                         }
224                         samples++;
225                         if (demodulador(fskd,&fskd->x2,GET_SAMPLE)) return(-1);
226 #if 0
227                         printf("x2 = %5.5f ", fskd->x2);
228 #endif                  
229                         if (fskd->x2 < -0.5) break; 
230                    }
231 search_startbit3:                  
232                 /* Esperamos 0.5 bits antes de usar DPLL */
233                 i=fskd->spb/2;
234                 if (*len < i) {
235                         fskd->state = STATE_SEARCH_STARTBIT3;
236                         return 0;
237                 }
238                 for(;i;i--) { if (demodulador(fskd,&fskd->x1,GET_SAMPLE)) return(-1); 
239 #if 0
240                         printf("x1 = %5.5f ", fskd->x1);
241 #endif                  
242         samples++; }
243
244                 /* x1 debe ser negativo (confirmaciĆ³n del bit de start) */
245
246         } while (fskd->x1>0);
247         fskd->state = STATE_GET_BYTE;
248
249 getbyte:
250
251         /* Need at least 80 samples (for 1200) or
252                 1320 (for 45.5) to be sure we'll have a byte */
253         if (fskd->nbit < 8) {
254                 if (*len < 1320)
255                         return 0;
256         } else {
257                 if (*len < 80)
258                         return 0;
259         }
260         /* Leemos ahora los bits de datos */
261         j=fskd->nbit;
262         for (a=n1=0;j;j--) {
263                 olen = *len;
264                 i=get_bit_raw(fskd, buffer, len);
265                 buffer += (olen - *len);
266                 if (i == -1) return(-1);
267                 if (i) n1++;
268                 a>>=1; a|=i;
269         }
270         j=8-fskd->nbit;
271         a>>=j;
272
273         /* Leemos bit de paridad (si existe) y la comprobamos */
274         if (fskd->paridad) {
275                 olen = *len;
276                 i=get_bit_raw(fskd, buffer, len); 
277                 buffer += (olen - *len);
278                 if (i == -1) return(-1);
279                 if (i) n1++;
280                 if (fskd->paridad==1) { /* paridad=1 (par) */
281                         if (n1&1) a|=0x100;             /* error */
282                 } else {                        /* paridad=2 (impar) */
283                         if (!(n1&1)) a|=0x100;  /* error */
284                 }
285         }
286         
287         /* Leemos bits de STOP. Todos deben ser 1 */
288         
289         for (j=fskd->nstop;j;j--) {
290                 r = get_bit_raw(fskd, buffer, len);
291                 if (r == -1) return(-1);
292                 if (!r) a|=0x200;
293         }
294
295         /* Por fin retornamos  */
296         /* Bit 8 : Error de paridad */
297         /* Bit 9 : Error de Framming */
298
299         *outbyte = a;
300         fskd->state = STATE_SEARCH_STARTBIT;
301         return 1;
302 }