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"

Include dependency graph for res_fax_spandsp.c:

Go to the source code of this file.

Data Structures
struct	spandsp_pvt::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_frame *	spandsp_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 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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, }
static struct ast_module_info *	ast_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 773 of file res_fax_spandsp.c.

static void __unreg_module ( void ) [static]

Definition at line 773 of file res_fax_spandsp.c.

static int load_module ( void ) [static]

load res_fax_spandsp

Definition at line 754 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, ast_module_info::self, and spandsp_global_stats.

{
   ast_mutex_init(&spandsp_global_stats.lock);
   spandsp_fax_tech.module = ast_module_info->self;
   if (ast_fax_tech_register(&spandsp_fax_tech) < 0) {
      ast_log(LOG_ERROR, "failed to register FAX technology\n");
      return AST_MODULE_LOAD_DECLINE;
   }

   /* prevent logging to stderr */
   span_set_message_handler(NULL);

   return AST_MODULE_LOAD_SUCCESS;
}

static void session_destroy ( struct spandsp_pvt * p ) [static]

Definition at line 140 of file res_fax_spandsp.c.

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

Referenced by spandsp_fax_destroy().

{
   struct ast_frame *f;

   t30_terminate(p->t30_state);
   p->isdone = 1;

   ast_timer_close(p->timer);

   fax_release(&p->fax_state);
   t38_terminal_release(&p->t38_state);

   while ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
      ast_frfree(f);
   }
}

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

Definition at line 409 of file res_fax_spandsp.c.

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

Referenced by spandsp_fax_start().

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

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

Definition at line 397 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().

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

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

Definition at line 386 of file res_fax_spandsp.c.

References ast_strlen_zero(), ast_fax_session_details::headerinfo, and ast_fax_session_details::localstationid.

Referenced by spandsp_fax_start().

{
   if (!ast_strlen_zero(details->localstationid)) {
      t30_set_tx_ident(t30_state, details->localstationid);
   }

   if (!ast_strlen_zero(details->headerinfo)) {
      t30_set_tx_page_header_info(t30_state, details->headerinfo);
   }
}

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

Definition at line 374 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().

{
   int level = SPAN_LOG_WARNING;

        if (details->option.debug) {
      level = SPAN_LOG_DEBUG_3;
   }

   span_log_set_message_handler(state, spandsp_log);
   span_log_set_level(state, SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | level);
}

static int spandsp_fax_cancel ( struct ast_fax_session * s ) [static]

Definition at line 627 of file res_fax_spandsp.c.

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

{
   struct spandsp_pvt *p = s->tech_pvt;
   t30_terminate(p->t30_state);
   p->isdone = 1;
   return 0;
}

static char * spandsp_fax_cli_show_capabilities ( int fd ) [static]

Definition at line 656 of file res_fax_spandsp.c.

References ast_cli(), and CLI_SUCCESS.

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

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

Definition at line 663 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.

