rpcodec.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:12k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _IMF_CODEC_H
  36. #define _IMF_CODEC_H
  37. typedef _INTERFACE IIMFCodecParse          IIMFCodecParse;
  38. typedef _INTERFACE IIMFCodecParseResponse  IIMFCodecParseResponse;
  39. typedef _INTERFACE IIMFCodecRender         IIMFCodecRender;
  40. typedef _INTERFACE IIMFCodecRenderResponse IIMFCodecRenderResponse;
  41. /****************************************************************************
  42.  *
  43.  *  Explanation of IIMFCodecParse/IIMFCodecParseResponse protocol
  44.  *
  45.  *  1. File Format calls IIMFCodecParse::GetCodecInfo() at initialization
  46.  *     time in order to find out what codecs are present and what
  47.  *     image formats can be handled.
  48.  *  2. File Format calls IIMFCodecParse::OpenParse() once at the beginning of
  49.  *     the presentation.
  50.  *  3. File Format calls IIMFCodecParse::CalculateDataSize() to get the codec
  51.  *     to calculate the amount of data which will be sent for a given file.
  52.  *  4. For each image that is scheduled to be parsed:
  53.  *     a) FileFormat calls IIMFCodecParse::StartImageParse()
  54.  *     b) Codec calls IIMFCodecParseResponse::StartImageParseDone()
  55.  *     c) File Format calls IIMFCodecParse::ParseImageData()
  56.  *     d) Codec calls IIMFCodecParseResponse::ParseImageDataDone().
  57.  *     e) If the bLastPacket parameter of ParseImageDataDone() is
  58.  *        FALSE, then the File Format goes to 3(c);
  59.  *        Else, the FileFormat calls IIMFCodecParse::FinishImageParse().
  60.  *     f) Codec calls IIMFCodecParseResponse::ImageParseFinished().
  61.  *  5. At the end of the presentation, File Format calls
  62.  *     IIMFCodecParse::CloseParse().
  63.  *
  64.  ****************************************************************************/
  65.  /****************************************************************************
  66.  *
  67.  *  Interface:          IIMFCodecParse
  68.  *
  69.  *  Purpose:            IMF Codec Parse Interface
  70.  *
  71.  *  IID_IIMFCodecParse: {65583BC1-44AC-11d1-A8BC-00A0C90826B9}
  72.  *
  73.  ****************************************************************************/
  74. DEFINE_GUID(IID_IIMFCodecParse, 0x65583bc1, 0x44ac, 0x11d1, 0xa8, 0xbc, 0x0,
  75.             0xa0, 0xc9, 0x8, 0x26, 0xb9);
  76. #define CLSID_IIMFCodecParse IID_IIMFCodecParse
  77. #undef  INTERFACE
  78. #define INTERFACE       IIMFCodecParse
  79. DECLARE_INTERFACE_(IIMFCodecParse, IUnknown)
  80. {
  81.     /*
  82.      * IUnknown methods
  83.      */
  84.     STDMETHOD(QueryInterface)   (THIS_ REFIID riid, void **ppvObj) PURE;
  85.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  86.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  87.     /*
  88.      * This method is used to determine what kinds of images this
  89.      * codec supports. The file format plug-in uses the file extensions strings
  90.      * and the render plug-in uses the mime-types strings
  91.      */
  92.     STDMETHOD(GetCodecInfo) (THIS_ REF(const char **) /*OUT*/ ppszFileExtensions,
  93.                                    REF(const char  *) /*OUT*/ ppszCodecMimeType,
  94.                                    REF(const char  *) /*OUT*/ pszCodecASMRules) PURE;
  95.     /*
  96.      * Methods called by FileFormat Plugin
  97.      */
  98.     /*
  99.      * OpenParse() should be called once for the entire IMF presentation. This method
  100.      * sets up several things needed for parsing:
  101.      *
  102.      * 1) Pointer to the .imf IHXFileObject (needed for IHXFileSystemManager::GetRelativeFileObject)
  103.      * 2) Pointer to the IIMFCodecResponse interface
  104.      * 3) String containing all the ASM rules for this presentation.
  105.      *
  106.      * This method is synchronous - an asynchronous response is not necessary.
  107.      */
  108.     STDMETHOD(OpenParse) (THIS_ IHXFileObject *         /*IN*/ pIMFFileObject,
  109.                                 IIMFCodecParseResponse * /*IN*/ pCodecResponse,
  110.                                 const char *             /*IN*/ pszASMRuleBook) PURE;
  111.     /*
  112.      * CloseParse() should be called once for the entire IMF presentation. This method
  113.      * informs the codec that it can release the interface pointers it addref'd
  114.      * in OpenParse().
  115.      *
  116.      * This method is synchronous - an asynchronous response is not necessary.
  117.      */
  118.     STDMETHOD(CloseParse) (THIS) PURE;
  119.     /*
  120.      * CalculateDataSize() is called once for every image file in an .imf file.
  121.      * 
  122.      * Note that this is called independent of StartImageParse() and any interfaces
  123.      * AddRef'd during CalculateDataSize() should be released after calling
  124.      * DataSizeCalculated().
  125.      */
  126.     STDMETHOD(CalculateDataSize) (THIS_ const char * /*IN*/ pszFileName,
  127.                                         UINT32       /*IN*/ ulDisplayWidth,
  128.                                         UINT32       /*IN*/ ulDisplayHeight) PURE;
  129.     /*
  130.      * StartImageParse() is called once for every image file in an .imf file and
  131.      * it initiates the parsing of a particular image file.
  132.      *
  133.      * This method is asynchronous and the response to this call is StartImageParseDone()
  134.      * in IIMFCodecResponse. An asynchronous reponse is necessary since StartImageParse()
  135.      * will cause the codec to initiate an asynchronous chain of file I/O calls.
  136.      */
  137.     STDMETHOD(StartImageParse) (THIS_ const char * /*IN*/ pszFileName,
  138.                                       ULONG32      /*IN*/ ulFileSize) PURE;
  139.     /*
  140.      * ParseImageData() will be called once a StartImageParseDone() is received from
  141.      * the codec with a successful status. ParseImageData() will also be called at
  142.      * every IHXFileFormatObject::GetPacket() call.
  143.      *
  144.      * This call is asynchronous, and the response is ParseImageDataReady() in
  145.      * IIMFCodecResponse. ParseImageDataReady() returns a packet with everything filled
  146.      * out in the IHXPacket object except the timestamp. The Codec cannot fill out
  147.      * the timestamp since it has no knowledge of the overall presentation, just this image.
  148.      */
  149.     STDMETHOD(ParseImageData) (THIS) PURE;
  150.     /*
  151.      * After seeing that the bLastPacket parameter of IIMFCodecResponse::ParseImageDataReady()
  152.      * is TRUE, it is the job of the FileFormat plugin to call FinishImageParse().
  153.      * This allows the Codec to free up any resources allocated during the parse
  154.      * of a particular image. The Codec will respond asynchronously with
  155.      * IIMFCodecResponse::ImageParseFinished().
  156.      */
  157.     STDMETHOD(FinishImageParse) (THIS) PURE;
  158. };
  159. /****************************************************************************
  160.  *
  161.  *  Interface:                  IIMFCodecParseResponse
  162.  *
  163.  *  Purpose:                    IMF Codec Parse Response Interface
  164.  *
  165.  *  IID_IIMFCodecParseResponse: {981FEC20-4584-11D1-B006-00A0243C2E90}
  166.  *
  167.  ****************************************************************************/
  168. DEFINE_GUID(IID_IIMFCodecParseResponse, 0x981fec20, 0x4584, 0x11d1, 0xb0, 0x6,  0x0,
  169.             0xa0, 0x24, 0x3c, 0x2e, 0x90);
  170. #define CLSID_IIMFCodecParseResponse IID_IIMFCodecParseResponse
  171. #undef  INTERFACE
  172. #define INTERFACE IIMFCodecParseResponse
  173. DECLARE_INTERFACE_(IIMFCodecParseResponse, IUnknown)
  174. {
  175.     /*
  176.      * IUnknown methods
  177.      */
  178.     STDMETHOD(QueryInterface)   (THIS_ REFIID riid, void **ppvObj) PURE;
  179.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  180.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  181.     /*
  182.      * IIMFCodecParseResponse methods
  183.      */
  184.     /*
  185.      * DataSizeCalculated() is the asynchronous response to
  186.      * IIMFCodecParse::CalcualteDataSize(). It informs the calling
  187.      * interface the size of the data to be transmitted for the
  188.      * specified image filename given in CalculateDataSize.
  189.      */
  190.     STDMETHOD(DataSizeCalculated) (THIS_ HX_RESULT status, UINT32 ulDataSize) PURE;
  191.     /*
  192.      * StartImageParseDone() is the async response to StartImageParse()
  193.      */
  194.     STDMETHOD(StartImageParseDone) (THIS_ HX_RESULT status) PURE;
  195.     /*
  196.      * ParseImageDataReady is the async response to ParseImageData().
  197.      * The flag bLastPacket is TRUE if the codec has determined that
  198.      * this packet is the last packet to be parsed in this image.
  199.      */
  200.     STDMETHOD(ParseImageDataReady) (THIS_ HX_RESULT   status,
  201.                                           IHXPacket *pPacket,
  202.                                           BOOL        bLastPacket) PURE;
  203.     /*
  204.      * ImageParseFinished() is the asynchronous response to
  205.      * IIMFCodec::FinishImageParse(). It informs the File Format plugin
  206.      * that the codec has successfully released all resources allocated
  207.      * during the parse of a particular image.
  208.      */
  209.     STDMETHOD(ImageParseFinished) (THIS_ HX_RESULT status) PURE;
  210. };
  211. /****************************************************************************
  212.  *
  213.  *  Interface:           IIMFCodecRender
  214.  *
  215.  *  Purpose:             IMF Codec Render Interface
  216.  *
  217.  *  IID_IIMFCodecRender: {1FEA07F1-97FC-11d1-AF1B-0060082083F9}
  218.  *
  219.  ****************************************************************************/
  220. DEFINE_GUID(IID_IIMFCodecRender, 0x1fea07f1, 0x97fc, 0x11d1, 0xaf, 0x1b,
  221.             0x0, 0x60, 0x8, 0x20, 0x83, 0xf9);
  222. #define CLSID_IIMFCodecRender IID_IIMFCodecRender
  223. #undef  INTERFACE
  224. #define INTERFACE       IIMFCodecRender
  225. DECLARE_INTERFACE_(IIMFCodecRender, IUnknown)
  226. {
  227.     /*
  228.      * IUnknown methods
  229.      */
  230.     STDMETHOD(QueryInterface)   (THIS_ REFIID riid, void **ppvObj) PURE;
  231.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  232.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  233.     /*
  234.      * IIMFCodecRender Methods
  235.      */
  236.     STDMETHOD(GetCodecRenderInfo)  (THIS_ REF(const char *) pszFileMimeType) PURE;
  237.     STDMETHOD(OpenRender)          (THIS) PURE;
  238.     STDMETHOD(InitRender)          (THIS_ UINT32     ulCompressedBufferLength,
  239.                                           REF(INT32) rlSessionHandle) PURE;
  240.     STDMETHOD(ParseHeader)         (THIS_ INT32       lSessionHandle,
  241.                                           IHXPacket *pPacket,
  242.                                           IHXValues *pValues) PURE;
  243.     STDMETHOD(SetOutputParameters) (THIS_ INT32       lSessionHandle,
  244.                                           BYTE       *pImageBuffer,
  245.                                           UINT32      ulImageBufferSize,
  246.                                           UINT32      ulPadWidth) PURE;
  247.     STDMETHOD(OnPacket)            (THIS_ INT32       lSessionHandle,
  248.                                           IHXPacket *pPacket) PURE;
  249.     STDMETHOD(ValidateImage)       (THIS_ INT32 lSessionHandle) PURE;
  250.     STDMETHOD(TermRender)          (THIS_ INT32 lSessionHandle) PURE;
  251.     STDMETHOD(CloseRender)         (THIS) PURE;
  252. };
  253. #endif