Generic FAX Resource for FAX technology resource modules. More...

#include "asterisk.h"
#include "asterisk/io.h"
#include "asterisk/file.h"
#include "asterisk/logger.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/lock.h"
#include "asterisk/options.h"
#include "asterisk/strings.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/config.h"
#include "asterisk/astobj2.h"
#include "asterisk/res_fax.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/dsp.h"
#include "asterisk/indications.h"
#include "asterisk/ast_version.h"
#include "asterisk/translate.h"
#include "asterisk/stasis.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/smoother.h"
#include "asterisk/format_cache.h"

Include dependency graph for res_fax.c:

Go to the source code of this file.

Data Structures
struct	ast_fax_debug_info

struct	debug_info_history

struct	fax_detect
	used for fax detect framehook More...

struct	fax_gateway
	used for gateway framehook More...

struct	fax_module
	registered FAX technology modules are put into this list More...

struct	fax_options

struct	faxmodules

Macros
#define	FAX_DETECT_MODE_BOTH (FAX_DETECT_MODE_CNG \| FAX_DETECT_MODE_T38)

#define	FAX_DETECT_MODE_CNG (1 << 0)
	FAX Detect flags.

#define	FAX_DETECT_MODE_T38 (1 << 1)

#define	FAX_GATEWAY_TIMEOUT RES_FAX_TIMEOUT

#define	FAX_MAXBUCKETS 10
	maximum buckets for res_fax ao2 containers

#define	GENERIC_FAX_EXEC_ERROR(fax, chan, errorstr, reason)

#define	GENERIC_FAX_EXEC_ERROR_QUIET(fax, chan, errorstr, reason)

#define	GENERIC_FAX_EXEC_SET_VARS(fax, chan, errorstr, reason)

#define	RES_FAX_MAXRATE 14400

#define	RES_FAX_MINRATE 4800

#define	RES_FAX_MODEM (AST_FAX_MODEM_V17 \| AST_FAX_MODEM_V27TER \| AST_FAX_MODEM_V29)

#define	RES_FAX_STATUSEVENTS 0

#define	RES_FAX_T38TIMEOUT 5000

#define	RES_FAX_TIMEOUT 10000

Enumerations
enum	{ OPT_CALLEDMODE = (1 << 0) , OPT_CALLERMODE = (1 << 1) , OPT_DEBUG = (1 << 2) , OPT_STATUS = (1 << 3) , OPT_ALLOWAUDIO = (1 << 5) , OPT_REQUEST_T38 = (1 << 6) , OPT_FORCE_AUDIO = (1 << 7) }

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

static int	acf_faxopt_read (struct ast_channel chan, const char cmd, char data, char buf, size_t len)
	FAXOPT read function returns the contents of a FAX option.

static int	acf_faxopt_write (struct ast_channel chan, const char cmd, char data, const char value)
	FAXOPT write function modifies the contents of a FAX option.

static char *	ast_fax_caps_to_str (enum ast_fax_capabilities caps, char *buf, size_t bufsize)

void	ast_fax_log (int level, const char file, const int line, const char function, const char *msg)
	Log message at FAX or recommended level.

unsigned int	ast_fax_maxrate (void)
	get the maxiumum supported fax rate

unsigned int	ast_fax_minrate (void)
	get the minimum supported fax rate

static int	ast_fax_modem_to_str (enum ast_fax_modems bits, char *tbuf, size_t bufsize)

const char *	ast_fax_session_operation_str (struct ast_fax_session *s)
	get string representation of a FAX session's operation

const char *	ast_fax_state_to_str (enum ast_fax_state state)
	convert a ast_fax_state to a string

int	ast_fax_tech_register (struct ast_fax_tech *tech)
	register a FAX technology module

void	ast_fax_tech_unregister (struct ast_fax_tech *tech)
	unregister a FAX technology module

struct ast_module *	AST_MODULE_SELF_SYM (void)

static int	check_modem_rate (enum ast_fax_modems modems, unsigned int rate)

static char *	cli_fax_set_debug (struct ast_cli_entry e, int cmd, struct ast_cli_args a)
	enable FAX debugging

static char *	cli_fax_show_capabilities (struct ast_cli_entry e, int cmd, struct ast_cli_args a)
	display registered FAX capabilities

static char *	cli_fax_show_session (struct ast_cli_entry e, int cmd, struct ast_cli_args a)
	display details of a specified fax session

static char *	cli_fax_show_sessions (struct ast_cli_entry e, int cmd, struct ast_cli_args a)
	display fax sessions

static char *	cli_fax_show_settings (struct ast_cli_entry e, int cmd, struct ast_cli_args a)
	display global defaults and settings

static char *	cli_fax_show_stats (struct ast_cli_entry e, int cmd, struct ast_cli_args a)
	display fax stats

static char *	cli_fax_show_version (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static void	debug_check_frame_for_silence (struct ast_fax_session s, unsigned int c2s, struct ast_frame frame)

static void	destroy_callback (void *data)

static void	destroy_faxdetect (void *data)
	destroy a FAX detect structure

static void	destroy_gateway (void *data)
	destroy a FAX gateway session structure

static void	destroy_session (void *session)
	destroy a FAX session structure

static void	destroy_session_details (void *details)
	destroy a FAX session details structure

static void	destroy_v21_sessions (struct fax_gateway *gateway)
	destroy the v21 detection parts of a fax gateway session

static int	disable_t38 (struct ast_channel *chan)

static int	fax_detect_attach (struct ast_channel *chan, int timeout, int flags)
	Attach a faxdetect framehook object to a channel.

static struct ast_frame *	fax_detect_framehook (struct ast_channel chan, struct ast_frame f, enum ast_framehook_event event, void *data)
	Fax Detect Framehook.

static void	fax_detect_framehook_destroy (void *data)
	Deref the faxdetect data structure when the faxdetect framehook is detached.

static struct fax_detect *	fax_detect_new (struct ast_channel *chan, int timeout, int flags)
	Create a new fax detect object.

static int	fax_gateway_attach (struct ast_channel chan, struct ast_fax_session_details details)
	Attach a gateway framehook object to a channel.

static struct ast_frame *	fax_gateway_detect_t38 (struct fax_gateway gateway, struct ast_channel chan, struct ast_channel peer, struct ast_channel active, struct ast_frame *f)
	T38 Gateway Negotiate t38 parameters.

static struct ast_frame *	fax_gateway_detect_v21 (struct fax_gateway gateway, struct ast_channel chan, struct ast_channel peer, struct ast_channel active, struct ast_frame *f)

static struct ast_frame *	fax_gateway_framehook (struct ast_channel chan, struct ast_frame f, enum ast_framehook_event event, void *data)
	T.30<->T.38 gateway framehook.

static void	fax_gateway_framehook_destroy (void *data)
	Destroy the gateway data structure when the framehook is detached.

static void	fax_gateway_indicate_t38 (struct ast_channel chan, struct ast_channel active, struct ast_control_t38_parameters *control_params)

static struct fax_gateway *	fax_gateway_new (struct ast_channel chan, struct ast_fax_session_details details)
	Create a new fax gateway object.

static struct ast_frame *	fax_gateway_request_t38 (struct fax_gateway gateway, struct ast_channel chan)

static int	fax_gateway_start (struct fax_gateway gateway, struct ast_fax_session_details details, struct ast_channel *chan)
	Create a fax session and start T.30<->T.38 gateway mode.

static unsigned int	fax_rate_str_to_int (const char *ratestr)
	convert a rate string to a rate

static struct ast_fax_session *	fax_session_new (struct ast_fax_session_details details, struct ast_channel chan, struct ast_fax_session reserved, struct ast_fax_tech_token token)
	create a FAX session

static void	fax_session_release (struct ast_fax_session s, struct ast_fax_tech_token token)
	Release a session token.

static struct ast_fax_session *	fax_session_reserve (struct ast_fax_session_details details, struct ast_fax_tech_token *token)
	Reserve a fax session.

static char *	fax_session_tab_complete (struct ast_cli_args *a)
	fax session tab completion

static const char *	fax_session_type (struct ast_fax_session *s)

static struct ast_fax_session *	fax_v21_session_new (struct ast_channel *chan)

static struct ast_fax_session_details *	find_details (struct ast_channel *chan)
	returns a reference counted pointer to a fax datastore, if it exists

static struct ast_fax_session_details *	find_or_create_details (struct ast_channel *chan)
	returns a reference counted details structure from the channel's fax datastore. If the datastore does not exist it will be created

static void	fixup_callback (void data, struct ast_channel old_chan, struct ast_channel *new_chan)
	Copies fax detection and gateway framehooks during masquerades.

static struct ast_json *	generate_filenames_json (struct ast_fax_session_details *details)

static char *	generate_filenames_string (struct ast_fax_session_details details, char prefix, char *separator)
	Generate a string of filenames using the given prefix and separator.

static int	generic_fax_exec (struct ast_channel chan, struct ast_fax_session_details details, struct ast_fax_session reserved, struct ast_fax_tech_token token)
	this is the generic FAX session handling function

static void	get_general_options (struct fax_options *options)

static int	load_module (void)
	Load the module.

static int	manager_fax_session (struct mansession s, const struct message m)

static int	manager_fax_sessions (struct mansession s, const struct message m)

static int	manager_fax_sessions_entry (struct mansession s, struct ast_fax_session session, const char *id_text)

static int	manager_fax_stats (struct mansession s, const struct message m)

static int	receivefax_exec (struct ast_channel chan, const char data)
	initiate a receive FAX session

static int	receivefax_t38_init (struct ast_channel chan, struct ast_fax_session_details details)

static int	reload_module (void)

static int	report_fax_status (struct ast_channel chan, struct ast_fax_session_details details, const char *status)
	send a FAX status manager event

static int	report_receive_fax_status (struct ast_channel chan, const char filename)
	Report on the final state of a receive fax operation.

static int	report_send_fax_status (struct ast_channel chan, struct ast_fax_session_details details)
	Report on the status of a completed fax send attempt.

static int	sendfax_exec (struct ast_channel chan, const char data)
	initiate a send FAX session

static int	sendfax_t38_init (struct ast_channel chan, struct ast_fax_session_details details)

static int	session_cmp_cb (void obj, void arg, int flags)
	compare callback for ao2

static struct ast_fax_session_details *	session_details_new (void)
	create a FAX session details structure

static int	session_hash_cb (const void *obj, const int flags)
	hash callback for ao2

static void	set_channel_variables (struct ast_channel chan, struct ast_fax_session_details details)
	Set fax related channel variables.

static int	set_config (int reload)
	configure res_fax

static int	set_fax_t38_caps (struct ast_channel chan, struct ast_fax_session_details details)

static void	set_general_options (const struct fax_options *options)

static int	set_t38timeout (const char value, unsigned int t38timeout)

static void	t38_parameters_ast_to_fax (struct ast_fax_t38_parameters dst, const struct ast_control_t38_parameters src)

static void	t38_parameters_fax_to_ast (struct ast_control_t38_parameters dst, const struct ast_fax_t38_parameters src)

static int	unload_module (void)
	unload res_fax

static int	update_modem_bits (enum ast_fax_modems bits, const char value)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS \| AST_MODFLAG_LOAD_ORDER , .description = "Generic FAX Applications" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_APP_DEPEND, }

static struct ast_custom_function	acf_faxopt
	FAXOPT dialplan function.

static const char	app_receivefax [] = "ReceiveFAX"

static const char	app_sendfax [] = "SendFAX"

static const struct ast_module_info *	ast_module_info = &__mod_info

static const char *	config = "res_fax.conf"

static const struct fax_options	default_options

static struct ast_cli_entry	fax_cli []

static const struct ast_datastore_info	fax_datastore

static const struct ast_app_option	fax_exec_options [128] = { [ 'a' ] = { .flag = OPT_CALLEDMODE }, [ 'c' ] = { .flag = OPT_CALLERMODE }, [ 'd' ] = { .flag = OPT_DEBUG }, [ 'f' ] = { .flag = OPT_ALLOWAUDIO }, [ 'F' ] = { .flag = OPT_FORCE_AUDIO }, [ 's' ] = { .flag = OPT_STATUS }, [ 'z' ] = { .flag = OPT_REQUEST_T38 }, }

static int	fax_logger_level = -1

static struct faxmodules	faxmodules = AST_RWLIST_HEAD_INIT_VALUE

struct {

int active_sessions

struct ao2_container * container

int fax_complete

int fax_failures

int fax_rx_attempts

int fax_tx_attempts

int nextsessionname

int reserved_sessions

}	faxregistry
	The faxregistry is used to manage information and statistics for all FAX sessions.

static struct fax_options	general_options

static int	global_fax_debug = 0

static ast_rwlock_t	options_lock = AST_RWLOCK_INIT_VALUE

static struct ast_control_t38_parameters	our_t38_parameters

Detailed Description

Generic FAX Resource for FAX technology resource modules.

Author: Dwayne M. Hubbard dhubb.nosp@m.ard@.nosp@m.digiu.nosp@m.m.co.nosp@m.m; Kevin P. Fleming kpfle.nosp@m.ming.nosp@m.@digi.nosp@m.um.c.nosp@m.om; Matthew Nicholson mnich.nosp@m.olso.nosp@m.n@dig.nosp@m.ium..nosp@m.com; Gregory H. Nietsky grego.nosp@m.ry@d.nosp@m.istro.nosp@m.tech.nosp@m..co.z.nosp@m.a

A generic FAX resource module that provides SendFAX and ReceiveFAX applications. This module requires FAX technology modules, like res_fax_spandsp, to register with it so it can use the technology modules to perform the actual FAX transmissions.

Definition in file res_fax.c.

Macro Definition Documentation

◆ FAX_DETECT_MODE_BOTH

#define FAX_DETECT_MODE_BOTH (FAX_DETECT_MODE_CNG | FAX_DETECT_MODE_T38)

Definition at line 586 of file res_fax.c.

◆ FAX_DETECT_MODE_CNG

#define FAX_DETECT_MODE_CNG (1 << 0)

FAX Detect flags.

Definition at line 584 of file res_fax.c.

◆ FAX_DETECT_MODE_T38

#define FAX_DETECT_MODE_T38 (1 << 1)

Definition at line 585 of file res_fax.c.

◆ FAX_GATEWAY_TIMEOUT

#define FAX_GATEWAY_TIMEOUT RES_FAX_TIMEOUT

Definition at line 594 of file res_fax.c.

◆ FAX_MAXBUCKETS

#define FAX_MAXBUCKETS 10

maximum buckets for res_fax ao2 containers

Definition at line 591 of file res_fax.c.

◆ GENERIC_FAX_EXEC_ERROR

#define GENERIC_FAX_EXEC_ERROR	(	fax,
		chan,
		errorstr,
		reason
	)

Value:

    do {    \
        ast_log(LOG_ERROR, "channel '%s' FAX session '%u' failure, reason: '%s' (%s)\n", ast_channel_name(chan), fax->id, reason, errorstr); \
        GENERIC_FAX_EXEC_ERROR_QUIET(fax, chan, errorstr, reason); \
    } while (0)

Definition at line 1586 of file res_fax.c.

       {    \
        ast_log(LOG_ERROR, "channel '%s' FAX session '%u' failure, reason: '%s' (%s)\n", ast_channel_name(chan), fax->id, reason, errorstr); \
        GENERIC_FAX_EXEC_ERROR_QUIET(fax, chan, errorstr, reason); \
    } while (0)

◆ GENERIC_FAX_EXEC_ERROR_QUIET

#define GENERIC_FAX_EXEC_ERROR_QUIET	(	fax,
		chan,
		errorstr,
		reason
	)

Value:

    do {    \
        GENERIC_FAX_EXEC_SET_VARS(fax, chan, errorstr, reason); \
    } while (0)

Definition at line 1581 of file res_fax.c.

       {    \
        GENERIC_FAX_EXEC_SET_VARS(fax, chan, errorstr, reason); \
    } while (0)

◆ GENERIC_FAX_EXEC_SET_VARS

#define GENERIC_FAX_EXEC_SET_VARS	(	fax,
		chan,
		errorstr,
		reason
	)

Definition at line 1570 of file res_fax.c.

       {    \
        if (ast_strlen_zero(fax->details->result)) \
            ast_string_field_set(fax->details, result, "FAILED"); \
        if (ast_strlen_zero(fax->details->resultstr)) \
            ast_string_field_set(fax->details, resultstr, reason); \
        if (ast_strlen_zero(fax->details->error)) \
            ast_string_field_set(fax->details, error, errorstr); \
        set_channel_variables(chan, fax->details); \
    } while (0)

◆ RES_FAX_MAXRATE

#define RES_FAX_MAXRATE 14400

Definition at line 624 of file res_fax.c.

◆ RES_FAX_MINRATE

#define RES_FAX_MINRATE 4800

Definition at line 623 of file res_fax.c.

◆ RES_FAX_MODEM

#define RES_FAX_MODEM (AST_FAX_MODEM_V17 | AST_FAX_MODEM_V27TER | AST_FAX_MODEM_V29)

Definition at line 626 of file res_fax.c.

◆ RES_FAX_STATUSEVENTS

#define RES_FAX_STATUSEVENTS 0

Definition at line 625 of file res_fax.c.

◆ RES_FAX_T38TIMEOUT

#define RES_FAX_T38TIMEOUT 5000

Definition at line 627 of file res_fax.c.

◆ RES_FAX_TIMEOUT

#define RES_FAX_TIMEOUT 10000

Definition at line 593 of file res_fax.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
OPT_CALLEDMODE
OPT_CALLERMODE
OPT_DEBUG
OPT_STATUS
OPT_ALLOWAUDIO
OPT_REQUEST_T38
OPT_FORCE_AUDIO

Definition at line 658 of file res_fax.c.

     {
    OPT_CALLEDMODE  = (1 << 0),
    OPT_CALLERMODE  = (1 << 1),
    OPT_DEBUG       = (1 << 2),
    OPT_STATUS      = (1 << 3),
    OPT_ALLOWAUDIO  = (1 << 5),
    OPT_REQUEST_T38 = (1 << 6),
    OPT_FORCE_AUDIO = (1 << 7),
};

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 4968 of file res_fax.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 4968 of file res_fax.c.

◆ acf_faxopt_read()

static int acf_faxopt_read	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		char *	buf,
		size_t	len
	)

static

FAXOPT read function returns the contents of a FAX option.

Definition at line 4627 of file res_fax.c.

{
    struct ast_fax_session_details *details = find_details(chan);
    int res = 0;
    char *filenames;
 
    if (!details) {
        ast_log(LOG_ERROR, "channel '%s' can't read FAXOPT(%s) because it has never been written.\n", ast_channel_name(chan), data);
        return -1;
    }
    if (!strcasecmp(data, "ecm")) {
        ast_copy_string(buf, details->option.ecm ? "yes" : "no", len);
    } else if (!strcasecmp(data, "t38gateway") || !strcasecmp(data, "gateway") ||
           !strcasecmp(data, "t38_gateway") || !strcasecmp(data, "faxgateway")) {
        ast_copy_string(buf, details->gateway_id != -1 ? "yes" : "no", len);
    } else if (!strcasecmp(data, "faxdetect")) {
        ast_copy_string(buf, details->faxdetect_id != -1 ? "yes" : "no", len);
    } else if (!strcasecmp(data, "error")) {
        ast_copy_string(buf, details->error, len);
    } else if (!strcasecmp(data, "filename")) {
        if (AST_LIST_EMPTY(&details->documents)) {
            ast_log(LOG_ERROR, "channel '%s' can't read FAXOPT(%s) because it has never been written.\n", ast_channel_name(chan), data);
            res = -1;
        } else {
            ast_copy_string(buf, AST_LIST_FIRST(&details->documents)->filename, len);
        }
    } else if (!strcasecmp(data, "filenames")) {
        if (AST_LIST_EMPTY(&details->documents)) {
            ast_log(LOG_ERROR, "channel '%s' can't read FAXOPT(%s) because it has never been written.\n", ast_channel_name(chan), data);
            res = -1;
        } else if ((filenames = generate_filenames_string(details, "", ","))) {
            ast_copy_string(buf, filenames, len);
            ast_free(filenames);
        } else {
            ast_log(LOG_ERROR, "channel '%s' can't read FAXOPT(%s), there was an error generating the filenames list.\n", ast_channel_name(chan), data);
            res = -1;
        }
    } else if (!strcasecmp(data, "headerinfo")) {
        ast_copy_string(buf, details->headerinfo, len);
    } else if (!strcasecmp(data, "localstationid")) {
        ast_copy_string(buf, details->localstationid, len);
    } else if (!strcasecmp(data, "maxrate")) {
        snprintf(buf, len, "%u", details->maxrate);
    } else if (!strcasecmp(data, "minrate")) {
        snprintf(buf, len, "%u", details->minrate);
    } else if (!strcasecmp(data, "pages")) {
        snprintf(buf, len, "%u", details->pages_transferred);
    } else if (!strcasecmp(data, "rate")) {
        ast_copy_string(buf, details->transfer_rate, len);
    } else if (!strcasecmp(data, "remotestationid")) {
        ast_copy_string(buf, details->remotestationid, len);
    } else if (!strcasecmp(data, "resolution")) {
        ast_copy_string(buf, details->resolution, len);
    } else if (!strcasecmp(data, "sessionid")) {
        snprintf(buf, len, "%u", details->id);
    } else if (!strcasecmp(data, "status")) {
        ast_copy_string(buf, details->result, len);
    } else if (!strcasecmp(data, "statusstr")) {
        ast_copy_string(buf, details->resultstr, len);
    } else if ((!strcasecmp(data, "modem")) || (!strcasecmp(data, "modems"))) {
        ast_fax_modem_to_str(details->modems, buf, len);
    } else if (!strcasecmp(data, "t38timeout")) {
        snprintf(buf, len, "%u", details->t38timeout);
    } else if (!strcasecmp(data, "negotiate_both")) {
        ast_copy_string(buf, details->negotiate_both != -1 ? "yes" : "no", len);
    } else {
        ast_log(LOG_WARNING, "channel '%s' can't read FAXOPT(%s) because it is unhandled!\n", ast_channel_name(chan), data);
        res = -1;
    }
    ao2_ref(details, -1);
 
    return res;
}

◆ acf_faxopt_write()

static int acf_faxopt_write	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		const char *	value
	)

static

FAXOPT write function modifies the contents of a FAX option.

Definition at line 4702 of file res_fax.c.

{
    int res = 0;
    struct ast_fax_session_details *details;
 
    if (!(details = find_or_create_details(chan))) {
        ast_log(LOG_WARNING, "channel '%s' can't set FAXOPT(%s) to '%s' because it failed to create a datastore.\n", ast_channel_name(chan), data, value);
        return -1;
    }
    ast_debug(3, "channel '%s' setting FAXOPT(%s) to '%s'\n", ast_channel_name(chan), data, value);
 
    if (!strcasecmp(data, "ecm")) {
        const char *val = ast_skip_blanks(value);
        if (ast_true(val)) {
            details->option.ecm = AST_FAX_OPTFLAG_TRUE;
        } else if (ast_false(val)) {
            details->option.ecm = AST_FAX_OPTFLAG_FALSE;
        } else {
            ast_log(LOG_WARNING, "Unsupported value '%s' passed to FAXOPT(ecm).\n", value);
        }
    } else if (!strcasecmp(data, "t38gateway") || !strcasecmp(data, "gateway") ||
           !strcasecmp(data, "t38_gateway") || !strcasecmp(data, "faxgateway")) {
        const char *val = ast_skip_blanks(value);
        char *timeout = strchr(val, ',');
 
        if (timeout) {
            *timeout++ = '\0';
        }
 
        if (ast_true(val)) {
            if (details->gateway_id < 0) {
                details->gateway_timeout = 0;
                if (timeout) {
                    unsigned int gwtimeout;
 
                    if (sscanf(timeout, "%30u", &gwtimeout) == 1) {
                        details->gateway_timeout = gwtimeout * 1000;
                    } else {
                        ast_log(LOG_WARNING, "Unsupported timeout '%s' passed to FAXOPT(%s).\n", timeout, data);
                    }
                }
 
                details->gateway_id = fax_gateway_attach(chan, details);
                if (details->gateway_id < 0) {
                    ast_log(LOG_ERROR, "Error attaching T.38 gateway to channel %s.\n", ast_channel_name(chan));
                    res = -1;
                } else {
                    ast_debug(1, "Attached T.38 gateway to channel %s.\n", ast_channel_name(chan));
                }
            } else {
                ast_log(LOG_WARNING, "Attempt to attach a T.38 gateway on channel (%s) with gateway already running.\n", ast_channel_name(chan));
            }
        } else if (ast_false(val)) {
            ast_channel_lock(chan);
            ast_framehook_detach(chan, details->gateway_id);
            ast_channel_unlock(chan);
            details->gateway_id = -1;
        } else {
            ast_log(LOG_WARNING, "Unsupported value '%s' passed to FAXOPT(%s).\n", value, data);
        }
    } else if (!strcasecmp(data, "faxdetect")) {
        const char *val = ast_skip_blanks(value);
        char *timeout = strchr(val, ',');
        unsigned int fdtimeout = 0;
        int flags;
        int faxdetect;
 
        if (timeout) {
            *timeout++ = '\0';
        }
 
        if (ast_true(val) || !strcasecmp(val, "t38") || !strcasecmp(val, "cng")) {
            if (details->faxdetect_id < 0) {
                if (timeout) {
                    if (sscanf(timeout, "%30u", &fdtimeout) == 1) {
                        fdtimeout *= 1000;
                    } else {
                        ast_log(LOG_WARNING, "Unsupported timeout '%s' passed to FAXOPT(%s).\n",
                            timeout, data);
                    }
                }
 
                if (!strcasecmp(val, "t38")) {
                    flags = FAX_DETECT_MODE_T38;
                } else if (!strcasecmp(val, "cng")) {
                    flags = FAX_DETECT_MODE_CNG;
                } else {
                    flags = FAX_DETECT_MODE_BOTH;
                }
 
                faxdetect = fax_detect_attach(chan, fdtimeout, flags);
                if (faxdetect < 0) {
                    ast_log(LOG_ERROR, "Error attaching FAX detect to channel %s.\n", ast_channel_name(chan));
                    res = -1;
                } else {
                    ast_debug(1, "Attached FAX detect to channel %s.\n", ast_channel_name(chan));
                }
            } else {
                ast_log(LOG_WARNING, "Attempt to attach a FAX detect on channel (%s) with FAX detect already running.\n", ast_channel_name(chan));
            }
        } else if (ast_false(val)) {
            ast_channel_lock(chan);
            ast_framehook_detach(chan, details->faxdetect_id);
            ast_channel_unlock(chan);
            details->faxdetect_id = -1;
        } else {
            ast_log(LOG_WARNING, "Unsupported value '%s' passed to FAXOPT(%s).\n", value, data);
        }
    } else if (!strcasecmp(data, "headerinfo")) {
        ast_string_field_set(details, headerinfo, value);
    } else if (!strcasecmp(data, "localstationid")) {
        ast_string_field_set(details, localstationid, value);
    } else if (!strcasecmp(data, "maxrate")) {
        details->maxrate = fax_rate_str_to_int(value);
        if (!details->maxrate) {
            details->maxrate = ast_fax_maxrate();
        }
    } else if (!strcasecmp(data, "minrate")) {
        details->minrate = fax_rate_str_to_int(value);
        if (!details->minrate) {
            details->minrate = ast_fax_minrate();
        }
    } else if (!strcasecmp(data, "t38timeout")) {
        if (set_t38timeout(value, &details->t38timeout)) {
            res = -1;
        }
    } else if ((!strcasecmp(data, "modem")) || (!strcasecmp(data, "modems"))) {
        update_modem_bits(&details->modems, value);
    } else if (!strcasecmp(data, "negotiate_both")) {
        details->negotiate_both = ast_true(ast_skip_blanks(value));
    } else {
        ast_log(LOG_WARNING, "channel '%s' set FAXOPT(%s) to '%s' is unhandled!\n", ast_channel_name(chan), data, value);
        res = -1;
    }
 
    ao2_ref(details, -1);
 
    return res;
}

◆ ast_fax_caps_to_str()

