spandsp: v29tx.h Source File

spandsp 0.0.6

private/v29tx.h
1/*
2 * SpanDSP - a series of DSP components for telephony
3 *
4 * private/v29tx.h - ITU V.29 modem transmit part
5 *
6 * Written by Steve Underwood <steveu@coppice.org>
7 *
8 * Copyright (C) 2003 Steve Underwood
9 *
10 * All rights reserved.
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License version 2.1,
14 * as published by the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 */
25
26#if !defined(_SPANDSP_PRIVATE_V29TX_H_)
27#define _SPANDSP_PRIVATE_V29TX_H_
28
29/*! The number of taps in the pulse shaping/bandpass filter */
30#define V29_TX_FILTER_STEPS 9
31
32/*!
33 V.29 modem transmit side descriptor. This defines the working state for a
34 single instance of a V.29 modem transmitter.
35*/
36 struct v29_tx_state_s
37{
38 /*! \brief The bit rate of the modem. Valid values are 4800, 7200 and 9600. */
39 int bit_rate;
40 /*! \brief The callback function used to get the next bit to be transmitted. */
41 get_bit_func_t get_bit;
42 /*! \brief A user specified opaque pointer passed to the get_bit function. */
43 void *get_bit_user_data;
44
45 /*! \brief The callback function used to report modem status changes. */
46 modem_status_func_t status_handler;
47 /*! \brief A user specified opaque pointer passed to the status function. */
48 void *status_user_data;
49
50#if defined(SPANDSP_USE_FIXED_POINT)
51 /*! \brief Gain required to achieve the specified output power, not allowing
52 for the size of the current constellation. */
53 float base_gain;
54 /*! \brief Gain required to achieve the specified output power, allowing
55 for the size of the current constellation. */
56 int32_t gain;
57 /*! \brief The root raised cosine (RRC) pulse shaping filter buffer. */
58 complexi16_t rrc_filter[2*V29_TX_FILTER_STEPS];
59#else
60 /*! \brief Gain required to achieve the specified output power, not allowing
61 for the size of the current constellation. */
62 float base_gain;
63 /*! \brief Gain required to achieve the specified output power, allowing
64 for the size of the current constellation. */
65 float gain;
66 /*! \brief The root raised cosine (RRC) pulse shaping filter buffer. */
67 complexf_t rrc_filter[2*V29_TX_FILTER_STEPS];
68#endif
69 /*! \brief Current offset into the RRC pulse shaping filter buffer. */
70 int rrc_filter_step;
71
72 /*! \brief The register for the data scrambler. */
73 uint32_t scramble_reg;
74 /*! \brief The register for the training scrambler. */
75 uint8_t training_scramble_reg;
76 /*! \brief TRUE if transmitting the training sequence, or shutting down transmission.
77 FALSE if transmitting user data. */
78 int in_training;
79 /*! \brief A counter used to track progress through sending the training sequence. */
80 int training_step;
81 /*! \brief An offset value into the table of training parameters, used to match the
82 training pattern to the bit rate. */
83 int training_offset;
84
85 /*! \brief The current phase of the carrier (i.e. the DDS parameter). */
86 uint32_t carrier_phase;
87 /*! \brief The update rate for the phase of the carrier (i.e. the DDS increment). */
88 int32_t carrier_phase_rate;
89 /*! \brief The current fractional phase of the baud timing. */
90 int baud_phase;
91 /*! \brief The code number for the current position in the constellation. */
92 int constellation_state;
93 /*! \brief The get_bit function in use at any instant. */
94 get_bit_func_t current_get_bit;
95 /*! \brief Error and flow logging control */
96 logging_state_t logging;
97};
98
99#endif
100/*- End of file ------------------------------------------------------------*/
modem_status_func_t
void(* modem_status_func_t)(void *user_data, int status)
Definition async.h:114
get_bit_func_t
int(* get_bit_func_t)(void *user_data)
Definition async.h:108
complexf_t
Definition complex.h:43
complexi16_t
Definition complex.h:89
logging_state_s
Definition private/logging.h:34
v29_tx_state_s
Definition private/v29tx.h:37
v29_tx_state_s::training_scramble_reg
uint8_t training_scramble_reg
The register for the training scrambler.
Definition private/v29tx.h:75
v29_tx_state_s::carrier_phase
uint32_t carrier_phase
The current phase of the carrier (i.e. the DDS parameter).
Definition private/v29tx.h:86
v29_tx_state_s::baud_phase
int baud_phase
The current fractional phase of the baud timing.
Definition private/v29tx.h:90
v29_tx_state_s::get_bit
get_bit_func_t get_bit
The callback function used to get the next bit to be transmitted.
Definition private/v29tx.h:41
v29_tx_state_s::status_user_data
void * status_user_data
A user specified opaque pointer passed to the status function.
Definition private/v29tx.h:48
v29_tx_state_s::get_bit_user_data
void * get_bit_user_data
A user specified opaque pointer passed to the get_bit function.
Definition private/v29tx.h:43
v29_tx_state_s::rrc_filter
complexf_t rrc_filter[2 *9]
The root raised cosine (RRC) pulse shaping filter buffer.
Definition private/v29tx.h:67
v29_tx_state_s::rrc_filter_step
int rrc_filter_step
Current offset into the RRC pulse shaping filter buffer.
Definition private/v29tx.h:70
v29_tx_state_s::carrier_phase_rate
int32_t carrier_phase_rate
The update rate for the phase of the carrier (i.e. the DDS increment).
Definition private/v29tx.h:88
v29_tx_state_s::logging
logging_state_t logging
Error and flow logging control.
Definition private/v29tx.h:96
v29_tx_state_s::training_offset
int training_offset
An offset value into the table of training parameters, used to match the training pattern to the bit ...
Definition private/v29tx.h:83
v29_tx_state_s::training_step
int training_step
A counter used to track progress through sending the training sequence.
Definition private/v29tx.h:80
v29_tx_state_s::base_gain
float base_gain
Gain required to achieve the specified output power, not allowing for the size of the current constel...
Definition private/v29tx.h:62
v29_tx_state_s::gain
float gain
Gain required to achieve the specified output power, allowing for the size of the current constellati...
Definition private/v29tx.h:65
v29_tx_state_s::bit_rate
int bit_rate
The bit rate of the modem. Valid values are 4800, 7200 and 9600.
Definition private/v29tx.h:39
v29_tx_state_s::scramble_reg
uint32_t scramble_reg
The register for the data scrambler.
Definition private/v29tx.h:73
v29_tx_state_s::constellation_state
int constellation_state
The code number for the current position in the constellation.
Definition private/v29tx.h:92
v29_tx_state_s::status_handler
modem_status_func_t status_handler
The callback function used to report modem status changes.
Definition private/v29tx.h:46
v29_tx_state_s::in_training
int in_training
TRUE if transmitting the training sequence, or shutting down transmission. FALSE if transmitting user...
Definition private/v29tx.h:78
v29_tx_state_s::current_get_bit
get_bit_func_t current_get_bit
The get_bit function in use at any instant.
Definition private/v29tx.h:94