Updated CHANGES file to mention res_fax and res_fax_spandsp.
[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  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Spandsp T.38 and G.711 FAX Resource
22  *
23  * \author Matthew Nicholson <mnicholson@digium.com>
24  *
25  * This module registers the Spandsp FAX technology with the res_fax module.
26  */
27
28 /*** MODULEINFO
29         <depend>spandsp</depend>
30         <depend>res_fax</depend>
31 ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #define SPANDSP_EXPOSE_INTERNAL_STRUCTURES
38 #include <spandsp.h>
39 #include <spandsp/version.h>
40
41 #include "asterisk/logger.h"
42 #include "asterisk/module.h"
43 #include "asterisk/strings.h"
44 #include "asterisk/cli.h"
45 #include "asterisk/utils.h"
46 #include "asterisk/timing.h"
47 #include "asterisk/astobj2.h"
48 #include "asterisk/res_fax.h"
49
50 #define SPANDSP_FAX_SAMPLES 160
51 #define SPANDSP_FAX_TIMER_RATE 8000 / SPANDSP_FAX_SAMPLES       /* 50 ticks per second, 20ms, 160 samples per second */
52
53 static void *spandsp_fax_new(struct ast_fax_session *s, struct ast_fax_tech_token *token);
54 static void spandsp_fax_destroy(struct ast_fax_session *s);
55 static struct ast_frame *spandsp_fax_read(struct ast_fax_session *s);
56 static int spandsp_fax_write(struct ast_fax_session *s, const struct ast_frame *f);
57 static int spandsp_fax_start(struct ast_fax_session *s);
58 static int spandsp_fax_cancel(struct ast_fax_session *s);
59 static int spandsp_fax_switch_to_t38(struct ast_fax_session *s);
60
61 static char *spandsp_fax_cli_show_capabilities(int fd);
62 static char *spandsp_fax_cli_show_session(struct ast_fax_session *s, int fd);
63 static char *spandsp_fax_cli_show_stats(int fd);
64
65 static struct ast_fax_tech spandsp_fax_tech = {
66         .type = "Spandsp",
67         .description = "Spandsp FAX Driver",
68 #if SPANDSP_RELEASE_DATE >= 20090220
69         /* spandsp 0.0.6 */
70         .version = SPANDSP_RELEASE_DATETIME_STRING,
71 #else
72         /* spandsp 0.0.5
73          * TODO: maybe we should determine the version better way
74          */
75         .version = "pre-20090220",
76 #endif
77         .caps = AST_FAX_TECH_AUDIO | AST_FAX_TECH_T38 | AST_FAX_TECH_SEND | AST_FAX_TECH_RECEIVE,
78         .new_session = spandsp_fax_new,
79         .destroy_session = spandsp_fax_destroy,
80         .read = spandsp_fax_read,
81         .write = spandsp_fax_write,
82         .start_session = spandsp_fax_start,
83         .cancel_session = spandsp_fax_cancel,
84         .switch_to_t38 = spandsp_fax_switch_to_t38,
85         .cli_show_capabilities = spandsp_fax_cli_show_capabilities,
86         .cli_show_session = spandsp_fax_cli_show_session,
87         .cli_show_stats = spandsp_fax_cli_show_stats,
88 };
89
90 struct spandsp_fax_stats {
91         int success;
92         int nofax;
93         int neg_failed;
94         int failed_to_train;
95         int rx_protocol_error;
96         int tx_protocol_error;
97         int protocol_error;
98         int retries_exceeded;
99         int file_error;
100         int mem_error;
101         int call_dropped;
102         int unknown_error;
103         int switched;
104 };
105
106 static struct {
107         ast_mutex_t lock;
108         struct spandsp_fax_stats g711;
109         struct spandsp_fax_stats t38;
110 } spandsp_global_stats;
111
112 struct spandsp_pvt {
113         unsigned int ist38:1;
114         unsigned int isdone:1;
115         fax_state_t fax_state;
116         t38_terminal_state_t t38_state;
117         t30_state_t *t30_state;
118         t38_core_state_t *t38_core_state;
119
120         struct spandsp_fax_stats *stats;
121
122         struct ast_timer *timer;
123         AST_LIST_HEAD(frame_queue, ast_frame) read_frames;
124 };
125
126 static void session_destroy(struct spandsp_pvt *p);
127 static int t38_tx_packet_handler(t38_core_state_t *t38_core_state, void *data, const uint8_t *buf, int len, int count);
128 static void t30_phase_e_handler(t30_state_t *t30_state, void *data, int completion_code);
129 static void spandsp_log(int level, const char *msg);
130 static int update_stats(struct spandsp_pvt *p, int completion_code);
131
132 static void set_logging(logging_state_t *state, struct ast_fax_session_details *details);
133 static void set_local_info(t30_state_t *t30_state, struct ast_fax_session_details *details);
134 static void set_file(t30_state_t *t30_state, struct ast_fax_session_details *details);
135 static void set_ecm(t30_state_t *t30_state, struct ast_fax_session_details *details);
136
137 static void session_destroy(struct spandsp_pvt *p)
138 {
139         struct ast_frame *f;
140
141         t30_terminate(p->t30_state);
142         p->isdone = 1;
143
144         ast_timer_close(p->timer);
145
146         fax_release(&p->fax_state);
147         t38_terminal_release(&p->t38_state);
148
149         while ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
150                 ast_frfree(f);
151         }
152 }
153
154 /*! \brief
155  *
156  */
157 static int t38_tx_packet_handler(t38_core_state_t *t38_core_state, void *data, const uint8_t *buf, int len, int count)
158 {
159         struct spandsp_pvt *p = data;
160         struct ast_frame fax_frame = {
161                 .frametype = AST_FRAME_MODEM,
162                 .subclass.integer = AST_MODEM_T38,
163                 .src = "res_fax_spandsp_t38",
164         };
165
166         struct ast_frame *f = &fax_frame;
167
168
169         /* TODO: Asterisk does not provide means of resending the same packet multiple
170           times so count is ignored at the moment */
171
172         AST_FRAME_SET_BUFFER(f, buf, 0, len);
173
174         if (!(f = ast_frisolate(f))) {
175                 return -1;
176         }
177
178         /* no need to lock, this all runs in the same thread */
179         AST_LIST_INSERT_TAIL(&p->read_frames, f, frame_list);
180
181         return 0;
182 }
183
184 static int update_stats(struct spandsp_pvt *p, int completion_code)
185 {
186         switch (completion_code) {
187         case T30_ERR_OK:
188                 ast_atomic_fetchadd_int(&p->stats->success, 1);
189                 break;
190
191         /* Link problems */
192         case T30_ERR_CEDTONE:            /*! The CED tone exceeded 5s */
193         case T30_ERR_T0_EXPIRED:         /*! Timed out waiting for initial communication */
194         case T30_ERR_T1_EXPIRED:         /*! Timed out waiting for the first message */
195         case T30_ERR_T3_EXPIRED:         /*! Timed out waiting for procedural interrupt */
196         case T30_ERR_HDLC_CARRIER:       /*! The HDLC carrier did not stop in a timely manner */
197         case T30_ERR_CANNOT_TRAIN:       /*! Failed to train with any of the compatible modems */
198                 ast_atomic_fetchadd_int(&p->stats->failed_to_train, 1);
199                 break;
200
201         case T30_ERR_OPER_INT_FAIL:      /*! Operator intervention failed */
202         case T30_ERR_INCOMPATIBLE:       /*! Far end is not compatible */
203         case T30_ERR_RX_INCAPABLE:       /*! Far end is not able to receive */
204         case T30_ERR_TX_INCAPABLE:       /*! Far end is not able to transmit */
205         case T30_ERR_NORESSUPPORT:       /*! Far end cannot receive at the resolution of the image */
206         case T30_ERR_NOSIZESUPPORT:      /*! Far end cannot receive at the size of image */
207                 ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
208                 break;
209
210         case T30_ERR_UNEXPECTED:         /*! Unexpected message received */
211                 ast_atomic_fetchadd_int(&p->stats->protocol_error, 1);
212                 break;
213
214         /* Phase E status values returned to a transmitter */
215         case T30_ERR_TX_BADDCS:          /*! Received bad response to DCS or training */
216         case T30_ERR_TX_BADPG:           /*! Received a DCN from remote after sending a page */
217         case T30_ERR_TX_ECMPHD:          /*! Invalid ECM response received from receiver */
218         case T30_ERR_TX_GOTDCN:          /*! Received a DCN while waiting for a DIS */
219         case T30_ERR_TX_INVALRSP:        /*! Invalid response after sending a page */
220         case T30_ERR_TX_NODIS:           /*! Received other than DIS while waiting for DIS */
221         case T30_ERR_TX_PHBDEAD:         /*! Received no response to DCS, training or TCF */
222         case T30_ERR_TX_PHDDEAD:         /*! No response after sending a page */
223         case T30_ERR_TX_T5EXP:           /*! Timed out waiting for receiver ready (ECM mode) */
224                 ast_atomic_fetchadd_int(&p->stats->tx_protocol_error, 1);
225                 break;
226
227         /* Phase E status values returned to a receiver */
228         case T30_ERR_RX_ECMPHD:          /*! Invalid ECM response received from transmitter */
229         case T30_ERR_RX_GOTDCS:          /*! DCS received while waiting for DTC */
230         case T30_ERR_RX_INVALCMD:        /*! Unexpected command after page received */
231         case T30_ERR_RX_NOCARRIER:       /*! Carrier lost during fax receive */
232         case T30_ERR_RX_NOEOL:           /*! Timed out while waiting for EOL (end Of line) */
233                 ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
234                 break;
235         case T30_ERR_RX_NOFAX:           /*! Timed out while waiting for first line */
236                 ast_atomic_fetchadd_int(&p->stats->nofax, 1);
237                 break;
238         case T30_ERR_RX_T2EXPDCN:        /*! Timer T2 expired while waiting for DCN */
239         case T30_ERR_RX_T2EXPD:          /*! Timer T2 expired while waiting for phase D */
240         case T30_ERR_RX_T2EXPFAX:        /*! Timer T2 expired while waiting for fax page */
241         case T30_ERR_RX_T2EXPMPS:        /*! Timer T2 expired while waiting for next fax page */
242         case T30_ERR_RX_T2EXPRR:         /*! Timer T2 expired while waiting for RR command */
243         case T30_ERR_RX_T2EXP:           /*! Timer T2 expired while waiting for NSS, DCS or MCF */
244         case T30_ERR_RX_DCNWHY:          /*! Unexpected DCN while waiting for DCS or DIS */
245         case T30_ERR_RX_DCNDATA:         /*! Unexpected DCN while waiting for image data */
246         case T30_ERR_RX_DCNFAX:          /*! Unexpected DCN while waiting for EOM, EOP or MPS */
247         case T30_ERR_RX_DCNPHD:          /*! Unexpected DCN after EOM or MPS sequence */
248         case T30_ERR_RX_DCNRRD:          /*! Unexpected DCN after RR/RNR sequence */
249         case T30_ERR_RX_DCNNORTN:        /*! Unexpected DCN after requested retransmission */
250                 ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
251                 break;
252
253         /* TIFF file problems */
254         case T30_ERR_FILEERROR:          /*! TIFF/F file cannot be opened */
255         case T30_ERR_NOPAGE:             /*! TIFF/F page not found */
256         case T30_ERR_BADTIFF:            /*! TIFF/F format is not compatible */
257         case T30_ERR_BADPAGE:            /*! TIFF/F page number tag missing */
258         case T30_ERR_BADTAG:             /*! Incorrect values for TIFF/F tags */
259         case T30_ERR_BADTIFFHDR:         /*! Bad TIFF/F header - incorrect values in fields */
260                 ast_atomic_fetchadd_int(&p->stats->file_error, 1);
261                 break;
262         case T30_ERR_NOMEM:              /*! Cannot allocate memory for more pages */
263                 ast_atomic_fetchadd_int(&p->stats->mem_error, 1);
264                 break;
265
266         /* General problems */
267         case T30_ERR_RETRYDCN:           /*! Disconnected after permitted retries */
268                 ast_atomic_fetchadd_int(&p->stats->retries_exceeded, 1);
269                 break;
270         case T30_ERR_CALLDROPPED:        /*! The call dropped prematurely */
271                 ast_atomic_fetchadd_int(&p->stats->call_dropped, 1);
272                 break;
273
274         /* Feature negotiation issues */
275         case T30_ERR_NOPOLL:             /*! Poll not accepted */
276         case T30_ERR_IDENT_UNACCEPTABLE: /*! Far end's ident is not acceptable */
277         case T30_ERR_SUB_UNACCEPTABLE:   /*! Far end's sub-address is not acceptable */
278         case T30_ERR_SEP_UNACCEPTABLE:   /*! Far end's selective polling address is not acceptable */
279         case T30_ERR_PSA_UNACCEPTABLE:   /*! Far end's polled sub-address is not acceptable */
280         case T30_ERR_SID_UNACCEPTABLE:   /*! Far end's sender identification is not acceptable */
281         case T30_ERR_PWD_UNACCEPTABLE:   /*! Far end's password is not acceptable */
282         case T30_ERR_TSA_UNACCEPTABLE:   /*! Far end's transmitting subscriber internet address is not acceptable */
283         case T30_ERR_IRA_UNACCEPTABLE:   /*! Far end's internet routing address is not acceptable */
284         case T30_ERR_CIA_UNACCEPTABLE:   /*! Far end's calling subscriber internet address is not acceptable */
285         case T30_ERR_ISP_UNACCEPTABLE:   /*! Far end's internet selective polling address is not acceptable */
286         case T30_ERR_CSA_UNACCEPTABLE:   /*! Far end's called subscriber internet address is not acceptable */
287                 ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
288                 break;
289         default:
290                 ast_atomic_fetchadd_int(&p->stats->unknown_error, 1);
291                 ast_log(LOG_WARNING, "unknown FAX session result '%d' (%s)\n", completion_code, t30_completion_code_to_str(completion_code));
292                 return -1;
293         }
294         return 0;
295 }
296
297 /*! \brief Phase E handler callback.
298  * \param t30_state the span t30 state
299  * \param data this will be the ast_fax_session
300  * \param completion_code the result of the fax session
301  *
302  * This function pulls stats from the spandsp stack and stores them for res_fax
303  * to use later.
304  */
305 static void t30_phase_e_handler(t30_state_t *t30_state, void *data, int completion_code)
306 {
307         struct ast_fax_session *s = data;
308         struct spandsp_pvt *p = s->tech_pvt;
309         char headerinfo[T30_MAX_PAGE_HEADER_INFO + 1];
310         const char *c;
311         t30_stats_t stats;
312
313         ast_debug(5, "FAX session '%d' entering phase E\n", s->id);
314
315         p->isdone = 1;
316
317         update_stats(p, completion_code);
318
319         t30_get_transfer_statistics(t30_state, &stats);
320
321         if (completion_code == T30_ERR_OK) {
322                 ast_string_field_set(s->details, result, "SUCCESS");
323         } else {
324                 ast_string_field_set(s->details, result, "FAILED");
325                 ast_string_field_set(s->details, error, t30_completion_code_to_str(completion_code));
326         }
327
328         ast_string_field_set(s->details, resultstr, t30_completion_code_to_str(completion_code));
329
330         ast_debug(5, "FAX session '%d' completed with result: %s (%s)\n", s->id, s->details->result, s->details->resultstr);
331
332         if ((c = t30_get_tx_ident(t30_state))) {
333                 ast_string_field_set(s->details, localstationid, c);
334         }
335
336         if ((c = t30_get_rx_ident(t30_state))) {
337                 ast_string_field_set(s->details, remotestationid, c);
338         }
339
340 #if SPANDSP_RELEASE_DATE >= 20090220
341         s->details->pages_transferred = (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx;
342 #else
343         s->details->pages_transferred = stats.pages_transferred;
344 #endif
345
346         ast_string_field_build(s->details, transfer_rate, "%d", stats.bit_rate);
347
348         ast_string_field_build(s->details, resolution, "%dx%d", stats.x_resolution, stats.y_resolution);
349
350         t30_get_tx_page_header_info(t30_state, headerinfo);
351         ast_string_field_set(s->details, headerinfo, headerinfo);
352 }
353
354 /*! \brief Send spandsp log messages to asterisk.
355  * \param level the spandsp logging level
356  * \param msg the log message
357  *
358  * \note This function is a callback function called by spandsp.
359  */
360 static void spandsp_log(int level, const char *msg)
361 {
362         if (level == SPAN_LOG_ERROR) {
363                 ast_log(LOG_ERROR, "%s", msg);
364         } else if (level == SPAN_LOG_WARNING) {
365                 ast_log(LOG_WARNING, "%s", msg);
366         } else {
367                 ast_log(LOG_DEBUG, "%s", msg);
368         }
369 }
370
371 static void set_logging(logging_state_t *state, struct ast_fax_session_details *details)
372 {
373         int level = SPAN_LOG_WARNING;
374
375         if (details->option.debug) {
376                 level = SPAN_LOG_DEBUG_3;
377         }
378
379         span_log_set_message_handler(state, spandsp_log);
380         span_log_set_level(state, SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | level);
381 }
382
383 static void set_local_info(t30_state_t *t30_state, struct ast_fax_session_details *details)
384 {
385         if (!ast_strlen_zero(details->localstationid)) {
386                 t30_set_tx_ident(t30_state, details->localstationid);
387         }
388
389         if (!ast_strlen_zero(details->headerinfo)) {
390                 t30_set_tx_page_header_info(t30_state, details->headerinfo);
391         }
392 }
393
394 static void set_file(t30_state_t *t30_state, struct ast_fax_session_details *details)
395 {
396         if (details->caps & AST_FAX_TECH_RECEIVE) {
397                 t30_set_rx_file(t30_state, AST_LIST_FIRST(&details->documents)->filename, -1);
398         } else {
399                 /* if not AST_FAX_TECH_RECEIVE, assume AST_FAX_TECH_SEND, this
400                  * should be safe because we ensure either RECEIVE or SEND is
401                  * indicated in spandsp_fax_new() */
402                 t30_set_tx_file(t30_state, AST_LIST_FIRST(&details->documents)->filename, -1, -1);
403         }
404 }
405
406 static void set_ecm(t30_state_t *t30_state, struct ast_fax_session_details *details)
407 {
408         t30_set_ecm_capability(t30_state, (details->option.ecm == AST_FAX_OPTFLAG_DEFAULT) ? 1 : details->option.ecm );
409         t30_set_supported_compressions(t30_state, T30_SUPPORT_T4_1D_COMPRESSION | T30_SUPPORT_T4_2D_COMPRESSION | T30_SUPPORT_T6_COMPRESSION);
410 }
411
412 /*! \brief create an instance of the spandsp tech_pvt for a fax session */
413 static void *spandsp_fax_new(struct ast_fax_session *s, struct ast_fax_tech_token *token)
414 {
415         struct spandsp_pvt *p;
416         int caller_mode;
417
418         if ((!(p = ast_calloc(1, sizeof(*p))))) {
419                 ast_log(LOG_ERROR, "Cannot initialize the spandsp private FAX technology structure.\n");
420                 goto e_return;
421         }
422
423         AST_LIST_HEAD_INIT(&p->read_frames);
424
425         if (s->details->caps & AST_FAX_TECH_RECEIVE) {
426                 caller_mode = 0;
427         } else if (s->details->caps & AST_FAX_TECH_SEND) {
428                 caller_mode = 1;
429         } else {
430                 ast_log(LOG_ERROR, "Are we sending or receiving? The FAX requirements (capabilities: 0x%X) were not properly set.\n", s->details->caps);
431                 goto e_free;
432         }
433
434         if (!(p->timer = ast_timer_open())) {
435                 ast_log(LOG_ERROR, "Channel '%s' FAX session '%d' failed to create timing source.\n", s->channame, s->id);
436                 goto e_free;
437         }
438
439         s->fd = ast_timer_fd(p->timer);
440
441         p->stats = &spandsp_global_stats.g711;
442
443         if (s->details->caps & AST_FAX_TECH_T38) {
444                 if ((s->details->caps & AST_FAX_TECH_AUDIO) == 0) {
445                         /* audio mode was not requested, start in T.38 mode */
446                         p->ist38 = 1;
447                         p->stats = &spandsp_global_stats.t38;
448                 }
449
450                 /* init t38 stuff */
451                 t38_terminal_init(&p->t38_state, caller_mode, t38_tx_packet_handler, p);
452                 set_logging(&p->t38_state.logging, s->details);
453         }
454
455         if (s->details->caps & AST_FAX_TECH_AUDIO) {
456                 /* init audio stuff */
457                 fax_init(&p->fax_state, caller_mode);
458                 set_logging(&p->fax_state.logging, s->details);
459         }
460
461         s->state = AST_FAX_STATE_INITIALIZED;
462         return p;
463
464 e_free:
465         ast_free(p);
466 e_return:
467         return NULL;
468 }
469
470 /*! \brief Destroy a spandsp fax session.
471  */
472 static void spandsp_fax_destroy(struct ast_fax_session *s)
473 {
474         struct spandsp_pvt *p = s->tech_pvt;
475
476         session_destroy(p);
477         ast_free(p);
478         s->tech_pvt = NULL;
479         s->fd = -1;
480 }
481
482 /*! \brief Read a frame from the spandsp fax stack.
483  */
484 static struct ast_frame *spandsp_fax_read(struct ast_fax_session *s)
485 {
486         struct spandsp_pvt *p = s->tech_pvt;
487         uint8_t buffer[AST_FRIENDLY_OFFSET + SPANDSP_FAX_SAMPLES * sizeof(uint16_t)];
488         int16_t *buf = (int16_t *) (buffer + AST_FRIENDLY_OFFSET);
489         int samples;
490
491         struct ast_frame fax_frame = {
492                 .frametype = AST_FRAME_VOICE,
493                 .subclass.codec = AST_FORMAT_SLINEAR,
494                 .src = "res_fax_spandsp_g711",
495         };
496
497         struct ast_frame *f = &fax_frame;
498
499         ast_timer_ack(p->timer, 1);
500
501         /* XXX do we need to lock here? */
502         if (p->isdone) {
503                 s->state = AST_FAX_STATE_COMPLETE;
504                 ast_debug(5, "FAX session '%d' is complete.\n", s->id);
505                 return NULL;
506         }
507
508         if (p->ist38) {
509                 t38_terminal_send_timeout(&p->t38_state, SPANDSP_FAX_SAMPLES);
510                 if ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
511                         return f;
512                 }
513         } else {
514                 if ((samples = fax_tx(&p->fax_state, buf, SPANDSP_FAX_SAMPLES)) > 0) {
515                         f->samples = samples;
516                         AST_FRAME_SET_BUFFER(f, buffer, AST_FRIENDLY_OFFSET, samples * sizeof(int16_t));
517                         return ast_frisolate(f);
518                 }
519         }
520
521         return &ast_null_frame;
522 }
523
524 /*! \brief Write a frame to the spandsp fax stack.
525  * \param s a fax session
526  * \param f the frame to write
527  *
528  * \note res_fax does not currently use the return value of this function.
529  * Also the fax_rx() function never fails.
530  *
531  * \retval 0 success
532  * \retval -1 failure
533  */
534 static int spandsp_fax_write(struct ast_fax_session *s, const struct ast_frame *f)
535 {
536         struct spandsp_pvt *p = s->tech_pvt;
537
538         /* XXX do we need to lock here? */
539         if (s->state == AST_FAX_STATE_COMPLETE) {
540                 ast_log(LOG_WARNING, "FAX session '%d' is in the '%s' state.\n", s->id, ast_fax_state_to_str(s->state));
541                 return -1;
542         }
543
544         if (p->ist38) {
545                 return t38_core_rx_ifp_packet(p->t38_core_state, f->data.ptr, f->datalen, f->seqno);
546         } else {
547                 return fax_rx(&p->fax_state, f->data.ptr, f->samples);
548         }
549 }
550
551 /*! \brief */
552 static int spandsp_fax_start(struct ast_fax_session *s)
553 {
554         struct spandsp_pvt *p = s->tech_pvt;
555
556         s->state = AST_FAX_STATE_OPEN;
557
558         if (p->ist38) {
559 #if SPANDSP_RELEASE_DATE >= 20080725
560                 /* for spandsp shaphots 0.0.6 and higher */
561                 p->t30_state = &p->t38_state.t30;
562                 p->t38_core_state = &p->t38_state.t38_fe.t38;
563 #else
564                 /* for spandsp releases 0.0.5 */
565                 p->t30_state = &p->t38_state.t30_state;
566                 p->t38_core_state = &p->t38_state.t38;
567 #endif
568         } else {
569 #if SPANDSP_RELEASE_DATE >= 20080725
570                 /* for spandsp shaphots 0.0.6 and higher */
571                 p->t30_state = &p->fax_state.t30;
572 #else
573                 /* for spandsp release 0.0.5 */
574                 p->t30_state = &p->fax_state.t30_state;
575 #endif
576         }
577
578         set_logging(&p->t30_state->logging, s->details);
579
580         /* set some parameters */
581         set_local_info(p->t30_state, s->details);
582         set_file(p->t30_state, s->details);
583         set_ecm(p->t30_state, s->details);
584
585         /* perhaps set_transmit_on_idle() should be called */
586
587         t30_set_phase_e_handler(p->t30_state, t30_phase_e_handler, s);
588
589         /* set T.38 parameters */
590         if (p->ist38) {
591                 set_logging(&p->t38_core_state->logging, s->details);
592
593                 t38_set_max_datagram_size(p->t38_core_state, s->details->their_t38_parameters.max_ifp);
594
595                 if (s->details->their_t38_parameters.fill_bit_removal) {
596                         t38_set_fill_bit_removal(p->t38_core_state, TRUE);
597                 }
598
599                 if (s->details->their_t38_parameters.transcoding_mmr) {
600                         t38_set_mmr_transcoding(p->t38_core_state, TRUE);
601                 }
602
603                 if (s->details->their_t38_parameters.transcoding_jbig) {
604                         t38_set_jbig_transcoding(p->t38_core_state, TRUE);
605                 }
606         } else {
607                 /* have the fax stack generate silence if it has no data to send */
608                 fax_set_transmit_on_idle(&p->fax_state, 1);
609         }
610
611
612         /* start the timer */
613         if (ast_timer_set_rate(p->timer, SPANDSP_FAX_TIMER_RATE)) {
614                 ast_log(LOG_ERROR, "FAX session '%d' error setting rate on timing source.\n", s->id);
615                 return -1;
616         }
617
618         s->state = AST_FAX_STATE_ACTIVE;
619
620         return 0;
621 }
622
623 /*! \brief */
624 static int spandsp_fax_cancel(struct ast_fax_session *s)
625 {
626         struct spandsp_pvt *p = s->tech_pvt;
627         t30_terminate(p->t30_state);
628         p->isdone = 1;
629         return 0;
630 }
631
632 /*! \brief */
633 static int spandsp_fax_switch_to_t38(struct ast_fax_session *s)
634 {
635         struct spandsp_pvt *p = s->tech_pvt;
636
637         /* prevent the phase E handler from running, this is not a real termination */
638         t30_set_phase_e_handler(p->t30_state, NULL, NULL);
639
640         t30_terminate(p->t30_state);
641
642         s->details->option.switch_to_t38 = 1;
643         ast_atomic_fetchadd_int(&p->stats->switched, 1);
644
645         p->ist38 = 1;
646         p->stats = &spandsp_global_stats.t38;
647         spandsp_fax_start(s);
648
649         return 0;
650 }
651
652 /*! \brief */
653 static char *spandsp_fax_cli_show_capabilities(int fd)
654 {
655         ast_cli(fd, "SEND RECEIVE T.38 G.711\n\n");
656         return  CLI_SUCCESS;
657 }
658
659 /*! \brief */
660 static char *spandsp_fax_cli_show_session(struct ast_fax_session *s, int fd)
661 {
662         struct spandsp_pvt *p = s->tech_pvt;
663         t30_stats_t stats;
664
665         ao2_lock(s);
666         ast_cli(fd, "%-22s : %d\n", "session", s->id);
667         ast_cli(fd, "%-22s : %s\n", "operation", (s->details->caps & AST_FAX_TECH_RECEIVE) ? "Receive" : "Transmit");
668         ast_cli(fd, "%-22s : %s\n", "state", ast_fax_state_to_str(s->state));
669         if (s->state != AST_FAX_STATE_UNINITIALIZED) {
670                 t30_get_transfer_statistics(p->t30_state, &stats);
671                 ast_cli(fd, "%-22s : %s\n", "Last Status", t30_completion_code_to_str(stats.current_status));
672                 ast_cli(fd, "%-22s : %s\n", "ECM Mode", stats.error_correcting_mode ? "Yes" : "No");
673                 ast_cli(fd, "%-22s : %d\n", "Data Rate", stats.bit_rate);
674                 ast_cli(fd, "%-22s : %dx%d\n", "Image Resolution", stats.x_resolution, stats.y_resolution);
675 #if SPANDSP_RELEASE_DATE >= 20090220
676                 ast_cli(fd, "%-22s : %d\n", "Page Number", (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx);
677 #else
678                 ast_cli(fd, "%-22s : %d\n", "Page Number", stats.pages_transferred);
679 #endif
680                 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);
681
682                 ast_cli(fd, "\nData Statistics:\n");
683 #if SPANDSP_RELEASE_DATE >= 20090220
684                 ast_cli(fd, "%-22s : %d\n", "Tx Pages", stats.pages_tx);
685                 ast_cli(fd, "%-22s : %d\n", "Rx Pages", stats.pages_rx);
686 #else
687                 ast_cli(fd, "%-22s : %d\n", "Tx Pages", (s->details->caps & AST_FAX_TECH_SEND) ? stats.pages_transferred : 0);
688                 ast_cli(fd, "%-22s : %d\n", "Rx Pages", (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_transferred : 0);
689 #endif
690                 ast_cli(fd, "%-22s : %d\n", "Longest Bad Line Run", stats.longest_bad_row_run);
691                 ast_cli(fd, "%-22s : %d\n", "Total Bad Lines", stats.bad_rows);
692         }
693         ao2_unlock(s);
694         ast_cli(fd, "\n\n");
695         return CLI_SUCCESS;
696 }
697
698 /*! \brief */
699 static char *spandsp_fax_cli_show_stats(int fd)
700 {
701         ast_mutex_lock(&spandsp_global_stats.lock);
702         ast_cli(fd, "\n%-20.20s\n", "Spandsp G.711");
703         ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.g711.success);
704         ast_cli(fd, "%-20.20s : %d\n", "Switched to T.38", spandsp_global_stats.g711.switched);
705         ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.g711.call_dropped);
706         ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.g711.nofax);
707         ast_cli(fd, "%-20.20s : %d\n", "Negotation Failed", spandsp_global_stats.g711.neg_failed);
708         ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.g711.failed_to_train);
709         ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.g711.retries_exceeded);
710         ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.g711.protocol_error);
711         ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.g711.tx_protocol_error);
712         ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.g711.rx_protocol_error);
713         ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.g711.file_error);
714         ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.g711.mem_error);
715         ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.g711.unknown_error);
716
717         ast_cli(fd, "\n%-20.20s\n", "Spandsp T.38");
718         ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.t38.success);
719         ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.t38.call_dropped);
720         ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.t38.nofax);
721         ast_cli(fd, "%-20.20s : %d\n", "Negotation Failed", spandsp_global_stats.t38.neg_failed);
722         ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.t38.failed_to_train);
723         ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.t38.retries_exceeded);
724         ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.t38.protocol_error);
725         ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.t38.tx_protocol_error);
726         ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.t38.rx_protocol_error);
727         ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.t38.file_error);
728         ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.t38.mem_error);
729         ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.t38.unknown_error);
730         ast_mutex_unlock(&spandsp_global_stats.lock);
731
732         return CLI_SUCCESS;
733 }
734
735 /*! \brief unload res_fax_spandsp */
736 static int unload_module(void)
737 {
738         ast_fax_tech_unregister(&spandsp_fax_tech);
739         ast_mutex_destroy(&spandsp_global_stats.lock);
740         return AST_MODULE_LOAD_SUCCESS;
741 }
742
743 /*! \brief load res_fax_spandsp */
744 static int load_module(void)
745 {
746         ast_mutex_init(&spandsp_global_stats.lock);
747         spandsp_fax_tech.module = ast_module_info->self;
748         if (ast_fax_tech_register(&spandsp_fax_tech) < 0) {
749                 ast_log(LOG_ERROR, "failed to register FAX technology\n");
750                 return AST_MODULE_LOAD_DECLINE;
751         }
752
753         /* prevent logging to stderr */
754         span_set_message_handler(NULL);
755
756         return AST_MODULE_LOAD_SUCCESS;
757 }
758
759
760 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Spandsp G.711 and T.38 FAX Technologies",
761                 .load = load_module,
762                 .unload = unload_module,
763                );