Wed Jan 27 20:02:47 2016

Asterisk developer's documentation


res_fax_spandsp.c File Reference

Spandsp T.38 and G.711 FAX Resource. More...

#include "asterisk.h"
#include <spandsp.h>
#include <spandsp/version.h>
#include "asterisk/logger.h"
#include "asterisk/module.h"
#include "asterisk/strings.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/timing.h"
#include "asterisk/astobj2.h"
#include "asterisk/res_fax.h"

Go to the source code of this file.

Data Structures

struct  frame_queue
struct  spandsp_fax_stats
struct  spandsp_pvt

Defines

#define SPANDSP_EXPOSE_INTERNAL_STRUCTURES
#define SPANDSP_FAX_SAMPLES   160
#define SPANDSP_FAX_TIMER_RATE   8000 / SPANDSP_FAX_SAMPLES

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int load_module (void)
 load res_fax_spandsp
static void session_destroy (struct spandsp_pvt *p)
static void set_ecm (t30_state_t *t30_state, struct ast_fax_session_details *details)
static void set_file (t30_state_t *t30_state, struct ast_fax_session_details *details)
static void set_local_info (t30_state_t *t30_state, struct ast_fax_session_details *details)
static void set_logging (logging_state_t *state, struct ast_fax_session_details *details)
static int spandsp_fax_cancel (struct ast_fax_session *s)
static char * spandsp_fax_cli_show_capabilities (int fd)
static char * spandsp_fax_cli_show_session (struct ast_fax_session *s, int fd)
static char * spandsp_fax_cli_show_settings (int fd)
 Show res_fax_spandsp settings.
static char * spandsp_fax_cli_show_stats (int fd)
static void spandsp_fax_destroy (struct ast_fax_session *s)
 Destroy a spandsp fax session.
static void * spandsp_fax_new (struct ast_fax_session *s, struct ast_fax_tech_token *token)
 create an instance of the spandsp tech_pvt for a fax session
static struct ast_framespandsp_fax_read (struct ast_fax_session *s)
 Read a frame from the spandsp fax stack.
static int spandsp_fax_start (struct ast_fax_session *s)
static int spandsp_fax_switch_to_t38 (struct ast_fax_session *s)
static int spandsp_fax_write (struct ast_fax_session *s, const struct ast_frame *f)
 Write a frame to the spandsp fax stack.
static void spandsp_log (int level, const char *msg)
 Send spandsp log messages to asterisk.
static int spandsp_modems (struct ast_fax_session_details *details)
static void t30_phase_e_handler (t30_state_t *t30_state, void *data, int completion_code)
 Phase E handler callback.
static int t38_tx_packet_handler (t38_core_state_t *t38_core_state, void *data, const uint8_t *buf, int len, int count)
static int unload_module (void)
 unload res_fax_spandsp
