Fixup fromcvs/togit conversion
[minix-pkgsrc.git] / audio / mpegaudio / files / mpeg_musicin.1
blob70e00d405ad07d4707d74090181e4b4b3186a4db
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_musicin.1,v 1.2 1999/08/29 10:56:51 peter Exp $
26 .Dd August 17, 1997
27 .Dt MPEG_MUSICIN 1
28 .Os
29 .Sh NAME
30 .Nm mpeg_musicin
31 .Nd MPEG/audio Layer 1 and Layer 2 decoder
32 .Sh SYNOPSIS
33 .Nm mpeg_musicin
34 queries for all arguments, or
35 .br
36 .Nm mpeg_musicin
37 .Op Fl l Ar lay
38 .br
39 .Op Fl m Ar mode
40 .br
41 .Op Fl p Ar psy
42 .br
43 .Op Fl s Ar sfrq
44 .br
45 .Op Fl b Ar br
46 .br
47 .Op Fl d Ar emp
48 .br
49 .Op Fl c
50 .br
51 .Op Fl o
52 .br
53 .Op Fl e
54 .br
55 inputCM
56 .br
57 .Op Ar outBS
58 .br
59 .Sh DESCRIPTION
60 The encoder and decoder software are configured to output
61 the coded audio bitstreams as a string of hexadecimal ascii
62 characters. For greater compression efficiency, compile flag,
63 BS_FORMAT, in common.h can be switched to configure the bitstream 
64 reading and writing routines to process raw binary bitstreams.
65 .br
66 The decoder program has a very crude implementation of bitstream
67 synchword detection. It may not be able to correctly decode valid
68 bitstreams which have false synchword patterns in the ancillary data
69 portion of the bitstream.
70 .Sh RESTRICTIONS
71 The software implements levels I and II and psychophysical auditory
72 models I and II as described in the ISO 3-11171 rev 1 standard.
73 There are future plans to implement level III.
74 .br
75 The input/output audio data may either be headerless raw 16 bit data
76 or alternatively an AIFF formatted file (Audio Interchange File Format)
77 with certain limitations.
78 .br 
79 For more information on the AIFF format see the postscript file
80 /sgi/aiff-c.9.26.91.ps at the anonymous ftp site FTP.SGI.COM
81 (192.48.153.1).
82 .br
83 The AIFF formatted file is a convenient way for storing sampling rate
84 of the audio file.
85 .br
86 The encoder and decoder software are configured to output the coded
87 audio bitstreams as a string of hexadecimal ascii characters.
88 For greater compression efficiency, compile flag, BS_FORMAT, 
89 in common.h can be switched to configure the bitstream reading 
90 and writing routines to process raw binary bitstreams.
91 .br
92 This software has been run and verified on a large variety of
93 computers and operating systems. In particular UNIX, MS_DOS (with
94 MicroSoft C version 6), Macintosh, AIX Platform (RS6000) and Convex.
95 .Sh OPTIONS
96 .Bl -tag -width Ds
97 .It Sy -l lay
98 use layer <lay> coding (default: 2)
99 .It Sy -m mode
100 channel mode : s/d/j/m (default: s)
101 .It Sy -p psy
102 psychoacoustic model 1/2 (default: 2)
103 .It Sy -s sfrq
104 input smpl rate in kHz (default: 44.1)
105 .It Sy -b br
106 total bitrate in kbps (default: 384)
107 .It Sy -d emp
108 de-emphasis n/5/c (default: n)
109 .It Sy -c
110 mark as copyright
111 .It Sy -o
112 mark as original
113 .It Sy -e
114 add error protection
115 .It Sy inputPCM
116 input PCM sound file (standard or AIFF)
117 .It Sy outBS
118 output bit stream of encoded audio (dflt inName+.mpg)
119 .Sh SEE ALSO
120 .Xr mpeg_musicout 1
121 .Sh HISTORY
122 Written by Andreas Klemm, August 17, 1997