home *** CD-ROM | disk | FTP | other *** search
/ The Best of Mecomp Multimedia 2 / MECOMP-CD-II.iso / amiga / datatypes / cdxl_datatype / cdxl.datatype.doc next >
Encoding:
Text File  |  1998-02-06  |  6.9 KB  |  196 lines
  1. TABLE OF CONTENTS
  2.  
  3. cdlx.datatype/MAIN
  4. cdxl.datatype/--datasheed--
  5. cdxl.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.         (Not implemented yet).
  34.  
  35.     INSTALLATION
  36.         After unpacking this archive:
  37.         Because this version does not include an Installer script, you have
  38.         to do the installation manually through the shell:
  39.  
  40.           - Unpack this archive and copy the "cdxl.datatype" to
  41.             SYS:Classes/DataTypes:
  42.  
  43.      Copy CLONE FROM "cdxl.datatype" TO "SYS:Classes/DataTypes/cdxl.datatype"
  44.  
  45.           - Then copy the datatypes descriptor into the DEVS:DataTypes
  46.             directory.
  47.             If the descriptor already exists, you should not replace it,
  48.             otherwise you may loose "toolnodes" and other settings stored in
  49.             the existing descriptor.
  50.  
  51.      Copy CLONE FROM "CDXL(%|.info)" TO DEVS:Datatypes/
  52.  
  53.     SOURCE
  54.         Partial source is included as an KISS example how to write an
  55.         animation.datatype subclass.
  56.  
  57.     AUTHOR
  58.         If you want to blame me, report any bugs, or wants a new version
  59.         send your letter to:
  60.                         Roland Mainz
  61.                         Hohenstaufenstraße 8
  62.                         52388 Nörvenich
  63.                         GERMANY
  64.  
  65.         Phone: (+49)(0)2426/901568
  66.         Fax:   (+49)(0)2426/901569
  67.  
  68.         EMAIL is also available (if you want to send me attachments
  69.         larger than 1MB (up to 5MB, more with my permission):
  70.  
  71.         GISBURN@w-specht.rhein-ruhr.de
  72.  
  73.         Up to April 1998 I'm reachable using this email address, too:
  74.         Reinhold.A.Mainz@KBV.DE
  75.  
  76.         | Please put your name and address in your mails !
  77.         | German mailers should add their phone numbers.
  78.         | See BUGS section above when submitting bug reports.
  79.  
  80.         Sorry, but I can only look once a week for mails.
  81.         If you don't hear something from me within three weeks, please
  82.         send your mail again (but watch about new releases) (problems with
  83.         this email port are caused by reconfigurations, hackers, network
  84.         problems etc.).
  85.  
  86.         The  entire  "cdxl.datatype"  package  may  be  noncommercially
  87.         redistributed, provided  that  the package  is always  distributed
  88.         in it's complete  form (including it's documentation). A small
  89.         copy fee  for media costs is okay but any kind of commercial
  90.         distribution is strictly forbidden without my permission !
  91.         Comments and suggestions how to improve this program are
  92.         generally appreciated!
  93.  
  94.         Thanks to David Junod, who wrote the animation.datatype and lots of
  95.         the datatypes example code, Matt Dillon for his DICE, Olaf 'Olsen' 
  96.         Barthel for his help, ideas and some text clips from his 
  97.         documentations.
  98.  
  99. cdxl.datatype/--datasheed--                       cdxl.datatype/--datasheed--
  100.  
  101.    NAME
  102.        cdxl.datatype -- data type for CDXL movies
  103.  
  104.    SUPERCLASS
  105.        animation.datatype
  106.  
  107.    DESCRIPTION
  108.        The cdxl datatype, a sub-class of the animation.datatype, is used to
  109.        load and play CDXL movies.
  110.  
  111.    METHODS
  112.        OM_NEW -- Create a new movie object from a description file. The
  113.            source may be a file or you may create an empty object (DTST_RAM).
  114.  
  115.        OM_DISPOSE -- Dispose instance and contents (frames, colormaps, sounds
  116.            etc.), then pass msg to superclass.
  117.  
  118.        OM_UPDATE -- Perform an ICM_CHECKLOOP check, and if succesfull, the
  119.            method will be executed like OM_SET downstairs.
  120.  
  121.        OM_SET -- Pass msg to superclass and call GM_RENDER if retval from
  122.            superclass was != 0UL.
  123.  
  124.        DTM_WRITE -- Save object's contents in local (CDXL) or
  125.            superclass (IFF ILBM) format.
  126.            (Encoder not implemented yet).
  127.  
  128.        ADTM_START -- Start playback. cdxl.datatype prepares itself to start
  129.            at the given timestamp and then passes the msg to superclass.
  130.  
  131.        ADTM_LOADFRAME -- Fill in struct adtFrame with requested information
  132.            from internal FrameNode list like bitmap, colormap and sample. If
  133.            the bitmap information is not loaded yet, it will be loaded from
  134.            disk.
  135.  
  136.        ADTM_UNLOADFRAME -- Free resources obtained by ADTM_UNLOADFRAME.
  137.  
  138.        All other methods are passed unchanged to superclass.
  139.  
  140.    ATTRIBUTES
  141.        Following attributes are set by the object and are READ-ONLY for
  142.        applications:
  143.        DTA_ObjName             -- set by file name (same as DTA_Name)
  144.        DTA_TotalVert           -- set by PAN section
  145.        DTA_TotalHoriz          -- set by PAN section
  146.        ADTA_Width              -- set by PAN section
  147.        ADTA_Height             -- set by PAN section
  148.        ADTA_Depth              -- set by PAN section
  149.        ADTA_ModeID             -- set by PAN section
  150.        ADTA_Frames             -- number of frames in the movie
  151.        ADTA_FramesPerSecond    -- FPS rate
  152.        ADTA_KeyFrame           -- Key frame of movie
  153.  
  154.    BUGS
  155.        None known yet.
  156.  
  157.    TODO
  158.        - Fixing the bugs above.
  159.  
  160.        - Write the "--input_format--"-Autodoc section.
  161.  
  162.    HISTORY
  163.        V1.1
  164.          Released to the Waldspecht-BBS for testing.
  165.  
  166.        V1.2
  167.          - Fixed the bug that ADTM_START/ADTM_LOADFRAME seek'ed outside
  168.            the file bounds if a alf_TimeStamp larger than ADTA_NumFrames
  169.            was given. Now both methods does bounds checking and
  170.            in the case of ADTM_LOADFRAME alf_Frame returns the timestamp
  171.            which was really loaded.
  172.            Fixed.
  173.  
  174.  
  175.    SEE ALSO
  176.        animation.datatype,
  177.        mpegsystem.datatype, mpegvideo.datatype,
  178.        picmovie.datatype,
  179.        anim.datatype. avi.datatype, quicktime.datatype,
  180.        moviesetter.datatype,
  181.        film.datatype,
  182.        directory.datatype,
  183.        markabletextdtclass
  184.  
  185. cdxl.datatype/--input_format--                 cdxl.datatype/--input_format--
  186.  
  187.     NAME
  188.         CDXL --
  189.  
  190.     DESCRIPTION
  191.         <Not written yet, sorry>
  192.  
  193.  
  194.     SEE ALSO
  195.  
  196.