spandsp: modem_monitor.h Source File

spandsp 0.0.6

modem_monitor.h
1/*
2 * SpanDSP - a series of DSP components for telephony
3 *
4 * constel.h - Display QAM constellations, using the FLTK toolkit.
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 General Public License version 2, as
14 * 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 General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 */
25
26/*! \page constel_page Modem performance monitoring
27\section constel_page_sec_1 What does it do?
28This code controls a GUI window, which provides monitoring of the internal status
29of a modem. It shows, graphically:
30
31 - the constellation, for PSK, QAM and other similar modulations.
32 - the equalizer status, for modems with adaptive equalizers.
33 - the carrier frequency.
34 - the symbol timing correction.
35
36\section constel_page_sec_2 How does it work?
37This code uses the FLTK cross platform GUI toolkit. It works on X11 and Windows platforms.
38In addition to the basic FLTK toolkit, fltk_cartesian is also required.
39*/
40
41#if !defined(_MODEM_MONITOR_H_)
42#define _MODEM_MONITOR_H_
43
44struct qam_monitor_s;
45
46typedef struct qam_monitor_s qam_monitor_t;
47
48#if defined(__cplusplus)
49extern "C"
50{
51#endif
52
53qam_monitor_t *qam_monitor_init(float constel_width, const char *tag);
54int qam_monitor_clear_constel(qam_monitor_t *s);
55int qam_monitor_update_constel(qam_monitor_t *s, const complexf_t *pt);
56int qam_monitor_update_equalizer(qam_monitor_t *s, const complexf_t *coeffs, int len);
57int qam_monitor_update_int_equalizer(qam_monitor_t *s, const complexi16_t *coeffs, int len);
58int qam_monitor_update_symbol_tracking(qam_monitor_t *s, float total_correction);
59int qam_monitor_update_carrier_tracking(qam_monitor_t *s, float carrier);
60int qam_monitor_update_audio_level(qam_monitor_t *s, const int16_t amp[], int len);
61void qam_wait_to_end(qam_monitor_t *s);
62
63#if defined(__cplusplus)
64}
65#endif
66
67#endif
68/*- End of file ------------------------------------------------------------*/
complexf_t
Definition complex.h:43
complexi16_t
Definition complex.h:89