@Database "MPEGIntuition 2.2 documentation"
@Node Main "Main side"


                            MPEGIntuition 2.2

                              by Sauron 1995

                       for MP(1.03) and AMIPeg(0.4)
                      (both are available on Aminet)


                      1.@{"  What is MPEGIntuition   " link part1}
                      2.@{" Why I decide to write it " link part2}
                      3.@{"       Requirements       " link part3}
                      4.@{"       Installation       " link part4}
                      5.@{"          Usage           " link part5}
                      6.@{"       Error report       " link part6}
                      7.@{"    Special thanks to     " link part7}
                      8.@{"         My address       " link part8}
                    -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
                      9.@{"         Agnen doc        " link part9}

@EndNode

@Node part1 "What is MPEGIntuition"

   It's a small (but it takes a lot of memory :) ) GUI for MPEG players.
   MPEGIntuition is created for MP (Michael Van Elst) and Amipeg (
   Michael Rausch & Miroslaw Smyk) to make more easy playing MPEG anim.
   You need only to click and done. Without cli commands and two lines
   long arg. line. Now you can also play sound simultanously with anim!!!

   Now something that I have to write :

   MPEGIntuition is Freeware so you can copy it and do what do you want :)

      I DON'T TAKE ANY RESPONSIBILITY OF DAMAGED MADE BY THIS PROGRAM

   All bugs report send also on my @{"E-Mail address" link part8} or ... PHONE ?????
                       (nope better don't do that )

@EndNode

@Node part2 "Why I decide to write it"
 
   See @{"paragraph 1" link part0} and you will understand why :) (I hope)


@EndNode

@Node part3 "Requirements"

    - To start MPEGIntuition you will need an MP (1.03 ver) of course,
      and (or) AMIPeg (0.4 ver or better) (that is MPEG_play command)
      both from AMINET, if you want to play saounds you should also
      find program to play samples or MPEG audio.
    - kickstart 2.0 or higher (I guess that with GadTools.library
                               for 1.3 it will work on that system
                               but I can't check it)
    - ReqTools library , GadTools.library, delay program in C: dir
    - About 90 KB memory for MPEGIntuition (50KB for MPEGIntuition
      rest for ReqTools library)
      and about 20 KB for Agnen (if you like) also lot of memory
      for MP or Amipeg (more = better) :))
    - A fast computer :)


@Endnode

@Node part4 "Installation"
   
   How to install MPEGIntuition ??

   - You just need to put the MPEGIntuition (and it's icon of course) in one
     of your HD directories (You can put it on a floppy disk - if you don't
     have a HD, but you should have a lot of memory and use RAM option).

   - You should also copy 'delay' program to your c: dir
     (thats is some kind of better 'wait' command)

   - Then you MUST change the default path for anims and MP & Amipeg
     in the icon tooltype.

     X_WIN & Y_WIN - Top, left corner of the MPEGIntuition window
    ex. X_WIN=100
        Y_WIN=100

     MP_PATH - YOU MUST modify that line. You should type the whole path
               to MP procedure with it's name. (mp)
    ex. MP_PATH=Tools:MPEG/mp

     AP_PATH - YOU MUST modify that line. You should type the whole path
               to Amipeg procedure with it's name (MPEG_Play)
    ex. AP_PATH=Tool:MPEG/mpeg_play

     SM_PATH - full path to sample player with name.
    ex. SM_PATH=Tools:MPEG/XPlay

     SM_FORM - there I should write example.
   If player (SFX) need some arg. on line than:
   SM_FORM should have all that you normaly write after
   name of program and instead of the name of sample write {f}.

   example: if from cli you write
   10.System> C:xplay VOLUME=64 RATE=43 DH1:Data/sample/yeloo.8svx

   so SM_FORM should look like that:
   SM_FORM=VOLUME=64 RATE=43 {f}
   in place of {f} MPEGIntuition will put full name of sample.

     MP_DITHER - start (default) dither type (name only)
                 REMEMBER - UPPER_CASE
    ex. MP_DITHER=MBORDERED

     MP_RAM , MP_NOP , MP_NOB , MP_LOOP - YES/NO bool expressions
                 to initial checkbox (look for more information below)
    ex. MP_RAM=NO
        MP_NOP=YES
        MP_NOB=NO
        MP_LOOP=YES

     SM_SAMPLEPATH - directory wher you have your SFX data :)
    ex. MP_SAMPLEPATH=Tools:Sounds

     SM_SAMPLENAME - name of the sound (from SM_SAMPLEPATH dir)
     that is use as default in MPEGIntuition.
    ex. SM_SAMPLENAME=yeloo.8svx

     MP_ANIMPATH - Directory where you have your's mpeg anims
    ex. MP_ANIMPATH=Tools:MPEG

     MP_ANIMNAME - Name of the default anim (that means that if you
                   run MPEGIntuition and push Start you will see 
                   that anim :)  )
    ex. MP_ANIMNAME=mickeymouse.mpeg

     
    TOPAZ=<YES/NO> Should the program use Topaz font or Workbench default
                   fonts
           
            REMEMBER if your WorkBench have default fonts other
             then 8x8 pixels MPEGIntuition will look nasty !!

