Mercurial > hg > audiostuff

comparison spandsp-0.0.6pre17/src/spandsp/t31.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 * t31.h - A T.31 compatible class 1 FAX modem interface.
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: t31.h,v 1.59 2009/03/13 12:59:26 steveu Exp $
26 */
27
28 /*! \file */
29
30 #if !defined(_SPANDSP_T31_H_)
31 #define _SPANDSP_T31_H_
32
33 /*! \page t31_page T.31 Class 1 FAX modem protocol handling
34 \section t31_page_sec_1 What does it do?
35 The T.31 class 1 FAX modem modules implements a class 1 interface to the FAX
36 modems in spandsp.
37
38 \section t31_page_sec_2 How does it work?
39 */
40
41 /*!
42 T.31 descriptor. This defines the working state for a single instance of
43 a T.31 FAX modem.
44 */
45 typedef struct t31_state_s t31_state_t;
46
47 typedef int (t31_modem_control_handler_t)(t31_state_t *s, void *user_data, int op, const char *num);
48
49 #define T31_TX_BUF_LEN (4096)
50 #define T31_TX_BUF_HIGH_TIDE (4096 - 1024)
51 #define T31_TX_BUF_LOW_TIDE (1024)
52 #define T31_MAX_HDLC_LEN 284
53 #define T31_T38_MAX_HDLC_LEN 260
54
55 #if defined(__cplusplus)
56 extern "C"
57 {
58 #endif
59
60 SPAN_DECLARE(void) t31_call_event(t31_state_t *s, int event);
61
62 SPAN_DECLARE(int) t31_at_rx(t31_state_t *s, const char *t, int len);
63
64 /*! Process a block of received T.31 modem audio samples.
65 \brief Process a block of received T.31 modem audio samples.
66 \param s The T.31 modem context.
67 \param amp The audio sample buffer.
68 \param len The number of samples in the buffer.
69 \return The number of samples unprocessed. */
70 SPAN_DECLARE(int) t31_rx(t31_state_t *s, int16_t amp[], int len);
71
72 /*! Fake processing of a missing block of received T.31 modem audio samples
73 (e.g due to packet loss).
74 \brief Fake processing of a missing block of received T.31 modem audio samples.
75 \param s The T.31 modem context.
76 \param len The number of samples to fake.
77 \return The number of samples unprocessed. */
78 SPAN_DECLARE(int) t31_rx_fillin(t31_state_t *s, int len);
79
80 /*! Generate a block of T.31 modem audio samples.
81 \brief Generate a block of T.31 modem audio samples.
82 \param s The T.31 modem context.
83 \param amp The audio sample buffer.
84 \param max_len The number of samples to be generated.
85 \return The number of samples actually generated.
86 */
87 SPAN_DECLARE(int) t31_tx(t31_state_t *s, int16_t amp[], int max_len);
88
89 SPAN_DECLARE(int) t31_t38_send_timeout(t31_state_t *s, int samples);
90
91 /*! Select whether silent audio will be sent when transmit is idle.
92 \brief Select whether silent audio will be sent when transmit is idle.
93 \param s The T.31 modem context.
94 \param transmit_on_idle TRUE if silent audio should be output when the transmitter is
95 idle. FALSE to transmit zero length audio when the transmitter is idle. The default
96 behaviour is FALSE.
97 */
98 SPAN_DECLARE(void) t31_set_transmit_on_idle(t31_state_t *s, int transmit_on_idle);
99
100 /*! Select whether TEP mode will be used (or time allowed for it (when transmitting).
101 \brief Select whether TEP mode will be used.
102 \param s The T.31 modem context.
103 \param use_tep TRUE if TEP is to be ised.
104 */
105 SPAN_DECLARE(void) t31_set_tep_mode(t31_state_t *s, int use_tep);
106
107 /*! Select whether T.38 data will be paced as it is transmitted.
108 \brief Select whether T.38 data will be paced.
109 \param s The T.31 modem context.
110 \param without_pacing TRUE if data is to be sent as fast as possible. FALSE if it is
111 to be paced.
112 */
113 SPAN_DECLARE(void) t31_set_t38_config(t31_state_t *s, int without_pacing);
114
115 SPAN_DECLARE(void) t31_set_mode(t31_state_t *s, int t38_mode);
116
117 /*! Get a pointer to the logging context associated with a T.31 context.
118 \brief Get a pointer to the logging context associated with a T.31 context.
119 \param s The T.31 context.
120 \return A pointer to the logging context, or NULL.
121 */
122 SPAN_DECLARE(logging_state_t *) t31_get_logging_state(t31_state_t *s);
123
124 SPAN_DECLARE(t38_core_state_t *) t31_get_t38_core_state(t31_state_t *s);
125
126 /*! Initialise a T.31 context. This must be called before the first
127 use of the context, to initialise its contents.
128 \brief Initialise a T.31 context.
129 \param s The T.31 context.
130 \param at_tx_handler A callback routine to handle AT interpreter channel output.
131 \param at_tx_user_data An opaque pointer passed in called to at_tx_handler.
132 \param modem_control_handler A callback routine to handle control of the modem (off-hook, etc).
133 \param modem_control_user_data An opaque pointer passed in called to modem_control_handler.
134 \param tx_t38_packet_handler ???
135 \param tx_t38_packet_user_data ???
136 \return A pointer to the T.31 context. */
137 SPAN_DECLARE(t31_state_t *) t31_init(t31_state_t *s,
138 at_tx_handler_t *at_tx_handler,
139 void *at_tx_user_data,
140 t31_modem_control_handler_t *modem_control_handler,
141 void *modem_control_user_data,
142 t38_tx_packet_handler_t *tx_t38_packet_handler,
143 void *tx_t38_packet_user_data);
144
145 /*! Release a T.31 context.
146 \brief Release a T.31 context.
147 \param s The T.31 context.
148 \return 0 for OK */
149 SPAN_DECLARE(int) t31_release(t31_state_t *s);
150
151 /*! Free a T.31 context.
152 \brief Release a T.31 context.
153 \param s The T.31 context.
154 \return 0 for OK */
155 SPAN_DECLARE(int) t31_free(t31_state_t *s);
156
157 #if defined(__cplusplus)
158 }
159 #endif
160
161 #endif
162 /*- End of file ------------------------------------------------------------*/

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