home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 106 / af106sub.adf / datatypes.LZX / cdxl_datatype / cdxl.datatype.doc < prev    next >
Text File  |  2005-09-11  |  7KB  |  192 lines
  1. TABLE OF CONTENTS
  2.  
  3. cdlx.datatype/MAIN
  4. cdxl.datatype/--datasheed--
  5. movie.datatype/--input_format--
  6. cdlx.datatype/MAIN                                         cdlx.datatype/MAIN
  7.  
  8.     INTRODUCTION
  9.  
  10.     REQUIREMENTS
  11.         - You need at least Kick/WB 3.0.
  12.           | Many people wrote me that they cannot find an
  13.           | "animation.datatype" class.
  14.           | Only the 3.1 release contains it. (Subclasses of)
  15.           | animation.datatype can run under 3.0.
  16.  
  17.         - "datatypes/animation.datatype", >= V39.
  18.           "animation.datatype 40.7 (28.09.93)" requires itself some
  19.           libraries/boopsi classes:
  20.         - "realtime.library", >= V39              - for timing
  21.         - "gadgets/tapedeck.gadget" (any version) - for the controls
  22.  
  23.     USAGE
  24.         If the datatypes descriptor file was activated, any attempt to load
  25.         an CDXL stream using GMultiView, MultiView, AmigaGuide or
  26.         SwitchWindow will load and play the movie.
  27.  
  28.         If you want to save the current movie in cdxl.datatype's local
  29.         format, use MultiView's "Project/Save As..." menu (or GMultiView's
  30.         "Project/Save As Raw...").
  31.         cdxl.datatype saves the current movie, stating with the current
  32.         frame as a CDXL stream.
  33.  
  34.     INSTALLATION
  35.         After unpacking this archive:
  36.         Because this version does not include an Installer script, you have
  37.         to do the installation manually through the shell:
  38.  
  39.           - Unpack this archive and copy the "cdxl.datatype" to
  40.             SYS:Classes/DataTypes:
  41.  
  42.      Copy CLONE FROM "cdxl.datatype" TO "SYS:Classes/DataTypes/cdxl.datatype"
  43.  
  44.           - Then copy the datatypes descriptor into the DEVS:DataTypes
  45.             directory.
  46.             If the descriptor already exists, you should not replace it,
  47.             otherwise you may loose "toolnodes" and other settings stored in
  48.             the existing descriptor.
  49.  
  50.      Copy CLONE FROM "CDXL(%|.info)" TO DEVS:Datatypes/
  51.  
  52.     SOURCE
  53.         Partial source is included as an KISS example how to write an
  54.         animation.datatype subclass.
  55.  
  56.     AUTHOR
  57.         If you want to blame me, report any bugs, or wants a new version
  58.         send your letter to:
  59.                         Roland Mainz
  60.                         Hohenstaufenstraße 8
  61.                         52388 Nörvenich
  62.                         GERMANY
  63.  
  64.         Phone: (+49)(0)2426/901568
  65.         Fax:   (+49)(0)2426/901569
  66.  
  67.         EMAIL is also available (if you want to send me attachments
  68.         larger than 1MB (up to 5MB, more with my permission):
  69.  
  70.         GISBURN@w-specht.rhein-ruhr.de
  71.  
  72.         Up to December 1997 I'm reachable using this email address, too:
  73.         Reinhold.A.Mainz@KBV.DE
  74.  
  75.         | Please put your name and address in your mails !
  76.         | German mailers should add their phone numbers.
  77.         | See BUGS section above when submitting bug reports.
  78.  
  79.         Sorry, but I can only look once a week for mails.
  80.         If you don't hear something from me within three weeks, please
  81.         send your mail again (but watch about new releases) (problems with
  82.         this email port are caused by reconfigurations, hackers, network
  83.         problems etc.).
  84.  
  85.         The  entire  "cdxl.datatype"  package  may  be  noncommercially
  86.         redistributed, provided  that  the package  is always  distributed
  87.         in it's complete  form (including it's documentation). A small
  88.         copy fee  for media costs is okay but any kind of commercial
  89.         distribution is strictly forbidden without my permission !
  90.         Comments and suggestions how to improve this program are
  91.         generally appreciated!
  92.  
  93.         Thanks to David Junod, who wrote the animation.datatype and lots of
  94.         the datatypes example code, Matt Dillon for his DICE, Olaf 'Olsen' 
  95.         Barthel for his help, ideas and some text clips from his 
  96.         documentations.
  97.  
  98. cdxl.datatype/--datasheed--                       cdxl.datatype/--datasheed--
  99.  
  100.    NAME
  101.        cdxl.datatype -- data type for CDXL movies
  102.  
  103.    SUPERCLASS
  104.        animation.datatype
  105.  
  106.    DESCRIPTION
  107.        The cdxl datatype, a sub-class of the animation.datatype, is used to
  108.        load and play CDXL movies.
  109.  
  110.    METHODS
  111.        OM_NEW -- Create a new movie object from a description file. The
  112.            source may be a file or you may create an empty object (DTST_RAM).
  113.  
  114.        OM_DISPOSE -- Dispose instance and contents (frames, colormaps, sounds
  115.            etc.), then pass msg to superclass.
  116.  
  117.        OM_UPDATE -- Perform an ICM_CHECKLOOP check, and if succesfull, the
  118.            method will be executed like OM_SET downstairs.
  119.  
  120.        OM_SET -- Pass msg to superclass and call GM_RENDER if retval from
  121.            superclass was != 0UL.
  122.  
  123.        DTM_WRITE -- Save object's contents in local (CDXL) or
  124.            superclass (IFF ILBM) format.
  125.  
  126.        ADTM_START -- Start playback.
  127.  
  128.        ADTM_PAUSE -- Pause playback.
  129.  
  130.        ADTM_STOP -- Stop playback.
  131.  
  132.        ADTM_LOADFRAME -- Fill in struct adtFrame with requested information
  133.            from internal FrameNode list like bitmap, colormap and sample. If
  134.            the bitmap information is not loaded yet, it will be loaded from
  135.            disk.
  136.  
  137.        ADTM_UNLOADFRAME -- Free resources obtained by ADTM_UNLOADFRAME.
  138.  
  139.        All other methods are passed unchanged to superclass.
  140.  
  141.    ATTRIBUTES
  142.        Following attributes are set by the object and are READ-ONLY for
  143.        applications:
  144.        DTA_ObjName             -- set by file name (same as DTA_Name)
  145.        DTA_TotalVert           -- set by PAN section
  146.        DTA_TotalHoriz          -- set by PAN section
  147.        ADTA_Width              -- set by PAN section
  148.        ADTA_Height             -- set by PAN section
  149.        ADTA_Depth              -- set by PAN section
  150.        ADTA_ModeID             -- set by PAN section
  151.        ADTA_Frames             -- number of frames in the movie
  152.        ADTA_FramesPerSecond    -- FPS rate
  153.        ADTA_KeyFrame           -- Key frame of movie
  154.  
  155.    BUGS
  156.        - In large videos, the frames at the end will be played slower than
  157.          those at the beginning of the file. This is the result of the
  158.          sequential search internally used (only serious with more than 25000
  159.          frames (mc6030/50mhz)).
  160.          May or may not be fixed.
  161.  
  162.    TODO
  163.        - Fixing the bugs above.
  164.  
  165.        - Write the "--input_format--"-Autodoc section.
  166.  
  167.    HISTORY
  168.        V1.1
  169.          Released to the Waldspecht-BBS for testing.
  170.  
  171.    SEE ALSO
  172.        animation.datatype,
  173.        mpegsystem.datatype, mpegvideo.datatype,
  174.        picmovie.datatype,
  175.        anim.datatype. avi.datatype, quicktime.datatype,
  176.        moviesetter.datatype,
  177.        film.datatype,
  178.        directory.datatype,
  179.        markabletextdtclass
  180.  
  181. movie.datatype/--input_format--               movie.datatype/--input_format--
  182.  
  183.     NAME
  184.         CDXL --
  185.  
  186.     DESCRIPTION
  187.         <Not written yet, sorry>
  188.  
  189.  
  190.     SEE ALSO
  191.  
  192.