summaryrefslogtreecommitdiff
path: root/pjmedia/include/pjmedia/echo_port.h
blob: b3945535ced00a7a32f418b3d0a43c84fd744b5d (plain)
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
/* $Id$ */
/* 
 * Copyright (C) 2003-2007 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_AEC_PORT_H__
#define __PJMEDIA_AEC_PORT_H__

/**
 * @file echo_port.h
 * @brief AEC (Accoustic Echo Cancellation) media port.
 */
#include <pjmedia/port.h>



/**
 * @defgroup PJMEDIA_ECHO_PORT Echo Cancellation Port
 * @ingroup PJMEDIA_PORT
 * @brief Echo Cancellation Port
 *
 * Echo canceller media port, using @ref PJMEDIA_Echo_Cancel backend.
 * @{
 */


PJ_BEGIN_DECL


/**
 * Create echo canceller port. 
 *
 * @param pool		Pool to allocate memory.
 * @param dn_port	Downstream port.
 * @param tail_ms	Tail length in miliseconds.
 * @param latency_ms	Total lacency introduced by playback and 
 *			recording device. Set to zero if the latency
 *			is not known.
 * @param options	Options, as in #pjmedia_echo_create().
 * @param p_port	Pointer to receive the port instance.
 *
 * @return		PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjmedia_echo_port_create(pj_pool_t *pool,
					      pjmedia_port *dn_port,
					      unsigned tail_ms,
					      unsigned latency_ms,
					      unsigned options,
					      pjmedia_port **p_port );



PJ_END_DECL

/**
 * @}
 */


#endif	/* __PJMEDIA_AEC_PORT_H__ */