@Endnode

     
@Node part5 "Usage"
   
   How to start ??
   - Just double-click on MPEGIntuition icon and that's it !!!
     (If there is something wrong, see doc : @{"Error report" link part6})
   
   How to use it ??
   - If you used MP before, you won't have any problems to use that 
     program (excluding RAM options - that's my innovation )
     If you are using it for the first time, you should read the entire doc! :]


   What are the gadgets for ??
   
   - As you can see (I hope) there are four main parts of the window
     

              MPEG Info         Dither Type
        ______________________________________
        |                    |@{"Gray8         " link part66}||
        | @{"000" link part51} X SIZE Y @{"000" link part52}  |@{"Gray          " link part66}||
        |                    |@{"HAM8          " link part66}||
        | Time @{"00000.00000" link part53}   |@{"HAM6          " link part66}||
        |                    |@{"Color         " link part66}||
        | Frame/s @{"00.00000" link part54}   |@{"2x2           " link part66}||
        |                    |@{"Mbordered     " link part66}||
        | Frame/b @{"000.0000" link part55}   |@{"Threshold     " link part66}||
        |                    |@{"Hybrid        " link part66}||
        | Compress @{"00:00.0" link part56}   |@{"Hybrid2       " link part66}||
        |                    |@{"Ordered       " link part66}||
        | KB @{"0000" link part57}  Fr.@{"0000" link part58}  |@{"Ordered2      " link part66}||
        |--------------------+---------------+|
        |@{"        " link part59}     RAM @{"  " link part61} @{"  " link part64} NOP   @{"About" link part69} |
        |@{"  PLAY  " link part59}                            |
        |@{"        " link part59}    LOOP @{"  " link part62} @{"  " link part63} NOB   @{"SAVE " link part65} |
        |-------------------------------------|
        |                File                 |
        | @{"L" link part67} @{"DH1:mpeg/DuneMovie.mpeg      " link part60} @{"D" link part68} |
        +-------------------------------------+


  (I know that that picture looks not too good but there is no
   other way to paint something like this under AmigaGuide)

@Endnode

@Node part6 "Error report"
       
      1. can't find MP program - check path in MPEGIntuition icon (there's
                                       something wrong)

      2. can't find Amipeg program - see first error. (IF you don't have
                                 MP program, MPEGint. won't gone run
                                 because it mainly use MP to all options
                                 but without Amipeg you won't be able 
                                 only to use AMP_#? filters)

      3. unknown dither type ... - you written something wrong in
                                  the icon (check MP_DITHER for correct
                                  of dither name !!)

      4. Sorry no icon.library   - check if you have icon.library in your
                                   libs: directory. If no , than copy it
                                   from Workbench disk !!

      5. You need to run this program under WB - that's mean that you
                                   can't run MPEGIntuition from CLI !!

      6 ... If sometimes you push PLAY and your Amiga won't
            show you enything (will back to MPEGIntuition) :

        - selected file is not MPEG file
          (Amipeg sometimes don't recognize some MPEG's)
        - there is no memory to run Amieg/MP
        - selected file doesn't exists on disk

      7 ... If there is no sound (but you set prefs before)

        - like before (there is no file or that file is not
          recognized by you player)
        - check player prefs in icon :)


@Endnode

@Node part7 "Special thanks"

                       Michael van Elst (for his MP)
               Michael Rausch & Miroslaw Smyk (for aMIPEG)
           Dudi , MAC , Lysy , Negativ/Eldritch, Frank Herbert (:))
               For their testing (Like always - not enough)

                         and Amiga E creators @#)

                  Parts of that Guide are from mp103.doc

@Endnode

