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

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: hxcleng.h,v 1.13.2.2 2004/07/09 02:05:40 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 _HXCLIENTENGINE_
  50. #define _HXCLIENTENGINE_
  51. #include "chxelst.h"
  52. #include "hxmon.h"
  53. #include "hxclreg.h"
  54. #include "statinfo.h"
  55. #include "strminfo.h"
  56. #include "hxshtdn.h"
  57. #include "hxupgrd.h"
  58. #include "hxerror.h"
  59. #if defined(HELIX_FEATURE_LITEPREFS)
  60. #include "chxliteprefs.h"
  61. #endif
  62. #ifdef _UNIX
  63. #include "hxengin.h"
  64. #endif
  65. class HXCommonClassFactory;
  66. class HXScheduler;
  67. class   HXOptimizedSchedulerBase;
  68. class HXPreferences;
  69. class HXNetworkServices;
  70. class HXHyperNavigate;
  71. class HXThreadHyperNavigate;
  72. class HXClientRegistry;
  73. class CHXAudioSession;
  74. class HXCoreGuiHook;
  75. class Plugin2Handler;
  76. class HXPluginManager;
  77. class BaseHandler;
  78. class HXAutoConfig;
  79. class CHXPlayerSinkControl;
  80. class HXCoreComm;
  81. class   HXMutex;
  82. class HXValidator;
  83. class HXExternalResourceManager;
  84. class CHXCredentialsCache;
  85. class CHXResMgr;
  86. class HXXMLParser;
  87. class HXCookies;
  88. class HXCookiesHelper;
  89. class HXPreferredTransportManager;
  90. class HXProxyManager;
  91. class CMediumBlockAllocator;
  92. class HXViewSource;
  93. class CHXMapStringToOb;
  94. class   HXOverlayManager;
  95. class HXNetInterface;
  96. class HXPlayer;
  97. class HXCookies;
  98. struct IHXClientAdviseSink;
  99. struct IHXErrorMessages;
  100. struct IHXCommonClassFactory;
  101. struct IHXClientEngine;
  102. struct IHXMimeTypeMapper;
  103. struct IHXRegistry;
  104. struct IHXHyperNavigate;
  105. struct  IHXPreferences;
  106. struct  IHXShutDownEverything;
  107. struct IHXValidator;
  108. struct  IHXSiteEventHandler;
  109. struct IHXXMLParser;
  110. struct  IHXSystemRequired;
  111. struct  IHXMultiPlayPauseSupport;
  112. struct IHXProxyAutoConfig;
  113. struct IHXNetInterfaces;
  114. struct  IHXBandwidthManager;
  115. #if defined(HELIX_FEATURE_SYSTEMREQUIRED)
  116. class HXSystemRequired : public IHXSystemRequired
  117. {
  118. protected:
  119.     LONG32     m_lRefCount;
  120. public:
  121.     HXSystemRequired() {m_lRefCount = 0;}
  122.     ~HXSystemRequired() {};
  123.     /*
  124.      * IUnknown methods
  125.      */
  126.     STDMETHOD(QueryInterface) (THIS_
  127. REFIID riid,
  128. void** ppvObj);
  129.     STDMETHOD_(ULONG32,AddRef) (THIS);
  130.     STDMETHOD_(ULONG32,Release) (THIS);
  131.     /*
  132.      * IHXSystemRequired methods
  133.      */
  134.     /************************************************************************
  135.      * Method:
  136.      * IHXSystemRequired::HasFeatures
  137.      * Purpose:
  138.      * Check if required features are present on the system.
  139.      *  Returns:
  140.      * HXR_OK -    features are here, no upgrade required;
  141.      *     all features are removed from pFeatures.
  142.      * HXR_FAIL -  some features are missing;
  143.      *     pFeatures contains only those features 
  144.      *     that need upgrade.
  145.      *
  146.      */       
  147.     STDMETHOD(HasFeatures)  (THIS_ 
  148.     IHXUpgradeCollection* pFeatures);
  149. };
  150. #endif /* HELIX_FEATURE_SYSTEMREQUIRED */
  151. class HXClientEngine : 
  152. public IHXClientEngine
  153. #if defined _UNIX && !defined _VXWORKS
  154.                       , public IHXClientEngineSelector
  155.                       , public IHXAsyncIOSelection
  156. #endif
  157.       , public IHXClientEngineSetup
  158.       , public IHXInterruptState
  159.       , public IHXShutDownEverything
  160.       , public IHXOverrideDefaultServices
  161.       , public IHXErrorMessages
  162.                       , public IHXClientEngineMapper
  163.       , public IHXCoreMutex
  164. #if defined(_MACINTOSH) && defined(_CARBON) && defined(THREADS_SUPPORTED)
  165.       , public IHXMacBlitMutex
  166. #endif
  167. {
  168. protected:
  169.     LONG32     m_lRefCount;
  170.     ULONG32     m_ulPlayerIndex;
  171.     INT32     m_unRegistryID;
  172.     HXClientRegistry*     m_pRegistry;
  173.     HXCommonClassFactory*  m_pCommonClassFactory;
  174.     IHXCommonClassFactory* m_pCommonClassFactoryOverride;
  175.     CMediumBlockAllocator*  m_pAllocator;
  176.     HXScheduler*     m_pScheduler;
  177.     HXOptimizedSchedulerBase* m_pOptimizedScheduler;
  178.     IHXPreferences*     m_pPreferences;
  179. #if defined(HELIX_FEATURE_NO_INTERNAL_PREFS)
  180.     IHXPreferences*     m_pOrigPreferences;
  181. #elif defined(HELIX_FEATURE_LITEPREFS)
  182.     CHXLitePrefs*     m_pOrigPreferences;
  183. #else
  184.     HXPreferences*     m_pOrigPreferences;
  185. #endif
  186.     CHXAudioSession*     m_pAudioSession;
  187.     HXNetworkServices*     m_pOrigNetworkServices;
  188.     IHXNetworkServices*    m_pNetworkServices;
  189. #ifdef _UNIX
  190.     IHXAsyncIOSelection*   m_pAsyncIOSelection;
  191.     BOOL                    m_bNetworkThreading;
  192. #endif
  193.     HXCookies*     m_pCookies;
  194.     HXCookiesHelper*     m_pCookiesHelper;
  195.     HXNetInterface*     m_pNetInterfaces;
  196.     IHXProxyAutoConfig*    m_pProxyAutoConfig;
  197.     IHXHyperNavigate*     m_pHyperNavigate;
  198.     HXThreadHyperNavigate* m_pOrigHyperNavigate;
  199.     HXValidator*     m_pValidator;
  200.     IHXBandwidthManager*    m_pASM;
  201.     CHXPlayerSinkControl*   m_pPlayerSinkControl;
  202.     CHXCredentialsCache*   m_pCredentialsCache;
  203.     CHXResMgr*     m_pResMgr;
  204.     HXExternalResourceManager* m_pExternalResourceManager;
  205.     HXXMLParser*     m_pXMLParser;
  206.     HXViewSource*     m_pViewSource;
  207.     IHXSystemRequired*     m_pSystemRequired;
  208. #if defined(_UNIX) || defined(__TCS__)
  209.     IHXSiteEventHandler*   m_pSiteEventHandler;
  210. #endif
  211.     HXProxyManager*     m_pProxyManager;
  212.     HXPreferredTransportManager*   m_pPreferredTransportManager;
  213.     HXOverlayManager*              m_pOverlayManager;
  214.     IHXMultiPlayPauseSupport*     m_pMultiPlayPauseSupport;
  215.     //List to store the plugins for information reguarding created players.
  216.     CHXSimpleList*     m_pSingleLoadPlugins;
  217. public:
  218. #if defined(_STATICALLY_LINKED) || !defined(HELIX_FEATURE_PLUGINHANDLER2)
  219. #if defined(HELIX_CONFIG_CONSOLIDATED_CORE)
  220.     BaseHandler*            m_pPlugin2Handler;
  221. #else /* HELIX_CONFIG_CONSOLIDATED_CORE */
  222.     HXPluginManager*     m_pPlugin2Handler;
  223. #endif /* HELIX_CONFIG_CONSOLIDATED_CORE */
  224. #else
  225.     Plugin2Handler*     m_pPlugin2Handler;
  226. #endif /* _STATICALLY_LINKED */
  227.     HXClientEngine(void);
  228.     ~HXClientEngine(void);
  229.     /*
  230.      * IUnknown methods
  231.      */
  232.     STDMETHOD(QueryInterface) (THIS_
  233. REFIID riid,
  234. void** ppvObj);
  235.     STDMETHOD_(ULONG32,AddRef) (THIS);
  236.     STDMETHOD_(ULONG32,Release) (THIS);
  237.     /*
  238.      * IHXClientEngine methods
  239.      */
  240.     /************************************************************************
  241.      * Method:
  242.      *     IHXClientEngine::CreatePlayer
  243.      * Purpose:
  244.      *     Creates a new IHXPlayer instance.
  245.      *
  246.      */
  247.     STDMETHOD(CreatePlayer) (THIS_
  248. REF(IHXPlayer*)    pPlayer);
  249.     /************************************************************************
  250.      * Method:
  251.      *     IHXClientEngine::ClosePlayer
  252.      * Purpose:
  253.      *     Called by the engine when it is done using the player...
  254.      *
  255.      */
  256.     STDMETHOD(ClosePlayer) (THIS_
  257. IHXPlayer*    pPlayer);
  258.     /************************************************************************
  259.      * Method:
  260.      *     IHXClientEngine::GetPlayerCount
  261.      * Purpose:
  262.      *     Returns the current number of IHXPlayer instances supported by
  263.      *     this client engine instance.
  264.      */
  265.     STDMETHOD_(UINT16, GetPlayerCount)(THIS);
  266.     /************************************************************************
  267.      * Method:
  268.      *     IHXClientEngine::GetPlayer
  269.      * Purpose:
  270.      *     Returns the Nth IHXPlayer instances supported by this client 
  271.      *     engine instance.
  272.      */
  273.     STDMETHOD(GetPlayer) (THIS_
  274. UINT16 nPlayerNumber,
  275. REF(IUnknown*) pUnknown);
  276.     /************************************************************************
  277.      * Method:
  278.      *     IHXClientEngine::EventOccurred
  279.      * Purpose:
  280.      *     Clients call this to pass OS events to all players. HXxEvent
  281.      *     defines a cross-platform event.
  282.      */
  283.     STDMETHOD(EventOccurred) (THIS_
  284. HXxEvent* /*IN*/ pEvent);
  285. /*
  286.  * IHXMimeTypeMapper methods
  287.  */
  288.     STDMETHOD(MapFromExtToMime) (THIS_
  289. const char*     /*IN*/  pExtension,
  290. REF(const char*)    /*OUT*/ pMimeType);
  291. #ifdef _UNIX
  292.     STDMETHOD_(INT32,Select) (THIS_
  293.       INT32 n,
  294.       fd_set* readfds,
  295.       fd_set* writefds,
  296.       fd_set* exceptfds,
  297.       struct timeval* timeout);
  298.     STDMETHOD(Add)           (THIS_
  299.       IHXCallback* pCallback,
  300.       INT32         lFileDescriptor,
  301.       UINT32        ulFlags);
  302.     STDMETHOD(Remove)        (THIS_
  303.       INT32         lFileDescriptor,
  304.       UINT32        ulFlags);
  305.     CHXSimpleList*            m_select_callbacks;
  306. #endif
  307.     /*
  308.      * IHXClientEngineSetup methods
  309.      */
  310.     /************************************************************************
  311.      * Method:
  312.      *     IHXClientEngineSetup::Setup
  313.      * Purpose:
  314.      *      Top level clients use this interface to over-ride certain basic 
  315.      *     interfaces are: IHXPreferences, IHXHyperNavigate
  316.      */
  317.     STDMETHOD(Setup) (THIS_
  318. IUnknown* pContext);
  319.     /*
  320.      * IHXInterruptState methods
  321.      */
  322.     STDMETHOD_(BOOL,AtInterruptTime) (THIS);
  323.     STDMETHOD(EnterInterruptState) (THIS);
  324.     STDMETHOD(LeaveInterruptState) (THIS);
  325.     STDMETHOD(EnableInterrupt) (THIS_
  326. BOOL bEnable);
  327.     
  328.     STDMETHOD_(BOOL, IsInterruptEnabled) (THIS);
  329.     /*
  330.      * IHXShutDownEverything methods
  331.      */
  332.     /************************************************************************
  333.      * Method:
  334.      *     IHXShutDownEverything::ShutDown
  335.      * Purpose:
  336.      *     Shutdown all the renderers/fileformats
  337.      *
  338.      */
  339.     STDMETHOD(ShutDown) (THIS);
  340.     /************************************************************************
  341.      * Method:
  342.      *     IHXShutDownEverything::StopAllOtherPlayers
  343.      * Purpose:
  344.      *     Stop all the players in other processes if they use audio
  345.      *
  346.      */
  347.     STDMETHOD(StopAllOtherPlayers) (THIS);
  348.     /************************************************************************
  349.      * Method:
  350.      *     IHXShutDownEverything::AskAllOtherPlayersToReload
  351.      * Purpose:
  352.      *     Ask all other players in other processes to reload their 
  353.      *     DLLs.
  354.      *
  355.      */
  356.     STDMETHOD(AskAllOtherPlayersToReload) (THIS);
  357.     /************************************************************************
  358.      * Method:
  359.      *     IHXShutDownEverything::AskAllOtherPlayersToUnload
  360.      * Purpose:
  361.      *     Ask all other players in other processes to unload their 
  362.      *     unused DLLs.
  363.      *
  364.      */
  365.     STDMETHOD(AskAllOtherPlayersToUnload) (THIS);
  366.     /*
  367.      * IHXOverrideDefaultServices methods
  368.      */
  369.     /************************************************************************
  370.      *  Method:
  371.      *      IHXOverrideDefaultServices::OverrideServices
  372.      *  Purpose:
  373.      *      Override default services provided by the G2 system.
  374.      * 
  375.      */
  376.     STDMETHOD(OverrideServices)         (THIS_
  377. IUnknown* pContext);
  378.     /*
  379.      *  IHXErrorMessages methods
  380.      */
  381.     /************************************************************************
  382.      * Method:
  383.      *     IHXErrorMessages::Report
  384.      * Purpose:
  385.      *     Call this method to report an error, event, or status message.
  386.      * Parameters:
  387.      *
  388.      *     const UINT8 unSeverity
  389.      *     Type of report. This value will impact how the player, tool, or
  390.      *     server will react to the report. Possible values are described 
  391.      *     above. Depending on the error type, an error message with the 
  392.      *     RMA code, anda string translation of that code will be displayed. 
  393.      *     The error dialog includes a "more info" section that displays the
  394.      *     user code and string, and a link to the more info URL. In the 
  395.      *     server these messages are logged to the log file.
  396.      *
  397.      *     const ULONG32   ulHXCode
  398.      *     Well known RMA error code. This will be translated to a text
  399.      *     representation for display in an error dialog box or log file.
  400.      *
  401.      *     const ULONG32   ulUserCode
  402.      *     User specific error code. This will NOT be translated to a text
  403.      *     representation. This can be any value the caller wants, it will
  404.      *     be logged or displayed but not interpretted.
  405.      *
  406.      *     const char*     pUserString
  407.      *     User specific error string. This will NOT be translated or 
  408.      *     modified. This can be any value the caller wants, it will
  409.      *     be logged or displayed but not interpretted.
  410.      *
  411.      *     const char*     pMoreInfoURL
  412.      *     User specific more info URL string.
  413.      *
  414.      */
  415.     STDMETHOD(Report) (THIS_
  416. const UINT8 unSeverity,  
  417. HX_RESULT ulHXCode,
  418. const ULONG32 ulUserCode,
  419. const char* pUserString,
  420. const char* pMoreInfoURL);
  421.     /************************************************************************
  422.      * Method:
  423.      *     IHXErrorMessages::GetErrorText
  424.      * Purpose:
  425.      *     Call this method to get the text description of a RMA error code.
  426.      * Parameters:
  427.      *     HX_RESULT ulHXCode (A RMA error code)
  428.      *  Return Value:
  429.      *     IHXBuffer* containing error text.
  430.      */
  431.     STDMETHOD_(IHXBuffer*, GetErrorText) (THIS_
  432. HX_RESULT ulHXCode);
  433.     /************************************************************************
  434.      * Method:
  435.      *     IHXClientEngineMapper::GetPlayerBySite
  436.      * Purpose:
  437.      *     Returns the IHXPlayer instance supported by this client 
  438.      *     engine instance that contains the specified IHXSite.
  439.      */
  440.     STDMETHOD(GetPlayerBySite) (THIS_
  441. IHXSite* pSite,
  442. REF(IUnknown*) pUnknown);
  443.     /************************************************************************
  444.      * Method:
  445.      *     IHXCoreMutex::LockCoreMutex
  446.      * Purpose:
  447.      *      Call this method to lock the client engine's core mutex.
  448.      */
  449.     STDMETHOD(LockCoreMutex)    (THIS);
  450.     /************************************************************************
  451.      * Method:
  452.      *     IHXCoreMutex::UnlockCoreMutex
  453.      * Purpose:
  454.      *      Call this method to unlock the client engine's core mutex.
  455.      */
  456.     STDMETHOD(UnlockCoreMutex)    (THIS);
  457. #if defined(_MACINTOSH) && defined(_CARBON) && defined(THREADS_SUPPORTED)
  458.     /************************************************************************
  459.      * Method:
  460.      *     IHXMacBlitMutex::LockMacBlitMutex
  461.      * Purpose:
  462.      *      Call this method to lock the Mac blitting mutex
  463.      */
  464.     STDMETHOD(LockMacBlitMutex)    (THIS);
  465.     /************************************************************************
  466.      * Method:
  467.      *     IHXMacBlitMutex::UnlockMacBlitMutex
  468.      * Purpose:
  469.      *      Call this method to unlock the Mac blitting mutex
  470.      */
  471.     STDMETHOD(UnlockMacBlitMutex)    (THIS);
  472. #endif
  473.     STDMETHOD(StopAudioPlayback) (THIS);
  474.     virtual void Close();
  475.     HXMutex* GetCoreMutex() {return m_pCoreMutex;};
  476.     CHXResMgr* GetResMgr() {return m_pResMgr;};
  477.     void NotifyPlayState(BOOL bInPlayingState);
  478.     HXCookies* GetCookies() {return m_pCookies;};
  479.     UINT32 m_lROBActive;
  480. protected:
  481.     void _Initialize();
  482.     virtual CHXAudioSession* NewAudioSession();
  483.     virtual HXPlayer* NewPlayer();
  484.     virtual HXCookies* NewCookies();
  485.     void CreatePrefIfNoExist(const char* pName, const char* pValue);
  486.     void CreatePluginDir();
  487.     void CreateCodecDir();
  488.     void InitializeThreadedObjects();
  489.     void InitializeRegistry();
  490.     IHXBuffer* CreateBufferAndSetToString(const char* pStr);
  491.     void InitPaths();
  492.     CHXSimpleList m_PlayerList;
  493.     HX_RESULT m_LastError;
  494.     HX_BITFIELD m_bIsSchedulerStarted : 1;
  495.     HX_BITFIELD m_bInitialized : 1;
  496.     BOOL m_bUseCoreThread;
  497.     HX_BITFIELD m_bUseCoreThreadExternallySet : 1;
  498.     HXCoreComm* m_pCoreComm;
  499.     HXMutex* m_pCoreMutex;
  500. #if defined(_MACINTOSH) && defined(_CARBON) && defined(THREADS_SUPPORTED)
  501.     BOOL m_bUseMacBlitMutex;
  502.     HXMutex* m_pMacBlitMutex;
  503. #endif
  504.     const char* m_AUName;
  505. };
  506. #endif // HXClientEngine