linux-stable/drivers/misc/echo/oslec.h
Thomas Gleixner 82c298100a treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 176
Based on 1 normalized pattern(s):

  this program is free software you can redistribute it and or modify
  it under the terms of the gnu general public license version 2 as
  published by the free software foundation 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 675 mass ave cambridge ma 02139 usa

extracted by the scancode license scanner the SPDX license identifier

  GPL-2.0-only

has been chosen to replace the boilerplate/reference in 44 file(s).

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Allison Randal <allison@lohutok.net>
Reviewed-by: Steve Winslow <swinslow@gmail.com>
Reviewed-by: Alexios Zavras <alexios.zavras@intel.com>
Cc: linux-spdx@vger.kernel.org
Link: https://lkml.kernel.org/r/20190528170025.980374610@linutronix.de
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2019-05-30 11:29:19 -07:00

81 lines
2.2 KiB
C

/* SPDX-License-Identifier: GPL-2.0-only */
/*
* OSLEC - A line echo canceller. This code is being developed
* against and partially complies with G168. Using code from SpanDSP
*
* Written by Steve Underwood <steveu@coppice.org>
* and David Rowe <david_at_rowetel_dot_com>
*
* Copyright (C) 2001 Steve Underwood and 2007-2008 David Rowe
*
* All rights reserved.
*/
#ifndef __OSLEC_H
#define __OSLEC_H
/* Mask bits for the adaption mode */
#define ECHO_CAN_USE_ADAPTION 0x01
#define ECHO_CAN_USE_NLP 0x02
#define ECHO_CAN_USE_CNG 0x04
#define ECHO_CAN_USE_CLIP 0x08
#define ECHO_CAN_USE_TX_HPF 0x10
#define ECHO_CAN_USE_RX_HPF 0x20
#define ECHO_CAN_DISABLE 0x40
/**
* oslec_state: G.168 echo canceller descriptor.
*
* This defines the working state for a line echo canceller.
*/
struct oslec_state;
/**
* oslec_create - Create a voice echo canceller context.
* @len: The length of the canceller, in samples.
* @return: The new canceller context, or NULL if the canceller could not be
* created.
*/
struct oslec_state *oslec_create(int len, int adaption_mode);
/**
* oslec_free - Free a voice echo canceller context.
* @ec: The echo canceller context.
*/
void oslec_free(struct oslec_state *ec);
/**
* oslec_flush - Flush (reinitialise) a voice echo canceller context.
* @ec: The echo canceller context.
*/
void oslec_flush(struct oslec_state *ec);
/**
* oslec_adaption_mode - set the adaption mode of a voice echo canceller context.
* @ec The echo canceller context.
* @adaption_mode: The mode.
*/
void oslec_adaption_mode(struct oslec_state *ec, int adaption_mode);
void oslec_snapshot(struct oslec_state *ec);
/**
* oslec_update: Process a sample through a voice echo canceller.
* @ec: The echo canceller context.
* @tx: The transmitted audio sample.
* @rx: The received audio sample.
*
* The return value is the clean (echo cancelled) received sample.
*/
int16_t oslec_update(struct oslec_state *ec, int16_t tx, int16_t rx);
/**
* oslec_hpf_tx: Process to high pass filter the tx signal.
* @ec: The echo canceller context.
* @tx: The transmitted auio sample.
*
* The return value is the HP filtered transmit sample, send this to your D/A.
*/
int16_t oslec_hpf_tx(struct oslec_state *ec, int16_t tx);
#endif /* __OSLEC_H */