A trunk that builds is a productive trunk.
[asterisk/asterisk.git] / codecs / codec_zap.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Zaptel native transcoding support
5  *
6  * Copyright (C) 1999 - 2006, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  * Kevin P. Fleming <kpfleming@digium.com>
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 /*! \file
23  *
24  * \brief Translate between various formats natively through Zaptel transcoding
25  *
26  * \ingroup codecs
27  */
28
29 /*** MODULEINFO
30         <depend>zaptel</depend>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include <fcntl.h>
38 #include <stdlib.h>
39 #include <unistd.h>
40 #include <netinet/in.h>
41 #include <string.h>
42 #include <stdio.h>
43 #include <sys/ioctl.h>
44 #include <errno.h>
45 #include <sys/mman.h>
46 #include <zaptel/zaptel.h>
47
48 #include "asterisk/lock.h"
49 #include "asterisk/translate.h"
50 #include "asterisk/config.h"
51 #include "asterisk/options.h"
52 #include "asterisk/module.h"
53 #include "asterisk/logger.h"
54 #include "asterisk/channel.h"
55 #include "asterisk/utils.h"
56 #include "asterisk/linkedlists.h"
57
58 #define BUFFER_SAMPLES  8000
59
60 static unsigned int global_useplc = 0;
61
62 struct format_map {
63         unsigned int map[32][32];
64 };
65
66 static struct format_map global_format_map = { { { 0 } } };
67
68 struct translator {
69         struct ast_translator t;
70         AST_LIST_ENTRY(translator) entry;
71 };
72
73 static AST_LIST_HEAD_STATIC(translators, translator);
74
75 struct pvt {
76         int fd;
77         int fake;
78 #ifdef DEBUG_TRANSCODE
79         int totalms;
80         int lasttotalms;
81 #endif
82         struct zt_transcode_header *hdr;
83         struct ast_frame f;
84 };
85
86 static int zap_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
87 {
88         struct pvt *ztp = pvt->pvt;
89         struct zt_transcode_header *hdr = ztp->hdr;
90
91         if (!f->subclass) {
92                 /* Fake a return frame for calculation purposes */
93                 ztp->fake = 2;
94                 pvt->samples = f->samples;
95                 return 0;
96         }
97
98         if (!hdr->srclen)
99                 /* Copy at front of buffer */
100                 hdr->srcoffset = 0;
101
102         if (hdr->srclen + f->datalen > sizeof(hdr->srcdata)) {
103                 ast_log(LOG_WARNING, "Out of space for codec translation!\n");
104                 return -1;
105         }
106
107         if (hdr->srclen + f->datalen + hdr->srcoffset > sizeof(hdr->srcdata)) {
108                 /* Very unlikely */
109                 memmove(hdr->srcdata, hdr->srcdata + hdr->srcoffset, hdr->srclen);
110                 hdr->srcoffset = 0;
111         }
112
113         memcpy(hdr->srcdata + hdr->srcoffset + hdr->srclen, f->data, f->datalen);
114         hdr->srclen += f->datalen;
115         pvt->samples += f->samples;
116
117         return -1;
118 }
119
120 static struct ast_frame *zap_frameout(struct ast_trans_pvt *pvt)
121 {
122         struct pvt *ztp = pvt->pvt;
123         struct zt_transcode_header *hdr = ztp->hdr;
124         unsigned int x;
125
126         if (ztp->fake == 2) {
127                 ztp->fake = 1;
128                 ztp->f.frametype = AST_FRAME_VOICE;
129                 ztp->f.subclass = 0;
130                 ztp->f.samples = 160;
131                 ztp->f.data = NULL;
132                 ztp->f.offset = 0;
133                 ztp->f.datalen = 0;
134                 ztp->f.mallocd = 0;
135                 pvt->samples = 0;
136         } else if (ztp->fake == 1) {
137                 return NULL;
138         } else {
139                 if (hdr->dstlen) {
140 #ifdef DEBUG_TRANSCODE
141                         ztp->totalms += hdr->dstsamples;
142                         if ((ztp->totalms - ztp->lasttotalms) > 8000) {
143                                 printf("Whee %p, %d (%d to %d)\n", ztp, hdr->dstlen, ztp->lasttotalms, ztp->totalms);
144                                 ztp->lasttotalms = ztp->totalms;
145                         }
146 #endif
147                         ztp->f.frametype = AST_FRAME_VOICE;
148                         ztp->f.subclass = hdr->dstfmt;
149                         ztp->f.samples = hdr->dstsamples;
150                         ztp->f.data = hdr->dstdata + hdr->dstoffset;
151                         ztp->f.offset = hdr->dstoffset;
152                         ztp->f.datalen = hdr->dstlen;
153                         ztp->f.mallocd = 0;
154                         pvt->samples -= ztp->f.samples;
155                         hdr->dstlen = 0;
156                         
157                 } else {
158                         if (hdr->srclen) {
159                                 hdr->dstoffset = AST_FRIENDLY_OFFSET;
160                                 x = ZT_TCOP_TRANSCODE;
161                                 if (ioctl(ztp->fd, ZT_TRANSCODE_OP, &x))
162                                         ast_log(LOG_WARNING, "Failed to transcode: %s\n", strerror(errno));
163                         }
164                         return NULL;
165                 }
166         }
167
168         return &ztp->f;
169 }
170
171 static void zap_destroy(struct ast_trans_pvt *pvt)
172 {
173         struct pvt *ztp = pvt->pvt;
174
175         munmap(ztp->hdr, sizeof(*ztp->hdr));
176         close(ztp->fd);
177 }
178
179 static int zap_translate(struct ast_trans_pvt *pvt, int dest, int source)
180 {
181         /* Request translation through zap if possible */
182         int fd;
183         unsigned int x = ZT_TCOP_RESET;
184         struct pvt *ztp = pvt->pvt;
185         struct zt_transcode_header *hdr;
186         int flags;
187         
188         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0)
189                 return -1;
190         flags = fcntl(fd, F_GETFL);
191         if (flags > - 1) {
192                 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK))
193                         ast_log(LOG_WARNING, "Could not set non-block mode!\n");
194         }
195         
196
197         if ((hdr = mmap(NULL, sizeof(*hdr), PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0)) == MAP_FAILED) {
198                 ast_log(LOG_ERROR, "Memory Map failed for transcoding (%s)\n", strerror(errno));
199                 close(fd);
200
201                 return -1;
202         }
203
204         if (hdr->magic != ZT_TRANSCODE_MAGIC) {
205                 ast_log(LOG_ERROR, "Transcoder header (%08x) wasn't magic.  Abandoning\n", hdr->magic);
206                 munmap(hdr, sizeof(*hdr));
207                 close(fd);
208
209                 return -1;
210         }
211         
212         hdr->srcfmt = (1 << source);
213         hdr->dstfmt = (1 << dest);
214         if (ioctl(fd, ZT_TRANSCODE_OP, &x)) {
215                 ast_log(LOG_ERROR, "Unable to attach transcoder: %s\n", strerror(errno));
216                 munmap(hdr, sizeof(*hdr));
217                 close(fd);
218
219                 return -1;
220         }
221
222         ztp = pvt->pvt;
223         ztp->fd = fd;
224         ztp->hdr = hdr;
225
226         return 0;
227 }
228
229 static int zap_new(struct ast_trans_pvt *pvt)
230 {
231         return zap_translate(pvt, pvt->t->dstfmt, pvt->t->srcfmt);
232 }
233
234 static struct ast_frame *fakesrc_sample(void)
235 {
236         /* Don't bother really trying to test hardware ones. */
237         static struct ast_frame f = {
238                 .frametype = AST_FRAME_VOICE,
239                 .samples = 160,
240                 .src = __PRETTY_FUNCTION__
241         };
242
243         return &f;
244 }
245
246 static int register_translator(int dst, int src)
247 {
248         struct translator *zt;
249         int res;
250
251         if (!(zt = ast_calloc(1, sizeof(*zt))))
252                 return -1;
253
254         snprintf((char *) (zt->t.name), sizeof(zt->t.name), "zap%sto%s", 
255                  ast_getformatname((1 << src)), ast_getformatname((1 << dst)));
256         zt->t.srcfmt = (1 << src);
257         zt->t.dstfmt = (1 << dst);
258         zt->t.newpvt = zap_new;
259         zt->t.framein = zap_framein;
260         zt->t.frameout = zap_frameout;
261         zt->t.destroy = zap_destroy;
262         zt->t.sample = fakesrc_sample;
263         zt->t.useplc = global_useplc;
264         zt->t.buf_size = BUFFER_SAMPLES * 2;
265         zt->t.desc_size = sizeof(struct pvt);
266         if ((res = ast_register_translator(&zt->t))) {
267                 free(zt);
268                 return -1;
269         }
270
271         AST_LIST_LOCK(&translators);
272         AST_LIST_INSERT_HEAD(&translators, zt, entry);
273         AST_LIST_UNLOCK(&translators);
274
275         global_format_map.map[dst][src] = 1;
276
277         return res;
278 }
279
280 static void drop_translator(int dst, int src)
281 {
282         struct translator *cur;
283
284         AST_LIST_LOCK(&translators);
285         AST_LIST_TRAVERSE_SAFE_BEGIN(&translators, cur, entry) {
286                 if (cur->t.srcfmt != src)
287                         continue;
288
289                 if (cur->t.dstfmt != dst)
290                         continue;
291
292                 AST_LIST_REMOVE_CURRENT(&translators, entry);
293                 ast_unregister_translator(&cur->t);
294                 free(cur);
295                 global_format_map.map[dst][src] = 0;
296                 break;
297         }
298         AST_LIST_TRAVERSE_SAFE_END;
299         AST_LIST_UNLOCK(&translators);
300 }
301
302 static void unregister_translators(void)
303 {
304         struct translator *cur;
305
306         AST_LIST_LOCK(&translators);
307         while ((cur = AST_LIST_REMOVE_HEAD(&translators, entry))) {
308                 ast_unregister_translator(&cur->t);
309                 free(cur);
310         }
311         AST_LIST_UNLOCK(&translators);
312 }
313
314 static void parse_config(void)
315 {
316         struct ast_variable *var;
317         struct ast_config *cfg = ast_config_load("codecs.conf");
318
319         if (!cfg)
320                 return;
321
322         for (var = ast_variable_browse(cfg, "plc"); var; var = var->next) {
323                if (!strcasecmp(var->name, "genericplc")) {
324                        global_useplc = ast_true(var->value);
325                        if (option_verbose > 2)
326                                ast_verbose(VERBOSE_PREFIX_3 "codec_zap: %susing generic PLC\n",
327                                            global_useplc ? "" : "not ");
328                }
329         }
330
331         ast_config_destroy(cfg);
332 }
333
334 static void build_translators(struct format_map *map, unsigned int dstfmts, unsigned int srcfmts)
335 {
336         unsigned int src, dst;
337
338         for (src = 0; src < 32; src++) {
339                 for (dst = 0; dst < 32; dst++) {
340                         if (!(srcfmts & (1 << src)))
341                                 continue;
342
343                         if (!(dstfmts & (1 << dst)))
344                                 continue;
345
346                         if (global_format_map.map[dst][src])
347                                 continue;
348
349                         if (!register_translator(dst, src))
350                                 map->map[dst][src] = 1;
351                 }
352         }
353 }
354
355 static int find_transcoders(void)
356 {
357         struct zt_transcode_info info = { 0, };
358         struct format_map map = { { { 0 } } };
359         int fd, res;
360         unsigned int x, y;
361
362         info.op = ZT_TCOP_GETINFO;
363         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0) {
364                 ast_log(LOG_NOTICE, "No Zaptel transcoder support!\n");
365                 return 0;
366         }
367         for (info.tcnum = 0; !(res = ioctl(fd, ZT_TRANSCODE_OP, &info)); info.tcnum++) {
368                 if (option_verbose > 1)
369                         ast_verbose(VERBOSE_PREFIX_2 "Found transcoder '%s'.\n", info.name);
370                 build_translators(&map, info.dstfmts, info.srcfmts);
371         }
372         close(fd);
373
374         if (!info.tcnum && (option_verbose > 1))
375                 ast_verbose(VERBOSE_PREFIX_2 "No hardware transcoders found.\n");
376
377         for (x = 0; x < 32; x++) {
378                 for (y = 0; y < 32; y++) {
379                         if (!map.map[x][y] && global_format_map.map[x][y])
380                                 drop_translator(x, y);
381                 }
382         }
383
384         return 0;
385 }
386
387 static int reload(void)
388 {
389         struct translator *cur;
390
391         parse_config();
392         find_transcoders();
393
394         AST_LIST_LOCK(&translators);
395         AST_LIST_TRAVERSE(&translators, cur, entry)
396                 cur->t.useplc = global_useplc;
397         AST_LIST_UNLOCK(&translators);
398
399         return 0;
400 }
401
402 static int unload_module(void)
403 {
404         unregister_translators();
405
406         return 0;
407 }
408
409 static int load_module(void)
410 {
411         parse_config();
412         find_transcoders();
413
414         return 0;
415 }
416
417 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Generic Zaptel Transcoder Codec Translator",
418                 .load = load_module,
419                 .unload = unload_module,
420                 .reload = reload,
421                );