{
   struct spandsp_pvt *p = s->tech_pvt;
   t30_stats_t stats;

   ao2_lock(s);
   ast_cli(fd, "%-22s : %d\n", "session", s->id);
   ast_cli(fd, "%-22s : %s\n", "operation", (s->details->caps & AST_FAX_TECH_RECEIVE) ? "Receive" : "Transmit");
   ast_cli(fd, "%-22s : %s\n", "state", ast_fax_state_to_str(s->state));
   if (s->state != AST_FAX_STATE_UNINITIALIZED) {
      t30_get_transfer_statistics(p->t30_state, &stats);
      ast_cli(fd, "%-22s : %s\n", "Last Status", t30_completion_code_to_str(stats.current_status));
      ast_cli(fd, "%-22s : %s\n", "ECM Mode", stats.error_correcting_mode ? "Yes" : "No");
      ast_cli(fd, "%-22s : %d\n", "Data Rate", stats.bit_rate);
      ast_cli(fd, "%-22s : %dx%d\n", "Image Resolution", stats.x_resolution, stats.y_resolution);
#if SPANDSP_RELEASE_DATE >= 20090220
      ast_cli(fd, "%-22s : %d\n", "Page Number", ((s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx) + 1);
#else
      ast_cli(fd, "%-22s : %d\n", "Page Number", stats.pages_transferred + 1);
#endif
      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);

      ast_cli(fd, "\nData Statistics:\n");
#if SPANDSP_RELEASE_DATE >= 20090220
      ast_cli(fd, "%-22s : %d\n", "Tx Pages", stats.pages_tx);
      ast_cli(fd, "%-22s : %d\n", "Rx Pages", stats.pages_rx);
#else
      ast_cli(fd, "%-22s : %d\n", "Tx Pages", (s->details->caps & AST_FAX_TECH_SEND) ? stats.pages_transferred : 0);
      ast_cli(fd, "%-22s : %d\n", "Rx Pages", (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_transferred : 0);
#endif
      ast_cli(fd, "%-22s : %d\n", "Longest Bad Line Run", stats.longest_bad_row_run);
      ast_cli(fd, "%-22s : %d\n", "Total Bad Lines", stats.bad_rows);
   }
   ao2_unlock(s);
   ast_cli(fd, "\n\n");
   return CLI_SUCCESS;
}

static char * spandsp_fax_cli_show_settings ( int fd ) [static]

Show res_fax_spandsp settings.

Definition at line 739 of file res_fax_spandsp.c.

References CLI_SUCCESS.

{
   /* no settings at the moment */
   return CLI_SUCCESS;
}

static char * spandsp_fax_cli_show_stats ( int fd ) [static]

Definition at line 702 of file res_fax_spandsp.c.

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

{
   ast_mutex_lock(&spandsp_global_stats.lock);
   ast_cli(fd, "\n%-20.20s\n", "Spandsp G.711");
   ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.g711.success);
   ast_cli(fd, "%-20.20s : %d\n", "Switched to T.38", spandsp_global_stats.g711.switched);
   ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.g711.call_dropped);
   ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.g711.nofax);
   ast_cli(fd, "%-20.20s : %d\n", "Negotiation Failed", spandsp_global_stats.g711.neg_failed);
   ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.g711.failed_to_train);
   ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.g711.retries_exceeded);
   ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.g711.protocol_error);
   ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.g711.tx_protocol_error);
   ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.g711.rx_protocol_error);
   ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.g711.file_error);
   ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.g711.mem_error);
   ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.g711.unknown_error);

   ast_cli(fd, "\n%-20.20s\n", "Spandsp T.38");
   ast_cli(fd, "%-20.20s : %d\n", "Success", spandsp_global_stats.t38.success);
   ast_cli(fd, "%-20.20s : %d\n", "Call Dropped", spandsp_global_stats.t38.call_dropped);
   ast_cli(fd, "%-20.20s : %d\n", "No FAX", spandsp_global_stats.t38.nofax);
   ast_cli(fd, "%-20.20s : %d\n", "Negotiation Failed", spandsp_global_stats.t38.neg_failed);
   ast_cli(fd, "%-20.20s : %d\n", "Train Failure", spandsp_global_stats.t38.failed_to_train);
   ast_cli(fd, "%-20.20s : %d\n", "Retries Exceeded", spandsp_global_stats.t38.retries_exceeded);
   ast_cli(fd, "%-20.20s : %d\n", "Protocol Error", spandsp_global_stats.t38.protocol_error);
   ast_cli(fd, "%-20.20s : %d\n", "TX Protocol Error", spandsp_global_stats.t38.tx_protocol_error);
   ast_cli(fd, "%-20.20s : %d\n", "RX Protocol Error", spandsp_global_stats.t38.rx_protocol_error);
   ast_cli(fd, "%-20.20s : %d\n", "File Error", spandsp_global_stats.t38.file_error);
   ast_cli(fd, "%-20.20s : %d\n", "Memory Error", spandsp_global_stats.t38.mem_error);
   ast_cli(fd, "%-20.20s : %d\n", "Unknown Error", spandsp_global_stats.t38.unknown_error);
   ast_mutex_unlock(&spandsp_global_stats.lock);

   return CLI_SUCCESS;
}

