@DATABASE SampleE.guide
@$VER: SampleE.guide 3.20 (14.03.1999)
@AUTHOR Rainer Müller

@node main "SampleE Dokumentation - contents"

			  SampleE V3.20  14.03.1999

		     A Sample-Editor written in Amiga-E
		   Copyright © 1996-1999 by Rainer Müller
			    All rights reserved


   @{" Introduction     " link Introduction}
   @{" Requirements     " link Requirements}
   @{" Installation     " link Installation}

   @{" Usage            " link Usage}

   @{" Configuration    " link PreferencesWindow}

   @{" Bugs             " link Bugs}
   @{" Internals        " link Internals}
   @{" Future Plans     " link FuturePlans}

   @{" Acknowledgements " link Acknowledgments}
   @{" Disclaimer       " link Disclaimer}
   @{" Copyright        " link Copyright}

   @{" Author           " link Author}

@endnode


#########################################################################
#									#
#  Introduction 							#
#									#
#########################################################################
@node Introduction "SampleE - Introduction"

@{B}@{U}Introduction@{UB}@{UU}

  SampleE is a sampleeditor, which most of the standard funktions like e.g.
  copy and insert cuttings, echo-effekt.
  Samples are edited with 16 bit resolution and in mono/stereo, this means of
  course more quality.

  Depending on the @{"graphic-mode" link recommendedscreenmodes} the maximum replay rate may be up to 57.6 kHz.
  The playback is done useing the @{"amiga-soundchip" link paula} in 8 bit.
  SampleE supports AHI. So it is possible to replay sounds with a soundcard.
  Depending on the soundcard samples are played with up to 16 bit and 48 kHz.
  For details read the documentation of @{"AHI" link ahi} !

  For loading and saveing SampleE supports in the moment the 8SVX, 16SV, AIFF
  and WAVE format. With the @{"multiio-function" link load} SampleE should be able to load
  a lot of other formats.

@endnode



#########################################################################
#									#
#  Requirements 							#
#									#
#########################################################################
@node Requirements "SampleE - Requirements"

@{B}@{U}Requirements@{UB}@{UU}

  In order to use SampleE, you need an Amiga with 512 KByte and at least
  Kickstart 3.0. But with 512 KB you only can edit very short samples
  Fast-Memory is highly recommended. If only Chip-Memory is available, the
  maximum replay-rate may be limited to quite small values.

  @{"AHI" link ahi} is recommended even without soundcard, because the AHI @{"paula" link paula}-driver
  allows output with 14 bit !

@endnode



#########################################################################
#									#
#  Installation 							#
#									#
#########################################################################
@node Installation "Sample - Installation"

@{B}@{U}Installation@{UB}@{UU}

  The best and easysiet way is to use the installation-script.


  Deinstallation:
     Is it really neccessary to delete this nice program ??
     Well, it is not difficult: just delete the SampleE drawer and if it
     exists delete ENVARC:SampleE.prefs.


  little note:
     Now SampleE has several external file which all are placed in the SampleE
     drawer, because of that the language-catalogs are always placed in the
     SampleE drawer too. If in an earlier installation the catalogs were
     placed in the system-drawer LOCALE: then you may and should delete these
     ones.

@endnode


#########################################################################
#									#
#  Bugs 								#
#									#
#########################################################################
@node Bugs "SampleE - Bugs"

@{B}@{U}Bugs@{UB}@{UU}

  I don't know any bugs, except the ones I found out myself. But it is
  possible, that there are bugs in the program, I haven't found yet.

  If an error occurs, please tell me, in order to remove it. Please describe
  the circumstances when the error occured. If there is a GURU, then tell
  me the number.

  My adress @{"Autor" link Author}

  On my computer SampleE didn't cause Enforcer Hits !

@endnode



#########################################################################
#									#
#  Internals								#
#									#
#########################################################################
@node Internals "SampleE - Internals"

@{B}@{U}Internals@{UB}@{UU}

  The programm is written 100% in Amiga-E.
  (Amiga-E Copyright © Wouter van Oortmerssen)

  The maximum samplelength is only limited by the available memory. Samples may
  be loaded into fast-memory. Fast-memory is highly recommended.

  SampleE edits samples with 16 bit. The @{"Amiga audio-hardware" link paula} works with  only
  8 bit. That means that while replaying, the data has to be reduced to 8 bit.
  This is time intensive, so fast memory is a good thing. Even better is. if
  @{"AHI" link ahi} is used. AHI works faster and supports soundcards.

  With OCS (Old Chip Set) the maximum play-rate was 28800 Hz. Starting with
  ECS (Enhanced Chip Set) and AGA (Advanced Graphics Architecture), maximum
  play-rate is 57600 Hz.
  Maximum rate depends on the graphic-mode, that means from its scanrates. But
  these rates are not "clear", because they change if you use "VGAonly" or the
  monitor-files were modified, so it is difficult to say, what the maximum
  rate is.
  You can find more information under: @{"Recommended Screen-Modes" link RecommendedScreenModes}
  The values given there are a compromise of the "normal" values and the values
  with active "VGAonly".

  With AHI this is handled a bit different.

@endnode



#########################################################################
#									#
#  Future Plans 							#
#									#
#########################################################################
@node FuturePlans "SampleE - Future Plans"

