3bc9a49d719795111efc29d6a1dc0019f370f13c
[dragonfly.git] / usr.sbin / i4b / g711conv / g711conv.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: g711conv.1,v 1.3 1999/12/13 22:11:55 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/g711conv/g711conv.1,v 1.4.2.6 2002/06/21 16:40:34 charnier Exp $
28 .\" $DragonFly: src/usr.sbin/i4b/g711conv/g711conv.1,v 1.3 2006/02/17 19:40:15 swildner Exp $
29 .\"
30 .\"     last edit-date: [Mon Dec 13 22:54:33 1999]
31 .\"
32 .Dd March 15, 1999
33 .Dt G711CONV 1
34 .Os
35 .Sh NAME
36 .Nm g711conv
37 .Nd conversions according to G.711
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl a
41 .Op Fl u
42 .Op Fl P
43 .Op Fl A
44 .Op Fl R
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility
49 is part of the isdn4bsd package and is used to convert between the A-Law and
50 u-law formats as specified in ITU G.711. It is based on a freely available
51 and freely usable reference implementation done by Sun Microsystems, Inc.
52 .Pp
53 The following options are available:
54 .Bl -tag -width Ds
55 .It Fl a
56 Convert A-law to u-law
57 .It Fl u
58 Convert u-law to A-law
59 .It Fl r
60 Reverse bits before conversion
61 .It Fl R
62 Reverse bits after conversion
63 .It Fl P
64 Print the resulting conversion tables (as C-source) to stdout instead of
65 doing the actual conversion.
66 .El
67 .Sh EXAMPLES
68 The command:
69 .Bd -literal -offset indent
70 g711conv -P -a
71 .Ed
72 .Pp
73 prints out the A-law to u-law conversion table as C-source to stdout.
74 .Pp
75 The command:
76 .Bd -literal -offset indent
77 cat max_headroom.ul | g711conv -u -R > /dev/i4btel0
78 .Ed
79 .Pp
80 converts the u-law coded voice of Max Headroom to A-law, reverses the
81 bits of the result and moves that to an active isdn4bsd telephone connection.
82 .Sh STANDARDS
83 A-Law and u-Law conversions are specified in ITU Recommendation G.711.
84 .Pp
85 The reference implementation done by Sun Microsystems, Inc. is available
86 from http://www.itu.int/itudoc/itu-t/rec/g/g700-799/refimpl.txt
87 .Sh AUTHORS
88 The
89 .Nm
90 utility and this manpage were written by
91 .An Hellmuth Michaelis Aq hm@kts.org
92 based on the G.711 conversion reference code written by Sun Microsystems,
93 Inc. and code contributed to isdn4bsd by Stefan Bethke.