@Node part8 "My adress"

                        Adrian (SAURON) Siemieniak
                             ul.Litewska 24m9
                              Wroclaw 51-354
                                  Poland

                        sauron@sco.zsi.pwr.wroc.pl
                       sauron@sun1000.ci.pwr.wroc.pl

              IRCnick : Sauron (#amigapl , #amiga , #rpg-pl)
@Endnode

@Node part9 "Agnen doc"

         Well... What the hell I should write here ???
      OK Agnen is a small program that sends via Signal()
            Control Break to MP / Amipeg task.
     It's very nasty for now but later (when can it be ???)
            I'll put it with main program :))
    Why not yet ?????
    Because it's not enough safety (can break not right task)
  and I don't know realy how I should integrate it with Intuition.
  
      Ohh yes one more thing , Amipeg will stop playing MPEG
                   a few seconds later then MP
  (that because he check signal when he is reading MPEG from disk)

  Now how to use it :
   Simply run it from Shell or WB and voila !!
   There is TERMAINATE button to break MP/Amipeg
   And also task ID : why it's here - if you run MPEGIntuition
                      and look only MPEGs,you don't need to look
                      at it.
                      But if you start playing MPEG Anim and run
                      other task check if the numbers doesn't change,
                      if so DON'T use TERMINATE (it break not right
                      task) 
            
              How to use it !! When run MPEGIntuition and push PLAY
              click mouse on Agnen window (the number will change
              and it will be remember) if you run another task,
              click once again if number change you know to
              not push TERMINATE :))


@Endnode
@Node part51 "X size"

 Show the X (horizontal) size of frame

@EndNode
@Node part52 "Y size"

 Show the Y (vertical) size of frame

@EndNode
@Node part53 "Time"

 Show the whole time from pressing PLAY button til end
            (including initialization)

@EndNode
@Node part54 "Frequency"

 Show how many frames can display MP or Amipeg on your machine
                        per seccond

@EndNode
@Node part55 "Frame size"

 Show how many bytes have a single frame of anim

@EndNode
@Node part56 "Compress ratio"

 Show the anim commpress ratio (ex. 1:35.43)

@EndNode
@Node part57 "Anim size"

 Show the length on animation in KB (this is the length of whole file)

@EndNode
@Node part58 "Frames"

 Show how many frames have the animation

@EndNode
@Node part59 "Play button"

 Start to play MPEG animation

 If there only for e few secconds gadgets became disabled and nothing
 happend (no screen with anim) there can be wrong :

 1) File is not recognized as MPEG Anim (Amipeg can't show a part of
    anims with differend header - try than MP)
 2) MP or Amipeg cannont allocate memory for buffer or screen
 3) There is some bug in my progam (Ohh Shai-hulud please no !!!)
    then contact with me (@{" Adress " link part8})

@EndNode
@Node part60 "Text gadget"

 Here is always visible name of last sellected animation by @{"load button" link part67}
            You can also write here the name by keyboard
 
                          REMEMBER !!!!! 
     All operation are make on file specified in that gadget

@EndNode
@Node part61 "RAM check"

  If marked MPEGIntuition after pushing the @{"PLAY" link part59} button
             will copy animation to RAM and than play it.
      
         MPEGIntuition doesn't check if animation fit in RAM

 Why I made that option : Simply when I play MPEG from HD and it's about
                          6 (and more) frames per seccond you can 
                          see smal stops. (MP and Amipeg read than anim
                          from HD or disk)

@EndNode
@Node part62 "LOOP check"

  If marked MPEGIntuition will ask to write number of cycling the anim
  (I know that doesn't look to good but I can't use MP loop function
   because the only way of ending it is send CTRL+D signal to it)
  When the Agnen program will be more friendly i'll try to make both
                         kind of loops.

@EndNode
@Node part63 "NOB check"

  causes the player to ignore and not display B 
         (bothway interpolated) frames.

@EndNode
@Node part64 "NOP check"

 causes the player to ignore and not display P (predicted)
                      frames.
@EndNode
@Node part65 "Save button"

     Acivate SAVE module from MPEGIntuition and MP that produce single
                24 bit ILBM frames from selected anim 

  After pushing button appear small requester that remember you something
 verry important and after it you'll be asked to choose dir where the frames
    of anim be saved and then you have to write patter name of file.
   ex. "MyAnim.%%%.iff" in place of %%% MP will put number of current frame.
   Frame saved will be named like MyAnim.001.iff MyAnim.002.iff ....

@EndNode
@Node part66 "Dither list view"

