v22bis_tx.c File Reference

#include <stdio.h>
#include <inttypes.h>
#include <stdlib.h>
#include <string.h>
#include <tgmath.h>
#include <math.h>
#include "floating_fudge.h"
#include "spandsp/telephony.h"
#include "spandsp/fast_convert.h"
#include "spandsp/logging.h"
#include "spandsp/complex.h"
#include "spandsp/vector_float.h"
#include "spandsp/complex_vector_float.h"
#include "spandsp/vector_int.h"
#include "spandsp/complex_vector_int.h"
#include "spandsp/async.h"
#include "spandsp/dds.h"
#include "spandsp/power_meter.h"
#include "spandsp/v29rx.h"
#include "spandsp/v22bis.h"
#include "spandsp/private/logging.h"
#include "spandsp/private/v22bis.h"
#include "v22bis_tx_floating_rrc.h"

Defines
#define	ms_to_symbols(t)   (((t)*600)/1000)
Functions
	SPAN_DECLARE_NONSTD (int)
	Get the next bit of a transmitted serial bit stream.
void	v22bis_tx_power (v22bis_state_t *s, float power)
	Adjust a V.22bis modem transmit context's output power.
void	v22bis_set_get_bit (v22bis_state_t *s, get_bit_func_t get_bit, void *user_data)
	Change the get_bit function associated with a V.22bis modem context.
void	v22bis_set_put_bit (v22bis_state_t *s, put_bit_func_t put_bit, void *user_data)
	Change the put_bit function associated with a V.22bis modem context.
void	v22bis_set_modem_status_handler (v22bis_state_t *s, modem_tx_status_func_t handler, void *user_data)
	Change the modem status report function associated with a V.22bis modem receive context.
logging_state_t *	v22bis_get_logging_state (v22bis_state_t *s)
	Get the logging context associated with a V.22bis modem context.
int	v22bis_restart (v22bis_state_t *s, int bit_rate)
	Reinitialise an existing V.22bis modem context.
int	v22bis_request_retrain (v22bis_state_t *s, int bit_rate)
	Request a retrain for a V.22bis modem context.
int	v22bis_remote_loopback (v22bis_state_t *s, int enable)
	Request a loopback 2 for a V.22bis modem context.
int	v22bis_get_current_bit_rate (v22bis_state_t *s)
	Report the current operating bit rate of a V.22bis modem context.
v22bis_state_t *	v22bis_init (v22bis_state_t *s, int bit_rate, int guard, int calling_party, get_bit_func_t get_bit, void *get_bit_user_data, put_bit_func_t put_bit, void *put_bit_user_data)
	Initialise a V.22bis modem context.
int	v22bis_release (v22bis_state_t *s)
	Release a V.22bis modem receive context.
int	v22bis_free (v22bis_state_t *s)
	Free a V.22bis modem receive context.
Variables
const complexf_t	v22bis_constellation [16]

---

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 dds_complexf(), dds_modf(), complexf_t::im, and complexf_t::re.

int v22bis_free

(

v22bis_state_t *

s

)

Free a V.22bis modem receive context.

Free a V.22bis modem receive context.

Parameters:

s

The modem context.

Returns:

0 for OK

int v22bis_get_current_bit_rate

(

v22bis_state_t *

s

)

Report the current operating bit rate of a V.22bis modem context.

Report the current operating bit rate of a V.22bis modem context.

Parameters:

s

The modem context.

logging_state_t* v22bis_get_logging_state

(

v22bis_state_t *

s

)

Get the logging context associated with a V.22bis modem context.

Get the logging context associated with a V.22bis modem context.

Parameters:

s

The modem context.

Returns:

A pointer to the logging context

v22bis_state_t* v22bis_init	(	v22bis_state_t *	s,
		int	bit_rate,
		int	guard,
		int	calling_party,
		get_bit_func_t	get_bit,
		void *	get_bit_user_data,
		put_bit_func_t	put_bit,
		void *	put_bit_user_data
	)

Initialise a V.22bis modem context.

Initialise a V.22bis modem context. This must be called before the first use of the context, to initialise its contents.