static char * ast_fax_caps_to_str	(	enum ast_fax_capabilities	caps,
		char *	buf,
		size_t	bufsize
	)

static

Definition at line 947 of file res_fax.c.

{
    char *out = buf;
    size_t size = bufsize;
    int first = 1;
 
    if (caps & AST_FAX_TECH_SEND) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "SEND");
        first = 0;
    }
    if (caps & AST_FAX_TECH_RECEIVE) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "RECEIVE");
        first = 0;
    }
    if (caps & AST_FAX_TECH_AUDIO) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "AUDIO");
        first = 0;
    }
    if (caps & AST_FAX_TECH_T38) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "T38");
        first = 0;
    }
    if (caps & AST_FAX_TECH_MULTI_DOC) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "MULTI_DOC");
        first = 0;
    }
    if (caps & AST_FAX_TECH_GATEWAY) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "GATEWAY");
        first = 0;
    }
    if (caps & AST_FAX_TECH_V21_DETECT) {
        if (!first) {
            ast_build_string(&buf, &size, ",");
        }
        ast_build_string(&buf, &size, "V21");
        first = 0;
    }
 
    return out;
}

References ast_build_string(), AST_FAX_TECH_AUDIO, AST_FAX_TECH_GATEWAY, AST_FAX_TECH_MULTI_DOC, AST_FAX_TECH_RECEIVE, AST_FAX_TECH_SEND, AST_FAX_TECH_T38, AST_FAX_TECH_V21_DETECT, buf, first, and out.

Referenced by fax_session_new(), and fax_session_reserve().

◆ ast_fax_log()

void ast_fax_log	(	int	level,
		const char *	file,
		const int	line,
		const char *	function,
		const char *	msg
	)

Log message at FAX or recommended level.

The first four parameters can be represented with Asterisk's LOG_* levels. In other words, this function may be called like

ast_fax_log(LOG_DEBUG, msg);

Definition at line 1137 of file res_fax.c.

{
    if (fax_logger_level != -1) {
        ast_log_dynamic_level(fax_logger_level, "%s", msg);
    } else {
        ast_log(level, file, line, function, "%s", msg);
    }
}

References ast_log, ast_log_dynamic_level, and fax_logger_level.

Referenced by spandsp_log().

◆ ast_fax_maxrate()

unsigned int ast_fax_maxrate ( void )

get the maxiumum supported fax rate

Definition at line 897 of file res_fax.c.

{
    struct fax_options options;
    get_general_options(&options);
 
    return options.maxrate;
}

References get_general_options(), and options.

Referenced by acf_faxopt_write().

◆ ast_fax_minrate()

unsigned int ast_fax_minrate ( void )

get the minimum supported fax rate

Definition at line 905 of file res_fax.c.

{
    struct fax_options options;
    get_general_options(&options);
 
    return options.minrate;
}

References get_general_options(), and options.

Referenced by acf_faxopt_write().

◆ ast_fax_modem_to_str()

static int ast_fax_modem_to_str	(	enum ast_fax_modems	bits,
		char *	tbuf,
		size_t	bufsize
	)

static

Definition at line 1006 of file res_fax.c.

{
    int count = 0;
 
    if (bits & AST_FAX_MODEM_V17) {
        strcat(tbuf, "V17");
        count++;
    }
    if (bits & AST_FAX_MODEM_V27TER) {
        if (count) {
            strcat(tbuf, ",");
        }
        strcat(tbuf, "V27");
        count++;
    }
    if (bits & AST_FAX_MODEM_V29) {
        if (count) {
            strcat(tbuf, ",");
        }
        strcat(tbuf, "V29");
        count++;
    }
    if (bits & AST_FAX_MODEM_V34) {
        if (count) {
            strcat(tbuf, ",");
        }
        strcat(tbuf, "V34");
        count++;
    }
 
    return 0;
}

References AST_FAX_MODEM_V17, AST_FAX_MODEM_V27TER, AST_FAX_MODEM_V29, and AST_FAX_MODEM_V34.

Referenced by acf_faxopt_read(), cli_fax_show_settings(), receivefax_exec(), sendfax_exec(), and set_config().

◆ ast_fax_session_operation_str()

const char * ast_fax_session_operation_str ( struct ast_fax_session * s )

get string representation of a FAX session's operation

Definition at line 4355 of file res_fax.c.

{
    if (s->details->caps & AST_FAX_TECH_GATEWAY) {
        return "gateway";
    }
    if (s->details->caps & AST_FAX_TECH_SEND) {
        return "send";
    }
    if (s->details->caps & AST_FAX_TECH_RECEIVE) {
        return "receive";
    }
    if (s->details->caps & AST_FAX_TECH_V21_DETECT) {
        return "V.21";
    }
 
    return "none";
}

References AST_FAX_TECH_GATEWAY, AST_FAX_TECH_RECEIVE, AST_FAX_TECH_SEND, AST_FAX_TECH_V21_DETECT, ast_fax_session_details::caps, and ast_fax_session::details.

Referenced by cli_fax_show_sessions(), manager_fax_sessions_entry(), and spandsp_manager_fax_session().

◆ ast_fax_state_to_str()

const char * ast_fax_state_to_str ( enum ast_fax_state state )

convert a ast_fax_state to a string

convert an ast_fax_state to a string

Definition at line 1114 of file res_fax.c.

{
    switch (state) {
    case AST_FAX_STATE_UNINITIALIZED:
        return "Uninitialized";
    case AST_FAX_STATE_INITIALIZED:
        return "Initialized";
    case AST_FAX_STATE_OPEN:
        return "Open";
    case AST_FAX_STATE_ACTIVE:
        return "Active";
    case AST_FAX_STATE_COMPLETE:
        return "Complete";
    case AST_FAX_STATE_RESERVED:
        return "Reserved";
    case AST_FAX_STATE_INACTIVE:
        return "Inactive";
    default:
        ast_log(LOG_WARNING, "unhandled FAX state: %u\n", state);
        return "Unknown";
    }
}

References AST_FAX_STATE_ACTIVE, AST_FAX_STATE_COMPLETE, AST_FAX_STATE_INACTIVE, AST_FAX_STATE_INITIALIZED, AST_FAX_STATE_OPEN, AST_FAX_STATE_RESERVED, AST_FAX_STATE_UNINITIALIZED, ast_log, and LOG_WARNING.

Referenced by cli_fax_show_sessions(), manager_fax_sessions_entry(), spandsp_fax_cli_show_session(), spandsp_fax_write(), and spandsp_manager_fax_session().

◆ ast_fax_tech_register()

int ast_fax_tech_register ( struct ast_fax_tech * tech )

register a FAX technology module

register a fax technology

Definition at line 1075 of file res_fax.c.

{
    struct fax_module *fax;
 
    if (!(fax = ast_calloc(1, sizeof(*fax)))) {
        return -1;
    }
    fax->tech = tech;
    AST_RWLIST_WRLOCK(&faxmodules);
    AST_RWLIST_INSERT_TAIL(&faxmodules, fax, list);
    AST_RWLIST_UNLOCK(&faxmodules);
 
    ast_verb(3, "Registered handler for '%s' (%s)\n", fax->tech->type, fax->tech->description);
 
    return 0;
}

References ast_calloc, AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, ast_fax_tech::description, fax_module::list, fax_module::tech, and ast_fax_tech::type.

Referenced by load_module().

◆ ast_fax_tech_unregister()

void ast_fax_tech_unregister ( struct ast_fax_tech * tech )

unregister a FAX technology module

unregister a fax technology

Definition at line 1093 of file res_fax.c.

{
    struct fax_module *fax;
 
    ast_verb(3, "Unregistering FAX module type '%s'\n", tech->type);
 
    AST_RWLIST_WRLOCK(&faxmodules);
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&faxmodules, fax, list) {
        if (fax->tech != tech) {
            continue;
        }
        AST_RWLIST_REMOVE_CURRENT(list);
        ast_free(fax);
        ast_verb(4, "Unregistered FAX module type '%s'\n", tech->type);
        break;
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
    AST_RWLIST_UNLOCK(&faxmodules);
}

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, fax_module::list, fax_module::tech, and ast_fax_tech::type.

Referenced by unload_module().

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 4968 of file res_fax.c.

◆ check_modem_rate()

static int check_modem_rate	(	enum ast_fax_modems	modems,
		unsigned int	rate
	)

static

Definition at line 1039 of file res_fax.c.

{
    switch (rate) {
    case 2400:
    case 4800:
        if (!(modems & (AST_FAX_MODEM_V27TER | AST_FAX_MODEM_V34))) {
            return 1;
        }
        break;
    case 7200:
    case 9600:
        if (!(modems & (AST_FAX_MODEM_V17 | AST_FAX_MODEM_V29 | AST_FAX_MODEM_V34))) {
            return 1;
        }
        break;
    case 12000:
    case 14400:
        if (!(modems & (AST_FAX_MODEM_V17 | AST_FAX_MODEM_V34))) {
            return 1;
        }
        break;
    case 28800:
    case 33600:
        if (!(modems & AST_FAX_MODEM_V34)) {
            return 1;
        }
        break;
    default:
        /* this should never happen */
        return 1;
    }
 
    return 0;
}

References AST_FAX_MODEM_V17, AST_FAX_MODEM_V27TER, AST_FAX_MODEM_V29, AST_FAX_MODEM_V34, and fax_options::modems.

Referenced by receivefax_exec(), sendfax_exec(), and set_config().

◆ cli_fax_set_debug()

static char * cli_fax_set_debug	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

enable FAX debugging

Definition at line 4104 of file res_fax.c.

{
    int flag;
    const char *what;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "fax set debug {on|off}";
        e->usage =
            "Usage: fax set debug { on | off }\n"
            "       Enable/Disable FAX debugging on new FAX sessions.  The basic FAX debugging will result in\n"
            "       additional events sent to manager sessions with 'call' class permissions.  When\n"
            "       verbosity is greater than '5' events will be displayed to the console and audio versus\n"
            "       energy analysis will be performed and displayed to the console.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    what = a->argv[e->args-1];      /* guaranteed to exist */
    if (!strcasecmp(what, "on")) {
        flag = 1;
    } else if (!strcasecmp(what, "off")) {
        flag = 0;
    } else {
        return CLI_SHOWUSAGE;
    }
 
    global_fax_debug = flag;
    ast_cli(a->fd, "\n\nFAX Debug %s\n\n", (flag) ? "Enabled" : "Disabled");
 
    return CLI_SUCCESS;
}

References a, ast_cli_entry::args, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, global_fax_debug, NULL, and ast_cli_entry::usage.

◆ cli_fax_show_capabilities()

static char * cli_fax_show_capabilities	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

display registered FAX capabilities

Definition at line 4139 of file res_fax.c.

{
    struct fax_module *fax;
    unsigned int num_modules = 0;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "fax show capabilities";
        e->usage =
            "Usage: fax show capabilities\n"
            "       Shows the capabilities of the registered FAX technology modules\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    ast_cli(a->fd, "\n\nRegistered FAX Technology Modules:\n\n");
    AST_RWLIST_RDLOCK(&faxmodules);
    AST_RWLIST_TRAVERSE(&faxmodules, fax, list) {
        ast_cli(a->fd, "%-15s : %s\n%-15s : %s\n%-15s : ", "Type", fax->tech->type, "Description", fax->tech->description, "Capabilities");
        fax->tech->cli_show_capabilities(a->fd);
        num_modules++;
    }
    AST_RWLIST_UNLOCK(&faxmodules);
    ast_cli(a->fd, "%u registered modules\n\n", num_modules);
 
    return CLI_SUCCESS;
}

References a, ast_cli(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_GENERATE, CLI_INIT, ast_fax_tech::cli_show_capabilities, CLI_SUCCESS, ast_cli_entry::command, ast_fax_tech::description, fax_module::list, NULL, fax_module::tech, ast_fax_tech::type, and ast_cli_entry::usage.

◆ cli_fax_show_session()

static char * cli_fax_show_session	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

display details of a specified fax session

Definition at line 4208 of file res_fax.c.

{
    struct ast_fax_session *s, tmp;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "fax show session";
        e->usage =
            "Usage: fax show session <session number>\n"
            "       Shows status of the named FAX session\n";
        return NULL;
    case CLI_GENERATE:
        return fax_session_tab_complete(a);
    }
 
    if (a->argc != 4) {
        return CLI_SHOWUSAGE;
    }
 
    if (sscanf(a->argv[3], "%u", &tmp.id) != 1) {
        ast_log(LOG_ERROR, "invalid session id: '%s'\n", a->argv[3]);
        return RESULT_SUCCESS;
    }
 
    ast_cli(a->fd, "\nFAX Session Details:\n--------------------\n\n");
    s = ao2_find(faxregistry.container, &tmp, OBJ_POINTER);
    if (s) {
        ast_cli(a->fd, "%-22s : %s\n", "channel", s->channame);
        s->tech->cli_show_session(s, a->fd);
        ao2_ref(s, -1);
    }
    ast_cli(a->fd, "\n\n");
 
    return CLI_SUCCESS;
}

References a, ao2_find, ao2_ref, ast_cli(), ast_log, ast_fax_session::channame, CLI_GENERATE, CLI_INIT, ast_fax_tech::cli_show_session, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, fax_session_tab_complete(), faxregistry, ast_fax_session::id, LOG_ERROR, NULL, OBJ_POINTER, RESULT_SUCCESS, ast_fax_session::tech, and ast_cli_entry::usage.

◆ cli_fax_show_sessions()

static char * cli_fax_show_sessions	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

display fax sessions

Definition at line 4374 of file res_fax.c.

{
    struct ast_fax_session *s;
    struct ao2_iterator i;
    int session_count;
    char *filenames;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "fax show sessions";
        e->usage =
            "Usage: fax show sessions\n"
            "       Shows the current FAX sessions\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    ast_cli(a->fd, "\nCurrent FAX Sessions:\n\n");
    ast_cli(a->fd, "%-30.30s %-10.10s %-10.10s %-5.5s %-10.10s %-15.15s %-30.30s\n",
        "Channel", "Tech", "FAXID", "Type", "Operation", "State", "File(s)");
    i = ao2_iterator_init(faxregistry.container, 0);
    while ((s = ao2_iterator_next(&i))) {
        ao2_lock(s);
 
        filenames = generate_filenames_string(s->details, "", ", ");
 
        ast_cli(a->fd, "%-30.30s %-10.10s %-10u %-5.5s %-10.10s %-15.15s %-30s\n",
            s->channame, s->tech->type, s->id,
            fax_session_type(s),
            ast_fax_session_operation_str(s),
            ast_fax_state_to_str(s->state), S_OR(filenames, ""));
 
        ast_free(filenames);
        ao2_unlock(s);
        ao2_ref(s, -1);
    }
    ao2_iterator_destroy(&i);
    session_count = ao2_container_count(faxregistry.container);
    ast_cli(a->fd, "\n%d FAX sessions\n\n", session_count);
 
    return CLI_SUCCESS;
}