@{B}@{U}Future Plans@{UB}@{UU}

    - hd-editing
    - XPK-support
    - Clipboard-support
    - "Paint"-funktion
    - famples 'loopen'
    - contextsensitive online-hilfe (how do I connect a program with Amiga
      Guide ???)
    - save several marked areas
    - datatypes ?? (how do I use datatypes ???)
    - Arexx ??? (how can I built a port into a program ???)
    ...
    ...

  I am thankful for suggestions.

  I am also thankful for documentations/informations about other sampleformaten
  like z.B. VOC, HSN, AIFF, (8SVX, WAVE)... and I will try to write load- and
  save-functions (some demo-samples for checking would be a good idea)

@endnode




#########################################################################
#									#
#  Acknowledgments							#
#									#
#########################################################################
@node Acknowledgments "SampleE - Acknowledgements"

@{B}@{U}Acknowledgements@{UB}@{UU}

  I want to thank following people: (random order)


	  Wouter van Oortmerssen - for the great Amiga-E language

 Nico Francois & Magnus Holmgren - for the ReqTools.library

	 Martin 'Leviticus' Blom - for AHI

		   Robert Müller - for common suggestions
				   for the help writing the installtion-script

       Daniel 'ThunderPig' Rädel - for the programm WatchMem

      Georges 'Melkor' Goncalves - for the motivation to keep on developing
				   for the french translation

	     Javier de las Rivas - for the spanish translation

  Commodore & Amiga Technologies - for the greatest of all computers


   all people who developed the Amiga and
     the ones who develope a PowerPC-successor, which is worthy to the Amiga

@endnode



#########################################################################
#									#
#  Disclaimer								#
#									#
#########################################################################
@node Disclaimer "SampleE - Disclaimer"

@{B}@{U}Disclaimer@{UB}@{UU}

  SampleE, except the ReqTools.library, was completely written and copyright
  by Rainer Müller. SampleE is FREEWARE. The ReqTools.library was written by
  Nico Francois and Magnus Holmgren.

  The files belonging to SampleE are not to be modified, complemented,
  shorted, etc..
  The files my be archived.

  The author is not responsible for any damage or loss of data, which might be
  caused by the usage of this program.

@endnode



#########################################################################
#									#
#  Copyright								#
#									#
#########################################################################
@node Copyright "SampleE - Copyright"

@{B}@{U}Copyright@{UB}@{UU}

  SampleE may be copied freely as long as its files are copied in their
  original condition. SampleE is FREEWARE.


  !! COMMERCIAL USAGE and COMMERZIAL DISTRIBUTION is not allowed !!


  It is not allowed to distribute the program on disks, which are sold for
  more then five (5) Deutsch Marks or equivalent in an other currency.


@endnode



#########################################################################
#									#
#  Author								#
#									#
#########################################################################
@node Author "SampleE - Author"

@{B}@{U}Author@{UB}@{UU}

  SampleE was developed and written by Rainer Müller


  My Address:

  Rainer Müller
  Lichtenbergstraße 21
  88677 Markdorf
  Deutschland (Germany)

  E-Mail: Rainer.m.Mueller@uni-konstanz.de

  The computer:
  Amiga 1200, 68030 50 MHz, 16 MB-Fast, 2 MB-Chip, 850 MB-HD, OS3.1  (Kick 40.68, WB 40.42)

  The language:
  Amiga-E © Wouter van Oortmerssen


  Please note that english is not my native language.
  So, if there are any mistakes (ok, there are many mistakes), tell me what
  is wrong and what would be right.

@endnode



#########################################################################
#									#
#  Usage								#
#									#
#########################################################################
@node Usage "SampleE - Usage"

@{B}@{U}Usage@{UB}@{UU}

   @{U}The Window Manager@{UU}

   @{"info-frames " link infowindow}
   @{"info-time   " link infowindow}
   @{"sample      " link samplewindow}
   @{"stereo      " link stereowindow}
   @{"zoom-mark   " link toolwindow}
   @{"audio       " link audiowindow}

   @{"edit        " link editwindow}
   @{"volume      " link volumewindow}
   @{"shift       " link shiftwindow}
   @{"mix         " link mixwindow}
   @{"echo        " link echowindow}
   @{"frequency   " link frequenzwindow}

   @{"project     " link projectwindow}
   @{"about       " link aboutwindow}

   @{"use         " link prefsuse}
   @{"save        " link prefssave}

   With the window-manager you can open all the other windows. A double-klick
   on the name of the wanted window opens the window. Is the window already
   open it is moved to the front. If the window is only a titelbar, it gets
   maximum size.
   All 'normal' windows are appwindows, that means: if you work on WB then
   drag an icon in a window and drop it - then SampleE will load this file.
   On the WB screen SampleE creates an appicon. Drop an icon on it and the
   file will be loaded.

   The close-gadget of the window quits SampleE.



  PS. I am not good in writing documentations, but I hope that everything is
      more or less easy to understand. If necessary, the good old "do by try"
      method will help, to understand the functions and the parameters.

  Have fun with SampleE !!

@endnode


@node prefssave "save settings"

@{B}@{U}save setting@{UB}@{UU}

  The configuration is saved to ENVARC:SampleE.prefs.

@endnode


@node prefsuse "use settings"

@{B}@{U}use settings@{UB}@{UU}

  The configuration is saved to ENV:SampleE.prefs -> after a reset the
  configuration is lost.

@endnode