Dither (all dither types used in MP procedure + Amipeg)
        If you want to know something more about every dither type see
        mp103.doc. I can only tell you about speed of that filters.
        And so : (the slowest one is 1 [ds]) - sorry for no gfx card
                                        results ( i don't have them )

   Speed factor   Dither name        ds amount (higher - better)

             2    @{"Gray8 (only AGA)" link part71} - 6.44 ds 
             1    @{"Gray            " link part72} - 7.27 ds  <--- Fastest
            15    @{"HAM8  (only AGA)" link part73} - 2.32 ds
             7    @{"HAM6            " link part74} - 3.87 ds
             4    @{"Color           " link part75} - 4.72 ds
            13    @{"2x2             " link part76} - 2.88 ds
             6    @{"MBordered       " link part77} - 4.00 ds
             3    @{"Threshold       " link part78} - 6.44 ds
            14    @{"Hybrid          " link part79} - 2.69 ds
            16    @{"Hybrid2         " link part80} - 2.06 ds
            12    @{"Ordered         " link part81} - 2.90 ds
             5    @{"Ordered2        " link part82} - 4.04 ds
            18    @{"FS2             " link part83} - 1.32 ds
            19    @{"FS2 Fast        " link part84} - 1.27 ds
            20    @{"FS4             " link part85} - 1.00 ds  <--- Slowest
             8    @{"MONO            " link part86} - 3.78 ds
            10    @{"AMP-color      *" link part87} - 3.51 ds  
             9    @{"AMP-ham6       *" link part88} - 3.72 ds
            11    @{"AMP-hiresham   *" link part89} - 2.97 ds
            17    @{"AMP-gray       *" link part90} - 1.96 ds
   
           * If you use that dither type, MPInt. will use Amipeg
             program)

  All above modes except for none, mono, threshold, gray, gray8, color, ham6
  and ham8 are paletted modes. On OCS/ECS machines this will produce an
  EXTRA_HALFBRITE display for the maximum number of colors. On AGA machines a
  256 color screen is used which produces a mucher better display. As written
  above, the gray8 mode is only available on AGA machines. The selection between
  gray and gray8 is not done automatic because the 16 graylevel mode is somewhat
  faster and some AGA users might want to trade display quality for speed.

@EndNode
@Node part67 "Load gadget"

  It's a load gadget !!! It let you to chose (via ReqTools) MPEG anim name
                 to later PLAY or SAVE functions.

@EndNode
@Node part68 "Delete gadget"

  Delete gadget !!! It delete ANIM from disk (before deleting you have to
                            confirm that action)

@EndNode
@Node part69 "About gadget"

  Eeee hard to guess ????

@EndNode
@Node part71 "Gray 8"

  Grayscale dithering with 256 grayscales (AGA only).

@EndNode
@Node part72 "Gray"

  Grayscale dithering. The image is dithered into 16
                      grayscales. Chrominance information is thrown away.

@EndNode
@Node part73 "HAM8"

  'True' color display using HAM approximation. In HAM8
                      mode you have a 18bit color palette for a maximum of 256k
                      colors produced by mp. This mode produces finer gradients
                      than ham6 but it is significantly slower.

@EndNode
@Node part74 "HAM6"

  'True' color display using HAM approximation. For each
                      pixel either red, green or blue are set correctly and
                      the other color components are the same as the pixel to
                      the left. As the name implies this uses the 6bit HAM mode
                      and is limited to 4096 possible colors.

@EndNode
@Node part75 "Color"

  'True' color display with 4 bits luminance and 2*2 bits
                      for chrominance.

@EndNode
@Node part76 "2x2"

  A dithering technique using a 2x2 pixel area for each
                      pixel. The image displayed is 4 times larger than the
                      original image encoded. Random error terms are added to
                      each pixel to break up contours and gradients.

@EndNode
@Node part77 "MBordered"

  ordered dithering at the macroblock level.

@EndNode
@Node part78 "Threshold"

  Simple thresholding in black and white.

@EndNode
@Node part79 "Hybrid"

  Hybrid dithering, a combination of ordered dithering for
                      luminance and fs2 dithering for chrominance. Errors are
                      not propagated properly.

@EndNode
@Node part80 "Hybrid2"

  Hybrid dithering with error propagation among pixels.

@EndNode
@Node part81 "Ordered"

  use simple ordered dithering

@EndNode
@Node part82 "Ordered2"

   a faster ordered dither. This is the default.

@EndNode
@Node part83 "FS2"

  Floyd-Steinberg dithering with 2 error values propagated

@EndNode
@Node part84 "FS2 FAST"

  a faster @{" fs2 " link part83}

@EndNode
@Node part85 "FS4"

  Floyd-Steinberg dithering with 4 error values propagated

@EndNode
@Node part86 "MONO"

  Floyd-Steinberg dithering in black and white.

@EndNode
@Node part87 "AMP-color"
@EndNode
@Node part88 "AMP-ham6"
@EndNode
@Node part89 "AMP-hiresham"
@EndNode
@Node part90 "AMP-hiresham"
@EndNode