References a, ao2_container_count(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, ast_cli(), ast_fax_session_operation_str(), ast_fax_state_to_str(), ast_free, ast_fax_session::channame, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, ast_fax_session::details, fax_session_type(), faxregistry, generate_filenames_string(), ast_fax_session::id, NULL, S_OR, session_count, ast_fax_session::state, ast_fax_session::tech, ast_fax_tech::type, and ast_cli_entry::usage.

◆ cli_fax_show_settings()

static char * cli_fax_show_settings	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

display global defaults and settings

Definition at line 4169 of file res_fax.c.

{
    struct fax_module *fax;
    char modems[128] = "";
    struct fax_options options;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "fax show settings";
        e->usage =
            "Usage: fax show settings\n"
            "       Show the global settings and defaults of both the FAX core and technology modules\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    get_general_options(&options);
 
    ast_cli(a->fd, "FAX For Asterisk Settings:\n");
    ast_cli(a->fd, "\tECM: %s\n", options.ecm ? "Enabled" : "Disabled");
    ast_cli(a->fd, "\tStatus Events: %s\n",  options.statusevents ? "On" : "Off");
    ast_cli(a->fd, "\tMinimum Bit Rate: %u\n", options.minrate);
    ast_cli(a->fd, "\tMaximum Bit Rate: %u\n", options.maxrate);
    ast_fax_modem_to_str(options.modems, modems, sizeof(modems));
    ast_cli(a->fd, "\tModem Modulations Allowed: %s\n", modems);
    ast_cli(a->fd, "\tT.38 Negotiation Timeout: %u\n", options.t38timeout);
    ast_cli(a->fd, "\n\nFAX Technology Modules:\n\n");
    AST_RWLIST_RDLOCK(&faxmodules);
    AST_RWLIST_TRAVERSE(&faxmodules, fax, list) {
        ast_cli(a->fd, "%s (%s) Settings:\n", fax->tech->type, fax->tech->description);
        fax->tech->cli_show_settings(a->fd);
    }
    AST_RWLIST_UNLOCK(&faxmodules);
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_fax_modem_to_str(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_GENERATE, CLI_INIT, ast_fax_tech::cli_show_settings, CLI_SUCCESS, ast_cli_entry::command, ast_fax_tech::description, get_general_options(), fax_options::modems, NULL, options, fax_module::tech, ast_fax_tech::type, and ast_cli_entry::usage.

◆ cli_fax_show_stats()

static char * cli_fax_show_stats	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

display fax stats

Definition at line 4282 of file res_fax.c.

{
    struct fax_module *fax;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "fax show stats";
        e->usage =
            "Usage: fax show stats\n"
            "       Shows a statistical summary of FAX transmissions\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    ast_cli(a->fd, "\nFAX Statistics:\n---------------\n\n");
    ast_cli(a->fd, "%-20.20s : %d\n", "Current Sessions", faxregistry.active_sessions);
    ast_cli(a->fd, "%-20.20s : %d\n", "Reserved Sessions", faxregistry.reserved_sessions);
    ast_cli(a->fd, "%-20.20s : %d\n", "Transmit Attempts", faxregistry.fax_tx_attempts);
    ast_cli(a->fd, "%-20.20s : %d\n", "Receive Attempts", faxregistry.fax_rx_attempts);
    ast_cli(a->fd, "%-20.20s : %d\n", "Completed FAXes", faxregistry.fax_complete);
    ast_cli(a->fd, "%-20.20s : %d\n", "Failed FAXes", faxregistry.fax_failures);
    AST_RWLIST_RDLOCK(&faxmodules);
    AST_RWLIST_TRAVERSE(&faxmodules, fax, list) {
        fax->tech->cli_show_stats(a->fd);
    }
    AST_RWLIST_UNLOCK(&faxmodules);
    ast_cli(a->fd, "\n\n");
 
    return CLI_SUCCESS;
}

References a, ast_cli(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_GENERATE, CLI_INIT, ast_fax_tech::cli_show_stats, CLI_SUCCESS, ast_cli_entry::command, faxregistry, fax_module::list, NULL, fax_module::tech, and ast_cli_entry::usage.

◆ cli_fax_show_version()

static char * cli_fax_show_version	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Definition at line 4072 of file res_fax.c.

{
    struct fax_module *fax;
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "fax show version";
        e->usage =
            "Usage: fax show version\n"
            "       Show versions of FAX For Asterisk components.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 3) {
        return CLI_SHOWUSAGE;
    }
 
    ast_cli(a->fd, "FAX For Asterisk Components:\n");
    ast_cli(a->fd, "\tApplications: %s\n", ast_get_version());
    AST_RWLIST_RDLOCK(&faxmodules);
    AST_RWLIST_TRAVERSE(&faxmodules, fax, list) {
        ast_cli(a->fd, "\t%s: %s\n", fax->tech->description, fax->tech->version);
    }
    AST_RWLIST_UNLOCK(&faxmodules);
    ast_cli(a->fd, "\n");
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_get_version(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ast_fax_tech::description, fax_module::list, NULL, fax_module::tech, ast_cli_entry::usage, and ast_fax_tech::version.

◆ debug_check_frame_for_silence()

static void debug_check_frame_for_silence	(	struct ast_fax_session *	s,
		unsigned int	c2s,
		struct ast_frame *	frame
	)

static

Definition at line 678 of file res_fax.c.

{
    struct debug_info_history *history = c2s ? &s->debug_info->c2s : &s->debug_info->s2c;
    int dspsilence;
    unsigned int last_consec_frames, last_consec_ms;
    unsigned char wassil;
    struct timeval diff;
 
    diff = ast_tvsub(ast_tvnow(), s->debug_info->base_tv);
 
    ast_dsp_reset(s->debug_info->dsp);
    ast_dsp_silence(s->debug_info->dsp, frame, &dspsilence);
 
    wassil = history->silence;
    history->silence = (dspsilence != 0) ? 1 : 0;
    if (history->silence != wassil) {
        last_consec_frames = history->consec_frames;
        last_consec_ms = history->consec_ms;
        history->consec_frames = 0;
        history->consec_ms = 0;
 
        if ((last_consec_frames != 0)) {
            ast_verb(0, "Channel '%s' fax session '%u', [ %.3ld.%.6ld ], %s sent %u frames (%u ms) of %s.\n",
                 s->channame, s->id, (long) diff.tv_sec, (long int) diff.tv_usec,
                 (c2s) ? "channel" : "stack", last_consec_frames, last_consec_ms,
                 (wassil) ? "silence" : "energy");
        }
    }
 
    history->consec_frames++;
    history->consec_ms += (frame->samples / 8);
}

References ast_dsp_reset(), ast_dsp_silence(), ast_tvnow(), ast_tvsub(), ast_verb, ast_fax_debug_info::base_tv, ast_fax_session::channame, debug_info_history::consec_frames, debug_info_history::consec_ms, ast_fax_session::debug_info, ast_fax_debug_info::dsp, ast_fax_session::id, ast_fax_debug_info::s2c, ast_frame::samples, and debug_info_history::silence.

Referenced by generic_fax_exec().

◆ destroy_callback()

static void destroy_callback ( void * data )

static

Definition at line 711 of file res_fax.c.

{
    if (data) {
        ao2_ref(data, -1);
    }
}

References ao2_ref.

◆ destroy_faxdetect()

static void destroy_faxdetect ( void * data )

static

destroy a FAX detect structure

Definition at line 3777 of file res_fax.c.

{
    struct fax_detect *faxdetect = data;
 
    if (faxdetect->dsp) {
        ast_dsp_free(faxdetect->dsp);
        faxdetect->dsp = NULL;
    }
    ao2_cleanup(faxdetect->details);
    ao2_cleanup(faxdetect->orig_format);
}

References ao2_cleanup, ast_dsp_free(), fax_detect::details, fax_detect::dsp, NULL, and fax_detect::orig_format.

Referenced by fax_detect_new().

◆ destroy_gateway()

static void destroy_gateway ( void * data )

static

destroy a FAX gateway session structure

Definition at line 2940 of file res_fax.c.

{
    struct fax_gateway *gateway = data;
 
    destroy_v21_sessions(gateway);
 
    if (gateway->s) {
        fax_session_release(gateway->s, gateway->token);
        gateway->token = NULL;
 
        ao2_unlink(faxregistry.container, gateway->s);
 
        ao2_ref(gateway->s, -1);
        gateway->s = NULL;
    }
 
    ao2_cleanup(gateway->chan_read_format);
    ao2_cleanup(gateway->chan_write_format);
    ao2_cleanup(gateway->peer_read_format);
    ao2_cleanup(gateway->peer_write_format);
}

References ao2_cleanup, ao2_ref, ao2_unlink, fax_gateway::chan_read_format, fax_gateway::chan_write_format, destroy_v21_sessions(), fax_session_release(), faxregistry, NULL, fax_gateway::peer_read_format, fax_gateway::peer_write_format, fax_gateway::s, and fax_gateway::token.

Referenced by fax_gateway_new().

◆ destroy_session()

static void destroy_session ( void * session )

static

destroy a FAX session structure

Definition at line 1197 of file res_fax.c.

{
    struct ast_fax_session *s = session;
 
    if (s->tech) {
        fax_session_release(s, NULL);
        if (s->tech_pvt) {
            s->tech->destroy_session(s);
        }
        ast_module_unref(s->tech->module);
    }
 
    if (s->details) {
        if (s->details->caps & AST_FAX_TECH_GATEWAY) {
            s->details->caps &= ~AST_FAX_TECH_GATEWAY;
        }
        ao2_ref(s->details, -1);
        s->details = NULL;
    }
 
    if (s->debug_info) {
        ast_dsp_free(s->debug_info->dsp);
        ast_free(s->debug_info);
    }
 
    if (s->smoother) {
        ast_smoother_free(s->smoother);
    }
 
    if (s->state != AST_FAX_STATE_INACTIVE) {
        ast_atomic_fetchadd_int(&faxregistry.active_sessions, -1);
    }
 
    ast_free(s->channame);
    ast_free(s->chan_uniqueid);
}

References ao2_ref, ast_atomic_fetchadd_int(), ast_dsp_free(), AST_FAX_STATE_INACTIVE, AST_FAX_TECH_GATEWAY, ast_free, ast_module_unref, ast_smoother_free(), ast_fax_session_details::caps, ast_fax_session::chan_uniqueid, ast_fax_session::channame, ast_fax_session::debug_info, ast_fax_tech::destroy_session, ast_fax_session::details, ast_fax_debug_info::dsp, fax_session_release(), faxregistry, NULL, session, ast_fax_session::smoother, ast_fax_session::state, ast_fax_session::tech, and ast_fax_session::tech_pvt.

Referenced by fax_session_new(), and fax_session_reserve().

◆ destroy_session_details()

static void destroy_session_details ( void * details )

static

destroy a FAX session details structure

Definition at line 785 of file res_fax.c.

{
    struct ast_fax_session_details *d = details;
    struct ast_fax_document *doc;
 
    while ((doc = AST_LIST_REMOVE_HEAD(&d->documents, next))) {
        ast_free(doc);
    }
    ast_string_field_free_memory(d);
}

References ast_free, AST_LIST_REMOVE_HEAD, ast_string_field_free_memory, d, and ast_fax_document::next.

Referenced by session_details_new().

◆ destroy_v21_sessions()

static void destroy_v21_sessions ( struct fax_gateway * gateway )

static

destroy the v21 detection parts of a fax gateway session

Definition at line 2922 of file res_fax.c.

{
    if (gateway->chan_v21_session) {
        ao2_unlink(faxregistry.container, gateway->chan_v21_session);
 
        ao2_ref(gateway->chan_v21_session, -1);
        gateway->chan_v21_session = NULL;
    }
 
    if (gateway->peer_v21_session) {
        ao2_unlink(faxregistry.container, gateway->peer_v21_session);
 
        ao2_ref(gateway->peer_v21_session, -1);
        gateway->peer_v21_session = NULL;
    }
}

References ao2_ref, ao2_unlink, fax_gateway::chan_v21_session, faxregistry, NULL, and fax_gateway::peer_v21_session.

Referenced by destroy_gateway(), fax_gateway_detect_v21(), and fax_gateway_start().

◆ disable_t38()

static int disable_t38 ( struct ast_channel * chan )

static

Definition at line 1628 of file res_fax.c.

{
    int timeout_ms;
    struct ast_frame *frame = NULL;
    struct ast_control_t38_parameters t38_parameters = { .request_response = AST_T38_REQUEST_TERMINATE, };
    struct timeval start;
    int ms;
 
    ast_debug(1, "Shutting down T.38 on %s\n", ast_channel_name(chan));
    if (ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters)) != 0) {
        ast_debug(1, "error while disabling T.38 on channel '%s'\n", ast_channel_name(chan));
        return -1;
    }
 
    /* wait up to five seconds for negotiation to complete */
    timeout_ms = 5000;
    start = ast_tvnow();
    while ((ms = ast_remaining_ms(start, timeout_ms))) {
        ms = ast_waitfor(chan, ms);
 
        if (ms == 0) {
            break;
        }
        if (ms < 0) {
            ast_debug(1, "error while disabling T.38 on channel '%s'\n", ast_channel_name(chan));
            return -1;
        }
 
        if (!(frame = ast_read(chan))) {
            return -1;
        }
        if ((frame->frametype == AST_FRAME_CONTROL) &&
            (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
            (frame->datalen == sizeof(t38_parameters))) {
            struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
            switch (parameters->request_response) {
            case AST_T38_TERMINATED:
                ast_debug(1, "Shut down T.38 on %s\n", ast_channel_name(chan));
                break;
            case AST_T38_REFUSED:
                ast_log(LOG_WARNING, "channel '%s' refused to disable T.38\n", ast_channel_name(chan));
                ast_frfree(frame);
                return -1;
            default:
                ast_log(LOG_ERROR, "channel '%s' failed to disable T.38\n", ast_channel_name(chan));
                ast_frfree(frame);
                return -1;
            }
            ast_frfree(frame);
            break;
        }
        ast_frfree(frame);
    }
 
    if (ms == 0) { /* all done, nothing happened */
        ast_debug(1, "channel '%s' timed-out during T.38 shutdown\n", ast_channel_name(chan));
    }
 
    return 0;
}

References ast_channel_name(), AST_CONTROL_T38_PARAMETERS, ast_debug, AST_FRAME_CONTROL, ast_frfree, ast_indicate_data(), ast_log, ast_read(), ast_remaining_ms(), AST_T38_REFUSED, AST_T38_REQUEST_TERMINATE, AST_T38_TERMINATED, ast_tvnow(), ast_waitfor(), ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame_subclass::integer, LOG_ERROR, LOG_WARNING, NULL, ast_frame::ptr, ast_control_t38_parameters::request_response, and ast_frame::subclass.

Referenced by receivefax_exec(), and sendfax_exec().

◆ fax_detect_attach()

static int fax_detect_attach	(	struct ast_channel *	chan,
		int	timeout,
		int	flags
	)

static

Attach a faxdetect framehook object to a channel.

Parameters

chan	the channel to attach to
timeout	in ms to remove framehook in this time if not zero

Returns: the faxdetect structure or NULL on error

Parameters

flags required options

Return values

-1 error

Definition at line 3990 of file res_fax.c.

{
    struct fax_detect *faxdetect;
    struct ast_fax_session_details *details;
    struct ast_framehook_interface fr_hook = {
        .version = AST_FRAMEHOOK_INTERFACE_VERSION,
        .event_cb = fax_detect_framehook,
        .destroy_cb = fax_detect_framehook_destroy,
    };
 
    if (!(details = find_or_create_details(chan))) {
        ast_log(LOG_ERROR, "System cannot provide memory for session requirements.\n");
        return -1;
    }
 
    /* set up the frame hook*/
    faxdetect = fax_detect_new(chan, timeout, flags);
    if (!faxdetect) {
        ao2_ref(details, -1);
        return -1;
    }
 
    fr_hook.data = faxdetect;
    faxdetect->details = details;
    ast_channel_lock(chan);
    details->faxdetect_id = ast_framehook_attach(chan, &fr_hook);
    details->faxdetect_timeout = timeout;
    details->faxdetect_flags = flags;
    ast_channel_unlock(chan);
 
    if (details->faxdetect_id < 0) {
        ao2_ref(faxdetect, -1);
    }
 
    return details->faxdetect_id;
}

References ao2_ref, ast_channel_lock, ast_channel_unlock, ast_framehook_attach(), AST_FRAMEHOOK_INTERFACE_VERSION, ast_log, ast_framehook_interface::data, fax_detect::details, fax_detect_framehook(), fax_detect_framehook_destroy(), fax_detect_new(), ast_fax_session_details::faxdetect_flags, ast_fax_session_details::faxdetect_id, ast_fax_session_details::faxdetect_timeout, find_or_create_details(), LOG_ERROR, and ast_framehook_interface::version.

Referenced by acf_faxopt_write(), and fixup_callback().

◆ fax_detect_framehook()

static struct ast_frame * fax_detect_framehook	(	struct ast_channel *	chan,
		struct ast_frame *	f,
		enum ast_framehook_event	event,
		void *	data
	)

static

Fax Detect Framehook.

Listen for fax tones in audio path and enable jumping to a extension when detected.

Parameters

chan	channel
f	frame to handle may be NULL
event	framehook event
data	framehook data (struct fax_detect *)

Returns: processed frame or NULL when f is NULL or a null frame

Definition at line 3846 of file res_fax.c.

{
    struct fax_detect *faxdetect = data;
    struct ast_fax_session_details *details;
    struct ast_control_t38_parameters *control_params;
    RAII_VAR(struct ast_channel *, peer, NULL, ao2_cleanup);
    RAII_VAR(struct ast_channel *, chan_ref, chan, ao2_cleanup);
    int result = 0;
 
    /* Ref bump the channel for when we have to unlock it */
    ao2_ref(chan, 1);
 
    details = faxdetect->details;
 
    switch (event) {
    case AST_FRAMEHOOK_EVENT_ATTACHED:
        /* Setup format for DSP on ATTACH*/
        ao2_replace(faxdetect->orig_format, ast_channel_readformat(chan));
 
        if ((ast_format_cmp(ast_channel_readformat(chan), ast_format_slin) != AST_FORMAT_CMP_EQUAL) &&
            (ast_format_cmp(ast_channel_readformat(chan), ast_format_alaw) != AST_FORMAT_CMP_EQUAL) &&
            (ast_format_cmp(ast_channel_readformat(chan), ast_format_ulaw) != AST_FORMAT_CMP_EQUAL)) {
            if (ast_set_read_format(chan, ast_format_slin)) {
                ast_framehook_detach(chan, details->faxdetect_id);
                details->faxdetect_id = -1;
                return f;
            }
        }
 
        return NULL;
    case AST_FRAMEHOOK_EVENT_DETACHED:
        /* restore audio formats when we are detached */
        ast_set_read_format(chan, faxdetect->orig_format);
        ast_channel_unlock(chan);
        peer = ast_channel_bridge_peer(chan);
        if (peer) {
            ast_channel_make_compatible(chan, peer);
        }
        ast_channel_lock(chan);
        return NULL;
    case AST_FRAMEHOOK_EVENT_READ:
        if (f) {
            break;
        }
    default:
        return f;
    };
 
    if (details->faxdetect_id < 0) {
        return f;
    }
 
    if (!ast_tvzero(faxdetect->timeout_start)
        && ast_tvdiff_ms(ast_tvnow(), faxdetect->timeout_start) > details->faxdetect_timeout) {
        ast_debug(1, "FAXOPT(faxdetect) timeout on %s\n", ast_channel_name(chan));
        ast_framehook_detach(chan, details->faxdetect_id);
        details->faxdetect_id = -1;
        return f;
    }
 
    /* only handle VOICE and CONTROL frames*/
    switch (f->frametype) {
    case AST_FRAME_VOICE:
        /* we have no DSP this means we not detecting CNG */
        if (!faxdetect->dsp) {
            return f;
        }
        /* We can only process some formats*/
        if ((ast_format_cmp(f->subclass.format, ast_format_slin) != AST_FORMAT_CMP_EQUAL) &&
            (ast_format_cmp(f->subclass.format, ast_format_alaw) != AST_FORMAT_CMP_EQUAL) &&
            (ast_format_cmp(f->subclass.format, ast_format_ulaw) != AST_FORMAT_CMP_EQUAL)) {
            return f;
        }
        break;
    case AST_FRAME_CONTROL:
        if ((f->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
            (faxdetect->flags & FAX_DETECT_MODE_T38)) {
            break;
        }
        return f;
    default:
        return f;
    }
 
    if (f->frametype == AST_FRAME_VOICE) {
        f = ast_dsp_process(chan, faxdetect->dsp, f);
        if (f->frametype == AST_FRAME_DTMF) {
            result = f->subclass.integer;
        }
    } else if ((f->frametype == AST_FRAME_CONTROL) && (f->datalen == sizeof(struct ast_control_t38_parameters))) {
        control_params = f->data.ptr;
        switch (control_params->request_response) {
        case AST_T38_NEGOTIATED:
        case AST_T38_REQUEST_NEGOTIATE:
            result = 't';
            break;
        default:
            break;
        }
    }
 
    if (result) {
        const char *target_context;
 
        switch (result) {
        case 'f':
        case 't':
            target_context = ast_channel_context(chan);
 
            ast_channel_unlock(chan);
            ast_frfree(f);
            f = &ast_null_frame;
            if (ast_exists_extension(chan, target_context, "fax", 1,
                S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
                ast_verb(2, "Redirecting '%s' to fax extension due to %s detection\n",
                    ast_channel_name(chan), (result == 'f') ? "CNG" : "T38");
                pbx_builtin_setvar_helper(chan, "FAXEXTEN", ast_channel_exten(chan));
                if (ast_async_goto(chan, target_context, "fax", 1)) {
                    ast_log(LOG_NOTICE, "Failed to async goto '%s' into fax of '%s'\n", ast_channel_name(chan), target_context);
                }
            } else {
                ast_log(LOG_NOTICE, "FAX %s detected but no fax extension in context (%s)\n",
                    (result == 'f') ? "CNG" : "T38", target_context);
            }
            ast_channel_lock(chan);
 
            ast_framehook_detach(chan, details->faxdetect_id);
            details->faxdetect_id = -1;
            break;
        default:
            break;
        }
    }
 
    return f;
}

References ao2_cleanup, ao2_ref, ao2_replace, ast_async_goto(), ast_channel_bridge_peer(), ast_channel_caller(), ast_channel_context(), ast_channel_exten(), ast_channel_lock, ast_channel_make_compatible(), ast_channel_name(), ast_channel_readformat(), ast_channel_unlock, AST_CONTROL_T38_PARAMETERS, ast_debug, ast_dsp_process(), ast_exists_extension(), ast_format_alaw, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_slin, ast_format_ulaw, AST_FRAME_CONTROL, AST_FRAME_DTMF, AST_FRAME_VOICE, ast_framehook_detach(), AST_FRAMEHOOK_EVENT_ATTACHED, AST_FRAMEHOOK_EVENT_DETACHED, AST_FRAMEHOOK_EVENT_READ, ast_frfree, ast_log, ast_null_frame, ast_set_read_format(), AST_T38_NEGOTIATED, AST_T38_REQUEST_NEGOTIATE, ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), ast_verb, ast_frame::data, ast_frame::datalen, fax_detect::details, fax_detect::dsp, FAX_DETECT_MODE_T38, ast_fax_session_details::faxdetect_id, ast_fax_session_details::faxdetect_timeout, fax_detect::flags, ast_frame_subclass::format, ast_frame::frametype, ast_frame_subclass::integer, LOG_NOTICE, NULL, fax_detect::orig_format, pbx_builtin_setvar_helper(), ast_frame::ptr, RAII_VAR, ast_control_t38_parameters::request_response, result, S_COR, ast_frame::subclass, and fax_detect::timeout_start.

Referenced by fax_detect_attach().

◆ fax_detect_framehook_destroy()

static void fax_detect_framehook_destroy ( void * data )

static

Deref the faxdetect data structure when the faxdetect framehook is detached.

Parameters

data	framehook data (faxdetect data)

Definition at line 3828 of file res_fax.c.

{
    struct fax_detect *faxdetect = data;
 
    ao2_ref(faxdetect, -1);
}

References ao2_ref.

Referenced by fax_detect_attach().

◆ fax_detect_new()

static struct fax_detect * fax_detect_new	(	struct ast_channel *	chan,
		int	timeout,
		int	flags
	)

static

Create a new fax detect object.

Parameters

chan	the channel attaching to
timeout	in ms to remove framehook in this time if not zero
flags	required options

Returns: NULL or a fax gateway object

Definition at line 3795 of file res_fax.c.

{
    struct fax_detect *faxdetect = ao2_alloc(sizeof(*faxdetect), destroy_faxdetect);
    if (!faxdetect) {
        return NULL;
    }
 
    faxdetect->flags = flags;
 
    if (timeout) {
        faxdetect->timeout_start = ast_tvnow();
    } else {
        faxdetect->timeout_start.tv_sec = 0;
        faxdetect->timeout_start.tv_usec = 0;
    }
 
    if (faxdetect->flags & FAX_DETECT_MODE_CNG) {
        faxdetect->dsp = ast_dsp_new();
        if (!faxdetect->dsp) {
            ao2_ref(faxdetect, -1);
            return NULL;
        }
        ast_dsp_set_features(faxdetect->dsp, DSP_FEATURE_FAX_DETECT);
        ast_dsp_set_faxmode(faxdetect->dsp, DSP_FAXMODE_DETECT_CNG | DSP_FAXMODE_DETECT_SQUELCH);
    } else {
        faxdetect->dsp = NULL;
    }
 
    return faxdetect;
}

References ao2_alloc, ao2_ref, ast_dsp_new(), ast_dsp_set_faxmode(), ast_dsp_set_features(), ast_tvnow(), destroy_faxdetect(), fax_detect::dsp, DSP_FAXMODE_DETECT_CNG, DSP_FAXMODE_DETECT_SQUELCH, DSP_FEATURE_FAX_DETECT, FAX_DETECT_MODE_CNG, fax_detect::flags, NULL, and fax_detect::timeout_start.

Referenced by fax_detect_attach().

◆ fax_gateway_attach()

static int fax_gateway_attach	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Attach a gateway framehook object to a channel.

Parameters

chan	the channel to attach to
details	fax session details

Returns: the framehook id of the attached framehook or -1 on error

Return values

-1 error

Definition at line 3727 of file res_fax.c.

{
    struct fax_gateway *gateway;
    struct ast_framehook_interface fr_hook = {
        .version = AST_FRAMEHOOK_INTERFACE_VERSION,
        .event_cb = fax_gateway_framehook,
        .destroy_cb = fax_gateway_framehook_destroy,
        .disable_inheritance = 1, /* Masquerade inheritance is handled through the datastore fixup */
    };
 
    if (global_fax_debug) {
        details->option.debug = AST_FAX_OPTFLAG_TRUE;
    }
 
    ast_string_field_set(details, result, "SUCCESS");
    ast_string_field_set(details, resultstr, "gateway operation started successfully");
    ast_string_field_set(details, error, "NO_ERROR");
    set_channel_variables(chan, details);
 
    /* set up the frame hook*/
    gateway = fax_gateway_new(chan, details);
    if (!gateway) {
        ast_string_field_set(details, result, "FAILED");
        ast_string_field_set(details, resultstr, "error initializing gateway session");
        ast_string_field_set(details, error, "INIT_ERROR");
        details->is_t38_negotiated = 0;
        set_channel_variables(chan, details);
        report_fax_status(chan, details, "No Available Resource");
        return -1;
    }
 
    fr_hook.data = gateway;
    ast_channel_lock(chan);
    gateway->framehook = ast_framehook_attach(chan, &fr_hook);
    ast_channel_unlock(chan);
 
    if (gateway->framehook < 0) {
        ao2_ref(gateway, -1);
        ast_string_field_set(details, result, "FAILED");
        ast_string_field_set(details, resultstr, "error attaching gateway to channel");
        ast_string_field_set(details, error, "INIT_ERROR");
        details->is_t38_negotiated = 0;
        set_channel_variables(chan, details);
        return -1;
    }
 
    return gateway->framehook;
}

References ao2_ref, ast_channel_lock, ast_channel_unlock, AST_FAX_OPTFLAG_TRUE, ast_framehook_attach(), AST_FRAMEHOOK_INTERFACE_VERSION, ast_string_field_set, ast_framehook_interface::data, ast_fax_session_details::debug, error(), fax_gateway_framehook(), fax_gateway_framehook_destroy(), fax_gateway_new(), fax_gateway::framehook, global_fax_debug, ast_fax_session_details::is_t38_negotiated, ast_fax_session_details::option, report_fax_status(), result, set_channel_variables(), and ast_framehook_interface::version.

Referenced by acf_faxopt_write(), and fixup_callback().

◆ fax_gateway_detect_t38()

static struct ast_frame * fax_gateway_detect_t38	(	struct fax_gateway *	gateway,
		struct ast_channel *	chan,
		struct ast_channel *	peer,
		struct ast_channel *	active,
		struct ast_frame *	f
	)

static

T38 Gateway Negotiate t38 parameters.

Parameters

gateway	gateway object
chan	channel running the gateway
peer	channel im bridged too
active	channel the frame originated on
f	the control frame to process

Precondition: chan is locked on entry

Returns: processed control frame or null frame

Definition at line 3210 of file res_fax.c.

{
    struct ast_control_t38_parameters *control_params = f->data.ptr;
    struct ast_channel *other = (active == chan) ? peer : chan;
    struct ast_fax_session_details *details;
    enum ast_t38_state state_other;
 
    if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
        /* invalaid AST_CONTROL_T38_PARAMETERS frame, we can't
         * do anything with it, pass it on */
        return f;
    }
 
    /* ignore frames from ourselves */
    if ((gateway->t38_state == T38_STATE_NEGOTIATED && control_params->request_response == AST_T38_NEGOTIATED)
        || (gateway->t38_state == T38_STATE_REJECTED && control_params->request_response == AST_T38_REFUSED)
        || (gateway->t38_state == T38_STATE_NEGOTIATING && control_params->request_response == AST_T38_REQUEST_TERMINATE)) {
 
        return f;
    }
 
    if (!(details = find_details(chan))) {
        ast_log(LOG_ERROR, "no FAX session details found on chan %s for T.38 gateway session, odd\n", ast_channel_name(chan));
        ast_framehook_detach(chan, gateway->framehook);
        return f;
    }
 
    if (control_params->request_response == AST_T38_REQUEST_NEGOTIATE) {
        ast_channel_unlock(chan);
        state_other = ast_channel_get_t38_state(other);
        ast_channel_lock(chan);
 
        if (state_other == T38_STATE_UNKNOWN) {
            /* we detected a request to negotiate T.38 and the
             * other channel appears to support T.38, we'll pass
             * the request through and only step in if the other
             * channel rejects the request */
            ast_debug(1, "%s is attempting to negotiate T.38 with %s, we'll see what happens\n", ast_channel_name(active), ast_channel_name(other));
            t38_parameters_ast_to_fax(&details->their_t38_parameters, control_params);
            gateway->t38_state = T38_STATE_UNKNOWN;
            gateway->timeout_start = ast_tvnow();
            details->is_t38_negotiated = 0;
            details->gateway_timeout = FAX_GATEWAY_TIMEOUT;
            ao2_ref(details, -1);
            return f;
        } else if (state_other == T38_STATE_UNAVAILABLE || state_other == T38_STATE_REJECTED) {
            /* the other channel does not support T.38, we need to
             * step in here */
            ast_debug(1, "%s is attempting to negotiate T.38 but %s does not support it\n", ast_channel_name(active), ast_channel_name(other));
            ast_debug(1, "starting T.38 gateway for T.38 channel %s and G.711 channel %s\n", ast_channel_name(active), ast_channel_name(other));
 
            t38_parameters_ast_to_fax(&details->their_t38_parameters, control_params);
            t38_parameters_fax_to_ast(control_params, &details->our_t38_parameters);
 
            if (fax_gateway_start(gateway, details, chan)) {
                ast_log(LOG_ERROR, "error starting T.38 gateway for T.38 channel %s and G.711 channel %s\n", ast_channel_name(active), ast_channel_name(other));
                gateway->t38_state = T38_STATE_REJECTED;
                details->is_t38_negotiated = 0;
                control_params->request_response = AST_T38_REFUSED;
 
                ast_framehook_detach(chan, details->gateway_id);
                details->gateway_id = -1;
            } else {
                gateway->t38_state = T38_STATE_NEGOTIATED;
                details->is_t38_negotiated = chan == active;
                control_params->request_response = AST_T38_NEGOTIATED;
                report_fax_status(chan, details, "T.38 Negotiated");
            }
 
            fax_gateway_indicate_t38(chan, active, control_params);
 
            ao2_ref(details, -1);
            return &ast_null_frame;
        } else if (gateway->t38_state == T38_STATE_NEGOTIATING) {
            /* we got a request to negotiate T.38 after we already
             * sent one to the other party based on v21 preamble
             * detection. We'll just pretend we passed this request
             * through in the first place. */
 
            t38_parameters_ast_to_fax(&details->their_t38_parameters, control_params);
            gateway->t38_state = T38_STATE_UNKNOWN;
            gateway->timeout_start = ast_tvnow();
            details->is_t38_negotiated = 0;
            details->gateway_timeout = FAX_GATEWAY_TIMEOUT;
 
            ast_debug(1, "%s is attempting to negotiate T.38 after we already sent a negotiation request based on v21 preamble detection\n", ast_channel_name(active));
            ao2_ref(details, -1);
            return &ast_null_frame;
        } else if (gateway->t38_state == T38_STATE_NEGOTIATED) {
            /* we got a request to negotiate T.38 after we already
             * sent one to the other party based on v21 preamble
             * detection and received a response. We need to
             * respond to this and shut down the gateway. */
 
            t38_parameters_fax_to_ast(control_params, &details->their_t38_parameters);
            ast_framehook_detach(chan, details->gateway_id);
            details->gateway_id = -1;
 
            control_params->request_response = AST_T38_NEGOTIATED;
 
            fax_gateway_indicate_t38(chan, active, control_params);
 
            ast_string_field_set(details, result, "SUCCESS");
            ast_string_field_set(details, resultstr, "no gateway necessary");
            ast_string_field_set(details, error, "NATIVE_T38");
            details->is_t38_negotiated = 1;
            set_channel_variables(chan, details);
 
            ast_debug(1, "%s is attempting to negotiate T.38 after we already negotiated T.38 with %s, disabling the gateway\n", ast_channel_name(active), ast_channel_name(other));
            ao2_ref(details, -1);
            return &ast_null_frame;
        } else {
            ast_log(LOG_WARNING, "%s is attempting to negotiate T.38 while %s is in an unsupported state\n", ast_channel_name(active), ast_channel_name(other));
            ao2_ref(details, -1);
            return f;
        }
    } else if (gateway->t38_state == T38_STATE_NEGOTIATING
        && control_params->request_response == AST_T38_REFUSED) {
 
        ast_debug(1, "unable to negotiate T.38 on %s for fax gateway\n", ast_channel_name(active));
        details->is_t38_negotiated = 0;
 
        /* our request to negotiate T.38 was refused, if the other
         * channel supports T.38, they might still reinvite and save
         * the day.  Otherwise disable the gateway. */
        ast_channel_unlock(chan);
        state_other = ast_channel_get_t38_state(other);
        ast_channel_lock(chan);
        if (state_other == T38_STATE_UNKNOWN) {
            gateway->t38_state = T38_STATE_UNAVAILABLE;
        } else if (state_other != T38_STATE_NEGOTIATING) {
            ast_framehook_detach(chan, details->gateway_id);
            details->gateway_id = -1;
 
            ast_string_field_set(details, result, "FAILED");
            ast_string_field_set(details, resultstr, "unable to negotiate T.38");
            ast_string_field_set(details, error, "T38_NEG_ERROR");
            set_channel_variables(chan, details);
        }
 
        ao2_ref(details, -1);
        return &ast_null_frame;
    } else if (gateway->t38_state == T38_STATE_NEGOTIATING
        && control_params->request_response == AST_T38_NEGOTIATED) {
 
        ast_debug(1, "starting T.38 gateway for T.38 channel %s and G.711 channel %s\n", ast_channel_name(active), ast_channel_name(other));
 
        t38_parameters_ast_to_fax(&details->their_t38_parameters, control_params);
 
        if (fax_gateway_start(gateway, details, chan)) {
            ast_log(LOG_ERROR, "error starting T.38 gateway for T.38 channel %s and G.711 channel %s\n", ast_channel_name(active), ast_channel_name(other));
            gateway->t38_state = T38_STATE_NEGOTIATING;
            details->is_t38_negotiated = 0;
            control_params->request_response = AST_T38_REQUEST_TERMINATE;
 
            fax_gateway_indicate_t38(chan, active, control_params);
        } else {
            gateway->t38_state = T38_STATE_NEGOTIATED;
            details->is_t38_negotiated = chan == active;
            report_fax_status(chan, details, "T.38 Negotiated");
        }
 
        ao2_ref(details, -1);
        return &ast_null_frame;
    } else if (control_params->request_response == AST_T38_REFUSED) {
        /* the other channel refused the request to negotiate T.38,
         * we'll step in here and pretend the request was accepted */
 
        ast_debug(1, "%s attempted to negotiate T.38 but %s refused the request\n", ast_channel_name(other), ast_channel_name(active));
        ast_debug(1, "starting T.38 gateway for T.38 channel %s and G.711 channel %s\n", ast_channel_name(other), ast_channel_name(active));
 
        t38_parameters_fax_to_ast(control_params, &details->our_t38_parameters);
 
        if (fax_gateway_start(gateway, details, chan)) {
            ast_log(LOG_ERROR, "error starting T.38 gateway for T.38 channel %s and G.711 channel %s\n", ast_channel_name(other), ast_channel_name(active));
            gateway->t38_state = T38_STATE_REJECTED;
            details->is_t38_negotiated = 0;
            control_params->request_response = AST_T38_REFUSED;
 
            ast_framehook_detach(chan, details->gateway_id);
            details->gateway_id = -1;
        } else {
            gateway->t38_state = T38_STATE_NEGOTIATED;
            details->is_t38_negotiated = chan == other;
            control_params->request_response = AST_T38_NEGOTIATED;
        }
 
        ao2_ref(details, -1);
        return f;
    } else if (control_params->request_response == AST_T38_REQUEST_TERMINATE) {
        /* the channel wishes to end our short relationship, we shall
         * oblige */
 
        ast_debug(1, "T.38 channel %s is requesting a shutdown of T.38, disabling the gateway\n", ast_channel_name(active));
 
        ast_framehook_detach(chan, details->gateway_id);
        details->gateway_id = -1;
 
        gateway->t38_state = T38_STATE_REJECTED;
        details->is_t38_negotiated = 0;
        control_params->request_response = AST_T38_TERMINATED;
 
        fax_gateway_indicate_t38(chan, active, control_params);
 
        ao2_ref(details, -1);
        return &ast_null_frame;
    } else if (control_params->request_response == AST_T38_NEGOTIATED) {
        ast_debug(1, "T.38 successfully negotiated between %s and %s, no gateway necessary\n", ast_channel_name(active), ast_channel_name(other));
 
        ast_framehook_detach(chan, details->gateway_id);
        details->gateway_id = -1;
 
        ast_string_field_set(details, result, "SUCCESS");
        ast_string_field_set(details, resultstr, "no gateway necessary");
        ast_string_field_set(details, error, "NATIVE_T38");
        details->is_t38_negotiated = 1;
        set_channel_variables(chan, details);
 
        ao2_ref(details, -1);
        return f;
    } else if (control_params->request_response == AST_T38_TERMINATED) {
        ast_debug(1, "T.38 disabled on channel %s\n", ast_channel_name(active));
 
        ast_framehook_detach(chan, details->gateway_id);
        details->gateway_id = -1;
 
        ao2_ref(details, -1);
        return &ast_null_frame;
    }
 
    ao2_ref(details, -1);
    return f;
}

References ao2_ref, ast_channel_get_t38_state(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_debug, ast_framehook_detach(), ast_log, ast_null_frame, ast_string_field_set, AST_T38_NEGOTIATED, AST_T38_REFUSED, AST_T38_REQUEST_NEGOTIATE, AST_T38_REQUEST_TERMINATE, AST_T38_TERMINATED, ast_tvnow(), ast_frame::data, ast_frame::datalen, ast_fax_session_details::error, fax_gateway_indicate_t38(), fax_gateway_start(), FAX_GATEWAY_TIMEOUT, find_details(), fax_gateway::framehook, ast_fax_session_details::gateway_id, ast_fax_session_details::gateway_timeout, ast_fax_session_details::is_t38_negotiated, LOG_ERROR, LOG_WARNING, ast_fax_session_details::our_t38_parameters, ast_frame::ptr, report_fax_status(), ast_control_t38_parameters::request_response, result, ast_fax_session_details::resultstr, set_channel_variables(), t38_parameters_ast_to_fax(), t38_parameters_fax_to_ast(), fax_gateway::t38_state, T38_STATE_NEGOTIATED, T38_STATE_NEGOTIATING, T38_STATE_REJECTED, T38_STATE_UNAVAILABLE, T38_STATE_UNKNOWN, ast_fax_session_details::their_t38_parameters, and fax_gateway::timeout_start.

Referenced by fax_gateway_framehook().

◆ fax_gateway_detect_v21()

static struct ast_frame * fax_gateway_detect_v21	(	struct fax_gateway *	gateway,
		struct ast_channel *	chan,
		struct ast_channel *	peer,
		struct ast_channel *	active,
		struct ast_frame *	f
	)

static

Precondition: chan is locked on entry

Definition at line 3113 of file res_fax.c.

{
    struct ast_channel *other = (active == chan) ? peer : chan;
    struct ast_fax_session *active_v21_session = (active == chan) ? gateway->chan_v21_session : gateway->peer_v21_session;
 
    if (!active_v21_session || gateway->detected_v21) {
        return f;
    }
 
    if (active_v21_session->tech->write(active_v21_session, f) == 0 &&
        active_v21_session->details->option.v21_detected) {
        gateway->detected_v21 = 1;
    }
 
    if (gateway->detected_v21) {
        enum ast_t38_state state_other;
        enum ast_t38_state state_active;
        struct ast_frame *fp;
        struct ast_fax_session_details *details;
        int negotiate_both = 0;
 
        /*
         * The default behavior is to wait for the active endpoint to initiate negotiation.
         * Find out if this has been overridden. If so, instead of waiting have Asterisk
         * initiate the negotiation requests out to both endpoints.
         */
        details = find_or_create_details(active);
        if (details) {
            negotiate_both = details->negotiate_both;
            ao2_ref(details, -1);
        } else {
            ast_log(LOG_WARNING, "Detect v21 - no session details for channel '%s'\n",
                    ast_channel_name(chan));
        }
 
        destroy_v21_sessions(gateway);
 
        ast_channel_unlock(chan);
        state_active = ast_channel_get_t38_state(active);
        state_other = ast_channel_get_t38_state(other);
        ast_channel_lock(chan);
 
        ast_debug(1, "detected v21 preamble from %s\n", ast_channel_name(active));
 
        if (state_active == T38_STATE_UNKNOWN || state_other == T38_STATE_UNKNOWN) {
            if (!(fp = fax_gateway_request_t38(gateway, chan))) {
                return f;
            }
            /* May be called endpoint is improperly configured to rely on the calling endpoint
             * to initiate T.38 re-INVITEs, send T.38 negotiation request to called endpoint */
            if (negotiate_both && state_active == T38_STATE_UNKNOWN) {
                ast_debug(1, "sending T.38 negotiation request to %s\n", ast_channel_name(active));
                if (active == chan) {
                    ast_channel_unlock(chan);
                }
                ast_write(active, fp);
                if (active == chan) {
                    ast_channel_lock(chan);
                }
            }
            if (state_other == T38_STATE_UNKNOWN) {
                ast_debug(1, "sending T.38 negotiation request to %s\n", ast_channel_name(other));
                return fp;
            }
        } else {
            ast_debug(1, "neither %s nor %s support T.38 for T.38 gateway session\n", ast_channel_name(active), ast_channel_name(other));
        }
    }
 
    return f;
}

References ao2_ref, ast_channel_get_t38_state(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_debug, ast_log, ast_write(), ast_fax_session::chan, fax_gateway::chan_v21_session, destroy_v21_sessions(), ast_fax_session::details, fax_gateway::detected_v21, fax_gateway_request_t38(), find_or_create_details(), LOG_WARNING, ast_fax_session_details::negotiate_both, ast_fax_session_details::option, fax_gateway::peer_v21_session, T38_STATE_UNKNOWN, ast_fax_session::tech, ast_fax_session_details::v21_detected, and ast_fax_tech::write.

Referenced by fax_gateway_framehook().

◆ fax_gateway_framehook()

static struct ast_frame * fax_gateway_framehook	(	struct ast_channel *	chan,
		struct ast_frame *	f,
		enum ast_framehook_event	event,
		void *	data
	)

static

T.30<->T.38 gateway framehook.

Intercept packets on bridged channels and determine if a T.38 gateway is required. If a gateway is required, start a gateway and handle T.38 negotiation if necessary.

Parameters

chan	channel running the gateway
f	frame to handle may be NULL
event	framehook event
data	framehook data (struct fax_gateway *)

Precondition: chan is locked on entry

Returns: processed frame or NULL when f is NULL or a null frame

Definition at line 3484 of file res_fax.c.

{
    struct fax_gateway *gateway = data;
    struct ast_channel *active;
    RAII_VAR(struct ast_fax_session_details *, details, NULL, ao2_cleanup);
    RAII_VAR(struct ast_channel *, peer, NULL, ao2_cleanup);
    RAII_VAR(struct ast_channel *, chan_ref, chan, ao2_cleanup);
 
    /* Ref bump channel for when we have to unlock it */
    ao2_ref(chan_ref, 1);
 
    if (gateway->s) {
        details = gateway->s->details;
        ao2_ref(details, 1);
    } else {
        if (!(details = find_details(chan))) {
            ast_log(LOG_ERROR, "no FAX session details found on chan %s for T.38 gateway session, odd\n", ast_channel_name(chan));
            ast_framehook_detach(chan, gateway->framehook);
            return f;
        }
    }
 
    /* restore audio formats when we are detached */
    if (event == AST_FRAMEHOOK_EVENT_DETACHED) {
        set_channel_variables(chan, details);
 
        if (gateway->bridged) {
            ast_set_read_format(chan, gateway->chan_read_format);
            ast_set_write_format(chan, gateway->chan_write_format);
 
            ast_channel_unlock(chan);
            peer = ast_channel_bridge_peer(chan);
            if (peer) {
                ast_set_read_format(peer, gateway->peer_read_format);
                ast_set_write_format(peer, gateway->peer_write_format);
                ast_channel_make_compatible(chan, peer);
            }
            ast_channel_lock(chan);
        }
        return NULL;
    }
 
    if (!f || (event == AST_FRAMEHOOK_EVENT_ATTACHED)) {
        return NULL;
    };
 
    /* this frame was generated by the fax gateway, pass it on */
    if (ast_test_flag(f, AST_FAX_FRFLAG_GATEWAY)) {
        return f;
    }
 
    /* If we aren't bridged or we don't have a peer, don't do anything */
    ast_channel_unlock(chan);
    peer = ast_channel_bridge_peer(chan);
    ast_channel_lock(chan);
    if (!peer) {
        return f;
    }
 
    if (!gateway->bridged) {
        enum ast_t38_state state_chan;
        enum ast_t38_state state_peer;
        int chan_is_hungup;
        int peer_is_hungup;
 
        chan_is_hungup = ast_check_hangup(chan);
        peer_is_hungup = ast_check_hangup(peer);
        /* Don't start a gateway if either channel is hung up */
        if (chan_is_hungup || peer_is_hungup) {
            return f;
        }
 
        ast_channel_unlock(chan);
        state_chan = ast_channel_get_t38_state(chan);
        state_peer = ast_channel_get_t38_state(peer);
        ast_channel_lock(chan);
 
        /* don't start a gateway if neither channel can handle T.38 */
        if (state_chan == T38_STATE_UNAVAILABLE && state_peer == T38_STATE_UNAVAILABLE) {
            ast_debug(1, "not starting gateway for %s and %s; neither channel supports T.38\n", ast_channel_name(chan), ast_channel_name(peer));
            ast_framehook_detach(chan, gateway->framehook);
            details->gateway_id = -1;
 
            ast_string_field_set(details, result, "FAILED");
            ast_string_field_set(details, resultstr, "neither channel supports T.38");
            ast_string_field_set(details, error, "T38_NEG_ERROR");
            details->is_t38_negotiated = 0;
            set_channel_variables(chan, details);
            return f;
        }
 
        if (details->gateway_timeout) {
            gateway->timeout_start = ast_tvnow();
        }
 
        ast_channel_unlock(chan);
        ast_channel_lock_both(chan, peer);
 
        /* we are bridged, change r/w formats to SLIN for v21 preamble
         * detection and T.30 */
        ao2_replace(gateway->chan_read_format, ast_channel_readformat(chan));
        ao2_replace(gateway->chan_write_format, ast_channel_writeformat(chan));
 
        ao2_replace(gateway->peer_read_format, ast_channel_readformat(peer));
        ao2_replace(gateway->peer_write_format, ast_channel_writeformat(peer));
 
        ast_set_read_format(chan, ast_format_slin);
        ast_set_write_format(chan, ast_format_slin);
 
        ast_set_read_format(peer, ast_format_slin);
        ast_set_write_format(peer, ast_format_slin);
 
        ast_channel_unlock(peer);
 
        gateway->bridged = 1;
        if (!(gateway->peer_v21_session = fax_v21_session_new(peer))) {
            ast_log(LOG_ERROR, "Can't create V21 session on chan %s for T.38 gateway session\n", ast_channel_name(peer));
            ast_framehook_detach(chan, gateway->framehook);
            return f;
        }
    }
 
    if (gateway->bridged && !ast_tvzero(gateway->timeout_start)) {
        if (ast_tvdiff_ms(ast_tvnow(), gateway->timeout_start) > details->gateway_timeout) {
            ast_debug(1, "no fax activity between %s and %s after %d ms, disabling gateway\n", ast_channel_name(chan), ast_channel_name(peer), details->gateway_timeout);
            ast_framehook_detach(chan, gateway->framehook);
            details->gateway_id = -1;
 
            ast_string_field_set(details, result, "FAILED");
            ast_string_field_build(details, resultstr, "no fax activity after %d ms", details->gateway_timeout);
            ast_string_field_set(details, error, "TIMEOUT");
            details->is_t38_negotiated = 0;
            set_channel_variables(chan, details);
            return f;
        }
    }
 
    /* only handle VOICE, MODEM, and CONTROL frames*/
    switch (f->frametype) {
    case AST_FRAME_VOICE:
        if ((ast_format_cmp(f->subclass.format, ast_format_slin) != AST_FORMAT_CMP_EQUAL) &&
            (ast_format_cmp(f->subclass.format, ast_format_alaw) != AST_FORMAT_CMP_EQUAL) &&
            (ast_format_cmp(f->subclass.format, ast_format_ulaw) != AST_FORMAT_CMP_EQUAL)) {
            return f;
        }
        break;
    case AST_FRAME_MODEM:
        if (f->subclass.integer == AST_MODEM_T38) {
            break;
        }
        return f;
    case AST_FRAME_CONTROL:
        if (f->subclass.integer == AST_CONTROL_T38_PARAMETERS) {
            break;
        }
        return f;
    default:
        return f;
    }
 
    /* detect the active channel */
    switch (event) {
    case AST_FRAMEHOOK_EVENT_WRITE:
        active = peer;
        break;
    case AST_FRAMEHOOK_EVENT_READ:
        active = chan;
        break;
    default:
        ast_log(LOG_WARNING, "unhandled framehook event %u\n", event);
        return f;
    }
 
    /* handle control frames */
    if (f->frametype == AST_FRAME_CONTROL && f->subclass.integer == AST_CONTROL_T38_PARAMETERS) {
        return fax_gateway_detect_t38(gateway, chan, peer, active, f);
    }
 
    if (!gateway->detected_v21 && gateway->t38_state == T38_STATE_UNAVAILABLE && f->frametype == AST_FRAME_VOICE) {
        /* not in gateway mode and have not detected v21 yet, listen
         * for v21 */
        return fax_gateway_detect_v21(gateway, chan, peer, active, f);
    }
 
    /* in gateway mode, gateway some packets */
    if (gateway->t38_state == T38_STATE_NEGOTIATED) {
        struct ast_trans_pvt *readtrans;
 
        if (!gateway->s || !gateway->s->tech_pvt) {
            ast_log(LOG_ERROR, "no FAX session on chan %s for T.38 gateway session, odd", ast_channel_name(chan));
            return f;
        }
 
        /* framehooks are called in __ast_read() before frame format
         * translation is done, so we need to translate here */
        if ((f->frametype == AST_FRAME_VOICE) && (ast_format_cmp(f->subclass.format, ast_format_slin) != AST_FORMAT_CMP_EQUAL)
            && (readtrans = ast_channel_readtrans(active))) {
            if ((f = ast_translate(readtrans, f, event == AST_FRAMEHOOK_EVENT_WRITE ? 0 : 1)) == NULL) {
                f = &ast_null_frame;
                return f;
            }
            /* XXX we ignore the return value here, perhaps we should
             * disable the gateway if a write fails. I am not sure how a
             * write would fail, or even if a failure would be fatal so for
             * now we'll just ignore the return value. */
            gateway->s->tech->write(gateway->s, f);
            ast_frfree(f);
        } else {
            gateway->s->tech->write(gateway->s, f);
        }
 
        f = &ast_null_frame;
        return f;
    }
 
    /* force silence on the line if T.38 negotiation might be taking place */
    if (gateway->t38_state != T38_STATE_UNAVAILABLE && gateway->t38_state != T38_STATE_REJECTED) {
        if (f->frametype == AST_FRAME_VOICE &&
            (ast_format_cmp(f->subclass.format, ast_format_slin) == AST_FORMAT_CMP_EQUAL)) {
            short silence_buf[f->samples];
            struct ast_frame silence_frame = {
                .frametype = AST_FRAME_VOICE,
                .subclass.format = ast_format_slin,
                .data.ptr = silence_buf,
                .samples = f->samples,
                .datalen = sizeof(silence_buf),
            };
            memset(silence_buf, 0, sizeof(silence_buf));
            return ast_frisolate(&silence_frame);
        } else {
            return &ast_null_frame;
        }
    }
 
    return f;
}

References ao2_cleanup, ao2_ref, ao2_replace, ast_channel_bridge_peer(), ast_channel_get_t38_state(), ast_channel_lock, ast_channel_lock_both, ast_channel_make_compatible(), ast_channel_name(), ast_channel_readformat(), ast_channel_readtrans(), ast_channel_unlock, ast_channel_writeformat(), ast_check_hangup(), AST_CONTROL_T38_PARAMETERS, ast_debug, AST_FAX_FRFLAG_GATEWAY, ast_format_alaw, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_slin, ast_format_ulaw, AST_FRAME_CONTROL, AST_FRAME_MODEM, AST_FRAME_VOICE, ast_framehook_detach(), AST_FRAMEHOOK_EVENT_ATTACHED, AST_FRAMEHOOK_EVENT_DETACHED, AST_FRAMEHOOK_EVENT_READ, AST_FRAMEHOOK_EVENT_WRITE, ast_frfree, ast_frisolate, ast_log, AST_MODEM_T38, ast_null_frame, ast_set_read_format(), ast_set_write_format(), ast_string_field_build, ast_string_field_set, ast_test_flag, ast_translate(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), fax_gateway::bridged, fax_gateway::chan_read_format, fax_gateway::chan_write_format, ast_fax_session::details, fax_gateway::detected_v21, error(), ast_trans_pvt::f, fax_gateway_detect_t38(), fax_gateway_detect_v21(), fax_v21_session_new(), find_details(), ast_frame_subclass::format, fax_gateway::framehook, ast_frame::frametype, ast_frame_subclass::integer, LOG_ERROR, LOG_WARNING, NULL, fax_gateway::peer_read_format, fax_gateway::peer_v21_session, fax_gateway::peer_write_format, RAII_VAR, result, fax_gateway::s, ast_frame::samples, set_channel_variables(), ast_frame::subclass, fax_gateway::t38_state, T38_STATE_NEGOTIATED, T38_STATE_REJECTED, T38_STATE_UNAVAILABLE, ast_fax_session::tech, ast_fax_session::tech_pvt, fax_gateway::timeout_start, and ast_fax_tech::write.

Referenced by fax_gateway_attach().

◆ fax_gateway_framehook_destroy()

static void fax_gateway_framehook_destroy ( void * data )

static

Destroy the gateway data structure when the framehook is detached.

Parameters

data	framehook data (gateway data)

Definition at line 3446 of file res_fax.c.

{
    struct fax_gateway *gateway = data;
 
    if (gateway->s) {
        switch (gateway->s->state) {
        case AST_FAX_STATE_INITIALIZED:
        case AST_FAX_STATE_OPEN:
        case AST_FAX_STATE_ACTIVE:
        case AST_FAX_STATE_COMPLETE:
            if (gateway->s->tech->cancel_session) {
                gateway->s->tech->cancel_session(gateway->s);
            }
            /* fall through */
        default:
            break;
        }
    }
 
    ao2_ref(gateway, -1);
}

References ao2_ref, AST_FAX_STATE_ACTIVE, AST_FAX_STATE_COMPLETE, AST_FAX_STATE_INITIALIZED, AST_FAX_STATE_OPEN, ast_fax_tech::cancel_session, fax_gateway::s, ast_fax_session::state, and ast_fax_session::tech.

Referenced by fax_gateway_attach().

◆ fax_gateway_indicate_t38()

static void fax_gateway_indicate_t38	(	struct ast_channel *	chan,
		struct ast_channel *	active,
		struct ast_control_t38_parameters *	control_params
	)

static

Precondition: chan is locked on entry

Definition at line 3186 of file res_fax.c.

{
    if (active == chan) {
        ast_channel_unlock(chan);
        ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, control_params, sizeof(*control_params));
        ast_channel_lock(chan);
    } else {
        ast_queue_control_data(chan, AST_CONTROL_T38_PARAMETERS, control_params, sizeof(*control_params));
    }
}

References ast_channel_lock, ast_channel_unlock, AST_CONTROL_T38_PARAMETERS, ast_indicate_data(), and ast_queue_control_data().

Referenced by fax_gateway_detect_t38().

◆ fax_gateway_new()

static struct fax_gateway * fax_gateway_new	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Create a new fax gateway object.

Parameters

chan	the channel the gateway object will be attached to
details	the fax session details

Returns: NULL or a fax gateway object

Definition at line 2981 of file res_fax.c.

{
    struct fax_gateway *gateway = ao2_alloc(sizeof(*gateway), destroy_gateway);
    if (!gateway) {
        return NULL;
    }
 
    if (!(gateway->chan_v21_session = fax_v21_session_new(chan))) {
        ast_log(LOG_ERROR, "Can't create V21 session on chan %s for T.38 gateway session\n", ast_channel_name(chan));
        ao2_ref(gateway, -1);
        return NULL;
    }
 
    gateway->framehook = -1;
 
    details->caps = AST_FAX_TECH_GATEWAY;
    if (details->gateway_timeout && !(gateway->s = fax_session_reserve(details, &gateway->token))) {
        details->caps &= ~AST_FAX_TECH_GATEWAY;
        ast_log(LOG_ERROR, "Can't reserve a FAX session, gateway attempt failed.\n");
        ao2_ref(gateway, -1);
        return NULL;
    }
 
    return gateway;
}

References ao2_alloc, ao2_ref, ast_channel_name(), AST_FAX_TECH_GATEWAY, ast_log, ast_fax_session_details::caps, fax_gateway::chan_v21_session, destroy_gateway(), fax_session_reserve(), fax_v21_session_new(), fax_gateway::framehook, ast_fax_session_details::gateway_timeout, LOG_ERROR, NULL, fax_gateway::s, and fax_gateway::token.

Referenced by fax_gateway_attach().

◆ fax_gateway_request_t38()

static struct ast_frame * fax_gateway_request_t38	(	struct fax_gateway *	gateway,
		struct ast_channel *	chan
	)

static

Precondition: chan is locked on entry

Definition at line 3073 of file res_fax.c.

{
    struct ast_frame *fp;
    struct ast_control_t38_parameters t38_parameters = {
        .request_response = AST_T38_REQUEST_NEGOTIATE,
    };
    struct ast_frame control_frame = {
        .src = "res_fax",
        .frametype = AST_FRAME_CONTROL,
        .datalen = sizeof(t38_parameters),
        .subclass.integer = AST_CONTROL_T38_PARAMETERS,
        .data.ptr = &t38_parameters,
    };
 
    struct ast_fax_session_details *details = find_details(chan);
 
    if (!details) {
        ast_log(LOG_ERROR, "no FAX session details found on chan %s for T.38 gateway session, odd\n", ast_channel_name(chan));
        ast_framehook_detach(chan, gateway->framehook);
        return NULL;
    }
 
    t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
    ao2_ref(details, -1);
 
    if (!(fp = ast_frisolate(&control_frame))) {
        ast_log(LOG_ERROR, "error generating T.38 request control frame on chan %s for T.38 gateway session\n", ast_channel_name(chan));
        return NULL;
    }
 
    gateway->t38_state = T38_STATE_NEGOTIATING;
    gateway->timeout_start = ast_tvnow();
    details->is_t38_negotiated = 0;
    details->gateway_timeout = FAX_GATEWAY_TIMEOUT;
 
    ast_debug(1, "requesting T.38 for gateway session for %s\n", ast_channel_name(chan));
    return fp;
}

References ao2_ref, ast_channel_name(), AST_CONTROL_T38_PARAMETERS, ast_debug, AST_FRAME_CONTROL, ast_framehook_detach(), ast_frisolate, ast_log, AST_T38_REQUEST_NEGOTIATE, ast_tvnow(), FAX_GATEWAY_TIMEOUT, find_details(), fax_gateway::framehook, ast_fax_session_details::gateway_timeout, ast_frame_subclass::integer, ast_fax_session_details::is_t38_negotiated, LOG_ERROR, NULL, ast_fax_session_details::our_t38_parameters, ast_control_t38_parameters::request_response, ast_frame::src, ast_frame::subclass, t38_parameters_fax_to_ast(), fax_gateway::t38_state, T38_STATE_NEGOTIATING, and fax_gateway::timeout_start.

Referenced by fax_gateway_detect_v21().

◆ fax_gateway_start()

static int fax_gateway_start	(	struct fax_gateway *	gateway,
		struct ast_fax_session_details *	details,
		struct ast_channel *	chan
	)

static

Create a fax session and start T.30<->T.38 gateway mode.

Parameters

gateway	a fax gateway object
details	fax session details
chan	active channel

Precondition: chan is locked on entry

Returns: 0 on error 1 on success

Definition at line 3018 of file res_fax.c.

{
    struct ast_fax_session *s;
    int start_res;
 
    /* if the fax gateway is already started then do nothing */
    if (gateway->s &&
        gateway->s->state != AST_FAX_STATE_RESERVED && gateway->s->state != AST_FAX_STATE_INACTIVE) {
        return 0;
    }
 
    /* if we start gateway we don't need v21 detection sessions any more */
    destroy_v21_sessions(gateway);
 
    /* create the FAX session */
    if (!(s = fax_session_new(details, chan, gateway->s, gateway->token))) {
        gateway->token = NULL;
        ast_string_field_set(details, result, "FAILED");
        ast_string_field_set(details, resultstr, "error starting gateway session");
        ast_string_field_set(details, error, "INIT_ERROR");
        details->is_t38_negotiated = 0;
        set_channel_variables(chan, details);
        report_fax_status(chan, details, "No Available Resource");
        ast_log(LOG_ERROR, "Can't create a FAX session, gateway attempt failed.\n");
        return -1;
    }
    /* release the reference for the reserved session and replace it with
     * the real session */
    if (gateway->s) {
        ao2_ref(gateway->s, -1);
    }
    gateway->s = s;
    gateway->token = NULL;
 
    ast_channel_unlock(chan);
    start_res = gateway->s->tech->start_session(gateway->s);
    ast_channel_lock(chan);
    if (start_res < 0) {
        ast_string_field_set(details, result, "FAILED");
        ast_string_field_set(details, resultstr, "error starting gateway session");
        ast_string_field_set(details, error, "INIT_ERROR");
        details->is_t38_negotiated = 0;
        set_channel_variables(chan, details);
        return -1;
    }
 
    gateway->timeout_start.tv_sec = 0;
    gateway->timeout_start.tv_usec = 0;
 
    report_fax_status(chan, details, "FAX Transmission In Progress");
 
    return 0;
}

References ao2_ref, ast_channel_lock, ast_channel_unlock, AST_FAX_STATE_INACTIVE, AST_FAX_STATE_RESERVED, ast_log, ast_string_field_set, ast_fax_session::chan, destroy_v21_sessions(), ast_fax_session::details, error(), fax_session_new(), ast_fax_session_details::is_t38_negotiated, LOG_ERROR, NULL, report_fax_status(), result, fax_gateway::s, set_channel_variables(), ast_fax_tech::start_session, ast_fax_session::state, ast_fax_session::tech, fax_gateway::timeout_start, and fax_gateway::token.

Referenced by fax_gateway_detect_t38().

◆ fax_rate_str_to_int()

static unsigned int fax_rate_str_to_int ( const char * ratestr )

static

convert a rate string to a rate

Definition at line 1147 of file res_fax.c.

{
    int rate;
 
    if (sscanf(ratestr, "%d", &rate) != 1) {
        ast_log(LOG_ERROR, "failed to sscanf '%s' to rate\n", ratestr);
        return 0;
    }
    switch (rate) {
    case 2400:
    case 4800:
    case 7200:
    case 9600:
    case 12000:
    case 14400:
    case 28800:
    case 33600:
        return rate;
    default:
        ast_log(LOG_WARNING, "ignoring invalid rate '%s'.  Valid options are {2400 | 4800 | 7200 | 9600 | 12000 | 14400 | 28800 | 33600}\n", ratestr);
        return 0;
    }
}

References ast_log, LOG_ERROR, and LOG_WARNING.

Referenced by acf_faxopt_write(), and set_config().

◆ fax_session_new()

static struct ast_fax_session * fax_session_new	(	struct ast_fax_session_details *	details,
		struct ast_channel *	chan,
		struct ast_fax_session *	reserved,
		struct ast_fax_tech_token *	token
	)

static

create a FAX session

Parameters

details	details for the session
chan	the channel the session will run on
reserved	a reserved session to base this session on (can be NULL)
token	the token for a reserved session (can be NULL)

Create a new fax session based on the given details structure.

Note: The given token is always consumed (by tech->new_session() or by fax_session_release() in the event of a failure). The given reference to a reserved session is never consumed and must be dereferenced separately from the reference returned by this function.

Returns: NULL or a reference to a new fax session

Definition at line 1316 of file res_fax.c.

{
    struct ast_fax_session *s = NULL;
    struct fax_module *faxmod;
 
    if (reserved) {
        s = reserved;
        ao2_ref(reserved, +1);
        ao2_unlink(faxregistry.container, reserved);
 
        /* NOTE: we don't consume the reference to the reserved
         * session. The session returned from fax_session_new() is a
         * new reference and must be derefed in addition to the
         * reserved session.
         */
 
        if (s->state == AST_FAX_STATE_RESERVED) {
            ast_atomic_fetchadd_int(&faxregistry.reserved_sessions, -1);
            s->state = AST_FAX_STATE_UNINITIALIZED;
        }
    }
 
    if (!s && !(s = ao2_alloc(sizeof(*s), destroy_session))) {
        return NULL;
    }
 
    ast_atomic_fetchadd_int(&faxregistry.active_sessions, 1);
    s->state = AST_FAX_STATE_UNINITIALIZED;
 
    if (details->option.debug && (details->caps & AST_FAX_TECH_AUDIO)) {
        if (!(s->debug_info = ast_calloc(1, sizeof(*(s->debug_info))))) {
            fax_session_release(s, token);
            ao2_ref(s, -1);
            return NULL;
        }
        if (!(s->debug_info->dsp = ast_dsp_new())) {
            ast_free(s->debug_info);
            s->debug_info = NULL;
            fax_session_release(s, token);
            ao2_ref(s, -1);
            return NULL;
        }
        ast_dsp_set_threshold(s->debug_info->dsp, 128);
    }
 
    if (!(s->channame = ast_strdup(ast_channel_name(chan)))) {
        fax_session_release(s, token);
        ao2_ref(s, -1);
        return NULL;
    }
 
    if (!(s->chan_uniqueid = ast_strdup(ast_channel_uniqueid(chan)))) {
        fax_session_release(s, token);
        ao2_ref(s, -1);
        return NULL;
    }
 
    s->chan = chan;
    if (!s->details) {
        s->details = details;
        ao2_ref(s->details, 1);
    }
 
    details->id = s->id = ast_atomic_fetchadd_int(&faxregistry.nextsessionname, 1);
 
    if (!token) {
        /* locate a FAX technology module that can handle said requirements */
        AST_RWLIST_RDLOCK(&faxmodules);
        AST_RWLIST_TRAVERSE(&faxmodules, faxmod, list) {
            if ((faxmod->tech->caps & details->caps) != details->caps) {
                continue;
            }
            if (!ast_module_running_ref(faxmod->tech->module)) {
                continue;
            }
            ast_debug(4, "Requesting a new FAX session from '%s'.\n", faxmod->tech->description);
            if (reserved) {
                /* Balance module ref from reserved session */
                ast_module_unref(reserved->tech->module);
            }
            s->tech = faxmod->tech;
            break;
        }
        AST_RWLIST_UNLOCK(&faxmodules);
 
        if (!faxmod) {
            char caps[128] = "";
            ast_log(LOG_ERROR, "Could not locate a FAX technology module with capabilities (%s)\n", ast_fax_caps_to_str(details->caps, caps, sizeof(caps)));
            ao2_ref(s, -1);
            return NULL;
        }
    }
 
    if (!(s->tech_pvt = s->tech->new_session(s, token))) {
        ast_log(LOG_ERROR, "FAX session failed to initialize.\n");
        ao2_ref(s, -1);
        return NULL;
    }
    /* link the session to the session container */
    if (!(ao2_link(faxregistry.container, s))) {
        ast_log(LOG_ERROR, "failed to add FAX session '%u' to container.\n", s->id);
        ao2_ref(s, -1);
        return NULL;
    }
    ast_debug(4, "channel '%s' using FAX session '%u'\n", s->channame, s->id);
 
    return s;
}

References ao2_alloc, ao2_link, ao2_ref, ao2_unlink, ast_atomic_fetchadd_int(), ast_calloc, ast_channel_name(), ast_channel_uniqueid(), ast_debug, ast_dsp_new(), ast_dsp_set_threshold(), ast_fax_caps_to_str(), AST_FAX_STATE_RESERVED, AST_FAX_STATE_UNINITIALIZED, AST_FAX_TECH_AUDIO, ast_free, ast_log, ast_module_running_ref, ast_module_unref, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, ast_fax_session_details::caps, ast_fax_tech::caps, ast_fax_session::chan, ast_fax_session::chan_uniqueid, ast_fax_session::channame, ast_fax_session_details::debug, ast_fax_session::debug_info, ast_fax_tech::description, destroy_session(), ast_fax_session::details, ast_fax_debug_info::dsp, fax_session_release(), faxregistry, ast_fax_session_details::id, ast_fax_session::id, fax_module::list, LOG_ERROR, ast_fax_tech::new_session, NULL, ast_fax_session_details::option, ast_fax_session::state, ast_fax_session::tech, fax_module::tech, and ast_fax_session::tech_pvt.

Referenced by fax_gateway_start(), fax_v21_session_new(), and generic_fax_exec().

◆ fax_session_release()

static void fax_session_release	(	struct ast_fax_session *	s,
		struct ast_fax_tech_token *	token
	)

static

Release a session token.

Parameters

s	a session returned from fax_session_reserve()
token	a token generated from fax_session_reserve()

This function releases the given token and marks the given session as no longer reserved. It is safe to call on a session that is not actually reserved and with a NULL token. This is so that sessions returned by technologies that do not support reserved sessions don't require extra logic to handle.

Note: This function DOES NOT release the given fax session, only the given token.

Definition at line 1184 of file res_fax.c.

{
    if (token) {
        s->tech->release_token(token);
    }
 
    if (s->state == AST_FAX_STATE_RESERVED) {
        ast_atomic_fetchadd_int(&faxregistry.reserved_sessions, -1);
        s->state = AST_FAX_STATE_INACTIVE;
    }
}

References ast_atomic_fetchadd_int(), AST_FAX_STATE_INACTIVE, AST_FAX_STATE_RESERVED, faxregistry, ast_fax_tech::release_token, ast_fax_session::state, and ast_fax_session::tech.

Referenced by destroy_gateway(), destroy_session(), fax_session_new(), receivefax_exec(), and sendfax_exec().

◆ fax_session_reserve()

static struct ast_fax_session * fax_session_reserve	(	struct ast_fax_session_details *	details,
		struct ast_fax_tech_token **	token
	)

static

Reserve a fax session.

Parameters

details	the fax session details
token	a pointer to a place to store a token to be passed to fax_session_new() later

This function reserves a fax session for use later. If the selected fax technology does not support reserving sessions a session will still be returned but token will not be set.

Note: The reference returned by this function does not get consumed by fax_session_new() and must always be dereferenced separately.

Returns: NULL or an uninitialized and possibly reserved session

Definition at line 1247 of file res_fax.c.

{
    struct ast_fax_session *s;
    struct fax_module *faxmod;
 
    if (!(s = ao2_alloc(sizeof(*s), destroy_session))) {
        return NULL;
    }
 
    s->state = AST_FAX_STATE_INACTIVE;
    s->details = details;
    ao2_ref(s->details, 1);
 
    /* locate a FAX technology module that can handle said requirements
     * Note: the requirements have not yet been finalized as T.38
     * negotiation has not yet occured. */
    AST_RWLIST_RDLOCK(&faxmodules);
    AST_RWLIST_TRAVERSE(&faxmodules, faxmod, list) {
        if ((faxmod->tech->caps & details->caps) != details->caps) {
            continue;
        }
        if (!ast_module_running_ref(faxmod->tech->module)) {
            continue;
        }
        ast_debug(4, "Reserving a FAX session from '%s'.\n", faxmod->tech->description);
        s->tech = faxmod->tech;
        break;
    }
    AST_RWLIST_UNLOCK(&faxmodules);
 
    if (!faxmod) {
        char caps[128] = "";
        ast_log(LOG_ERROR, "Could not locate a FAX technology module with capabilities (%s)\n", ast_fax_caps_to_str(details->caps, caps, sizeof(caps)));
        ao2_ref(s, -1);
        return NULL;
    }
 
    if (!s->tech->reserve_session) {
        ast_debug(1, "Selected FAX technology module (%s) does not support reserving sessions.\n", s->tech->description);
        return s;
    }
 
    if (!(*token = s->tech->reserve_session(s))) {
        ao2_ref(s, -1);
        return NULL;
    }
 
    s->state = AST_FAX_STATE_RESERVED;
    ast_atomic_fetchadd_int(&faxregistry.reserved_sessions, 1);
 
    return s;
}

References ao2_alloc, ao2_ref, ast_atomic_fetchadd_int(), ast_debug, ast_fax_caps_to_str(), AST_FAX_STATE_INACTIVE, AST_FAX_STATE_RESERVED, ast_log, ast_module_running_ref, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_fax_session_details::caps, ast_fax_tech::caps, ast_fax_tech::description, destroy_session(), ast_fax_session::details, faxregistry, fax_module::list, LOG_ERROR, NULL, ast_fax_tech::reserve_session, ast_fax_session::state, ast_fax_session::tech, and fax_module::tech.

Referenced by fax_gateway_new(), receivefax_exec(), and sendfax_exec().

◆ fax_session_tab_complete()

static char * fax_session_tab_complete ( struct ast_cli_args * a )

static

fax session tab completion

Definition at line 4044 of file res_fax.c.

{
    int tklen;
    int wordnum = 0;
    char *name = NULL;
    struct ao2_iterator i;
    struct ast_fax_session *s;
    char tbuf[5];
 
    if (a->pos != 3) {
        return NULL;
    }
 
    tklen = strlen(a->word);
    i = ao2_iterator_init(faxregistry.container, 0);
    while ((s = ao2_iterator_next(&i))) {
        snprintf(tbuf, sizeof(tbuf), "%u", s->id);
        if (!strncasecmp(a->word, tbuf, tklen) && ++wordnum > a->n) {
            name = ast_strdup(tbuf);
            ao2_ref(s, -1);
            break;
        }
        ao2_ref(s, -1);
    }
    ao2_iterator_destroy(&i);
    return name;
}

References a, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_strdup, faxregistry, ast_fax_session::id, name, and NULL.

Referenced by cli_fax_show_session().

◆ fax_session_type()

static const char * fax_session_type ( struct ast_fax_session * s )

static

Definition at line 4343 of file res_fax.c.

{
    if (s->details->caps & AST_FAX_TECH_AUDIO) {
        return "G.711";
    }
    if (s->details->caps & AST_FAX_TECH_T38) {
        return "T.38";
    }
 
    return "none";
}

References AST_FAX_TECH_AUDIO, AST_FAX_TECH_T38, ast_fax_session_details::caps, and ast_fax_session::details.

Referenced by cli_fax_show_sessions(), and manager_fax_sessions_entry().

◆ fax_v21_session_new()

static struct ast_fax_session * fax_v21_session_new ( struct ast_channel * chan )

static

Definition at line 2962 of file res_fax.c.

                                                                              {
    struct ast_fax_session_details *v21_details;
    struct ast_fax_session *v21_session;
 
    if (!chan || !(v21_details = session_details_new())) {
        return NULL;
    }
 
    v21_details->caps = AST_FAX_TECH_V21_DETECT;
    v21_session = fax_session_new(v21_details, chan, NULL, NULL);
    ao2_ref(v21_details, -1);
    return v21_session;
}

References ao2_ref, AST_FAX_TECH_V21_DETECT, ast_fax_session_details::caps, ast_fax_session::chan, fax_session_new(), NULL, and session_details_new().

Referenced by fax_gateway_framehook(), and fax_gateway_new().

◆ find_details()

static struct ast_fax_session_details * find_details ( struct ast_channel * chan )

static

returns a reference counted pointer to a fax datastore, if it exists

Definition at line 763 of file res_fax.c.

{
    struct ast_fax_session_details *details;
    struct ast_datastore *datastore;
 
    ast_channel_lock(chan);
    if (!(datastore = ast_channel_datastore_find(chan, &fax_datastore, NULL))) {
        ast_channel_unlock(chan);
        return NULL;
    }
    if (!(details = datastore->data)) {
        ast_log(LOG_WARNING, "Huh?  channel '%s' has a FAX datastore without data!\n", ast_channel_name(chan));
        ast_channel_unlock(chan);
        return NULL;
    }
    ao2_ref(details, 1);
    ast_channel_unlock(chan);
 
    return details;
}

References ao2_ref, ast_channel_datastore_find(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_log, ast_datastore::data, fax_datastore, LOG_WARNING, and NULL.

Referenced by acf_faxopt_read(), fax_gateway_detect_t38(), fax_gateway_framehook(), fax_gateway_request_t38(), and find_or_create_details().

◆ find_or_create_details()

static struct ast_fax_session_details * find_or_create_details ( struct ast_channel * chan )

static

returns a reference counted details structure from the channel's fax datastore. If the datastore does not exist it will be created

Definition at line 865 of file res_fax.c.

{
    struct ast_fax_session_details *details;
    struct ast_datastore *datastore;
 
    if ((details = find_details(chan))) {
        return details;
    }
    /* channel does not have one so we must create one */
    if (!(details = session_details_new())) {
        ast_log(LOG_WARNING, "channel '%s' can't get a FAX details structure for the datastore!\n", ast_channel_name(chan));
        return NULL;
    }
    if (!(datastore = ast_datastore_alloc(&fax_datastore, NULL))) {
        ao2_ref(details, -1);
        ast_log(LOG_WARNING, "channel '%s' can't get a datastore!\n", ast_channel_name(chan));
        return NULL;
    }
    /* add the datastore to the channel and increment the refcount */
    datastore->data = details;
 
    /* initialize default T.38 parameters */
    t38_parameters_ast_to_fax(&details->our_t38_parameters, &our_t38_parameters);
    t38_parameters_ast_to_fax(&details->their_t38_parameters, &our_t38_parameters);
 
    ao2_ref(details, 1);
    ast_channel_lock(chan);
    ast_channel_datastore_add(chan, datastore);
    ast_channel_unlock(chan);
    return details;
}

References ao2_ref, ast_channel_datastore_add(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_datastore_alloc, ast_log, ast_datastore::data, fax_datastore, find_details(), LOG_WARNING, NULL, ast_fax_session_details::our_t38_parameters, our_t38_parameters, session_details_new(), t38_parameters_ast_to_fax(), and ast_fax_session_details::their_t38_parameters.

Referenced by acf_faxopt_write(), fax_detect_attach(), fax_gateway_detect_v21(), fixup_callback(), receivefax_exec(), and sendfax_exec().

◆ fixup_callback()

static void fixup_callback	(	void *	data,
		struct ast_channel *	old_chan,
		struct ast_channel *	new_chan
	)

static

Copies fax detection and gateway framehooks during masquerades.

Note: must be called with both old_chan and new_chan locked. Since this is only called by do_masquerade, that shouldn't be an issue.

Definition at line 737 of file res_fax.c.

{
    struct ast_fax_session_details *old_details = data;
    struct ast_datastore *datastore = ast_channel_datastore_find(old_chan, &fax_datastore, NULL);
 
    if (old_details->gateway_id >= 0) {
        struct ast_fax_session_details *new_details = find_or_create_details(new_chan);
 
        ast_framehook_detach(old_chan, old_details->gateway_id);
        new_details->is_t38_negotiated = old_details->is_t38_negotiated;
        fax_gateway_attach(new_chan, new_details);
        ao2_cleanup(new_details);
    }
 
    if (old_details->faxdetect_id >= 0) {
        ast_framehook_detach(old_chan, old_details->faxdetect_id);
        fax_detect_attach(new_chan, old_details->faxdetect_timeout, old_details->faxdetect_flags);
    }
 
    if (datastore) {
        ast_channel_datastore_remove(old_chan, datastore);
        ast_datastore_free(datastore);
    }
}

References ao2_cleanup, ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_datastore_free(), ast_framehook_detach(), fax_datastore, fax_detect_attach(), fax_gateway_attach(), ast_fax_session_details::faxdetect_flags, ast_fax_session_details::faxdetect_id, ast_fax_session_details::faxdetect_timeout, find_or_create_details(), ast_fax_session_details::gateway_id, ast_fax_session_details::is_t38_negotiated, and NULL.

◆ generate_filenames_json()

static struct ast_json * generate_filenames_json ( struct ast_fax_session_details * details )

static

Definition at line 1431 of file res_fax.c.

{
    RAII_VAR(struct ast_json *, json_array, ast_json_array_create(), ast_json_unref);
    struct ast_fax_document *doc;
 
    if (!details || !json_array) {
        return NULL;
    }
 
    /* don't process empty lists */
    if (AST_LIST_EMPTY(&details->documents)) {
        return NULL;
    }
 
    AST_LIST_TRAVERSE(&details->documents, doc, next) {
        struct ast_json *entry = ast_json_string_create(doc->filename);
        if (!entry) {
            return NULL;
        }
        if (ast_json_array_append(json_array, entry)) {
            return NULL;
        }
    }
 
    ast_json_ref(json_array);
    return json_array;
}

References ast_json_array_append(), ast_json_array_create(), ast_json_ref(), ast_json_string_create(), ast_json_unref(), AST_LIST_EMPTY, AST_LIST_TRAVERSE, ast_fax_session_details::documents, ast_fax_document::filename, ast_fax_document::next, NULL, and RAII_VAR.

Referenced by report_fax_status(), and report_send_fax_status().

◆ generate_filenames_string()

static char * generate_filenames_string	(	struct ast_fax_session_details *	details,
		char *	prefix,
		char *	separator
	)

static

Generate a string of filenames using the given prefix and separator.

Parameters

details	the fax session details
prefix	the prefix to each filename
separator	the separator between filenames

This function generates a string of filenames from the given details structure and using the given prefix and separator.

Return values

NULL	there was an error generating the string

Returns: the string generated string

Definition at line 1471 of file res_fax.c.

{
    char *filenames, *c;
    size_t size = 0;
    int first = 1;
    struct ast_fax_document *doc;
 
    /* don't process empty lists */
    if (AST_LIST_EMPTY(&details->documents)) {
        return ast_strdup("");
    }
 
    /* Calculate the total length of all of the file names */
    AST_LIST_TRAVERSE(&details->documents, doc, next) {
        size += strlen(separator) + strlen(prefix) + strlen(doc->filename);
    }
    size += 1; /* add space for the terminating null */
 
    if (!(filenames = ast_malloc(size))) {
        return NULL;
    }
    c = filenames;
 
    ast_build_string(&c, &size, "%s%s", prefix, AST_LIST_FIRST(&details->documents)->filename);
    AST_LIST_TRAVERSE(&details->documents, doc, next) {
        if (first) {
            first = 0;
            continue;
        }
 
        ast_build_string(&c, &size, "%s%s%s", separator, prefix, doc->filename);
    }
 
    return filenames;
}

References ast_build_string(), AST_LIST_EMPTY, AST_LIST_FIRST, AST_LIST_TRAVERSE, ast_malloc, ast_strdup, c, ast_fax_session_details::documents, ast_fax_document::filename, first, ast_fax_document::next, NULL, and prefix.

Referenced by acf_faxopt_read(), cli_fax_show_sessions(), manager_fax_sessions_entry(), and sendfax_exec().

◆ generic_fax_exec()

static int generic_fax_exec	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details,
		struct ast_fax_session *	reserved,
		struct ast_fax_tech_token *	token
	)

static

this is the generic FAX session handling function

Definition at line 1691 of file res_fax.c.

{
    int ms;
    int timeout = RES_FAX_TIMEOUT;
    int chancount;
    unsigned int expected_frametype = -1;
    struct ast_frame_subclass expected_framesubclass = { .integer = 0, };
    unsigned int t38negotiated = (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED);
    struct ast_control_t38_parameters t38_parameters;
    const char *tempvar;
    struct ast_fax_session *fax = NULL;
    struct ast_frame *frame = NULL;
    struct ast_channel *c = chan;
    RAII_VAR(struct ast_format *, orig_write_format, NULL, ao2_cleanup);
    RAII_VAR(struct ast_format *, orig_read_format, NULL, ao2_cleanup);
    int remaining_time;
    struct timeval start;
 
    chancount = 1;
 
    /* Make sure one or the other is set to avoid race condition */
    if (t38negotiated) {
        details->caps |= AST_FAX_TECH_T38;
    } else {
        details->caps |= AST_FAX_TECH_AUDIO;
    }
 
    /* create the FAX session */
    if (!(fax = fax_session_new(details, chan, reserved, token))) {
        ast_log(LOG_ERROR, "Can't create a FAX session, FAX attempt failed.\n");
        report_fax_status(chan, details, "No Available Resource");
        return -1;
    }
 
    ast_channel_lock(chan);
    /* update session details */
    if (ast_strlen_zero(details->headerinfo) && (tempvar = pbx_builtin_getvar_helper(chan, "LOCALHEADERINFO"))) {
        ast_string_field_set(details, headerinfo, tempvar);
    }
    if (ast_strlen_zero(details->localstationid)) {
        tempvar = pbx_builtin_getvar_helper(chan, "LOCALSTATIONID");
        ast_string_field_set(details, localstationid, tempvar ? tempvar : "unknown");
    }
    ast_channel_unlock(chan);
 
    report_fax_status(chan, details, "Allocating Resources");
 
    if (details->caps & AST_FAX_TECH_AUDIO) {
        expected_frametype = AST_FRAME_VOICE;
        expected_framesubclass.format = ast_format_slin;
        orig_write_format = ao2_bump(ast_channel_writeformat(chan));
        if (ast_set_write_format(chan, ast_format_slin) < 0) {
            ast_log(LOG_ERROR, "channel '%s' failed to set write format to signed linear'.\n", ast_channel_name(chan));
            ao2_unlink(faxregistry.container, fax);
            ao2_ref(fax, -1);
            return -1;
        }
        orig_read_format = ao2_bump(ast_channel_readformat(chan));
        if (ast_set_read_format(chan, ast_format_slin) < 0) {
            ast_log(LOG_ERROR, "channel '%s' failed to set read format to signed linear.\n", ast_channel_name(chan));
            ao2_unlink(faxregistry.container, fax);
            ao2_ref(fax, -1);
            return -1;
        }
        if (fax->smoother) {
            ast_smoother_free(fax->smoother);
            fax->smoother = NULL;
        }
        if (!(fax->smoother = ast_smoother_new(320))) {
            ast_log(LOG_WARNING, "Channel '%s' FAX session '%u' failed to obtain a smoother.\n", ast_channel_name(chan), fax->id);
        }
    } else {
        expected_frametype = AST_FRAME_MODEM;
        expected_framesubclass.integer = AST_MODEM_T38;
    }
 
    if (fax->debug_info) {
        fax->debug_info->base_tv = ast_tvnow();
    }
 
    /* reset our result fields just in case the fax tech driver wants to
     * set custom error messages */
    ast_string_field_set(details, result, "");
    ast_string_field_set(details, resultstr, "");
    ast_string_field_set(details, error, "");
    details->is_t38_negotiated = t38negotiated;
    set_channel_variables(chan, details);
 
    if (fax->tech->start_session(fax) < 0) {
        GENERIC_FAX_EXEC_ERROR(fax, chan, "INIT_ERROR", "failed to start FAX session");
    }
 
    report_fax_status(chan, details, "FAX Transmission In Progress");
 
    ast_debug(5, "channel %s will wait on FAX fd %d\n", ast_channel_name(chan), fax->fd);
 
    /* handle frames for the session */
    remaining_time = timeout;
    start = ast_tvnow();
    while (remaining_time > 0) {
        struct ast_channel *ready_chan;
        int ofd, exception;
 
        ms = 1000;
        errno = 0;
        ready_chan = ast_waitfor_nandfds(&c, chancount, &fax->fd, 1, &exception, &ofd, &ms);
        if (ready_chan) {
            if (!(frame = ast_read(chan))) {
                /* the channel is probably gone, so lets stop polling on it and let the
                 * FAX session complete before we exit the application.  if needed,
                 * send the FAX stack silence so the modems can finish their session without
                 * any problems */
                ast_debug(1, "Channel '%s' did not return a frame; probably hung up.\n", ast_channel_name(chan));
                GENERIC_FAX_EXEC_SET_VARS(fax, chan, "HANGUP", "remote channel hungup");
                c = NULL;
                chancount = 0;
                remaining_time = ast_remaining_ms(start, timeout);
                fax->tech->cancel_session(fax);
                if (fax->tech->generate_silence) {
                    fax->tech->generate_silence(fax);
                }
                continue;
            }
 
            if ((frame->frametype == AST_FRAME_CONTROL) &&
                (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
                (frame->datalen == sizeof(t38_parameters))) {
                unsigned int was_t38 = t38negotiated;
                struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
                switch (parameters->request_response) {
                case AST_T38_REQUEST_NEGOTIATE:
                    /* the other end has requested a switch to T.38, so reply that we are willing, if we can
                     * do T.38 as well
                     */
                    t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
                    if (details->caps & AST_FAX_TECH_T38) {
                        details->is_t38_negotiated = 1;
                        t38_parameters.request_response = AST_T38_NEGOTIATED;
                    } else {
                        t38_parameters.request_response = AST_T38_REFUSED;
                    }
                    ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters));
                    break;
                case AST_T38_NEGOTIATED:
                    t38_parameters_ast_to_fax(&details->their_t38_parameters, parameters);
                    t38negotiated = 1;
                    details->is_t38_negotiated = 1;
                    break;
                default:
                    break;
                }
                if (t38negotiated && !was_t38) {
                    if (fax->tech->switch_to_t38(fax)) {
                        GENERIC_FAX_EXEC_ERROR(fax, chan, "UNKNOWN", "T.38 switch failed");
                        break;
                    }
                    details->caps &= ~AST_FAX_TECH_AUDIO;
                    expected_frametype = AST_FRAME_MODEM;
                    expected_framesubclass.integer = AST_MODEM_T38;
                    if (fax->smoother) {
                        ast_smoother_free(fax->smoother);
                        fax->smoother = NULL;
                    }
 
                    report_fax_status(chan, details, "T.38 Negotiated");
 
                    ast_verb(3, "Channel '%s' switched to T.38 FAX session '%u'.\n", ast_channel_name(chan), fax->id);
                }
            } else if ((frame->frametype == expected_frametype) && (expected_framesubclass.integer == frame->subclass.integer) &&
                ((!frame->subclass.format && !expected_framesubclass.format) ||
                (frame->subclass.format && expected_framesubclass.format &&
                    (ast_format_cmp(frame->subclass.format, expected_framesubclass.format) != AST_FORMAT_CMP_NOT_EQUAL)))) {
                struct ast_frame *f;
 
                if (fax->smoother) {
                    /* push the frame into a smoother */
                    if (ast_smoother_feed(fax->smoother, frame) < 0) {
                        GENERIC_FAX_EXEC_ERROR(fax, chan, "UNKNOWN", "Failed to feed the smoother");
                    }
                    while ((f = ast_smoother_read(fax->smoother)) && (f->data.ptr)) {
                        if (fax->debug_info) {
                            debug_check_frame_for_silence(fax, 1, f);
                        }
                        /* write the frame to the FAX stack */
                        fax->tech->write(fax, f);
                        fax->frames_received++;
                        if (f != frame) {
                            ast_frfree(f);
                        }
                    }
                } else {
                    /* write the frame to the FAX stack */
                    fax->tech->write(fax, frame);
                    fax->frames_received++;
                }
                start = ast_tvnow();
            }
            ast_frfree(frame);
        } else if (ofd == fax->fd) {
            /* read a frame from the FAX stack and send it out the channel.
             * the FAX stack will return a NULL if the FAX session has already completed */
            if (!(frame = fax->tech->read(fax))) {
                break;
            }
 
            if (fax->debug_info && (frame->frametype == AST_FRAME_VOICE)) {
                debug_check_frame_for_silence(fax, 0, frame);
            }
 
            ast_write(chan, frame);
            fax->frames_sent++;
            ast_frfree(frame);
            start = ast_tvnow();
        } else {
            if (ms && (ofd < 0)) {
                if ((errno == 0) || (errno == EINTR)) {
                    remaining_time = ast_remaining_ms(start, timeout);
                    if (remaining_time <= 0)
                        GENERIC_FAX_EXEC_ERROR(fax, chan, "TIMEOUT", "fax session timed-out");
                    continue;
                } else {
                    ast_log(LOG_WARNING, "something bad happened while channel '%s' was polling.\n", ast_channel_name(chan));
                    GENERIC_FAX_EXEC_ERROR(fax, chan, "UNKNOWN", "error polling data");
                    break;
                }
            } else {
                /* nothing happened */
                remaining_time = ast_remaining_ms(start, timeout);
                if (remaining_time <= 0) {
                    GENERIC_FAX_EXEC_ERROR(fax, chan, "TIMEOUT", "fax session timed-out");
                    break;
                }
            }
        }
    }
    ast_debug(3, "channel '%s' - event loop stopped { timeout: %d, remaining_time: %d }\n", ast_channel_name(chan), timeout, remaining_time);
 
    set_channel_variables(chan, details);
 
    ast_atomic_fetchadd_int(&faxregistry.fax_complete, 1);
    if (!strcasecmp(details->result, "FAILED")) {
        ast_atomic_fetchadd_int(&faxregistry.fax_failures, 1);
    }
 
    if (fax) {
        ao2_unlink(faxregistry.container, fax);
        ao2_ref(fax, -1);
    }
 
    /* if the channel is still alive, and we changed its read/write formats,
     * restore them now
     */
    if (chancount) {
        if (orig_read_format) {
            ast_set_read_format(chan, orig_read_format);
        }
        if (orig_write_format) {
            ast_set_write_format(chan, orig_write_format);
        }
    }
 
    /* return the chancount so the calling function can determine if the channel hungup during this FAX session or not */
    return chancount;
}

References ao2_bump, ao2_cleanup, ao2_ref, ao2_unlink, ast_atomic_fetchadd_int(), ast_channel_get_t38_state(), ast_channel_lock, ast_channel_name(), ast_channel_readformat(), ast_channel_unlock, ast_channel_writeformat(), AST_CONTROL_T38_PARAMETERS, ast_debug, AST_FAX_TECH_AUDIO, AST_FAX_TECH_T38, ast_format_cmp(), AST_FORMAT_CMP_NOT_EQUAL, ast_format_slin, AST_FRAME_CONTROL, AST_FRAME_MODEM, AST_FRAME_VOICE, ast_frfree, ast_indicate_data(), ast_log, AST_MODEM_T38, ast_read(), ast_remaining_ms(), ast_set_read_format(), ast_set_write_format(), ast_smoother_feed, ast_smoother_free(), ast_smoother_new(), ast_smoother_read(), ast_string_field_set, ast_strlen_zero(), AST_T38_NEGOTIATED, AST_T38_REFUSED, AST_T38_REQUEST_NEGOTIATE, ast_tvnow(), ast_verb, ast_waitfor_nandfds(), ast_write(), ast_fax_debug_info::base_tv, c, ast_fax_tech::cancel_session, ast_fax_session_details::caps, chancount, ast_frame::data, ast_frame::datalen, debug_check_frame_for_silence(), ast_fax_session::debug_info, errno, error(), fax_session_new(), faxregistry, ast_fax_session::fd, ast_frame_subclass::format, ast_fax_session::frames_received, ast_fax_session::frames_sent, ast_frame::frametype, ast_fax_tech::generate_silence, GENERIC_FAX_EXEC_ERROR, GENERIC_FAX_EXEC_SET_VARS, ast_fax_session_details::headerinfo, ast_fax_session::id, ast_frame_subclass::integer, ast_fax_session_details::is_t38_negotiated, ast_fax_session_details::localstationid, LOG_ERROR, LOG_WARNING, NULL, ast_fax_session_details::our_t38_parameters, pbx_builtin_getvar_helper(), ast_frame::ptr, RAII_VAR, ast_fax_tech::read, report_fax_status(), ast_control_t38_parameters::request_response, RES_FAX_TIMEOUT, result, ast_fax_session_details::result, set_channel_variables(), ast_fax_session::smoother, ast_fax_tech::start_session, ast_frame::subclass, ast_fax_tech::switch_to_t38, t38_parameters_ast_to_fax(), t38_parameters_fax_to_ast(), T38_STATE_NEGOTIATED, ast_fax_session::tech, ast_fax_session_details::their_t38_parameters, and ast_fax_tech::write.

Referenced by receivefax_exec(), and sendfax_exec().

◆ get_general_options()

static void get_general_options ( struct fax_options * options )

static

Definition at line 4498 of file res_fax.c.

{
    ast_rwlock_rdlock(&options_lock);
    *options = general_options;
    ast_rwlock_unlock(&options_lock);
}

References ast_rwlock_rdlock, ast_rwlock_unlock, general_options, options, and options_lock.

Referenced by ast_fax_maxrate(), ast_fax_minrate(), cli_fax_show_settings(), and session_details_new().

◆ load_module()

static int load_module ( void )

static

Load the module.

Module loading including tests for configuration or dependencies. This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE, or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails tests return AST_MODULE_LOAD_FAILURE. If the module can not load the configuration file or other non-critical problem return AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.

Definition at line 4889 of file res_fax.c.

{
    int res;
 
    /* initialize the registry */
    faxregistry.active_sessions = 0;
    faxregistry.reserved_sessions = 0;
    faxregistry.container = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
        FAX_MAXBUCKETS, session_hash_cb, NULL, session_cmp_cb);
    if (!faxregistry.container) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (set_config(0) < 0) {
        ast_log(LOG_ERROR, "failed to load configuration file '%s'\n", config);
        ao2_ref(faxregistry.container, -1);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    /* register CLI operations and applications */
    if (ast_register_application_xml(app_sendfax, sendfax_exec) < 0) {
        ast_log(LOG_WARNING, "failed to register '%s'.\n", app_sendfax);
        ao2_ref(faxregistry.container, -1);
        return AST_MODULE_LOAD_DECLINE;
    }
    if (ast_register_application_xml(app_receivefax, receivefax_exec) < 0) {
        ast_log(LOG_WARNING, "failed to register '%s'.\n", app_receivefax);
        ast_unregister_application(app_sendfax);
        ao2_ref(faxregistry.container, -1);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_manager_register_xml("FAXSessions", EVENT_FLAG_CALL, manager_fax_sessions)) {
        ast_log(LOG_WARNING, "failed to register 'FAXSessions' AMI command.\n");
        ast_unregister_application(app_receivefax);
        ast_unregister_application(app_sendfax);
        ao2_ref(faxregistry.container, -1);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_manager_register_xml("FAXSession", EVENT_FLAG_CALL, manager_fax_session)) {
        ast_log(LOG_WARNING, "failed to register 'FAXSession' AMI command.\n");
        ast_manager_unregister("FAXSession");
        ast_unregister_application(app_receivefax);
        ast_unregister_application(app_sendfax);
        ao2_ref(faxregistry.container, -1);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_manager_register_xml("FAXStats", EVENT_FLAG_REPORTING, manager_fax_stats)) {
        ast_log(LOG_WARNING, "failed to register 'FAXStats' AMI command.\n");
        ast_manager_unregister("FAXSession");
        ast_manager_unregister("FAXSessions");
        ast_unregister_application(app_receivefax);
        ast_unregister_application(app_sendfax);
        ao2_ref(faxregistry.container, -1);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_cli_register_multiple(fax_cli, ARRAY_LEN(fax_cli));
    res = ast_custom_function_register(&acf_faxopt);
    fax_logger_level = ast_logger_register_level("FAX");
 
    return res;
}

References acf_faxopt, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ao2_ref, app_receivefax, app_sendfax, ARRAY_LEN, ast_cli_register_multiple, ast_custom_function_register, ast_log, ast_logger_register_level(), ast_manager_register_xml, ast_manager_unregister(), AST_MODULE_LOAD_DECLINE, ast_register_application_xml, ast_unregister_application(), config, EVENT_FLAG_CALL, EVENT_FLAG_REPORTING, fax_cli, fax_logger_level, FAX_MAXBUCKETS, faxregistry, LOG_ERROR, LOG_WARNING, manager_fax_session(), manager_fax_sessions(), manager_fax_stats(), NULL, receivefax_exec(), sendfax_exec(), session_cmp_cb(), session_hash_cb(), and set_config().

◆ manager_fax_session()

static int manager_fax_session	(	struct mansession *	s,
		const struct message *	m
	)

static

Definition at line 4244 of file res_fax.c.

{
    const char *action_id = astman_get_header(m, "ActionID");
    const char *session_number = astman_get_header(m, "SessionNumber");
    char id_text[256] = "";
    struct ast_fax_session *session;
    struct ast_fax_session find_session;
 
    if (sscanf(session_number, "%30u", &find_session.id) != 1) {
        astman_send_error(s, m, "Invalid session ID");
        return 0;
    }
 
    session = ao2_find(faxregistry.container, &find_session, OBJ_POINTER);
    if (!session) {
        astman_send_error(s, m, "Session not found");
        return 0;
    }
 
    if (!session->tech->manager_fax_session) {
        astman_send_error(s, m, "Fax technology doesn't provide a handler for FAXSession");
        ao2_ref(session, -1);
        return 0;
    }
 
    if (!ast_strlen_zero(action_id)) {
        snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", action_id);
    }
 
    astman_send_ack(s, m, "FAXSession event will follow");
 
    session->tech->manager_fax_session(s, id_text, session);
    ao2_ref(session, -1);
 
    return 0;
}

References ao2_find, ao2_ref, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), faxregistry, find_session(), OBJ_POINTER, and session.

Referenced by load_module().

◆ manager_fax_sessions()

static int manager_fax_sessions	(	struct mansession *	s,
		const struct message *	m
	)

static

Definition at line 4450 of file res_fax.c.

{
    const char *action_id = astman_get_header(m, "ActionID");
    char id_text[256];
    struct ast_fax_session *session;
    struct ao2_iterator iter;
    int session_count = 0;
 
    id_text[0] = '\0';
    if (!ast_strlen_zero(action_id)) {
        snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", action_id);
    }
 
    astman_send_listack(s, m, "FAXSessionsEntry event list will follow", "Start");
 
    iter = ao2_iterator_init(faxregistry.container, 0);
    while ((session = ao2_iterator_next(&iter))) {
        if (!manager_fax_sessions_entry(s, session, id_text)) {
            session_count++;
        }
        ao2_ref(session, -1);
    }
    ao2_iterator_destroy(&iter);
 
    astman_send_list_complete_start(s, m, "FAXSessionsComplete", session_count);
    astman_append(s, "Total: %d\r\n", session_count);
    astman_send_list_complete_end(s);
 
    return 0;
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), faxregistry, manager_fax_sessions_entry(), session, and session_count.

Referenced by load_module().

◆ manager_fax_sessions_entry()

static int manager_fax_sessions_entry	(	struct mansession *	s,
		struct ast_fax_session *	session,
		const char *	id_text
	)

static

Definition at line 4418 of file res_fax.c.

{
    char *filenames;
 
    ao2_lock(session);
    filenames = generate_filenames_string(session->details, "", ",");
 
    if (!filenames) {
        ast_log(LOG_ERROR, "Error generating Files string");
        ao2_unlock(session);
        return -1;
    }
 
    astman_append(s, "Event: FAXSessionsEntry\r\n"
        "%s" /* ActionID if present */
        "Channel: %s\r\n" /* Channel name */
        "Technology: %s\r\n" /* Fax session technology */
        "SessionNumber: %u\r\n" /* Session ID */
        "SessionType: %s\r\n" /* G711 or T38 */
        "Operation: %s\r\n"
        "State: %s\r\n"
        "Files: %s\r\n"
        "\r\n",
        id_text, session->channame, session->tech->type, session->id,
        fax_session_type(session), ast_fax_session_operation_str(session),
        ast_fax_state_to_str(session->state), S_OR(filenames, ""));
    ast_free(filenames);
    ao2_unlock(session);
    return 0;
}

References ao2_lock, ao2_unlock, ast_fax_session_operation_str(), ast_fax_state_to_str(), ast_free, ast_log, astman_append(), fax_session_type(), generate_filenames_string(), LOG_ERROR, S_OR, and session.

Referenced by manager_fax_sessions().

◆ manager_fax_stats()

static int manager_fax_stats	(	struct mansession *	s,
		const struct message *	m
	)

static

Definition at line 4314 of file res_fax.c.

{
    const char *action_id = astman_get_header(m, "ActionID");
 
    char id_text[256] = "";
 
    astman_send_ack(s, m, "FAXStats event will follow");
 
    if (!ast_strlen_zero(action_id)) {
        snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", action_id);
    }
 
    astman_append(s, "Event: FAXStats\r\n"
        "%s"
        "CurrentSessions: %d\r\n"
        "ReservedSessions: %d\r\n"
        "TransmitAttempts: %d\r\n"
        "ReceiveAttempts: %d\r\n"
        "CompletedFAXes: %d\r\n"
        "FailedFAXes: %d\r\n"
        "\r\n",
        id_text,
        faxregistry.active_sessions, faxregistry.reserved_sessions,
        faxregistry.fax_tx_attempts, faxregistry.fax_rx_attempts,
        faxregistry.fax_complete, faxregistry.fax_failures);
 
    return 0;
}

References ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_ack(), and faxregistry.

Referenced by load_module().

◆ receivefax_exec()

static int receivefax_exec	(	struct ast_channel *	chan,
		const char *	data
	)

static

initiate a receive FAX session

Definition at line 2183 of file res_fax.c.

{
    char *parse, modems[128] = "";
    int channel_alive;
    RAII_VAR(struct ast_fax_session *, s, NULL, ao2_cleanup);
    RAII_VAR(struct ast_fax_session_details *, details, NULL, ao2_cleanup);
    struct ast_fax_tech_token *token = NULL;
    struct ast_fax_document *doc;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(filename);
        AST_APP_ARG(options);
    );
    struct ast_flags opts = { 0, };
    enum ast_t38_state t38state;
 
    /* initialize output channel variables */
    pbx_builtin_setvar_helper(chan, "FAXSTATUS", "FAILED");
    pbx_builtin_setvar_helper(chan, "REMOTESTATIONID", NULL);
    pbx_builtin_setvar_helper(chan, "FAXPAGES", "0");
    pbx_builtin_setvar_helper(chan, "FAXBITRATE", NULL);
    pbx_builtin_setvar_helper(chan, "FAXRESOLUTION", NULL);
    pbx_builtin_setvar_helper(chan, "FAXMODE", NULL);
 
    /* Get a FAX session details structure from the channel's FAX datastore and create one if
     * it does not already exist. */
    if (!(details = find_or_create_details(chan))) {
        pbx_builtin_setvar_helper(chan, "FAXERROR", "MEMORY_ERROR");
        pbx_builtin_setvar_helper(chan, "FAXSTATUSSTRING", "error allocating memory");
        ast_log(LOG_ERROR, "System cannot provide memory for session requirements.\n");
        return -1;
    }
 
    ast_string_field_set(details, result, "FAILED");
    ast_string_field_set(details, resultstr, "error starting fax session");
    ast_string_field_set(details, error, "INIT_ERROR");
    set_channel_variables(chan, details);
 
    if (details->gateway_id > 0) {
        ast_string_field_set(details, resultstr, "can't receive a fax on a channel with a T.38 gateway");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "executing ReceiveFAX on a channel with a T.38 Gateway is not supported\n");
        return -1;
    }
 
    if (details->maxrate < details->minrate) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "maxrate is less than minrate");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "maxrate %u is less than minrate %u\n", details->maxrate, details->minrate);
        return -1;
    }
 
    if (check_modem_rate(details->modems, details->minrate)) {
        ast_fax_modem_to_str(details->modems, modems, sizeof(modems));
        ast_log(LOG_ERROR, "'modems' setting '%s' is incompatible with 'minrate' setting %u\n", modems, details->minrate);
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "incompatible 'modems' and 'minrate' settings");
        set_channel_variables(chan, details);
        return -1;
    }
 
    if (check_modem_rate(details->modems, details->maxrate)) {
        ast_fax_modem_to_str(details->modems, modems, sizeof(modems));
        ast_log(LOG_ERROR, "'modems' setting '%s' is incompatible with 'maxrate' setting %u\n", modems, details->maxrate);
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "incompatible 'modems' and 'maxrate' settings");
        set_channel_variables(chan, details);
        return -1;
    }
 
    if (ast_strlen_zero(data)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        ast_log(LOG_WARNING, "%s requires an argument (filename[,options])\n", app_receivefax);
        return -1;
    }
    parse = ast_strdupa(data);
    AST_STANDARD_APP_ARGS(args, parse);
 
    if (!ast_strlen_zero(args.options) &&
        ast_app_parse_options(fax_exec_options, &opts, NULL, args.options)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        return -1;
    }
    if (ast_strlen_zero(args.filename)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        ast_log(LOG_WARNING, "%s requires an argument (filename[,options])\n", app_receivefax);
        return -1;
    }
 
    /* check for unsupported FAX application options */
    if (ast_test_flag(&opts, OPT_CALLERMODE) || ast_test_flag(&opts, OPT_CALLEDMODE)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        ast_log(LOG_WARNING, "%s does not support polling\n", app_receivefax);
        return -1;
    }
 
    ast_atomic_fetchadd_int(&faxregistry.fax_rx_attempts, 1);
 
    pbx_builtin_setvar_helper(chan, "FAXERROR", "Channel Problems");
    pbx_builtin_setvar_helper(chan, "FAXSTATUSSTRING", "Error before FAX transmission started.");
 
    if (!(doc = ast_calloc(1, sizeof(*doc) + strlen(args.filename) + 1))) {
        ast_string_field_set(details, error, "MEMORY_ERROR");
        ast_string_field_set(details, resultstr, "error allocating memory");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "System cannot provide memory for session requirements.\n");
        return -1;
    }
 
    strcpy(doc->filename, args.filename);
    AST_LIST_INSERT_TAIL(&details->documents, doc, next);
 
    ast_verb(3, "Channel '%s' receiving FAX '%s'\n", ast_channel_name(chan), args.filename);
 
    details->caps = AST_FAX_TECH_RECEIVE;
    details->option.send_ced = AST_FAX_OPTFLAG_TRUE;
 
    /* check for debug */
    if (ast_test_flag(&opts, OPT_DEBUG) || global_fax_debug) {
        details->option.debug = AST_FAX_OPTFLAG_TRUE;
    }
 
    /* check for request for status events */
    if (ast_test_flag(&opts, OPT_STATUS)) {
        details->option.statusevents = AST_FAX_OPTFLAG_TRUE;
    }
 
    t38state = ast_channel_get_t38_state(chan);
    if ((t38state == T38_STATE_UNAVAILABLE) || (t38state == T38_STATE_REJECTED) ||
        ast_test_flag(&opts, OPT_ALLOWAUDIO) ||
        ast_test_flag(&opts, OPT_FORCE_AUDIO)) {
        details->option.allow_audio = AST_FAX_OPTFLAG_TRUE;
    }
 
    if (!(s = fax_session_reserve(details, &token))) {
        ast_string_field_set(details, resultstr, "error reserving fax session");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "Unable to reserve FAX session.\n");
        return -1;
    }
 
    /* make sure the channel is up */
    if (ast_channel_state(chan) != AST_STATE_UP) {
        if (ast_answer(chan)) {
            ast_string_field_set(details, resultstr, "error answering channel");
            set_channel_variables(chan, details);
            ast_log(LOG_WARNING, "Channel '%s' failed answer attempt.\n", ast_channel_name(chan));
            fax_session_release(s, token);
            return -1;
        }
    }
 
    if (!ast_test_flag(&opts, OPT_FORCE_AUDIO)) {
        if (set_fax_t38_caps(chan, details)) {
            ast_string_field_set(details, error, "T38_NEG_ERROR");
            ast_string_field_set(details, resultstr, "error negotiating T.38");
            set_channel_variables(chan, details);
            fax_session_release(s, token);
            return -1;
        }
    } else {
        details->caps |= AST_FAX_TECH_AUDIO;
    }
 
    if (!ast_test_flag(&opts, OPT_FORCE_AUDIO) && (details->caps & AST_FAX_TECH_T38)) {
        if (receivefax_t38_init(chan, details)) {
            ast_string_field_set(details, error, "T38_NEG_ERROR");
            ast_string_field_set(details, resultstr, "error negotiating T.38");
            set_channel_variables(chan, details);
            fax_session_release(s, token);
            ast_log(LOG_ERROR, "error initializing channel '%s' in T.38 mode\n", ast_channel_name(chan));
            return -1;
        }
    }
 
    if ((channel_alive = generic_fax_exec(chan, details, s, token)) < 0) {
        ast_atomic_fetchadd_int(&faxregistry.fax_failures, 1);
    }
 
    if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
        if (disable_t38(chan)) {
            ast_debug(1, "error disabling T.38 mode on %s\n", ast_channel_name(chan));
        }
    }
 
    if (report_receive_fax_status(chan, args.filename)) {
        ast_log(AST_LOG_ERROR, "Error publishing ReceiveFAX status message\n");
    }
 
    /* If the channel hungup return -1; otherwise, return 0 to continue in the dialplan */
    return (!channel_alive) ? -1 : 0;
}

