httpfsys.h

linux下的一款播放器

/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: httpfsys.h,v 1.5.8.1 2004/07/09 02:04:03 hubbe Exp $
 * 
 * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
 * 
 * The contents of this file, and the files included with this file,
 * are subject to the current version of the RealNetworks Public
 * Source License (the "RPSL") available at
 * http://www.helixcommunity.org/content/rpsl unless you have licensed
 * the file under the current version of the RealNetworks Community
 * Source License (the "RCSL") available at
 * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
 * will apply. You may also obtain the license terms directly from
 * RealNetworks.  You may not use this file except in compliance with
 * the RPSL or, if you have a valid RCSL with RealNetworks applicable
 * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
 * the rights, obligations and limitations governing use of the
 * contents of the file.
 * 
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License Version 2 or later (the
 * "GPL") in which case the provisions of the GPL are applicable
 * instead of those above. If you wish to allow use of your version of
 * this file only under the terms of the GPL, and not to allow others
 * to use your version of this file under the terms of either the RPSL
 * or RCSL, indicate your decision by deleting the provisions above
 * and replace them with the notice and other provisions required by
 * the GPL. If you do not delete the provisions above, a recipient may
 * use your version of this file under the terms of any one of the
 * RPSL, the RCSL or the GPL.
 * 
 * This file is part of the Helix DNA Technology. RealNetworks is the
 * developer of the Original Code and owns the copyrights in the
 * portions it created.
 * 
 * This file, and the files included with this file, is distributed
 * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
 * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
 * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
 * ENJOYMENT OR NON-INFRINGEMENT.
 * 
 * Technology Compatibility Kit Test Suite(s) Location:
 *    http://www.helixcommunity.org/content/tck
 * 
 * Contributor(s):
 * 
 * ***** END LICENSE BLOCK ***** */

#ifndef _HTTPFSYS_H_
#define _HTTPFSYS_H_

#include "unkimp.h"
#include "smartptr.h"
#include "hxathsp.h"
#include "hxcomsp.h"
#include "hxplnsp.h"
#include "hxpktsp.h"
#include "hxflche.h"
#include "hxauto.h"
#include "hxpac.h"

#include "miscsp.h"


/* forward decl. */
struct IUnknown;
struct IHXBuffer;
struct IHXCallback;
struct IHXRegistry;
struct IHXFileResponse;
struct IHXFileSystemObject;
struct IHXFileObject;
struct IHXPlugin;
struct IHXTCPSocket;
struct IHXFileMimeMapperResponse;
struct IHXFileExistsResponse;
struct IHXPendingStatus;
struct IHXTimeoutSettings;
struct IHXErrorMessages;
struct IHXInterruptState;
struct IHXCookies;
struct IHXCookies2;
struct IHXHTTPRedirect;

class CHXString;
class CChunkyRes;
class CHXSimpleList;
class CDecoder;

class HTTPTCPResponse;
class HTTPFileObjCallback;

#define MAX_CHUNK_SIZE	1024

typedef enum
{
    CE_HEADER_PENDING,
    CE_BODY_PENDING,
    CE_HEADER_READY,
    CE_BODY_READY
} CEState;

typedef struct _HTTPChunkedEncoding
{
    long    size;
    long    read;
    BOOL    lastchunk;
    CEState state;
    char*   buf;
} HTTPChunkedEncoding;

/////////////////////////////////////////////////////////////////////////////
// 
//  Class:
//
//  	CHTTPFileSystem
//
//  Purpose:
//
//  	Example implementation of HTTP file system.
//