static int update_stats (struct spandsp_pvt *p, int completion_code)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Spandsp G.711 and T.38 FAX Technologies" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, }
static struct ast_module_infoast_module_info = &__mod_info
static struct ast_fax_tech spandsp_fax_tech
struct {
   struct spandsp_fax_stats   g711
   ast_mutex_t   lock
   struct spandsp_fax_stats   t38
spandsp_global_stats

Detailed Description

Spandsp T.38 and G.711 FAX Resource.

Author:
Matthew Nicholson <mnicholson@digium.com>

This module registers the Spandsp FAX technology with the res_fax module.

Definition in file res_fax_spandsp.c.


Define Documentation

#define SPANDSP_EXPOSE_INTERNAL_STRUCTURES

Definition at line 38 of file res_fax_spandsp.c.

#define SPANDSP_FAX_SAMPLES   160

Definition at line 51 of file res_fax_spandsp.c.

Referenced by spandsp_fax_read().

#define SPANDSP_FAX_TIMER_RATE   8000 / SPANDSP_FAX_SAMPLES

Definition at line 52 of file res_fax_spandsp.c.

Referenced by spandsp_fax_start().


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 801 of file res_fax_spandsp.c.

static void __unreg_module ( void   )  [static]

Definition at line 801 of file res_fax_spandsp.c.

static int load_module ( void   )  [static]

load res_fax_spandsp

Definition at line 782 of file res_fax_spandsp.c.

References ast_fax_tech_register(), ast_log(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_mutex_init, LOG_ERROR, ast_fax_tech::module, and spandsp_global_stats.

00783 {
00784    ast_mutex_init(&spandsp_global_stats.lock);
00785    spandsp_fax_tech.module = ast_module_info->self;
00786    if (ast_fax_tech_register(&spandsp_fax_tech) < 0) {
00787       ast_log(LOG_ERROR, "failed to register FAX technology\n");
00788       return AST_MODULE_LOAD_DECLINE;
00789    }
00790 
00791    /* prevent logging to stderr */
00792    span_set_message_handler(NULL);
00793 
00794    return AST_MODULE_LOAD_SUCCESS;
00795 }

static void session_destroy ( struct spandsp_pvt p  )  [static]

Definition at line 141 of file res_fax_spandsp.c.

References ast_frfree, AST_LIST_REMOVE_HEAD, ast_timer_close(), and f.

Referenced by spandsp_fax_destroy().

00142 {
00143    struct ast_frame *f;
00144 
00145    t30_terminate(p->t30_state);
00146    p->isdone = 1;
00147 
00148    ast_timer_close(p->timer);
00149    p->timer = NULL;
00150    fax_release(&p->fax_state);
00151    t38_terminal_release(&p->t38_state);
00152 
00153    while ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
00154       ast_frfree(f);
00155    }
00156 }

static void set_ecm ( t30_state_t *  t30_state,
struct ast_fax_session_details details 
) [static]

Definition at line 410 of file res_fax_spandsp.c.

References ast_fax_session_details::ecm, and ast_fax_session_details::option.

Referenced by spandsp_fax_start().

00411 {
00412    t30_set_ecm_capability(t30_state, details->option.ecm);
00413    t30_set_supported_compressions(t30_state, T30_SUPPORT_T4_1D_COMPRESSION | T30_SUPPORT_T4_2D_COMPRESSION | T30_SUPPORT_T6_COMPRESSION);
00414 }

static void set_file ( t30_state_t *  t30_state,
struct ast_fax_session_details details 
) [static]

Definition at line 398 of file res_fax_spandsp.c.

References AST_FAX_TECH_RECEIVE, AST_LIST_FIRST, ast_fax_session_details::caps, and ast_fax_session_details::documents.

Referenced by spandsp_fax_start().

00399 {
00400    if (details->caps & AST_FAX_TECH_RECEIVE) {
00401       t30_set_rx_file(t30_state, AST_LIST_FIRST(&details->documents)->filename, -1);
00402    } else {
00403       /* if not AST_FAX_TECH_RECEIVE, assume AST_FAX_TECH_SEND, this
00404        * should be safe because we ensure either RECEIVE or SEND is
00405        * indicated in spandsp_fax_new() */
00406       t30_set_tx_file(t30_state, AST_LIST_FIRST(&details->documents)->filename, -1, -1);
00407    }
00408 }

static void set_local_info ( t30_state_t *  t30_state,
struct ast_fax_session_details details 
) [static]

Definition at line 387 of file res_fax_spandsp.c.

References ast_strlen_zero().

Referenced by spandsp_fax_start().

00388 {
00389    if (!ast_strlen_zero(details->localstationid)) {
00390       t30_set_tx_ident(t30_state, details->localstationid);
00391    }
00392 
00393    if (!ast_strlen_zero(details->headerinfo)) {
00394       t30_set_tx_page_header_info(t30_state, details->headerinfo);
00395    }
00396 }

static void set_logging ( logging_state_t *  state,
struct ast_fax_session_details details 
) [static]

Definition at line 375 of file res_fax_spandsp.c.

References ast_fax_session_details::debug, ast_fax_session_details::option, and spandsp_log().

Referenced by spandsp_fax_new(), and spandsp_fax_start().

00376 {
00377    int level = SPAN_LOG_WARNING;
00378 
00379         if (details->option.debug) {
00380       level = SPAN_LOG_DEBUG_3;
00381    }
00382 
00383    span_log_set_message_handler(state, spandsp_log);
00384    span_log_set_level(state, SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | level);
00385 }

static int spandsp_fax_cancel ( struct ast_fax_session s  )  [static]

Definition at line 655 of file res_fax_spandsp.c.

References spandsp_pvt::isdone, spandsp_pvt::t30_state, and ast_fax_session::tech_pvt.

00656 {
00657    struct spandsp_pvt *p = s->tech_pvt;
00658    t30_terminate(p->t30_state);
00659    p->isdone = 1;
00660    return 0;
00661 }

static char * spandsp_fax_cli_show_capabilities ( int  fd  )  [static]

Definition at line 684 of file res_fax_spandsp.c.

References ast_cli(), and CLI_SUCCESS.

00685 {
00686    ast_cli(fd, "SEND RECEIVE T.38 G.711\n\n");
00687    return  CLI_SUCCESS;
00688 }

static char * spandsp_fax_cli_show_session ( struct ast_fax_session s,
int  fd 
) [static]

Definition at line 691 of file res_fax_spandsp.c.

References ao2_lock, ao2_unlock, ast_cli(), ast_fax_state_to_str(), AST_FAX_STATE_UNINITIALIZED, AST_FAX_TECH_RECEIVE, AST_FAX_TECH_SEND, ast_fax_session_details::caps, CLI_SUCCESS, ast_fax_session::details, ast_fax_session::id, ast_fax_session::state, spandsp_pvt::stats, spandsp_pvt::t30_state, and ast_fax_session::tech_pvt.

00692 {
00693    struct spandsp_pvt *p = s->tech_pvt;
00694    t30_stats_t stats;
00695 
00696    ao2_lock(s);
00697    ast_cli(fd, "%-22s : %u\n", "session", s->id);
00698    ast_cli(fd, "%-22s : %s\n", "operation", (s->details->caps & AST_FAX_TECH_RECEIVE) ? "Receive" : "Transmit");
00699    ast_cli(fd, "%-22s : %s\n", "state", ast_fax_state_to_str(s->state));
00700    if (s->state != AST_FAX_STATE_UNINITIALIZED) {
00701       t30_get_transfer_statistics(p->t30_state, &stats);
00702       ast_cli(fd, "%-22s : %s\n", "Last Status", t30_completion_code_to_str(stats.current_status));
00703       ast_cli(fd, "%-22s : %s\n", "ECM Mode", stats.error_correcting_mode ? "Yes" : "No");
00704       ast_cli(fd, "%-22s : %d\n", "Data Rate", stats.bit_rate);
00705       ast_cli(fd, "%-22s : %dx%d\n", "Image Resolution", stats.x_resolution, stats.y_resolution);
00706 #if SPANDSP_RELEASE_DATE >= 20090220
00707       ast_cli(fd, "%-22s : %d\n", "Page Number", ((s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx) + 1);
00708 #else
00709       ast_cli(fd, "%-22s : %d\n", "Page Number", stats.pages_transferred + 1);
00710 #endif
00711       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);
00712 
00713       ast_cli(fd, "\nData Statistics:\n");
00714 #if SPANDSP_RELEASE_DATE >= 20090220
00715       ast_cli(fd, "%-22s : %d\n", "Tx Pages", stats.pages_tx);
00716       ast_cli(fd, "%-22s : %d\n", "Rx Pages", stats.pages_rx);
00717 #else
00718       ast_cli(fd, "%-22s : %d\n", "Tx Pages", (s->details->caps & AST_FAX_TECH_SEND) ? stats.pages_transferred : 0);
00719       ast_cli(fd, "%-22s : %d\n", "Rx Pages", (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_transferred : 0);
00720 #endif
00721       ast_cli(fd, "%-22s : %d\n", "Longest Bad Line Run", stats.longest_bad_row_run);
00722       ast_cli(fd, "%-22s : %d\n", "Total Bad Lines", stats.bad_rows);
00723    }
00724    ao2_unlock(s);
00725    ast_cli(fd, "\n\n");
00726    return CLI_SUCCESS;
00727 }

static char * spandsp_fax_cli_show_settings ( int  fd  )  [static]

Show res_fax_spandsp settings.

Definition at line 767 of file res_fax_spandsp.c.

References CLI_SUCCESS.

00768 {
00769    /* no settings at the moment */
00770    return CLI_SUCCESS;
00771 }

static char * spandsp_fax_cli_show_stats ( int  fd  )  [static]

Definition at line 730 of file res_fax_spandsp.c.

References ast_cli(), ast_mutex_lock, ast_mutex_unlock, CLI_SUCCESS, and spandsp_global_stats.

00731 {
00732    ast_mutex_lock(&spandsp_global_stats.lock);
00733    ast_cli(fd, "\n%-20.20s\n", "Spandsp G.711");
00734    ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.g711.success);
00735    ast_cli(fd, "%-20.20s : %d\n", "Switched to T.38", spandsp_global_stats.g711.switched);
00736    ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.g711.call_dropped);
00737    ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.g711.nofax);
00738    ast_cli(fd, "%-20.20s : %d\n", "Negotiation Failed", spandsp_global_stats.g711.neg_failed);
00739    ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.g711.failed_to_train);
00740    ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.g711.retries_exceeded);
00741    ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.g711.protocol_error);
00742    ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.g711.tx_protocol_error);
00743    ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.g711.rx_protocol_error);
00744    ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.g711.file_error);
00745    ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.g711.mem_error);
00746    ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.g711.unknown_error);
00747 
00748    ast_cli(fd, "\n%-20.20s\n", "Spandsp T.38");
00749    ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.t38.success);
00750    ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.t38.call_dropped);
00751    ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.t38.nofax);
00752    ast_cli(fd, "%-20.20s : %d\n", "Negotiation Failed", spandsp_global_stats.t38.neg_failed);
00753    ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.t38.failed_to_train);
00754    ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.t38.retries_exceeded);
00755    ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.t38.protocol_error);
00756    ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.t38.tx_protocol_error);
00757    ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.t38.rx_protocol_error);
00758    ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.t38.file_error);
00759    ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.t38.mem_error);
00760    ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.t38.unknown_error);
00761    ast_mutex_unlock(&spandsp_global_stats.lock);
00762 
00763    return CLI_SUCCESS;
00764 }