References ao2_cleanup, app_receivefax, args, ast_answer(), AST_APP_ARG, ast_app_parse_options(), ast_atomic_fetchadd_int(), ast_calloc, ast_channel_get_t38_state(), ast_channel_name(), ast_debug, AST_DECLARE_APP_ARGS, ast_fax_modem_to_str(), AST_FAX_OPTFLAG_TRUE, AST_FAX_TECH_AUDIO, AST_FAX_TECH_RECEIVE, AST_FAX_TECH_T38, AST_LIST_INSERT_TAIL, ast_log, AST_LOG_ERROR, AST_STANDARD_APP_ARGS, AST_STATE_UP, ast_strdupa, ast_string_field_set, ast_strlen_zero(), ast_test_flag, ast_verb, check_modem_rate(), disable_t38(), error(), fax_exec_options, fax_session_release(), fax_session_reserve(), faxregistry, ast_fax_document::filename, find_or_create_details(), generic_fax_exec(), global_fax_debug, LOG_ERROR, LOG_WARNING, NULL, OPT_ALLOWAUDIO, OPT_CALLEDMODE, OPT_CALLERMODE, OPT_DEBUG, OPT_FORCE_AUDIO, OPT_STATUS, options, pbx_builtin_setvar_helper(), RAII_VAR, receivefax_t38_init(), report_receive_fax_status(), result, set_channel_variables(), set_fax_t38_caps(), T38_STATE_NEGOTIATED, T38_STATE_REJECTED, and T38_STATE_UNAVAILABLE.

