hxbsrc.h

linux下的一款播放器

/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: hxbsrc.h,v 1.14.2.1 2004/07/09 02:05:57 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 _HX_BSOURCE_
#define _HX_BSOURCE_

#include "hxresult.h"
#include "hxtypes.h"
#include "hxurl.h"
#include "hxcomm.h"			// IHXRegistryID
#include "plprefk.h"
#include "hxmap.h"
#include "hxfiles.h"
#include "hxasm.h"
#include "hxmon.h"
#include "hxhyper.h"
#include "hxclreg.h"
#include "hxpends.h"
#include "chxelst.h"
#include "statsmgr.h"
#include "statinfo.h"
#include "strminfo.h"
#include "buffmgr.h"
#include "hxausvc.h"
#include "hxaudply.h"
#include "hxplugn.h"
#include "smiltype.h"
#include "recordctl.h"
#include "hxcore.h"

// need to go in hxresult.h
#define HX_INVALID_HEADER			HXR_INVALID_PARAMETER

#define NUM_MILLISECS_IN_A_SEC			((ULONG32) 1000)

#define HX_LATE_PACKET				HXR_FAILED
#define HX_DUPLICATE_PACKET			(HXR_FAILED + 1)


///////////////////////////////////////////////////////////////
// PERFECTPLAY_FUDGE_FACTOR
//
// Percentage of average download to consider for calculations. 
// 100 = 100% and assumes that the average download time is 
// correct. Larger numbers (i.e. 110) would handle the case of 
// the average being lucky as if all future blocks come in at 
// slower rate.
#define PERFECTPLAY_FUDGE_FACTOR		(110)	

///////////////////////////////////////////////////////////////
// PERFECTPLAY_FUDGE_FACTOR_BASE
//
// Base unit of measure for percentage of average download to 
// consider for calculations.
#define PERFECTPLAY_FUDGE_FACTOR_BASE	(100)	

///////////////////////////////////////////////////////////////
// PERFECTPLAY_MIN_BUFFERS
//
// Due to the behavior of pn_net's de-interleaving support
// we must make sure that we have at least 3 superblocks of
// buffers before we can start playback in perfect play mode.
// I have tried smaller amounts, in particular I thought 
// MIN_LEAD_BLOCKS would be a logical number, but this was not
// conservative enough and the playback would stop prematurely
// even though there was data available.
#define PERFECTPLAY_MIN_BUFFERS		(mInterleaveFactor * 3)

///////////////////////////////////////////////////////////////
// PERFECTPLAY_TICKS_PER_SECOND
//
// Since the different OS's return different meanings for "ticks"
// we will use this as the ratio of ticks to seconds.
#ifdef __MWERKS__
#define PERFECTPLAY_TICKS_PER_SECOND		60
#else
#define PERFECTPLAY_TICKS_PER_SECOND		100
#endif

///////////////////////////////////////////////////////////////
// PERFECTPLAY_MIN_TIME
//
// Also due to the behavior of pn_net's de-interleaving support
// we can't play for less than about 3 superblocks of audio, so
// this define will represent this in seconds.
// This is a reasonable minimun perfect play time
#define	PERFECTPLAY_MIN_TIME	10

#define MINIMUM_PLAY_TIME   10000 /* in ms.*/

/* Approx Time to be taken for network buffering */
#define NETWORK_FUDGE_FACTOR			2000

#define MIN_BUFFERTIME_BEFORE_DELAY	500

#define RENDERER_INTERFACE_SIZE	16
#define SECURE_RENDERER_INTERFACE_SIZE	5

// forward decl.
class HXPlayer;
class CHXEvent;
class CHXEventList;
class HXClientEngine;

class Plugin2Handler;

class CBufferManager;
class SourceInfo;
class HXUpgradeCollection;

