@DATABASE IFF-ANIM-Format
@AUTHOR ...
@(C) ...
@NODE MAIN


                                 AnimFX V 2.5
                                 ------------


     deutsch                      @{"english" LINK Excuse}

     @{" Copyright        " LINK Copyright_D}          @{" Copyright        " LINK Copyright_E}
     @{" Einführung       " LINK Introduction_D}          @{" Introduction     " LINK Introduction_E}
     @{" Installation     " LINK Installation_D}          @{" Installation     " LINK Installation_E}
     @{" Benutzung        " LINK Usage_D}          @{" Usage            " LINK Usage_E}
     @{" ARexx-Port       " LINK ARexx_D}          @{" ARexx-Port       " LINK ARexx_E}
     @{" Sound-ANIMS ???  " LINK ANIM_D}          @{" Sound-ANIMS ???  " LINK ANIM_E}
     @{" Zukünftiges      " LINK Future_D}          @{" Future           " LINK Future_E}


@ENDNODE
@NODE Excuse


I have to excuse my really very bad english. There is no one who could
help me and translate my manuals with better results. So I have to do it
myself. You can see how bad it is and I hope you will understand what
I mean!

                                                      - Michael alias QXC


@ENDNODE
@NODE Copyright_D


  Copyright
  ---------


AnimFX ist © by QXC und Virtual Worlds Productions. AnimFX ist FREEWARE und
kann demzufolge frei weiterkopiert werden. Voraussetzung dafür ist, das am
Programm keine Veränderungen vorgenommen werden.

Die Benutzung von AnimFX und die Verwendung von Informationen aus den
mitgelieferten Dokumentationen geschieht unter allen Bedingungen und
Voraussetzungen auf eigene Gefahr. Es werden keinerlei Gewährleistungen
übernommen.

Änderungen bei Copyright, Dokumentation, Programm oder sonstigem werden
vorbehalten!


@ENDNODE
@NODE Copyright_E


  Copyright
  ---------


AnimFX is © by QXC and Virtual Worlds Productions. AnimFX is FREEWARE. If you
don't change the program you can copy and spread it freely.

You use AnimFX and it's documentations at your own risk. There are no
warranties.


@ENDNODE
@NODE Introduction_D


  Einführung
  ----------

AnimFX ist ein Animationsplayer, der in der Lage ist, neben den "normalen"
Anims auch Animationen mit @{"Sound" LINK ANIM_D} abzuspielen! Dabei
unterstützt AnimFX sowohl Mono- als auch Stereo-Samples. Letztere können
sogar Surround-Informationen beinhalten, die - wenn ein entsprechender Decoder
an den Amiga-Audioausgang angeschlossen ist - ein (fast) kinoreifes Ergebnis
liefern!

AnimFX ist auch in der Lage, Animationen, die größer als der verfügbare
Speicher sind, direkt von (Hard-) Disk abzuspielen.

Animationen mit Sound haben - technisch bedingt - neben dem faszinierenden
Eindruck, den so etwas hinterläßt, natürlich auch ein paar Nachteile. So
müssen hier wesentlich mehr Daten hin und her geschaufelt werden. Das wirkt
sich dann entsprechend auf die Abspielgeschwindigkeit aus. Folgende Faktoren
beeinflussen die Geschwindigkeit, wobei immer gilt, je mehr und je größer
um so mehr Daten müssen verarbeitet werden, und um so langsamer geht es:

Bilddaten:  - Größe des Bildschirmes
            - Anzahl der vorhandenen Farben (= Tiefe des Bildschirmes)
            - Größe des Bildbereiches, der sich von einem Frame zum
              anderen verändert

Sounddaten: - Anzahl der Kanäle (Mono oder Stereo)
            - Samplerate