class CHTTPFileSystem : public CUnknownIMP,
		       public IHXPlugin,
		       public IHXFileSystemObject,
		       public IHXFileSystemCache,
		       public IHXHTTPAutoStream
{
    DECLARE_UNKNOWN(CHTTPFileSystem)

public:
    static HX_RESULT STDAPICALLTYPE HXCreateInstance(IUnknown** ppIUnknown);
    static HX_RESULT CanUnload();
    static HX_RESULT STDAPICALLTYPE HXShutdown(void);

    CHTTPFileSystem();

    ~CHTTPFileSystem();


    static char* GetProtocol(void)  { return ((char *) zm_pProtocol); }

    /*** IHXPlugin methods ***/

    /************************************************************************
     *	Method:
     *	    IHXPlugin::GetPluginInfo
     *	Purpose:
     *	    Returns the basic information about this plugin. Including:
     *
     *	    unInterfaceCount	the number of standard RMA interfaces 
     *				supported by this plugin DLL.
     *	    pIIDList		array of IID's for standard RMA interfaces
     *				supported by this plugin DLL.
     *	    bLoadMultiple	whether or not this plugin DLL can be loaded
     *				multiple times. All File Formats must set
     *				this value to TRUE.
     *	    pDescription	which is used in about UIs (can be NULL)
     *	    pCopyright		which is used in about UIs (can be NULL)
     *	    pMoreInfoURL	which is used in about UIs (can be NULL)
     */
    STDMETHOD(GetPluginInfo)	(THIS_
				 REF(BOOL)        /*OUT*/ bLoadMultiple,
			         REF(const char*) /*OUT*/ pDescription,
				 REF(const char*) /*OUT*/ pCopyright,
				 REF(const char*) /*OUT*/ pMoreInfoURL,
				 REF(ULONG32)	  /*OUT*/ ulVersionNumber
				);

    /************************************************************************
     *	Method:
     *	    IHXPlugin::InitPlugin
     *	Purpose:
     *	    Initializes the plugin for use. This interface must always be
     *	    called before any other method is called. This is primarily needed 
     *	    so that the plugin can have access to the context for creation of
     *	    IHXBuffers and IMalloc.
     */
    STDMETHOD(InitPlugin)   (THIS_
			    IUnknown*   /*IN*/  pContext);

    STDMETHOD(GetFileSystemInfo)    (THIS_
				    REF(const char*) /*OUT*/ pShortName,
				    REF(const char*) /*OUT*/ pProtocol);
    STDMETHOD(InitFileSystem) (THIS_ IHXValues* options);

    STDMETHOD(CreateFile)	(THIS_
				IUnknown**    /*OUT*/	ppFileObject);

    STDMETHOD(CreateDir)        (THIS_
				IUnknown**     /*OUT*/     ppDirObject);

    // IHXFileSystemCache methods...
    STDMETHOD (RefreshCache) (THIS);
    STDMETHOD (EmptyCache) (THIS);
    STDMETHOD (MoveCache) (THIS_ const char *path);

    // IHXHTTPAutoStream methods...
    STDMETHOD_( void, SetDestinationFile) ( THIS_ const char *pFilename );


private:
    IUnknown*			m_pContext;
    IHXValues*			m_pOptions;
    static const char*		zm_pDescription;
    static const char*		zm_pCopyright;
    static const char*		zm_pMoreInfoURL;
    static const char*		zm_pShortName;
    static const char*		zm_pProtocol;

    // Autostreaming support
    static BOOL			m_bSaveNextStream;
    static CHXString		m_SaveFileName;
};

/////////////////////////////////////////////////////////////////////////////
// 
//  Class:
//
//  	CHTTPFileObject
//
//  Purpose:
//
//  	Example implementation of a basic file system file object.
//