static void spandsp_fax_destroy ( struct ast_fax_session * s ) [static]

Destroy a spandsp fax session.

Definition at line 475 of file res_fax_spandsp.c.

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

{
   struct spandsp_pvt *p = s->tech_pvt;

   session_destroy(p);
   ast_free(p);
   s->tech_pvt = NULL;
   s->fd = -1;
}

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 416 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.

{
   struct spandsp_pvt *p;
   int caller_mode;

   if ((!(p = ast_calloc(1, sizeof(*p))))) {
      ast_log(LOG_ERROR, "Cannot initialize the spandsp private FAX technology structure.\n");
      goto e_return;
   }

   AST_LIST_HEAD_INIT(&p->read_frames);

   if (s->details->caps & AST_FAX_TECH_RECEIVE) {
      caller_mode = 0;
   } else if (s->details->caps & AST_FAX_TECH_SEND) {
      caller_mode = 1;
   } else {
      ast_log(LOG_ERROR, "Are we sending or receiving? The FAX requirements (capabilities: 0x%X) were not properly set.\n", s->details->caps);
      goto e_free;
   }

   if (!(p->timer = ast_timer_open())) {
      ast_log(LOG_ERROR, "Channel '%s' FAX session '%d' failed to create timing source.\n", s->channame, s->id);
      goto e_free;
   }

   s->fd = ast_timer_fd(p->timer);

   p->stats = &spandsp_global_stats.g711;

   if (s->details->caps & AST_FAX_TECH_T38) {
      if ((s->details->caps & AST_FAX_TECH_AUDIO) == 0) {
         /* audio mode was not requested, start in T.38 mode */
         p->ist38 = 1;
         p->stats = &spandsp_global_stats.t38;
      }

      /* init t38 stuff */
      t38_terminal_init(&p->t38_state, caller_mode, t38_tx_packet_handler, p);
      set_logging(&p->t38_state.logging, s->details);
   }

   if (s->details->caps & AST_FAX_TECH_AUDIO) {
      /* init audio stuff */
      fax_init(&p->fax_state, caller_mode);
      set_logging(&p->fax_state.logging, s->details);
   }

   s->state = AST_FAX_STATE_INITIALIZED;
   return p;

e_free:
   ast_free(p);
e_return:
   return NULL;
}

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 487 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_null_frame, ast_timer_ack(), f, spandsp_pvt::fax_state, ast_frame::frametype, ast_fax_session::id, spandsp_pvt::isdone, spandsp_pvt::ist38, 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.

{
   struct spandsp_pvt *p = s->tech_pvt;
   uint8_t buffer[AST_FRIENDLY_OFFSET + SPANDSP_FAX_SAMPLES * sizeof(uint16_t)];
   int16_t *buf = (int16_t *) (buffer + AST_FRIENDLY_OFFSET);
   int samples;

   struct ast_frame fax_frame = {
      .frametype = AST_FRAME_VOICE,
      .subclass.codec = AST_FORMAT_SLINEAR,
      .src = "res_fax_spandsp_g711",
   };

   struct ast_frame *f = &fax_frame;

   ast_timer_ack(p->timer, 1);

   /* XXX do we need to lock here? */
   if (p->isdone) {
      s->state = AST_FAX_STATE_COMPLETE;
      ast_debug(5, "FAX session '%d' is complete.\n", s->id);
      return NULL;
   }

   if (p->ist38) {
      t38_terminal_send_timeout(&p->t38_state, SPANDSP_FAX_SAMPLES);
      if ((f = AST_LIST_REMOVE_HEAD(&p->read_frames, frame_list))) {
         return f;
      }
   } else {
      if ((samples = fax_tx(&p->fax_state, buf, SPANDSP_FAX_SAMPLES)) > 0) {
         f->samples = samples;
         AST_FRAME_SET_BUFFER(f, buffer, AST_FRIENDLY_OFFSET, samples * sizeof(int16_t));
         return ast_frisolate(f);
      }
   }

   return &ast_null_frame;
}