Referenced by load_module().

◆ receivefax_t38_init()

static int receivefax_t38_init	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Definition at line 1957 of file res_fax.c.

{
    int timeout_ms;
    struct ast_frame *frame = NULL;
    struct ast_control_t38_parameters t38_parameters;
    struct timeval start;
    int ms;
 
    /* don't send any audio if we've already received a T.38 reinvite */
    if (ast_channel_get_t38_state(chan) != T38_STATE_NEGOTIATING) {
        /* generate 3 seconds of CED */
        if (ast_playtones_start(chan, 1024, "!2100/3000", 1)) {
            ast_log(LOG_ERROR, "error generating CED tone on %s\n", ast_channel_name(chan));
            return -1;
        }
 
        timeout_ms = 3000;
        start = ast_tvnow();
        while ((ms = ast_remaining_ms(start, timeout_ms))) {
            ms = ast_waitfor(chan, ms);
 
            if (ms < 0) {
                ast_log(LOG_ERROR, "error while generating CED tone on %s\n", ast_channel_name(chan));
                ast_playtones_stop(chan);
                return -1;
            }
 
            if (ms == 0) { /* all done, nothing happened */
                break;
            }
 
            if (!(frame = ast_read(chan))) {
                ast_log(LOG_ERROR, "error reading frame while generating CED tone on %s\n", ast_channel_name(chan));
                ast_playtones_stop(chan);
                return -1;
            }
 
            if ((frame->frametype == AST_FRAME_CONTROL) &&
                (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
                (frame->datalen == sizeof(t38_parameters))) {
                struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
                switch (parameters->request_response) {
                case AST_T38_REQUEST_NEGOTIATE:
                    /* the other end has requested a switch to T.38, so reply that we are willing, if we can
                     * do T.38 as well
                     */
                    t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
                    t38_parameters.request_response = (details->caps & AST_FAX_TECH_T38) ? AST_T38_NEGOTIATED : AST_T38_REFUSED;
                    ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters));
                    ast_playtones_stop(chan);
                    break;
                case AST_T38_NEGOTIATED:
                    ast_debug(1, "Negotiated T.38 for receive on %s\n", ast_channel_name(chan));
                    t38_parameters_ast_to_fax(&details->their_t38_parameters, parameters);
                    details->caps &= ~AST_FAX_TECH_AUDIO;
                    report_fax_status(chan, details, "T.38 Negotiated");
                    break;
                default:
                    break;
                }
            }
            ast_frfree(frame);
        }
 
        ast_playtones_stop(chan);
    }
 
    /* if T.38 was negotiated, we are done initializing */
    if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
        return 0;
    }
 
    /* request T.38 */
    ast_debug(1, "Negotiating T.38 for receive on %s\n", ast_channel_name(chan));
 
    /* wait for negotiation to complete */
    timeout_ms = details->t38timeout;
 
    /* set parameters based on the session's parameters */
    t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
    t38_parameters.request_response = AST_T38_REQUEST_NEGOTIATE;
    if ((ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters)) != 0)) {
        return -1;
    }
 
    start = ast_tvnow();
    while ((ms = ast_remaining_ms(start, timeout_ms))) {
        int break_loop = 0;
 
        ms = ast_waitfor(chan, ms);
        if (ms < 0) {
            ast_log(LOG_WARNING, "error on '%s' while waiting for T.38 negotiation.\n", ast_channel_name(chan));
            return -1;
        }
        if (ms == 0) { /* all done, nothing happened */
            ast_log(LOG_WARNING, "channel '%s' timed-out during the T.38 negotiation.\n", ast_channel_name(chan));
            details->caps &= ~AST_FAX_TECH_T38;
            break;
        }
 
        if (!(frame = ast_read(chan))) {
            ast_log(LOG_WARNING, "error on '%s' while waiting for T.38 negotiation.\n", ast_channel_name(chan));
            return -1;
        }
 
        if ((frame->frametype == AST_FRAME_CONTROL) &&
                (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
                (frame->datalen == sizeof(t38_parameters))) {
            struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
            switch (parameters->request_response) {
            case AST_T38_REQUEST_NEGOTIATE:
                t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
                t38_parameters.request_response = AST_T38_NEGOTIATED;
                ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters));
                break;
            case AST_T38_NEGOTIATED:
                ast_debug(1, "Negotiated T.38 for receive on %s\n", ast_channel_name(chan));
                t38_parameters_ast_to_fax(&details->their_t38_parameters, parameters);
                details->caps &= ~AST_FAX_TECH_AUDIO;
                report_fax_status(chan, details, "T.38 Negotiated");
                break_loop = 1;
                break;
            case AST_T38_REFUSED:
                ast_log(LOG_WARNING, "channel '%s' refused to negotiate T.38\n", ast_channel_name(chan));
                details->caps &= ~AST_FAX_TECH_T38;
                break_loop = 1;
                break;
            default:
                ast_log(LOG_ERROR, "channel '%s' failed to negotiate T.38\n", ast_channel_name(chan));
                details->caps &= ~AST_FAX_TECH_T38;
                break_loop = 1;
                break;
            }
        }
        ast_frfree(frame);
        if (break_loop) {
            break;
        }
    }
 
    /* if T.38 was negotiated, we are done initializing */
    if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
        return 0;
    }
 
    /* if we made it here, then T.38 failed, check the 'f' flag */
    if (details->option.allow_audio != AST_FAX_OPTFLAG_TRUE) {
        ast_log(LOG_WARNING, "Audio FAX not allowed on channel '%s' and T.38 negotiation failed; aborting.\n", ast_channel_name(chan));
        return -1;
    }
 
    /* ok, audio fallback is allowed */
    details->caps |= AST_FAX_TECH_AUDIO;
 
    return 0;
}