static void spandsp_fax_destroy ( struct ast_fax_session s  )  [static]

Destroy a spandsp fax session.

Definition at line 499 of file res_fax_spandsp.c.

References ast_free, ast_fax_session::fd, session_destroy(), and ast_fax_session::tech_pvt.

00500 {
00501    struct spandsp_pvt *p = s->tech_pvt;
00502 
00503    session_destroy(p);
00504    ast_free(p);
00505    s->tech_pvt = NULL;
00506    s->fd = -1;
00507 }

static void * spandsp_fax_new ( struct ast_fax_session s,
struct ast_fax_tech_token *  token 
) [static]

create an instance of the spandsp tech_pvt for a fax session

Definition at line 442 of file res_fax_spandsp.c.

References ast_calloc, AST_FAX_STATE_INITIALIZED, AST_FAX_TECH_AUDIO, AST_FAX_TECH_RECEIVE, AST_FAX_TECH_SEND, AST_FAX_TECH_T38, ast_free, AST_LIST_HEAD_INIT, ast_log(), ast_timer_fd(), ast_timer_open(), ast_fax_session_details::caps, ast_fax_session::channame, ast_fax_session::details, spandsp_pvt::fax_state, ast_fax_session::fd, ast_fax_session::id, spandsp_pvt::ist38, LOG_ERROR, spandsp_pvt::read_frames, set_logging(), spandsp_global_stats, ast_fax_session::state, spandsp_pvt::stats, spandsp_pvt::t38_state, t38_tx_packet_handler(), and spandsp_pvt::timer.

00443 {
00444    struct spandsp_pvt *p;
00445    int caller_mode;
00446 
00447    if ((!(p = ast_calloc(1, sizeof(*p))))) {
00448       ast_log(LOG_ERROR, "Cannot initialize the spandsp private FAX technology structure.\n");
00449       goto e_return;
00450    }
00451 
00452    AST_LIST_HEAD_INIT(&p->read_frames);
00453 
00454    if (s->details->caps & AST_FAX_TECH_RECEIVE) {
00455       caller_mode = 0;
00456    } else if (s->details->caps & AST_FAX_TECH_SEND) {
00457       caller_mode = 1;
00458    } else {
00459       ast_log(LOG_ERROR, "Are we sending or receiving? The FAX requirements (capabilities: 0x%X) were not properly set.\n", s->details->caps);
00460       goto e_free;
00461    }
00462 
00463    if (!(p->timer = ast_timer_open())) {
00464       ast_log(LOG_ERROR, "Channel '%s' FAX session '%u' failed to create timing source.\n", s->channame, s->id);
00465       goto e_free;
00466    }
00467 
00468    s->fd = ast_timer_fd(p->timer);
00469 
00470    p->stats = &spandsp_global_stats.g711;
00471 
00472    if (s->details->caps & (AST_FAX_TECH_T38 | AST_FAX_TECH_AUDIO)) {
00473       if ((s->details->caps & AST_FAX_TECH_AUDIO) == 0) {
00474          /* audio mode was not requested, start in T.38 mode */
00475          p->ist38 = 1;
00476          p->stats = &spandsp_global_stats.t38;
00477       }
00478 
00479       /* init t38 stuff */
00480       t38_terminal_init(&p->t38_state, caller_mode, t38_tx_packet_handler, p);
00481       set_logging(&p->t38_state.logging, s->details);
00482 
00483       /* init audio stuff */
00484       fax_init(&p->fax_state, caller_mode);
00485       set_logging(&p->fax_state.logging, s->details);
00486    }
00487 
00488    s->state = AST_FAX_STATE_INITIALIZED;
00489    return p;
00490 
00491 e_free:
00492    ast_free(p);
00493 e_return:
00494    return NULL;
00495 }