Parameters:

	s	The modem context.
	bit_rate	The bit rate of the modem. Valid values are 1200 and 2400.
	guard	The guard tone option. 0 = none, 1 = 550Hz, 2 = 1800Hz.
	calling_party	TRUE if this is the calling modem.
	get_bit	The callback routine used to get the data to be transmitted.
	put_bit	The callback routine used to get the data to be transmitted.
	user_data	An opaque pointer, passed in calls to the get and put routines.

Returns:

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

References dds_phase_ratef(), v22bis_restart(), and v22bis_tx_power().

int v22bis_release

(

v22bis_state_t *

s

)

Release a V.22bis modem receive context.

Release a V.22bis modem receive context.

Parameters:

s

The modem context.

Returns:

0 for OK

int v22bis_remote_loopback	(	v22bis_state_t *	s,
		int	enable
	)

Request a loopback 2 for a V.22bis modem context.

Request a loopback 2 for a V.22bis modem context.

Parameters:

	s	The modem context.
	enable	TRUE to enable loopback, or FALSE to disable it.

Returns:

0 for OK, -1 for request reject.

int v22bis_request_retrain	(	v22bis_state_t *	s,
		int	bit_rate
	)

Request a retrain for a V.22bis modem context.

Request a retrain for a V.22bis modem context. A rate change may also be requested.

Parameters:

	s	The modem context.
	bit_rate	The bit rate of the modem. Valid values are 1200 and 2400.

Returns:

0 for OK, -1 for request rejected.

References SIG_STATUS_MODEM_RETRAIN_OCCURRED, and span_log().

int v22bis_restart	(	v22bis_state_t *	s,
		int	bit_rate
	)

Reinitialise an existing V.22bis modem context.

Reinitialise an existing V.22bis modem context, so it may be reused.

Parameters:

	s	The modem context.
	bit_rate	The bit rate of the modem. Valid values are 1200 and 2400.

Returns:

0 for OK, -1 for bad parameter.

References v22bis_rx_restart().

Referenced by v22bis_init().

void v22bis_set_get_bit	(	v22bis_state_t *	s,
		get_bit_func_t	get_bit,
		void *	user_data
	)

Change the get_bit function associated with a V.22bis modem context.

Change the get_bit function associated with a V.22bis modem context.

Parameters:

	s	The modem context.
	get_bit	The callback routine used to get the data to be transmitted.
	user_data	An opaque pointer.

void v22bis_set_modem_status_handler	(	v22bis_state_t *	s,
		modem_rx_status_func_t	handler,
		void *	user_data
	)

Change the modem status report function associated with a V.22bis modem receive context.

Change the modem status report function associated with a V.22bis modem receive context.

Parameters:

	s	The modem context.
	handler	The callback routine used to report modem status changes.
	user_data	An opaque pointer.

void v22bis_set_put_bit	(	v22bis_state_t *	s,
		put_bit_func_t	put_bit,
		void *	user_data
	)

Change the put_bit function associated with a V.22bis modem context.

Change the get_bit function associated with a V.22bis modem context.

Parameters:

	s	The modem context.
	put_bit	The callback routine used to process the data received.
	user_data	An opaque pointer.

void v22bis_tx_power	(	v22bis_state_t *	s,
		float	power
	)

Adjust a V.22bis modem transmit context's output power.

Adjust a V.22bis modem transmit context's power output.

Parameters:

	s	The modem context.
	power	The power level, in dBm0

References dds_phase_ratef().

Referenced by v22bis_init().

---

Variable Documentation

const complexf_t v22bis_constellation[16]

Initial value:

{
    { 1.0f,  1.0f},
    { 3.0f,  1.0f},     
    { 1.0f,  3.0f},
    { 3.0f,  3.0f},
    {-1.0f,  1.0f},
    {-1.0f,  3.0f},     
    {-3.0f,  1.0f},
    {-3.0f,  3.0f},
    {-1.0f, -1.0f},
    {-3.0f, -1.0f},     
    {-1.0f, -3.0f},
    {-3.0f, -3.0f},
    { 1.0f, -1.0f},
    { 1.0f, -3.0f},     
    { 3.0f, -1.0f},
    { 3.0f, -3.0f}
}