Changeset 653 for pjproject/trunk/pjmedia/include/pjmedia/sound_port.h

Timestamp:

Aug 6, 2006 12:07:13 PM (18 years ago)

Author:

bennylp

Message:

Change AEC into generic echo canceller framework with either AEC or simple echo suppressor backend can be selected during runtime.

File:

• pjproject/trunk/pjmedia/include/pjmedia/sound_port.h (modified) (2 diffs)

pjproject/trunk/pjmedia/include/pjmedia/sound_port.h

@@ -184 +184 @@
 
 /**
- * Enable accoustic echo cancellation (AEC) to the specified sound. 
- * The AEC can only be enabled for sound streams with full-duplex direction.
- *
- * And note, you should only change the AEC settings when the sound port
- * is not connected to any downstream ports.
- *
- * @param snd_port          The sound device port.
- * @param pool              Pool to re-create the AEC if necessary.
+ * Configure the echo cancellation tail length. By default, echo canceller
+ * is enabled in the sound device with the default tail length. After the
+ * sound port is created, application can query the current echo canceller
+ * tail length by calling #pjmedia_snd_port_get_ec_tail.
+ *
+ * Note that you should only change the EC settings when the sound port
+ * is not connected to any downstream ports, otherwise race condition may
+ * occur.
+ *
+ * @param snd_port          The sound device port.
+ * @param pool              Pool to re-create the echo canceller if necessary.
  * @param tail_ms           Maximum echo tail length to be supported, in
- *                          miliseconds. If zero is specified, the AEC would
+ *                          miliseconds. If zero is specified, the EC would
  *                          be disabled.
  *
  * @return                  PJ_SUCCESS on success.
  */
-PJ_DECL(pj_status_t) pjmedia_snd_port_set_aec(pjmedia_snd_port *snd_port,
-                                              pj_pool_t *pool,
-                                              unsigned tail_ms);
-
-
-/**
- * Get current AEC tail length, in miliseconds. The tail length will be zero
- * if AEC is not enabled.
+PJ_DECL(pj_status_t) pjmedia_snd_port_set_ec_tail(pjmedia_snd_port *snd_port,
+                                                  pj_pool_t *pool,
+                                                  unsigned tail_ms);
+
+
+/**
+ * Get current echo canceller tail length, in miliseconds. The tail length 
+ * will be zero if EC is not enabled.
  *
  * @param snd_port          The sound device port.
@@ -212 +215 @@
  * @return                  PJ_SUCCESS on success.
  */
-PJ_DECL(pj_status_t) pjmedia_snd_port_get_aec_tail(pjmedia_snd_port *snd_port,
-                                                   unsigned *p_length);
+PJ_DECL(pj_status_t) pjmedia_snd_port_get_ec_tail(pjmedia_snd_port *snd_port,
+                                                  unsigned *p_length);