updated irroots info for the authors section
[asterisk/asterisk.git] / res / res_fax_spandsp.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009-2010, Digium, Inc.
5  *
6  * Matthew Nicholson <mnicholson@digium.com>
7  *
8  * Initial T.38-gateway code
9  * 2008, Daniel Ferenci <daniel.ferenci@nethemba.com>
10  * Created by Nethemba s.r.o. http://www.nethemba.com
11  * Sponsored by IPEX a.s. http://www.ipex.cz
12  *
13  * T.38-gateway integration into asterisk app_fax and rework
14  * 2008, Gregory Hinton Nietsky <gregory@dnstelecom.co.za>
15  * dns Telecom http://www.dnstelecom.co.za
16  *
17  * Modified to make T.38-gateway compatible with Asterisk 1.6.2
18  * 2010, Anton Verevkin <mymail@verevkin.it>
19  * ViaNetTV http://www.vianettv.com
20  *
21  * Modified to make T.38-gateway work
22  * 2010, Klaus Darilion, IPCom GmbH, www.ipcom.at
23  *
24  * See http://www.asterisk.org for more information about
25  * the Asterisk project. Please do not directly contact
26  * any of the maintainers of this project for assistance;
27  * the project provides a web site, mailing lists and IRC
28  * channels for your use.
29  *
30  * This program is free software, distributed under the terms of
31  * the GNU General Public License Version 2. See the LICENSE file
32  * at the top of the source tree.
33  */
34
35 /*! \file
36  *
37  * \brief Spandsp T.38 and G.711 FAX Resource
38  *
39  * \author Matthew Nicholson <mnicholson@digium.com>
40  * \author Gregory H. Nietsky <gregory@distrotech.co.za>
41  *
42  * This module registers the Spandsp FAX technology with the res_fax module.
43  */
44
45 /*** MODULEINFO
46         <depend>spandsp</depend>
47         <depend>res_fax</depend>
48 ***/
49
50 #include "asterisk.h"
51
52 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
53
54 #define SPANDSP_EXPOSE_INTERNAL_STRUCTURES
55 #include <spandsp.h>
56 #include <spandsp/version.h>
57
58 #include "asterisk/logger.h"
59 #include "asterisk/module.h"
60 #include "asterisk/strings.h"
61 #include "asterisk/cli.h"
62 #include "asterisk/utils.h"
63 #include "asterisk/timing.h"
64 #include "asterisk/astobj2.h"
65 #include "asterisk/res_fax.h"
66 #include "asterisk/channel.h"
67
68 #define SPANDSP_FAX_SAMPLES 160
69 #define SPANDSP_FAX_TIMER_RATE 8000 / SPANDSP_FAX_SAMPLES       /* 50 ticks per second, 20ms, 160 samples per second */
70 #define SPANDSP_ENGAGE_UDPTL_NAT_RETRY 3
71
72 static void *spandsp_fax_new(struct ast_fax_session *s, struct ast_fax_tech_token *token);
73 static void spandsp_fax_destroy(struct ast_fax_session *s);
74 static struct ast_frame *spandsp_fax_read(struct ast_fax_session *s);
75 static int spandsp_fax_write(struct ast_fax_session *s, const struct ast_frame *f);
76 static int spandsp_fax_start(struct ast_fax_session *s);
77 static int spandsp_fax_cancel(struct ast_fax_session *s);
78 static int spandsp_fax_switch_to_t38(struct ast_fax_session *s);
79 static int spandsp_fax_gateway_start(struct ast_fax_session *s);
80 static int spandsp_fax_gateway_process(struct ast_fax_session *s, const struct ast_frame *f);
81 static void spandsp_fax_gateway_cleanup(struct ast_fax_session *s);
82
83 static char *spandsp_fax_cli_show_capabilities(int fd);
84 static char *spandsp_fax_cli_show_session(struct ast_fax_session *s, int fd);
85 static char *spandsp_fax_cli_show_stats(int fd);
86 static char *spandsp_fax_cli_show_settings(int fd);
87
88 static struct ast_fax_tech spandsp_fax_tech = {
89         .type = "Spandsp",
90         .description = "Spandsp FAX Driver",
91 #if SPANDSP_RELEASE_DATE >= 20090220
92         /* spandsp 0.0.6 */
93         .version = SPANDSP_RELEASE_DATETIME_STRING,
94 #else
95         /* spandsp 0.0.5
96          * TODO: maybe we should determine the version better way
97          */
98         .version = "pre-20090220",
99 #endif
100         .caps = AST_FAX_TECH_AUDIO | AST_FAX_TECH_T38 | AST_FAX_TECH_SEND | AST_FAX_TECH_RECEIVE | AST_FAX_TECH_GATEWAY,
101         .new_session = spandsp_fax_new,
102         .destroy_session = spandsp_fax_destroy,
103         .read = spandsp_fax_read,
104         .write = spandsp_fax_write,
105         .start_session = spandsp_fax_start,
106         .cancel_session = spandsp_fax_cancel,
107         .switch_to_t38 = spandsp_fax_switch_to_t38,
108         .cli_show_capabilities = spandsp_fax_cli_show_capabilities,
109         .cli_show_session = spandsp_fax_cli_show_session,
110         .cli_show_stats = spandsp_fax_cli_show_stats,
111         .cli_show_settings = spandsp_fax_cli_show_settings,
112 };
113
114 struct spandsp_fax_stats {
115         int success;
116         int nofax;
117         int neg_failed;
118         int failed_to_train;
119         int rx_protocol_error;
120         int tx_protocol_error;
121         int protocol_error;
122         int retries_exceeded;
123         int file_error;
124         int mem_error;
125         int call_dropped;
126         int unknown_error;
127         int switched;
128 };
129
130 static struct {
131         ast_mutex_t lock;
132         struct spandsp_fax_stats g711;
133         struct spandsp_fax_stats t38;
134 } spandsp_global_stats;
135
136 struct spandsp_pvt {
137         unsigned int ist38:1;
138         unsigned int isdone:1;
139         enum ast_t38_state ast_t38_state;
140         fax_state_t fax_state;
141         t38_terminal_state_t t38_state;
142         t30_state_t *t30_state;
143         t38_core_state_t *t38_core_state;
144
145         struct spandsp_fax_stats *stats;
146
147         struct spandsp_fax_gw_stats *t38stats;
148         t38_gateway_state_t t38_gw_state;
149
150         struct ast_timer *timer;
151         AST_LIST_HEAD(frame_queue, ast_frame) read_frames;
152 };
153
154 static void session_destroy(struct spandsp_pvt *p);
155 static int t38_tx_packet_handler(t38_core_state_t *t38_core_state, void *data, const uint8_t *buf, int len, int count);
156 static void t30_phase_e_handler(t30_state_t *t30_state, void *data, int completion_code);
157 static void spandsp_log(int level, const char *msg);
158 static int update_stats(struct spandsp_pvt *p, int completion_code);
159
160 static void set_logging(logging_state_t *state, struct ast_fax_session_details *details);
161 static void set_local_info(t30_state_t *t30_state, struct ast_fax_session_details *details);
162 static void set_file(t30_state_t *t30_state, struct ast_fax_session_details *details);
163 static void set_ecm(t30_state_t *t30_state, struct ast_fax_session_details *details);
164
165 static void session_destroy(struct spandsp_pvt *p)
166 {
167         struct ast_frame *f;
168
169         t30_terminate(p->t30_state);
170         p->isdone = 1;
171
172         ast_timer_close(p->timer);
173
174         fax_release(&p->fax_state);
175         t38_terminal_release(&p->t38_state);
176
177         while ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
178                 ast_frfree(f);
179         }
180 }
181
182 /*! \brief
183  *
184  */
185 static int t38_tx_packet_handler(t38_core_state_t *t38_core_state, void *data, const uint8_t *buf, int len, int count)
186 {
187         int res = -1;
188         struct ast_fax_session *s = data;
189         struct spandsp_pvt *p = s->tech_pvt;
190         struct ast_frame fax_frame = {
191                 .frametype = AST_FRAME_MODEM,
192                 .subclass.integer = AST_MODEM_T38,
193                 .src = "res_fax_spandsp_t38",
194         };
195
196         struct ast_frame *f = &fax_frame;
197
198
199         /* TODO: Asterisk does not provide means of resending the same packet multiple
200           times so count is ignored at the moment */
201
202         AST_FRAME_SET_BUFFER(f, buf, 0, len);
203
204         if (!(f = ast_frisolate(f))) {
205                 return res;
206         }
207
208         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
209                 ast_set_flag(f, AST_FAX_FRFLAG_GATEWAY);
210                 if (p->ast_t38_state == T38_STATE_NEGOTIATED) {
211                         res = ast_write(s->chan, f);
212                 } else {
213                         res = ast_queue_frame(s->chan, f);
214                 }
215                 ast_frfree(f);
216         } else {
217                 /* no need to lock, this all runs in the same thread */
218                 AST_LIST_INSERT_TAIL(&p->read_frames, f, frame_list);
219         }
220
221         return res;
222 }
223
224 static int update_stats(struct spandsp_pvt *p, int completion_code)
225 {
226         switch (completion_code) {
227         case T30_ERR_OK:
228                 ast_atomic_fetchadd_int(&p->stats->success, 1);
229                 break;
230
231         /* Link problems */
232         case T30_ERR_CEDTONE:            /*! The CED tone exceeded 5s */
233         case T30_ERR_T0_EXPIRED:         /*! Timed out waiting for initial communication */
234         case T30_ERR_T1_EXPIRED:         /*! Timed out waiting for the first message */
235         case T30_ERR_T3_EXPIRED:         /*! Timed out waiting for procedural interrupt */
236         case T30_ERR_HDLC_CARRIER:       /*! The HDLC carrier did not stop in a timely manner */
237         case T30_ERR_CANNOT_TRAIN:       /*! Failed to train with any of the compatible modems */
238                 ast_atomic_fetchadd_int(&p->stats->failed_to_train, 1);
239                 break;
240
241         case T30_ERR_OPER_INT_FAIL:      /*! Operator intervention failed */
242         case T30_ERR_INCOMPATIBLE:       /*! Far end is not compatible */
243         case T30_ERR_RX_INCAPABLE:       /*! Far end is not able to receive */
244         case T30_ERR_TX_INCAPABLE:       /*! Far end is not able to transmit */
245         case T30_ERR_NORESSUPPORT:       /*! Far end cannot receive at the resolution of the image */
246         case T30_ERR_NOSIZESUPPORT:      /*! Far end cannot receive at the size of image */
247                 ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
248                 break;
249
250         case T30_ERR_UNEXPECTED:         /*! Unexpected message received */
251                 ast_atomic_fetchadd_int(&p->stats->protocol_error, 1);
252                 break;
253
254         /* Phase E status values returned to a transmitter */
255         case T30_ERR_TX_BADDCS:          /*! Received bad response to DCS or training */
256         case T30_ERR_TX_BADPG:           /*! Received a DCN from remote after sending a page */
257         case T30_ERR_TX_ECMPHD:          /*! Invalid ECM response received from receiver */
258         case T30_ERR_TX_GOTDCN:          /*! Received a DCN while waiting for a DIS */
259         case T30_ERR_TX_INVALRSP:        /*! Invalid response after sending a page */
260         case T30_ERR_TX_NODIS:           /*! Received other than DIS while waiting for DIS */
261         case T30_ERR_TX_PHBDEAD:         /*! Received no response to DCS, training or TCF */
262         case T30_ERR_TX_PHDDEAD:         /*! No response after sending a page */
263         case T30_ERR_TX_T5EXP:           /*! Timed out waiting for receiver ready (ECM mode) */
264                 ast_atomic_fetchadd_int(&p->stats->tx_protocol_error, 1);
265                 break;
266
267         /* Phase E status values returned to a receiver */
268         case T30_ERR_RX_ECMPHD:          /*! Invalid ECM response received from transmitter */
269         case T30_ERR_RX_GOTDCS:          /*! DCS received while waiting for DTC */
270         case T30_ERR_RX_INVALCMD:        /*! Unexpected command after page received */
271         case T30_ERR_RX_NOCARRIER:       /*! Carrier lost during fax receive */
272         case T30_ERR_RX_NOEOL:           /*! Timed out while waiting for EOL (end Of line) */
273                 ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
274                 break;
275         case T30_ERR_RX_NOFAX:           /*! Timed out while waiting for first line */
276                 ast_atomic_fetchadd_int(&p->stats->nofax, 1);
277                 break;
278         case T30_ERR_RX_T2EXPDCN:        /*! Timer T2 expired while waiting for DCN */
279         case T30_ERR_RX_T2EXPD:          /*! Timer T2 expired while waiting for phase D */
280         case T30_ERR_RX_T2EXPFAX:        /*! Timer T2 expired while waiting for fax page */
281         case T30_ERR_RX_T2EXPMPS:        /*! Timer T2 expired while waiting for next fax page */
282         case T30_ERR_RX_T2EXPRR:         /*! Timer T2 expired while waiting for RR command */
283         case T30_ERR_RX_T2EXP:           /*! Timer T2 expired while waiting for NSS, DCS or MCF */
284         case T30_ERR_RX_DCNWHY:          /*! Unexpected DCN while waiting for DCS or DIS */
285         case T30_ERR_RX_DCNDATA:         /*! Unexpected DCN while waiting for image data */
286         case T30_ERR_RX_DCNFAX:          /*! Unexpected DCN while waiting for EOM, EOP or MPS */
287         case T30_ERR_RX_DCNPHD:          /*! Unexpected DCN after EOM or MPS sequence */
288         case T30_ERR_RX_DCNRRD:          /*! Unexpected DCN after RR/RNR sequence */
289         case T30_ERR_RX_DCNNORTN:        /*! Unexpected DCN after requested retransmission */
290                 ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
291                 break;
292
293         /* TIFF file problems */
294         case T30_ERR_FILEERROR:          /*! TIFF/F file cannot be opened */
295         case T30_ERR_NOPAGE:             /*! TIFF/F page not found */
296         case T30_ERR_BADTIFF:            /*! TIFF/F format is not compatible */
297         case T30_ERR_BADPAGE:            /*! TIFF/F page number tag missing */
298         case T30_ERR_BADTAG:             /*! Incorrect values for TIFF/F tags */
299         case T30_ERR_BADTIFFHDR:         /*! Bad TIFF/F header - incorrect values in fields */
300                 ast_atomic_fetchadd_int(&p->stats->file_error, 1);
301                 break;
302         case T30_ERR_NOMEM:              /*! Cannot allocate memory for more pages */
303                 ast_atomic_fetchadd_int(&p->stats->mem_error, 1);
304                 break;
305
306         /* General problems */
307         case T30_ERR_RETRYDCN:           /*! Disconnected after permitted retries */
308                 ast_atomic_fetchadd_int(&p->stats->retries_exceeded, 1);
309                 break;
310         case T30_ERR_CALLDROPPED:        /*! The call dropped prematurely */
311                 ast_atomic_fetchadd_int(&p->stats->call_dropped, 1);
312                 break;
313
314         /* Feature negotiation issues */
315         case T30_ERR_NOPOLL:             /*! Poll not accepted */
316         case T30_ERR_IDENT_UNACCEPTABLE: /*! Far end's ident is not acceptable */
317         case T30_ERR_SUB_UNACCEPTABLE:   /*! Far end's sub-address is not acceptable */
318         case T30_ERR_SEP_UNACCEPTABLE:   /*! Far end's selective polling address is not acceptable */
319         case T30_ERR_PSA_UNACCEPTABLE:   /*! Far end's polled sub-address is not acceptable */
320         case T30_ERR_SID_UNACCEPTABLE:   /*! Far end's sender identification is not acceptable */
321         case T30_ERR_PWD_UNACCEPTABLE:   /*! Far end's password is not acceptable */
322         case T30_ERR_TSA_UNACCEPTABLE:   /*! Far end's transmitting subscriber internet address is not acceptable */
323         case T30_ERR_IRA_UNACCEPTABLE:   /*! Far end's internet routing address is not acceptable */
324         case T30_ERR_CIA_UNACCEPTABLE:   /*! Far end's calling subscriber internet address is not acceptable */
325         case T30_ERR_ISP_UNACCEPTABLE:   /*! Far end's internet selective polling address is not acceptable */
326         case T30_ERR_CSA_UNACCEPTABLE:   /*! Far end's called subscriber internet address is not acceptable */
327                 ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
328                 break;
329         default:
330                 ast_atomic_fetchadd_int(&p->stats->unknown_error, 1);
331                 ast_log(LOG_WARNING, "unknown FAX session result '%d' (%s)\n", completion_code, t30_completion_code_to_str(completion_code));
332                 return -1;
333         }
334         return 0;
335 }
336
337 /*! \brief Phase E handler callback.
338  * \param t30_state the span t30 state
339  * \param data this will be the ast_fax_session
340  * \param completion_code the result of the fax session
341  *
342  * This function pulls stats from the spandsp stack and stores them for res_fax
343  * to use later.
344  */
345 static void t30_phase_e_handler(t30_state_t *t30_state, void *data, int completion_code)
346 {
347         struct ast_fax_session *s = data;
348         struct spandsp_pvt *p = s->tech_pvt;
349         char headerinfo[T30_MAX_PAGE_HEADER_INFO + 1];
350         const char *c;
351         t30_stats_t stats;
352
353         ast_debug(5, "FAX session '%d' entering phase E\n", s->id);
354
355         p->isdone = 1;
356
357         update_stats(p, completion_code);
358
359         t30_get_transfer_statistics(t30_state, &stats);
360
361         if (completion_code == T30_ERR_OK) {
362                 ast_string_field_set(s->details, result, "SUCCESS");
363         } else {
364                 ast_string_field_set(s->details, result, "FAILED");
365                 ast_string_field_set(s->details, error, t30_completion_code_to_str(completion_code));
366         }
367
368         ast_string_field_set(s->details, resultstr, t30_completion_code_to_str(completion_code));
369
370         ast_debug(5, "FAX session '%d' completed with result: %s (%s)\n", s->id, s->details->result, s->details->resultstr);
371
372         if ((c = t30_get_tx_ident(t30_state))) {
373                 ast_string_field_set(s->details, localstationid, c);
374         }
375
376         if ((c = t30_get_rx_ident(t30_state))) {
377                 ast_string_field_set(s->details, remotestationid, c);
378         }
379
380 #if SPANDSP_RELEASE_DATE >= 20090220
381         s->details->pages_transferred = (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx;
382 #else
383         s->details->pages_transferred = stats.pages_transferred;
384 #endif
385
386         ast_string_field_build(s->details, transfer_rate, "%d", stats.bit_rate);
387
388         ast_string_field_build(s->details, resolution, "%dx%d", stats.x_resolution, stats.y_resolution);
389
390         t30_get_tx_page_header_info(t30_state, headerinfo);
391         ast_string_field_set(s->details, headerinfo, headerinfo);
392 }
393
394 /*! \brief Send spandsp log messages to asterisk.
395  * \param level the spandsp logging level
396  * \param msg the log message
397  *
398  * \note This function is a callback function called by spandsp.
399  */
400 static void spandsp_log(int level, const char *msg)
401 {
402         if (level == SPAN_LOG_ERROR) {
403                 ast_log(LOG_ERROR, "%s", msg);
404         } else if (level == SPAN_LOG_WARNING) {
405                 ast_log(LOG_WARNING, "%s", msg);
406         } else {
407                 ast_fax_log(LOG_DEBUG, msg);
408         }
409 }
410
411 static void set_logging(logging_state_t *state, struct ast_fax_session_details *details)
412 {
413         int level = SPAN_LOG_WARNING;
414
415         if (details->option.debug) {
416                 level = SPAN_LOG_DEBUG_3;
417         }
418
419         span_log_set_message_handler(state, spandsp_log);
420         span_log_set_level(state, SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | level);
421 }
422
423 static void set_local_info(t30_state_t *t30_state, struct ast_fax_session_details *details)
424 {
425         if (!ast_strlen_zero(details->localstationid)) {
426                 t30_set_tx_ident(t30_state, details->localstationid);
427         }
428
429         if (!ast_strlen_zero(details->headerinfo)) {
430                 t30_set_tx_page_header_info(t30_state, details->headerinfo);
431         }
432 }
433
434 static void set_file(t30_state_t *t30_state, struct ast_fax_session_details *details)
435 {
436         if (details->caps & AST_FAX_TECH_RECEIVE) {
437                 t30_set_rx_file(t30_state, AST_LIST_FIRST(&details->documents)->filename, -1);
438         } else {
439                 /* if not AST_FAX_TECH_RECEIVE, assume AST_FAX_TECH_SEND, this
440                  * should be safe because we ensure either RECEIVE or SEND is
441                  * indicated in spandsp_fax_new() */
442                 t30_set_tx_file(t30_state, AST_LIST_FIRST(&details->documents)->filename, -1, -1);
443         }
444 }
445
446 static void set_ecm(t30_state_t *t30_state, struct ast_fax_session_details *details)
447 {
448         t30_set_ecm_capability(t30_state, details->option.ecm);
449         t30_set_supported_compressions(t30_state, T30_SUPPORT_T4_1D_COMPRESSION | T30_SUPPORT_T4_2D_COMPRESSION | T30_SUPPORT_T6_COMPRESSION);
450 }
451
452 /*! \brief create an instance of the spandsp tech_pvt for a fax session */
453 static void *spandsp_fax_new(struct ast_fax_session *s, struct ast_fax_tech_token *token)
454 {
455         struct spandsp_pvt *p;
456         int caller_mode;
457
458         if ((!(p = ast_calloc(1, sizeof(*p))))) {
459                 ast_log(LOG_ERROR, "Cannot initialize the spandsp private FAX technology structure.\n");
460                 goto e_return;
461         }
462
463         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
464                 s->state = AST_FAX_STATE_INITIALIZED;
465                 return p;
466         }
467
468         AST_LIST_HEAD_INIT(&p->read_frames);
469
470         if (s->details->caps & AST_FAX_TECH_RECEIVE) {
471                 caller_mode = 0;
472         } else if (s->details->caps & AST_FAX_TECH_SEND) {
473                 caller_mode = 1;
474         } else {
475                 ast_log(LOG_ERROR, "Are we sending or receiving? The FAX requirements (capabilities: 0x%X) were not properly set.\n", s->details->caps);
476                 goto e_free;
477         }
478
479         if (!(p->timer = ast_timer_open())) {
480                 ast_log(LOG_ERROR, "Channel '%s' FAX session '%d' failed to create timing source.\n", s->channame, s->id);
481                 goto e_free;
482         }
483
484         s->fd = ast_timer_fd(p->timer);
485
486         p->stats = &spandsp_global_stats.g711;
487
488         if (s->details->caps & AST_FAX_TECH_T38) {
489                 if ((s->details->caps & AST_FAX_TECH_AUDIO) == 0) {
490                         /* audio mode was not requested, start in T.38 mode */
491                         p->ist38 = 1;
492                         p->stats = &spandsp_global_stats.t38;
493                 }
494
495                 /* init t38 stuff */
496                 t38_terminal_init(&p->t38_state, caller_mode, t38_tx_packet_handler, s);
497                 set_logging(&p->t38_state.logging, s->details);
498         }
499
500         if (s->details->caps & AST_FAX_TECH_AUDIO) {
501                 /* init audio stuff */
502                 fax_init(&p->fax_state, caller_mode);
503                 set_logging(&p->fax_state.logging, s->details);
504         }
505
506         s->state = AST_FAX_STATE_INITIALIZED;
507         return p;
508
509 e_free:
510         ast_free(p);
511 e_return:
512         return NULL;
513 }
514
515 /*! \brief Destroy a spandsp fax session.
516  */
517 static void spandsp_fax_destroy(struct ast_fax_session *s)
518 {
519         struct spandsp_pvt *p = s->tech_pvt;
520
521         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
522                 spandsp_fax_gateway_cleanup(s);
523         } else {
524                 session_destroy(p);
525         }
526
527         ast_free(p);
528         s->tech_pvt = NULL;
529         s->fd = -1;
530 }
531
532 /*! \brief Read a frame from the spandsp fax stack.
533  */
534 static struct ast_frame *spandsp_fax_read(struct ast_fax_session *s)
535 {
536         struct spandsp_pvt *p = s->tech_pvt;
537         uint8_t buffer[AST_FRIENDLY_OFFSET + SPANDSP_FAX_SAMPLES * sizeof(uint16_t)];
538         int16_t *buf = (int16_t *) (buffer + AST_FRIENDLY_OFFSET);
539         int samples;
540
541         struct ast_frame fax_frame = {
542                 .frametype = AST_FRAME_VOICE,
543                 .src = "res_fax_spandsp_g711",
544         };
545         struct ast_frame *f = &fax_frame;
546         ast_format_set(&fax_frame.subclass.format, AST_FORMAT_SLINEAR, 0);
547
548         ast_timer_ack(p->timer, 1);
549
550         /* XXX do we need to lock here? */
551         if (p->isdone) {
552                 s->state = AST_FAX_STATE_COMPLETE;
553                 ast_debug(5, "FAX session '%d' is complete.\n", s->id);
554                 return NULL;
555         }
556
557         if (p->ist38) {
558                 t38_terminal_send_timeout(&p->t38_state, SPANDSP_FAX_SAMPLES);
559                 if ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
560                         return f;
561                 }
562         } else {
563                 if ((samples = fax_tx(&p->fax_state, buf, SPANDSP_FAX_SAMPLES)) > 0) {
564                         f->samples = samples;
565                         AST_FRAME_SET_BUFFER(f, buffer, AST_FRIENDLY_OFFSET, samples * sizeof(int16_t));
566                         return ast_frisolate(f);
567                 }
568         }
569
570         return &ast_null_frame;
571 }
572
573 /*! \brief Write a frame to the spandsp fax stack.
574  * \param s a fax session
575  * \param f the frame to write
576  *
577  * \note res_fax does not currently use the return value of this function.
578  * Also the fax_rx() function never fails.
579  *
580  * \retval 0 success
581  * \retval -1 failure
582  */
583 static int spandsp_fax_write(struct ast_fax_session *s, const struct ast_frame *f)
584 {
585         struct spandsp_pvt *p = s->tech_pvt;
586
587         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
588                 return spandsp_fax_gateway_process(s, f);
589         }
590
591         /* XXX do we need to lock here? */
592         if (s->state == AST_FAX_STATE_COMPLETE) {
593                 ast_log(LOG_WARNING, "FAX session '%d' is in the '%s' state.\n", s->id, ast_fax_state_to_str(s->state));
594                 return -1;
595         }
596
597         if (p->ist38) {
598                 return t38_core_rx_ifp_packet(p->t38_core_state, f->data.ptr, f->datalen, f->seqno);
599         } else {
600                 return fax_rx(&p->fax_state, f->data.ptr, f->samples);
601         }
602 }
603
604 /*! \brief generate T.30 packets sent to the T.30 leg of gateway
605  * \param chan T.30 channel
606  * \param data fax session structure
607  * \param len not used
608  * \param samples no of samples generated
609  * \return -1 on failure or 0 on sucess*/
610 static int spandsp_fax_gw_t30_gen(struct ast_channel *chan, void *data, int len, int samples)
611 {
612         int res = -1;
613         struct ast_fax_session *s = data;
614         struct spandsp_pvt *p = s->tech_pvt;
615         uint8_t buffer[AST_FRIENDLY_OFFSET + samples * sizeof(uint16_t)];
616         struct ast_frame *f;
617         struct ast_frame t30_frame = {
618                 .frametype = AST_FRAME_VOICE,
619                 .src = "res_fax_spandsp_g711",
620                 .samples = samples,
621                 .flags = AST_FAX_FRFLAG_GATEWAY,
622         };
623
624         AST_FRAME_SET_BUFFER(&t30_frame, buffer, AST_FRIENDLY_OFFSET, t30_frame.samples * sizeof(int16_t));
625
626         ast_format_set(&t30_frame.subclass.format, AST_FORMAT_SLINEAR, 0);
627         if (!(f = ast_frisolate(&t30_frame))) {
628                 return p->isdone ? -1 : res;
629         }
630
631         /* generate a T.30 packet */
632         if ((f->samples = t38_gateway_tx(&p->t38_gw_state, f->data.ptr, f->samples))) {
633                 f->datalen = f->samples * sizeof(int16_t);
634                 res = ast_write(chan, f);
635         }
636         ast_frfree(f);
637         return p->isdone ? -1 : res;
638 }
639
640 /*! \brief simple routine to allocate data to generator
641  * \param chan channel
642  * \param params generator data
643  * \return data to use in generator call*/
644 static void *spandsp_fax_gw_gen_alloc(struct ast_channel *chan, void *params) {
645         ao2_ref(params, +1);
646         return params;
647 }
648
649 static void spandsp_fax_gw_gen_release(struct ast_channel *chan, void *data) {
650         ao2_ref(data, -1);
651 }
652
653 /*! \brief activate a spandsp gateway based on the information in the given fax session
654  * \param s fax session
655  * \return -1 on error 0 on sucess*/
656 static int spandsp_fax_gateway_start(struct ast_fax_session *s) {
657         struct spandsp_pvt *p = s->tech_pvt;
658         struct ast_fax_t38_parameters *t38_param;
659         int i, modems = 0;
660         struct ast_channel *peer;
661         static struct ast_generator t30_gen = {
662                 alloc: spandsp_fax_gw_gen_alloc,
663                 release: spandsp_fax_gw_gen_release,
664                 generate: spandsp_fax_gw_t30_gen,
665         };
666
667 #if SPANDSP_RELEASE_DATE >= 20081012
668         /* for spandsp shaphots 0.0.6 and higher */
669         p->t38_core_state=&p->t38_gw_state.t38x.t38;
670 #else
671         /* for spandsp release 0.0.5 */
672         p->t38_core_state=&p->t38_gw_state.t38;
673 #endif
674
675         if (!t38_gateway_init(&p->t38_gw_state, t38_tx_packet_handler, s)) {
676                 return -1;
677         }
678
679         p->ist38 = 1;
680         p->ast_t38_state = ast_channel_get_t38_state(s->chan);
681         if (!(peer = ast_bridged_channel(s->chan))) {
682                 ast_channel_unlock(s->chan);
683                 return -1;
684         }
685         ast_activate_generator(p->ast_t38_state == T38_STATE_NEGOTIATED ? peer : s->chan, &t30_gen , s);
686
687         set_logging(&p->t38_gw_state.logging, s->details);
688         set_logging(&p->t38_core_state->logging, s->details);
689
690         t38_param = (p->ast_t38_state == T38_STATE_NEGOTIATED) ? &s->details->our_t38_parameters : &s->details->their_t38_parameters;
691         t38_set_t38_version(p->t38_core_state, t38_param->version);
692         t38_gateway_set_ecm_capability(&p->t38_gw_state, s->details->option.ecm);
693         t38_set_max_datagram_size(p->t38_core_state, t38_param->max_ifp);
694         t38_set_fill_bit_removal(p->t38_core_state, t38_param->fill_bit_removal);
695         t38_set_mmr_transcoding(p->t38_core_state, t38_param->transcoding_mmr);
696         t38_set_jbig_transcoding(p->t38_core_state, t38_param->transcoding_jbig);
697         t38_set_data_rate_management_method(p->t38_core_state, 
698                         (t38_param->rate_management == AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF)? 1 : 2);
699
700         t38_gateway_set_transmit_on_idle(&p->t38_gw_state, TRUE);
701         t38_set_sequence_number_handling(p->t38_core_state, TRUE);
702
703         if (AST_FAX_MODEM_V17 & s->details->modems) {
704                 modems |= T30_SUPPORT_V17;
705         }
706         if (AST_FAX_MODEM_V27 & s->details->modems) {
707                 modems |= T30_SUPPORT_V27TER;
708         }
709         if (AST_FAX_MODEM_V29 & s->details->modems) {
710                 modems |= T30_SUPPORT_V29;
711         }
712         if (AST_FAX_MODEM_V34 & s->details->modems) {
713 #if defined(T30_SUPPORT_V34)
714                 modems |= T30_SUPPORT_V34;
715 #elif defined(T30_SUPPORT_V34HDX)
716                 modems |= T30_SUPPORT_V34HDX;
717 #else
718                 ast_log(LOG_WARNING, "v34 not supported in this version of spandsp\n");
719 #endif
720         }
721
722         t38_gateway_set_supported_modems(&p->t38_gw_state, modems);
723
724         /* engage udptl nat on other side of T38 line 
725          * (Asterisk changes media ports thus we send a few packets to reinitialize
726          * pinholes in NATs and FWs
727          */
728         for (i=0; i < SPANDSP_ENGAGE_UDPTL_NAT_RETRY; i++) {
729 #if SPANDSP_RELEASE_DATE >= 20091228
730                 t38_core_send_indicator(&p->t38_gw_state.t38x.t38, T38_IND_NO_SIGNAL);
731 #elif SPANDSP_RELEASE_DATE >= 20081012
732                 t38_core_send_indicator(&p->t38_gw_state.t38x.t38, T38_IND_NO_SIGNAL, p->t38_gw_state.t38x.t38.indicator_tx_count);
733 #else
734                 t38_core_send_indicator(&p->t38_gw_state.t38, T38_IND_NO_SIGNAL, p->t38_gw_state.t38.indicator_tx_count);
735 #endif
736         }
737
738         s->state = AST_FAX_STATE_ACTIVE;
739
740         return 0;
741 }
742
743 /*! \brief process a frame from the bridge
744  * \param s fax session
745  * \param f frame to process
746  * \return 1 on sucess 0 on incorect packet*/
747 static int spandsp_fax_gateway_process(struct ast_fax_session *s, const struct ast_frame *f)
748 {
749         struct spandsp_pvt *p = s->tech_pvt;
750
751         /*invalid frame*/
752         if (!f->data.ptr || !f->datalen) {
753                 return -1;
754         }
755
756         /* Process a IFP packet */
757         if ((f->frametype == AST_FRAME_MODEM) && (f->subclass.integer == AST_MODEM_T38)) {
758                 return t38_core_rx_ifp_packet(p->t38_core_state, f->data.ptr, f->datalen, f->seqno);
759         } else if ((f->frametype == AST_FRAME_VOICE) && (f->subclass.format.id == AST_FORMAT_SLINEAR)) {
760                 return t38_gateway_rx(&p->t38_gw_state, f->data.ptr, f->samples);
761         }
762
763         return -1;
764 }
765
766 /*! \brief gather data and clean up after gateway ends
767  * \param s fax session*/
768 static void spandsp_fax_gateway_cleanup(struct ast_fax_session *s)
769 {
770         struct spandsp_pvt *p = s->tech_pvt;
771         t38_stats_t t38_stats;
772
773         t38_gateway_get_transfer_statistics(&p->t38_gw_state, &t38_stats);
774
775         s->details->option.ecm = t38_stats.error_correcting_mode ? AST_FAX_OPTFLAG_TRUE : AST_FAX_OPTFLAG_FALSE;
776         s->details->pages_transferred = t38_stats.pages_transferred;
777         ast_string_field_build(s->details, transfer_rate, "%d", t38_stats.bit_rate);
778 }
779
780 /*! \brief */
781 static int spandsp_fax_start(struct ast_fax_session *s)
782 {
783         struct spandsp_pvt *p = s->tech_pvt;
784
785         s->state = AST_FAX_STATE_OPEN;
786
787         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
788                 return spandsp_fax_gateway_start(s);
789         }
790
791         if (p->ist38) {
792 #if SPANDSP_RELEASE_DATE >= 20080725
793                 /* for spandsp shaphots 0.0.6 and higher */
794                 p->t30_state = &p->t38_state.t30;
795                 p->t38_core_state = &p->t38_state.t38_fe.t38;
796 #else
797                 /* for spandsp releases 0.0.5 */
798                 p->t30_state = &p->t38_state.t30_state;
799                 p->t38_core_state = &p->t38_state.t38;
800 #endif
801         } else {
802 #if SPANDSP_RELEASE_DATE >= 20080725
803                 /* for spandsp shaphots 0.0.6 and higher */
804                 p->t30_state = &p->fax_state.t30;
805 #else
806                 /* for spandsp release 0.0.5 */
807                 p->t30_state = &p->fax_state.t30_state;
808 #endif
809         }
810
811         set_logging(&p->t30_state->logging, s->details);
812
813         /* set some parameters */
814         set_local_info(p->t30_state, s->details);
815         set_file(p->t30_state, s->details);
816         set_ecm(p->t30_state, s->details);
817
818         /* perhaps set_transmit_on_idle() should be called */
819
820         t30_set_phase_e_handler(p->t30_state, t30_phase_e_handler, s);
821
822         /* set T.38 parameters */
823         if (p->ist38) {
824                 set_logging(&p->t38_core_state->logging, s->details);
825
826                 t38_set_max_datagram_size(p->t38_core_state, s->details->their_t38_parameters.max_ifp);
827
828                 if (s->details->their_t38_parameters.fill_bit_removal) {
829                         t38_set_fill_bit_removal(p->t38_core_state, TRUE);
830                 }
831
832                 if (s->details->their_t38_parameters.transcoding_mmr) {
833                         t38_set_mmr_transcoding(p->t38_core_state, TRUE);
834                 }
835
836                 if (s->details->their_t38_parameters.transcoding_jbig) {
837                         t38_set_jbig_transcoding(p->t38_core_state, TRUE);
838                 }
839         } else {
840                 /* have the fax stack generate silence if it has no data to send */
841                 fax_set_transmit_on_idle(&p->fax_state, 1);
842         }
843
844
845         /* start the timer */
846         if (ast_timer_set_rate(p->timer, SPANDSP_FAX_TIMER_RATE)) {
847                 ast_log(LOG_ERROR, "FAX session '%d' error setting rate on timing source.\n", s->id);
848                 return -1;
849         }
850
851         s->state = AST_FAX_STATE_ACTIVE;
852
853         return 0;
854 }
855
856 /*! \brief */
857 static int spandsp_fax_cancel(struct ast_fax_session *s)
858 {
859         struct spandsp_pvt *p = s->tech_pvt;
860
861         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
862                 p->isdone = 1;
863                 return 0;
864         }
865
866         t30_terminate(p->t30_state);
867         p->isdone = 1;
868         return 0;
869 }
870
871 /*! \brief */
872 static int spandsp_fax_switch_to_t38(struct ast_fax_session *s)
873 {
874         struct spandsp_pvt *p = s->tech_pvt;
875
876         /* prevent the phase E handler from running, this is not a real termination */
877         t30_set_phase_e_handler(p->t30_state, NULL, NULL);
878
879         t30_terminate(p->t30_state);
880
881         s->details->option.switch_to_t38 = 1;
882         ast_atomic_fetchadd_int(&p->stats->switched, 1);
883
884         p->ist38 = 1;
885         p->stats = &spandsp_global_stats.t38;
886         spandsp_fax_start(s);
887
888         return 0;
889 }
890
891 /*! \brief */
892 static char *spandsp_fax_cli_show_capabilities(int fd)
893 {
894         ast_cli(fd, "SEND RECEIVE T.38 G.711 GATEWAY\n\n");
895         return  CLI_SUCCESS;
896 }
897
898 /*! \brief */
899 static char *spandsp_fax_cli_show_session(struct ast_fax_session *s, int fd)
900 {
901         struct spandsp_pvt *p = s->tech_pvt;
902
903         ao2_lock(s);
904         if (s->details->caps & AST_FAX_TECH_GATEWAY) {
905                 ast_cli(fd, "%-22s : %d\n", "session", s->id);
906                 ast_cli(fd, "%-22s : %s\n", "operation", "Gateway");
907                 ast_cli(fd, "%-22s : %s\n", "state", ast_fax_state_to_str(s->state));
908                 if (s->state != AST_FAX_STATE_UNINITIALIZED) {
909                         t38_stats_t stats;
910                         t38_gateway_get_transfer_statistics(&p->t38_gw_state, &stats);
911                         ast_cli(fd, "%-22s : %s\n", "ECM Mode", stats.error_correcting_mode ? "Yes" : "No");
912                         ast_cli(fd, "%-22s : %d\n", "Data Rate", stats.bit_rate);
913                         ast_cli(fd, "%-22s : %d\n", "Page Number", stats.pages_transferred + 1);
914                 }
915         } else {
916                 ast_cli(fd, "%-22s : %d\n", "session", s->id);
917                 ast_cli(fd, "%-22s : %s\n", "operation", (s->details->caps & AST_FAX_TECH_RECEIVE) ? "Receive" : "Transmit");
918                 ast_cli(fd, "%-22s : %s\n", "state", ast_fax_state_to_str(s->state));
919                 if (s->state != AST_FAX_STATE_UNINITIALIZED) {
920                         t30_stats_t stats;
921                         t30_get_transfer_statistics(p->t30_state, &stats);
922                         ast_cli(fd, "%-22s : %s\n", "Last Status", t30_completion_code_to_str(stats.current_status));
923                         ast_cli(fd, "%-22s : %s\n", "ECM Mode", stats.error_correcting_mode ? "Yes" : "No");
924                         ast_cli(fd, "%-22s : %d\n", "Data Rate", stats.bit_rate);
925                         ast_cli(fd, "%-22s : %dx%d\n", "Image Resolution", stats.x_resolution, stats.y_resolution);
926 #if SPANDSP_RELEASE_DATE >= 20090220
927                         ast_cli(fd, "%-22s : %d\n", "Page Number", ((s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx) + 1);
928 #else
929                         ast_cli(fd, "%-22s : %d\n", "Page Number", stats.pages_transferred + 1);
930 #endif
931                         ast_cli(fd, "%-22s : %s\n", "File Name", s->details->caps & AST_FAX_TECH_RECEIVE ? p->t30_state->rx_file : p->t30_state->tx_file);
932
933                         ast_cli(fd, "\nData Statistics:\n");
934 #if SPANDSP_RELEASE_DATE >= 20090220
935                         ast_cli(fd, "%-22s : %d\n", "Tx Pages", stats.pages_tx);
936                         ast_cli(fd, "%-22s : %d\n", "Rx Pages", stats.pages_rx);
937 #else
938                         ast_cli(fd, "%-22s : %d\n", "Tx Pages", (s->details->caps & AST_FAX_TECH_SEND) ? stats.pages_transferred : 0);
939                         ast_cli(fd, "%-22s : %d\n", "Rx Pages", (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_transferred : 0);
940 #endif
941                         ast_cli(fd, "%-22s : %d\n", "Longest Bad Line Run", stats.longest_bad_row_run);
942                         ast_cli(fd, "%-22s : %d\n", "Total Bad Lines", stats.bad_rows);
943                 }
944         }
945         ao2_unlock(s);
946         ast_cli(fd, "\n\n");
947         return CLI_SUCCESS;
948 }
949
950 /*! \brief */
951 static char *spandsp_fax_cli_show_stats(int fd)
952 {
953         ast_mutex_lock(&spandsp_global_stats.lock);
954         ast_cli(fd, "\n%-20.20s\n", "Spandsp G.711");
955         ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.g711.success);
956         ast_cli(fd, "%-20.20s : %d\n", "Switched to T.38", spandsp_global_stats.g711.switched);
957         ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.g711.call_dropped);
958         ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.g711.nofax);
959         ast_cli(fd, "%-20.20s : %d\n", "Negotiation Failed", spandsp_global_stats.g711.neg_failed);
960         ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.g711.failed_to_train);
961         ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.g711.retries_exceeded);
962         ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.g711.protocol_error);
963         ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.g711.tx_protocol_error);
964         ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.g711.rx_protocol_error);
965         ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.g711.file_error);
966         ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.g711.mem_error);
967         ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.g711.unknown_error);
968
969         ast_cli(fd, "\n%-20.20s\n", "Spandsp T.38");
970         ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.t38.success);
971         ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.t38.call_dropped);
972         ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.t38.nofax);
973         ast_cli(fd, "%-20.20s : %d\n", "Negotiation Failed", spandsp_global_stats.t38.neg_failed);
974         ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.t38.failed_to_train);
975         ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.t38.retries_exceeded);
976         ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.t38.protocol_error);
977         ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.t38.tx_protocol_error);
978         ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.t38.rx_protocol_error);
979         ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.t38.file_error);
980         ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.t38.mem_error);
981         ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.t38.unknown_error);
982         ast_mutex_unlock(&spandsp_global_stats.lock);
983
984         return CLI_SUCCESS;
985 }
986
987 /*! \brief Show res_fax_spandsp settings */
988 static char *spandsp_fax_cli_show_settings(int fd)
989 {
990         /* no settings at the moment */
991         return CLI_SUCCESS;
992 }
993
994 /*! \brief unload res_fax_spandsp */
995 static int unload_module(void)
996 {
997         ast_fax_tech_unregister(&spandsp_fax_tech);
998         ast_mutex_destroy(&spandsp_global_stats.lock);
999         return AST_MODULE_LOAD_SUCCESS;
1000 }
1001
1002 /*! \brief load res_fax_spandsp */
1003 static int load_module(void)
1004 {
1005         ast_mutex_init(&spandsp_global_stats.lock);
1006         spandsp_fax_tech.module = ast_module_info->self;
1007         if (ast_fax_tech_register(&spandsp_fax_tech) < 0) {
1008                 ast_log(LOG_ERROR, "failed to register FAX technology\n");
1009                 return AST_MODULE_LOAD_DECLINE;
1010         }
1011
1012         /* prevent logging to stderr */
1013         span_set_message_handler(NULL);
1014
1015         return AST_MODULE_LOAD_SUCCESS;
1016 }
1017
1018
1019 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Spandsp G.711 and T.38 FAX Technologies",
1020                 .load = load_module,
1021                 .unload = unload_module,
1022                );