class CHTTPFileObject : public IHXFileObject,
		        public IHXFileExists,
		        public IHXFileStat,
		        public IHXFileMimeMapper,
		        public IHXGetFileFromSamePool,
		        public IHXPendingStatus,
		        public IHXRequestHandler,
		        public IHXTimeoutSettings,
		        public IHXClientAuthResponse,
			public IHXHTTPRedirect,
		    	public IHXFileAutoStream,
			public IHXProxyAutoConfigCallback
{
//    DECLARE_UNKNOWN(CHTTPFileObject);

public:
    CHTTPFileObject();
    ~CHTTPFileObject();

    INT32 m_lCount;

    static CHTTPFileObject* CreateObject();
    STDMETHOD(QueryInterface)
    (
	THIS_
	REFIID riid,
	void** ppvObj
    );
    STDMETHOD_(ULONG32,AddRef) (THIS);
    STDMETHOD_(ULONG32,Release) (THIS);

    void InitObject
    (
	char*			szBaseURL,
	IHXFileSystemObject*	pFS, 
	IUnknown*		pContext,
	IHXValues*		pOptions
    );

    /*
     *	IHXFileObject methods
     */

    /************************************************************************
     *	Method:
     *	    IHXFileObject::Init
     *	Purpose:
     *	    Associates a file object with the file response object it should
     *	    notify of operation completness. This method should also check
     *	    for validity of the object (for example by opening it if it is
     *	    a local file).
     */
    STDMETHOD(Init)		(THIS_
				ULONG32		    /*IN*/	ulFlags,
				IHXFileResponse*   /*IN*/	pFileResponse);

    /************************************************************************
     *  Method:
     *      IHXFileObject::GetFilename
     *  Purpose:
     *      Returns the filename (without any path information) associated
     *      with a file object.
     */
    STDMETHOD(GetFilename)      (THIS_
				REF(const char*)    /*OUT*/  pFilename);

    /************************************************************************
     *	Method:
     *	    IHXFileObject::Close
     *	Purpose:
     *	    Closes the file resource and releases all resources associated
     *	    with the object.
     */
    STDMETHOD(Close)	    	(THIS);

    /************************************************************************
     *	Method:
     *	    IHXFileObject::Read
     *	Purpose:
     *	    Reads a buffer of data of the specified length from the file
     *	    and asynchronously returns it to the caller via the 
     *	    IHXFileResponse interface passed in to Init.
     */
    STDMETHOD(Read)		(THIS_
    	    	    	    	ULONG32	    	    ulCount);

    /************************************************************************
     *	Method:
     *	    IHXFileObject::Write
     *	Purpose:
     *	    Writes a buffer of data to the file and asynchronously notifies
     *	    the caller via the IHXFileResponse interface passed in to Init,
     *	    of the completeness of the operation.
     */
    STDMETHOD(Write)	    	(THIS_
    	    	    	    	IHXBuffer*	    pBuffer);

    /************************************************************************
     *	Method:
     *	    IHXFileObject::Seek
     *	Purpose:
     *	    Seeks to an offset in the file and asynchronously notifies
     *	    the caller via the IHXFileResponse interface passed in to Init,
     *	    of the completeness of the operation.
     */
    STDMETHOD(Seek)		(THIS_
    	    	    	    	ULONG32	    ulOffset,
				BOOL	    bRelative);
    
    /************************************************************************
     *	Method:
     *	    IHXFileObject::Stat
     *	Purpose:
     *	    Collects information about the file that is returned to the
     *      caller in an IHXStat object
     */
    STDMETHOD(Stat)		(THIS_
				IHXFileStatResponse* pFileStatResponse);

    /************************************************************************
     *	Method:
     *	    IHXFileObject::Advise
     *	Purpose:
     *      To pass information to the File Object
     */
    STDMETHOD(Advise)	(THIS_
			ULONG32 ulInfo);

    /************************************************************************
     *	Method:
     *	    IHXGetFileFromSamePool::GetFileObjectFromPool
     *	Purpose:
     *      To get another FileObject from the same pool. 
     */
    STDMETHOD(GetFileObjectFromPool)	(THIS_
					 IHXGetFileFromSamePoolResponse*);

    // IHXFileExists interface
    /************************************************************************
     *	Method:
     *	    IHXFileExists::DoesExist
     *	Purpose:
     */
    STDMETHOD(DoesExist) (THIS_
			const char*		/*IN*/  pPath, 
			IHXFileExistsResponse* /*IN*/  pFileResponse);

    /*
     *	IHXFileMimeMapper methods
     */
    /************************************************************************
     *	Method:
     *	    IHXFileMimeMapper::FindMimeType
     *	Purpose:
     */
    STDMETHOD(FindMimeType) (THIS_
		    const char*		    /*IN*/  pURL, 
		    IHXFileMimeMapperResponse* /*IN*/  pMimeMapperResponse
			    );


    /*
     * IHXPendingStatus methods
     */

    /************************************************************************
     *	Method:
     *	    IHXPendingStatus::GetStatus
     *	Purpose:
     *	    Called by the user to get the current pending status from an object
     */
    STDMETHOD(GetStatus)	(THIS_
				REF(UINT16) uStatusCode, 
				REF(IHXBuffer*) pStatusDesc, 
				REF(UINT16) ulPercentDone);

    HX_RESULT _ReOpen();

    /************************************************************************
     *	Method:
     *	    Private interface::_OpenFile
     *	Purpose:
     *	    This common method is used from Init() and GetFileObjectFromPool()
     */
    HX_RESULT _OpenFile( const char* pFilename,
			ULONG32	    ulFlags);

    HX_RESULT ProcessIdle(void);

    /*
     *	IHXTCPResponse methods
     */

    STDMETHOD(ConnectDone)	(THIS_
				 HX_RESULT		status);

    STDMETHOD(ReadDone)		(THIS_
				HX_RESULT		status,
				IHXBuffer*		pBuffer);