static int spandsp_fax_start ( struct ast_fax_session * s ) [static]

Definition at line 555 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, 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().

{
   struct spandsp_pvt *p = s->tech_pvt;

   s->state = AST_FAX_STATE_OPEN;

   if (p->ist38) {
#if SPANDSP_RELEASE_DATE >= 20080725
      /* for spandsp shaphots 0.0.6 and higher */
      p->t30_state = &p->t38_state.t30;
      p->t38_core_state = &p->t38_state.t38_fe.t38;
#else
      /* for spandsp releases 0.0.5 */
      p->t30_state = &p->t38_state.t30_state;
      p->t38_core_state = &p->t38_state.t38;
#endif
   } else {
#if SPANDSP_RELEASE_DATE >= 20080725
      /* for spandsp shaphots 0.0.6 and higher */
      p->t30_state = &p->fax_state.t30;
#else
      /* for spandsp release 0.0.5 */
      p->t30_state = &p->fax_state.t30_state;
#endif
   }

   set_logging(&p->t30_state->logging, s->details);

   /* set some parameters */
   set_local_info(p->t30_state, s->details);
   set_file(p->t30_state, s->details);
   set_ecm(p->t30_state, s->details);

   /* perhaps set_transmit_on_idle() should be called */

   t30_set_phase_e_handler(p->t30_state, t30_phase_e_handler, s);

   /* set T.38 parameters */
   if (p->ist38) {
      set_logging(&p->t38_core_state->logging, s->details);

      t38_set_max_datagram_size(p->t38_core_state, s->details->their_t38_parameters.max_ifp);

      if (s->details->their_t38_parameters.fill_bit_removal) {
         t38_set_fill_bit_removal(p->t38_core_state, TRUE);
      }

      if (s->details->their_t38_parameters.transcoding_mmr) {
         t38_set_mmr_transcoding(p->t38_core_state, TRUE);
      }

      if (s->details->their_t38_parameters.transcoding_jbig) {
         t38_set_jbig_transcoding(p->t38_core_state, TRUE);
      }
   } else {
      /* have the fax stack generate silence if it has no data to send */
      fax_set_transmit_on_idle(&p->fax_state, 1);
   }


   /* start the timer */
   if (ast_timer_set_rate(p->timer, SPANDSP_FAX_TIMER_RATE)) {
      ast_log(LOG_ERROR, "FAX session '%d' error setting rate on timing source.\n", s->id);
      return -1;
   }

   s->state = AST_FAX_STATE_ACTIVE;

   return 0;
}

static int spandsp_fax_switch_to_t38 ( struct ast_fax_session * s ) [static]

Definition at line 636 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.

{
   struct spandsp_pvt *p = s->tech_pvt;

   /* prevent the phase E handler from running, this is not a real termination */
   t30_set_phase_e_handler(p->t30_state, NULL, NULL);

   t30_terminate(p->t30_state);

   s->details->option.switch_to_t38 = 1;
   ast_atomic_fetchadd_int(&p->stats->switched, 1);

   p->ist38 = 1;
   p->stats = &spandsp_global_stats.t38;
   spandsp_fax_start(s);

   return 0;
}

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 537 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.

{
   struct spandsp_pvt *p = s->tech_pvt;

   /* XXX do we need to lock here? */
   if (s->state == AST_FAX_STATE_COMPLETE) {
      ast_log(LOG_WARNING, "FAX session '%d' is in the '%s' state.\n", s->id, ast_fax_state_to_str(s->state));
      return -1;
   }

   if (p->ist38) {
      return t38_core_rx_ifp_packet(p->t38_core_state, f->data.ptr, f->datalen, f->seqno);
   } else {
      return fax_rx(&p->fax_state, f->data.ptr, f->samples);
   }
}

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 363 of file res_fax_spandsp.c.

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

