v8.c File Reference

#include <inttypes.h>
#include <stdlib.h>
#include <stdio.h>
#include <memory.h>
#include <tgmath.h>
#include <math.h>
#include "floating_fudge.h"
#include "spandsp/telephony.h"
#include "spandsp/logging.h"
#include "spandsp/queue.h"
#include "spandsp/async.h"
#include "spandsp/vector_int.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/fsk.h"
#include "spandsp/modem_connect_tones.h"
#include "spandsp/v8.h"
#include "spandsp/private/logging.h"
#include "spandsp/private/fsk.h"
#include "spandsp/private/modem_connect_tones.h"
#include "spandsp/private/v8.h"

Enumerations
enum	{   V8_WAIT_1S, V8_CI_ON, V8_CI_OFF, V8_HEARD_ANSAM,   V8_CM_ON, V8_CJ_ON, V8_CM_WAIT, V8_SIGC,   V8_JM_ON, V8_SIGA, V8_PARKED }
enum	{ V8_SYNC_UNKNOWN = 0, V8_SYNC_CI, V8_SYNC_CM_JM, V8_SYNC_V92 }
enum	{   V8_CALL_FUNCTION_TAG = 0x01, V8_MODULATION_TAG = 0x05, V8_PROTOCOLS_TAG = 0x0A, V8_PSTN_ACCESS_TAG = 0x0D,   V8_NSF_TAG = 0x0F, V8_PCM_MODEM_AVAILABILITY_TAG = 0x07, V8_T66_TAG = 0x0E }
enum	{ V8_CI_SYNC_OCTET = 0x00, V8_CM_JM_SYNC_OCTET = 0xE0 }
Functions
const char *	v8_call_function_to_str (int call_function)
const char *	v8_modulation_to_str (int modulation_scheme)
const char *	v8_protocol_to_str (int protocol)
const char *	v8_pstn_access_to_str (int pstn_access)
const char *	v8_nsf_to_str (int nsf)
const char *	v8_pcm_modem_availability_to_str (int pcm_modem_availability)
const char *	v8_t66_to_str (int t66)
void	v8_log_supported_modulations (v8_state_t *s, int modulation_schemes)
	Log the list of supported modulations.
	SPAN_DECLARE_NONSTD (int)
	Get the next bit of a transmitted serial bit stream.
logging_state_t *	v8_get_logging_state (v8_state_t *s)
int	v8_restart (v8_state_t *s, int calling_party, v8_parms_t *parms)
v8_state_t *	v8_init (v8_state_t *s, int calling_party, v8_parms_t *parms, v8_result_handler_t *result_handler, void *user_data)
	Initialise a V.8 context.
int	v8_release (v8_state_t *s)
	Release a V.8 context.
int	v8_free (v8_state_t *s)
	Release a V.8 context.
Variables
enum { ... }	v8_states_e
enum { ... }	v8_sync_types_e

---

Detailed Description

---

Function Documentation

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.

Get the next bit of a transmitted serial bit stream.

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

Apply fake T.30 receive processing.

Apply T.30 receive processing to a block of audio samples.

Parameters:

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

Returns:

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

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.

Get the next bit of a transmitted serial bit stream.

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

Process a block of received FSK modem audio samples.

Generate a block of FSK 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.

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.

Get the next bit of a transmitted serial bit stream.

Get the next sequence of bytes for transmission.

Get the next byte for transmission.

Parameters:

s

A pointer to an HDLC transmitter context.

Returns:

The next bit for transmission.

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.

Get the next bit of a transmitted serial bit stream.

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

Parameters:

	s	The context.
	amp	An array of signal samples.
	len	The number of samples to generate.

Returns:

The number of samples generated.

Parameters:

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

Returns:

The number of unprocessed samples.

Get the next bit of a transmitted serial bit stream.

Dummy receive fillin callback.

Dummy receive callback.

Generate a block of silent audio samples.

Parameters:

	s	The silence generator 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.

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.

Get the next bit of a transmitted serial bit stream.

Generate a block of T.31 modem audio samples.

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

Process a block of received T.31 modem audio samples.

Parameters:

	s	The T.31 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 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.

Get the next bit of a transmitted serial bit stream.

Generate a block of FAX audio samples.

Apply fake received audio processing.

Process a block of received FAX audio samples.

Parameters:

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

Returns:

The number of samples unprocessed.

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.

Get the next bit of a transmitted serial bit stream.

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

Process a block of received V.17 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 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.

Get the next bit of a transmitted serial bit stream.

Generate a block of V.17 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.

Get the next bit of a transmitted serial bit stream.

Process a block of received V.18 audio samples.

Generate a block of V.18 audio samples.

Parameters:

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

Returns:

The number of samples actually generated.

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.

Get the next bit of a transmitted serial bit stream.

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.22bis 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 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.

Get the next bit of a transmitted serial bit stream.

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

Process a block of received V.27ter 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 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.

Get the next bit of a transmitted serial bit stream.

Generate a block of V.27ter 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.

Get the next bit of a transmitted serial bit stream.

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

Process a block of received V.29 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 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.

Get the next bit of a transmitted serial bit stream.

Generate a block of V.29 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.

Get the next bit of a transmitted serial bit stream.

Process a block of received V.8 audio samples.

Generate a block of V.8 audio samples.

Parameters:

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

Returns:

The number of samples actually generated.

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 fsk_tx_init(), MODEM_CONNECT_TONES_NONE, modem_connect_tones_rx_get(), queue_contents(), queue_flush(), span_log(), V8_STATUS_FAILED, V8_STATUS_V8_CALL, and V8_STATUS_V8_OFFERED.

int v8_free

(

v8_state_t *

s

)

Release a V.8 context.

Free a V.8 context.

Parameters:

s

The V.8 context.

Returns:

0 for OK.

References queue_free().

v8_state_t* v8_init	(	v8_state_t *	s,
		int	calling_party,
		v8_parms_t *	parms,
		v8_result_handler_t *	result_handler,
		void *	user_data
	)

Initialise a V.8 context.

Initialise a V.8 context.

Parameters:

	s	The V.8 context.
	calling_party	TRUE if caller mode, else answerer mode.
	parms	The allowed parameters for the call.
	result_handler	The callback routine used to handle the results of negotiation.
	user_data	An opaque pointer passed to the result_handler routine.

Returns:

A pointer to the V.8 context, or NULL if there was a problem.

Referenced by fax_init(), and t31_init().

void v8_log_supported_modulations	(	v8_state_t *	s,
		int	modulation_schemes
	)

Log the list of supported modulations.

Log the list of supported modulations.

Parameters:

	s	The V.8 context.
	modulation_schemes	The list of supported modulations.

References span_log().

int v8_release

(

v8_state_t *

s

)

Release a V.8 context.

Release a V.8 context.

Parameters:

s

The V.8 context.

Returns:

0 for OK.

References queue_free().