mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
285 lines
9.2 KiB
C++
285 lines
9.2 KiB
C++
/* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */
|
|
/* vim: set ts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_dom_audiochannelservice_h__
|
|
#define mozilla_dom_audiochannelservice_h__
|
|
|
|
#include "nsAutoPtr.h"
|
|
#include "nsIObserver.h"
|
|
#include "nsTArray.h"
|
|
#include "nsITimer.h"
|
|
|
|
#include "AudioChannelCommon.h"
|
|
#include "AudioChannelAgent.h"
|
|
#include "nsAttrValue.h"
|
|
#include "nsClassHashtable.h"
|
|
#include "mozilla/dom/AudioChannelBinding.h"
|
|
|
|
class nsIRunnable;
|
|
class nsPIDOMWindow;
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
#ifdef MOZ_WIDGET_GONK
|
|
class SpeakerManagerService;
|
|
#endif
|
|
class AudioChannelService
|
|
: public nsIObserver
|
|
, public nsITimerCallback
|
|
{
|
|
public:
|
|
NS_DECL_ISUPPORTS
|
|
NS_DECL_NSIOBSERVER
|
|
NS_DECL_NSITIMERCALLBACK
|
|
|
|
/**
|
|
* Returns the AudioChannelServce singleton. Only to be called from main
|
|
* thread.
|
|
*
|
|
* @return NS_OK on proper assignment, NS_ERROR_FAILURE otherwise.
|
|
*/
|
|
static AudioChannelService* GetAudioChannelService();
|
|
|
|
/**
|
|
* Shutdown the singleton.
|
|
*/
|
|
static void Shutdown();
|
|
|
|
/**
|
|
* Any audio channel agent that starts playing should register itself to
|
|
* this service, sharing the AudioChannel.
|
|
*/
|
|
virtual void RegisterAudioChannelAgent(AudioChannelAgent* aAgent,
|
|
AudioChannel aChannel,
|
|
bool aWithVideo);
|
|
|
|
/**
|
|
* Any audio channel agent that stops playing should unregister itself to
|
|
* this service.
|
|
*/
|
|
virtual void UnregisterAudioChannelAgent(AudioChannelAgent* aAgent);
|
|
|
|
/**
|
|
* Return the state to indicate this agent should keep playing/
|
|
* fading volume/muted.
|
|
*/
|
|
virtual AudioChannelState GetState(AudioChannelAgent* aAgent,
|
|
bool aElementHidden);
|
|
|
|
/**
|
|
* Return true if there is a content channel active in this process
|
|
* or one of its subprocesses.
|
|
*/
|
|
virtual bool ContentOrNormalChannelIsActive();
|
|
|
|
/**
|
|
* Return true if there is a telephony channel active in this process
|
|
* or one of its subprocesses.
|
|
*/
|
|
virtual bool TelephonyChannelIsActive();
|
|
|
|
/**
|
|
* Return true if a normal or content channel is active for the given
|
|
* process ID.
|
|
*/
|
|
virtual bool ProcessContentOrNormalChannelIsActive(uint64_t aChildID);
|
|
|
|
/***
|
|
* AudioChannelManager calls this function to notify the default channel used
|
|
* to adjust volume when there is no any active channel. if aChannel is -1,
|
|
* the default audio channel will be used. Otherwise aChannel is casted to
|
|
* AudioChannel enum.
|
|
*/
|
|
virtual void SetDefaultVolumeControlChannel(int32_t aChannel,
|
|
bool aHidden);
|
|
|
|
bool AnyAudioChannelIsActive();
|
|
|
|
void RefreshAgentsVolume(nsPIDOMWindow* aWindow);
|
|
|
|
#ifdef MOZ_WIDGET_GONK
|
|
void RegisterSpeakerManager(SpeakerManagerService* aSpeakerManager)
|
|
{
|
|
if (!mSpeakerManager.Contains(aSpeakerManager)) {
|
|
mSpeakerManager.AppendElement(aSpeakerManager);
|
|
}
|
|
}
|
|
|
|
void UnregisterSpeakerManager(SpeakerManagerService* aSpeakerManager)
|
|
{
|
|
mSpeakerManager.RemoveElement(aSpeakerManager);
|
|
}
|
|
#endif
|
|
|
|
static const nsAttrValue::EnumTable* GetAudioChannelTable();
|
|
static AudioChannel GetAudioChannel(const nsAString& aString);
|
|
static AudioChannel GetDefaultAudioChannel();
|
|
static void GetAudioChannelString(AudioChannel aChannel, nsAString& aString);
|
|
static void GetDefaultAudioChannelString(nsAString& aString);
|
|
|
|
void Notify();
|
|
|
|
protected:
|
|
void SendNotification();
|
|
|
|
/**
|
|
* Send the audio-channel-changed notification for the given process ID if
|
|
* needed.
|
|
*/
|
|
void SendAudioChannelChangedNotification(uint64_t aChildID);
|
|
|
|
/* Register/Unregister IPC types: */
|
|
void RegisterType(AudioChannel aChannel, uint64_t aChildID, bool aWithVideo);
|
|
void UnregisterType(AudioChannel aChannel, bool aElementHidden,
|
|
uint64_t aChildID, bool aWithVideo);
|
|
void UnregisterTypeInternal(AudioChannel aChannel, bool aElementHidden,
|
|
uint64_t aChildID, bool aWithVideo);
|
|
|
|
AudioChannelState GetStateInternal(AudioChannel aChannel, uint64_t aChildID,
|
|
bool aElementHidden,
|
|
bool aElementWasHidden);
|
|
|
|
/* Update the internal type value following the visibility changes */
|
|
void UpdateChannelType(AudioChannel aChannel, uint64_t aChildID,
|
|
bool aElementHidden, bool aElementWasHidden);
|
|
|
|
/* Send the default-volume-channel-changed notification */
|
|
void SetDefaultVolumeControlChannelInternal(int32_t aChannel,
|
|
bool aHidden, uint64_t aChildID);
|
|
|
|
AudioChannelState CheckTelephonyPolicy(AudioChannel aChannel,
|
|
uint64_t aChildID);
|
|
void RegisterTelephonyChild(uint64_t aChildID);
|
|
void UnregisterTelephonyChild(uint64_t aChildID);
|
|
|
|
AudioChannelService();
|
|
virtual ~AudioChannelService();
|
|
|
|
enum AudioChannelInternalType {
|
|
AUDIO_CHANNEL_INT_NORMAL = 0,
|
|
AUDIO_CHANNEL_INT_NORMAL_HIDDEN,
|
|
AUDIO_CHANNEL_INT_CONTENT,
|
|
AUDIO_CHANNEL_INT_CONTENT_HIDDEN,
|
|
AUDIO_CHANNEL_INT_NOTIFICATION,
|
|
AUDIO_CHANNEL_INT_NOTIFICATION_HIDDEN,
|
|
AUDIO_CHANNEL_INT_ALARM,
|
|
AUDIO_CHANNEL_INT_ALARM_HIDDEN,
|
|
AUDIO_CHANNEL_INT_TELEPHONY,
|
|
AUDIO_CHANNEL_INT_TELEPHONY_HIDDEN,
|
|
AUDIO_CHANNEL_INT_RINGER,
|
|
AUDIO_CHANNEL_INT_RINGER_HIDDEN,
|
|
AUDIO_CHANNEL_INT_PUBLICNOTIFICATION,
|
|
AUDIO_CHANNEL_INT_PUBLICNOTIFICATION_HIDDEN,
|
|
AUDIO_CHANNEL_INT_LAST
|
|
};
|
|
|
|
bool ChannelsActiveWithHigherPriorityThan(AudioChannelInternalType aType);
|
|
|
|
bool CheckVolumeFadedCondition(AudioChannelInternalType aType,
|
|
bool aElementHidden);
|
|
|
|
AudioChannelInternalType GetInternalType(AudioChannel aChannel,
|
|
bool aElementHidden);
|
|
|
|
class AudioChannelAgentData {
|
|
public:
|
|
AudioChannelAgentData(AudioChannel aChannel,
|
|
bool aElementHidden,
|
|
AudioChannelState aState,
|
|
bool aWithVideo)
|
|
: mChannel(aChannel)
|
|
, mElementHidden(aElementHidden)
|
|
, mState(aState)
|
|
, mWithVideo(aWithVideo)
|
|
{}
|
|
|
|
AudioChannel mChannel;
|
|
bool mElementHidden;
|
|
AudioChannelState mState;
|
|
const bool mWithVideo;
|
|
};
|
|
|
|
static PLDHashOperator
|
|
NotifyEnumerator(AudioChannelAgent* aAgent,
|
|
AudioChannelAgentData* aData, void *aUnused);
|
|
|
|
static PLDHashOperator
|
|
RefreshAgentsVolumeEnumerator(AudioChannelAgent* aAgent,
|
|
AudioChannelAgentData* aUnused,
|
|
void *aPtr);
|
|
|
|
static PLDHashOperator
|
|
CountWindowEnumerator(AudioChannelAgent* aAgent,
|
|
AudioChannelAgentData* aUnused,
|
|
void *aPtr);
|
|
|
|
// This returns the number of agents from this aWindow.
|
|
uint32_t CountWindow(nsIDOMWindow* aWindow);
|
|
|
|
nsClassHashtable< nsPtrHashKey<AudioChannelAgent>, AudioChannelAgentData > mAgents;
|
|
#ifdef MOZ_WIDGET_GONK
|
|
nsTArray<SpeakerManagerService*> mSpeakerManager;
|
|
#endif
|
|
nsTArray<uint64_t> mChannelCounters[AUDIO_CHANNEL_INT_LAST];
|
|
|
|
int32_t mCurrentHigherChannel;
|
|
int32_t mCurrentVisibleHigherChannel;
|
|
|
|
nsTArray<uint64_t> mWithVideoChildIDs;
|
|
|
|
// Telephony Channel policy is "LIFO", the last app to require the resource is
|
|
// allowed to play. The others are muted.
|
|
struct TelephonyChild {
|
|
uint64_t mChildID;
|
|
uint32_t mInstances;
|
|
|
|
explicit TelephonyChild(uint64_t aChildID)
|
|
: mChildID(aChildID)
|
|
, mInstances(1)
|
|
{}
|
|
};
|
|
nsTArray<TelephonyChild> mTelephonyChildren;
|
|
|
|
// mPlayableHiddenContentChildID stores the ChildID of the process which can
|
|
// play content channel(s) in the background.
|
|
// A background process contained content channel(s) will become playable:
|
|
// 1. When this background process registers its content channel(s) in
|
|
// AudioChannelService and there is no foreground process with registered
|
|
// content channel(s).
|
|
// 2. When this process goes from foreground into background and there is
|
|
// no foreground process with registered content channel(s).
|
|
// A background process contained content channel(s) will become non-playable:
|
|
// 1. When there is a foreground process registering its content channel(s)
|
|
// in AudioChannelService.
|
|
// ps. Currently this condition is never satisfied because the default value
|
|
// of visibility status of each channel during registering is hidden = true.
|
|
// 2. When there is a process with registered content channel(s) goes from
|
|
// background into foreground.
|
|
// 3. When this process unregisters all hidden content channels.
|
|
// 4. When this process shuts down.
|
|
uint64_t mPlayableHiddenContentChildID;
|
|
|
|
bool mDisabled;
|
|
|
|
nsCOMPtr<nsIRunnable> mRunnable;
|
|
|
|
nsCOMPtr<nsITimer> mDeferTelChannelTimer;
|
|
bool mTimerElementHidden;
|
|
uint64_t mTimerChildID;
|
|
|
|
uint64_t mDefChannelChildID;
|
|
|
|
// This is needed for IPC comunication between
|
|
// AudioChannelServiceChild and this class.
|
|
friend class ContentParent;
|
|
friend class ContentChild;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif
|