References ast_fax_session_details::allow_audio, ast_channel_get_t38_state(), ast_channel_name(), AST_CONTROL_T38_PARAMETERS, ast_debug, AST_FAX_OPTFLAG_TRUE, AST_FAX_TECH_AUDIO, AST_FAX_TECH_T38, AST_FRAME_CONTROL, ast_frfree, ast_indicate_data(), ast_log, ast_playtones_start(), ast_playtones_stop(), ast_read(), ast_remaining_ms(), AST_T38_NEGOTIATED, AST_T38_REFUSED, AST_T38_REQUEST_NEGOTIATE, ast_tvnow(), ast_waitfor(), ast_fax_session_details::caps, ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame_subclass::integer, LOG_ERROR, LOG_WARNING, NULL, ast_fax_session_details::option, ast_fax_session_details::our_t38_parameters, ast_frame::ptr, report_fax_status(), ast_control_t38_parameters::request_response, ast_frame::subclass, t38_parameters_ast_to_fax(), t38_parameters_fax_to_ast(), T38_STATE_NEGOTIATED, T38_STATE_NEGOTIATING, ast_fax_session_details::t38timeout, and ast_fax_session_details::their_t38_parameters.

Referenced by receivefax_exec().

◆ reload_module()

static int reload_module ( void )

static

Definition at line 4955 of file res_fax.c.

{
    set_config(1);
    return 0;
}

References set_config().

◆ report_fax_status()

static int report_fax_status	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details,
		const char *	status
	)

static

send a FAX status manager event

Definition at line 1508 of file res_fax.c.

{
    RAII_VAR(struct ast_json *, json_object, NULL, ast_json_unref);
    RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
    struct ast_json *json_filenames = NULL;
 
    if (!details->option.statusevents) {
        return 0;
    }
 
    json_filenames = generate_filenames_json(details);
    if (!json_filenames) {
        return -1;
    }
 
    json_object = ast_json_pack("{s: s, s: s, s: s, s: s, s: o}",
        "type", "status",
        "operation", (details->caps & AST_FAX_TECH_GATEWAY)
            ? "gateway"
            : (details->caps & AST_FAX_TECH_RECEIVE) ? "receive" : "send",
        "status", status,
        "local_station_id", AST_JSON_UTF8_VALIDATE(details->localstationid),
        "filenames", json_filenames);
    if (!json_object) {
        return -1;
    }
 
    {
        SCOPED_CHANNELLOCK(lock, chan);
 
        message = ast_channel_blob_create_from_cache(ast_channel_uniqueid(chan), ast_channel_fax_type(), json_object);
        if (!message) {
            return -1;
        }
        stasis_publish(ast_channel_topic(chan), message);
    }
    return 0;
}

