Mercurial > hg > audiostuff

comparison spandsp-0.0.6pre17/src/spandsp/v8.h @ 4:26cd8f1ef0b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
import spandsp-0.0.6pre17
author Peter Meerwald <pmeerw@cosy.sbg.ac.at>
date Fri, 25 Jun 2010 15:50:58 +0200
parents
children
comparison
equal deleted inserted replaced
3:c6c5a16ce2f2 4:26cd8f1ef0b1
1 /*
2 * SpanDSP - a series of DSP components for telephony
3 *
4 * v8.h - V.8 modem negotiation processing.
5 *
6 * Written by Steve Underwood <steveu@coppice.org>
7 *
8 * Copyright (C) 2004 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 * $Id: v8.h,v 1.31.4.1 2009/12/28 12:20:47 steveu Exp $
26 */
27
28 /*! \file */
29
30 /*! \page v8_page The V.8 modem negotiation protocol
31 \section v8_page_sec_1 What does it do?
32 The V.8 specification defines a procedure to be used as PSTN modem answer phone calls,
33 which allows the modems to negotiate the optimum modem standard, which both ends can
34 support.
35
36 \section v8_page_sec_2 How does it work?
37 At startup the modems communicate using the V.21 standard at 300 bits/second. They
38 exchange simple messages about their capabilities, and choose the modem standard they
39 will use for data communication. The V.8 protocol then terminates, and the modems
40 being negotiating and training with their chosen modem standard.
41 */
42
43 #if !defined(_SPANDSP_V8_H_)
44 #define _SPANDSP_V8_H_
45
46 typedef struct v8_parms_s v8_parms_t;
47
48 typedef void (v8_result_handler_t)(void *user_data, v8_parms_t *result);
49
50 enum v8_call_function_e
51 {
52 V8_CALL_TBS = 0,
53 V8_CALL_H324 = 1,
54 V8_CALL_V18 = 2,
55 V8_CALL_T101 = 3,
56 V8_CALL_T30_TX = 4,
57 V8_CALL_T30_RX = 5,
58 V8_CALL_V_SERIES = 6,
59 V8_CALL_FUNCTION_EXTENSION = 7
60 };
61
62 enum v8_modulation_e
63 {
64 V8_MOD_V17 = (1 << 0), /* V.17 half-duplex */
65 V8_MOD_V21 = (1 << 1), /* V.21 duplex */
66 V8_MOD_V22 = (1 << 2), /* V.22/V22.bis duplex */
67 V8_MOD_V23HALF = (1 << 3), /* V.23 half-duplex */
68 V8_MOD_V23 = (1 << 4), /* V.23 duplex */
69 V8_MOD_V26BIS = (1 << 5), /* V.23 duplex */
70 V8_MOD_V26TER = (1 << 6), /* V.23 duplex */
71 V8_MOD_V27TER = (1 << 7), /* V.23 duplex */
72 V8_MOD_V29 = (1 << 8), /* V.29 half-duplex */
73 V8_MOD_V32 = (1 << 9), /* V.32/V32.bis duplex */
74 V8_MOD_V34HALF = (1 << 10), /* V.34 half-duplex */
75 V8_MOD_V34 = (1 << 11), /* V.34 duplex */
76 V8_MOD_V90 = (1 << 12), /* V.90 duplex */
77 V8_MOD_V92 = (1 << 13), /* V.92 duplex */
78
79 V8_MOD_FAILED = (1 << 15) /* Indicates failure to negotiate */
80 };
81
82 enum v8_protocol_e
83 {
84 V8_PROTOCOL_NONE = 0,
85 V8_PROTOCOL_LAPM_V42 = 1,
86 V8_PROTOCOL_EXTENSION = 7
87 };
88
89 enum v8_pstn_access_e
90 {
91 V8_PSTN_ACCESS_CALL_DCE_CELLULAR = 0x01,
92 V8_PSTN_ACCESS_ANSWER_DCE_CELLULAR = 0x02,
93 V8_PSTN_ACCESS_DCE_ON_DIGITAL = 0x04
94 };
95
96 enum v8_pcm_modem_availability_e
97 {
98 V8_PSTN_PCM_MODEM_V90_V92_ANALOGUE = 0x01,
99 V8_PSTN_PCM_MODEM_V90_V92_DIGITAL = 0x02,
100 V8_PSTN_PCM_MODEM_V91 = 0x04
101 };
102
103 typedef struct v8_state_s v8_state_t;
104
105 struct v8_parms_s
106 {
107 int modem_connect_tone;
108 int call_function;
109 unsigned int modulations;
110 int protocol;
111 int pstn_access;
112 int pcm_modem_availability;
113 int nsf;
114 int t66;
115 };
116
117 #if defined(__cplusplus)
118 extern "C"
119 {
120 #endif
121
122 SPAN_DECLARE(int) v8_restart(v8_state_t *s,
123 int calling_party,
124 v8_parms_t *parms);
125
126 /*! Initialise a V.8 context.
127 \brief Initialise a V.8 context.
128 \param s The V.8 context.
129 \param calling_party TRUE if caller mode, else answerer mode.
130 \param parms The allowed parameters for the call.
131 \param result_handler The callback routine used to handle the results of negotiation.
132 \param user_data An opaque pointer passed to the result_handler routine.
133 \return A pointer to the V.8 context, or NULL if there was a problem. */
134 SPAN_DECLARE(v8_state_t *) v8_init(v8_state_t *s,
135 int calling_party,
136 v8_parms_t *parms,
137 v8_result_handler_t *result_handler,
138 void *user_data);
139
140 /*! Release a V.8 context.
141 \brief Release a V.8 context.
142 \param s The V.8 context.
143 \return 0 for OK. */
144 SPAN_DECLARE(int) v8_release(v8_state_t *s);
145
146 /*! Free a V.8 context.
147 \brief Release a V.8 context.
148 \param s The V.8 context.
149 \return 0 for OK. */
150 SPAN_DECLARE(int) v8_free(v8_state_t *s);
151
152 SPAN_DECLARE(logging_state_t *) v8_get_logging_state(v8_state_t *s);
153
154 /*! Generate a block of V.8 audio samples.
155 \brief Generate a block of V.8 audio samples.
156 \param s The V.8 context.
157 \param amp The audio sample buffer.
158 \param max_len The number of samples to be generated.
159 \return The number of samples actually generated.
160 */
161 SPAN_DECLARE_NONSTD(int) v8_tx(v8_state_t *s, int16_t *amp, int max_len);
162
163 /*! Process a block of received V.8 audio samples.
164 \brief Process a block of received V.8 audio samples.
165 \param s The V.8 context.
166 \param amp The audio sample buffer.
167 \param len The number of samples in the buffer.
168 */
169 SPAN_DECLARE_NONSTD(int) v8_rx(v8_state_t *s, const int16_t *amp, int len);
170
171 /*! Log the list of supported modulations.
172 \brief Log the list of supported modulations.
173 \param s The V.8 context.
174 \param modulation_schemes The list of supported modulations. */
175 SPAN_DECLARE(void) v8_log_supported_modulations(v8_state_t *s, int modulation_schemes);
176
177 SPAN_DECLARE(const char *) v8_call_function_to_str(int call_function);
178 SPAN_DECLARE(const char *) v8_modulation_to_str(int modulation_scheme);
179 SPAN_DECLARE(const char *) v8_protocol_to_str(int protocol);
180 SPAN_DECLARE(const char *) v8_pstn_access_to_str(int pstn_access);
181 SPAN_DECLARE(const char *) v8_nsf_to_str(int nsf);
182 SPAN_DECLARE(const char *) v8_pcm_modem_availability_to_str(int pcm_modem_availability);
183 SPAN_DECLARE(const char *) v8_t66_to_str(int t66);
184
185 #if defined(__cplusplus)
186 }
187 #endif
188
189 #endif
190 /*- End of file ------------------------------------------------------------*/

Repositories maintained by Peter Meerwald, pmeerw@pmeerw.net.