modem_connect_tones.c File Reference

#include <inttypes.h>
#include <stdlib.h>
#include <memory.h>
#include <tgmath.h>
#include <math.h>
#include "floating_fudge.h"
#include <stdio.h>
#include "spandsp/telephony.h"
#include "spandsp/fast_convert.h"
#include "spandsp/logging.h"
#include "spandsp/complex.h"
#include "spandsp/dds.h"
#include "spandsp/tone_detect.h"
#include "spandsp/tone_generate.h"
#include "spandsp/super_tone_rx.h"
#include "spandsp/power_meter.h"
#include "spandsp/async.h"
#include "spandsp/fsk.h"
#include "spandsp/modem_connect_tones.h"
#include "spandsp/private/fsk.h"
#include "spandsp/private/modem_connect_tones.h"

Defines
#define	HDLC_FRAMING_OK_THRESHOLD   5
Functions
const char *	modem_connect_tone_to_str (int tone)
	SPAN_DECLARE_NONSTD (int)
	Get the next bit of a transmitted serial bit stream.
modem_connect_tones_tx_state_t *	modem_connect_tones_tx_init (modem_connect_tones_tx_state_t *s, int tone_type)
	Initialise an instance of the modem connect tones generator.
int	modem_connect_tones_tx_release (modem_connect_tones_tx_state_t *s)
	Release an instance of the modem connect tones generator.
int	modem_connect_tones_tx_free (modem_connect_tones_tx_state_t *s)
	Free an instance of the modem connect tones generator.
int	modem_connect_tones_rx_get (modem_connect_tones_rx_state_t *s)
	Test if a modem_connect tone has been detected.
modem_connect_tones_rx_state_t *	modem_connect_tones_rx_init (modem_connect_tones_rx_state_t *s, int tone_type, tone_report_func_t tone_callback, void *user_data)
	Initialise an instance of the modem connect tones detector.
int	modem_connect_tones_rx_release (modem_connect_tones_rx_state_t *s)
	Release an instance of the modem connect tones detector.
int	modem_connect_tones_rx_free (modem_connect_tones_rx_state_t *s)
	Free an instance of the modem connect tones detector.

---

Detailed Description

---

Function Documentation

int modem_connect_tones_rx_free

(

modem_connect_tones_rx_state_t *

s

)

Free an instance of the modem connect tones detector.

Parameters:

s

The context.

Returns:

0 for OK, else -1.

int modem_connect_tones_rx_get

(

modem_connect_tones_rx_state_t *

s

)

Test if a modem_connect tone has been detected.

Parameters:

s

The context.

Returns:

TRUE if tone is detected, else FALSE.

References MODEM_CONNECT_TONES_NONE.

Referenced by SPAN_DECLARE_NONSTD().

modem_connect_tones_rx_state_t* modem_connect_tones_rx_init	(	modem_connect_tones_rx_state_t *	s,
		int	tone_type,
		tone_report_func_t	tone_callback,
		void *	user_data
	)

Initialise an instance of the modem connect tones detector.

Parameters:

	s	The context.
	tone_type	The type of connect tone being tested for.
	tone_callback	An optional callback routine, used to report tones
	user_data	An opaque pointer passed to the callback routine,

Returns:

A pointer to the context.

References fsk_rx_init(), fsk_rx_signal_cutoff(), MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM, MODEM_CONNECT_TONES_ANSAM_PR, MODEM_CONNECT_TONES_FAX_CED_OR_PREAMBLE, MODEM_CONNECT_TONES_FAX_PREAMBLE, and MODEM_CONNECT_TONES_NONE.

int modem_connect_tones_rx_release

(

modem_connect_tones_rx_state_t *

s

)

Release an instance of the modem connect tones detector.

Parameters:

s

The context.

Returns:

0 for OK, else -1.

int modem_connect_tones_tx_free

(

modem_connect_tones_tx_state_t *

s

)

Free an instance of the modem connect tones generator.

Parameters:

s

The context.

Returns:

0 for OK, else -1.

modem_connect_tones_tx_state_t* modem_connect_tones_tx_init	(	modem_connect_tones_tx_state_t *	s,
		int	tone_type
	)

Initialise an instance of the modem connect tones generator.

Parameters:

s

The context.

References dds_phase_rate(), dds_scaling_dbm0(), MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM, MODEM_CONNECT_TONES_ANSAM_PR, and MODEM_CONNECT_TONES_FAX_CNG.

int modem_connect_tones_tx_release

(

modem_connect_tones_tx_state_t *

s

)

Release an instance of the modem connect tones generator.

Parameters:

s

The context.

Returns:

0 for OK, else -1.

SPAN_DECLARE_NONSTD

(

int

)

Get the next bit of a transmitted serial bit stream.

Get the next bit of data from a T.38 rate adapting non-ECM buffer context.

Get a bit of received non-ECM image data.

Get the next bit of a transmitted serial bit stream.