References ao2_cleanup, ast_channel_blob_create_from_cache(), ast_channel_fax_type(), ast_channel_topic(), ast_channel_uniqueid(), AST_FAX_TECH_GATEWAY, AST_FAX_TECH_RECEIVE, ast_json_pack(), ast_json_unref(), AST_JSON_UTF8_VALIDATE, ast_fax_session_details::caps, generate_filenames_json(), ast_fax_session_details::localstationid, lock, NULL, ast_fax_session_details::option, RAII_VAR, SCOPED_CHANNELLOCK, stasis_publish(), status, and ast_fax_session_details::statusevents.

Referenced by fax_gateway_attach(), fax_gateway_detect_t38(), fax_gateway_start(), generic_fax_exec(), receivefax_t38_init(), and sendfax_t38_init().

◆ report_receive_fax_status()

static int report_receive_fax_status	(	struct ast_channel *	chan,
		const char *	filename
	)

static

Report on the final state of a receive fax operation.

Note: This will lock the ast_channel

Definition at line 2119 of file res_fax.c.

{
    RAII_VAR(struct ast_json *, json_object, NULL, ast_json_unref);
    RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
    RAII_VAR(struct ast_json *, json_array, ast_json_array_create(), ast_json_unref);
    struct ast_json *json_filename = ast_json_string_create(filename);
 
    if (!json_array || !json_filename) {
        ast_json_unref(json_filename);
        return -1;
    }
    ast_json_array_append(json_array, json_filename);
 
    {
        const char *remote_station_id;
        const char *local_station_id;
        const char *fax_pages;
        const char *fax_resolution;
        const char *fax_bitrate;
        SCOPED_CHANNELLOCK(lock, chan);
 
        remote_station_id = AST_JSON_UTF8_VALIDATE(pbx_builtin_getvar_helper(chan, "REMOTESTATIONID"));
        if (!ast_strlen_zero(remote_station_id)) {
            remote_station_id = ast_strdupa(remote_station_id);
        }
        local_station_id = AST_JSON_UTF8_VALIDATE(pbx_builtin_getvar_helper(chan, "LOCALSTATIONID"));
        if (!ast_strlen_zero(local_station_id)) {
            local_station_id = ast_strdupa(local_station_id);
        }
        fax_pages = S_OR(pbx_builtin_getvar_helper(chan, "FAXPAGES"), "");
        if (!ast_strlen_zero(fax_pages)) {
            fax_pages = ast_strdupa(fax_pages);
        }
        fax_resolution = S_OR(pbx_builtin_getvar_helper(chan, "FAXRESOLUTION"), "");
        if (!ast_strlen_zero(fax_resolution)) {
            fax_resolution = ast_strdupa(fax_resolution);
        }
        fax_bitrate = S_OR(pbx_builtin_getvar_helper(chan, "FAXBITRATE"), "");
        if (!ast_strlen_zero(fax_bitrate)) {
            fax_bitrate = ast_strdupa(fax_bitrate);
        }
 
        json_object = ast_json_pack("{s: s, s: s, s: s, s: s, s: s, s: s, s: o}",
                "type", "receive",
                "remote_station_id", S_OR(remote_station_id, ""),
                "local_station_id", S_OR(local_station_id, ""),
                "fax_pages", S_OR(fax_pages, ""),
                "fax_resolution", S_OR(fax_resolution, ""),
                "fax_bitrate", S_OR(fax_bitrate, ""),
                "filenames", ast_json_ref(json_array));
        if (!json_object) {
            return -1;
        }
 
        message = ast_channel_blob_create_from_cache(ast_channel_uniqueid(chan), ast_channel_fax_type(), json_object);
        if (!message) {
            return -1;
        }
        stasis_publish(ast_channel_topic(chan), message);
    }
    return 0;
}

References ao2_cleanup, ast_channel_blob_create_from_cache(), ast_channel_fax_type(), ast_channel_topic(), ast_channel_uniqueid(), ast_json_array_append(), ast_json_array_create(), ast_json_pack(), ast_json_ref(), ast_json_string_create(), ast_json_unref(), AST_JSON_UTF8_VALIDATE, ast_strdupa, ast_strlen_zero(), lock, NULL, pbx_builtin_getvar_helper(), RAII_VAR, S_OR, SCOPED_CHANNELLOCK, and stasis_publish().

Referenced by receivefax_exec().

◆ report_send_fax_status()

static int report_send_fax_status	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Report on the status of a completed fax send attempt.

Note: This will lock the ast_channel

Definition at line 2628 of file res_fax.c.

{
    RAII_VAR(struct ast_json *, json_obj, NULL, ast_json_unref);
    RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
    struct ast_json *json_filenames;
 
    json_filenames = generate_filenames_json(details);
    if (!json_filenames) {
        return -1;
    }
 
    {
        const char *remote_station_id;
        const char *local_station_id;
        const char *fax_pages;
        const char *fax_resolution;
        const char *fax_bitrate;
        SCOPED_CHANNELLOCK(lock, chan);
 
        remote_station_id = AST_JSON_UTF8_VALIDATE(pbx_builtin_getvar_helper(chan, "REMOTESTATIONID"));
        if (!ast_strlen_zero(remote_station_id)) {
            remote_station_id = ast_strdupa(remote_station_id);
        }
        local_station_id = AST_JSON_UTF8_VALIDATE(pbx_builtin_getvar_helper(chan, "LOCALSTATIONID"));
        if (!ast_strlen_zero(local_station_id)) {
            local_station_id = ast_strdupa(local_station_id);
        }
        fax_pages = S_OR(pbx_builtin_getvar_helper(chan, "FAXPAGES"), "");
        if (!ast_strlen_zero(fax_pages)) {
            fax_pages = ast_strdupa(fax_pages);
        }
        fax_resolution = S_OR(pbx_builtin_getvar_helper(chan, "FAXRESOLUTION"), "");
        if (!ast_strlen_zero(fax_resolution)) {
            fax_resolution = ast_strdupa(fax_resolution);
        }
        fax_bitrate = S_OR(pbx_builtin_getvar_helper(chan, "FAXBITRATE"), "");
        if (!ast_strlen_zero(fax_bitrate)) {
            fax_bitrate = ast_strdupa(fax_bitrate);
        }
        json_obj = ast_json_pack("{s: s, s: s, s: s, s: s, s: s, s: s, s: o}",
                "type", "send",
                "remote_station_id", S_OR(remote_station_id, ""),
                "local_station_id", S_OR(local_station_id, ""),
                "fax_pages", S_OR(fax_pages, ""),
                "fax_resolution", S_OR(fax_resolution, ""),
                "fax_bitrate", S_OR(fax_bitrate, ""),
                "filenames", json_filenames);
        if (!json_obj) {
            return -1;
        }
 
        message = ast_channel_blob_create_from_cache(ast_channel_uniqueid(chan), ast_channel_fax_type(), json_obj);
        if (!message) {
            return -1;
        }
        stasis_publish(ast_channel_topic(chan), message);
    }
    return 0;
}

References ao2_cleanup, ast_channel_blob_create_from_cache(), ast_channel_fax_type(), ast_channel_topic(), ast_channel_uniqueid(), ast_json_pack(), ast_json_unref(), AST_JSON_UTF8_VALIDATE, ast_strdupa, ast_strlen_zero(), generate_filenames_json(), lock, NULL, pbx_builtin_getvar_helper(), RAII_VAR, S_OR, SCOPED_CHANNELLOCK, and stasis_publish().

Referenced by sendfax_exec().

◆ sendfax_exec()

static int sendfax_exec	(	struct ast_channel *	chan,
		const char *	data
	)

static

initiate a send FAX session

Definition at line 2691 of file res_fax.c.

{
    char *parse, *filenames, *c, modems[128] = "";
    int channel_alive, file_count;
    RAII_VAR(struct ast_fax_session_details *, details, NULL, ao2_cleanup);
    RAII_VAR(struct ast_fax_session *, s, NULL, ao2_cleanup);
    struct ast_fax_tech_token *token = NULL;
    struct ast_fax_document *doc;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(filenames);
        AST_APP_ARG(options);
    );
    struct ast_flags opts = { 0, };
    enum ast_t38_state t38state;
 
    /* initialize output channel variables */
    pbx_builtin_setvar_helper(chan, "FAXSTATUS", "FAILED");
    pbx_builtin_setvar_helper(chan, "REMOTESTATIONID", NULL);
    pbx_builtin_setvar_helper(chan, "FAXPAGES", "0");
    pbx_builtin_setvar_helper(chan, "FAXBITRATE", NULL);
    pbx_builtin_setvar_helper(chan, "FAXRESOLUTION", NULL);
    pbx_builtin_setvar_helper(chan, "FAXMODE", NULL);
 
    /* Get a requirement structure and set it.  This structure is used
     * to tell the FAX technology module about the higher level FAX session */
    if (!(details = find_or_create_details(chan))) {
        pbx_builtin_setvar_helper(chan, "FAXERROR", "MEMORY_ERROR");
        pbx_builtin_setvar_helper(chan, "FAXSTATUSSTRING", "error allocating memory");
        ast_log(LOG_ERROR, "System cannot provide memory for session requirements.\n");
        return -1;
    }
 
    ast_string_field_set(details, result, "FAILED");
    ast_string_field_set(details, resultstr, "error starting fax session");
    ast_string_field_set(details, error, "INIT_ERROR");
    set_channel_variables(chan, details);
 
    if (details->gateway_id > 0) {
        ast_string_field_set(details, resultstr, "can't send a fax on a channel with a T.38 gateway");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "executing SendFAX on a channel with a T.38 Gateway is not supported\n");
        return -1;
    }
 
    if (details->maxrate < details->minrate) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "maxrate is less than minrate");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "maxrate %u is less than minrate %u\n", details->maxrate, details->minrate);
        return -1;
    }
 
    if (check_modem_rate(details->modems, details->minrate)) {
        ast_fax_modem_to_str(details->modems, modems, sizeof(modems));
        ast_log(LOG_ERROR, "'modems' setting '%s' is incompatible with 'minrate' setting %u\n", modems, details->minrate);
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "incompatible 'modems' and 'minrate' settings");
        set_channel_variables(chan, details);
        return -1;
    }
 
    if (check_modem_rate(details->modems, details->maxrate)) {
        ast_fax_modem_to_str(details->modems, modems, sizeof(modems));
        ast_log(LOG_ERROR, "'modems' setting '%s' is incompatible with 'maxrate' setting %u\n", modems, details->maxrate);
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "incompatible 'modems' and 'maxrate' settings");
        set_channel_variables(chan, details);
        return -1;
    }
 
    if (ast_strlen_zero(data)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        ast_log(LOG_WARNING, "%s requires an argument (filename[&filename[&filename]][,options])\n", app_sendfax);
        return -1;
    }
    parse = ast_strdupa(data);
    AST_STANDARD_APP_ARGS(args, parse);
 
 
    if (!ast_strlen_zero(args.options) &&
        ast_app_parse_options(fax_exec_options, &opts, NULL, args.options)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        return -1;
    }
    if (ast_strlen_zero(args.filenames)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        ast_log(LOG_WARNING, "%s requires an argument (filename[&filename[&filename]],options])\n", app_sendfax);
        return -1;
    }
 
    /* check for unsupported FAX application options */
    if (ast_test_flag(&opts, OPT_CALLERMODE) || ast_test_flag(&opts, OPT_CALLEDMODE)) {
        ast_string_field_set(details, error, "INVALID_ARGUMENTS");
        ast_string_field_set(details, resultstr, "invalid arguments");
        set_channel_variables(chan, details);
        ast_log(LOG_WARNING, "%s does not support polling\n", app_sendfax);
        return -1;
    }
 
    ast_atomic_fetchadd_int(&faxregistry.fax_tx_attempts, 1);
 
    file_count = 0;
    filenames = args.filenames;
    while ((c = strsep(&filenames, "&"))) {
        if (access(c, (F_OK | R_OK)) < 0) {
            ast_string_field_set(details, error, "FILE_ERROR");
            ast_string_field_set(details, resultstr, "error reading file");
            set_channel_variables(chan, details);
            ast_log(LOG_ERROR, "access failure.  Verify '%s' exists and check permissions.\n", args.filenames);
            return -1;
        }
 
        if (!(doc = ast_calloc(1, sizeof(*doc) + strlen(c) + 1))) {
            ast_string_field_set(details, error, "MEMORY_ERROR");
            ast_string_field_set(details, resultstr, "error allocating memory");
            set_channel_variables(chan, details);
            ast_log(LOG_ERROR, "System cannot provide memory for session requirements.\n");
            return -1;
        }
 
        strcpy(doc->filename, c);
        AST_LIST_INSERT_TAIL(&details->documents, doc, next);
        file_count++;
    }
 
    ast_verb(3, "Channel '%s' sending FAX:\n", ast_channel_name(chan));
    AST_LIST_TRAVERSE(&details->documents, doc, next) {
        ast_verb(3, "   %s\n", doc->filename);
    }
 
    details->caps = AST_FAX_TECH_SEND;
 
    if (file_count > 1) {
        details->caps |= AST_FAX_TECH_MULTI_DOC;
    }
 
    /* check for debug */
    if (ast_test_flag(&opts, OPT_DEBUG) || global_fax_debug) {
        details->option.debug = AST_FAX_OPTFLAG_TRUE;
    }
 
    /* check for request for status events */
    if (ast_test_flag(&opts, OPT_STATUS)) {
        details->option.statusevents = AST_FAX_OPTFLAG_TRUE;
    }
 
    t38state = ast_channel_get_t38_state(chan);
    if ((t38state == T38_STATE_UNAVAILABLE) || (t38state == T38_STATE_REJECTED) ||
        ast_test_flag(&opts, OPT_ALLOWAUDIO) ||
        ast_test_flag(&opts, OPT_FORCE_AUDIO)) {
        details->option.allow_audio = AST_FAX_OPTFLAG_TRUE;
    }
 
    if (ast_test_flag(&opts, OPT_REQUEST_T38)) {
        details->option.request_t38 = AST_FAX_OPTFLAG_TRUE;
    }
 
    if (!(s = fax_session_reserve(details, &token))) {
        ast_string_field_set(details, resultstr, "error reserving fax session");
        set_channel_variables(chan, details);
        ast_log(LOG_ERROR, "Unable to reserve FAX session.\n");
        return -1;
    }
 
    /* make sure the channel is up */
    if (ast_channel_state(chan) != AST_STATE_UP) {
        if (ast_answer(chan)) {
            ast_string_field_set(details, resultstr, "error answering channel");
            set_channel_variables(chan, details);
            ast_log(LOG_WARNING, "Channel '%s' failed answer attempt.\n", ast_channel_name(chan));
            fax_session_release(s, token);
            return -1;
        }
    }
 
    if (!ast_test_flag(&opts, OPT_FORCE_AUDIO)) {
        if (set_fax_t38_caps(chan, details)) {
            ast_string_field_set(details, error, "T38_NEG_ERROR");
            ast_string_field_set(details, resultstr, "error negotiating T.38");
            set_channel_variables(chan, details);
            fax_session_release(s, token);
            return -1;
        }
    } else {
        details->caps |= AST_FAX_TECH_AUDIO;
    }
 
    if (!ast_test_flag(&opts, OPT_FORCE_AUDIO) && (details->caps & AST_FAX_TECH_T38)) {
        if (sendfax_t38_init(chan, details)) {
            ast_string_field_set(details, error, "T38_NEG_ERROR");
            ast_string_field_set(details, resultstr, "error negotiating T.38");
            set_channel_variables(chan, details);
            fax_session_release(s, token);
            ast_log(LOG_ERROR, "error initializing channel '%s' in T.38 mode\n", ast_channel_name(chan));
            return -1;
        }
    } else {
        details->option.send_cng = 1;
    }
 
    if ((channel_alive = generic_fax_exec(chan, details, s, token)) < 0) {
        ast_atomic_fetchadd_int(&faxregistry.fax_failures, 1);
    }
 
    if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
        if (disable_t38(chan)) {
            ast_debug(1, "error disabling T.38 mode on %s\n", ast_channel_name(chan));
        }
    }
 
    if (!(filenames = generate_filenames_string(details, "FileName: ", "\r\n"))) {
        ast_log(LOG_ERROR, "Error generating SendFAX manager event\n");
        return (!channel_alive) ? -1 : 0;
    }
 
    /* send out the AMI completion event */
    if (report_send_fax_status(chan, details)) {
        ast_log(AST_LOG_ERROR, "Error publishing SendFAX status message\n");
    }
 
    /* If the channel hungup return -1; otherwise, return 0 to continue in the dialplan */
    return (!channel_alive) ? -1 : 0;
}

References ao2_cleanup, app_sendfax, args, ast_answer(), AST_APP_ARG, ast_app_parse_options(), ast_atomic_fetchadd_int(), ast_calloc, ast_channel_get_t38_state(), ast_channel_name(), ast_debug, AST_DECLARE_APP_ARGS, ast_fax_modem_to_str(), AST_FAX_OPTFLAG_TRUE, AST_FAX_TECH_AUDIO, AST_FAX_TECH_MULTI_DOC, AST_FAX_TECH_SEND, AST_FAX_TECH_T38, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_log, AST_LOG_ERROR, AST_STANDARD_APP_ARGS, AST_STATE_UP, ast_strdupa, ast_string_field_set, ast_strlen_zero(), ast_test_flag, ast_verb, c, check_modem_rate(), disable_t38(), error(), F_OK, fax_exec_options, fax_session_release(), fax_session_reserve(), faxregistry, ast_fax_document::filename, find_or_create_details(), generate_filenames_string(), generic_fax_exec(), global_fax_debug, LOG_ERROR, LOG_WARNING, NULL, OPT_ALLOWAUDIO, OPT_CALLEDMODE, OPT_CALLERMODE, OPT_DEBUG, OPT_FORCE_AUDIO, OPT_REQUEST_T38, OPT_STATUS, options, pbx_builtin_setvar_helper(), R_OK, RAII_VAR, report_send_fax_status(), result, sendfax_t38_init(), set_channel_variables(), set_fax_t38_caps(), strsep(), T38_STATE_NEGOTIATED, T38_STATE_REJECTED, and T38_STATE_UNAVAILABLE.

Referenced by load_module().

◆ sendfax_t38_init()

static int sendfax_t38_init	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Definition at line 2384 of file res_fax.c.

{
    int timeout_ms;
    struct ast_frame *frame = NULL;
    struct ast_control_t38_parameters t38_parameters;
    struct timeval start;
    int ms;
 
    /* send CNG tone while listening for the receiver to initiate a switch
     * to T.38 mode; if they do, stop sending the CNG tone and proceed with
     * the switch.
     *
     * 10500 is enough time for 3 CNG tones
     */
    timeout_ms = 10500;
 
    /* don't send any audio if we've already received a T.38 reinvite */
    if (ast_channel_get_t38_state(chan) != T38_STATE_NEGOTIATING) {
        if (ast_playtones_start(chan, 1024, "!1100/500,!0/3000,!1100/500,!0/3000,!1100/500,!0/3000", 1)) {
            ast_log(LOG_ERROR, "error generating CNG tone on %s\n", ast_channel_name(chan));
            return -1;
        }
    }
 
    start = ast_tvnow();
    while ((ms = ast_remaining_ms(start, timeout_ms))) {
        int break_loop = 0;
        ms = ast_waitfor(chan, ms);
 
        if (ms < 0) {
            ast_log(LOG_ERROR, "error while generating CNG tone on %s\n", ast_channel_name(chan));
            ast_playtones_stop(chan);
            return -1;
        }
 
        if (ms == 0) { /* all done, nothing happened */
            break;
        }
 
        if (!(frame = ast_read(chan))) {
            ast_log(LOG_ERROR, "error reading frame while generating CNG tone on %s\n", ast_channel_name(chan));
            ast_playtones_stop(chan);
            return -1;
        }
 
        if ((frame->frametype == AST_FRAME_CONTROL) &&
                (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
                (frame->datalen == sizeof(t38_parameters))) {
            struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
            switch (parameters->request_response) {
            case AST_T38_REQUEST_NEGOTIATE:
                /* the other end has requested a switch to T.38, so reply that we are willing, if we can
                 * do T.38 as well
                 */
                t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
                t38_parameters.request_response = (details->caps & AST_FAX_TECH_T38) ? AST_T38_NEGOTIATED : AST_T38_REFUSED;
                ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters));
                ast_playtones_stop(chan);
                break;
            case AST_T38_NEGOTIATED:
                ast_debug(1, "Negotiated T.38 for send on %s\n", ast_channel_name(chan));
                t38_parameters_ast_to_fax(&details->their_t38_parameters, parameters);
                details->caps &= ~AST_FAX_TECH_AUDIO;
                report_fax_status(chan, details, "T.38 Negotiated");
                break_loop = 1;
                break;
            default:
                break;
            }
        }
        ast_frfree(frame);
        if (break_loop) {
            break;
        }
    }
 
    ast_playtones_stop(chan);
 
    if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
        return 0;
    }
 
    /* T.38 negotiation did not happen, initiate a switch if requested */
    if (details->option.request_t38 == AST_FAX_OPTFLAG_TRUE) {
        ast_debug(1, "Negotiating T.38 for send on %s\n", ast_channel_name(chan));
 
        /* wait up to five seconds for negotiation to complete */
        timeout_ms = 5000;
 
        /* set parameters based on the session's parameters */
        t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
        t38_parameters.request_response = AST_T38_REQUEST_NEGOTIATE;
        if ((ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters)) != 0)) {
            return -1;
        }
 
        start = ast_tvnow();
        while ((ms = ast_remaining_ms(start, timeout_ms))) {
            int break_loop = 0;
 
            ms = ast_waitfor(chan, ms);
            if (ms < 0) {
                ast_log(LOG_WARNING, "error on '%s' while waiting for T.38 negotiation.\n", ast_channel_name(chan));
                return -1;
            }
            if (ms == 0) { /* all done, nothing happened */
                ast_log(LOG_WARNING, "channel '%s' timed-out during the T.38 negotiation.\n", ast_channel_name(chan));
                details->caps &= ~AST_FAX_TECH_T38;
                break;
            }
 
            if (!(frame = ast_read(chan))) {
                ast_log(LOG_WARNING, "error on '%s' while waiting for T.38 negotiation.\n", ast_channel_name(chan));
                return -1;
            }
 
            if ((frame->frametype == AST_FRAME_CONTROL) &&
                    (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
                    (frame->datalen == sizeof(t38_parameters))) {
                struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
                switch (parameters->request_response) {
                case AST_T38_REQUEST_NEGOTIATE:
                    t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
                    t38_parameters.request_response = AST_T38_NEGOTIATED;
                    ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters));
                    break;
                case AST_T38_NEGOTIATED:
                    ast_debug(1, "Negotiated T.38 for receive on %s\n", ast_channel_name(chan));
                    t38_parameters_ast_to_fax(&details->their_t38_parameters, parameters);
                    details->caps &= ~AST_FAX_TECH_AUDIO;
                    report_fax_status(chan, details, "T.38 Negotiated");
                    break_loop = 1;
                    break;
                case AST_T38_REFUSED:
                    ast_log(LOG_WARNING, "channel '%s' refused to negotiate T.38\n", ast_channel_name(chan));
                    details->caps &= ~AST_FAX_TECH_T38;
                    break_loop = 1;
                    break;
                default:
                    ast_log(LOG_ERROR, "channel '%s' failed to negotiate T.38\n", ast_channel_name(chan));
                    details->caps &= ~AST_FAX_TECH_T38;
                    break_loop = 1;
                    break;
                }
            }
            ast_frfree(frame);
            if (break_loop) {
                break;
            }
        }
 
        /* if T.38 was negotiated, we are done initializing */
        if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
            return 0;
        }
 
        /* send one more CNG tone to get audio going again for some
         * carriers if we are going to fall back to audio mode */
        if (details->option.allow_audio == AST_FAX_OPTFLAG_TRUE) {
            if (ast_playtones_start(chan, 1024, "!1100/500,!0/3000", 1)) {
                ast_log(LOG_ERROR, "error generating second CNG tone on %s\n", ast_channel_name(chan));
                return -1;
            }
 
            timeout_ms = 3500;
            start = ast_tvnow();
            while ((ms = ast_remaining_ms(start, timeout_ms))) {
                int break_loop = 0;
 
                ms = ast_waitfor(chan, ms);
                if (ms < 0) {
                    ast_log(LOG_ERROR, "error while generating second CNG tone on %s\n", ast_channel_name(chan));
                    ast_playtones_stop(chan);
                    return -1;
                }
                if (ms == 0) { /* all done, nothing happened */
                    break;
                }
 
                if (!(frame = ast_read(chan))) {
                    ast_log(LOG_ERROR, "error reading frame while generating second CNG tone on %s\n", ast_channel_name(chan));
                    ast_playtones_stop(chan);
                    return -1;
                }
 
                if ((frame->frametype == AST_FRAME_CONTROL) &&
                        (frame->subclass.integer == AST_CONTROL_T38_PARAMETERS) &&
                        (frame->datalen == sizeof(t38_parameters))) {
                    struct ast_control_t38_parameters *parameters = frame->data.ptr;
 
                    switch (parameters->request_response) {
                    case AST_T38_REQUEST_NEGOTIATE:
                        /* the other end has requested a switch to T.38, so reply that we are willing, if we can
                         * do T.38 as well
                         */
                        t38_parameters_fax_to_ast(&t38_parameters, &details->our_t38_parameters);
                        t38_parameters.request_response = (details->caps & AST_FAX_TECH_T38) ? AST_T38_NEGOTIATED : AST_T38_REFUSED;
                        ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &t38_parameters, sizeof(t38_parameters));
                        ast_playtones_stop(chan);
                        break;
                    case AST_T38_NEGOTIATED:
                        ast_debug(1, "Negotiated T.38 for send on %s\n", ast_channel_name(chan));
                        t38_parameters_ast_to_fax(&details->their_t38_parameters, parameters);
                        details->caps &= ~AST_FAX_TECH_AUDIO;
                        report_fax_status(chan, details, "T.38 Negotiated");
                        break_loop = 1;
                        break;
                    default:
                        break;
                    }
                }
                ast_frfree(frame);
                if (break_loop) {
                    break;
                }
            }
 
            ast_playtones_stop(chan);
 
            /* if T.38 was negotiated, we are done initializing */
            if (ast_channel_get_t38_state(chan) == T38_STATE_NEGOTIATED) {
                return 0;
            }
        }
    }
 
    /* if we made it here, then T.38 failed, check the 'f' flag */
    if (details->option.allow_audio == AST_FAX_OPTFLAG_FALSE) {
        ast_log(LOG_WARNING, "Audio FAX not allowed on channel '%s' and T.38 negotiation failed; aborting.\n", ast_channel_name(chan));
        return -1;
    }
 
    /* ok, audio fallback is allowed */
    details->caps |= AST_FAX_TECH_AUDIO;
 
    return 0;
}

References ast_fax_session_details::allow_audio, ast_channel_get_t38_state(), ast_channel_name(), AST_CONTROL_T38_PARAMETERS, ast_debug, AST_FAX_OPTFLAG_FALSE, AST_FAX_OPTFLAG_TRUE, AST_FAX_TECH_AUDIO, AST_FAX_TECH_T38, AST_FRAME_CONTROL, ast_frfree, ast_indicate_data(), ast_log, ast_playtones_start(), ast_playtones_stop(), ast_read(), ast_remaining_ms(), AST_T38_NEGOTIATED, AST_T38_REFUSED, AST_T38_REQUEST_NEGOTIATE, ast_tvnow(), ast_waitfor(), ast_fax_session_details::caps, ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame_subclass::integer, LOG_ERROR, LOG_WARNING, NULL, ast_fax_session_details::option, ast_fax_session_details::our_t38_parameters, ast_frame::ptr, report_fax_status(), ast_control_t38_parameters::request_response, ast_fax_session_details::request_t38, ast_frame::subclass, t38_parameters_ast_to_fax(), t38_parameters_fax_to_ast(), T38_STATE_NEGOTIATED, T38_STATE_NEGOTIATING, and ast_fax_session_details::their_t38_parameters.

