/* -*- 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/. */ #include "FMRadioService.h" #include "mozilla/Hal.h" #include "nsIAudioManager.h" #include "AudioManager.h" #include "nsDOMClassInfo.h" #include "mozilla/Preferences.h" #include "mozilla/dom/FMRadioChild.h" #include "nsIObserverService.h" #include "nsISettingsService.h" #include "nsJSUtils.h" #include "nsCxPusher.h" #define BAND_87500_108000_kHz 1 #define BAND_76000_108000_kHz 2 #define BAND_76000_90000_kHz 3 #define MOZSETTINGS_CHANGED_ID "mozsettings-changed" #define SETTING_KEY_AIRPLANEMODE_ENABLED "airplaneMode.enabled" using namespace mozilla::hal; using mozilla::Preferences; BEGIN_FMRADIO_NAMESPACE // static IFMRadioService* IFMRadioService::Singleton() { if (XRE_GetProcessType() != GeckoProcessType_Default) { return FMRadioChild::Singleton(); } else { return FMRadioService::Singleton(); } } StaticRefPtr FMRadioService::sFMRadioService; FMRadioService::FMRadioService() : mPendingFrequencyInKHz(0) , mState(Disabled) , mHasReadAirplaneModeSetting(false) , mAirplaneModeEnabled(false) , mPendingRequest(nullptr) , mObserverList(FMRadioEventObserverList()) { // Read power state and frequency from Hal. mEnabled = IsFMRadioOn(); if (mEnabled) { mPendingFrequencyInKHz = GetFMRadioFrequency(); SetState(Enabled); } switch (Preferences::GetInt("dom.fmradio.band", BAND_87500_108000_kHz)) { case BAND_76000_90000_kHz: mUpperBoundInKHz = 90000; mLowerBoundInKHz = 76000; break; case BAND_76000_108000_kHz: mUpperBoundInKHz = 108000; mLowerBoundInKHz = 76000; break; case BAND_87500_108000_kHz: default: mUpperBoundInKHz = 108000; mLowerBoundInKHz = 87500; break; } mChannelWidthInKHz = Preferences::GetInt("dom.fmradio.channelWidth", 100); switch (mChannelWidthInKHz) { case 50: case 100: case 200: break; default: NS_WARNING("Invalid channel width specified in dom.fmradio.channelwidth"); mChannelWidthInKHz = 100; break; } mPreemphasis = Preferences::GetInt("dom.fmradio.preemphasis", 50); switch (mPreemphasis) { // values in microseconds case 0: case 50: case 75: break; default: NS_WARNING("Invalid preemphasis specified in dom.fmradio.preemphasis"); mPreemphasis = 50; break; } nsCOMPtr obs = services::GetObserverService(); if (obs && NS_FAILED(obs->AddObserver(this, MOZSETTINGS_CHANGED_ID, /* useWeak */ false))) { NS_WARNING("Failed to add settings change observer!"); } RegisterFMRadioObserver(this); } FMRadioService::~FMRadioService() { UnregisterFMRadioObserver(this); } class EnableRunnable MOZ_FINAL : public nsRunnable { public: EnableRunnable(uint32_t aUpperLimit, uint32_t aLowerLimit, uint32_t aSpaceType, uint32_t aPreemphasis) : mUpperLimit(aUpperLimit) , mLowerLimit(aLowerLimit) , mSpaceType(aSpaceType) , mPreemphasis(aPreemphasis) { } NS_IMETHOD Run() { FMRadioSettings info; info.upperLimit() = mUpperLimit; info.lowerLimit() = mLowerLimit; info.spaceType() = mSpaceType; info.preEmphasis() = mPreemphasis; EnableFMRadio(info); return NS_OK; } private: uint32_t mUpperLimit; uint32_t mLowerLimit; uint32_t mSpaceType; uint32_t mPreemphasis; }; /** * Read the airplane-mode setting, if the airplane-mode is not enabled, we * enable the FM radio. */ class ReadAirplaneModeSettingTask MOZ_FINAL : public nsISettingsServiceCallback { public: NS_DECL_ISUPPORTS ReadAirplaneModeSettingTask(nsRefPtr aPendingRequest) : mPendingRequest(aPendingRequest) { } NS_IMETHOD Handle(const nsAString& aName, JS::Handle aResult) { FMRadioService* fmRadioService = FMRadioService::Singleton(); MOZ_ASSERT(mPendingRequest == fmRadioService->mPendingRequest); fmRadioService->mHasReadAirplaneModeSetting = true; if (!aResult.isBoolean()) { // Failed to read the setting value, set the state back to Disabled. fmRadioService->TransitionState( ErrorResponse(NS_LITERAL_STRING("Unexpected error")), Disabled); return NS_OK; } fmRadioService->mAirplaneModeEnabled = aResult.toBoolean(); if (!fmRadioService->mAirplaneModeEnabled) { EnableRunnable* runnable = new EnableRunnable(fmRadioService->mUpperBoundInKHz, fmRadioService->mLowerBoundInKHz, fmRadioService->mChannelWidthInKHz, fmRadioService->mPreemphasis); NS_DispatchToMainThread(runnable); } else { // Airplane mode is enabled, set the state back to Disabled. fmRadioService->TransitionState(ErrorResponse( NS_LITERAL_STRING("Airplane mode currently enabled")), Disabled); } return NS_OK; } NS_IMETHOD HandleError(const nsAString& aName) { FMRadioService* fmRadioService = FMRadioService::Singleton(); MOZ_ASSERT(mPendingRequest == fmRadioService->mPendingRequest); fmRadioService->TransitionState(ErrorResponse( NS_LITERAL_STRING("Unexpected error")), Disabled); return NS_OK; } private: nsRefPtr mPendingRequest; }; NS_IMPL_ISUPPORTS(ReadAirplaneModeSettingTask, nsISettingsServiceCallback) class DisableRunnable MOZ_FINAL : public nsRunnable { public: DisableRunnable() { } NS_IMETHOD Run() { // Fix Bug 796733. DisableFMRadio should be called before // SetFmRadioAudioEnabled to prevent the annoying beep sound. DisableFMRadio(); IFMRadioService::Singleton()->EnableAudio(false); return NS_OK; } }; class SetFrequencyRunnable MOZ_FINAL : public nsRunnable { public: SetFrequencyRunnable(int32_t aFrequency) : mFrequency(aFrequency) { } NS_IMETHOD Run() { SetFMRadioFrequency(mFrequency); return NS_OK; } private: int32_t mFrequency; }; class SeekRunnable MOZ_FINAL : public nsRunnable { public: SeekRunnable(FMRadioSeekDirection aDirection) : mDirection(aDirection) { } NS_IMETHOD Run() { switch (mDirection) { case FM_RADIO_SEEK_DIRECTION_UP: case FM_RADIO_SEEK_DIRECTION_DOWN: FMRadioSeek(mDirection); break; default: MOZ_CRASH(); } return NS_OK; } private: FMRadioSeekDirection mDirection; }; void FMRadioService::TransitionState(const FMRadioResponseType& aResponse, FMRadioState aState) { if (mPendingRequest) { mPendingRequest->SetReply(aResponse); NS_DispatchToMainThread(mPendingRequest); } SetState(aState); } void FMRadioService::SetState(FMRadioState aState) { mState = aState; mPendingRequest = nullptr; } void FMRadioService::AddObserver(FMRadioEventObserver* aObserver) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); mObserverList.AddObserver(aObserver); } void FMRadioService::RemoveObserver(FMRadioEventObserver* aObserver) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); mObserverList.RemoveObserver(aObserver); if (mObserverList.Length() == 0) { // Turning off the FM radio HW because observer list is empty. if (IsFMRadioOn()) { NS_DispatchToMainThread(new DisableRunnable()); } } } void FMRadioService::EnableAudio(bool aAudioEnabled) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); nsCOMPtr audioManager = do_GetService("@mozilla.org/telephony/audiomanager;1"); if (!audioManager) { return; } bool audioEnabled; audioManager->GetFmRadioAudioEnabled(&audioEnabled); if (audioEnabled != aAudioEnabled) { audioManager->SetFmRadioAudioEnabled(aAudioEnabled); } } /** * Round the frequency to match the range of frequency and the channel width. If * the given frequency is out of range, return 0. For example: * - lower: 87500KHz, upper: 108000KHz, channel width: 200KHz * 87.6MHz is rounded to 87700KHz * 87.58MHz is rounded to 87500KHz * 87.49MHz is rounded to 87500KHz * 109MHz is not rounded, 0 will be returned * * We take frequency in MHz to prevent precision losing, and return rounded * value in KHz for Gonk using. */ int32_t FMRadioService::RoundFrequency(double aFrequencyInMHz) { double halfChannelWidthInMHz = mChannelWidthInKHz / 1000.0 / 2; // Make sure 87.49999MHz would be rounded to the lower bound when // the lower bound is 87500KHz. if (aFrequencyInMHz < mLowerBoundInKHz / 1000.0 - halfChannelWidthInMHz || aFrequencyInMHz > mUpperBoundInKHz / 1000.0 + halfChannelWidthInMHz) { return 0; } int32_t partToBeRounded = round(aFrequencyInMHz * 1000) - mLowerBoundInKHz; int32_t roundedPart = round(partToBeRounded / (double)mChannelWidthInKHz) * mChannelWidthInKHz; return mLowerBoundInKHz + roundedPart; } bool FMRadioService::IsEnabled() const { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); return IsFMRadioOn(); } double FMRadioService::GetFrequency() const { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); if (IsEnabled()) { int32_t frequencyInKHz = GetFMRadioFrequency(); return frequencyInKHz / 1000.0; } return 0; } double FMRadioService::GetFrequencyUpperBound() const { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); return mUpperBoundInKHz / 1000.0; } double FMRadioService::GetFrequencyLowerBound() const { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); return mLowerBoundInKHz / 1000.0; } double FMRadioService::GetChannelWidth() const { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); return mChannelWidthInKHz / 1000.0; } void FMRadioService::Enable(double aFrequencyInMHz, FMRadioReplyRunnable* aReplyRunnable) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); MOZ_ASSERT(aReplyRunnable); switch (mState) { case Seeking: case Enabled: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently enabled"))); NS_DispatchToMainThread(aReplyRunnable); return; case Disabling: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabling"))); NS_DispatchToMainThread(aReplyRunnable); return; case Enabling: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently enabling"))); NS_DispatchToMainThread(aReplyRunnable); return; case Disabled: break; } int32_t roundedFrequency = RoundFrequency(aFrequencyInMHz); if (!roundedFrequency) { aReplyRunnable->SetReply(ErrorResponse( NS_LITERAL_STRING("Frequency is out of range"))); NS_DispatchToMainThread(aReplyRunnable); return; } if (mHasReadAirplaneModeSetting && mAirplaneModeEnabled) { aReplyRunnable->SetReply(ErrorResponse( NS_LITERAL_STRING("Airplane mode currently enabled"))); NS_DispatchToMainThread(aReplyRunnable); return; } SetState(Enabling); // Cache the enable request just in case disable() is called // while the FM radio HW is being enabled. mPendingRequest = aReplyRunnable; // Cache the frequency value, and set it after the FM radio HW is enabled mPendingFrequencyInKHz = roundedFrequency; if (!mHasReadAirplaneModeSetting) { nsCOMPtr settings = do_GetService("@mozilla.org/settingsService;1"); nsCOMPtr settingsLock; nsresult rv = settings->CreateLock(nullptr, getter_AddRefs(settingsLock)); if (NS_FAILED(rv)) { TransitionState(ErrorResponse( NS_LITERAL_STRING("Can't create settings lock")), Disabled); return; } nsRefPtr callback = new ReadAirplaneModeSettingTask(mPendingRequest); rv = settingsLock->Get(SETTING_KEY_AIRPLANEMODE_ENABLED, callback); if (NS_FAILED(rv)) { TransitionState(ErrorResponse( NS_LITERAL_STRING("Can't get settings lock")), Disabled); } return; } NS_DispatchToMainThread(new EnableRunnable(mUpperBoundInKHz, mLowerBoundInKHz, mChannelWidthInKHz, mPreemphasis)); } void FMRadioService::Disable(FMRadioReplyRunnable* aReplyRunnable) { // When airplane-mode is enabled, we will call this function from // FMRadioService::Observe without passing a FMRadioReplyRunnable, // so we have to check if |aReplyRunnable| is null before we dispatch it. MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); switch (mState) { case Disabling: if (aReplyRunnable) { aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabling"))); NS_DispatchToMainThread(aReplyRunnable); } return; case Disabled: if (aReplyRunnable) { aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabled"))); NS_DispatchToMainThread(aReplyRunnable); } return; case Enabled: case Enabling: case Seeking: break; } nsRefPtr enablingRequest = mPendingRequest; // If the FM Radio is currently seeking, no fail-to-seek or similar // event will be fired, execute the seek callback manually. if (mState == Seeking) { TransitionState(ErrorResponse( NS_LITERAL_STRING("Seek action is cancelled")), Disabling); } FMRadioState preState = mState; SetState(Disabling); mPendingRequest = aReplyRunnable; if (preState == Enabling) { // If the radio is currently enabling, we fire the error callback on the // enable request immediately. When the radio finishes enabling, we'll call // DoDisable and fire the success callback on the disable request. enablingRequest->SetReply( ErrorResponse(NS_LITERAL_STRING("Enable action is cancelled"))); NS_DispatchToMainThread(enablingRequest); // If we haven't read the airplane mode settings yet we won't enable the // FM radio HW, so fail the disable request immediately. if (!mHasReadAirplaneModeSetting) { SetState(Disabled); if (aReplyRunnable) { aReplyRunnable->SetReply(SuccessResponse()); NS_DispatchToMainThread(aReplyRunnable); } } return; } DoDisable(); } void FMRadioService::DoDisable() { // To make such codes work: // navigator.mozFMRadio.disable(); // navigator.mozFMRadio.ondisabled = function() { // console.log("We will catch disabled event "); // }; // we need to call hal::DisableFMRadio() asynchronously. Same reason for // EnableRunnable and SetFrequencyRunnable. NS_DispatchToMainThread(new DisableRunnable()); } void FMRadioService::SetFrequency(double aFrequencyInMHz, FMRadioReplyRunnable* aReplyRunnable) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); MOZ_ASSERT(aReplyRunnable); switch (mState) { case Disabled: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabled"))); NS_DispatchToMainThread(aReplyRunnable); return; case Enabling: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently enabling"))); NS_DispatchToMainThread(aReplyRunnable); return; case Disabling: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabling"))); NS_DispatchToMainThread(aReplyRunnable); return; case Seeking: CancelFMRadioSeek(); TransitionState(ErrorResponse( NS_LITERAL_STRING("Seek action is cancelled")), Enabled); break; case Enabled: break; } int32_t roundedFrequency = RoundFrequency(aFrequencyInMHz); if (!roundedFrequency) { aReplyRunnable->SetReply(ErrorResponse( NS_LITERAL_STRING("Frequency is out of range"))); NS_DispatchToMainThread(aReplyRunnable); return; } NS_DispatchToMainThread(new SetFrequencyRunnable(roundedFrequency)); aReplyRunnable->SetReply(SuccessResponse()); NS_DispatchToMainThread(aReplyRunnable); } void FMRadioService::Seek(FMRadioSeekDirection aDirection, FMRadioReplyRunnable* aReplyRunnable) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); MOZ_ASSERT(aReplyRunnable); switch (mState) { case Enabling: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently enabling"))); NS_DispatchToMainThread(aReplyRunnable); return; case Disabled: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabled"))); NS_DispatchToMainThread(aReplyRunnable); return; case Seeking: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently seeking"))); NS_DispatchToMainThread(aReplyRunnable); return; case Disabling: aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently disabling"))); NS_DispatchToMainThread(aReplyRunnable); return; case Enabled: break; } SetState(Seeking); mPendingRequest = aReplyRunnable; NS_DispatchToMainThread(new SeekRunnable(aDirection)); } void FMRadioService::CancelSeek(FMRadioReplyRunnable* aReplyRunnable) { MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!"); MOZ_ASSERT(aReplyRunnable); // We accept canceling seek request only if it's currently seeking. if (mState != Seeking) { aReplyRunnable->SetReply( ErrorResponse(NS_LITERAL_STRING("FM radio currently not seeking"))); NS_DispatchToMainThread(aReplyRunnable); return; } // Cancel the seek immediately to prevent it from completing. CancelFMRadioSeek(); TransitionState( ErrorResponse(NS_LITERAL_STRING("Seek action is cancelled")), Enabled); aReplyRunnable->SetReply(SuccessResponse()); NS_DispatchToMainThread(aReplyRunnable); } NS_IMETHODIMP FMRadioService::Observe(nsISupports * aSubject, const char * aTopic, const char16_t * aData) { MOZ_ASSERT(NS_IsMainThread()); MOZ_ASSERT(sFMRadioService); if (strcmp(aTopic, MOZSETTINGS_CHANGED_ID) != 0) { return NS_OK; } // The string that we're interested in will be a JSON string looks like: // {"key":"airplaneMode.enabled","value":true} AutoSafeJSContext cx; const nsDependentString dataStr(aData); JS::Rooted val(cx); if (!JS_ParseJSON(cx, dataStr.get(), dataStr.Length(), &val) || !val.isObject()) { NS_WARNING("Bad JSON string format."); return NS_OK; } JS::Rooted obj(cx, &val.toObject()); JS::Rooted key(cx); if (!JS_GetProperty(cx, obj, "key", &key) || !key.isString()) { NS_WARNING("Failed to get string property `key`."); return NS_OK; } JS::Rooted jsKey(cx, key.toString()); nsAutoJSString keyStr; if (!keyStr.init(cx, jsKey)) { return NS_OK; } if (keyStr.EqualsLiteral(SETTING_KEY_AIRPLANEMODE_ENABLED)) { JS::Rooted value(cx); if (!JS_GetProperty(cx, obj, "value", &value)) { NS_WARNING("Failed to get property `value`."); return NS_OK; } if (!value.isBoolean()) { return NS_OK; } mAirplaneModeEnabled = value.toBoolean(); mHasReadAirplaneModeSetting = true; // Disable the FM radio HW if Airplane mode is enabled. if (mAirplaneModeEnabled) { Disable(nullptr); } } return NS_OK; } void FMRadioService::NotifyFMRadioEvent(FMRadioEventType aType) { mObserverList.Broadcast(aType); } void FMRadioService::Notify(const FMRadioOperationInformation& aInfo) { switch (aInfo.operation()) { case FM_RADIO_OPERATION_ENABLE: MOZ_ASSERT(IsFMRadioOn()); MOZ_ASSERT(mState == Disabling || mState == Enabling); // If we're disabling, disable the radio right now. if (mState == Disabling) { DoDisable(); return; } // Fire success callback on the enable request. TransitionState(SuccessResponse(), Enabled); // To make sure the FM app will get the right frequency after the FM // radio is enabled, we have to set the frequency first. SetFMRadioFrequency(mPendingFrequencyInKHz); // Bug 949855: enable audio after the FM radio HW is enabled, to make sure // 'hw.fm.isAnalog' could be detected as |true| during first time launch. // This case is for audio output on analog path, i.e. 'ro.moz.fm.noAnalog' // is not |true|. EnableAudio(true); // Update the current frequency without sending the`FrequencyChanged` // event, to make sure the FM app will get the right frequency when the // `EnabledChange` event is sent. mPendingFrequencyInKHz = GetFMRadioFrequency(); UpdatePowerState(); // The frequency was changed from '0' to some meaningful number, so we // should send the `FrequencyChanged` event manually. NotifyFMRadioEvent(FrequencyChanged); break; case FM_RADIO_OPERATION_DISABLE: MOZ_ASSERT(mState == Disabling); TransitionState(SuccessResponse(), Disabled); UpdatePowerState(); break; case FM_RADIO_OPERATION_SEEK: // Seek action might be cancelled by SetFrequency(), we need to check if // the current state is Seeking. if (mState == Seeking) { TransitionState(SuccessResponse(), Enabled); } UpdateFrequency(); break; case FM_RADIO_OPERATION_TUNE: UpdateFrequency(); break; default: MOZ_CRASH(); } } void FMRadioService::UpdatePowerState() { bool enabled = IsFMRadioOn(); if (enabled != mEnabled) { mEnabled = enabled; NotifyFMRadioEvent(EnabledChanged); } } void FMRadioService::UpdateFrequency() { int32_t frequency = GetFMRadioFrequency(); if (mPendingFrequencyInKHz != frequency) { mPendingFrequencyInKHz = frequency; NotifyFMRadioEvent(FrequencyChanged); } } // static FMRadioService* FMRadioService::Singleton() { MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default); MOZ_ASSERT(NS_IsMainThread()); if (!sFMRadioService) { sFMRadioService = new FMRadioService(); } return sFMRadioService; } NS_IMPL_ISUPPORTS(FMRadioService, nsIObserver) END_FMRADIO_NAMESPACE