spandsp: t38_non_ecm_buffer.h Source File

spandsp 0.0.6

private/t38_non_ecm_buffer.h
1/*
2 * SpanDSP - a series of DSP components for telephony
3 *
4 * private/t38_non_ecm_buffer.h - A rate adapting buffer for T.38 non-ECM image
5 * and TCF data
6 *
7 * Written by Steve Underwood <steveu@coppice.org>
8 *
9 * Copyright (C) 2005, 2006, 2007, 2008 Steve Underwood
10 *
11 * All rights reserved.
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU Lesser General Public License version 2.1,
15 * as published by the Free Software Foundation.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Lesser General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 */
26
27#if !defined(_SPANDSP_PRIVATE_T38_NON_ECM_BUFFER_H_)
28#define _SPANDSP_PRIVATE_T38_NON_ECM_BUFFER_H_
29
30/*! \brief A flow controlled non-ECM image data buffer, for buffering T.38 to analogue
31 modem data.
32*/
33 struct t38_non_ecm_buffer_state_s
34{
35 /*! \brief Minimum number of bits per row, used when fill bits are being deleted on the
36 link, and restored at the emitting gateway. */
37 int min_bits_per_row;
38
39 /*! \brief non-ECM modem transmit data buffer. */
40 uint8_t data[T38_NON_ECM_TX_BUF_LEN];
41 /*! \brief The current write point in the buffer. */
42 int in_ptr;
43 /*! \brief The current read point in the buffer. */
44 int out_ptr;
45 /*! \brief The location of the most recent EOL marker in the buffer. */
46 int latest_eol_ptr;
47 /*! \brief The number of bits to date in the current row, used when min_row_bits is
48 to be applied. */
49 int row_bits;
50
51 /*! \brief The bit stream entering the buffer, used to detect EOLs */
52 unsigned int bit_stream;
53 /*! \brief The non-ECM flow control fill octet (0xFF before the first data, and 0x00
54 once data has started). */
55 uint8_t flow_control_fill_octet;
56 /*! \brief A code for the phase of input buffering, from initial all ones to completion. */
57 int input_phase;
58 /*! \brief TRUE is the end of non-ECM data indication has been received. */
59 int data_finished;
60 /*! \brief The current octet being transmitted from the buffer. */
61 unsigned int octet;
62 /*! \brief The current bit number in the current non-ECM octet. */
63 int bit_no;
64 /*! \brief TRUE if in image data mode, as opposed to TCF mode. */
65 int image_data_mode;
66
67 /*! \brief The number of octets input to the buffer. */
68 int in_octets;
69 /*! \brief The number of rows input to the buffer. */
70 int in_rows;
71 /*! \brief The number of non-ECM fill octets generated for minimum row bits
72 purposes. */
73 int min_row_bits_fill_octets;
74 /*! \brief The number of octets output from the buffer. */
75 int out_octets;
76 /*! \brief The number of rows output from the buffer. */
77 int out_rows;
78 /*! \brief The number of non-ECM fill octets generated for flow control
79 purposes. */
80 int flow_control_fill_octets;
81};
82
83#endif
84/*- End of file ------------------------------------------------------------*/
t38_non_ecm_buffer_state_s
A flow controlled non-ECM image data buffer, for buffering T.38 to analogue modem data.
Definition private/t38_non_ecm_buffer.h:34
t38_non_ecm_buffer_state_s::out_rows
int out_rows
The number of rows output from the buffer.
Definition private/t38_non_ecm_buffer.h:77
t38_non_ecm_buffer_state_s::latest_eol_ptr
int latest_eol_ptr
The location of the most recent EOL marker in the buffer.
Definition private/t38_non_ecm_buffer.h:46
t38_non_ecm_buffer_state_s::octet
unsigned int octet
The current octet being transmitted from the buffer.
Definition private/t38_non_ecm_buffer.h:61
t38_non_ecm_buffer_state_s::flow_control_fill_octets
int flow_control_fill_octets
The number of non-ECM fill octets generated for flow control purposes.
Definition private/t38_non_ecm_buffer.h:80
t38_non_ecm_buffer_state_s::out_octets
int out_octets
The number of octets output from the buffer.
Definition private/t38_non_ecm_buffer.h:75
t38_non_ecm_buffer_state_s::in_rows
int in_rows
The number of rows input to the buffer.
Definition private/t38_non_ecm_buffer.h:70
t38_non_ecm_buffer_state_s::data_finished
int data_finished
TRUE is the end of non-ECM data indication has been received.
Definition private/t38_non_ecm_buffer.h:59
t38_non_ecm_buffer_state_s::out_ptr
int out_ptr
The current read point in the buffer.
Definition private/t38_non_ecm_buffer.h:44
t38_non_ecm_buffer_state_s::input_phase
int input_phase
A code for the phase of input buffering, from initial all ones to completion.
Definition private/t38_non_ecm_buffer.h:57
t38_non_ecm_buffer_state_s::image_data_mode
int image_data_mode
TRUE if in image data mode, as opposed to TCF mode.
Definition private/t38_non_ecm_buffer.h:65
t38_non_ecm_buffer_state_s::bit_stream
unsigned int bit_stream
The bit stream entering the buffer, used to detect EOLs.
Definition private/t38_non_ecm_buffer.h:52
t38_non_ecm_buffer_state_s::flow_control_fill_octet
uint8_t flow_control_fill_octet
The non-ECM flow control fill octet (0xFF before the first data, and 0x00 once data has started).
Definition private/t38_non_ecm_buffer.h:55
t38_non_ecm_buffer_state_s::min_row_bits_fill_octets
int min_row_bits_fill_octets
The number of non-ECM fill octets generated for minimum row bits purposes.
Definition private/t38_non_ecm_buffer.h:73
t38_non_ecm_buffer_state_s::data
uint8_t data[T38_NON_ECM_TX_BUF_LEN]
non-ECM modem transmit data buffer.
Definition private/t38_non_ecm_buffer.h:40
t38_non_ecm_buffer_state_s::in_octets
int in_octets
The number of octets input to the buffer.
Definition private/t38_non_ecm_buffer.h:68
t38_non_ecm_buffer_state_s::bit_no
int bit_no
The current bit number in the current non-ECM octet.
Definition private/t38_non_ecm_buffer.h:63
t38_non_ecm_buffer_state_s::min_bits_per_row
int min_bits_per_row
Minimum number of bits per row, used when fill bits are being deleted on the link,...
Definition private/t38_non_ecm_buffer.h:37
t38_non_ecm_buffer_state_s::in_ptr
int in_ptr
The current write point in the buffer.
Definition private/t38_non_ecm_buffer.h:42
t38_non_ecm_buffer_state_s::row_bits
int row_bits
The number of bits to date in the current row, used when min_row_bits is to be applied.
Definition private/t38_non_ecm_buffer.h:49
T38_NON_ECM_TX_BUF_LEN
#define T38_NON_ECM_TX_BUF_LEN
Definition t38_non_ecm_buffer.h:72