Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / i4b / dtmfdecode / dtmfdecode.1
1 .\"
2 .\" Copyright (c) 1999 Hellmuth Michaelis.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\"     $Id: dtmfdecode.1,v 1.6 1999/12/13 22:11:55 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/dtmfdecode/dtmfdecode.1,v 1.5.2.6 2002/12/29 16:35:41 schweikh Exp $
28 .\"
29 .\"     last edit-date: [Mon Dec 13 22:53:13 1999]
30 .\"
31 .\"
32 .Dd February 15, 1999
33 .Dt DTMFDECODE 1
34 .Os
35 .Sh NAME
36 .Nm dtmfdecode
37 .Nd decodes DTMF tones from A-law audio data
38 .Sh SYNOPSIS
39 .Nm
40 .Sh DESCRIPTION
41 The
42 .Nm
43 utility
44 is part of the isdn4bsd package and is used to detect DTMF tones in the
45 audio stream.
46 .Pp
47 It reads audio G.711 A-Law coded data from stdin and outputs the detected
48 numbers values as ASCII characters to stdout.
49 .Pp
50 The detector is implemented as 8 narrow band-pass filters realized with
51 an integer double-cross recursive algorithm.  Various ad-hoc methods are
52 employed to provide hysteresis and anti-bounce for the detected signals.
53 .Sh EXAMPLES
54 The command:
55 .Bd -literal -offset indent
56 dtmfdecode < beep.al
57 .Ed
58 .Pp
59 will print a "1" to stdout.
60 .Sh STANDARDS
61 ITU Recommendations G.711
62 .Sh AUTHORS
63 .An -nosplit
64 The
65 .Nm
66 utility was written by
67 .An Poul-Henning Kamp Aq phk@FreeBSD.org .
68 This man page was written by
69 .An Hellmuth Michaelis Aq hm@FreeBSD.org .