#########################################################################
#									#
#  zoom-mark window							#
#									#
#########################################################################
@node toolwindow "zoom-mark window"

@{B}@{U}zoom-mark window@{UB}@{UU}

     zoom	mark
   @{"   1:1   " link zoom} @{"   all   " link mark}
   @{"   in    " link zoom} @{"  view   " link mark}
   @{"   out   " link zoom}
   @{"  mark   " link zoom} @{" unmark  " link mark}
   @{"   all   " link zoom} @{" @| l    " link sampledisplay}

@endnode

@node zoom "zoom"

@{B}@{U}zoom@{UB}@{UU}

  - '   1:1   '  shows the sample "1:1" = maximum zoom
  - '   in    '  shows a smaller part of the sample
  - '   out   '  shows a bigger part of the sample
  - '  range  '  shows the marked range
  - '   all   '  shows the whole sample

@endnode


@node mark "mark"


@{B}@{U}mark@{UB}@{UU}

  - '   all   '  the whole sample is marked
  - '  view   '  the visible part of the sample is marked
  - ' unmark  '  the marking is deleted

@endnode


@node sampledisplay "sampledisplay"

@{B}@{U}sampledisplay@{UB}@{UU}

   the sample is displayed as

   'l' - lines
   'p' - points
   's' - solid

@endnode




#########################################################################
#									#
#  edit window								#
#									#
#########################################################################
@node editwindow "edit window"

@{B}@{U}edit window@{UB}@{UU}

     buffer	edit
   @{"sample to" link cbuf} @{"   cut   " link edit}
   @{"to sample" link cbuf} @{"  copy   " link edit}
   @{"  clear  " link cbuf} @{"  paste  " link edit}
   @{"M" link buffertype}         @{"   del   " link edit}
	      @{"  clear  " link edit}
   @{" reverse " link reverse} @{" inverse " link inverse}

@endnode


@node cbuf "copy-buffer functions"

@{B}@{U}copy-buffer functions@{UB}@{UU}

  - 'sample to'  the sample will be copied into the copy-buffer
  - 'to sample'  the copy-buffer will be copied to the sample
  - '  clear  '  the copy-buffer will be deleted

@endnode


@node buffertype "buffer mono/stereo ?"

@{B}@{U}buffer mono/stereo ?@{UB}@{UU}

   A 'M' means, that the copy-buffer contains mono data.
   A 'S' means, you're right, that the copy-buffer contains stereo data.

@endnode


@node edit "edit"

@{B}@{U}edit@{UB}@{UU}

  - '   cut   '  the marked range will be copied into the copy-buffer and
		 deleted from the sample
  - '  copy   '  the marked range will be copied into the copy-buffer
  - '  paste  '  the contents of the copy-buffer will be inserted at the
		 beginning of the marking
  - '   del   '  the marked range will be deleted from the sample
  - '  clear  '  the marked range will be set to the value 0

@endnode


@node reverse "reverse"

@{B}@{U}reverse@{UB}@{UU}

  The marked range will be reversed.

@endnode


@node inverse "inverse"

@{B}@{U}inverse@{UB}@{UU}

  The sample will be turned upside down.

@endnode




#########################################################################
#									#
#  Info window								#
#									#
#########################################################################
@node infowindow "info window"

@{B}@{U}info window@{UB}@{UU}

info-frames:

 range	       start	  end	length
 visible   @{">" link InfoInput}@{"  12345" link InfoRead}@{">" link InfoInput}@{"  12345" link InfoRead}@{">" link InfoInput}@{"  12345" link InfoRead}
 marked    @{">" link InfoInput}@{"  12345" link InfoRead}@{">" link InfoInput}@{"  12345" link InfoRead}@{">" link InfoInput}@{"  12345" link InfoRead}
 sample 		  @{"M" link sampletype}@{"C" link meminfo}@{">" link InfoInput}@{"  12345" link InfoRead}


info-time:

 range	       start	   end	 length
 visible   @{"123:45:67" link InfoRead}@{"123:45:67" link InfoRead}@{"123:45:67" link InfoRead}
 marked    @{"123:45:67" link InfoRead}@{"123:45:67" link InfoRead}@{"123:45:67" link InfoRead}
 sample 		      @{"123:45:67" link InfoRead}

@endnode


@node meminfo "type of memory"

@{B}@{U}type of memory@{UB}@{UU}

  Here is the type of memory display, in which the sample is placed.

  C = Chip
  F = Fast

@endnode


@node sampletype "Sample Mono/Stereo ?"

@{B}@{U}Sample Mono/Stereo ?@{UB}@{UU}

   A 'M' means, that the sample is mono.
   A 'S' means, that the sample is stereo.

@endnode


@node InfoInput "ranges - change startpoint/endpoint/length"

@{B}@{U}ranges - change startpoint/endpoint/length@{UB}@{UU}

  Here you can enter the startpoint/endpoint/length of the visible/marked
  range, change length of the sample (in @{"frames" link frames}).

@endnode


@node InfoRead "ranges - startpoint/endpoint/length/Länge"

@{B}@{U}ranges - startpoint/endpoint/length@{UB}@{UU}

  Here is the startpoint/endpoint/length of the visible/marked range, the
  length of the sample displayed in @{"sampleframes" link frames}.

  The second window displays the startpoint/endpoint/legnth of the visible/
  marked range, the length of the sample in the format	xxx:yy:zz
  with xxx: minutes
	yy: seconds
	zz: 1/100 seconds

