home *** CD-ROM | disk | FTP | other *** search
/ Collection of Hack-Phreak Scene Programs / cleanhpvac.zip / cleanhpvac / PCGPEV10.ZIP / FLI.FOR < prev    next >
Text File  |  1994-05-10  |  10KB  |  245 lines
  1.  
  2.  
  3. Flic Files (.FLI) Format description:
  4.  
  5.      The details of a FLI file are moderately complex, but the
  6. idea behind it is simple: don't bother storing the parts of a
  7. frame that are the same as the last frame.  Not only does this
  8. save space, but it's very quick.  It's faster to leave a pixel
  9. alone than to set it.
  10.  
  11.      A FLI file has a 128-byte header followed by a sequence of
  12. frames. The first frame is compressed using a bytewise run-length
  13. compression scheme.  Subsequent frames are stored as the
  14. difference from the previous frame.  (Occasionally the first
  15. frame and/or subsequent frames are uncompressed.)  There is one
  16. extra frame at the end of a FLI which contains the difference
  17. between the last frame and the first frame.
  18.  
  19.      The FLI header:
  20.  
  21.      byte size name      meaning
  22.      offset
  23.  
  24.      0    4    size      Length of file, for programs that want
  25.                          to read the FLI all at once if possible.
  26.      4    2    magic     Set to hex AF11.  Please use another
  27.                          value here if you change format (even to
  28.                          a different resolution) so Autodesk
  29.                          Animator won't crash trying to read it.
  30.      6    2    frames    Number of frames in FLI.  FLI files have
  31.                          a maxium length of 4000 frames.
  32.      8    2    width     Screen width (320).
  33.      10   2    height    Screen height (200).
  34.      12   2    depth     Depth of a pixel (8).
  35.      14   2    flags     Must be 0.
  36.      16   2    speed     Number of video ticks between frames.
  37.      18   4    next      Set to 0.
  38.      22   4    frit      Set to 0.
  39.      26   102  expand    All zeroes -- for future enhancement.
  40.  
  41.      Next are the frames, each of which has a header:
  42.  
  43.      byte size name      meaning
  44.      offset
  45.      0    4    size      Bytes in this frame.  Autodesk Animator
  46.                          demands that this be less than 64K.
  47.      4    2    magic     Always hexadecimal F1FA
  48.      6    2    chunks    Number of 'chunks' in frame.
  49.      8    8    expand    Space for future enhancements.  All
  50.                          zeros.
  51.  
  52.      After the frame header come the chunks that make up the
  53. frame.  First comes a color chunk if the color map has changed
  54. from the last frame.  Then comes a pixel chunk if the pixels have
  55. changed.  If the frame is absolutely identical to the last frame
  56. there will be no chunks at all.
  57.  
  58.      A chunk itself has a header, followed by the data.  The
  59. chunk header is:
  60.  
  61.      byte size name meaning
  62.      offset
  63.      0    4    size Bytes in this chunk.
  64.      4    2    type Type of chunk (see below).
  65.  
  66.      There are currently five types of chunks you'll see in a FLI
  67. file.
  68.  
  69.      number    name      meaning
  70.      11        FLI_COLOR Compressed color map
  71.      12        FLI_LC    Line compressed -- the most common type
  72.                          of compression for any but the first
  73.                          frame.  Describes the pixel difference
  74.                          from the previous frame.
  75.      13        FLI_BLACK Set whole screen to color 0 (only occurs
  76.                          on the first frame).
  77.      15        FLI_BRUN  Bytewise run-length compression -- first
  78.                          frame only
  79.      16        FLI_COPY  Indicates uncompressed 64000 bytes soon
  80.                          to follow.  For those times when
  81.                          compression just doesn't work!
  82.  
  83.      The compression schemes are all byte-oriented.  If the
  84. compressed data ends up being an odd length a single pad byte is
  85. inserted so that the FLI_COPY's always start at an even address
  86. for faster DMA.
  87.  
  88. FLI_COLOR Chunks
  89.      The first word is the number of packets in this chunk. This
  90. is followed directly by the packets.  The first byte of a packet
  91. says how many colors to skip.  The next byte says how many colors
  92. to change.  If this byte is zero it is interpreted to mean 256. 
  93. Next follows 3 bytes for each color to change (one each for red,
  94. green and blue).
  95.  
  96. FLI_LC Chunks
  97.      This is the most common, and alas, most complex chunk.   The
  98. first word (16 bits) is the number of lines starting from the top
  99. of the screen that are the same as the previous frame. (For
  100. example, if there is motion only on the bottom line of screen
  101. you'd have a 199 here.)  The next word is the number of lines
  102. that do change.  Next there is the data for the changing lines
  103. themselves.  Each line is compressed individually; among other
  104. things this makes it much easier to play back the FLI at a
  105. reduced size.
  106.  
  107.      The first byte of a compressed line is the number of packets
  108. in this line.  If the line is unchanged from the last frame this 
  109. is zero.  The format of an individual packet is:
  110.  
  111. skip_count
  112. size_count
  113. data
  114.  
  115.      The skip count is a single byte.  If more than 255 pixels
  116. are to be skipped it must be broken into 2 packets. The size
  117. count is also a byte.  If it is positive, that many bytes of data
  118. follow and are to be copied to the screen.  If it's negative a
  119. single byte follows, and is repeated -skip_count times.
  120.  
  121.      In the worst case a FLI_LC frame can be about 70K.  If it
  122. comes out to be 60000 bytes or more Autodesk Animator decides
  123. compression isn't worthwhile and saves the frame as FLI_COPY.
  124.  
  125. FLI_BLACK Chunks
  126.      These are very simple.  There is no data associated with
  127. them at all. In fact they are only generated for the first frame
  128. in Autodesk Animator after the user selects NEW under the FLIC
  129. menu.
  130.  
  131. FLI_BRUN Chunks
  132.      These are much like FLI_LC chunks without the skips.  They
  133. start immediately with the data for the first line, and go line-
  134. by-line from there.  The first byte contains the number of
  135. packets in that line.  The format for a packet is:
  136.  
  137. size_count
  138. data
  139.  
  140.      If size_count is positive the data consists of a single byte
  141. which is repeated size_count times. If size_count is negative
  142. there are -size_count bytes of data which are copied to the
  143. screen. In Autodesk Animator if the "compressed" data shows signs
  144. of exceeding 60000 bytes the frame is stored as FLI_COPY instead.
  145.  
  146. FLI_COPY Chunks
  147.      These are 64000 bytes of data for direct reading onto the
  148. screen.
  149.  
  150. -----------------------------------------------------------------------
  151. And here's the PRO extensions:
  152. -----------------------------------------------------------------------
  153.  
  154. This is supplemental info on the AutoDesk Animator FLI and FLC formats.
  155.  
  156. The following is an attempt at describing the newer chunks and frames
  157. that are not described in the Turbo C FLI library documentation.
  158.  
  159.   Chunk type       Chunk ID 
  160.   ----------       -----------
  161.   FLI_DELTA        7 (decimal)
  162.   
  163.   First WORD (16 bits) is the number of compressed lines to follow.  Next
  164.   is the data for the changing lines themselves, always starting with the
  165.   first line.   Each line is compressed individually.
  166.  
  167.   The first WORD (16 bits) of a compressed line is the number of packets in
  168.   the line.  If the number of packets is a negative skip -packets lines.
  169.   If the number of packets is positive, decode the packets.  The format of
  170.   an individual packet is:
  171.  
  172.   skip_count
  173.   size_count
  174.   data
  175.  
  176.   The skip count is a single byte.  If more than 255 pixels are to be
  177.   skipped, it must be broken into 2 packets.  The size_count is also a byte.
  178.   If it is positive, that many WORDS of data follow and are to be copied to
  179.   the screen.  If it is negative, a single WORDS value follows, and is to be
  180.   repeated -size_count times.
  181.  
  182.   Chunk type       Chunk ID 
  183.   ----------       -----------
  184.   FLI_256_COLOR    4 (decimal)
  185.  
  186.   The first WORD is the number of packets in this chunk.  This is followed
  187.   directly by the packets.  The first byte of a packet is how many colors
  188.   to skip.  The next byte is how many colors to change.  If this number is
  189.   0, (zero), it means 256.  Next follow 3 bytes for each color to change.
  190.   (One each for red, green and blue).
  191.  
  192.   The only difference between a FLI_256_COLOR chunk (type 4 decimal) and a
  193.   FLI_COLOR chunk (type 11 decimal) is that the values in the type 4 chunk
  194.   range from 0 to 255, and the values in a type 11 chunk range from 0 to 63.
  195.  
  196.   NOTE:  WORD  refer to a 16 bit int in INTEL (Little Endian) format.
  197.          WORDS refer to two-bytes (16 bits) of consecutive data. (Big Endian)
  198.  
  199.   .FLC special frames and chunks
  200.  
  201.   FLC's may contain all the above chunks plus one other:
  202.  
  203.   Chunk type       Chunk ID 
  204.   ----------       -----------
  205.   FLI_MINI         18 (decimal) 12 (Hex)
  206.  
  207.   From what I understand,  this is a miniture 64 x 32 version of the first
  208.   frame in FLI_BRUN format, used as an button for selecting flc's from
  209.   within Animator Pro.  Simply do nothing with this chunk.
  210.  
  211.   FLC New Frame
  212.  
  213.   FLC's also contains a frame with the magic bytes set to hex 00A1.  This
  214.   is the first frame in the .flc file.  Actually it isn't a frame at all
  215.   but to have several chunks within it that specify file location info
  216.   specific to Animator Pro.  IE:  filepath, font to use, and .COL file info.
  217.   This FRAME may be skipped while loading.  That's right!  Ignore it!  The
  218.   frame header is the same length as all other frames.  So you may read the
  219.   frame header, then skip past the rest of the frame.
  220.  
  221.  
  222.   NOTE:  When reading the FLI header on the newer FLI and FLC files, the
  223.   FLI signature bytes are AF12 instead of AF11 used in the older FLI files.
  224.   Also, you cannot ignore the screen width and height they may not be
  225.   320 x 200.
  226.  
  227.   Allowable screen sizes include:
  228.  
  229.   320 x 200, 640 x 480, 800 x 600, 1280 x 1024
  230.  
  231.  
  232.   NOTE:  the delay value between frames appears to be in 1000th's of a
  233.   second instead of 70th's.
  234.  
  235. If you have any questions or more info on the FLI or FLC formats,
  236. please let me know.
  237.  
  238. Mike Haaland
  239.  
  240. CompuServe : 72300,1433
  241. Delphi     : MikeHaaland
  242. Internet   : mike@htsmm1.las-vegas.nv.us
  243. Usenet     : ...!htsmm1.las-vegas.nv.us!mike
  244.  
  245.