home *** CD-ROM | disk | FTP | other *** search
/ Groovy Bytes: Behind the Moon / groovybytes.iso / GROOVY / SND_TOOL / WM10.ZIP / DOC.DAT / waview.txt < prev    next >
Encoding:
Text File  |  1995-08-30  |  16.9 KB  |  357 lines

  1.  WM WAView            Distance lends enhancement to the view. - Thomas Campbell
  2.  ─────────
  3.  
  4.  WM WAView displays WAV files graphically. Roughly speaking, it does for WAVs
  5.  what WM Read does for TXTs. The graphics mode employed is EGA high resolution
  6.  (VGA medium resolution), i.e. 640x350 pixels, 16 colors. You need at least an
  7.  EGA card to run WM WAView.
  8.  
  9.  This Help file can be called up from within WM WAView by pressing Alt-H or by
  10.  choosing the Help command from the bottom bar {WAView 83}.
  11.  
  12.  
  13.  Contents:   ■ Startup                            {WAView  33}
  14.  ─────────     ■ Aborting Startup                 {WAView  44}
  15.              ■ Toggling units                     {WAView  72}
  16.              ■ The bottom bar                     {WAView  83}
  17.              ■ PRGed.INI (Write & Play commands)  {WAView  90}
  18.              ■ WM WAView display                  {WAView 107}
  19.              ■ Scrolling                          {WAView 131}
  20.              ■ Jumping                            {WAView 147}
  21.              ■ Vertical zoom                      {WAView 162}
  22.              ■ Marking a range                    {WAView 169}
  23.              ■ Horizontal zoom                    {WAView 198}
  24.              ■ Write command                      {WAView 212}
  25.              ■ Play command                       {WAView 231}
  26.              ■ Function key operations            {WAView 241}
  27.                ■ Inheritance                      {WAView 249}
  28.                ■ Viewing assignments              {WAView 292}
  29.                ■ Assigning values                 {WAView 328}
  30.                ■ Assignment export                {WAView 345}
  31.  
  32.  
  33. ─── Startup ────────────────────────────────────────────────────────────────────
  34.  
  35.  Like WM Read, WM WAView expects to be called with a filename argument. The 
  36.  file must conform to the WAV format, subject to the usual restrictions common 
  37.  to all WAVmaker applications supporting WAVs {WMWAV}. The file extension may 
  38.  be anything you like; if none is specified, the default WAV is assumed.
  39.  
  40.  When viewing large sample files, it may be a good idea to limit the initial 
  41.  display range, since displaying large files in their entirety takes time and 
  42.  results in poor resolution.
  43.  
  44.  Tip: If you launch WAView with a large file, only to find yourself waiting for
  45.  ──── an initial display at a scale too large to be of any use, hit Esc or the
  46.       Right mouse button. This will abort execution immediately and return you
  47.       to the caller.
  48.  
  49.  You can set the initial display range either in samples or in milliseconds, 
  50.  using the following options:
  51.  
  52.                       ■ /ss <sample number> (set Start Sample)
  53.                       ■ /es <sample number> (set End Sample)
  54.                       ■ /st <milliseconds>  (set Start Time)
  55.                       ■ /et <milliseconds>  (set End Time)
  56.  
  57.  The first sample is numbered 0; the time origin is 0 milliseconds. The default
  58.  start sample/time is 0. Thus, "WAView Piano1 /et 100" will cause the first 100
  59.  milliseconds of the file Piano1.WAV (residing in the Temp\ subdirectory) to be
  60.  displayed. "WAView Piano1 /es 100" will display the first 100 samples. If the
  61.  file is shorter than the value given with /es or /et, it will be displayed in
  62.  its entirety.
  63.  
  64.  Note: Throughout WAVmaker, the term "samples" refers to the quantity normally
  65.        meant when talking about "sampling rate". "100 samples" stands for "100 
  66.        words of whichever length you are using - 8 or 16 bits - for each sound 
  67.        channel (of which there may be one or two, for mono or stereo, 
  68.        respectively)". The relationship between sample number and time is
  69.        therefore not dependent upon word length or number of sound channels.    
  70.  
  71.  
  72. ─── Toggling units (Alt-U) ─────────────────────────────────────────────────────
  73.  
  74.  If the last view window option on the command line is /ss or /es, WM WAView 
  75.  will use sample numbers to display positions; if not, it will use 
  76.  milliseconds. You can change this choice by means of the Unit command; press
  77.  Alt-U or select Unit from the bottom bar.
  78.  
  79.  IMPORTANT: The time unit used at startup affects the way Function key values
  80.  ────────── are inherited from the calling prgram! See {WAView 249}.
  81.  
  82.  
  83. ─── The bottom bar ─────────────────────────────────────────────────────────────
  84.  
  85.  Use the mouse to pull down the crosshair all the way to the bottom bar: an 
  86.  arrow-shaped cursor will become visible. Point the cursor at the command you 
  87.  wish to execute and hit Enter or press the Left mouse button; et voilà!
  88.  
  89.  
  90. ─── PRGed.INI ──────────────────────────────────────────────────────────────────
  91.  
  92.  WAView uses WM PRGed's initialization file PRGed.INI (residing in WAVmaker's
  93.  Temp\ subdirectory) to determine which name to use for the temporary file 
  94.  created with the Write command (see {WAView 212}). This file can be played 
  95.  back using the Play command {WAView 231}, which calls the external player 
  96.  also specified in PRGed.INI.
  97.  
  98.  The use of PRGed.INI ensures consistency when calling WM View from within WM
  99.  PRGed (unless you change PRGed's temporary file and/or external player and do
  100.  not use the Keep command to update PRGed.INI before calling WM View) {PRGed}.
  101.  
  102.  If PRGed.INI is not found, WM WAView will use the same defaults as WM PRGed:
  103.  it will use Temp\Temp.WAV as its temporary file and call WAVplay.BAT to play 
  104.  it back.
  105.  
  106.  
  107. ─── WM WAView display ──────────────────────────────────────────────────────────
  108.  
  109.  While the display should be fairly self-explanatory, especially if you already
  110.  know how to use WM Read and WM Help, a couple of explanatory remarks may be in
  111.  place.
  112.  
  113.  The kind of file being displayed can be read off the cyan (left) portion of
  114.  the bottom bar. First comes the name of the file, then a character which may
  115.  be either "M" (for Mono) or "S" (for Stereo). Next comes the word size (8 or
  116.  16 bits) and last the sampling rate: "11k" for 11025 Hz, "22k" for 22050 Hz,
  117.  "44k" for 44100 Hz.
  118.  
  119.  Unlike other programs, WM WAView displays both sound channels in stereo files
  120.  on the same time axis, making it easier to see relationships between the two.
  121.  The Left channel is written first, in red; the Right channel is written 
  122.  over it, in blue. If you can see only one (blue) pixel at a given horizontal
  123.  coordinate, it's because the corresponding red pixel has been overwritten,
  124.  meaning that the contents of the two channels are equal (to the current 
  125.  resolution limits) at that point.
  126.  
  127.  You may memorize the color coding for Left and Right by noting that it is
  128.  politically correct. :-)
  129.  
  130.  
  131. ─── Scrolling ──────────────────────────────────────────────────────────────────
  132.  
  133.  In order to move around in the WAV file beying displayed, you can use the 
  134.  following keys:
  135.  
  136.                    ■ Left  arrow  (scroll back half a screen)
  137.                    ■ Right arrow  (scroll forward half a screen)
  138.                    ■ PgUp  key    (scroll back a full screen)
  139.                    ■ PgDn  key    (scroll forward a full screen)
  140.                    ■ Home  key    (show first screen)
  141.                    ■ End   key    (show last screen)
  142.  
  143.  Left/Right arrow and PgUp/PgDn are also available from the red portion of the
  144.  bottom bar {WAView 83}.
  145.  
  146.  
  147. ─── Jumping (Alt-G) ────────────────────────────────────────────────────────────
  148.  
  149.  For large moves, you may want to use the Goto command. It can be executed 
  150.  either from the bottom bar {WAView 83} or by hitting Alt-G. You will then be
  151.  prompted for the new position. Type it in using standard line editing commands 
  152.  (Left/Right arrow, Ins, Backspace and Del). You can abort by hitting Esc or by 
  153.  pressing the Right mouse button. If you terminate by hitting Enter or by 
  154.  pressing the Left mouse button, WAView will try to center the view window on 
  155.  the specified location, maintaining the current resolution. Note that the
  156.  crosshair is NOT moved to the new position.
  157.  
  158.  Hitting a Function key (F1 through F10) while entering the new position will
  159.  cause the value of the Function key to be written to the edit line.
  160.  
  161.  
  162. ─── Vertical zoom ──────────────────────────────────────────────────────────────
  163.  
  164.  Pressing Shift-Up arrow will incrase vertical resolution by a factor 2. You 
  165.  can do this up to 7 times (for a total factor of 128). Step back a factor 2 
  166.  by pressing Shift-Down arrow.
  167.  
  168.  
  169. ─── Marking a range ────────────────────────────────────────────────────────────
  170.  
  171.  This is useful for horizontal zooming {WAView 198} and for writing to the 
  172.  temporary file {WAView 212}. It works just like in WM Read. Use the following 
  173.  procedure:
  174.  
  175.      (0) Hit the - (Minus) key a couple of times (a preparatory action
  176.          to remove any previously set markers).
  177.  
  178.      (1) Position the crosshair at the beginning of the block you wish 
  179.          to mark.
  180.  
  181.      (2) Hit the + (Plus) key. This sets the start marker (you won't 
  182.          see anything happening on the screen at this time).
  183.      
  184.      (3) Position the crosshair at the end (last character) of the 
  185.          block you wish to mark.
  186.  
  187.      (4) Hit the + (Plus) key again. This sets the end marker. The 
  188.         (visible portion of the) selected range should now be 
  189.         highlighted (cyan background).
  190.  
  191.  You won't get a selected range if you set the end marker to a position
  192.  preceding that of the start marker! If you want to change your marker 
  193.  assignments, use the - (Minus) key. This key removes the end mark first 
  194.  (if it's set), so you can hit it just once to remove the end marker but not
  195.  the start marker, or twice to remove both markers and start all over again.
  196.  
  197.  
  198. ─── Horizontal zoom ────────────────────────────────────────────────────────────
  199.  
  200.  There are two ways to change the horizontal (time) resolution. 
  201.  
  202.    When there is no marked range {WAView 169}, hitting the Up arrow key will 
  203.    reduce the displayed range to half (until a further reduction would put less 
  204.    than two samples in the view window); hitting the Down arrow key will double 
  205.    it (until the whole file is in the view window).
  206.  
  207.    When there is a marked range (not necessarily on screen), hitting the Up 
  208.    arrow key will make it fill up the view window exactly. The range is 
  209.    unselected (start and end markers are removed) automatically.
  210.  
  211.  
  212. ─── Write command (Alt-W) ──────────────────────────────────────────────────────
  213.  
  214.  Issuing the Write command (press Alt-W or select it from the bottom bar 
  215.  {WAView 83}) can have one of two effects:
  216.  
  217.    If there is no marked range {WAView 169}, WM WAView will notify you of this 
  218.    and ask whether you wish to write the current view window range to the 
  219.    temporary file.
  220.  
  221.    If there is a marked range, WM WAView will write its contents to the 
  222.    temporary file.
  223.    
  224.  If the temporary file already exists, you will be asked for permission to
  225.  overwrite it.
  226.  
  227.  The name of the temporary file is determined at startup by reading PRGed.INI
  228.  {WAView 90}.
  229.  
  230.  
  231. ─── Play command (Alt-P) ───────────────────────────────────────────────────────
  232.  
  233.  Issuing the Play command (press Alt-P or select it from the bottom bar 
  234.  {WAView 83}) causes WM WAView to launch the external player, with the 
  235.  temporary file used by Write {WAVwrite 212} as its argument. 
  236.  
  237.  The names of external player and temporary file are determined at startup by 
  238.  reading PRGed.INI {WAView 90}.
  239.  
  240.  
  241. ─── Function key operations ────────────────────────────────────────────────────
  242.  
  243.  While in WM WAView, you have ten programmable Function keys (F1 to F10) at 
  244.  your disposal. Each one is assigned a title and a value. Titles and values 
  245.  can be up to 15 characters long (reflecting the size of the default DOS 
  246.  keyboard buffer).
  247.  
  248.  
  249.  Inheritance
  250.  ───────────
  251.  
  252.  At startup, WM WAView scans WAVmaker's public Function key file for Function 
  253.  key titles matching those in its internal table. All matching titles cause 
  254.  the associated values to be inherited {FnKeys}.
  255.  
  256.  There is an interesting quirk to this process. The Function key titles used 
  257.  by WM WAView depend on the current time unit (samples or milliseconds), 
  258.  according to the following tables:
  259.  
  260.                 ┌─────┬──────────────┐   ┌─────┬──────────────┐ 
  261.                 │ Key │ Title        │   │ Key │ Title        │
  262.                 ├─────┼──────────────┤   ├─────┼──────────────┤
  263.                 │ F 1 │ Auxiliary #1 │   │ F 1 │ Sample #1    │
  264.                 │ F 2 │ Auxiliary #2 │   │ F 2 │ Sample #2    │
  265.                 │ F 3 │ Start time   │   │ F 3 │ Sample #3    │  
  266.                 │ F 4 │ End time     │   │ F 4 │ Sample #4    │ 
  267.                 │ F 5 │ Parameter #1 │   │ F 5 │ Sample #5    │ 
  268.                 │ F 6 │ Parameter #2 │   │ F 6 │ Sample #6    │ 
  269.                 │ F 7 │ Parameter #3 │   │ F 7 │ Auxiliary #1 │ 
  270.                 │ F 8 │ Parameter #4 │   │ F 8 │ Auxiliary #2 │ 
  271.                 │ F 9 │ Parameter #5 │   │ F 9 │ Auxiliary #3 │
  272.                 │ F10 │ Parameter #6 │   │ F10 │ Auxiliary #4 │ 
  273.                 ├─────┴──────────────┤   ├─────┴──────────────┤
  274.                 │ Unit: milliseconds │   │ Unit: samples      │ 
  275.                 └────────────────────┘   └────────────────────┘ 
  276.  
  277.  These choices reflect the Function key assignments used in WAVmaker's DSP 
  278.  menus and in WM PRGed, respectively (all of WAVmaker's DSP operations are 
  279.  performed using milliseconds, as is customary; WM PRGed on the other hand 
  280.  uses sample numbers for maximal control over envelope and loop points).
  281.  
  282.  IMPORTANT: Since the time unit used at startup is determined by the last view 
  283.  ────────── window command line option {WAView 72}, it is important to let the 
  284.             command line end the right way! WM PRGed makes sure that WM WAView 
  285.             starts up in sample mode (rather than in the default millisecond 
  286.             mode) by calling it with a command line ending with the /es option.
  287.  
  288.  If F3 and F4 are not assigned to by the public Function key file, they are 
  289.  initially given the /st/et & ss/es values specified or implied at startup.
  290.  
  291.  
  292.  Viewing assignments
  293.  ───────────────────
  294.  
  295.  To bring up the Function key window showing all current assignments, press 
  296.  Alt and a Function key between F1 and F10. Do not be surprised if some titles
  297.  appear within parentheses! Since you can toggle time unit at any time, WM 
  298.  WAView does not know which title to associate with a value until the actual 
  299.  assignment is made. Titles within parentheses are what would be used with the
  300.  current time unit. Once an assignment is made, the title is frozen (till the 
  301.  next assignment to the same key) and can be shown without any ambiguity.
  302.  
  303.  To make the Function key window go away, either
  304.  
  305.                 ■ press Alt and F1-F10 again, or
  306.                 ■ hit the Esc key, or
  307.                 ■ click the Right mouse button, or
  308.                 ■ scroll or jump to a new location.
  309.   
  310.  You can also view the contents of a single Function key by hitting it at any
  311.  time (almost - see exceptions below). If the key has been assigned a value,
  312.  title and value will be written to the screen's upper right corner; if not,
  313.  you will get an "unassigned" message in the same position. The text will 
  314.  disappear the next time you execute a jump or a scroll command, toggle time
  315.  unit, or hit another Function key. 
  316.  
  317.  Now for the two exceptions: 
  318.  
  319.     ■ Hitting a Function key when entering a new position with the Goto
  320.       command causes the current value of the Function key to be written 
  321.       to the edit line. 
  322.     
  323.     ■ Hitting a Function key while a position is selected assigns the 
  324.       selected position to the Function key value and causes the NEW 
  325.       value to be displayed in the screen's upper right corner (see below).
  326.  
  327.  
  328.  Assigning values
  329.  ────────────────
  330.  
  331.  The only values you can assign to keys in WM WAView are positions, either in
  332.  milliseconds or in samples.
  333.  
  334.  A position is selected by placing the crosshair and clicking the Left mouse 
  335.  button or hitting Enter. This causes the position string in the screen's upper 
  336.  left corner to be highlighted (light cyan on blue background), and the 
  337.  crosshair to be locked at its current position. Clicking the Left mouse button
  338.  or hitting Enter again undoes the selection.
  339.  
  340.  Hitting a key between F1 and F10 while a selection is active will assign that 
  341.  position to the Function key, and display the title and value assignment in
  342.  the screen's upper right corner (and in the Function key window if open).
  343.  
  344.  
  345.  Assignment export
  346.  ─────────────────
  347.  
  348.  All Function key assignments are exported to WAVmaker's public Function key 
  349.  file {FnKeys} upon termination. The filename is exported with title "File #1",
  350.  stripped of the directory path.
  351.  
  352.  Note: The main purpose of Function keys in WM WAView is to allow you to 
  353.  ───── export position values to the caller. When doing so, keep in mind that 
  354.        the Function keys entitled "Auxiliary" have no match in the DSP menus 
  355.        or in WM PRGed. Also, remember to store positions in the unit expected 
  356.        by the caller!
  357.