/usr/include/pjmedia/echo.h is in libpjproject-dev 2.1.0.0.ast20130823-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 | /* $Id: echo.h 4082 2012-04-24 13:09:14Z bennylp $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJMEDIA_ECHO_H__
#define __PJMEDIA_ECHO_H__
/**
* @file echo.h
* @brief Echo Cancellation API.
*/
#include <pjmedia/types.h>
/**
* @defgroup PJMEDIA_Echo_Cancel Accoustic Echo Cancellation API
* @ingroup PJMEDIA_PORT
* @brief Echo Cancellation API.
* @{
*
* This section describes API to perform echo cancellation to audio signal.
* There may be multiple echo canceller implementation in PJMEDIA, ranging
* from simple echo suppressor to a full Accoustic Echo Canceller/AEC. By
* using this API, application should be able to use which EC backend to
* use base on the requirement and capability of the platform.
*/
PJ_BEGIN_DECL
/**
* Opaque type for PJMEDIA Echo Canceller state.
*/
typedef struct pjmedia_echo_state pjmedia_echo_state;
/**
* Echo cancellation options.
*/
typedef enum pjmedia_echo_flag
{
/**
* Use any available backend echo canceller algorithm. This is
* the default settings. This setting is mutually exclusive with
* PJMEDIA_ECHO_SIMPLE and PJMEDIA_ECHO_SPEEX.
*/
PJMEDIA_ECHO_DEFAULT= 0,
/**
* Force to use Speex AEC as the backend echo canceller algorithm.
* This setting is mutually exclusive with PJMEDIA_ECHO_SIMPLE.
*/
PJMEDIA_ECHO_SPEEX = 1,
/**
* If PJMEDIA_ECHO_SIMPLE flag is specified during echo canceller
* creation, then a simple echo suppressor will be used instead of
* an accoustic echo cancellation. This setting is mutually exclusive
* with PJMEDIA_ECHO_SPEEX.
*/
PJMEDIA_ECHO_SIMPLE = 2,
/**
* For internal use.
*/
PJMEDIA_ECHO_ALGO_MASK = 15,
/**
* If PJMEDIA_ECHO_NO_LOCK flag is specified, no mutex will be created
* for the echo canceller, but application will guarantee that echo
* canceller will not be called by different threads at the same time.
*/
PJMEDIA_ECHO_NO_LOCK = 16,
/**
* If PJMEDIA_ECHO_USE_SIMPLE_FIFO flag is specified, the delay buffer
* created for the echo canceller will use simple FIFO mechanism, i.e.
* without using WSOLA to expand and shrink audio samples.
*/
PJMEDIA_ECHO_USE_SIMPLE_FIFO = 32,
/**
* If PJMEDIA_ECHO_USE_SW_ECHO flag is specified, software echo canceller
* will be used instead of device EC.
*/
PJMEDIA_ECHO_USE_SW_ECHO = 64
} pjmedia_echo_flag;
/**
* Create the echo canceller.
*
* @param pool Pool to allocate memory.
* @param clock_rate Media clock rate/sampling rate.
* @param samples_per_frame Number of samples per frame.
* @param tail_ms Tail length, miliseconds.
* @param latency_ms Total lacency introduced by playback and
* recording device. Set to zero if the latency
* is not known.
* @param options Options. If PJMEDIA_ECHO_SIMPLE is specified,
* then a simple echo suppressor implementation
* will be used instead of an accoustic echo
* cancellation.
* See #pjmedia_echo_flag for other options.
* @param p_echo Pointer to receive the Echo Canceller state.
*
* @return PJ_SUCCESS on success, or the appropriate status.
*/
PJ_DECL(pj_status_t) pjmedia_echo_create(pj_pool_t *pool,
unsigned clock_rate,
unsigned samples_per_frame,
unsigned tail_ms,
unsigned latency_ms,
unsigned options,
pjmedia_echo_state **p_echo );
/**
* Create multi-channel the echo canceller.
*
* @param pool Pool to allocate memory.
* @param clock_rate Media clock rate/sampling rate.
* @param channel_count Number of channels.
* @param samples_per_frame Number of samples per frame.
* @param tail_ms Tail length, miliseconds.
* @param latency_ms Total lacency introduced by playback and
* recording device. Set to zero if the latency
* is not known.
* @param options Options. If PJMEDIA_ECHO_SIMPLE is specified,
* then a simple echo suppressor implementation
* will be used instead of an accoustic echo
* cancellation.
* See #pjmedia_echo_flag for other options.
* @param p_echo Pointer to receive the Echo Canceller state.
*
* @return PJ_SUCCESS on success, or the appropriate status.
*/
PJ_DECL(pj_status_t) pjmedia_echo_create2(pj_pool_t *pool,
unsigned clock_rate,
unsigned channel_count,
unsigned samples_per_frame,
unsigned tail_ms,
unsigned latency_ms,
unsigned options,
pjmedia_echo_state **p_echo );
/**
* Destroy the Echo Canceller.
*
* @param echo The Echo Canceller.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_echo_destroy(pjmedia_echo_state *echo );
/**
* Reset the echo canceller.
*
* @param echo The Echo Canceller.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_echo_reset(pjmedia_echo_state *echo );
/**
* Let the Echo Canceller know that a frame has been played to the speaker.
* The Echo Canceller will keep the frame in its internal buffer, to be used
* when cancelling the echo with #pjmedia_echo_capture().
*
* @param echo The Echo Canceller.
* @param play_frm Sample buffer containing frame to be played
* (or has been played) to the playback device.
* The frame must contain exactly samples_per_frame
* number of samples.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_echo_playback(pjmedia_echo_state *echo,
pj_int16_t *play_frm );
/**
* Let the Echo Canceller know that a frame has been captured from the
* microphone. The Echo Canceller will cancel the echo from the captured
* signal, using the internal buffer (supplied by #pjmedia_echo_playback())
* as the FES (Far End Speech) reference.
*
* @param echo The Echo Canceller.
* @param rec_frm On input, it contains the input signal (captured
* from microphone) which echo is to be removed.
* Upon returning this function, this buffer contain
* the processed signal with the echo removed.
* The frame must contain exactly samples_per_frame
* number of samples.
* @param options Echo cancellation options, reserved for future use.
* Put zero for now.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_echo_capture(pjmedia_echo_state *echo,
pj_int16_t *rec_frm,
unsigned options );
/**
* Perform echo cancellation.
*
* @param echo The Echo Canceller.
* @param rec_frm On input, it contains the input signal (captured
* from microphone) which echo is to be removed.
* Upon returning this function, this buffer contain
* the processed signal with the echo removed.
* @param play_frm Sample buffer containing frame to be played
* (or has been played) to the playback device.
* The frame must contain exactly samples_per_frame
* number of samples.
* @param options Echo cancellation options, reserved for future use.
* Put zero for now.
* @param reserved Reserved for future use, put NULL for now.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_echo_cancel( pjmedia_echo_state *echo,
pj_int16_t *rec_frm,
const pj_int16_t *play_frm,
unsigned options,
void *reserved );
PJ_END_DECL
/**
* @}
*/
#endif /* __PJMEDIA_ECHO_H__ */
|