Add two widely used constants
[asterisk/asterisk.git] / include / asterisk / plc.h
1 /*! \file
2  * \brief SpanDSP - a series of DSP components for telephony
3  *
4  * plc.h
5  *
6  * \author 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 as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
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 General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  * This version may be optionally licenced under the GNU LGPL licence.
27  * This version is disclaimed to DIGIUM for inclusion in the Asterisk project.
28  */
29
30
31 #if !defined(_PLC_H_)
32 #define _PLC_H_
33
34 #ifdef SOLARIS
35 #include <sys/int_types.h>
36 #else
37 #if defined(__OpenBSD__) || defined( __FreeBSD__)
38 #include <inttypes.h>
39 #else
40 #include <stdint.h>
41 #endif
42 #endif
43
44 /*! \page plc_page Packet loss concealment
45 \section plc_page_sec_1 What does it do?
46 The packet loss concealment module provides a suitable synthetic fill-in signal,
47 to minimise the audible effect of lost packets in VoIP applications. It is not
48 tied to any particular codec, and could be used with almost any codec which does not
49 specify its own procedure for packet loss concealment.
50
51 Where a codec specific concealment procedure exists, the algorithm is usually built
52 around knowledge of the characteristics of the particular codec. It will, therefore,
53 generally give better results for that particular codec than this generic concealer will.
54
55 \section plc_page_sec_2 How does it work?
56 While good packets are being received, the plc_rx() routine keeps a record of the trailing
57 section of the known speech signal. If a packet is missed, plc_fillin() is called to produce
58 a synthetic replacement for the real speech signal. The average mean difference function
59 (AMDF) is applied to the last known good signal, to determine its effective pitch.
60 Based on this, the last pitch period of signal is saved. Essentially, this cycle of speech
61 will be repeated over and over until the real speech resumes. However, several refinements
62 are needed to obtain smooth pleasant sounding results.
63
64 - The two ends of the stored cycle of speech will not always fit together smoothly. This can
65   cause roughness, or even clicks, at the joins between cycles. To soften this, the
66   1/4 pitch period of real speech preceeding the cycle to be repeated is blended with the last
67   1/4 pitch period of the cycle to be repeated, using an overlap-add (OLA) technique (i.e.
68   in total, the last 5/4 pitch periods of real speech are used).
69
70 - The start of the synthetic speech will not always fit together smoothly with the tail of
71   real speech passed on before the erasure was identified. Ideally, we would like to modify
72   the last 1/4 pitch period of the real speech, to blend it into the synthetic speech. However,
73   it is too late for that. We could have delayed the real speech a little, but that would
74   require more buffer manipulation, and hurt the efficiency of the no-lost-packets case
75   (which we hope is the dominant case). Instead we use a degenerate form of OLA to modify
76   the start of the synthetic data. The last 1/4 pitch period of real speech is time reversed,
77   and OLA is used to blend it with the first 1/4 pitch period of synthetic speech. The result
78   seems quite acceptable.
79
80 - As we progress into the erasure, the chances of the synthetic signal being anything like
81   correct steadily fall. Therefore, the volume of the synthesized signal is made to decay
82   linearly, such that after 50ms of missing audio it is reduced to silence.
83
84 - When real speech resumes, an extra 1/4 pitch period of sythetic speech is blended with the
85   start of the real speech. If the erasure is small, this smoothes the transition. If the erasure
86   is long, and the synthetic signal has faded to zero, the blending softens the start up of the
87   real signal, avoiding a kind of "click" or "pop" effect that might occur with a sudden onset.
88
89 \section plc_page_sec_3 How do I use it?
90 Before audio is processed, call plc_init() to create an instance of the packet loss
91 concealer. For each received audio packet that is acceptable (i.e. not including those being
92 dropped for being too late) call plc_rx() to record the content of the packet. Note this may
93 modify the packet a little after a period of packet loss, to blend real synthetic data smoothly.
94 When a real packet is not available in time, call plc_fillin() to create a sythetic substitute.
95 That's it!
96 */
97
98 /*! Minimum allowed pitch (66 Hz) */
99 #define PLC_PITCH_MIN           120
100 /*! Maximum allowed pitch (200 Hz) */
101 #define PLC_PITCH_MAX           40
102 /*! Maximum pitch OLA window */
103 #define PLC_PITCH_OVERLAP_MAX   (PLC_PITCH_MIN >> 2)
104 /*! The length over which the AMDF function looks for similarity (20 ms) */
105 #define CORRELATION_SPAN        160
106 /*! History buffer length. The buffer much also be at leat 1.25 times
107     PLC_PITCH_MIN, but that is much smaller than the buffer needs to be for
108     the pitch assessment. */
109 #define PLC_HISTORY_LEN         (CORRELATION_SPAN + PLC_PITCH_MIN)
110
111 typedef struct
112 {
113     /*! Consecutive erased samples */
114     int missing_samples;
115     /*! Current offset into pitch period */
116     int pitch_offset;
117     /*! Pitch estimate */
118     int pitch;
119     /*! Buffer for a cycle of speech */
120     float pitchbuf[PLC_PITCH_MIN];
121     /*! History buffer */
122     int16_t history[PLC_HISTORY_LEN];
123     /*! Current pointer into the history buffer */
124     int buf_ptr;
125 } plc_state_t;
126
127
128 #ifdef __cplusplus
129 extern "C" {
130 #endif
131
132 /*! Process a block of received audio samples.
133     \brief Process a block of received audio samples.
134     \param s The packet loss concealer context.
135     \param amp The audio sample buffer.
136     \param len The number of samples in the buffer.
137     \return The number of samples in the buffer. */
138 int plc_rx(plc_state_t *s, int16_t amp[], int len);
139
140 /*! Fill-in a block of missing audio samples.
141     \brief Fill-in a block of missing audio samples.
142     \param s The packet loss concealer context.
143     \param amp The audio sample buffer.
144     \param len The number of samples to be synthesised.
145     \return The number of samples synthesized. */
146 int plc_fillin(plc_state_t *s, int16_t amp[], int len);
147
148 /*! Process a block of received V.29 modem audio samples.
149     \brief Process a block of received V.29 modem audio samples.
150     \param s The packet loss concealer context.
151     \return A pointer to the he packet loss concealer context. */
152 plc_state_t *plc_init(plc_state_t *s);
153
154 #ifdef __cplusplus
155 }
156 #endif
157
158 #endif
159 /*- End of file ------------------------------------------------------------*/