AnimFX unterstützt folgende Formate/Features:
   - ANIM 7 - schnelles ANIM-Format, das zwar etwas größer ausfällt, aber
              dafür in Sachen Geschwindigkeit so ziemlich das Optimum
              darstellt (ANIM7/16 ist dabei schneller als ANIM8/16)
   - ANIM 5 - ein etwas älteres Format, das aber - Dank Deluxe Paint® - sehr
              weit verbreitet ist. Dieses Format ermöglicht recht kleine
              Dateien, ist aber leider etwas langsam. Das wirkt sich mitunter
              recht störend auf die Tonqualität aus.
   - ANIM 8 - schnelles ANIM-Format, das zwar etwas größer ausfällt, aber
              dafür in Sachen Geschwindigkeit so ziemlich das Optimum
              darstellt (ANIM8/32 ist dabei schneller als ANIM7/32)
   - Multi-Palette - verschiedene Paletten für die einzelnen Frames, das
              verbessert die Bildqualität auf Basis der maximal
              verwendbaren Farben, bremst aber die Animation etwas, da zu
              jedem Frame erst die Farben geändert werden müssen
   - Frames-Timing - neben Animationen mit einer festen Abspieldauer gibt es
              auch solche, bei denen die Anzeigedauer der Frames variiert.
              Enthält eine Animation keine Sounds, so werden diese
              Timinginformationen von AnimFX herangezogen.
   - Wiedergabe direkt von Disk - Animationen, die größer als der verfügbare
              Speicher sind, können direkt von der Festplatte abgespielt
              werden. Dabei verwendet AnimFX eine Replay-Methode, die dafür
              sorgt, das die Animation möglichst flüssig abgespielt wird. Ist
              zwischen den einzelnen Frames jedoch zuwenig Zeit, um genügend
              Daten zu laden, so muß AnimFX in gewissen Abständen trotzdem
              eine kurze Pause einlegen, um wieder Daten nachzuladen.
   - Loops mit Sound, wobei die Information, wieviele Loops gespielt werden
              sollen in einem Soundchunk mit enthalten ist

Wenn AnimFX unter Druck gerät und es nicht mehr schafft, eine Animation in der
vorgesehenen Geschwindigkeit abzuspielen, so wirkt sich das sicht- und hörbar
aus. Die Bildwiederholrate sinkt, der Ton verschlechtert sich und klingt
dadurch blechern bis hallig. Es handelt sich dabei nicht um einen
Programmfehler sondern ist technisch bedingt.
  Dieses Problem besteht besonders dann, wenn IFF-ANIMs auf einem Computer
abgespielt werden, der nur CHIP-RAM besitzt.


@ENDNODE
@NODE Introduction_E


  Introduction
  ------------


AnimFX is an animplayer wich allowes it to replay "normal" ANIMs and anims
with @{"Sounds" LINK ANIM_E}! It supports Mono- and Stereo-samples. Stereo-
samples can be surround-encoded, so that you will get a sound (nearly) like
in good cinemas if you use a surround-decoder!

AnimFX is also able to replay anims, wich are larger than your RAM.

Because of its larger amount of data wich has to be moved, ANIMs with sound
are not as fast as ANIMs without. There are some things wich have a
influence on playspeed:

Picture: - size of Screen
         - number of colors (= depth of screen)
         - size of the part of the screen wich changes from one frame
           to the next

Sound:   - number of existing channels (Mono or Stereo)
         - samplerate / samplefrequency

AnimFX supports following formats/features:
   - ANIM 7 - a good and fast method, its files are larger than ANIM-5-
              files but playspeed is very good (ANIM7/16 is faster than
              ANIM8/16)
   - ANIM 5 - a older format, but there are much ANIMs in method 5 because
              DeluxePaint® used it; it's a little bit slow and so the
              resulting quality of the sound isn't as good as in method 7
   - ANIM 8 - a good and fast method, its files are larger than ANIM-5-
              files but playspeed is very good (ANIM8/32 is faster than
              ANIM7/32)
   - multi-palette - there are anims with different palettes for every
              frame, this method improves picture-quality but speed is
              a little bit slower
   - frames-timing - you can find animations with a static playspeed and
              ANIM´s with a playspeed wich varies from frame to frame.
              If AnimFX doesn´t find sounds inside a ANIM-file, it uses
              this timing-informations for replay.
   - direct-from-disk replay - animations with a size greater than the
              available RAM can be replayed direct from a harddisk. AnimFX
              uses a replay-method wich tries to display the animation
              as smooth as possible. But if the time between two frames is
              too short to load data, AnimFX sometimes needs to stop to
              load new data from disk.
   - looped animations with sound; the information how much loops have to 
              be played are included in one of the special soundchunks

If AnimFX has to move much data - e.g. large changes from one frame to an
other in a slow ANIM-method - you can see and hear it. The framerate
decreases and it sounds strange (it sounds like hall or echo). This isn't
a bug in AnimFX, it's a technical problem (your computer could be too
slow!).
  You will have these problems if you playback a IFF-ANIM on a computer
without FAST-RAM.


@ENDNODE
@NODE Installation_D


  Installation
  ------------


Da die Installation von AnimFX wirklich denkbar einfach ist, habe ich mir
nicht die Mühe gemacht, extra noch ein Install-Script zu schreiben.

AnimFX wird installiert, indem das AnimFX-Icon z.B. in die "Utilities"-
Schublade der Workbench gezogen wird (wo das Programm jederzeit gefunden wird,
wenn die "Path"-Kommandos der "startup-sequence" nicht vermurxt wurden).


