SoftEcho for Asterisk

1. What versions of OCTVQE8 should I use with version 1.x.y of Zaptel?

OCTVQE8 version 01.04.00-PR supports up to version 1.4.7.1 of Zaptel.
OCTVQE8 version 01.04.02-PR supports versions 1.4.8 and newer of Zaptel.

OCTVQE8 does not currently support DAHDI (Digium Asterisk Hardware Device Interface).

All versions can be found here.

2. What information should be provided when a problem is encountered?

In order to ensure a prompt and accurate response, the following information should be provided when reporting a problem:

1) System information

- Names and versions of the hardware, OS, libraries and executables running on the system with the problem.
For example, On Linux systems, the outputs of the following commands should be provided:

uname -a
lsmod
dmesg
ps -aux
cat /proc/cpuinfo
cat /proc/octvqe

- License Key used for registering the product

2) Installation procedure followed

The exact steps that were followed for the installation process. Any deviation from the documented procedure should be outlined.

3) Detailed description of the symptoms and the environment

All the information that describes the unwanted behavior that was observed as well as all the steps taken to get to the problematic situation.

4) Impact analysis

A description of the impacts that the problem has on the system implementation and its usability.

3. How to install OCTVQE8 on zaptel 1.2.21 and 1.4.6

For version 1.2.21 and 1.4.6 of Zaptel, follow the installation instructions found in the documentation.

In short, you must define ECHO_CAN_OCTWARE in zconfig.h.

Look for this: #define ECHO_CAN_MG2
Replace it by: #define ECHO_CAN_OCTWARE

You then have to edit zaptel-base.c and include octwareec14.h by adding the following lines in the echo canceller section:
#elif defined(ECHO_CAN_OCTWARE)
#include "octwareec14.h"

4. How to install OCTVQE8 on zaptel 1.2.20.1 and 1.4.5.1

There is a change in procedure to install OCTVQE8 when you are using version
1.2.20.1 and 1.4.5.1 of Zaptel. Follow the instructions to install the octvqe
module. Then, instead of editing zconfig.h, you have to edit Makefile.kernel26.

Look for this line:
ECHO_CAN_NAME := MG2 and replace MG2 by OCTWARE.

Edit zaptel-base.c by adding the following lines in the echo canceller section:
#elif defined(ECHO_CAN_OCTWARE)
#include "octwareec14.h"

You can then do the make and make install of Zaptel and it will use OCTVQE8 as its default echo canceller.

5. How do zaptel channel numbers relate to ocvqed channel numbers?

The octvqed.conf channel numbers are completely independent from the zaptel channel numbers. The echo_can functions in zaptel used to connect to the ocvqed deamon do not carry the zaptel channel number information. We currenly have no means to tie the octvqed channels to the zaptel the channel numbers. However, once a channel is opened, the octvqed will start by using all the available ( activated with the licenses ) channels first and then fall back to the default zaptel EC for subsequent channels for which EC is enabled. The decision to enable EC or not on a specific zaptel channel ( or group of channels ) is normally made in the /etc/asterisk/zapata.conf file.

6. How do I deactivate OCTVQE8?

It might be useful for troubleshooting purposes to deactivate OCTVQE8. To do this, all octvqed processes must be stopped by entering the "killall octvqed" command. To start OCTVQE8 again, just run the "./octvqed" command from the directory it was extracted to.

7. Can OCTVQE8 be used with the ztdummy module?

Currently, OCTVQE8 cannot be used with the ztdummy module. To perform echo cancellation, the OCTVQE8 relies on the fact that the zaptel driver receives and transmits voice samples. We are currently investigating if we can provide a solution to echo problems on systems not using the zaptel driver to receive and transmit voice samples.

8. Can OCTVQE8 be used with the mISDN driver?

It can. The kernel module and the mISDN driver needs to be patched to make this possible. This has been done by someone at Beronet on version 1.1.2. Please note that at this point we recommend using the latest version. We currently do not have the intention to include these patches in our releases.

You will find the 1.1.2 patched files and a good README here: http://www.beronet.com/downloads/SoftEcho

9. Can OCTVQE8 and HPEC be used together

No. Using HPEC and OCTVQE8 together is not possible. Make sure that none of the HPEC modules are installed and that the "hpec_$arch_$bit.o_shipped" binary is not present the zaptel/hpec directory.

10. Can I move my License Key to another HW platform or change the network adapter?

License Keys are bound to a single hardware platform and cannot be unregistered. Upgrading to a newer computer will require a new license. The Octware License Keys are bound ( amongst other things ) to the MAC address of the first network adapter. It is possible to replace a failing network adapter as long as the MAC address of the new adapter is changed to be the same as the one that was used to perform the registration.

Here is how to change a MAC address on Linux:

ifconfig <interface> hw <class> <address>

For Example:

ifconfig eth0 hw ether 01:02:03:04:05:06 Will give eth0 network adaptor the new address 01:02:03:04:05:06