@endnode




#########################################################################
#									#
#  Sample Window							#
#									#
#########################################################################
@node samplewindow "sample window"

@{B}@{U}sample window@{UB}@{UU}

   In the sample window, the sample (or a part of it) is diplayed graphically.

   With the @{"zoom" link zoom} functions in the main menu you can make the
   visible bigger/smaller. With the scroll-gadget at the bottom of the sample
   window, you can scroll the visible part of the sample. The sample is
   displayed "even", that means every 2., 3., ... byte and not every 2,1. 3,6.
   byte is displayed -> it may happen, that in the right half of the window is
   empty.

   The size of the sample window is variable. The width can be adjusted at all.
   If you adjust the window to an innerheight of e.g. 180 pixel, the program
   makes the window smaller, so that the window has an innerheight of 128
   pixels. If you adjust the window to an innerheight of 127 pixel, the window
   will be sized to 64 pixels.


   Mark a range:
      Press the left mouse button in the interior of the window and keep the
      button pressed and mark the range from left to right, by moving the
      mouse. The marked range is made visible by inverted display of the
      sample. The information about position and size are displayed in the
      @{"Info Fenster" link infowindow}. You can change the marked range with the @{"mark" link mark} functions
      in the main menu.

   The display method (lines, points, solid) can be set in the @{"zoom-mark" link toolwindow} window.

@endnode



#########################################################################
#									#
#  project window							#
#									#
#########################################################################
@node projectwindow "project window"

@{B}@{U}project window@{UB}@{UU}

   +----------------------------+-+
   |				|||
   |				|||
   |				|||
   |				|^|
   |				|v|
   +----------------------------+-+
   @{"   add    " link addsamp}@{"   copy   " link copysamp}@{"  delete  " link delsamp}
   @{"   load   " link load}@{"   save   " link save}@{" new name " link newname}

@endnode


@node addsamp "add sample"

@{B}@{U}add sample@{UB}@{UU}

  At first a text-requester appears. There you type in the name of the new
  sample. Then there is a second requester. There you type in the length of the
  new sample and select wether the sample should be mono or stereo.

@endnode

@node copysamp "copy sample"

@{B}@{U}copy sample@{UB}@{UU}

  The sample is copied. It gets the name Copy_of_xxx

@endnode

@node delsamp "delete sample"

@{B}@{U}delete sample@{UB}@{UU}

  The sample is deleted.

@endnode

@node newname "new name"

@{B}@{U}new name@{UB}@{UU}

   A requester, where you type in the new name, appears.

@endnode



@node Load "Load"

@{B}@{U}Load@{UB}@{UU}

  A file-requester appears. There you select the sample to be loaded.
  If the sample is not a 8SVX, 16SV, AIFF or WAVE file, there will be
  following window.


	unknown format
	 load-options

  @{"  " link loadtype} mono      @{"  " link loadbitcpu}  8 Bit
  @{"  " link loadtype} stereo    @{"  " link loadbitcpu} 16 Bit

  @{"  " link loadsign} signed    @{"  " link loadbitcpu} Motorola
  @{"  " link loadsign} unsigned  @{"  " link loadbitcpu} Intel

  @{"    skip    " link skip} 1234

  @{"    Load    " link loadload} @{"   cancel   " link loadcancel}


  With this parameters it should be possible, to load every unknown sound-file.

  Notes:
    If you want to load a file as stereo OR 16 bit, the filelength must be
    divideable by two.
    If you want to load a file as stereo AND 16 bit, the filelength must be
    divideable by four.

    If you want to load a file and you are 100% sure that it is a 8SVX, 16SV,
    AIFF or WAVE file, but SampleE says 'unkown format', then send me this
    file. I will have a look at my load-routines and at the file in order to
    find the error. (I know a program, which writes WAVE files in a wrong way)

@endnode


@node loadtype "Mono / Stereo"

@{B}@{U}Mono / Stereo@{UB}@{UU}

  With this switches, you select wether the data have to be interpreted a as
  mono or stereo sample.

  SampleE expects, that the stereo-byte order is following:

   8 Bit: 12121212...	  1 = 1 byte  left;  2 = 1 byte  right
  16 Bit: 11221122...	  1 = 2 bytes left;  2 = 2 bytes right

@endnode


@node loadsign "signed / unsigned"

@{B}@{U}signed / unsigned@{UB}@{UU}

  Here you select, wether the data has a sign or not.

  Example:
    8SVX and amiga-raw soundfile have values from -128 to 122 -> signed

    WAVE 8 bit format has values from 0 to 255 -> unsigned

@endnode


@node loadbitcpu "8 Bit / 16 Bit - Motorola / Intel"

@{B}@{U}8 Bit / 16 Bit - Motorola / Intel@{UB}@{UU}

  Here you select wether the data has to be interpreted as a 8 bit or 16 bit
  sample.

  If you select 16 bit, Motorola/Intel has following meaning.

  In order to get 16 bit, you have to combine 2 bytes. This can be done in two
  different ways.

  Motorola: left  is the high-byte, right is the low-byte

  Intel   : right is the high-byte, left  is the low-byte


  If you have a unknown file, only trying will help, but if you know from
  which computer the file comes from, you can set the byte order well aimed.

@endnode


@node skip "skip"