static struct ast_frame * spandsp_fax_read ( struct ast_fax_session s  )  [static, read]

Read a frame from the spandsp fax stack.

Definition at line 511 of file res_fax_spandsp.c.

References ast_debug, AST_FAX_STATE_COMPLETE, AST_FORMAT_SLINEAR, AST_FRAME_SET_BUFFER, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_frisolate(), AST_LIST_REMOVE_HEAD, ast_log(), ast_null_frame, ast_timer_ack(), f, spandsp_pvt::fax_state, ast_frame::frametype, ast_fax_session::id, spandsp_pvt::isdone, spandsp_pvt::ist38, LOG_ERROR, spandsp_pvt::read_frames, ast_frame::samples, SPANDSP_FAX_SAMPLES, ast_fax_session::state, spandsp_pvt::t38_state, ast_fax_session::tech_pvt, and spandsp_pvt::timer.

00512 {
00513    struct spandsp_pvt *p = s->tech_pvt;
00514    uint8_t buffer[AST_FRIENDLY_OFFSET + SPANDSP_FAX_SAMPLES * sizeof(uint16_t)];
00515    int16_t *buf = (int16_t *) (buffer + AST_FRIENDLY_OFFSET);
00516    int samples;
00517 
00518    struct ast_frame fax_frame = {
00519       .frametype = AST_FRAME_VOICE,
00520       .subclass.codec = AST_FORMAT_SLINEAR,
00521       .src = "res_fax_spandsp_g711",
00522    };
00523 
00524    struct ast_frame *f = &fax_frame;
00525 
00526    if (ast_timer_ack(p->timer, 1) < 0) {
00527       ast_log(LOG_ERROR, "Failed to acknowledge timer for FAX session '%u'\n", s->id);
00528       return NULL;
00529    }
00530 
00531    /* XXX do we need to lock here? */
00532    if (p->isdone) {
00533       s->state = AST_FAX_STATE_COMPLETE;
00534       ast_debug(5, "FAX session '%u' is complete.\n", s->id);
00535       return NULL;
00536    }
00537 
00538    if (p->ist38) {
00539       t38_terminal_send_timeout(&p->t38_state, SPANDSP_FAX_SAMPLES);
00540       if ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
00541          return f;
00542       }
00543    } else {
00544       if ((samples = fax_tx(&p->fax_state, buf, SPANDSP_FAX_SAMPLES)) > 0) {
00545          f->samples = samples;
00546          AST_FRAME_SET_BUFFER(f, buffer, AST_FRIENDLY_OFFSET, samples * sizeof(int16_t));
00547          return ast_frisolate(f);
00548       }
00549    }
00550 
00551    return &ast_null_frame;
00552 }

static int spandsp_fax_start ( struct ast_fax_session s  )  [static]

Definition at line 582 of file res_fax_spandsp.c.

References AST_FAX_STATE_ACTIVE, AST_FAX_STATE_OPEN, ast_log(), ast_timer_set_rate(), ast_fax_session::details, spandsp_pvt::fax_state, ast_fax_t38_parameters::fill_bit_removal, ast_fax_session::id, spandsp_pvt::ist38, LOG_ERROR, ast_fax_t38_parameters::max_ifp, set_ecm(), set_file(), set_local_info(), set_logging(), SPANDSP_FAX_TIMER_RATE, spandsp_modems(), ast_fax_session::state, t30_phase_e_handler(), spandsp_pvt::t30_state, spandsp_pvt::t38_core_state, spandsp_pvt::t38_state, ast_fax_session::tech_pvt, ast_fax_session_details::their_t38_parameters, spandsp_pvt::timer, ast_fax_t38_parameters::transcoding_jbig, ast_fax_t38_parameters::transcoding_mmr, and TRUE.

Referenced by spandsp_fax_switch_to_t38().

