hxaudses.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:22k
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: RCSL 1.0/RPSL 1.0
- *
- * Portions Copyright (c) 1995-2002 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
- * Version 1.0 (the "RPSL") available at
- * http://www.helixcommunity.org/content/rpsl unless you have licensed
- * the file under the RealNetworks Community Source License Version 1.0
- * (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.
- *
- * 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 _HXAUDSES_H
- #define _HXAUDSES_H
- #include "hxaudtyp.h"
- #ifdef _UNIX
- #include <fcntl.h>
- #include <sys/stat.h>
- #endif
- // foward decls.
- struct IHXCallback;
- struct IHXScheduler;
- struct IHXPreferences;
- struct IHXAudioDeviceResponse;
- struct IHXAudioPlayerResponse;
- struct IHXAudioAdviseSink;
- struct IHXAudioDeviceManager;
- struct IHXAudioHook;
- struct IHXInterruptState;
- typedef struct _HXAudioFormat HXAudioFormat;
- class CHXAudioPlayer;
- class CHXAudioDevice;
- class CHXAudioStream;
- class CHXSimpleList;
- class HXVolumeAdviseSink;
- struct IHXBuffer;
- class Timeval;
- class HXThread;
- class HXMutex;
- class HXEvent;
- #ifdef HELIX_CONFIG_MIN_PCM_PUSHDOWN_BYTES
- #define MINIMUM_INITIAL_PUSHDOWN 100
- #else
- #define MINIMUM_INITIAL_PUSHDOWN 4000
- #endif
- typedef enum
- {
- BUFFER_NONE = 0,
- BUFFER_PLAYER = 1,
- BUFFER_SESSION = 2
- } BufType;
- class CHXAudioSession : public IHXAudioDeviceResponse,
- public IHXAudioDeviceManager,
- public IHXAudioHookManager,
- public IHXAudioDeviceManager2,
- #ifdef HELIX_FEATURE_VOLUME
- public IHXVolumeAdviseSink,
- #endif
- public IHXCallback,
- public IHXAudioResamplerManager,
- public IHXAudioPushdown2
- {
- public:
- /*
- * IUnknown methods
- */
- STDMETHOD(QueryInterface) (THIS_
- REFIID riid,
- void** ppvObj);
- STDMETHOD_(ULONG32,AddRef) (THIS);
- STDMETHOD_(ULONG32,Release) (THIS);
- CHXAudioSession(void);
- #ifdef HELIX_FEATURE_VOLUME
- //IHXVolumeAdviseSink methods
- inline STDMETHOD(OnVolumeChange) (THIS_ const UINT16 uVolume )
- {
- SetVolume(uVolume);
- return HXR_OK;
- }
- inline STDMETHOD(OnMuteChange)(THIS_ const BOOL bMute )
- {
- SetMute(bMute);
- return HXR_OK;
- }
- #endif
-
- /*
- * IHXAudioDeviceManager methods
- */
- /************************************************************************
- * Method:
- * IHXAudioDeviceManager::Replace
- * Purpose:
- * This is used to replace the default implementation of the audio
- * device by the given audio device interface.
- */
- STDMETHOD(Replace) (THIS_
- IHXAudioDevice* /*IN*/ pAudioDevice);
- /************************************************************************
- * Method:
- * IHXAudioDeviceManager::Remove
- * Purpose:
- * This is used to remove the audio device given to the manager in
- * the earlier call to Replace.
- */
- STDMETHOD(Remove) (THIS_
- IHXAudioDevice* /*IN*/ pAudioDevice);
- /************************************************************************
- * Method:
- * IHXAudioDeviceManager::AddFinalHook
- * Purpose:
- * One last chance to modify data being written to the audio device.
- * This hook allows the user to change the audio format that
- * is to be written to the audio device. This can be done in call
- * to OnInit() in IHXAudioHook.
- */
- STDMETHOD(SetFinalHook) (THIS_
- IHXAudioHook* /*IN*/ pHook
- );
- /************************************************************************
- * Method:
- * IHXAudioDeviceManager::RemoveFinalHook
- * Purpose:
- * Remove final hook
- */
- STDMETHOD(RemoveFinalHook) (THIS_
- IHXAudioHook* /*IN*/ pHook
- );
- /************************************************************************
- * Method:
- * IHXAudioDeviceManager::GetAudioFormat
- * Purpose:
- * Returns the audio format in which the audio device is opened.
- * This function will fill in the pre-allocated HXAudioFormat
- * structure passed in.
- */
- STDMETHOD(GetAudioFormat) (THIS_
- HXAudioFormat* /*IN/OUT*/pAudioFormat);
- /*
- * IHXAudioDeviceResponse methods
- */
- /************************************************************************
- * Method:
- * IHXAudioDeviceResponse::OnTimeSync
- * Purpose:
- * Notification interface provided by users of the IHXAudioDevice
- * interface. This method is called by the IHXAudioDevice when
- * audio playback occurs.
- */
- STDMETHOD(OnTimeSync) (THIS_
- ULONG32 /*IN*/ ulTimeEnd);
- /*
- * IHXAudioHookManager methods
- */
- /************************************************************************
- * Method:
- * IHXAudioHookManager::AddHook
- * Purpose:
- * Use this to add a hook
- */
- STDMETHOD(AddHook) (THIS_
- IHXAudioHook* /*IN*/ pHook);
- /************************************************************************
- * Method:
- * IHXAudioHookManager::RemoveHook
- * Purpose:
- * Use this to remove a hook
- */
- STDMETHOD(RemoveHook) (THIS_
- IHXAudioHook* /*IN*/ pHook);
- /*
- * IHXAudioDeviceManager2 methods
- */
- /**********************************************************************
- * Method:
- * IHXAudioDeviceManager2::IsReplacedDevice
- * Purpose:
- * This is used to determine if the audio device has been replaced.
- */
- STDMETHOD_(BOOL, IsReplacedDevice) (THIS);
- /*
- * IHXAudioResamplerManager methods
- *
- */
- STDMETHOD(CreateResampler) (THIS_
- HXAudioFormat inAudioFormat,
- REF(HXAudioFormat) outAudioFormat,
- REF(IHXAudioResampler*) pResampler);
- /*
- * IHXAudioPushdown methods
- */
- /************************************************************************
- * Method:
- * IHXAudioPushdown::SetAudioPushdown
- * Purpose:
- * Use this to set the minimum audio pushdown value in ms.
- * This is the amount of audio data that is being written
- * to the audio device before starting playback.
- */
- STDMETHOD(SetAudioPushdown) (THIS_
- UINT32 /*IN*/ ulMinimumPushdown);
- /************************************************************************
- * Method:
- * IHXAudioPushdown2::GetAudioPushdown
- * Purpose:
- * Use this to get the minimum audio pushdown value in ms.
- * This is the amount of audio data that is being written
- * to the audio device before starting playback.
- */
- STDMETHOD(GetAudioPushdown) (THIS_
- REF(UINT32) /*OUT*/ ulAudioPushdown);
- /************************************************************************
- * Method:
- * IHXAudioPushdown2::GetCurrentAudioDevicePushdown
- * Purpose:
- * Use this to get the audio pushed down to the audio device and haven't
- * been played yet
- */
- STDMETHOD(GetCurrentAudioDevicePushdown) (THIS_
- REF(UINT32) /*OUT*/ ulAudioPusheddown);
- /* It gets Scheduler interface from the context.
- * The session object keeps a list of audio player objects.
- * Create a session list; add this session to the list.
- */
- HX_RESULT Init(IUnknown* pContext);
- /* Setup is called by Audio Player object.
- */
- HX_RESULT Setup (BOOL bHasStreams);
- /* Create audio player. The RMA session object calls this
- * for each Player it knows about.
- */
- virtual HX_RESULT CreateAudioPlayer(CHXAudioPlayer** ppAudioPlayer);
- HX_RESULT _CreateAudioPlayer(CHXAudioPlayer** ppAudioPlayer);
- HX_RESULT CloseAudioPlayer( CHXAudioPlayer* pAudioPlayer);
- void Close(void);
- /* The session object determines the audio device format based
- * on all of its players.
- */
- HX_RESULT GetDeviceFormat(void);
- /* Open is called to open the audio device.
- */
- HX_RESULT OpenAudio (void);
- HX_RESULT OpenDevice (void);
-
- /* PlayAudio is called by Audio Player object.
- */
- HX_RESULT PlayAudio (UINT16 uNumBlocks = 1);
- /* Pause is called by Audio Player object.
- */
- HX_RESULT Pause (CHXAudioPlayer* p);
- /* Resume is called by Audio Player object.
- */
- HX_RESULT Resume (CHXAudioPlayer* pPlayer = NULL);
- /* Stop is called by Audio Player object.
- */
- HX_RESULT Stop (CHXAudioPlayer* p, BOOL bFlush);
- /* Seek is called by Audio Player object.
- */
- HX_RESULT Seek (
- CHXAudioPlayer* pPlayerToExclude,
- const UINT32 ulSeekTime
- );
- /* Return the device volume interface */
- inline IHXVolume* GetDeviceVolume()
- {
- #if defined(HELIX_FEATURE_VOLUME)
- if( m_pDeviceVolume )
- m_pDeviceVolume->AddRef();
- return m_pDeviceVolume;
- #else
- return NULL;
- #endif /* HELIX_FEATURE_VOLUME */
- }
- /* The player object sets the granularity; I think the RMA session
- * object should do this after it resolves the granularity amongst
- * all of its players.
- */
- /* Granularity is always 100ms now...
- * The core keeps track of the granularity requirements for each
- * renderer and queries audio sesssion.
- */
- ULONG32 SetGranularity(ULONG32 ulGranularity);
- /* Reset audio session; flush buffers, etc.
- */
- virtual void ResetSession(void);
- virtual HX_RESULT ProcessAudioHook(PROCESS_ACTION action,
- IHXAudioHook* pAudioHook);
- virtual HX_RESULT ProcessAudioDevice(PROCESS_ACTION action,
- IHXAudioDevice* pAudioDevice);
- virtual HX_RESULT CreateAudioDevice();
- void ReleaseAudioDevice();
- void RestoreReplacedDevice();
- ULONG32 GetCurrentPlayBackTime(void);
- /* Get format that audio device was opened with. */
- void GetFormat( HXAudioFormat* pAudioFmt );
- /* Return the core scheduler interface.
- */
- inline void GetScheduler(IHXScheduler** pScheduler)
- {
- *pScheduler = m_pScheduler;
- };
- void SetVolume(const UINT16 uVolume );
- UINT16 GetVolume();
- void SetMute(const BOOL bMute);
- inline BOOL GetMute()
- {
- return m_bMute;
- }
-
- /* Return the current time in timeline. */
- //ULONG32 GetCurrentPlaybackTime(void);
- /* Returns true if any audio player is playing... */
- BOOL IsPlaying(void);
- /* Returns number of active players (which are not is a STOP state).*/
- UINT16 NumberOfActivePlayers(void);
- UINT16 NumberOfResumedPlayers(void);
- inline void ToBeRewound() {m_bToBeRewound = TRUE;};
- BOOL CheckDisableWrite(void);
- ULONG32 GetInitialPushdown(BOOL bAtStart = FALSE);
- HX_RESULT CheckToPlayMoreAudio();
- HX_RESULT TryOpenAudio (void); // attempt to open audio
-
- void StopAllOtherPlayers();
- inline HX_RESULT CheckForBufferReuse();
- void ConvertTo8BitAndOrMono(HXAudioData* pAudioData);
-
- double ConvertMsToBytes(UINT32 ulCurrentTime);
- inline double NumberOfBytesWritten() {return m_dNumBytesWritten;};
- inline double GetNumBytesPlayed() {return m_dNumBytesPlayed;};
- void SetCoreMutex(HXMutex* pMutex) {m_pCoreMutex = pMutex;};
- void CheckIfLastNMilliSecsToBeStored();
- void RewindSession(CHXAudioPlayer* pPlayerToExclude = NULL);
- void RewindAllPlayers(UINT32 ulCurTime,
- UINT32 ulTimeToRewind,
- CHXAudioPlayer* pPlayerToExclude);
- HX_RESULT ActualResume();
- inline UINT32 GetLastRewindTimestamp(void) {return m_ulLastRewindTimestamp;};
- BOOL ReallyNeedData();
- inline void UseCoreThread() {m_bShouldOpenOnCoreThread = TRUE;};
- inline void PostMixHooksUpdated(void) { m_bPostMixHooksUpdated = TRUE; };
- BOOL GetDisableMultiPlayPauseSupport();
- //IHXCallback stuff
- STDMETHOD(Func) (THIS);
- IUnknown* m_pContext;
- class HXDeviceSetupCallback :
- public IHXCallback,
- public IHXInterruptSafe
- {
- private:
- ~HXDeviceSetupCallback();
- PRIVATE_DESTRUCTORS_ARE_NOT_A_CRIME
-
- CHXAudioSession* m_pAudioSessionObject;
- ULONG32 m_ulCallbackID;
- LONG32 m_lRefCount;
- public:
- HXDeviceSetupCallback(CHXAudioSession* it);
- STDMETHOD(QueryInterface) (THIS_ REFIID riid, void** ppvObj);
- STDMETHOD_(ULONG32,AddRef) (THIS);
- STDMETHOD_(ULONG32,Release) (THIS);
- STDMETHOD(Func) (THIS);
- STDMETHOD_(BOOL,IsInterruptSafe) (THIS);
- void PendingID(ULONG32 it )
- { m_ulCallbackID = it;}
- ULONG32 PendingID()
- { return m_ulCallbackID; }
-
- };
- friend class CHXAudioSession::HXDeviceSetupCallback;
- protected:
- ~CHXAudioSession(void);
- PRIVATE_DESTRUCTORS_ARE_NOT_A_CRIME
- void _ConstructIfNeeded();
-
- private:
- #ifdef _MACINTOSH
- static BOOL zm_Locked;
- #endif
- LONG32 m_lRefCount;
- IHXScheduler* m_pScheduler;
- IHXPreferences* m_pPreferences;
- IHXInterruptState* m_pInterruptState;
- HXAudioFormat m_BeforeHookDeviceFmt; // Actual Audio device format.
- HXAudioFormat m_ActualDeviceFmt; // Actual Audio device format.
- HXAudioFormat m_DeviceFmt; // Audio device format used for all calculations.
- IHXBuffer* m_pPlayerBuf;
- IHXBuffer* m_pSessionBuf;
- ULONG32 m_ulGranularity; // Amount of audio to push (ms).
- double m_dGranularity;
- ULONG32 m_ulMinimumPushdown;
- ULONG32 m_ulIdealMinimumPushdown;
- ULONG32 m_ulMinBlocksTobeQueued;
- ULONG32 m_ulMinBlocksTobeQueuedAtStart;
- ULONG32 m_ulBytesPerGran; // Number of bytes in gran
- ULONG32 m_ulBlocksWritten; // Number of blocks written so far
- ULONG32 m_ulCallbackID;
- BOOL m_bFakeAudioTimeline;
-
- BOOL m_bShouldOpenOnCoreThread;
- BOOL m_bToBeReOpened;
- HXDeviceSetupCallback* m_pDeviceCallback;
- BOOL m_bHasStreams; // True if there are audio streams
- /* We keep a track of the current time when we use Scheduler for
- * genertaing time syncs.
- */
- ULONG32 m_ulIncreasingTimer;
- /* This is the actual time we report back to the player->renderers
- * It gets set in the OnTimeSync
- */
- ULONG32 m_ulCurrentTime;
- ULONG32 m_ulLastAudioTime;
- ULONG32 m_ulLastAudioReturnTime;
- ULONG32 m_ulLastSystemTime;
- BOOL m_bAtLeastOneTimeReceived;
- ULONG32 m_ulStartTime;
- BOOL m_bTimeSyncReceived;
- BOOL m_bPaused;
- BOOL m_bStoppedDuringPause;
- ULONG32 m_ulLastFakeCallbackTime;
- Timeval* m_pFakeAudioCBTime;
- HXAudioData* m_pInDataPtr;
- HXAudioData* m_pOutDataPtr;
- /*
- * Should be in a data structure with the player objects and stuffed
- * on the list.
- */
- IHXAudioPlayerResponse* m_pPlayerResponse; // Notification interface
- BOOL m_bFirstPlayAudio;
- UINT16 m_uVolume; // Default volume
- BOOL m_bMute; // the mute state
- BOOL m_bAudioDeviceSupportsVolume;
- /*
- * Continuous session play back time. This is the time written to the audio
- * device object for each buffer. This is the time that each audio player
- * retrieves as its start time.
- */
- double m_dBufEndTime;
- BOOL m_bDisableWrite;
- BOOL m_bInPlayAudio;
- BOOL m_bInActualResume;
- double m_dNumBytesWritten;
- double m_dNumBytesPlayed;
- /* CheckAudioFormat Interface is called by audio player to
- * check resample audio format with audio device format.
- */
- HX_RESULT CheckAudioFormat(
- HXAudioFormat* pAudioFormat );
- /* Create the playback buffer.
- */
- HX_RESULT CreatePlaybackBuffer(void);
- void OnTimerCallback();
- inline void CheckAudioVolume()
- {}
-
- /* Write audio data to post mix hooks. */
- HX_RESULT ProcessPostMixHooks(
- CHXAudioPlayer* pPlayer,
- IHXBuffer*& pInBuffer,
- BOOL* bDisableWrite,
- UINT32 ulBufTime,
- BOOL& bChanged);
-
- void InitHooks();
- void ProcessHooks(HXAudioData* pAudioData);
- /* Convert 16-bit buffer to 8-bit */
- void ConvertToEight(void);
- BOOL IsAudioOnlyTrue(void);
-
- UINT32 AnchorDeviceTime(UINT32 ulCurTime);
- void AdjustInRealTime();
- HX_RESULT Rewind();
- void UpdateMinimumPushdown();
- void ReopenDevice();
-
- protected:
- BOOL m_bInited; // is audio setup?
- IHXAudioDevice* m_pAudioDev; // device layer
- IHXAudioDevice* m_pCurrentAudioDev; // keep track of the current device layer
- IHXAudioDevice* m_pReplacedAudioDev; // keep track of replaced audio device
- BOOL m_bReplacedDev; // is audio device replaced?
- CHXSimpleList* m_pPlayerList; // list of player audio sessions
- CHXSimpleList* m_pHookList; // hook list
- // Any audio buffers that we were not able to write to the audio
- // device successfully
- CHXSimpleList* m_pAuxiliaryAudioBuffers;
- HXMutex* m_pMutex;
- IHXAudioHook* m_pFinalHook;
- BOOL m_bUseFinalHook;
- HXMutex* m_pCoreMutex;
- UINT16 m_uAskFromAudioDevice;
- BOOL m_bDeferActualResume;
- CHXAudioPlayer* m_pLastPausedPlayer;
- BOOL m_bUsingReplacedDevice;
- BOOL m_bToBeRewound;
- UINT32 m_ulLastRewindTimestamp;
- UINT16 m_uNumToBePushed;
- BOOL m_bSessionBufferDirty;
- BOOL m_bPostMixHooksUpdated;
- IHXMultiPlayPauseSupport* m_pMPPSupport;
- #ifdef HELIX_FEATURE_VOLUME
- IHXVolume* m_pDeviceVolume;
- #endif
- };
- #endif // _HXAUDSES_H