Referenced by set_logging().

{
   if (level == SPAN_LOG_ERROR) {
      ast_log(LOG_ERROR, "%s", msg);
   } else if (level == SPAN_LOG_WARNING) {
      ast_log(LOG_WARNING, "%s", msg);
   } else {
      ast_fax_log(LOG_DEBUG, msg);
   }
}

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 308 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, ast_fax_session_details::result, ast_fax_session_details::resultstr, spandsp_pvt::stats, ast_fax_session::tech_pvt, and update_stats().

Referenced by spandsp_fax_start().

{
   struct ast_fax_session *s = data;
   struct spandsp_pvt *p = s->tech_pvt;
   char headerinfo[T30_MAX_PAGE_HEADER_INFO + 1];
   const char *c;
   t30_stats_t stats;

   ast_debug(5, "FAX session '%d' entering phase E\n", s->id);

   p->isdone = 1;

   update_stats(p, completion_code);

   t30_get_transfer_statistics(t30_state, &stats);

   if (completion_code == T30_ERR_OK) {
      ast_string_field_set(s->details, result, "SUCCESS");
   } else {
      ast_string_field_set(s->details, result, "FAILED");
      ast_string_field_set(s->details, error, t30_completion_code_to_str(completion_code));
   }

   ast_string_field_set(s->details, resultstr, t30_completion_code_to_str(completion_code));

   ast_debug(5, "FAX session '%d' completed with result: %s (%s)\n", s->id, s->details->result, s->details->resultstr);

   if ((c = t30_get_tx_ident(t30_state))) {
      ast_string_field_set(s->details, localstationid, c);
   }

   if ((c = t30_get_rx_ident(t30_state))) {
      ast_string_field_set(s->details, remotestationid, c);
   }

#if SPANDSP_RELEASE_DATE >= 20090220
   s->details->pages_transferred = (s->details->caps & AST_FAX_TECH_RECEIVE) ? stats.pages_rx : stats.pages_tx;
#else
   s->details->pages_transferred = stats.pages_transferred;
#endif

   ast_string_field_build(s->details, transfer_rate, "%d", stats.bit_rate);

   ast_string_field_build(s->details, resolution, "%dx%d", stats.x_resolution, stats.y_resolution);

   t30_get_tx_page_header_info(t30_state, headerinfo);
   ast_string_field_set(s->details, headerinfo, headerinfo);
}

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 160 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().

{
   struct spandsp_pvt *p = data;
   struct ast_frame fax_frame = {
      .frametype = AST_FRAME_MODEM,
      .subclass.integer = AST_MODEM_T38,
      .src = "res_fax_spandsp_t38",
   };

   struct ast_frame *f = &fax_frame;


   /* TODO: Asterisk does not provide means of resending the same packet multiple
     times so count is ignored at the moment */

   AST_FRAME_SET_BUFFER(f, buf, 0, len);

   if (!(f = ast_frisolate(f))) {
      return -1;
   }

   /* no need to lock, this all runs in the same thread */
   AST_LIST_INSERT_TAIL(&p->read_frames, f, frame_list);

   return 0;
}

static int unload_module ( void ) [static]

unload res_fax_spandsp

Definition at line 746 of file res_fax_spandsp.c.

References ast_fax_tech_unregister(), AST_MODULE_LOAD_SUCCESS, ast_mutex_destroy, and spandsp_global_stats.

{
   ast_fax_tech_unregister(&spandsp_fax_tech);
   ast_mutex_destroy(&spandsp_global_stats.lock);
   return AST_MODULE_LOAD_SUCCESS;
}

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 187 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().

