v17tx.h File Reference

Go to the source code of this file.

Typedefs
typedef struct v17_tx_state_s	v17_tx_state_t

Functions
void	v17_tx_power (v17_tx_state_t *s, float power)
	Adjust a V.17 modem transmit context's output power.
v17_tx_state_t *	v17_tx_init (v17_tx_state_t *s, int bit_rate, int tep, get_bit_func_t get_bit, void *user_data)
	Initialise a V.17 modem transmit context.
int	v17_tx_restart (v17_tx_state_t *s, int bit_rate, int tep, int short_train)
	Reinitialise an existing V.17 modem transmit context.
int	v17_tx_release (v17_tx_state_t *s)
	Release a V.17 modem transmit context.
int	v17_tx_free (v17_tx_state_t *s)
	Free a V.17 modem transmit context.
logging_state_t *	v17_tx_get_logging_state (v17_tx_state_t *s)
	Get the logging context associated with a V.17 modem transmit context.
void	v17_tx_set_get_bit (v17_tx_state_t *s, get_bit_func_t get_bit, void *user_data)
	Change the get_bit function associated with a V.17 modem transmit context.
void	v17_tx_set_modem_status_handler (v17_tx_state_t *s, modem_status_func_t handler, void *user_data)
	Change the modem status report function associated with a V.17 modem transmit context.
	SPAN_DECLARE_NONSTD (int) v17_tx(v17_tx_state_t *s
	Generate a block of V.17 modem audio samples.

Variables
int16_t	amp []
int16_t int	len

Typedef Documentation

v17_tx_state_t

typedef struct v17_tx_state_s v17_tx_state_t

V.17 modem transmit side descriptor. This defines the working state for a single instance of a V.17 modem transmitter.

Function Documentation

SPAN_DECLARE_NONSTD()

SPAN_DECLARE_NONSTD

(

int

)

Generate a block of V.17 modem audio samples.

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.

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

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.

Process a received T.38 IFP packet from a reliable stream (e.g. TCP).

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.

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.

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.

Parameters

s	The T.38 context.
buf	The packet contents.
len	The length of the packet contents.
seq_no	The packet sequence number, used for logging purposes.

Returns

The length of the packet processed, or -1 if there is an error in the packet, or too few bytes of data to complete it.

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.

v17_tx_free()

int v17_tx_free

(

v17_tx_state_t *

s

)

Free a V.17 modem transmit context.

Free a V.17 modem transmit context.

Parameters

s	The modem context.

Returns

0 for OK

v17_tx_get_logging_state()

logging_state_t * v17_tx_get_logging_state

(

v17_tx_state_t *

s

)

Get the logging context associated with a V.17 modem transmit context.

Get the logging context associated with a V.17 modem transmit context.

Parameters

s	The modem context.

Returns

A pointer to the logging context

References v17_tx_state_s::logging.

v17_tx_init()

v17_tx_state_t * v17_tx_init	(	v17_tx_state_t *	s,
		int	bit_rate,
		int	tep,
		get_bit_func_t	get_bit,
		void *	user_data )

Initialise a V.17 modem transmit context.

Initialise a V.17 modem transmit 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 7200, 9600, 12000 and 14400.
tep	TRUE is the optional TEP tone is to be transmitted.
get_bit	The callback routine used to get the data to be transmitted.
user_data	An opaque pointer.

Returns

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

References CARRIER_NOMINAL_FREQ, v17_tx_state_s::carrier_phase_rate, dds_phase_ratef(), v17_tx_state_s::get_bit, v17_tx_state_s::get_bit_user_data, v17_tx_state_s::logging, v17_tx_power(), and v17_tx_restart().

v17_tx_power()

void v17_tx_power	(	v17_tx_state_t *	s,
		float	power )

Adjust a V.17 modem transmit context's output power.

Adjust a V.17 modem transmit context's power output.

Parameters

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

References v17_tx_state_s::gain.

Referenced by v17_tx_init().

v17_tx_release()

int v17_tx_release

(

v17_tx_state_t *

s

)

Release a V.17 modem transmit context.

Release a V.17 modem transmit context.

Parameters

s	The modem context.

Returns

0 for OK

v17_tx_restart()

int v17_tx_restart	(	v17_tx_state_t *	s,
		int	bit_rate,
		int	tep,
		int	short_train )

Reinitialise an existing V.17 modem transmit context.

Reinitialise an existing V.17 modem transmit context, so it may be reused.

Parameters

s	The modem context.
bit_rate	The bit rate of the modem. Valid values are 7200, 9600, 12000 and 14400.
tep	TRUE is the optional TEP tone is to be transmitted.
short_train	TRUE if the short training sequence should be used.

Returns

0 for OK, -1 for parameter error.

References v17_tx_state_s::baud_phase, v17_tx_state_s::bit_rate, v17_tx_state_s::bits_per_symbol, v17_tx_state_s::carrier_phase, v17_tx_state_s::constellation, v17_tx_state_s::constellation_state, v17_tx_state_s::convolution, v17_tx_state_s::current_get_bit, v17_tx_state_s::diff, v17_tx_state_s::in_training, v17_tx_state_s::rrc_filter, v17_tx_state_s::rrc_filter_step, v17_tx_state_s::scramble_reg, v17_tx_state_s::short_train, v17_tx_state_s::training_step, V17_TRAINING_SEG_1, and V17_TRAINING_SEG_TEP_A.

Referenced by v17_tx_init().

v17_tx_set_get_bit()

void v17_tx_set_get_bit	(	v17_tx_state_t *	s,
		get_bit_func_t	get_bit,
		void *	user_data )

Change the get_bit function associated with a V.17 modem transmit context.

Change the get_bit function associated with a V.17 modem transmit context.

Parameters

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

References v17_tx_state_s::current_get_bit, v17_tx_state_s::get_bit, and v17_tx_state_s::get_bit_user_data.

v17_tx_set_modem_status_handler()

void v17_tx_set_modem_status_handler	(	v17_tx_state_t *	s,
		modem_status_func_t	handler,
		void *	user_data )

Change the modem status report function associated with a V.17 modem transmit context.

Change the modem status report function associated with a V.17 modem transmit context.

Parameters

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

References v17_tx_state_s::status_handler, and v17_tx_state_s::status_user_data.