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