spandsp: echo_monitor.h Source File

spandsp 0.0.6

echo_monitor.h
1/*
2 * SpanDSP - a series of DSP components for telephony
3 *
4 * echo_monitor.h - Display echo canceller status, 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 echo_monitor_page Echo canceller performance monitoring
27\section echo_monitor_page_sec_1 What does it do?
28This code controls a GUI window, which provides monitoring of the internal status
29of a time domain echo canceller. It shows, graphically:
30
31 - the spectrum of the received signal.
32 - the line model in use (when a known line model is being used).
33 - the adapted coefficients of the canceller.
34
35\section echo_monitor_page_sec_2 How does it work?
36This code uses the FLTK cross platform GUI toolkit. It works on X11 and Windows platforms.
37In addition to the basic FLTK toolkit, fltk_cartesian is also required.
38*/
39
40#if !defined(_ECHO_MONITOR_H_)
41#define _ECHO_MONITOR_H_
42
43#if defined(__cplusplus)
44extern "C"
45{
46#endif
47
48int start_echo_can_monitor(int len);
49int echo_can_monitor_can_update(const int16_t *coeffs, int len);
50int echo_can_monitor_line_model_update(const int32_t *coeffs, int len);
51int echo_can_monitor_line_spectrum_update(const int16_t amp[], int len);
52void echo_can_monitor_wait_to_end(void);
53void echo_can_monitor_update_display(void);
54
55#if defined(__cplusplus)
56}
57#endif
58
59#endif
60/*- End of file ------------------------------------------------------------*/