@ENDNODE
@NODE Installation_E


  Installation
  ------------


The Installation of AnimFX is so simple, that you don't need a special
Installer-script to do that.

Drop its icon into a Workbench-drawer (the "Utilities"-drawer would be the
best place, because it can be found there without problems, if you don't have
changed the "Path"-commands in your "startup-sequence").


@ENDNODE
@NODE Usage_D


  Benutzung
  ---------


AnimFX kann vom CLI oder von der Workbench aus gestartet werden. Folgende
Parameter stehen für das CLI zur Verfügung:

AnimFX ?
   Ausgabe von Versionsnummer, Copyright, unterstützten Formaten und einer
   Beschreibung der möglichen Parameter
AnimFX
   Es wird ein Filerequester geöffnet, mit dem die Animation selektiert
   werden kann ("reqtools.library" wird in "LIBS:" benötigt)
AnimFX <filename> <ZOOM>
   Abspielen einer Animation mit dem Namen "filename" vom CLI aus. Handelt
   es sich bei der Animation um ein CDXL-File, so kann dieses - wenn eine
   bestimmte maximale Bildgröße nicht überschritten wird - mit dem "ZOOM"-
   Parameter auf die doppelte Breite und Höhe skaliert werden (benötigt
   DblPAL-Monitor)
AnimFX <portname> AREXXPORT
   Steuerung von AnimFX über einen @{"ARexx-Port" LINK ARexx_D}. Der Name des Ports wird durch
   den Parameter <portname> vergeben und kann beliebig gewählt werden.

AnimFX benötigt FAST-RAM, das AGA-Chipset, AmigaOS 3.0 und mindestens
einen 68020-Prozessor.


@ENDNODE
@NODE Usage_E


  Usage
  -----

You can start AnimFX from CLI/shell or from workbench. Following parameters
are possible for CLI:

AnimFX ?
   Gives you some informations about version, copyright, supported file-
   formats and a short description of all parameters.
AnimFX
   A filerequester will be opened if the "reqtools.library" is installed.
AnimFX <filename> <ZOOM>
   Replays a animation with the name "filename" from CLI. If you replay a
   CDXL-file, you can scale it to the double width and height by using the
   "ZOOM"-parameter. Zooming is possible only if the picture size isn't to
   large and if DblPAL is available.
AnimFX <portname> AREXXPORT
   You can handle AnimFX by using @{"ARexx" LINK ARexx_E}. The name of the Port is given with
   the parameter <portname>.

AnimFX requires FAST-RAM, AGA-Chipset, AmigaOS 3.0 and at least a
68020-processor.


@ENDNODE
@NODE ARexx_D


  Der ARexx-Port
  --------------


Um AnimFX per ARexx steuern zu können, muß es mit folgenden Parametern
gestartet werden: AnimFX <portname> AREXXPORT.

"portname" ist dabei der frei wählbare Name des ARexx-Ports, über den
AnimFX gesteuert wird.

Es werden folgende ARexx-Befehle unterstützt:

AFXinit <filename> <ZOOM> 
   Initialisierung des Programmes und Übergabe des Filenamens/Pfades
   "filename" zur Animation. Entsprechend der Parameter für das CLI kann
   hier für CDXL-Files auch der Parameter "ZOOM" angegeben werden.
   
   Soll ein CDXL-File abgespielt werden, so ist dafür nur der Befehl
   "AFXinit" erforderlich. Die Animation wird sofort abgespielt.
   
   Um IFF-Animationen abzuspielen, sind immer alle drei Befehle "AFXinit",
   "AFXscan" und "AFXplay" erforderlich. "AFXinit" muß dabei jedesmal
   als erstes ausgeführt werden, auch wenn die gleiche Animation erneut
   abgespielt werden soll.

AFXscan
   Die mit "AFXinit" spezifizierte IFF-Animation wird geladen. Tritt ein
   Fehler auf, wird ein Fehlercode zurückgeschickt. "AFXplay" kann dann
   nicht ausgeführt werden

AFXplay
   Die mit "AFXinit" selektierte und mit "AFXscan" geladene IFF-Animation
   wird abgespielt. Sollte die Animation größer als der verfügbare
   Speicher sein, werden die fehlenden Frames automatisch nachgeladen.

AFXexit
   Der AnimFX-ARexx-Port wird entfernt und das Programm wird beendet.

