spandsp  3.0.0
private/v27ter_tx.h
1 /*
2  * SpanDSP - a series of DSP components for telephony
3  *
4  * private/v27ter_tx.h - ITU V.27ter 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_V27TER_TX_H_)
27 #define _SPANDSP_PRIVATE_V27TER_TX_H_
28 
29 /*! The number of taps in the pulse shaping/bandpass filter */
30 #define V27TER_TX_FILTER_STEPS 9
31 
32 /*!
33  V.27ter modem transmit side descriptor. This defines the working state for a
34  single instance of a V.27ter modem transmitter.
35 */
37 {
38  /*! \brief The bit rate of the modem. Valid values are 2400 and 4800. */
39  int bit_rate;
40  /*! \brief The callback function used to get the next bit to be transmitted. */
42  /*! \brief A user specified opaque pointer passed to the get_bit function. */
44 
45  /*! \brief The callback function used to report modem status changes. */
47  /*! \brief A user specified opaque pointer passed to the status function. */
49 
50 #if defined(SPANDSP_USE_FIXED_POINT)
51  /*! \brief The gain factor needed to achieve the specified output power at 2400bps. */
52  int16_t gain_2400;
53  /*! \brief The gain factor needed to achieve the specified output power at 4800bps. */
54  int16_t gain_4800;
55  /*! \brief The root raised cosine (RRC) pulse shaping filter buffer. */
56  int16_t rrc_filter_re[V27TER_TX_FILTER_STEPS];
57  int16_t rrc_filter_im[V27TER_TX_FILTER_STEPS];
58 #else
59  /*! \brief The gain factor needed to achieve the specified output power at 2400bps. */
60  float gain_2400;
61  /*! \brief The gain factor needed to achieve the specified output power at 4800bps. */
62  float gain_4800;
63  /*! \brief The root raised cosine (RRC) pulse shaping filter buffer. */
64  float rrc_filter_re[V27TER_TX_FILTER_STEPS];
65  float rrc_filter_im[V27TER_TX_FILTER_STEPS];
66 #endif
67 
68  /*! \brief Current offset into the RRC pulse shaping filter buffer. */
70 
71  /*! \brief The register for the training and data scrambler. */
72  uint32_t scramble_reg;
73  /*! \brief A counter for the number of consecutive bits of repeating pattern through
74  the scrambler. */
76  /*! \brief True if transmitting the training sequence, or shutting down transmission.
77  False if transmitting user data. */
79  /*! \brief A counter used to track progress through sending the training sequence. */
81 
82  /*! \brief The current phase of the carrier (i.e. the DDS parameter). */
83  uint32_t carrier_phase;
84  /*! \brief The update rate for the phase of the carrier (i.e. the DDS increment). */
86  /*! \brief The current fractional phase of the baud timing. */
88  /*! \brief The code number for the current position in the constellation. */
90  /*! \brief The get_bit function in use at any instant. */
92  /*! \brief Error and flow logging control */
94 };
95 
96 #endif
97 /*- End of file ------------------------------------------------------------*/
void(* modem_status_func_t)(void *user_data, int status)
Definition: async.h:113
int(* get_bit_func_t)(void *user_data)
Definition: async.h:110
Definition: private/logging.h:34
Definition: private/v27ter_tx.h:37
int bit_rate
The bit rate of the modem. Valid values are 2400 and 4800.
Definition: private/v27ter_tx.h:39
int32_t carrier_phase_rate
The update rate for the phase of the carrier (i.e. the DDS increment).
Definition: private/v27ter_tx.h:85
uint32_t scramble_reg
The register for the training and data scrambler.
Definition: private/v27ter_tx.h:72
get_bit_func_t get_bit
The callback function used to get the next bit to be transmitted.
Definition: private/v27ter_tx.h:41
void * get_bit_user_data
A user specified opaque pointer passed to the get_bit function.
Definition: private/v27ter_tx.h:43
bool in_training
True if transmitting the training sequence, or shutting down transmission. False if transmitting user...
Definition: private/v27ter_tx.h:78
int baud_phase
The current fractional phase of the baud timing.
Definition: private/v27ter_tx.h:87
modem_status_func_t status_handler
The callback function used to report modem status changes.
Definition: private/v27ter_tx.h:46
get_bit_func_t current_get_bit
The get_bit function in use at any instant.
Definition: private/v27ter_tx.h:91
float gain_2400
The gain factor needed to achieve the specified output power at 2400bps.
Definition: private/v27ter_tx.h:60
int scrambler_pattern_count
A counter for the number of consecutive bits of repeating pattern through the scrambler.
Definition: private/v27ter_tx.h:75
int rrc_filter_step
Current offset into the RRC pulse shaping filter buffer.
Definition: private/v27ter_tx.h:69
logging_state_t logging
Error and flow logging control.
Definition: private/v27ter_tx.h:93
int training_step
A counter used to track progress through sending the training sequence.
Definition: private/v27ter_tx.h:80
void * status_user_data
A user specified opaque pointer passed to the status function.
Definition: private/v27ter_tx.h:48
int constellation_state
The code number for the current position in the constellation.
Definition: private/v27ter_tx.h:89
uint32_t carrier_phase
The current phase of the carrier (i.e. the DDS parameter).
Definition: private/v27ter_tx.h:83
float rrc_filter_re[9]
The root raised cosine (RRC) pulse shaping filter buffer.
Definition: private/v27ter_tx.h:64
float gain_4800
The gain factor needed to achieve the specified output power at 4800bps.
Definition: private/v27ter_tx.h:62