Referenced by sendfax_exec().

◆ session_cmp_cb()

static int session_cmp_cb	(	void *	obj,
		void *	arg,
		int	flags
	)

static

compare callback for ao2

Definition at line 4036 of file res_fax.c.

{
    struct ast_fax_session *lhs = obj, *rhs = arg;
 
    return (lhs->id == rhs->id) ? CMP_MATCH | CMP_STOP : 0;
}

References CMP_MATCH, CMP_STOP, and ast_fax_session::id.

Referenced by load_module().

◆ session_details_new()

static struct ast_fax_session_details * session_details_new ( void )

static

create a FAX session details structure

Definition at line 797 of file res_fax.c.

{
    struct ast_fax_session_details *d;
    struct fax_options options;
 
    if (!(d = ao2_alloc(sizeof(*d), destroy_session_details))) {
        return NULL;
    }
 
    if (ast_string_field_init(d, 512)) {
        ao2_ref(d, -1);
        return NULL;
    }
 
    get_general_options(&options);
 
    AST_LIST_HEAD_INIT_NOLOCK(&d->documents);
 
    /* These options need to be set to the configured default and may be overridden by
     * SendFAX, ReceiveFAX, or FAXOPT */
    d->option.request_t38 = AST_FAX_OPTFLAG_FALSE;
    d->option.send_cng = AST_FAX_OPTFLAG_FALSE;
    d->option.send_ced = AST_FAX_OPTFLAG_FALSE;
    d->option.ecm = options.ecm;
    d->option.statusevents = options.statusevents;
    d->modems = options.modems;
    d->minrate = options.minrate;
    d->maxrate = options.maxrate;
    d->t38timeout = options.t38timeout;
    d->gateway_id = -1;
    d->faxdetect_id = -1;
    d->gateway_timeout = 0;
    d->negotiate_both = 0;
 
    return d;
}

References ao2_alloc, ao2_ref, AST_FAX_OPTFLAG_FALSE, AST_LIST_HEAD_INIT_NOLOCK, ast_string_field_init, d, destroy_session_details(), get_general_options(), NULL, and options.

Referenced by fax_v21_session_new(), and find_or_create_details().

◆ session_hash_cb()

static int session_hash_cb	(	const void *	obj,
		const int	flags
	)

static

hash callback for ao2

Definition at line 4028 of file res_fax.c.

{
    const struct ast_fax_session *s = obj;
 
    return s->id;
}

References ast_fax_session::id.

Referenced by load_module().

◆ set_channel_variables()

static void set_channel_variables	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Set fax related channel variables.

Definition at line 1548 of file res_fax.c.

{
    char buf[10];
 
    pbx_builtin_setvar_helper(chan, "FAXSTATUS", S_OR(details->result, NULL));
    pbx_builtin_setvar_helper(chan, "FAXERROR", S_OR(details->error, NULL));
    pbx_builtin_setvar_helper(chan, "FAXSTATUSSTRING", S_OR(details->resultstr, NULL));
    pbx_builtin_setvar_helper(chan, "REMOTESTATIONID", AST_JSON_UTF8_VALIDATE(details->remotestationid));
    pbx_builtin_setvar_helper(chan, "LOCALSTATIONID", AST_JSON_UTF8_VALIDATE(details->localstationid));
    pbx_builtin_setvar_helper(chan, "FAXBITRATE", S_OR(details->transfer_rate, NULL));
    pbx_builtin_setvar_helper(chan, "FAXRESOLUTION", S_OR(details->resolution, NULL));
 
    if (details->is_t38_negotiated) {
        pbx_builtin_setvar_helper(chan, "FAXMODE", "T38");
    } else {
        pbx_builtin_setvar_helper(chan, "FAXMODE", "audio");
    }
 
    snprintf(buf, sizeof(buf), "%u", details->pages_transferred);
    pbx_builtin_setvar_helper(chan, "FAXPAGES", buf);
}

References AST_JSON_UTF8_VALIDATE, buf, ast_fax_session_details::error, ast_fax_session_details::is_t38_negotiated, ast_fax_session_details::localstationid, NULL, ast_fax_session_details::pages_transferred, pbx_builtin_setvar_helper(), ast_fax_session_details::remotestationid, ast_fax_session_details::resolution, ast_fax_session_details::result, ast_fax_session_details::resultstr, S_OR, and ast_fax_session_details::transfer_rate.

Referenced by fax_gateway_attach(), fax_gateway_detect_t38(), fax_gateway_framehook(), fax_gateway_start(), generic_fax_exec(), receivefax_exec(), and sendfax_exec().

◆ set_config()

static int set_config ( int reload )

static

configure res_fax

Definition at line 4523 of file res_fax.c.

{
    struct ast_config *cfg;
    struct ast_variable *v;
    struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
    char modems[128] = "";
    struct fax_options options;
    int res = 0;
 
    options = default_options;
 
    /* When we're not reloading, we have to be certain to set the general options
     * to the defaults in case config loading goes wrong at some point. On a reload,
     * the general options need to stay the same as what they were prior to the
     * reload rather than being reset to the defaults.
     */
    if (!reload) {
        set_general_options(&options);
    }
 
    /* read configuration */
    if (!(cfg = ast_config_load2(config, "res_fax", config_flags))) {
        ast_log(LOG_NOTICE, "Configuration file '%s' not found, %s options.\n",
                config, reload ? "not changing" : "using default");
        return 0;
    }
 
    if (cfg == CONFIG_STATUS_FILEINVALID) {
        ast_log(LOG_NOTICE, "Configuration file '%s' is invalid, %s options.\n",
                config, reload ? "not changing" : "using default");
        return 0;
    }
 
    if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
        return 0;
    }
 
    if (reload) {
        options = default_options;
    }
 
    /* create configuration */
    for (v = ast_variable_browse(cfg, "general"); v; v = v->next) {
        int rate;
 
        if (!strcasecmp(v->name, "minrate")) {
            ast_debug(3, "reading minrate '%s' from configuration file\n", v->value);
            if ((rate = fax_rate_str_to_int(v->value)) == 0) {
                res = -1;
                goto end;
            }
            options.minrate = rate;
        } else if (!strcasecmp(v->name, "maxrate")) {
            ast_debug(3, "reading maxrate '%s' from configuration file\n", v->value);
            if ((rate = fax_rate_str_to_int(v->value)) == 0) {
                res = -1;
                goto end;
            }
            options.maxrate = rate;
        } else if (!strcasecmp(v->name, "statusevents")) {
            ast_debug(3, "reading statusevents '%s' from configuration file\n", v->value);
            options.statusevents = ast_true(v->value);
        } else if (!strcasecmp(v->name, "ecm")) {
            ast_debug(3, "reading ecm '%s' from configuration file\n", v->value);
            options.ecm = ast_true(v->value);
        } else if ((!strcasecmp(v->name, "modem")) || (!strcasecmp(v->name, "modems"))) {
            options.modems = 0;
            update_modem_bits(&options.modems, v->value);
        } else if (!strcasecmp(v->name, "t38timeout")) {
            if (set_t38timeout(v->value, &options.t38timeout)) {
                res = -1;
                goto end;
            }
        }
    }
 
    if (options.maxrate < options.minrate) {
        ast_log(LOG_ERROR, "maxrate %u is less than minrate %u\n", options.maxrate, options.minrate);
        res = -1;
        goto end;
    }
 
    if (check_modem_rate(options.modems, options.minrate)) {
        ast_fax_modem_to_str(options.modems, modems, sizeof(modems));
        ast_log(LOG_ERROR, "'modems' setting '%s' is incompatible with 'minrate' setting %u\n", modems, options.minrate);
        res = -1;
        goto end;
    }
 
    if (check_modem_rate(options.modems, options.maxrate)) {
        ast_fax_modem_to_str(options.modems, modems, sizeof(modems));
        ast_log(LOG_ERROR, "'modems' setting '%s' is incompatible with 'maxrate' setting %u\n", modems, options.maxrate);
        res = -1;
        goto end;
    }
 
    set_general_options(&options);
 
end:
    ast_config_destroy(cfg);
    return res;
}

References ast_config_destroy(), ast_config_load2(), ast_debug, ast_fax_modem_to_str(), ast_log, ast_true(), ast_variable_browse(), check_modem_rate(), config, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, default_options, end, fax_rate_str_to_int(), LOG_ERROR, LOG_NOTICE, fax_options::modems, ast_variable::name, ast_variable::next, options, reload(), set_general_options(), set_t38timeout(), update_modem_bits(), and ast_variable::value.

Referenced by load_module(), and reload_module().

◆ set_fax_t38_caps()

static int set_fax_t38_caps	(	struct ast_channel *	chan,
		struct ast_fax_session_details *	details
	)

static

Definition at line 1592 of file res_fax.c.

{
    switch (ast_channel_get_t38_state(chan)) {
    case T38_STATE_UNKNOWN:
        details->caps |= AST_FAX_TECH_T38;
        break;
    case T38_STATE_REJECTED:
    case T38_STATE_UNAVAILABLE:
        details->caps |= AST_FAX_TECH_AUDIO;
        break;
    case T38_STATE_NEGOTIATED:
        /* already in T.38 mode? This should not happen. */
    case T38_STATE_NEGOTIATING: {
        /* the other end already sent us a T.38 reinvite, so we need to prod the channel
         * driver into resending their parameters to us if it supports doing so... if
         * not, we can't proceed, because we can't create a proper reply without them.
         * if it does work, the channel driver will send an AST_CONTROL_T38_PARAMETERS
         * with a request of AST_T38_REQUEST_NEGOTIATE, which will be read by the function
         * that gets called after this one completes
         */
        struct ast_control_t38_parameters parameters = { .request_response = AST_T38_REQUEST_PARMS, };
        if (ast_indicate_data(chan, AST_CONTROL_T38_PARAMETERS, &parameters, sizeof(parameters)) != AST_T38_REQUEST_PARMS) {
            ast_log(LOG_ERROR, "channel '%s' is in an unsupported T.38 negotiation state, cannot continue.\n", ast_channel_name(chan));
            return -1;
        }
        details->caps |= AST_FAX_TECH_T38;
        break;
    }
    default:
        ast_log(LOG_ERROR, "channel '%s' is in an unsupported T.38 negotiation state, cannot continue.\n", ast_channel_name(chan));
        return -1;
    }
 
    return 0;
}

References ast_channel_get_t38_state(), ast_channel_name(), AST_CONTROL_T38_PARAMETERS, AST_FAX_TECH_AUDIO, AST_FAX_TECH_T38, ast_indicate_data(), ast_log, AST_T38_REQUEST_PARMS, ast_fax_session_details::caps, LOG_ERROR, ast_control_t38_parameters::request_response, T38_STATE_NEGOTIATED, T38_STATE_NEGOTIATING, T38_STATE_REJECTED, T38_STATE_UNAVAILABLE, and T38_STATE_UNKNOWN.

Referenced by receivefax_exec(), and sendfax_exec().

◆ set_general_options()

static void set_general_options ( const struct fax_options * options )

static

Definition at line 4491 of file res_fax.c.

{
    ast_rwlock_wrlock(&options_lock);
    general_options = *options;
    ast_rwlock_unlock(&options_lock);
}

References ast_rwlock_unlock, ast_rwlock_wrlock, general_options, options, and options_lock.

Referenced by set_config().

◆ set_t38timeout()

static int set_t38timeout	(	const char *	value,
		unsigned int *	t38timeout
	)

static

Definition at line 4505 of file res_fax.c.

{
    unsigned int timeout;
 
    if (sscanf(value, "%u", &timeout) != 1) {
        ast_log(LOG_ERROR, "Unable to get timeout from '%s'\n", value);
        return -1;
    } else if (timeout) {
        *t38timeout = timeout;
    } else {
        ast_log(LOG_ERROR, "T.38 negotiation timeout must be non-zero\n");
        return -1;
    }
 
    return 0;
}

References ast_log, LOG_ERROR, and value.

Referenced by acf_faxopt_write(), and set_config().

◆ t38_parameters_ast_to_fax()

static void t38_parameters_ast_to_fax	(	struct ast_fax_t38_parameters *	dst,
		const struct ast_control_t38_parameters *	src
	)

static

Definition at line 841 of file res_fax.c.

{
    dst->version = src->version;
    dst->max_ifp = src->max_ifp;
    dst->rate = src->rate;
    dst->rate_management = src->rate_management;
    dst->fill_bit_removal = src->fill_bit_removal;
    dst->transcoding_mmr = src->transcoding_mmr;
    dst->transcoding_jbig = src->transcoding_jbig;
}

References ast_control_t38_parameters::fill_bit_removal, ast_fax_t38_parameters::fill_bit_removal, ast_control_t38_parameters::max_ifp, ast_fax_t38_parameters::max_ifp, ast_control_t38_parameters::rate, ast_fax_t38_parameters::rate, ast_control_t38_parameters::rate_management, ast_fax_t38_parameters::rate_management, ast_control_t38_parameters::transcoding_jbig, ast_fax_t38_parameters::transcoding_jbig, ast_control_t38_parameters::transcoding_mmr, ast_fax_t38_parameters::transcoding_mmr, ast_control_t38_parameters::version, and ast_fax_t38_parameters::version.

Referenced by fax_gateway_detect_t38(), find_or_create_details(), generic_fax_exec(), receivefax_t38_init(), and sendfax_t38_init().

◆ t38_parameters_fax_to_ast()

static void t38_parameters_fax_to_ast	(	struct ast_control_t38_parameters *	dst,
		const struct ast_fax_t38_parameters *	src
	)

static

Definition at line 852 of file res_fax.c.

{
    dst->version = src->version;
    dst->max_ifp = src->max_ifp;
    dst->rate = src->rate;
    dst->rate_management = src->rate_management;
    dst->fill_bit_removal = src->fill_bit_removal;
    dst->transcoding_mmr = src->transcoding_mmr;
    dst->transcoding_jbig = src->transcoding_jbig;
}

References ast_control_t38_parameters::fill_bit_removal, ast_fax_t38_parameters::fill_bit_removal, ast_control_t38_parameters::max_ifp, ast_fax_t38_parameters::max_ifp, ast_control_t38_parameters::rate, ast_fax_t38_parameters::rate, ast_control_t38_parameters::rate_management, ast_fax_t38_parameters::rate_management, ast_control_t38_parameters::transcoding_jbig, ast_fax_t38_parameters::transcoding_jbig, ast_control_t38_parameters::transcoding_mmr, ast_fax_t38_parameters::transcoding_mmr, ast_control_t38_parameters::version, and ast_fax_t38_parameters::version.

Referenced by fax_gateway_detect_t38(), fax_gateway_request_t38(), generic_fax_exec(), receivefax_t38_init(), and sendfax_t38_init().

◆ unload_module()

static int unload_module ( void )

static

unload res_fax

Definition at line 4850 of file res_fax.c.

{
    ast_cli_unregister_multiple(fax_cli, ARRAY_LEN(fax_cli));
 
    if (ast_custom_function_unregister(&acf_faxopt) < 0) {
        ast_log(LOG_WARNING, "failed to unregister function '%s'\n", acf_faxopt.name);
    }
 
    if (ast_unregister_application(app_sendfax) < 0) {
        ast_log(LOG_WARNING, "failed to unregister '%s'\n", app_sendfax);
    }
 
    if (ast_unregister_application(app_receivefax) < 0) {
        ast_log(LOG_WARNING, "failed to unregister '%s'\n", app_receivefax);
    }
 
    ast_manager_unregister("FAXSessions");
    ast_manager_unregister("FAXSession");
    ast_manager_unregister("FAXStats");
 
    if (fax_logger_level != -1) {
        ast_logger_unregister_level("FAX");
    }
 
    ao2_ref(faxregistry.container, -1);
 
    return 0;
}

References acf_faxopt, ao2_ref, app_receivefax, app_sendfax, ARRAY_LEN, ast_cli_unregister_multiple(), ast_custom_function_unregister(), ast_log, ast_logger_unregister_level(), ast_manager_unregister(), ast_unregister_application(), fax_cli, fax_logger_level, faxregistry, LOG_WARNING, and ast_custom_function::name.

◆ update_modem_bits()

static int update_modem_bits	(	enum ast_fax_modems *	bits,
		const char *	value
	)

static

Definition at line 913 of file res_fax.c.

{
    char *m[5], *tok, *v = (char *) value, *rest;
    int i = 0, j;
 
    if (!strchr(v, ',')) {
        m[i++] = v;
        m[i] = NULL;
    } else {
        tok = strtok_r(v, ", ", &rest);
        while (tok && i < ARRAY_LEN(m) - 1) {
            m[i++] = tok;
            tok = strtok_r(NULL, ", ", &rest);
        }
        m[i] = NULL;
    }
 
    *bits = 0;
    for (j = 0; j < i; j++) {
        if (!strcasecmp(m[j], "v17")) {
            *bits |= AST_FAX_MODEM_V17;
        } else if (!strcasecmp(m[j], "v27")) {
            *bits |= AST_FAX_MODEM_V27TER;
        } else if (!strcasecmp(m[j], "v29")) {
            *bits |= AST_FAX_MODEM_V29;
        } else if (!strcasecmp(m[j], "v34")) {
            *bits |= AST_FAX_MODEM_V34;
        } else {
            ast_log(LOG_WARNING, "ignoring invalid modem setting: '%s', valid options {v17 | v27 | v29 | v34}\n", m[j]);
        }
    }
    return 0;
}

References ARRAY_LEN, AST_FAX_MODEM_V17, AST_FAX_MODEM_V27TER, AST_FAX_MODEM_V29, AST_FAX_MODEM_V34, ast_log, LOG_WARNING, NULL, and value.

Referenced by acf_faxopt_write(), and set_config().

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Generic FAX Applications" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_APP_DEPEND, }

static

Definition at line 4968 of file res_fax.c.

◆ acf_faxopt

struct ast_custom_function acf_faxopt

static

Initial value:

= {
    .name = "FAXOPT",
    .read = acf_faxopt_read,
    .write = acf_faxopt_write,
}

FAXOPT dialplan function.

Definition at line 4843 of file res_fax.c.

                                               {
    .name = "FAXOPT",
    .read = acf_faxopt_read,
    .write = acf_faxopt_write,
};

Referenced by load_module(), and unload_module().

◆ active_sessions

int active_sessions

The number of active FAX sessions

Definition at line 599 of file res_fax.c.

◆ app_receivefax

const char app_receivefax[] = "ReceiveFAX"

static

Definition at line 529 of file res_fax.c.

Referenced by load_module(), receivefax_exec(), and unload_module().

◆ app_sendfax

const char app_sendfax[] = "SendFAX"

static

Definition at line 530 of file res_fax.c.

Referenced by load_module(), sendfax_exec(), and unload_module().

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 4968 of file res_fax.c.

◆ config

const char* config = "res_fax.conf"

static

Definition at line 654 of file res_fax.c.

Referenced by load_module(), and set_config().

◆ container

struct ao2_container* container

active sessions are astobj2 objects

Definition at line 603 of file res_fax.c.

Referenced by __container_unlink_node_debug(), aeap_tab_complete_name(), ast_aeap_client_configs_get(), ast_extension_state_extended(), ast_sip_cli_traverse_objects(), AST_TEST_DEFINE(), bridge_profile_find(), cli_aor_get_container(), cli_aor_iterate(), cli_contact_iterate(), cli_contact_retrieve_by_id(), cli_endpoint_get_container(), cli_eprofile_show_all(), cli_get_container(), cli_get_container(), cli_get_container(), cli_get_container(), cli_iterate(), cli_iterator(), cli_iterator(), cli_iterator(), cli_profile_show_all(), cli_tn_show_all(), cli_unid_iterate(), client_config_show_all(), complete_app(), complete_session(), complete_show_sorcery_object(), complete_sorcery_object(), config_object_tab_complete_name(), gather_contacts_for_aor(), get_publishes_and_update_state(), handle_export_primitives(), has_mwi_subscription(), insert_test_duplicates(), insert_test_vector(), load_module(), load_module(), menu_find(), named_acl_find(), named_item_find(), notify_option_find(), populate_transport_states(), proxy_dtor(), registrar_add_non_permanent(), registrar_add_unreachable(), speech_observer_loaded(), test_ao2_callback_traversal(), test_ao2_iteration(), test_expected_duplicates(), test_item_find(), test_make_nonsorted(), test_make_sorted(), unload_module(), user_profile_find(), var_list_from_loc_info(), var_list_from_node(), and xmpp_client_create_buddy().

◆ default_options

const struct fax_options default_options

static

Definition at line 640 of file res_fax.c.

                                                  {
    .minrate = RES_FAX_MINRATE,
    .maxrate = RES_FAX_MAXRATE,
    .statusevents = RES_FAX_STATUSEVENTS,
    .modems = RES_FAX_MODEM,
    .ecm = AST_FAX_OPTFLAG_TRUE,
    .t38timeout = RES_FAX_T38TIMEOUT,
};

Referenced by set_config().

◆ fax_cli

struct ast_cli_entry fax_cli[]

static

Definition at line 4481 of file res_fax.c.

                                        {
    AST_CLI_DEFINE(cli_fax_show_version, "Show versions of FAX For Asterisk components"),
    AST_CLI_DEFINE(cli_fax_set_debug, "Enable/Disable FAX debugging on new FAX sessions"),
    AST_CLI_DEFINE(cli_fax_show_capabilities, "Show the capabilities of the registered FAX technology modules"),
    AST_CLI_DEFINE(cli_fax_show_settings, "Show the global settings and defaults of both the FAX core and technology modules"),
    AST_CLI_DEFINE(cli_fax_show_session, "Show the status of the named FAX sessions"),
    AST_CLI_DEFINE(cli_fax_show_sessions, "Show the current FAX sessions"),
    AST_CLI_DEFINE(cli_fax_show_stats, "Summarize FAX session history"),
};

Referenced by load_module(), and unload_module().

◆ fax_complete

int fax_complete

Number of successful FAX transmissions

Definition at line 609 of file res_fax.c.

◆ fax_datastore

const struct ast_datastore_info fax_datastore

static

Initial value:

= {
    .type = "res_fax",
    .destroy = destroy_callback,
    .chan_fixup = fixup_callback,
}

Definition at line 720 of file res_fax.c.

                                                       {
    .type = "res_fax",
    .destroy = destroy_callback,
    .chan_fixup = fixup_callback,
};

Referenced by find_details(), find_or_create_details(), and fixup_callback().

◆ fax_exec_options

const struct ast_app_option fax_exec_options[128] = { [ 'a' ] = { .flag = OPT_CALLEDMODE }, [ 'c' ] = { .flag = OPT_CALLERMODE }, [ 'd' ] = { .flag = OPT_DEBUG }, [ 'f' ] = { .flag = OPT_ALLOWAUDIO }, [ 'F' ] = { .flag = OPT_FORCE_AUDIO }, [ 's' ] = { .flag = OPT_STATUS }, [ 'z' ] = { .flag = OPT_REQUEST_T38 }, }

static

Definition at line 676 of file res_fax.c.

Referenced by receivefax_exec(), and sendfax_exec().

◆ fax_failures

int fax_failures

Number of failed FAX transmissions

Definition at line 611 of file res_fax.c.

◆ fax_logger_level

int fax_logger_level = -1

static

Definition at line 588 of file res_fax.c.

Referenced by ast_fax_log(), load_module(), and unload_module().

◆ fax_rx_attempts

int fax_rx_attempts

Total number of Rx FAX attempts

Definition at line 607 of file res_fax.c.

◆ fax_tx_attempts

int fax_tx_attempts

Total number of Tx FAX attempts

Definition at line 605 of file res_fax.c.

◆ faxmodules

struct faxmodules faxmodules = AST_RWLIST_HEAD_INIT_VALUE

static

◆ [struct]

struct { ... } faxregistry

The faxregistry is used to manage information and statistics for all FAX sessions.

Referenced by cli_fax_show_session(), cli_fax_show_sessions(), cli_fax_show_stats(), destroy_gateway(), destroy_session(), destroy_v21_sessions(), fax_session_new(), fax_session_release(), fax_session_reserve(), fax_session_tab_complete(), generic_fax_exec(), load_module(), manager_fax_session(), manager_fax_sessions(), manager_fax_stats(), receivefax_exec(), sendfax_exec(), and unload_module().

◆ general_options

struct fax_options general_options

static

Definition at line 638 of file res_fax.c.

Referenced by get_general_options(), and set_general_options().

◆ global_fax_debug

int global_fax_debug = 0

static

Definition at line 656 of file res_fax.c.

Referenced by cli_fax_set_debug(), fax_gateway_attach(), receivefax_exec(), and sendfax_exec().

◆ nextsessionname

int nextsessionname

the next unique session name

Definition at line 613 of file res_fax.c.

◆ options_lock

ast_rwlock_t options_lock = AST_RWLOCK_INIT_VALUE

static

Definition at line 649 of file res_fax.c.

Referenced by get_general_options(), and set_general_options().

◆ our_t38_parameters

struct ast_control_t38_parameters our_t38_parameters

static

Definition at line 834 of file res_fax.c.

                                                              {
    .version = 0,
    .max_ifp = 400,
    .rate = AST_T38_RATE_14400,
    .rate_management = AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF,
};

Referenced by find_or_create_details().

◆ reserved_sessions

int reserved_sessions

The number of reserved FAX sessions

Definition at line 601 of file res_fax.c.

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FAX_DETECT_MODE_BOTH

◆ FAX_DETECT_MODE_CNG

◆ FAX_DETECT_MODE_T38

◆ FAX_GATEWAY_TIMEOUT

◆ FAX_MAXBUCKETS

◆ GENERIC_FAX_EXEC_ERROR

◆ GENERIC_FAX_EXEC_ERROR_QUIET

◆ GENERIC_FAX_EXEC_SET_VARS

◆ RES_FAX_MAXRATE

◆ RES_FAX_MINRATE

◆ RES_FAX_MODEM

◆ RES_FAX_STATUSEVENTS

◆ RES_FAX_T38TIMEOUT

◆ RES_FAX_TIMEOUT

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ acf_faxopt_read()

◆ acf_faxopt_write()

◆ ast_fax_caps_to_str()

◆ ast_fax_log()

◆ ast_fax_maxrate()

◆ ast_fax_minrate()

◆ ast_fax_modem_to_str()

◆ ast_fax_session_operation_str()

◆ ast_fax_state_to_str()

◆ ast_fax_tech_register()

◆ ast_fax_tech_unregister()

◆ AST_MODULE_SELF_SYM()

◆ check_modem_rate()

◆ cli_fax_set_debug()

◆ cli_fax_show_capabilities()

◆ cli_fax_show_session()

◆ cli_fax_show_sessions()

◆ cli_fax_show_settings()

◆ cli_fax_show_stats()

◆ cli_fax_show_version()

◆ debug_check_frame_for_silence()

◆ destroy_callback()

◆ destroy_faxdetect()

◆ destroy_gateway()

◆ destroy_session()

◆ destroy_session_details()

◆ destroy_v21_sessions()

◆ disable_t38()

◆ fax_detect_attach()

◆ fax_detect_framehook()

◆ fax_detect_framehook_destroy()

◆ fax_detect_new()

◆ fax_gateway_attach()

◆ fax_gateway_detect_t38()

◆ fax_gateway_detect_v21()

◆ fax_gateway_framehook()

◆ fax_gateway_framehook_destroy()

◆ fax_gateway_indicate_t38()

◆ fax_gateway_new()

◆ fax_gateway_request_t38()

◆ fax_gateway_start()

◆ fax_rate_str_to_int()

◆ fax_session_new()

◆ fax_session_release()

◆ fax_session_reserve()

◆ fax_session_tab_complete()

◆ fax_session_type()

◆ fax_v21_session_new()

◆ find_details()

◆ find_or_create_details()

◆ fixup_callback()

◆ generate_filenames_json()

◆ generate_filenames_string()

◆ generic_fax_exec()