AFXsetmem
   Es wird festgelegt, wieviel Speicher von AnimFX freigelassen werden soll.
   Diese Funktion ist sinnvoll, wenn z.B. AnimFX von einem Script aus ge-
   startet wurde und Speicher für andere Programme frei bleiben soll, die
   während des Abspielens im Hintergrund gestartet werden sollen. Die Größe
   des freizulassenden Speichers wird in Bytes angegeben. AFXsetmem sollte
   vor "AFXscan" benutzt werden, um rechtzeitig wirksam zu werden.


@ENDNODE
@NODE ARexx_E


  The ARexx-Port
  --------------


To handle AnimFX by using ARexx, you have to start it from CLI with
following parameters: AnimFX <portname> AREXXPORT.

"portname" is the name of the ARexx-port. You can choose a name for it
here.

Following ARexx-commands are supported:

AFXinit <filename> <ZOOM> 
   Initializes the program and gives the path/filename of the animation
   to it. Here you can also use the parameter "ZOOM" if you select a
   CDXL-file.

   If you replay a CDXL-file, the commands "AFXScan", "AFXplay" must'nt
   be used. These anims were replayed by the "AFXinit"-command.

   To replay IFF-animations you have to use the commands "AFXinit",
   "AFXscan" and "AFXplay".
   "AFXinit" has to be executed everytime as first command. You also have
   to execute it again if you like to replay the same animation again.

AFXscan
   The IFF-animation, specified with "AFXinit" will be loaded. If an
   error occures an errorcode will be returned. In this case you cannot
   execute the command "AFXplay".

AFXplay
   The IFF-animation will be replayed if you have executed "AFXinit"
   and "AFXscan" successful before.

AFXexit
   The AnimFX-ARexx-port will be removed and the program exits.

AFXsetmem
   With this function you declare, how much memory (in bytes) doesn't have
   to be used by AnimFX for the actual anim. This function is important, if
   you use AnimFX in a script and like to get some memory free for other
   programs wich should be startet while AnimFX replays.
   AFXsetmem should be used before "AFXscan" to declare the amount of memory
   wich needs to be free for the actual anim.


@ENDNODE
@NODE ANIM_D


  Sound-ANIMs
  -----------


Wer bis hierhin nur Bahnhof verstanden hat, hat vermutlich ein Problem, das
ich hiermit lösen möchte:

Es gibt IFF-ANIMs mit Soundunterstützung!! Ja, wirklich!!
---------------------------------------------------------

Bei diesen sind die Sampledaten ins ANIM-File integriert worden. Eine
Beschreibung, wie das genau aussieht, findet sich in der Dokumentation
"ANIM.guide" die darüberhinaus die kompletten Entwicklerinformationen für alle
derzeit aktuellen ANIM-Formate enthält.

ANIMs mit Sound können z.B. mit Hilfe des WaveTracer®-Softwarepaketes erstellt
werden (Informationen zum WaveTracer® gibt's z.B. im Internet auf der
VWP-Homepage unter "http://www.VirtualWorlds.de"). Es werden bei diesem Programm
mehrere Möglichkeiten  geboten, einen solchen Sound zu erstellen: durch
"Handarbeit", durch die  Analyse und Konvertierung von Raytracer-Szenen oder
durch Zusammensetzen  von einzelnen Samples. Genauere Informationen hierzu sind
den Dokumentationen des WaveTracer®-Softwarepaketes zu entnehmen.


@ENDNODE
@NODE ANIM_E


  Sound-ANIMs
  -----------


If you have a problem to understand what I mean, there can be two reasons why:
my english is too bad and you don't understand what I like to say - then I
can't help you (sorry!). Or you don't know what I mean when I write something
about "ANIMs with sound" - that's a little bit better, then I can help you:

There are IFF-ANIMs with soundsupport!! Yeah, really!!
------------------------------------------------------

These type of ANIM owns some spechial chunks including the sounddata. You can
have a look into the "ANIM.guide" if you want to have the complete developer-
information about all well known ANIM-formats (excluding the AnimBrush-format).

You can create ANIMs with sound by using the WaveTracer®-softwarepackage.
(information about WaveTracer® are available at the VWP-Homepage in english
and german: "http://www.VirtualWorlds.de"). The WaveTracer® gives you much
possibilities to create a good sound: you can make it using your hands, you
can analyze and convert raytracing-scenes or you can merge different samples to
one sound. If you like to have more informations, please have a look at the
WaveTracer®-documentation.


@ENDNODE
@NODE FUTURE_D


  Zukünftiges
  -----------


Folgende Dinge sind noch geplant bzw. schon in Arbeit:

- Unterstützung von 16 Bit Mono- und Stereo-Sounds


@ENDNODE
@NODE FUTURE_E


  Future
  ------


Here you can see which features will follow soon:

- support of 16 bit Mono- and Stereo-sounds


@ENDNODE