struct IHXPacket;
struct IHXStreamSource;
struct IHXValues;
struct IHXStream;
struct IHXClientEngine;
struct IHXPlayer;
struct IHXPrivateStreamSource;
struct IHXDigitalRightsManager;

// if you change these two constants please change
// ProtocolName and StreamName size in RaCOnnectionInfo
// structure in hxtypes.h as well...
#define MAX_STREAM_NAME		50
#define MAX_PROTOCOL_NAME	20

#define HX_EOF_TIME		0	// use to indicate to netplay to play until EOF of stream

#define RAM_MIMETYPE		"application/ram"

// XXXTW.	There is a copy of this in rpplmrg\rpplmgr.cpp.  Update both,
// 			if either.
enum PlayMode
{
    NORMAL_PLAY = 0,
    BUFFERED_PLAY,
    PERFECT_PLAY,
    BUFFERED_PLAY_NOT_ENTIRE_CLIP,
    PERFECT_PLAY_NOT_ENTIRE_CLIP
};

enum TurboPlayMode
{
    TURBO_PLAY_UNKNOWN,
    TURBO_PLAY_ON,
    TURBO_PLAY_OFF
};

enum TurboPlayOffReason
{
    TP_OFF_BY_UNKNOWN = 0,
    TP_OFF_BY_PREFERENCE,
    TP_OFF_BY_SERVER,
    TP_OFF_BY_REBUFFER,
    TP_OFF_BY_NOTENOUGHBW,
    TP_OFF_BY_NETCONGESTION,
    TP_OFF_BY_NONRTSP,
    TP_OFF_BY_LIVE,
    TP_OFF_BY_ROB,
    TP_OFF_BY_INVALIDTLC,
    TP_OFF_BY_MULTISURESTREAMS    
};

enum EndCode
{
    END_UNKNOWN = 0,
    END_DURATION,
    END_STOP,
    END_RECONNECT,
    END_REDIRECT,
    END_ABORT
};

struct TurboPlayStats
{
    TurboPlayOffReason	tpOffReason;
    BOOL		bBufferDone;
    UINT32		ulAcceleratedBW;
    UINT32		ulBufferedTime;

    TurboPlayStats()
    {
	tpOffReason = TP_OFF_BY_UNKNOWN;
	bBufferDone = FALSE;
	ulAcceleratedBW = 0;
	ulBufferedTime = 0;
    }
};

class HXSource : public IHXStreamSource,
		  public IHXPendingStatus,
		  public IHXRegistryID,
		  public IHXInfoLogger,
		  public IHXPrivateStreamSource,
		  public IHXBackChannel,
		  public IHXASMSource,
#if defined(HELIX_FEATURE_HYPER_NAVIGATE)
		  public IHXHyperNavigate,
		  public IHXHyperNavigate2,