@{B}@{U}skip@{UB}@{UU}

  Here you can set the number of bytes, which you want to be skipped.

  This is useful e.g. if you know how big the file-header of the file is or if
  you want a file as 16 bit-stereo, the filelength must be divideable by 4. You
  can reach this by skipping by 1,2 or 3 bytes (depending on the filelength).

@endnode


@node loadload "MultiIO-Load"

@{B}@{U}MultiIO-Load@{UB}@{UU}

  The file is loaded with these parameters and with a bit luck, the result
  is the wanted.

@endnode

@node loadcancel "cancel"

@{B}@{U}cancel@{UB}@{UU}

  Loading is canceled.

@endnode



@node Save "save"

@{B}@{U}save@{UB}@{UU}

  Following window appears


     Format
  @{"  " link saveformat} 8SVX
  @{"  " link saveformat} 16SV
  @{"  " link saveformat} AIFF
  @{"  " link saveformat} WAVE
  @{"  " link saveformat} RAW         @{"    options    " link saveformat}

  @{"    save     " link savesave}  @{"     cancel    " link savecancel}

@endnode


@node saveformat "save format"

@{B}@{U}save format@{UB}@{UU}


   If you select 'options' a window appears, where you can set several options
   of the actual selected format.


8SVX: is the most common format on the Amiga. But samples are only saved with
      8 Bit and not with 16 Bit !!! Stereo samples are converted to mono !!!
      If "compress" is activated, the sample will be compressed using the
      fibonacci-delta-method. Die compression is always 50%, but this method
      has in most cases a (high) lost of quality !

16SV: is almost the same as 8SVX. The data is in opposite to 8SVX written with
      16 Bit. Read and write compressed files is not possible in the moment.

AIFF: is used on Apple Macintosh also on the Amiga and not as often under
      Windows. You can choose between save as 8/16 Bit and Mono/Stereo.

WAVE: is mainly used under Windows. There are some options:
      you can save as 8 Bit/16 Bit and Mono/Stereo

RAW:  is a flexibel format, with one disadvantage: it is not saved, in which
      format the sample was saved !
      You can select between 8 Bit/16 Bit; Mono/Stereo; signed/unsigned and
      Motorola/Intel auswählen. You can find a description of the parameters
      under @{"load" link load}
      If you select RAW, the default values 8 Bit, Mono, signed, Motorola will
      be used. These values are equal to the AMIGA RAW-format.

@endnode


@node savesave "save"

@{B}@{U}save@{UB}@{UU}

  A filerequester appears with which you can save the sample.

@endnode


@node savecancel "cancel"

@{B}@{U}cancel@{UB}@{UU}

  Saving is canceled.

@endnode



#########################################################################
#									#
#  volume window							#
#									#
#########################################################################
@node volumewindow "volume window"

@{B}@{U}volume window@{UB}@{UU}


   start @{"   |                        " link volval}@{">" link volval}@{" 100" link volval} %
     end @{"   |                        " link volval}@{">" link volval}@{" 100" link volval} %

  @{" fade  in " link volfade}@{" fade out " link volfade}@{" maximum  " link volfade} @{"do volume " link dovol}


  With the volume-change-function you can modify the samples loudness by
  changing the sample.

  **  this function modifies a marked range  **

@endnode


@node volval "volume parameters"

@{B}@{U}volume parameters@{UB}@{UU}

  - you can modify the start/end volume with the scroll bars
  - with '>' you can enter the value in a requester

  on the right the current values are displayed

@endnode


@node volfade "volume: fade in/fade out"

@{B}@{U}volume: fade in/fade out@{UB}@{UU}

  The start/end volume is set to
  'fade  in' : fades the marked range in
  'fade out': fades the marked range out

  For 'maximum', a marked range is needed. 'max' calculates the needed volume
  values in order to make the sample as loud as possible.

@endnode


@node dovol "change volume"

@{B}@{U}change volume@{UB}@{UU}

  For the marked range, the new volume will be calculated.

@endnode



#########################################################################
#									#
#  shift window 							#
#									#
#########################################################################
@node shiftwindow "shift window"

@{B}@{U}shift window@{UB}@{UU}


  @{"                 |                " link shiftval}@{">" link shiftval}@{"    0" link shiftval}

  @{"   up    " link shiftmode} @{"  down   " link shiftmode} @{" center  " link shiftmode} @{"  zero   " link shiftmode}
		@{"  do shift  " link doshift}


  With the shift-function you can shift the wave-form up/down. This may be
  useful if the values of a sample are only above/under the zero-line. This
  may be unfavourable for some functions like e.g. change volume, mix,... .

  **  this function modifies a marked range  **

@endnode


@node shiftval "shift value"

@{B}@{U}shift value@{UB}@{UU}

  With the scrollbar you can set the value, with which the sample is shifted.
  On the right side the value is displayed.
  A negative/positive value means, that the sample is shifted down/up.

@endnode


@node shiftmode "useful shift-values"

@{B}@{U}useful shift-values@{UB}@{UU}

  '   up   ' - the shiftvalue is set to value which shifts the sample maximum up
  '  down  ' - see 'down' but the sample is shifted down
  ' center ' - the shiftvalue is set to the value which centers the marked range
  '  zero  ' - the shiftvalue is set to the value which moves the first marked
	       byte to zero.

@endnode


@node doshift "shift"