{
   switch (completion_code) {
   case T30_ERR_OK:
      ast_atomic_fetchadd_int(&p->stats->success, 1);
      break;

   /* Link problems */
   case T30_ERR_CEDTONE:            /*! The CED tone exceeded 5s */
   case T30_ERR_T0_EXPIRED:         /*! Timed out waiting for initial communication */
   case T30_ERR_T1_EXPIRED:         /*! Timed out waiting for the first message */
   case T30_ERR_T3_EXPIRED:         /*! Timed out waiting for procedural interrupt */
   case T30_ERR_HDLC_CARRIER:       /*! The HDLC carrier did not stop in a timely manner */
   case T30_ERR_CANNOT_TRAIN:       /*! Failed to train with any of the compatible modems */
      ast_atomic_fetchadd_int(&p->stats->failed_to_train, 1);
      break;

   case T30_ERR_OPER_INT_FAIL:      /*! Operator intervention failed */
   case T30_ERR_INCOMPATIBLE:       /*! Far end is not compatible */
   case T30_ERR_RX_INCAPABLE:       /*! Far end is not able to receive */
   case T30_ERR_TX_INCAPABLE:       /*! Far end is not able to transmit */
   case T30_ERR_NORESSUPPORT:       /*! Far end cannot receive at the resolution of the image */
   case T30_ERR_NOSIZESUPPORT:      /*! Far end cannot receive at the size of image */
      ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
      break;

   case T30_ERR_UNEXPECTED:         /*! Unexpected message received */
      ast_atomic_fetchadd_int(&p->stats->protocol_error, 1);
      break;

   /* Phase E status values returned to a transmitter */
   case T30_ERR_TX_BADDCS:          /*! Received bad response to DCS or training */
   case T30_ERR_TX_BADPG:           /*! Received a DCN from remote after sending a page */
   case T30_ERR_TX_ECMPHD:          /*! Invalid ECM response received from receiver */
   case T30_ERR_TX_GOTDCN:          /*! Received a DCN while waiting for a DIS */
   case T30_ERR_TX_INVALRSP:        /*! Invalid response after sending a page */
   case T30_ERR_TX_NODIS:           /*! Received other than DIS while waiting for DIS */
   case T30_ERR_TX_PHBDEAD:         /*! Received no response to DCS, training or TCF */
   case T30_ERR_TX_PHDDEAD:         /*! No response after sending a page */
   case T30_ERR_TX_T5EXP:           /*! Timed out waiting for receiver ready (ECM mode) */
      ast_atomic_fetchadd_int(&p->stats->tx_protocol_error, 1);
      break;

   /* Phase E status values returned to a receiver */
   case T30_ERR_RX_ECMPHD:          /*! Invalid ECM response received from transmitter */
   case T30_ERR_RX_GOTDCS:          /*! DCS received while waiting for DTC */
   case T30_ERR_RX_INVALCMD:        /*! Unexpected command after page received */
   case T30_ERR_RX_NOCARRIER:       /*! Carrier lost during fax receive */
   case T30_ERR_RX_NOEOL:           /*! Timed out while waiting for EOL (end Of line) */
      ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
      break;
   case T30_ERR_RX_NOFAX:           /*! Timed out while waiting for first line */
      ast_atomic_fetchadd_int(&p->stats->nofax, 1);
      break;
   case T30_ERR_RX_T2EXPDCN:        /*! Timer T2 expired while waiting for DCN */
   case T30_ERR_RX_T2EXPD:          /*! Timer T2 expired while waiting for phase D */
   case T30_ERR_RX_T2EXPFAX:        /*! Timer T2 expired while waiting for fax page */
   case T30_ERR_RX_T2EXPMPS:        /*! Timer T2 expired while waiting for next fax page */
   case T30_ERR_RX_T2EXPRR:         /*! Timer T2 expired while waiting for RR command */
   case T30_ERR_RX_T2EXP:           /*! Timer T2 expired while waiting for NSS, DCS or MCF */
   case T30_ERR_RX_DCNWHY:          /*! Unexpected DCN while waiting for DCS or DIS */
   case T30_ERR_RX_DCNDATA:         /*! Unexpected DCN while waiting for image data */
   case T30_ERR_RX_DCNFAX:          /*! Unexpected DCN while waiting for EOM, EOP or MPS */
   case T30_ERR_RX_DCNPHD:          /*! Unexpected DCN after EOM or MPS sequence */
   case T30_ERR_RX_DCNRRD:          /*! Unexpected DCN after RR/RNR sequence */
   case T30_ERR_RX_DCNNORTN:        /*! Unexpected DCN after requested retransmission */
      ast_atomic_fetchadd_int(&p->stats->rx_protocol_error, 1);
      break;

   /* TIFF file problems */
   case T30_ERR_FILEERROR:          /*! TIFF/F file cannot be opened */
   case T30_ERR_NOPAGE:             /*! TIFF/F page not found */
   case T30_ERR_BADTIFF:            /*! TIFF/F format is not compatible */
   case T30_ERR_BADPAGE:            /*! TIFF/F page number tag missing */
   case T30_ERR_BADTAG:             /*! Incorrect values for TIFF/F tags */
   case T30_ERR_BADTIFFHDR:         /*! Bad TIFF/F header - incorrect values in fields */
      ast_atomic_fetchadd_int(&p->stats->file_error, 1);
      break;
   case T30_ERR_NOMEM:              /*! Cannot allocate memory for more pages */
      ast_atomic_fetchadd_int(&p->stats->mem_error, 1);
      break;

   /* General problems */
   case T30_ERR_RETRYDCN:           /*! Disconnected after permitted retries */
      ast_atomic_fetchadd_int(&p->stats->retries_exceeded, 1);
      break;
   case T30_ERR_CALLDROPPED:        /*! The call dropped prematurely */
      ast_atomic_fetchadd_int(&p->stats->call_dropped, 1);
      break;

   /* Feature negotiation issues */
   case T30_ERR_NOPOLL:             /*! Poll not accepted */
   case T30_ERR_IDENT_UNACCEPTABLE: /*! Far end's ident is not acceptable */
   case T30_ERR_SUB_UNACCEPTABLE:   /*! Far end's sub-address is not acceptable */
   case T30_ERR_SEP_UNACCEPTABLE:   /*! Far end's selective polling address is not acceptable */
   case T30_ERR_PSA_UNACCEPTABLE:   /*! Far end's polled sub-address is not acceptable */
   case T30_ERR_SID_UNACCEPTABLE:   /*! Far end's sender identification is not acceptable */
   case T30_ERR_PWD_UNACCEPTABLE:   /*! Far end's password is not acceptable */
   case T30_ERR_TSA_UNACCEPTABLE:   /*! Far end's transmitting subscriber internet address is not acceptable */
   case T30_ERR_IRA_UNACCEPTABLE:   /*! Far end's internet routing address is not acceptable */
   case T30_ERR_CIA_UNACCEPTABLE:   /*! Far end's calling subscriber internet address is not acceptable */
   case T30_ERR_ISP_UNACCEPTABLE:   /*! Far end's internet selective polling address is not acceptable */
   case T30_ERR_CSA_UNACCEPTABLE:   /*! Far end's called subscriber internet address is not acceptable */
      ast_atomic_fetchadd_int(&p->stats->neg_failed, 1);
      break;
   default:
      ast_atomic_fetchadd_int(&p->stats->unknown_error, 1);
      ast_log(LOG_WARNING, "unknown FAX session result '%d' (%s)\n", completion_code, t30_completion_code_to_str(completion_code));
      return -1;
   }
   return 0;
}

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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, } [static]

Definition at line 773 of file res_fax_spandsp.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 773 of file res_fax_spandsp.c.

struct spandsp_fax_stats g711

Definition at line 111 of file res_fax_spandsp.c.

ast_mutex_t lock

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]

Referenced by load_module(), spandsp_fax_cli_show_stats(), spandsp_fax_new(), spandsp_fax_switch_to_t38(), and unload_module().