00583 {
00584    struct spandsp_pvt *p = s->tech_pvt;
00585 
00586    s->state = AST_FAX_STATE_OPEN;
00587 
00588    if (p->ist38) {
00589 #if SPANDSP_RELEASE_DATE >= 20080725
00590       /* for spandsp shaphots 0.0.6 and higher */
00591       p->t30_state = &p->t38_state.t30;
00592       p->t38_core_state = &p->t38_state.t38_fe.t38;
00593 #else
00594       /* for spandsp releases 0.0.5 */
00595       p->t30_state = &p->t38_state.t30_state;
00596       p->t38_core_state = &p->t38_state.t38;
00597 #endif
00598    } else {
00599 #if SPANDSP_RELEASE_DATE >= 20080725
00600       /* for spandsp shaphots 0.0.6 and higher */
00601       p->t30_state = &p->fax_state.t30;
00602 #else
00603       /* for spandsp release 0.0.5 */
00604       p->t30_state = &p->fax_state.t30_state;
00605 #endif
00606    }
00607 
00608    set_logging(&p->t30_state->logging, s->details);
00609 
00610    /* set some parameters */
00611    set_local_info(p->t30_state, s->details);
00612    set_file(p->t30_state, s->details);
00613    set_ecm(p->t30_state, s->details);
00614    t30_set_supported_modems(p->t30_state, spandsp_modems(s->details));
00615 
00616    /* perhaps set_transmit_on_idle() should be called */
00617 
00618    t30_set_phase_e_handler(p->t30_state, t30_phase_e_handler, s);
00619 
00620    /* set T.38 parameters */
00621    if (p->ist38) {
00622       set_logging(&p->t38_core_state->logging, s->details);
00623 
00624       t38_set_max_datagram_size(p->t38_core_state, s->details->their_t38_parameters.max_ifp);
00625 
00626       if (s->details->their_t38_parameters.fill_bit_removal) {
00627          t38_set_fill_bit_removal(p->t38_core_state, TRUE);
00628       }
00629 
00630       if (s->details->their_t38_parameters.transcoding_mmr) {
00631          t38_set_mmr_transcoding(p->t38_core_state, TRUE);
00632       }
00633 
00634       if (s->details->their_t38_parameters.transcoding_jbig) {
00635          t38_set_jbig_transcoding(p->t38_core_state, TRUE);
00636       }
00637    } else {
00638       /* have the fax stack generate silence if it has no data to send */
00639       fax_set_transmit_on_idle(&p->fax_state, 1);
00640    }
00641 
00642 
00643    /* start the timer */
00644    if (ast_timer_set_rate(p->timer, SPANDSP_FAX_TIMER_RATE)) {
00645       ast_log(LOG_ERROR, "FAX session '%u' error setting rate on timing source.\n", s->id);
00646       return -1;
00647    }
00648 
00649    s->state = AST_FAX_STATE_ACTIVE;
00650 
00651    return 0;
00652 }

static int spandsp_fax_switch_to_t38 ( struct ast_fax_session s  )  [static]

Definition at line 664 of file res_fax_spandsp.c.

References ast_atomic_fetchadd_int(), ast_fax_session::details, spandsp_pvt::ist38, ast_fax_session_details::option, spandsp_fax_start(), spandsp_global_stats, spandsp_pvt::stats, ast_fax_session_details::switch_to_t38, spandsp_fax_stats::switched, spandsp_pvt::t30_state, and ast_fax_session::tech_pvt.

00665 {
00666    struct spandsp_pvt *p = s->tech_pvt;
00667 
00668    /* prevent the phase E handler from running, this is not a real termination */
00669    t30_set_phase_e_handler(p->t30_state, NULL, NULL);
00670 
00671    t30_terminate(p->t30_state);
00672 
00673    s->details->option.switch_to_t38 = 1;
00674    ast_atomic_fetchadd_int(&p->stats->switched, 1);
00675 
00676    p->ist38 = 1;
00677    p->stats = &spandsp_global_stats.t38;
00678    spandsp_fax_start(s);
00679 
00680    return 0;
00681 }

static int spandsp_fax_write ( struct ast_fax_session s,
const struct ast_frame f 
) [static]

Write a frame to the spandsp fax stack.

Parameters:
s a fax session
f the frame to write
Note:
res_fax does not currently use the return value of this function. Also the fax_rx() function never fails.
Return values:
0 success
-1 failure

Definition at line 564 of file res_fax_spandsp.c.

References AST_FAX_STATE_COMPLETE, ast_fax_state_to_str(), ast_log(), ast_frame::data, ast_frame::datalen, spandsp_pvt::fax_state, ast_fax_session::id, spandsp_pvt::ist38, LOG_WARNING, ast_frame::ptr, ast_frame::samples, ast_frame::seqno, ast_fax_session::state, spandsp_pvt::t38_core_state, and ast_fax_session::tech_pvt.

00565 {
00566    struct spandsp_pvt *p = s->tech_pvt;
00567 
00568    /* XXX do we need to lock here? */
00569    if (s->state == AST_FAX_STATE_COMPLETE) {
00570       ast_log(LOG_WARNING, "FAX session '%u' is in the '%s' state.\n", s->id, ast_fax_state_to_str(s->state));
00571       return -1;
00572    }
00573 
00574    if (p->ist38) {
00575       return t38_core_rx_ifp_packet(p->t38_core_state, f->data.ptr, f->datalen, f->seqno);
00576    } else {
00577       return fax_rx(&p->fax_state, f->data.ptr, f->samples);
00578    }
00579 }

static void spandsp_log ( int  level,
const char *  msg 
) [static]

Send spandsp log messages to asterisk.

Parameters:
level the spandsp logging level
msg the log message
Note:
This function is a callback function called by spandsp.

Definition at line 364 of file res_fax_spandsp.c.

References ast_fax_log(), ast_log(), LOG_DEBUG, LOG_ERROR, and LOG_WARNING.

Referenced by set_logging().

00365 {
00366    if (level == SPAN_LOG_ERROR) {
00367       ast_log(LOG_ERROR, "%s", msg);
00368    } else if (level == SPAN_LOG_WARNING) {
00369       ast_log(LOG_WARNING, "%s", msg);
00370    } else {
00371       ast_fax_log(LOG_DEBUG, msg);
00372    }
00373 }

static int spandsp_modems ( struct ast_fax_session_details details  )  [static]

Definition at line 416 of file res_fax_spandsp.c.