Parameters:

user_data

An opaque point which must point to a transmitter context.

Returns:

the next bit, or PUTBIT_END_OF_DATA to indicate the data stream has ended.

Get the next bit of a transmitted serial bit stream.

Process a block of received V.8 audio samples.

Fake processing of a missing block of received V.29 modem audio samples.

Fake processing of a missing block of received V.27ter modem audio samples.

Generate a block of V.22bis modem audio samples.

Fake processing of a missing block of received V.22bis modem audio samples.

Process a block of received V.18 audio samples.

Fake processing of a missing block of received V.17 modem audio samples.

Generate a block of FAX audio samples.

Apply fake received audio processing.

Generate a block of T.31 modem audio samples.

Fake processing of a missing block of received T.31 modem audio samples.

Dummy receive fillin callback.

Dummy receive callback.

Process a block of samples through an instance of the modem connect tones detector.

Get the next sequence of bytes for transmission.

Get the next byte for transmission.

Fake processing of a missing block of received FSK modem audio samples.

Process a block of received FSK modem audio samples.

Apply T.30 transmit processing to generate a block of audio samples.

Apply fake T.30 receive processing when a block of audio samples is missing (e.g due to packet loss).

Parameters:

	s	The FAX context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed. This should only be non-zero if the software has reached the end of the FAX call.

Apply T.30 transmit processing to generate a block of audio samples.

Parameters:

	s	The FAX context.
	amp	The audio sample buffer.
	max_len	The number of samples to be generated.

Returns:

The number of samples actually generated. This will be zero when there is nothing to send.

Process a block of received FSK modem audio samples.

Parameters:

	s	The modem context.
	amp	The audio sample buffer.
	len	The number of samples in the buffer.

Returns:

The number of samples unprocessed.

Fake processing of a missing block of received FSK modem audio samples (e.g due to packet loss).

Parameters:

	s	The modem context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed.

Parameters:

s

A pointer to an HDLC transmitter context.

Returns:

The next byte for transmission.

Parameters:

	s	A pointer to an HDLC transmitter context.
	buf	The buffer for the data.
	max_len	The number of bytes to get.

Returns:

The number of bytes actually got.

Parameters:

	s	The context.
	amp	An array of signal samples.
	len	The number of samples in the array.

Returns:

The number of unprocessed samples.

A dummy routine to use as a receive callback, when we aren't really trying to process what is received. It just absorbs and ignores the data.

Parameters:

	user_data	The context.
	amp	The signal.buffer
	len	The length of the signal buffer

Returns:

0.

A dummy routine to use as a receive fillin callback, when we aren't really trying to process what is received. It just absorbs and ignores the request.

Parameters:

	user_data	The context.
	len	The length of the signal buffer

Returns:

0.

Fake processing of a missing block of received T.31 modem audio samples (e.g due to packet loss).

Parameters:

	s	The T.31 modem context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed.

Generate a block of T.31 modem audio samples.

Parameters:

	s	The T.31 modem context.
	amp	The audio sample buffer.
	max_len	The number of samples to be generated.

Returns:

The number of samples actually generated.

Apply fake processing when a block of audio samples is missing (e.g due to packet loss).

Parameters:

	s	The T.38 context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed. This should only be non-zero if the software has reached the end of the FAX call.

Generate a block of FAX audio samples.

Parameters:

	s	The T.38 context.
	amp	The audio sample buffer.
	max_len	The number of samples to be generated.

Returns:

The number of samples actually generated.

Fake processing of a missing block of received V.17 modem audio samples. (e.g due to packet loss).

Parameters:

	s	The modem context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed.

Process a block of received V.18 audio samples.

Parameters:

	s	The V.18 context.
	amp	The audio sample buffer.
	len	The number of samples in the buffer.

Fake processing of a missing block of received V.22bis modem audio samples. (e.g due to packet loss).

Parameters:

	s	The modem context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed.

Generate a block of V.22bis modem audio samples.

Parameters:

	s	The modem context.
	amp	The audio sample buffer.
	len	The number of samples to be generated.

Returns:

The number of samples actually generated.

Fake processing of a missing block of received V.27ter modem audio samples. (e.g due to packet loss).

Parameters:

	s	The modem context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed.

Fake processing of a missing block of received V.29 modem audio samples. (e.g due to packet loss).

Parameters:

	s	The modem context.
	len	The number of samples to fake.

Returns:

The number of samples unprocessed.

Process a block of received V.8 audio samples.

Parameters:

	s	The V.8 context.
	amp	The audio sample buffer.
	len	The number of samples in the buffer.

References MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM, MODEM_CONNECT_TONES_ANSAM_PR, MODEM_CONNECT_TONES_FAX_CED_OR_PREAMBLE, MODEM_CONNECT_TONES_FAX_CNG, MODEM_CONNECT_TONES_FAX_PREAMBLE, and MODEM_CONNECT_TONES_NONE.