home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d7xx / d779 / aap_aac.lha / AAP_AAC / AAC.Doc < prev    next >
Text File  |  1992-12-06  |  9KB  |  313 lines
  1. 04. Oct 1992       Docfile for AAC      version 1.1 (1.st public release)
  2.  
  3.   ** Table of contents in this docfile **
  4.  
  5. 1. .... FUNCTIONAL OVERVIEW
  6. 2. .... USAGE (CLI-OPTIONS)
  7. 3. .... AAC KEYS
  8. 4. .... USING SCRIPT FILES
  9. 5. .... FRAME TIMING
  10. 6. .... CONVERTING EXAMPLES
  11. 7. .... CONVERTING LIMITATIONS
  12. 8. .... BUGS
  13.  
  14. 1. FUNCTIONAL OVERVIEW
  15.  
  16. AAC (AmigaAnimConvert) offers the following features:
  17.  
  18.     -   Convert a sequence of pictures and/or anims to anim
  19.         files
  20.  
  21.     -   Convert a sequence of pictures and/or anims to single
  22.         pictures
  23.  
  24.     -   Supported pictures: IFF ILBM
  25.  
  26.     -   Supported anims   : IFF ANIM_5    (byte oriented)
  27.                             ANIM_7        (short oriented)
  28.                             ANIM_7        (long  oriented)
  29.  
  30.  
  31.         (For a description of the new ANIM7 fileformat
  32.         see Anim7.doc file.)
  33.  
  34.  
  35.  
  36. 2. USAGE (CLI-OPTIONS)
  37.  
  38. AAC is designed for cli call.
  39.  
  40. Usage:
  41.     aac [-switches] anim | picture | script
  42.  
  43. All the switches are optional.
  44.  
  45.     [-d]    Input from diskfile                 (default)
  46.  
  47.     [-m]    Preload inputfile(s) into memory.
  48.  
  49.     [-l]    Type script while analyzing it.
  50.  
  51.     [-s]    Set global frame timing (speed in jiffies).
  52.  
  53.     [-a]    Output as anim filetype.            (default)
  54.             Write output frames to one animation file.
  55.  
  56.             All frames of an output animation file must have
  57.             the same size!
  58.  
  59.             If the Input frame Sequence is a script with
  60.             different sizes of frames:
  61.  
  62.             Each frame of the input sequence (script) that does
  63.             not match in width, height or depth with the
  64.             previous frame begins a seperate anim outputfile.
  65.             (Using basename and the next filecontnumber to
  66.              build its name).
  67.  
  68.             (Do NOT combine -p and -a option !!)
  69.  
  70.             Customize anim file with following number options:
  71.             (number options should always be used in
  72.              combination with -a Option)
  73.  
  74.     [-4]    Use ANIM7 type with long data (data is organized as
  75.             longword (= 4 Byte) enables maximum playbackrates
  76.             on 68030 machines with 32-Bit organized memory).
  77.  
  78.     [-2]    Use ANIM7 type with short datamodel (data is
  79.             organized as words (= 2 Byte).
  80.  
  81.     [-1]    Use ANIM5 IFF type.                 (default)
  82.             (Data is organized in bytes and mixed with opcode
  83.              List. ANIM5 files are usually better packed than
  84.              ANIM7 but they playback slower.)
  85.  
  86.     [-0]    Write initial frame#0 as DLTA chunk otherwise use
  87.             BODY chunk for frame#0 (default).
  88.             This option usually produces better compression
  89.             results on the first frame (because the first frame
  90.             is stored as difference (DLTA) to an empty frame).
  91.  
  92.             But: It produces NON-IFF outputs.
  93.  
  94.     [-p]    Output as sequence of pictures (IFF,ILBM).
  95.             Each frame is written to a seperate IFF ILBM file.
  96.  
  97.             (Do NOT combine -p and -a option!!)
  98.  
  99.     [-b]    Option generate uncompressed BODY chunks otherwise
  100.             use RLC-compressed BODY.            (default)
  101.  
  102.             (This option does not make sense in combination
  103.              with -0)
  104.  
  105.     [-o]    Basename for the outputffile.
  106.  
  107.             With -o you may specify a basename for your output-
  108.             files (pictures or animations). A filecount number
  109.             (minimum of 3 digits) is added as suffix to the
  110.             basename.
  111.  
  112.             The basename must follow immediate behind the 'o'
  113.             letter!!
  114.             Further options must be separated by a blank.
  115.  
  116.                 -odh0:pictures/pic.
  117.  
  118.             results in:
  119.  
  120.                 dh0:pictures/pic.000
  121.                 dh0:pictures/pic.001
  122.                   :
  123.                 dh0:pictures/pic.nnn
  124.  
  125.  
  126. AAC needs no additional files or libraries to run.
  127. AAC runs on AMIGAs with Kickstart 1.3 and higher.
  128.  
  129.  
  130. 3. AAC KEYS
  131.  
  132. Press ESC to stop AAC (Hold down ESC for a while, because AAC
  133. writes the current frame to the outputfile before checking the
  134. ESC key).
  135.  
  136.  
  137.  
  138. 4. USING SCRIPT FILES
  139.  
  140. Both programs AAP and AAC use the same kind of scriptfiles.
  141. Scripts are used to assemble animation sequences or picture
  142. slide shows.
  143. Scripts are line-structured ASCII files and can be made with
  144. any editor.
  145.  
  146. -   There can be only ONE filename or command in a single line.
  147.  
  148. -   Files with binary data are not accepted as script.
  149.  
  150. -   Script files are not case sensitive.
  151.  
  152. -   Blank lines, or lines starting with the semicolon ';' are
  153.     remarklines.
  154.  
  155. -   All lines that are no command or no remarklines must
  156.     contain the name of a picture or animation file. The
  157.     filenames MUST NOT contain Blanks!!
  158.  
  159. See docfile AAP.doc for a detailed description about
  160. the script command Syntax and possibilities.
  161.  
  162. Warning:
  163. Bear in mind, that _BEG_LOOP's default is 32000. (That gives a
  164. lot of Frames ...
  165.               ... so do not use LOOPs lightly with AAC.)
  166.  
  167. Restrictions:
  168.  
  169. AAC ignores some of the commands in the script; marked with *)
  170.  
  171. List of ignored script commands:
  172.  
  173.     _ADRESS         *)
  174.     _MSG            *)
  175.     _VIEW_DX [ofs]  *)
  176.     _VIEW_DY [ofs]  *)
  177.     _KEY_BREAK      *)
  178.  
  179. 5. FRAME TIMING
  180.  
  181. The playback rate is stored in a DPAN chunk as "frames_per_second" value.
  182. AAC timing is based on jiffies, this limits the f/sec values to multiples
  183. of the display frequency. (see table below).
  184.  
  185.   speed     PAL             NTSC
  186.  (jiffies)  (frames/sec)    (frame/sec)
  187.  
  188.     1       50              60
  189.     2       25              30
  190.     3       16.6            20
  191.     4       12.5            15
  192.     5       10              12
  193.     6       8.3             10
  194.     7       7.1             8.5
  195.  
  196.  
  197. Timing informations are also stored as relative frametime jiffies
  198. in ANHD Chunks along with each frame.
  199. Timing informations are lost when the output to single pictures
  200. is used.
  201.  
  202. 6. CONVERTING EXAMPLES
  203.  
  204.  Convert a single file, named MyAnim5.file from IFF ANIM5 (or ANIM7 short)
  205.  to a single file ANIM7 (long)
  206.  
  207.    AAC -a4 -oMyAnim. MyAnim5.file
  208.  
  209.    ==> Output to file: MyAnim.000
  210.  
  211.  
  212.    since we did not specify any path within the filenames
  213.    both input and output file are located in the current directory.
  214.  
  215.  
  216.  Convert any ANIM file of types ANIM7
  217.  to a single file of IFF ANIM5 (as used by DPAINT)
  218.  
  219.    AAC -a -oDH0:Dpaint/Anims/MyAnim.  MyAnim.000
  220.  
  221.    ==> Output to file DH0:Dpaint/Anims/MyAnim.000
  222.  
  223.    note that this example will NOT work if the current directory is
  224.    DH0:Dpaint/Anims/
  225.    because the output file must not be the same as the input file
  226.    on a disk based conversion.
  227.    (You may use the same file for input and output if the -m
  228.    option is set to operate from Memory)
  229.  
  230.  
  231.  Convert any ANIM file of types ANIM7 or ANIM5
  232.  to a group of Picture files of IFF ILBM type
  233.  
  234.    AAC -p -oDH0:Dpaint/pictures/MyPic.  MyAnim.000
  235.  
  236.    ==> Output to file DH0:Dpaint/pictures/MyPic.000
  237.    ==> Output to file DH0:Dpaint/pictures/MyPic.001
  238.    ==> Output to file DH0:Dpaint/pictures/MyPic.002
  239.    ==> Output to file DH0:Dpaint/pictures/MyPic.003
  240.  
  241.    ...
  242.    ...
  243.    ... until all frames are saved as picture
  244.  
  245.  
  246.  
  247.  Convert a Sequence of Pictures
  248.  into one big Animation.
  249.  
  250.    Therefore you need to create a script that may look like this:
  251.  
  252.    ; This Remark is the 1.st line of the ConvertScript
  253.    ;
  254.    MyPic.000
  255.    MyPic.001
  256.    MyPic.002
  257.    MyPic.003
  258.    MyPic.004
  259.    MyPic.005
  260.  
  261.    ; at the end of the Animation we add the first
  262.    ; 2 frames.
  263.    ; that enables a continous loop replay.
  264.    ; (note that Dpaint stores Anims in the same way.
  265.    ; and truncates the last 2 frames when loading
  266.    ; an animation)
  267.    MyPic.000
  268.    MyPic.001
  269.  
  270.    ; This is the last line of the ConvertScript
  271.  
  272.  
  273.    AAC -a -oMyAnim. ConvertScript
  274.  
  275.    ==> Output to file MyAnim.000
  276.  
  277.  
  278.    This Example will work properly if all pictures have
  279.    the same height, width and depth.
  280.    if not the result wolud be two (or more) outputfiles.
  281.    (==> Output to file MyAnim.001, MyAnim.002, ...)
  282.  
  283.  
  284. 7. CONVERTING LIMITATIONS
  285.  
  286. Files of the IFF structure are organized in Chunks.
  287. In this Version AAC supports only those Chunk Types
  288. needed in AAP.
  289.  
  290.      - This Informations will be stored in the Output file(s):
  291.  
  292.                 Information Type  | Chunk Type
  293.                 -----------------------------------
  294.         Headers           | FORM, BMHD, ANHD
  295.         Dpaint Timing     | DPAN
  296.         Bitmap Data       | BODY, DLTA
  297.         Colormap Data     | CMAP
  298.         Viewmode Info     | CAMG
  299.  
  300.      - All other Information (such as the CRNG Colorcycling chunk)
  301.        found in Inputfiles is ignored.
  302.  
  303.      - There may be Changes of viewmodes palette and
  304.        relative_frametiming between each frame.
  305.        However:
  306.        Changes of width, height and depth
  307.        can not be packed into a single output animation file.
  308.        .. the result are 2 or more anim file outputs.
  309.       (filenames are made of a basename and a count number)
  310.  
  311. 8. BUGS
  312.  
  313. There are no known Bugs.