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

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 _HXDTDR_H_
  36. #define _HXDTDR_H_
  37. /****************************************************************************
  38.  * Defines
  39.  */
  40. typedef _INTERFACE      IHXPacket                  IHXPacket;
  41. typedef _INTERFACE      IHXValues                  IHXValues;
  42. typedef _INTERFACE      IHXSourceInput             IHXSourceInput;
  43. typedef _INTERFACE      IHXFileWriter    IHXFileWriter;
  44. typedef _INTERFACE      IHXSourceHandler           IHXSourceHandler;
  45. /****************************************************************************
  46.  * Options
  47.  */
  48. #define MEMORY_OPTION_NAME     "Memory"
  49. #define HEADER_OPTION_NAME     "Header"
  50. #define PACKET_OPTION_NAME     "Packet"
  51. #define VERBOSE_OPTION_NAME     "Verbose"
  52. #define LEAKANALYSIS_OPTION_NAME    "LeakAnalysis"
  53. #define LEAKDETAILS_OPTION_NAME     "LeakDetails"
  54. #define MEMORYDETAILS_OPTION_NAME   "MemoryDetails"
  55. #define SERVER_OPTION_NAME     "Server"
  56. #define RATE_OPTION_NAME     "Rate"
  57. #define TIMER_OPTION_NAME     "Timer"
  58. #define EVENT_OPTION_NAME     "Event"
  59. #define DURATION_OPTION_NAME     "Duration"
  60. #define PREROLL_OPTION_NAME     "RecomputePreroll"
  61. #define BLASTFILE_OPTION_NAME     "BlastFiles"
  62. #define ROTATIONSIZE_OPTION_NAME    "RotationSize"
  63. #define RELATIVETS_OPTION_NAME     "RelativeTS"
  64. #define DECRYPT_OPTION_NAME     "DecryptSource"
  65. #define DECODE_OPTION_NAME     "DecodeSource"
  66. #define BLOCK_OPTION_NAME     "BlockFilter"
  67. #define SUPPRESS_WRITER_OPTION     "SuppressWriter"
  68. #define OUTPUT_FILENAME_OPTION     "OutputFileName"
  69. #define TRANSFER_CERTIFICATE_OPTION "TransferCertificate"
  70. //e1ec2c5f-7f0c-4348-b3b0c4af5eae9778
  71. #define SHID_DECODER   {0xe1ec2c5f, 0x7f0c, 0x4348, 0xb3, 0xb0, 0xc4, 0xaf, 0x5e, 0xae, 0x97, 0x78}
  72. /****************************************************************************
  73.  * 
  74.  *  Interface:
  75.  * 
  76.  * IHXDataTypeDriverResponse
  77.  * 
  78.  *  Purpose:
  79.  * 
  80.  * Interface used to check the state of plugins.
  81.  * 
  82.  *  IHXDataTypeDriverResponse:
  83.  * 
  84.  *  {9D65E58D-9B4B-40f2-8FF0-5CFF673F0BD3}
  85.  * 
  86.  */
  87. DEFINE_GUID(IID_IHXDataTypeDriverResponse, 0x9d65e58d, 0x9b4b, 0x40f2, 0x8f, 0xf0, 0x5c, 0xff, 0x67, 0x3f, 0xb, 0xd3);
  88.  
  89. #undef  INTERFACE
  90. #define INTERFACE   IHXDataTypeDriverResponse
  91.  
  92. DECLARE_INTERFACE_(IHXDataTypeDriverResponse, IUnknown)
  93. {
  94.     /*
  95.      * IHXDataTypeDriverResponse methods
  96.      */
  97.  
  98.     /************************************************************************
  99.      * Method:
  100.      *     IHXDataTypeDriverResponse::OnProgress(UINT32);
  101.      * Purpose:
  102.      *     Called to notify the status of the transfer
  103.      *     
  104.      */
  105.     STDMETHOD(OnProgress)(THIS_ UINT32 progress) PURE;
  106.     /************************************************************************
  107.      * Method:
  108.      *     IHXDataTypeDriverResponse::OnTerminate(HX_RESULT);
  109.      * Purpose:
  110.      *     Called when the datatype driver is done, with the appropriate 
  111.      *     error condition.
  112.      */
  113.     STDMETHOD(OnTerminate)(THIS_ HX_RESULT result) PURE;
  114. };
  115. /****************************************************************************
  116.  * 
  117.  *  Interface:
  118.  * 
  119.  * IHXDataTypeDriver2
  120.  * 
  121.  *  Purpose:
  122.  * 
  123.  *  New interface for datatype driver.
  124.  * 
  125.  *  IHXDataTypeDriver2:
  126.  * 
  127.  *  {9D65E58E-9B4B-40f2-8FF0-5CFF673F0BD3}
  128.  * 
  129.  */
  130. DEFINE_GUID(IID_IHXDataTypeDriver2, 0x9d65e58e, 0x9b4b, 0x40f2, 0x8f, 0xf0, 0x5c, 0xff, 0x67, 0x3f, 0xb, 0xd3);
  131.  
  132. #undef  INTERFACE
  133. #define INTERFACE   IHXDataTypeDriver2
  134. DECLARE_INTERFACE_(IHXDataTypeDriver2, IUnknown)
  135. {
  136.     /*
  137.      * IHXDataTypeDriver2 methods
  138.      */
  139.  
  140.     /************************************************************************
  141.      * Method:
  142.      *     IHXDataTypeDriver2::Open()
  143.      * Purpose:
  144.      *     Called to initialize the driver.
  145.      *     Note: all callbacks on the pResponse will be on the same thread 
  146.      *     that called function.
  147.      *   
  148.      *     the data output from the last source handler will be provided to an
  149.      *     IHXSourceInput. IHXDataTypeDriverResponse is useful for 
  150.      *     monitoring transfer/decode/decrypt progress and error conditions.     
  151.      *    
  152.      *     the source handler list used is the concatenation of handlers from 
  153.      *     pCertificate, pSourceHandlerGUIDs and pSourceHandlerList, in that order.
  154.      *     any of the above three can be null
  155.      *
  156.      *     pOption can be used to pass option values to both FFDRIVER and source
  157.      *     handlers
  158.      *
  159.      *     'decrypt' can only be signaled by the presence of a pCertificate
  160.      *     'decode'  can be signaled by setting the value in pOptions
  161.      *       but if pCertificate is present, it overwrites 
  162.      *       'decode' setting in pOptions
  163.      *
  164.      */
  165.     STDMETHOD(Open) (THIS_ 
  166.      const char* pCertificate,
  167.      int nSourceHandlerGUIDs,
  168.      GUID*   pSourceHandlerGUIDs,
  169.      int nSourceHandlerList,
  170.      IHXSourceHandler** pSourceHandlerList,
  171.      IHXValues* pOptions,
  172.      IHXDataTypeDriverResponse* pResponse,
  173.      IHXSourceInput* pSourceInput
  174.     ) PURE;
  175.  
  176.     /************************************************************************
  177.      * Method:
  178.      *     IHXDataTypeDriver2::Drive()
  179.      * Purpose:
  180.      *     Called to start processing. This will start the conversion in
  181.      *      a separate thread and return immediately. The client will
  182.      *     receive callbacks through pResponse's IHXSourceInput and/or 
  183.      *     IHXDataTypeDriverResponse interfaces (see Open()).
  184.      *
  185.      *     Drive() may be called multiple times without calling Close()
  186.      *     to process multiple files with the same driver settings.
  187.      *     
  188.      */
  189.     STDMETHOD(Drive)(THIS_ const char* pInFileName,
  190.      const char* pOutFileName
  191.      ) PURE;
  192.     /************************************************************************
  193.      * Method:
  194.      *      IHXDataTypeDriver2::Stop()
  195.      * Purpose:
  196.      *     Called to stop Drive. Can be called from a different thread, or 
  197.      *     called from a call back.
  198.      */
  199.     STDMETHOD(Stop)(THIS_ ) PURE;
  200.     /************************************************************************
  201.      * Method:
  202.      *     IHXDataTypeDriver2::Close()
  203.      * Purpose:
  204.      *     Called to clean up the driver process. If called while still
  205.      *     processing a file, the operation will be terminated. The driver
  206.      *     will need to be reinitialized by calling Open() before it can
  207.      *     be used again.
  208.      *
  209.      */
  210.     STDMETHOD(Close)(THIS) PURE;
  211.     /************************************************************************
  212.      * Method:
  213.      *     IHXDataTypeDriver2::Pause()
  214.      * Purpose:
  215.      *     Called to throttle delivery. No more callbacks will be made
  216.      *    until Resume() is called. 
  217.      */
  218.     STDMETHOD(Pause)(THIS) PURE;
  219.     /************************************************************************
  220.      * Method:
  221.      *     IHXDataTypeDriver2::Resume()
  222.      * Purpose:
  223.      *     Called to resume delivery
  224.      */
  225.     STDMETHOD(Resume)(THIS) PURE;
  226. };
  227. /****************************************************************************
  228.  * 
  229.  *  Interface:
  230.  * 
  231.  *  IHXSetClientContext
  232.  * 
  233.  *  Purpose:
  234.  * 
  235.  *  to set a client context
  236.  * 
  237.  *  IHXSetClientContext
  238.  * 
  239.  *  {9D65E58F-9B4B-40f2-8FF0-5CFF673F0BD3}
  240.  * 
  241.  */
  242. DEFINE_GUID(IID_IHXSetClientContext, 0x9d65e58f, 0x9b4b, 0x40f2, 0x8f, 0xf0, 0x5c, 0xff, 0x67, 0x3f, 0xb, 0xd3);
  243.  
  244. #undef  INTERFACE
  245. #define INTERFACE   IHXSetClientContext
  246. DECLARE_INTERFACE_(IHXSetClientContext, IUnknown)
  247. {
  248.     /*
  249.      * IHXSetClientContext methods
  250.      */
  251.      /************************************************************************
  252.      * Method:
  253.      *     IHXSetClientContext::SetClientContext
  254.      * Purpose:
  255.      *     Called by the client to install itself as the provider of client
  256.      *     services. 
  257.      *
  258.      * Datatype driver client can implement IHXUpgradeCollection in the client context 
  259.      *  to get plugin components upgrade notification.
  260.      *
  261.      *  Can also be used as means for custom source handler to commnuication with client through custom interface
  262.      *  implemnted in the ClientContext.
  263.      */
  264.     STDMETHOD(SetClientContext) (THIS_
  265. IUnknown* pUnknown) PURE;
  266. };
  267. #endif //_HXDTDR_H_