References AST_FAX_MODEM_V17, AST_FAX_MODEM_V27, AST_FAX_MODEM_V29, AST_FAX_MODEM_V34, ast_log(), LOG_WARNING, and ast_fax_session_details::modems.

Referenced by spandsp_fax_start().

00417 {
00418    int modems = 0;
00419    if (AST_FAX_MODEM_V17 & details->modems) {
00420       modems |= T30_SUPPORT_V17;
00421    }
00422    if (AST_FAX_MODEM_V27 & details->modems) {
00423       modems |= T30_SUPPORT_V27TER;
00424    }
00425    if (AST_FAX_MODEM_V29 & details->modems) {
00426       modems |= T30_SUPPORT_V29;
00427    }
00428    if (AST_FAX_MODEM_V34 & details->modems) {
00429 #if defined(T30_SUPPORT_V34)
00430       modems |= T30_SUPPORT_V34;
00431 #elif defined(T30_SUPPORT_V34HDX)
00432       modems |= T30_SUPPORT_V34HDX;
00433 #else
00434       ast_log(LOG_WARNING, "v34 not supported in this version of spandsp\n");
00435 #endif
00436    }
00437 
00438    return modems;
00439 }

static void t30_phase_e_handler ( t30_state_t *  t30_state,
void *  data,
int  completion_code 
) [static]

Phase E handler callback.

Parameters:
t30_state the span t30 state
data this will be the ast_fax_session
completion_code the result of the fax session

This function pulls stats from the spandsp stack and stores them for res_fax to use later.

Definition at line 309 of file res_fax_spandsp.c.

References ast_debug, AST_FAX_TECH_RECEIVE, ast_string_field_build, ast_string_field_set, ast_fax_session_details::caps, ast_fax_session::details, ast_fax_session::id, spandsp_pvt::isdone, ast_fax_session_details::pages_transferred, spandsp_pvt::stats, ast_fax_session::tech_pvt, and update_stats().

Referenced by spandsp_fax_start().