@{B}@{U}shift@{UB}@{UU}

  Das sample is shifted.

@endnode



#########################################################################
#									#
#  Mix-Fenster								#
#									#
#########################################################################
@node mixwindow "mix window"

@{B}@{U}mix window@{UB}@{UU}

  current    buffer
  @{" 50" link mixval}@{"    |   " link mixval}@{" 50" link mixval}
      @{" do mix " link domix}


  This function mixes the current sample with the contents of the copy-buffer.

  Note:
  Is the current sample mono, the copy-buffer has to be also in mono.
  Is the sample stereo, then there are two cases:
  a) the copy-buffer is stereo and in the stereo-window the edit-mode is set
     to 'both'.
  b) in stereo-window is set to 'left' or 'right', in this case the copy-buffer
     has to contain mono data.


  **  this function changes a marked range  **

@endnode


@node mixval "mixing ratio"

@{B}@{U}mixing ratio@{UB}@{UU}

  With the scrollbar you can modify the mixing ratio.
  Left/right of the scrollbar the ratio of the sample/of the copybuffer is
  displayed.

@endnode



@node domix "mix"

@{B}@{U}mix@{UB}@{UU}

  The marked range of the current samples is mixed with the copy-buffer, with
  the set mixing-rate.

@endnode



#########################################################################
#									#
#  echo window								#
#									#
#########################################################################
@node echowindow "echo window"

@{B}@{U}echo window@{UB}@{UU}

      delay @{"     |      " link echopara}@{" 50" link echopara} %
      times @{"|           " link echopara}@{"  1" link echopara} *
      decay @{"     |      " link echopara}@{" 50" link echopara} %
	  @{"   do echo   " link doecho}


  With this function, you can add one or more echos to a sample.

  **  this function changes a marked range  **

@endnode


@node echopara "echo parameters"

@{B}@{U}echo parameters@{UB}@{UU}

  With the scrollbars you set the parameters for the echo function. Behind the
  bar the value is displayed.

  delay : this value defines, after how many percents of the marked range the
	  first/second/third... echo starts

	  e.g. 25% = after 1/4 of the marked range, the first echo starts

  times : this value defines the number of echos

	  e.g.	3* = three echos will be calculated

  decay : this value defines the decay of the loudness of the echos

	  e.g. 25% = the first echo has 75%, the second echo has 50%,... of
		     the loudness of the original sample

@endnode


@node doecho "calculate echo"

@{B}@{U}calculate echo@{UB}@{UU}

  For the marked range, the echo will be calculated with the set parameters.

@endnode




#########################################################################
#									#
#  frequency window							#
#									#
#########################################################################
@node frequenzwindow "frequency window"

