spandsp 0.0.6

swept_tone.h
Go to the documentation of this file.
1/*
2 * SpanDSP - a series of DSP components for telephony
3 *
4 * swept_tone.h - Swept tone generation
5 *
6 * Written by Steve Underwood <steveu@coppice.org>
7 *
8 * Copyright (C) 2009 Steve Underwood
9 *
10 * All rights reserved.
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License version 2.1,
14 * as published by the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 */
25
26/*! \file */
27
28#if !defined(_SPANDSP_SWEPT_TONE_H_)
29#define _SPANDSP_SWEPT_TONE_H_
30
31/*! \page swept_tone_page The swept tone generator
32\section swept_tone_page_sec_1 What does it do?
33*/
34
35 typedef struct swept_tone_state_s swept_tone_state_t;
36
37#if defined(__cplusplus)
38 extern "C"
39{
40#endif
41
42SPAN_DECLARE(swept_tone_state_t *) swept_tone_init(swept_tone_state_t *s, float start, float end, float level, int duration, int repeating);
43
44SPAN_DECLARE(int) swept_tone(swept_tone_state_t *s, int16_t amp[], int len);
45
46SPAN_DECLARE(float) swept_tone_current_frequency(swept_tone_state_t *s);
47
48SPAN_DECLARE(int) swept_tone_release(swept_tone_state_t *s);
49
50SPAN_DECLARE(int) swept_tone_free(swept_tone_state_t *s);
51
52#if defined(__cplusplus)
53}
54#endif
55
56#endif
57/*- End of file ------------------------------------------------------------*/
swept_tone_state_s
Definition private/swept_tone.h:30