Fixup fromcvs/togit conversion
[minix-pkgsrc.git] / audio / mpegaudio / files / mpeg_musicout.1
blobcba817497e69c509443876979809ac3c48b27968
1 .\" Copyright (c) 1997 Andreas Klemm <andreas@FreeBSD.org>. Neuss.
2 .\" 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 .\" $FreeBSD: ports/audio/mpegaudio/files/mpeg_musicout.1,v 1.2 1999/08/29 10:56:51 peter Exp $
26 .Dd August 17, 1997
27 .Dt MPEG_MUSICOUT 1
28 .Os
29 .Sh NAME
30 .Nm mpeg_musicout
31 .Nd MPEG/audio Layer 1 and Layer 2 encoder
32 .Sh SYNOPSIS
33 .Nm mpeg_musicout
34 queries for all arguments, or
35 .br
36 .Nm mpeg_musicout
37 .Op Fl A
38 .br
39 .Op Fl s Ar sb
40 .br
41 inputBS
42 .br
43 .Op Ar outPCM
44 .br
45 .Sh DESCRIPTION
46 The encoder and decoder software are configured to output
47 the coded audio bitstreams as a string of hexadecimal ascii
48 characters. For greater compression efficiency, compile flag,
49 BS_FORMAT, in common.h can be switched to configure the bitstream 
50 reading and writing routines to process raw binary bitstreams.
51 .br
52 The decoder program has a very crude implementation of bitstream
53 synchword detection. It may not be able to correctly decode valid
54 bitstreams which have false synchword patterns in the ancillary data
55 portion of the bitstream.
56 .Sh RESTRICTIONS
57 The software implements levels I and II and psychophysical auditory
58 models I and II as described in the ISO 3-11171 rev 1 standard.
59 There are future plans to implement level III.
60 .br
61 The input/output audio data may either be headerless raw 16 bit data
62 or alternatively an AIFF formatted file (Audio Interchange File Format)
63 with certain limitations.
64 .br 
65 For more information on the AIFF format see the postscript file
66 /sgi/aiff-c.9.26.91.ps at the anonymous ftp site FTP.SGI.COM
67 (192.48.153.1).
68 .br
69 The AIFF formatted file is a convenient way for storing sampling rate
70 of the audio file.
71 .br
72 The encoder and decoder software are configured to output the coded
73 audio bitstreams as a string of hexadecimal ascii characters.
74 For greater compression efficiency, compile flag, BS_FORMAT, 
75 in common.h can be switched to configure the bitstream reading 
76 and writing routines to process raw binary bitstreams.
77 .br
78 This software has been run and verified on a large variety of
79 computers and operating systems. In particular UNIX, MS_DOS (with
80 MicroSoft C version 6), Macintosh, AIX Platform (RS6000) and Convex.
81 .Sh OPTIONS
82 .Bl -tag -width Ds
83 .It Sy -A
84 write an AIFF output PCM sound file
85 .It Sy -s sb
86 resynth only up to this sb (debugging only)
87 .It Sy inputBS
88 input bit stream of encoded audio
89 .It Sy outPCM
90 output PCM sound file (dflt inName+.dec)
91 .Sh SEE ALSO
92 .Xr mpeg_musicin 1
93 .Sh HISTORY
94 Written by Andreas Klemm, August 17, 1997