@{B}@{U}frequency window@{UB}@{UU}


   from @{"       |                   " link freqpara}@{">" link freqpara}@{"17000" link freqpara} Hz
     to @{"       |                   " link freqpara}@{">" link freqpara}@{"17000" link freqpara} Hz

  @{"      octave up      " link octave} @{"     octave down     " link octave}
  @{"  do with  oversamp  " link dofrq } @{" do without oversamp " link dofrq}


  With this function you can modify the frequency of a sample without changing
  the replay rate (see @{"audio window" link audiowindow}. This function changes
  the length of the sample.

  **  this function modifies a marked range  **

@endnode


@node freqpara "frequency parameters"

@{B}@{U}frequency parameters@{UB}@{UU}

  With the scrollbars you can set the from/to frequency. '>' a requester
  appears and there you can enter the value. On the right the value is
  displayed.

  It will be the best, if I explain the meaning of the from/to frequency with
  an example.

  A sample is played with 20kHz. The replay rate stays at 20 kHz, but the
  sample shall sound as if it is played with 10 kHz. So you set the value of
  the from-frequency to 20000 Hz and the value of the to-frequency to 10000 Hz
  and calculate the newfrequency. Now the sample sounds, if it is played with
  20 kHz, like the original sample would sound with 10 kHz.

@endnode


@node octave "octave higher/lower"

@{B}@{U}octave higher/lower@{UB}@{UU}

  The from/to frequenz is set to values, which make the sample an octave
  higher/lower.

@endnode


@node dofrq "calculate frequency"

@{B}@{U}calculate frequency@{UB}@{UU}

  'do with oversamp'    : the calculation will be done with "OverSampling",
			  that means between/average values will be calculated
			  -> better quality, longer calculation time
  'do without oversamp' : the calculation will be done without "OverSampling"
			  that means no between/average values will be
			  calculated -> worse quality, shorter calculation
			  time

  Is the ratio fromfrequency : tofrequency bigger than 1:3 or 3:1, it may
  happen, that the calculation with oversampling sounds worse, than the
  calculation without oversampling

@endnode




#########################################################################
#									#
#  About Fenster							#
#									#
#########################################################################
@node aboutwindow "about window"

@{B}@{U}about window@{UB}@{UU}

   In the about window you find the versionnumber and the address of the @{"author" link author}
   and information about the memory: available, used, maximum available and
   biggest @{"continous memory-block" link fragmemory}.
   It is differed between FAST and CHIP memory.

@endnode



@node fragmemory "fragmented memory"

@{B}@{U}fragmented memory@{UB}@{UU}

   If several program are started/quited, data is loaded/deleted etc. it may
   happen that your memory is splitted up in several small pieces.
   Samples have to be loaded in continous parts of memory eg. a 100 KByte big
   sample can't be loaded, if the biggest memory block is smaller than
   100 KByte.


   What can you do against fragmented memory ?

   - Quit all programs, delete all file in RAM-Disks and execute the command
     'avail' with the option 'flush'. (doesn't always help)

   - reboot your computer (helps always)

@endnode




#########################################################################
#									#
#  audio window 							#
#									#
#########################################################################
@node audiowindow "audio window"

@{B}@{U}audio window@{UB}@{UU}

	  play
  @{"   all    " link play}@{"   view   " link play}
  @{"   mark   " link play}
  frequency @{">" link setfreq}@{"17000" link showfreq}
  @{"         |          " link setfreq}
  volume    @{"64" link showvol}@{"       |" link setvol}


  If you use the built-in Paula soundoutput you MUST have fast-memory !
  Because of the high Chipmem-bus usage when replaying at high rates, stereo
  samples and high-resolution screens with several colours there were often
  distortions while replaying. Using fast-memory this problem was removed.

  If in SampleE_Prefs AHI was activated, the samples will be replayed using
  AHI.

@endnode


@node play "play"

@{B}@{U}play@{UB}@{UU}

  - '   all    '  the whole sample is played
  - '   view   '  the visible range is played
  - '   mark   '  the marked range is played

  while playing a window appears. In this window is a gadget with the text
  'stop play'ing'. If you klick on this gadget the playing is stopped.
  There will be also a moving bar in the @{"sample window" link samplewindow} which displays the
  actual replay-position.

  With AHI the bar is updated 4 times a second. Using the Paula-Output, the bar
  is updated only 2 times a second because of speed reasons.

@endnode


@node setfreq "set frequency"

@{B}@{U}set frequency@{UB}@{UU}

  With '>' a requester appears where you can set the frequency.
  With the proportional-gadget you can set the frequency, too.

  Frequency means the frequency, with which the sound-hardware plays the sample.

@endnode


@node showfreq "frequency"

@{B}@{U}frequency@{UB}@{UU}

  Here is the current frequency displayed.

@endnode


@node setvol "set volume"

@{B}@{U}set volume@{UB}@{UU}

  With the proportional-gadget you can set the volume.

  Volume means the volume, with which the sound-hardware plays the sample.

@endnode


@node showvol "volume"

@{B}@{U}volume@{UB}@{UU}

  Here is the current volume displayed.

@endnode




#########################################################################
#									#
#  stereo window							#
#									#
#########################################################################
@node stereowindow "stereo window"

@{B}@{U}stereo window@{UB}@{UU}

	   convert to
  @{"   mono   " link convertto}@{" @|    mix        " link tomonotype}
	    @{" 50" link monoval}@{"     |     " link monoval}@{" 50" link monoval}
  @{"  stereo  " link convertto}@{" @|   normal      " link tostereotype}
       edit destination
  @{" @|         both            " link edittype}
  @{"         swap sides         " link swapsides}

@endnode


@node monoval "mixing ratio"

@{B}@{U}mixing ratio@{UB}@{UU}

  This option is only needed, if 'covert to mono' the mode 'mix' is selected.

  With the scrollbar you can modify the mixing ratio.
  Left/right of the scrollbar the ratio of the left/right side is displayed.
  rechten Seite.

@endnode


@node convertto "convert to"

@{B}@{U}convert to@{UB}@{UU}

  ' mono ' - converts the sample to mono
  'stereo' - converts the sample to stereo

  with the selected options.

@endnode


@node tomonotype "to mono - options"

@{B}@{U}to mono - options@{UB}@{UU}

  '      mix      ' - the left and right side are mixed together with the
		      @{"ratio" link monoval} selected below
  '  left > buffer' - the left side is copied to the copy-buffer, the right
		      side stays in the sample
  ' right > buffer' - the left side is copied to the copy-buffer, the right
		      side stays in the sample
  '   alternate   ' - the both sides are "fit together" that means, that means
		      one value of the left, one value of the right, one value
		      of the right and so on -> the new sample is twice as long
		      as the old

@endnode


@node tostereotype "to stereo - options"

@{B}@{U}to stereo - options@{UB}@{UU}

  '     normal    ' - the original sample is used for the left and right side
  'buffer > left  ' - the copy buffer is copied to the left side, the original
		      sample becomes the right side
  'buffer > right ' - the copy buffer is copied to the right side, the original
		      sample becomes the left side
  '   alternate   ' - the original sample is divided that means the 1. value
		      is placed to the left, the 2. value is placed to the
		      right, the 3. value is placed to the left and so on


  'buffer > left  ' bzw. 'buffer > right ' need, that the copy buffer has the
  same lenght as the current sample.

@endnode


@node edittype "edit"

@{B}@{U}edit@{UB}@{UU}

  'both ' - both sides are edited
  'left ' - only the left side is edited
  'right' - only the right side is edit

  This option affects:
  @{"reverse" link reverse}
  @{"inverse" link inverse}
  @{" clear " link edit}
  @{" volume" link volumewindow}
  @{" shift " link shiftwindow}
  @{"  mix  " link mixwindow}
  @{" echo  " link echowindow}

@endnode


@node swapsides "swap sides"

@{B}@{U}swap sides@{UB}@{UU}

  The left side and the right are swapped.

@endnode




#########################################################################
#									#
#  preferences window							#
#									#
#########################################################################
@node preferenceswindow "preferences window"

@{B}@{U}preferences window@{UB}@{UU}


  @{" @|        own screen           " link prefsscreen}    memory
  @{" mode  " link prefsscreen}SUPER72:SuperHighRes      @{"  " link prefsmem} memory
  @{"colours" link prefsscreen}
  @{" font  " link prefsscreen}topaz 8
  @{"  " link ahiprefs} use AHI
  @{"  " link gfxcard} 57600 with graphic-card

  @{"   save   " link saveprefs} @{"   use    " link useprefs} @{"  cancel  " link cancelprefs}  @{"load last " link loadlast}


  SampleE V3.20 has a new config-file format. SampleE_Prefs is able to load
  the old format and convert it to the new.

@endnode


@node prefsscreen "screen options"

@{B}@{U}screen options@{UB}@{UU}

  With these gadgets you can:
    "screen " - use own screen or workbench screen
    " mode  " - select a graphics mode
		see also: @{"recommended screen modes" link RecommendedScreenModes}
    "colours" - change the screen colors
    " font  " - select a font

    on the right the currently selected screen/font is displayed.

@endnode


@node prefsmem "memory options"

@{B}@{U}memory options@{UB}@{UU}

  In the moment, you can't select anything. The samples are loaded into the
  fast-memory if possible. If there is no fast-memory available or everything
  is used, then chip-memory is used.

  In a later version there will be some options.

@endnode


@node ahiprefs "use AHI"

@{B}@{U}use AHI@{UB}@{UU}

  If this is checked, SampleE uses AHI-device to replay the samples. This way
  it is possible to replay samples with 16 bit on a sound card. For more
  details read the manual of AHI.
  Of course @{"AHI" link ahi} has to be installed !

@endnode


@node gfxcard "57600 Hz with graphic-card"

@{B}@{U}57600 Hz with graphic-card@{UB}@{UU}

  Depending on the used graphic-card software (Picasso96, CaberGfx,..) it should
  be possible to replay a sample with max. 57600 Hz. If it is possible with your
  software (read the documentation!) to replay 57600 Hz, this option must be set
  to enable SampleE to use these high frequency.

@endnode


@node saveprefs "save"

@{B}@{U}save@{UB}@{UU}

  The configuration is saved to ENVARC:SampleE.prefs.

@endnode


@node useprefs "use"

@{B}@{U}use@{UB}@{UU}

  The configuration is saced to ENV:SampleE.prefs -> after a reset the
  configuration is lost.

@endnode


@node cancelprefs "cancel"

@{B}@{U}cancel@{UB}@{UU}

  SampleE_Prefs quits and nothing will be saved.

@endnode


@node loadlast "load last"

@{B}@{U}load last@{UB}@{UU}

  The last saved configuration is loaded.

@endnode



@node RecommendedScreenModes "recommended screen modes"

@{B}@{U}recommended screen modes@{UB}@{UU}

   You should use a screen with at least 640*400 or 800*300 pixels. On a
   smaller screen you will have only few space. You might use a small font,
   but this is often hard to read.

   recommeded:
      - all DBL-modes  (DBLPAL, DBLNTSC) -> max 54000 Hz
      - Euro 72 Hz			 -> max 57600 Hz
      - Multiscan			 -> max 57600 Hz
      - Super 72			 -> max 46000 Hz

      This mode are able to diplay high resolutions without flicker.
      In this mode it is possible to play samples with up to 57.6 kHz.


   not recommeded:
      - PAL
      - NTSC
      - Euro 36 Hz

      This modes flicker more or less strong or in the flicker-free versions
      the resolution is low. Samples can be played with only 28,8 kHz.


   The program should run on graphic-cards without any problems. Maximum replay
   rate is limited to 28,8 kHz.

@endnode



@node ahi "AHI"

@{B}@{U}AHI@{UB}@{UU}

  AHI is a replacement for the audio-device. It is driver based that means the
  sound output is done with the amiga soundchip or any amiga soundcard with a
  driver for AHI.

  For more information:

     AHI in Aminet:
	   dev/misc/ahidev.lha	   developer archive
	   mus/misc/ahiusr.lha	   user archive
	   docs/misc/ahiman.lha    manual

  AHI is Copyright ©1994-1997 Martin Blom

@endnode



@node paula "Paula"

@{B}@{U}Paula@{UB}@{UU}

  Paula is the name of the amiga soundchip. It offers 4 channels (two on the
  left, two on the right), each with a resolution of 8 bit.

  Some time ago a method was developed, which joins the channels of one side
  together enableing an output in 14 bit.

@endnode



@node frames "frames"

@{B}@{U}frames@{UB}@{UU}

   Here some definitions:

   sample:	 one (digitized) value  e.g. in 8 or 16 Bit

   sample-frame: one frame is built of one sample in the mono case and built
		 of two samples (one sample left, one sample right) in the
		 stereo case.
		 Often only the word frame is used.

   Sound:	 a sound is built of many sample-frames.
		 Very often, the word sample is used instead of sound.


   Example: we have a sound with 16 Bit and stereo, 44100 Hz and a length of
	    5 seconds
	    -> a sample is 16 Bit = 2 Byte big
	    -> a sample-frame is built of two samples and is 4 Byte big
	    -> the sound exists of  44100 1/s * 5 s = 220500  sample-frames

@endnode