#endif /* defined(HELIX_FEATURE_HYPER_NAVIGATE) */
                  public IHXSourceBufferingStats2
{
protected:
    LONG32			m_lRefCount;
    ULONG32			m_ulStreamIndex;

    HXPlayer*			m_pPlayer;
    
    CBufferManager*		m_pBufferManager;

    friend class CBufferManager;

public:
    // statistic info.
    HXClientRegistry*		m_pRegistry;
#if defined(HELIX_FEATURE_STATS) && defined(HELIX_FEATURE_REGISTRY)
    StatsManager*		m_pStatsManager;
    SOURCE_STATS*		m_pStats;
#endif /* HELIX_FEATURE_STATS && HELIX_FEATURE_REGISTRY */
    IHXValues*			m_pFileHeader;
    HX_BITFIELD			m_bRebufferingRequired : 1;
    HX_BITFIELD			m_bRTSPRuleFlagWorkAround : 1;
    HX_BITFIELD			m_bReSetup : 1;
    HX_BITFIELD			m_bFastStart : 1;
    EndCode			m_srcEndCode;
    TurboPlayStats		m_turboPlayStats;
    TurboPlayMode		m_serverTurboPlay;
    HX_BITFIELD			m_bSureStreamClip : 1;
    SourceInfo*			m_pSourceInfo;
    UINT32			m_ulMaxBandwidth;
    UINT32			m_ulDelay;    
    UINT32			m_ulOriginalDuration;
    UINT32			m_ulOriginalDelay;
    UINT32			m_ulPrefetchDelay;
    UINT32			m_ulRegistryID;
    UINT32			m_ulTurboPushDown;
    CHXSimpleList               m_PacketBufferList;
    HX_BITFIELD                 m_bContinueWithHeaders : 1;

protected:
    HX_BITFIELD			m_bDefaultAltURL : 1;

public:
				HXSource(void);

    /*
     * IUnknown methods
     */

    STDMETHOD(QueryInterface)	(THIS_
				REFIID riid,
				void** ppvObj);

    STDMETHOD_(ULONG32,AddRef)	(THIS);

    STDMETHOD_(ULONG32,Release)	(THIS);

    /*
     * IHXStreamSource methods
     */

    /************************************************************************
     *	Method:
     *		IHXStreamSource::IsLive
     *	Purpose:
     *		Ask the source whether it is live
     *
     */
    STDMETHOD_ (BOOL,IsLive)	(THIS);
    
    /************************************************************************
     *	Method:
     *	    IHXStreamSource::GetPlayer
     *	Purpose:
     *	    Get the interface to the player of which the source is
     *	    a part of.
     *
     */
    STDMETHOD(GetPlayer)	(THIS_
				REF(IHXPlayer*)    pPlayer);

    /************************************************************************
     *	Method:
     *	    IHXStreamSource::GetContext
     *	Purpose:
     *	    Get the interface to the context of which the source is
     *	    a part of.
     *
     */
    STDMETHOD(GetContext)	(THIS_
				REF(IUnknown*)	pContext);

    /************************************************************************
     *	Method:
     *	    IHXStreamSource::GetURL
     *	Purpose:
     *	    Get the URL for this source. NOTE: The returned string is
     *	    assumed to be valid for the life of the IHXStreamSource from which it
     *	    was returned.
     *
     */
    STDMETHOD_(const char*,GetURL)  (THIS);

    /************************************************************************
     *	Method:
     *	    IHXStreamSource::GetStreamCount
     *	Purpose:
     *	    Returns the current number of stream instances supported by
     *	    this source instance.
     */
    STDMETHOD_(UINT16, GetStreamCount)(THIS);

    /************************************************************************
     *	Method:
     *	    IHXStreamSource::GetStream
     *	Purpose:
     *	    Returns the Nth stream instance supported by this source.
     */
    STDMETHOD(GetStream)	(THIS_
				UINT16		nIndex,
				REF(IUnknown*)	pUnknown);

    /************************************************************************
     *	Method:
     *		HXSource::ReportError
     *	Purpose:
     *		The protocol object reports of any fatal errors. 
     *
     */
    void	ReportError (HX_RESULT theErr);


    // 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) = 0;

    /*
     *	IHXRegistryID methods
     */

    /************************************************************************
     *	Method:
     *	    IHXRegistryID::GetID
     *	Purpose:
     *	    Get registry ID(hash_key) of the objects(player, source and stream)
     *
     */
    STDMETHOD(GetID)		(THIS_
				REF(UINT32) /*OUT*/  ulRegistryID) = 0;


    // IHXPrivateStreamSource methods 
    STDMETHOD_ (BOOL,IsSaveAllowed)	(THIS);


    /*
     * IHXBackChannel method
     */
    /************************************************************************
     *	Method:
     *	    IHXBackChannel::PacketReady
     *	Purpose:
     *      A back channel packet sent from Renderer to FileFormat plugin.
     */
    STDMETHOD(PacketReady)	(THIS_
				IHXPacket* pPacket);

    /*
     * IHXASMSource methods
     */