rpcodec.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:13k
源码类别:

Symbian

开发平台:

Visual C++

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