Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / miscellany / multi-media / READ-ME
1 $Id: READ-ME,v 1.3 1992/10/26 16:57:51 jromine Exp $
2
3 [ READ-ME - Wed Sep  1 19:07:25 1993 - multi-media MH - /mtr ]
4
5
6                                    NOTICE
7
8      This package is openly available but is NOT in the public domain.
9      You are allowed and encouraged to take this software and use it for
10      any lawful purpose.  However, as a condition of use, you are required
11      to "hold harmless" all contributors.
12
13      Permission to use, copy, modify, and distribute this software and
14      its documentation for any purpose and without fee is hereby
15      granted, provided that this notice be retained unaltered,  and that
16      the name of any contributors shall not be used in advertising or
17      publicity pertaining to distribution of the software without
18      specific written prior permission.   No contributor makes any
19      representations about the suitability of this software for any
20      purpose.  It is provided "as is" without express or implied
21      warranty.
22
23         ALL CONTRIBUTORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
24         SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
25         AND FITNESS FOR THE PARTICULAR PURPOSE, TITLE, AND
26         NON-INFRINGEMENT.
27
28         IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE FOR ANY SPECIAL,
29         INDIRECT OR CONSEQUENTIAL DAMAGES, WHETHER IN CONTRACT, TORT, OR
30         OTHER TORTUOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH, THE
31         USE OR PERFORMANCE OF THIS SOFTWARE.
32
33
34      Following are sources of software for manipulating various MIME content
35      types.  The script support/general/bootmhn.sh (which is run when
36      you do "make inst-all") will look for these programs and create the
37      global mhn_defaults file accordingly.  Since this script will
38      look for the programs detailed below, you should do all of the
39      installation here prior to running "make inst-all".  Also, the
40      programs should be installed in either the MH library area
41      (e.g., /usr/local/lib/mh/) or in your $PATH.
42
43
44                                 text/richtext
45
46      There are two programs for rendering text/richtext, rt2raw and
47      richtext. 
48
49      1. r2raw - a really dumb richtext interpreter
50
51      This is found in the MH distribution:
52
53         % cd miscellany/multi-media/misc/
54         % cc -o rt2raw rt2raw.c
55
56      and then copy rt2raw to your MH library area.
57
58
59      2. richtext - a termcap-based interpreter
60
61      This is found in the MetaMail distribution:    
62
63         host    thumper.bellcore.com
64         dir     pub/nsb/
65         file    mm.tar.Z
66         mode    binary
67
68      Now run these commands
69
70         % mkdir mm
71         % cd mm
72         % uncompress < ../mm.tar.Z | tar xvpf -
73         % cd richmail
74         % make richtext
75
76      and then copy richtext to your MH library area.
77
78
79                                     image
80
81      There are several programs available for rending images: xv, pbmplus,
82      and jpeg.  To use any of these, you need to be running under the
83      X window system.  When bootmhn.sh runs, it will generate commands
84      for a monochrome monitor.  If you're running on a greyscale or
85      color monitor, you should change the commands accordingly.
86
87      1. xv version 2.11
88
89      There may be a more recent version by the time you read this file:
90
91         host    ftp.cis.upenn.edu
92         dir     pub/
93         file    xv-2.11.tar.Z
94         mode    binary
95
96      Read the installation instructions and install the xv binary
97      somewhere in your $PATH.
98
99      2. pbmplus
100
101      There may be a more recent version by the time you read this file:
102
103         host    ftp.uu.net
104         dir     pub/window-sys/X/contrib
105         file    pbmplus10dec91.tar.Z
106         mode    binary
107
108      3. JPEG
109
110      There may be a more recent version by the time you read this file:
111
112         host    ftp.uu.net
113         dir     graphics/jpeg/
114         file    jpegsrc.v3.tar.Z
115         mode    binary
116
117      Read the installation instructions and install the djpeg binary
118      somewhere in your $PATH.
119
120
121                                     audio
122
123      This is platform dependent.  At present, only detailed information
124      for the SPARC and the HP 9000/710 is presented.
125
126      1. SPARC
127
128      The SPARC has a telephone-quality audio-chip and an internal
129      speaker.  If you want to record audio, you'll need to buy a
130      microphone.  For reasons not worth going into, most mic's don't
131      have enough gain, and you have to put the thing right next to your
132      lips.  However, Isaac Salzman of SMI suggests, and I concur, that
133      the best mic to get is SONY's ECM-K7.  This costs about US$50, but
134      is well worth it: you can put the mic on your desk and it will
135      still pick up your voice.
136
137      The "native" encoding for the audio-chip is 8-bit u-law sampled at
138      8000/second .  Prior to SunOS 4.1, audio files contained simply the
139      encoded audio.  However, in SunOS 4.1 or later, SMI introduced a
140      file format containing a header followed by the encoded audio.  For
141      now, we'll use the content type audio/basic to refer to the raw
142      audio, and the content type audio/x-next to refer to the file
143      format (NeXT developed the file format and SMI supports a subset of
144      it).  When dealing audio/basic, you simply cat to/from /dev/audio.
145      When dealing with audio/x-next, you can use the play and record
146      programs found in the /usr/demo/SOUND/ directory.
147
148      In addition, in OpenWindows 3.0 or later, SMI added support for a
149      compressed u-law encoding based on the CCITT G.721 ADPCM algorithm.
150      Before audio encoded in this fashion can be heard, it must be
151      converted back to 8-bit u-law.  Conversions to and from the two
152      encodings can be done with the adpcm_enc and adpcm_dec programs
153      found in the $OPENWINHOME/bin/xview/ directory.
154
155      If you are running something earlier than SunOS 4.1, I suggest that
156      you immediately get a copy of the raw2audio, play, and record
157      programs, so you can generate audio files.  The source is avilable
158      in the SunOS 4.1 Demos installation.  If you can't find these
159      programs, then when bootmhn.sh runs, it will just cat directly
160      to/from /dev/audio.
161
162      If you do have the raw2audio, play, and record programs (regardless
163      of the version of SunOS you're running), then apply some patches:
164
165         % (cd /usr/demo/SOUND; patch) < miscellany/multi-media/SPARC/SOUND.diff
166         % cd /usr/demo/SOUND
167         % make raw2audio
168
169      Be sure to put /usr/demo/SOUND in your $PATH so that bootmhn.sh can
170      find the programs there.  (Alternately, you could copy these
171      programs to another directory which is in your $PATH.)
172
173      You might also consider running /usr/demo/SOUND/x_gaintool, so you
174      can fiddle with the volume controls whenever you like.
175
176      2. HP 9000/710
177
178      The HP-Apollo 9000/710 workstation has a telephone-quality audio
179      chip and an internal speaker.  If you want to record audio, you'll
180      need to buy a microphone.  As with the SPARC, just about any
181      microphone with a standard mini jack will do.  Comments in the
182      preceding section that apply to selections of a microphone for the
183      SPARC probably also apply here. 
184
185      The audio programs that may be used with mhn -- player, splayer,
186      recorder, and srecorder -- are provided by HP in source form in the
187      directory /usr/audio/examples/.  The README file in that directory
188      documents the various audio utility programs for recording and
189      playing sounds.  Be sure to put /usr/audio/examples in your $PATH
190      so that bootmhn.sh can find the programs there.  (Alternately, you
191      could copy these programs to another directory which is in your
192      $PATH.)
193
194      Before any of the aforementioned programs can be used, the audio
195      device files must be created by running
196      /usr/audio/bin/make_audio_dev, and two daemons must be started:
197      /usr/etc/ncs/llbd and /usr/audio/bin/Aserver.  Refer to Audio(5)
198      for detailed, step by step instructions on how to do these things.
199      Alternatively, refer to the HP publication "Audio Users Guide"
200      (HP order number A1991-90609, November 1991 version).
201
202      The audio devices support several "native" encodings that vary as
203      to which of the audio device files is used: one of
204      /dev/audio[BEI][ALU], where E=external jack, I=internal speaker,
205      B=both; A=8-bit ALaw, L=16-bit linear, U=8-bit MuLaw.  It is
206      possible to "cat" a raw audio data file of the appropriate type to
207      or from one of these devices. For example, a SPARC .au file may be
208      played by running this command:
209
210         cat bark.au >/dev/audioIU
211
212      (You must create the audio device files before you can cat anything
213      to them; again, refer to Audio(5) for information on how to do this.)
214
215      There is, as of HP-UX 8.07, no supplied tool a la the SPARC's raw2audio
216      to add headers to audio data files that describe the audio data
217      encodings.  Rather than looking for headers in the sound data, the
218      audio tools rely on user-supplied information, such as file
219      extensions or command line options, to inform the tools about the
220      types and sampling rates of the audio data.
221
222      Audio file names have the form 
223
224         <file name>[["."<sample rate>]"."<type>]
225
226     where
227
228         <sample rate> ::= 1#DIGIT"000"/ 1#DIGIT"k"
229         <type> ::= "u" / "al" / "au" / "wav" / "snd" / "l8" / 
230                         "lo8" / "l16"
231
232         Mulaw                           u
233         Alaw                            al
234         Sun                             au
235         Microsoft RIFF Waveform         wav
236         Macintosh                       snd
237         Linear8                         l8
238         Linear8Offset                   lo8
239         Linear16                        l16
240
241     Examples: 
242
243         bark.au
244         bark.8000.au
245         bark.8k.au
246
247      As with the SPARC, the default sample rate is 8000 Hz.
248
249      The /usr/audio/bin/audio_demo program may be used to convert
250      manually among different sound types, as well as to play, to
251      record, and to edit the sounds.  Unfortunately, the audio_demo
252      program does not accept command line arguments, so it is not quite
253      as suitable for invocation from mhn as are the player and recorder
254      programs.
255
256      You might also consider running /usr/audio/examples/acontrol, so you
257      can fiddle with the volume controls whenever you like.