00310 {
00311    struct ast_fax_session *s = data;
00312    struct spandsp_pvt *p = s->tech_pvt;
00313    char headerinfo[T30_MAX_PAGE_HEADER_INFO + 1];
00314    const char *c;
00315    t30_stats_t stats;
00316 
00317    ast_debug(5, "FAX session '%u' entering phase E\n", s->id);
00318 
00319    p->isdone = 1;
00320 
00321    update_stats(p, completion_code);
00322 
00323    t30_get_transfer_statistics(t30_state, &stats);
00324 
00325    if (completion_code == T30_ERR_OK) {
00326       ast_string_field_set(s->details, result, "SUCCESS");
00327    } else {
00328       ast_string_field_set(s->details, result, "FAILED");
00329       ast_string_field_set(s->details, error, t30_completion_code_to_str(completion_code));
00330    }
00331 
00332    ast_string_field_set(s->details, resultstr, t30_completion_code_to_str(completion_code));
00333 
00334    ast_debug(5, "FAX session '%u' completed with result: %s (%s)\n", s->id, s->details->result, s->details->resultstr);
00335 
00336    if ((c = t30_get_tx_ident(t30_state))) {
00337       ast_string_field_set(s->details, localstationid, c);
00338    }
00339 
00340    if ((c = t30_get_rx_ident(t30_state))) {
00341       ast_string_field_set(s->details, remotestationid, c);
00342    }
00343 
00344 #if SPANDSP_RELEASE_DATE >= 20090220
00345    s->details->pages_transferred = (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx;
00346 #else
00347    s->details->pages_transferred = stats.pages_transferred;
00348 #endif
00349 
00350    ast_string_field_build(s->details, transfer_rate, "%d", stats.bit_rate);
00351 
00352    ast_string_field_build(s->details, resolution, "%dx%d", stats.x_resolution, stats.y_resolution);
00353 
00354    t30_get_tx_page_header_info(t30_state, headerinfo);
00355    ast_string_field_set(s->details, headerinfo, headerinfo);
00356 }

static int t38_tx_packet_handler ( t38_core_state_t *  t38_core_state,
void *  data,
const uint8_t *  buf,
int  len,
int  count 
) [static]

Definition at line 161 of file res_fax_spandsp.c.

References AST_FRAME_MODEM, AST_FRAME_SET_BUFFER, ast_frisolate(), AST_LIST_INSERT_TAIL, AST_MODEM_T38, f, ast_frame::frametype, and spandsp_pvt::read_frames.

Referenced by spandsp_fax_new().

00162 {
00163    struct spandsp_pvt *p = data;
00164    struct ast_frame fax_frame = {
00165       .frametype = AST_FRAME_MODEM,
00166       .subclass.integer = AST_MODEM_T38,
00167       .src = "res_fax_spandsp_t38",
00168    };
00169 
00170    struct ast_frame *f = &fax_frame;
00171 
00172 
00173    /* TODO: Asterisk does not provide means of resending the same packet multiple
00174      times so count is ignored at the moment */
00175 
00176    AST_FRAME_SET_BUFFER(f, buf, 0, len);
00177 
00178    if (!(f = ast_frisolate(f))) {
00179       return -1;
00180    }
00181 
00182    /* no need to lock, this all runs in the same thread */
00183    AST_LIST_INSERT_TAIL(&p->read_frames, f, frame_list);
00184 
00185    return 0;
00186 }

static int unload_module ( void   )  [static]
static int update_stats ( struct spandsp_pvt p,
int  completion_code 
) [static]

The CED tone exceeded 5s

Timed out waiting for initial communication

Timed out waiting for the first message

Timed out waiting for procedural interrupt

The HDLC carrier did not stop in a timely manner

Failed to train with any of the compatible modems

Operator intervention failed

Far end is not compatible

Far end is not able to receive

Far end is not able to transmit

Far end cannot receive at the resolution of the image

Far end cannot receive at the size of image

Unexpected message received

Received bad response to DCS or training

Received a DCN from remote after sending a page

Invalid ECM response received from receiver

Received a DCN while waiting for a DIS

Invalid response after sending a page

Received other than DIS while waiting for DIS

Received no response to DCS, training or TCF

No response after sending a page

Timed out waiting for receiver ready (ECM mode)

Invalid ECM response received from transmitter

DCS received while waiting for DTC

Unexpected command after page received

Carrier lost during fax receive

Timed out while waiting for EOL (end Of line)

Timed out while waiting for first line

Timer T2 expired while waiting for DCN

Timer T2 expired while waiting for phase D

Timer T2 expired while waiting for fax page

Timer T2 expired while waiting for next fax page

Timer T2 expired while waiting for RR command

Timer T2 expired while waiting for NSS, DCS or MCF

Unexpected DCN while waiting for DCS or DIS

Unexpected DCN while waiting for image data

Unexpected DCN while waiting for EOM, EOP or MPS

Unexpected DCN after EOM or MPS sequence

Unexpected DCN after RR/RNR sequence

Unexpected DCN after requested retransmission

TIFF/F file cannot be opened

TIFF/F page not found

TIFF/F format is not compatible

TIFF/F page number tag missing

Incorrect values for TIFF/F tags

Bad TIFF/F header - incorrect values in fields

Cannot allocate memory for more pages

Disconnected after permitted retries

The call dropped prematurely

Poll not accepted

Far end's ident is not acceptable

Far end's sub-address is not acceptable

Far end's selective polling address is not acceptable

Far end's polled sub-address is not acceptable

Far end's sender identification is not acceptable

Far end's password is not acceptable

Far end's transmitting subscriber internet address is not acceptable

Far end's internet routing address is not acceptable

Far end's calling subscriber internet address is not acceptable

Far end's internet selective polling address is not acceptable

Far end's called subscriber internet address is not acceptable

Definition at line 188 of file res_fax_spandsp.c.

References ast_atomic_fetchadd_int(), ast_log(), spandsp_fax_stats::call_dropped, spandsp_fax_stats::failed_to_train, spandsp_fax_stats::file_error, LOG_WARNING, spandsp_fax_stats::mem_error, spandsp_fax_stats::neg_failed, spandsp_fax_stats::nofax, spandsp_fax_stats::protocol_error, spandsp_fax_stats::retries_exceeded, spandsp_fax_stats::rx_protocol_error, spandsp_pvt::stats, spandsp_fax_stats::success, spandsp_fax_stats::tx_protocol_error, and spandsp_fax_stats::unknown_error.

Referenced by t30_phase_e_handler().

00189 {
00190    switch (completion_code) {
00191    case T30_ERR_OK:
00192       ast_atomic_fetchadd_int(&p->stats->success, 1);
00193       break;
00194 
00195    /* Link problems */
00196    case T30_ERR_CEDTONE:            /*! The CED tone exceeded 5s */
00197    case T30_ERR_T0_EXPIRED:         /*! Timed out waiting for initial communication */
00198    case T30_ERR_T1_EXPIRED:         /*! Timed out waiting for the first message */
00199    case T30_ERR_T3_EXPIRED:         /*! Timed out waiting for procedural interrupt */
00200    case T30_ERR_HDLC_CARRIER:       /*! The HDLC carrier did not stop in a timely manner */
00201    case T30_ERR_CANNOT_TRAIN:       /*! Failed to train with any of the compatible modems */
00202       ast_atomic_fetchadd_int(&p->stats->failed_to_train, 1);
00203       break;
00204 
00205    case T30_ERR_OPER_INT_FAIL:      /*! Operator intervention failed */
00206    case T30_ERR_INCOMPATIBLE:       /*! Far end is not compatible */
00207    case T30_ERR_RX_INCAPABLE:       /*! Far end is not able to receive */
00208    case T30_ERR_TX_INCAPABLE:       /*! Far end is not able to transmit */
00209    case T30_ERR_NORESSUPPORT:       /*! Far end cannot receive at the resolution of the image */
00210    case T30_ERR_NOSIZESUPPORT:      /*! Far end cannot receive at the size of image */
00211       ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
00212       break;
00213 
00214    case T30_ERR_UNEXPECTED:         /*! Unexpected message received */
00215       ast_atomic_fetchadd_int(&p->stats->protocol_error, 1);
00216       break;
00217 
00218    /* Phase E status values returned to a transmitter */
00219    case T30_ERR_TX_BADDCS:          /*! Received bad response to DCS or training */
00220    case T30_ERR_TX_BADPG:           /*! Received a DCN from remote after sending a page */
00221    case T30_ERR_TX_ECMPHD:          /*! Invalid ECM response received from receiver */
00222    case T30_ERR_TX_GOTDCN:          /*! Received a DCN while waiting for a DIS */
00223    case T30_ERR_TX_INVALRSP:        /*! Invalid response after sending a page */
00224    case T30_ERR_TX_NODIS:           /*! Received other than DIS while waiting for DIS */
00225    case T30_ERR_TX_PHBDEAD:         /*! Received no response to DCS, training or TCF */
00226    case T30_ERR_TX_PHDDEAD:         /*! No response after sending a page */
00227    case T30_ERR_TX_T5EXP:           /*! Timed out waiting for receiver ready (ECM mode) */
00228       ast_atomic_fetchadd_int(&p->stats->tx_protocol_error, 1);
00229       break;
00230 
00231    /* Phase E status values returned to a receiver */
00232    case T30_ERR_RX_ECMPHD:          /*! Invalid ECM response received from transmitter */
00233    case T30_ERR_RX_GOTDCS:          /*! DCS received while waiting for DTC */
00234    case T30_ERR_RX_INVALCMD:        /*! Unexpected command after page received */
00235    case T30_ERR_RX_NOCARRIER:       /*! Carrier lost during fax receive */
00236    case T30_ERR_RX_NOEOL:           /*! Timed out while waiting for EOL (end Of line) */
00237       ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
00238       break;
00239    case T30_ERR_RX_NOFAX:           /*! Timed out while waiting for first line */
00240       ast_atomic_fetchadd_int(&p->stats->nofax, 1);
00241       break;
00242    case T30_ERR_RX_T2EXPDCN:        /*! Timer T2 expired while waiting for DCN */
00243    case T30_ERR_RX_T2EXPD:          /*! Timer T2 expired while waiting for phase D */
00244    case T30_ERR_RX_T2EXPFAX:        /*! Timer T2 expired while waiting for fax page */
00245    case T30_ERR_RX_T2EXPMPS:        /*! Timer T2 expired while waiting for next fax page */
00246    case T30_ERR_RX_T2EXPRR:         /*! Timer T2 expired while waiting for RR command */
00247    case T30_ERR_RX_T2EXP:           /*! Timer T2 expired while waiting for NSS, DCS or MCF */
00248    case T30_ERR_RX_DCNWHY:          /*! Unexpected DCN while waiting for DCS or DIS */
00249    case T30_ERR_RX_DCNDATA:         /*! Unexpected DCN while waiting for image data */
00250    case T30_ERR_RX_DCNFAX:          /*! Unexpected DCN while waiting for EOM, EOP or MPS */
00251    case T30_ERR_RX_DCNPHD:          /*! Unexpected DCN after EOM or MPS sequence */
00252    case T30_ERR_RX_DCNRRD:          /*! Unexpected DCN after RR/RNR sequence */
00253    case T30_ERR_RX_DCNNORTN:        /*! Unexpected DCN after requested retransmission */
00254       ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
00255       break;
00256 
00257    /* TIFF file problems */
00258    case T30_ERR_FILEERROR:          /*! TIFF/F file cannot be opened */
00259    case T30_ERR_NOPAGE:             /*! TIFF/F page not found */
00260    case T30_ERR_BADTIFF:            /*! TIFF/F format is not compatible */
00261    case T30_ERR_BADPAGE:            /*! TIFF/F page number tag missing */
00262    case T30_ERR_BADTAG:             /*! Incorrect values for TIFF/F tags */
00263    case T30_ERR_BADTIFFHDR:         /*! Bad TIFF/F header - incorrect values in fields */
00264       ast_atomic_fetchadd_int(&p->stats->file_error, 1);
00265       break;
00266    case T30_ERR_NOMEM:              /*! Cannot allocate memory for more pages */
00267       ast_atomic_fetchadd_int(&p->stats->mem_error, 1);
00268       break;
00269 
00270    /* General problems */
00271    case T30_ERR_RETRYDCN:           /*! Disconnected after permitted retries */
00272       ast_atomic_fetchadd_int(&p->stats->retries_exceeded, 1);
00273       break;
00274    case T30_ERR_CALLDROPPED:        /*! The call dropped prematurely */
00275       ast_atomic_fetchadd_int(&p->stats->call_dropped, 1);
00276       break;
00277 
00278    /* Feature negotiation issues */
00279    case T30_ERR_NOPOLL:             /*! Poll not accepted */
00280    case T30_ERR_IDENT_UNACCEPTABLE: /*! Far end's ident is not acceptable */
00281    case T30_ERR_SUB_UNACCEPTABLE:   /*! Far end's sub-address is not acceptable */
00282    case T30_ERR_SEP_UNACCEPTABLE:   /*! Far end's selective polling address is not acceptable */
00283    case T30_ERR_PSA_UNACCEPTABLE:   /*! Far end's polled sub-address is not acceptable */
00284    case T30_ERR_SID_UNACCEPTABLE:   /*! Far end's sender identification is not acceptable */
00285    case T30_ERR_PWD_UNACCEPTABLE:   /*! Far end's password is not acceptable */
00286    case T30_ERR_TSA_UNACCEPTABLE:   /*! Far end's transmitting subscriber internet address is not acceptable */
00287    case T30_ERR_IRA_UNACCEPTABLE:   /*! Far end's internet routing address is not acceptable */
00288    case T30_ERR_CIA_UNACCEPTABLE:   /*! Far end's calling subscriber internet address is not acceptable */
00289    case T30_ERR_ISP_UNACCEPTABLE:   /*! Far end's internet selective polling address is not acceptable */
00290    case T30_ERR_CSA_UNACCEPTABLE:   /*! Far end's called subscriber internet address is not acceptable */
00291       ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
00292       break;
00293    default:
00294       ast_atomic_fetchadd_int(&p->stats->unknown_error, 1);
00295       ast_log(LOG_WARNING, "unknown FAX session result '%d' (%s)\n", completion_code, t30_completion_code_to_str(completion_code));
00296       return -1;
00297    }
00298    return 0;
00299 }


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Spandsp G.711 and T.38 FAX Technologies" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, } [static]

Definition at line 801 of file res_fax_spandsp.c.

Definition at line 801 of file res_fax_spandsp.c.

Definition at line 111 of file res_fax_spandsp.c.

Definition at line 110 of file res_fax_spandsp.c.

struct ast_fax_tech spandsp_fax_tech [static]

Definition at line 67 of file res_fax_spandsp.c.

struct { ... } spandsp_global_stats [static]

Definition at line 112 of file res_fax_spandsp.c.

Referenced by transmit_t38().


Generated on 27 Jan 2016 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1