fix some formatting and add some comments (issue #5403)
[asterisk/asterisk.git] / tdd.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 /*
22  *
23  * TTY/TDD Generation support 
24  * 
25  */
26
27 #include <time.h>
28 #include <string.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <math.h>
33 #include <ctype.h>
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/ulaw.h"
40 #include "asterisk/tdd.h"
41 #include "asterisk/logger.h"
42 #include "asterisk/fskmodem.h"
43 #include "ecdisa.h"
44
45 struct tdd_state {
46         fsk_data fskd;
47         char rawdata[256];
48         short oldstuff[4096];
49         int oldlen;
50         int pos;
51         int modo;
52         int mode;
53 };
54
55 static float dr[4], di[4];
56 static float tddsb = 176.0;  /* 45.5 baud */
57
58 #define TDD_SPACE       1800.0          /* 1800 hz for "0" */
59 #define TDD_MARK        1400.0          /* 1400 hz for "1" */
60
61 static int tdd_decode_baudot(struct tdd_state *tdd,unsigned char data)  /* covert baudot into ASCII */
62 {
63         static char ltrs[32]={'<','E','\n','A',' ','S','I','U',
64                                 '\n','D','R','J','N','F','C','K',
65                                 'T','Z','L','W','H','Y','P','Q',
66                                 'O','B','G','^','M','X','V','^'};
67         static char figs[32]={'<','3','\n','-',' ',',','8','7',
68                                 '\n','$','4','\'',',','·',':','(',
69                                 '5','+',')','2','·','6','0','1',
70                                 '9','7','·','^','.','/','=','^'};
71         int d;
72         d=0;  /* return 0 if not decodeable */
73         switch (data) {
74         case 0x1f :     tdd->modo=0; break;
75         case 0x1b : tdd->modo=1; break;
76         default:        if (tdd->modo==0) d=ltrs[data]; else d=figs[data]; break;
77         }
78         return d;
79 }
80
81 void tdd_init(void)
82 {
83         /* Initialize stuff for inverse FFT */
84         dr[0] = cos(TDD_SPACE * 2.0 * M_PI / 8000.0);
85         di[0] = sin(TDD_SPACE * 2.0 * M_PI / 8000.0);
86         dr[1] = cos(TDD_MARK * 2.0 * M_PI / 8000.0);
87         di[1] = sin(TDD_MARK * 2.0 * M_PI / 8000.0);
88 }
89
90 struct tdd_state *tdd_new(void)
91 {
92         struct tdd_state *tdd;
93         tdd = malloc(sizeof(struct tdd_state));
94         if (tdd) {
95                 memset(tdd, 0, sizeof(struct tdd_state));
96                 tdd->fskd.spb = 176;            /* 45.5 baud */
97                 tdd->fskd.hdlc = 0;             /* Async */
98                 tdd->fskd.nbit = 5;             /* 5 bits */
99                 tdd->fskd.nstop = 1.5;  /* 1.5 stop bits */
100                 tdd->fskd.paridad = 0;  /* No parity */
101                 tdd->fskd.bw=0;                 /* Filter 75 Hz */
102                 tdd->fskd.f_mark_idx =  0;      /* 1400 Hz */
103                 tdd->fskd.f_space_idx = 1;      /* 1800 Hz */
104                 tdd->fskd.pcola = 0;            /* No clue */
105                 tdd->fskd.cont = 0;                     /* Digital PLL reset */
106                 tdd->fskd.x0 = 0.0;
107                 tdd->fskd.state = 0;
108                 tdd->pos = 0;
109                 tdd->mode = 2;
110         } else
111                 ast_log(LOG_WARNING, "Out of memory\n");
112         return tdd;
113 }
114
115 int ast_tdd_gen_ecdisa(unsigned char *outbuf, int len)
116 {
117         int pos = 0;
118         int cnt;
119         while(len) {
120                 cnt = len;
121                 if (cnt > sizeof(ecdisa))
122                         cnt = sizeof(ecdisa);
123                 memcpy(outbuf + pos, ecdisa, cnt);
124                 pos += cnt;
125                 len -= cnt;
126         }
127         return 0;
128 }
129
130 int tdd_feed(struct tdd_state *tdd, unsigned char *ubuf, int len)
131 {
132         int mylen = len;
133         int olen;
134         int b = 'X';
135         int res;
136         int c,x;
137         short *buf = malloc(2 * len + tdd->oldlen);
138         short *obuf = buf;
139         if (!buf) {
140                 ast_log(LOG_WARNING, "Out of memory\n");
141                 return -1;
142         }
143         memset(buf, 0, 2 * len + tdd->oldlen);
144         memcpy(buf, tdd->oldstuff, tdd->oldlen);
145         mylen += tdd->oldlen/2;
146         for (x=0;x<len;x++) 
147                 buf[x+tdd->oldlen/2] = AST_MULAW(ubuf[x]);
148         c = res = 0;
149         while(mylen >= 1320) { /* has to have enough to work on */
150                 olen = mylen;
151                 res = fsk_serie(&tdd->fskd, buf, &mylen, &b);
152                 if (mylen < 0) {
153                         ast_log(LOG_ERROR, "fsk_serie made mylen < 0 (%d) (olen was %d)\n", mylen,olen);
154                         free(obuf);
155                         return -1;
156                 }
157                 buf += (olen - mylen);
158                 if (res < 0) {
159                         ast_log(LOG_NOTICE, "fsk_serie failed\n");
160                         free(obuf);
161                         return -1;
162                 }
163                 if (res == 1) {
164                         /* Ignore invalid bytes */
165                         if (b > 0x7f)
166                                 continue;
167                         c = tdd_decode_baudot(tdd,b);
168                         if ((c < 1) || (c > 126)) continue; /* if not valid */
169                         break;
170                 }
171         }
172         if (mylen) {
173                 memcpy(tdd->oldstuff, buf, mylen * 2);
174                 tdd->oldlen = mylen * 2;
175         } else
176                 tdd->oldlen = 0;
177         free(obuf);
178         if (res)  {
179                 tdd->mode = 2; /* put it in mode where it
180                         reliably puts teleprinter in correct shift mode */
181                 return(c);
182         }
183         return 0;
184 }
185
186 void tdd_free(struct tdd_state *tdd)
187 {
188         free(tdd);
189 }
190
191 static inline float tdd_getcarrier(float *cr, float *ci, int bit)
192 {
193         /* Move along.  There's nothing to see here... */
194         float t;
195         t = *cr * dr[bit] - *ci * di[bit];
196         *ci = *cr * di[bit] + *ci * dr[bit];
197         *cr = t;
198         
199         t = 2.0 - (*cr * *cr + *ci * *ci);
200         *cr *= t;
201         *ci *= t;
202         return *cr;
203 }       
204
205 #define PUT_BYTE(a) do { \
206         *(buf++) = (a); \
207         bytes++; \
208 } while(0)
209
210 #define PUT_AUDIO_SAMPLE(y) do { \
211         int index = (short)(rint(8192.0 * (y))); \
212         *(buf++) = AST_LIN2MU(index); \
213         bytes++; \
214 } while(0)
215         
216 #define PUT_TDD_MARKMS do { \
217         int x; \
218         for (x=0;x<8;x++) \
219                 PUT_AUDIO_SAMPLE(tdd_getcarrier(&cr, &ci, 1)); \
220 } while(0)
221
222 #define PUT_TDD_BAUD(bit) do { \
223         while(scont < tddsb) { \
224                 PUT_AUDIO_SAMPLE(tdd_getcarrier(&cr, &ci, bit)); \
225                 scont += 1.0; \
226         } \
227         scont -= tddsb; \
228 } while(0)
229
230 #define PUT_TDD_STOP do { \
231         while(scont < (tddsb * 1.5)) { \
232                 PUT_AUDIO_SAMPLE(tdd_getcarrier(&cr, &ci, 1)); \
233                 scont += 1.0; \
234         } \
235         scont -= (tddsb * 1.5); \
236 } while(0)
237
238
239 #define PUT_TDD(byte) do { \
240         int z; \
241         unsigned char b = (byte); \
242         PUT_TDD_BAUD(0);        /* Start bit */ \
243         for (z=0;z<5;z++) { \
244                 PUT_TDD_BAUD(b & 1); \
245                 b >>= 1; \
246         } \
247         PUT_TDD_STOP;   /* Stop bit */ \
248 } while(0);     
249
250 int tdd_generate(struct tdd_state *tdd, unsigned char *buf, const char *str)
251 {
252         int bytes=0;
253         int i,x;
254         char    c;
255         static unsigned char lstr[31] = "\000E\nA SIU\rDRJNFCKTZLWHYPQOBG\000MXV";
256         static unsigned char fstr[31] = "\0003\n- \00787\r$4',!:(5\")2\0006019?&\000./;";
257         /* Initial carriers (real/imaginary) */
258         float cr = 1.0;
259         float ci = 0.0;
260         float scont = 0.0;
261
262         for(x = 0; str[x]; x++) {
263                 c = toupper(str[x]);
264 #if     0
265                 printf("%c",c); fflush(stdout);
266 #endif
267                 if (c == 0) /* send null */
268                    {
269                         PUT_TDD(0);
270                         continue;
271                    }
272                 if (c == '\r') /* send c/r */
273                    {
274                         PUT_TDD(8);
275                         continue;
276                    }
277                 if (c == '\n') /* send c/r and l/f */
278                    {
279                         PUT_TDD(8);
280                         PUT_TDD(2);
281                         continue;
282                    }
283                 if (c == ' ') /* send space */
284                    {
285                         PUT_TDD(4);
286                         continue;
287                    }
288                 for(i = 0; i < 31; i++)
289                    {
290                         if (lstr[i] == c) break;
291                    }
292                 if (i < 31) /* if we found it */
293                    {
294                         if (tdd->mode)  /* if in figs mode, change it */
295                            { 
296                                 PUT_TDD(31); /* Send LTRS */
297                                 tdd->mode = 0;
298                            }
299                         PUT_TDD(i);
300                         continue;
301                    }
302                 for(i = 0; i < 31; i++)
303                    {
304                         if (fstr[i] == c) break;
305                    }
306                 if (i < 31) /* if we found it */
307                    {
308                         if (tdd->mode != 1)  /* if in ltrs mode, change it */
309                            {
310                                 PUT_TDD(27); /* send FIGS */
311                                 tdd->mode = 1;
312                            }
313                         PUT_TDD(i);  /* send byte */
314                         continue;
315                    }
316            }
317         return bytes;
318 }
319
320