Bug 1366415: Unprefix mozAutoGainControl and mozNoiseSuppression w/deprecation warnings. r=jesup,smaug

MozReview-Commit-ID: EdWjSsIhtIM

--HG--
extra : rebase_source : 373bf802ae7a0f957770f2f6ec18fa4cc6c736da

Author: jan-ivar

dom/locales/en-US/chrome/dom/dom.properties

@@ -327,6 +327,10 @@ GeolocationInsecureRequestIsForbidden=A Geolocation request can only be fulfille
 LargeAllocationNonWin32=This page would be loaded in a new process due to a Large-Allocation header, however Large-Allocation process creation is disabled on non-Win32 platforms.
 # LOCALIZATION NOTE: Do not translate URL.createObjectURL(MediaStream).
 URLCreateObjectURL_MediaStream=URL.createObjectURL(MediaStream) is deprecated and will be removed soon.
+# LOCALIZATION NOTE: Do not translate MozAutoGainControl or autoGainControl.
+MozAutoGainControlWarning=mozAutoGainControl is deprecated. Use autoGainControl instead.
+# LOCALIZATION NOTE: Do not translate mozNoiseSuppression or noiseSuppression.
+MozNoiseSuppressionWarning=mozNoiseSuppression is deprecated. Use noiseSuppression instead.
 # LOCALIZATION NOTE: Do not translate xml:base.
 XMLBaseAttributeWarning=Use of xml:base attribute is deprecated and will be removed soon. Please remove any use of it.
 # LOCALIZATION NOTE: %S is the tag name of the element that starts the loop

dom/media/MediaManager.cpp

@@ -2234,6 +2234,14 @@ MediaManager::GetUserMedia(nsPIDOMWindowInner* aWindow,
 
   if (c.mAudio.IsMediaTrackConstraints()) {
     auto& ac = c.mAudio.GetAsMediaTrackConstraints();
+    MediaConstraintsHelper::ConvertOldWithWarning(ac.mMozAutoGainControl,
+                                                  ac.mAutoGainControl,
+                                                  "MozAutoGainControlWarning",
+                                                  aWindow);
+    MediaConstraintsHelper::ConvertOldWithWarning(ac.mMozNoiseSuppression,
+                                                  ac.mNoiseSuppression,
+                                                  "MozNoiseSuppressionWarning",
+                                                  aWindow);
     audioType = StringToEnum(dom::MediaSourceEnumValues::strings,
                              ac.mMediaSource,
                              MediaSourceEnum::Other);
@@ -3775,10 +3783,11 @@ SourceListener::CapturingBrowser() const
 }
 
 already_AddRefed<PledgeVoid>
-SourceListener::ApplyConstraintsToTrack(nsPIDOMWindowInner* aWindow,
-                                        TrackID aTrackID,
-                                        const dom::MediaTrackConstraints& aConstraints,
-                                        dom::CallerType aCallerType)
+SourceListener::ApplyConstraintsToTrack(
+    nsPIDOMWindowInner* aWindow,
+    TrackID aTrackID,
+    const MediaTrackConstraints& aConstraintsPassedIn,
+    dom::CallerType aCallerType)
 {
   MOZ_ASSERT(NS_IsMainThread());
   RefPtr<PledgeVoid> p = new PledgeVoid();
@@ -3797,6 +3806,16 @@ SourceListener::ApplyConstraintsToTrack(nsPIDOMWindowInner* aWindow,
     p->Resolve(false);
     return p.forget();
   }
+  MediaTrackConstraints c(aConstraintsPassedIn); // use a modifiable copy
+
+  MediaConstraintsHelper::ConvertOldWithWarning(c.mMozAutoGainControl,
+                                                c.mAutoGainControl,
+                                                "MozAutoGainControlWarning",
+                                                aWindow);
+  MediaConstraintsHelper::ConvertOldWithWarning(c.mMozNoiseSuppression,
+                                                c.mNoiseSuppression,
+                                                "MozNoiseSuppressionWarning",
+                                                aWindow);
 
   RefPtr<MediaManager> mgr = MediaManager::GetInstance();
   uint32_t id = mgr->mOutstandingVoidPledges.Append(*p);
@@ -3805,27 +3824,27 @@ SourceListener::ApplyConstraintsToTrack(nsPIDOMWindowInner* aWindow,
 
   MediaManager::PostTask(NewTaskFrom([id, windowId,
                                       audioDevice, videoDevice,
-                                      aConstraints, isChrome]() mutable {
+                                      c, isChrome]() mutable {
     MOZ_ASSERT(MediaManager::IsInMediaThread());
     RefPtr<MediaManager> mgr = MediaManager::GetInstance();
     const char* badConstraint = nullptr;
     nsresult rv = NS_OK;
 
     if (audioDevice) {
-      rv = audioDevice->Restart(aConstraints, mgr->mPrefs, &badConstraint);
+      rv = audioDevice->Restart(c, mgr->mPrefs, &badConstraint);
       if (rv == NS_ERROR_NOT_AVAILABLE && !badConstraint) {
         nsTArray<RefPtr<AudioDevice>> audios;
         audios.AppendElement(audioDevice);
         badConstraint = MediaConstraintsHelper::SelectSettings(
-            NormalizedConstraints(aConstraints), audios, isChrome);
+            NormalizedConstraints(c), audios, isChrome);
       }
     } else {
-      rv = videoDevice->Restart(aConstraints, mgr->mPrefs, &badConstraint);
+      rv = videoDevice->Restart(c, mgr->mPrefs, &badConstraint);
       if (rv == NS_ERROR_NOT_AVAILABLE && !badConstraint) {
         nsTArray<RefPtr<VideoDevice>> videos;
         videos.AppendElement(videoDevice);
         badConstraint = MediaConstraintsHelper::SelectSettings(
-            NormalizedConstraints(aConstraints), videos, isChrome);
+            NormalizedConstraints(c), videos, isChrome);
       }
     }
     NS_DispatchToMainThread(NewRunnableFrom([id, windowId, rv,

dom/media/tests/mochitest/test_getUserMedia_constraints.html

@@ -74,9 +74,10 @@
 
 var mustSupport = [
   'width', 'height', 'frameRate', 'facingMode', 'deviceId',
+  'echoCancellation', 'noiseSuppression', 'autoGainControl',
+
   // Yet to add:
-  //  'aspectRatio', 'frameRate', 'volume', 'sampleRate', 'sampleSize',
-  //  'latency', 'groupId'
+  //  'aspectRatio', 'volume', 'sampleRate', 'sampleSize', 'latency', 'groupId'
 
   // http://fluffy.github.io/w3c-screen-share/#screen-based-video-constraints
   // OBE by http://w3c.github.io/mediacapture-screen-share
@@ -85,8 +86,6 @@
   // Experimental https://bugzilla.mozilla.org/show_bug.cgi?id=1131568#c3
   'browserWindow', 'scrollWithPage',
   'viewportOffsetX', 'viewportOffsetY', 'viewportWidth', 'viewportHeight',
-
-  'echoCancellation', 'mozNoiseSuppression', 'mozAutoGainControl'
 ];
 
 var mustFailWith = (msg, reason, constraint, f) =>

dom/media/webrtc/MediaEngineWebRTCAudio.cpp

@@ -215,8 +215,8 @@ MediaEngineWebRTCMicrophoneSource::MediaEngineWebRTCMicrophoneSource(
   mDeviceUUID.Assign(uuid);
   mListener = new mozilla::WebRTCAudioDataListener(this);
   mSettings.mEchoCancellation.Construct(0);
-  mSettings.mMozAutoGainControl.Construct(0);
-  mSettings.mMozNoiseSuppression.Construct(0);
+  mSettings.mAutoGainControl.Construct(0);
+  mSettings.mNoiseSuppression.Construct(0);
   // We'll init lazily as needed
 }
 
@@ -286,8 +286,8 @@ MediaEngineWebRTCMicrophoneSource::UpdateSingleSource(
 
   MediaEnginePrefs prefs = aPrefs;
   prefs.mAecOn = c.mEchoCancellation.Get(prefs.mAecOn);
-  prefs.mAgcOn = c.mMozAutoGainControl.Get(prefs.mAgcOn);
-  prefs.mNoiseOn = c.mMozNoiseSuppression.Get(prefs.mNoiseOn);
+  prefs.mAgcOn = c.mAutoGainControl.Get(prefs.mAgcOn);
+  prefs.mNoiseOn = c.mNoiseSuppression.Get(prefs.mNoiseOn);
 
   LOG(("Audio config: aec: %d, agc: %d, noise: %d, delay: %d",
        prefs.mAecOn ? prefs.mAec : -1,
@@ -382,8 +382,8 @@ MediaEngineWebRTCMicrophoneSource::SetLastPrefs(
 
   NS_DispatchToMainThread(media::NewRunnableFrom([that, aPrefs]() mutable {
     that->mSettings.mEchoCancellation.Value() = aPrefs.mAecOn;
-    that->mSettings.mMozAutoGainControl.Value() = aPrefs.mAgcOn;
-    that->mSettings.mMozNoiseSuppression.Value() = aPrefs.mNoiseOn;
+    that->mSettings.mAutoGainControl.Value() = aPrefs.mAgcOn;
+    that->mSettings.mNoiseSuppression.Value() = aPrefs.mNoiseOn;
     return NS_OK;
   }));
 }

dom/media/webrtc/MediaTrackConstraints.cpp

@@ -4,6 +4,7 @@
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 #include "MediaTrackConstraints.h"
+#include "nsIScriptError.h"
 #include "mozilla/dom/MediaStreamTrackBinding.h"
 
 #include <limits>
@@ -371,11 +372,11 @@ FlattenedConstraints::FlattenedConstraints(const NormalizedConstraints& aOther)
     if (mEchoCancellation.Intersects(set.mEchoCancellation)) {
         mEchoCancellation.Intersect(set.mEchoCancellation);
     }
-    if (mMozNoiseSuppression.Intersects(set.mMozNoiseSuppression)) {
-        mMozNoiseSuppression.Intersect(set.mMozNoiseSuppression);
+    if (mNoiseSuppression.Intersects(set.mNoiseSuppression)) {
+        mNoiseSuppression.Intersect(set.mNoiseSuppression);
     }
-    if (mMozAutoGainControl.Intersects(set.mMozAutoGainControl)) {
-        mMozAutoGainControl.Intersect(set.mMozAutoGainControl);
+    if (mAutoGainControl.Intersects(set.mAutoGainControl)) {
+        mAutoGainControl.Intersect(set.mAutoGainControl);
     }
   }
 }
@@ -469,4 +470,31 @@ MediaConstraintsHelper::FindBadConstraint(
   return FindBadConstraint(aConstraints, devices);
 }
 
+void
+MediaConstraintsHelper::ConvertOldWithWarning(
+    const dom::OwningBooleanOrConstrainBooleanParameters& old,
+    dom::OwningBooleanOrConstrainBooleanParameters& to,
+    const char* aMessageName,
+    nsPIDOMWindowInner* aWindow) {
+  if ((old.IsBoolean() ||
+       old.GetAsConstrainBooleanParameters().mExact.WasPassed() ||
+       old.GetAsConstrainBooleanParameters().mIdeal.WasPassed()) &&
+      !(to.IsBoolean() ||
+        to.GetAsConstrainBooleanParameters().mExact.WasPassed() ||
+        to.GetAsConstrainBooleanParameters().mIdeal.WasPassed())) {
+    nsCOMPtr<nsIDocument> doc = aWindow->GetDoc();
+    if (doc) {
+      nsContentUtils::ReportToConsole(nsIScriptError::warningFlag,
+                                      NS_LITERAL_CSTRING("DOM"), doc,
+                                      nsContentUtils::eDOM_PROPERTIES,
+                                      aMessageName);
+    }
+    if (old.IsBoolean()) {
+      to.SetAsBoolean() = old.GetAsBoolean();
+    } else {
+      to.SetAsConstrainBooleanParameters() = old.GetAsConstrainBooleanParameters();
+    }
+  }
+}
+
 }

dom/media/webrtc/MediaTrackConstraints.h

@@ -225,7 +225,7 @@ class NormalizedConstraintSet
   BooleanRange mScrollWithPage;
   StringRange mDeviceId;
   LongRange mViewportOffsetX, mViewportOffsetY, mViewportWidth, mViewportHeight;
-  BooleanRange mEchoCancellation, mMozNoiseSuppression, mMozAutoGainControl;
+  BooleanRange mEchoCancellation, mNoiseSuppression, mAutoGainControl;
 private:
   typedef NormalizedConstraintSet T;
 public:
@@ -254,11 +254,11 @@ class NormalizedConstraintSet
                     aOther.mViewportHeight, advanced, aList)
   , mEchoCancellation(&T::mEchoCancellation, "echoCancellation",
                       aOther.mEchoCancellation, advanced, aList)
-  , mMozNoiseSuppression(&T::mMozNoiseSuppression, "mozNoiseSuppression",
-                         aOther.mMozNoiseSuppression,
-                         advanced, aList)
-  , mMozAutoGainControl(&T::mMozAutoGainControl, "mozAutoGainControl",
-                        aOther.mMozAutoGainControl, advanced, aList) {}
+  , mNoiseSuppression(&T::mNoiseSuppression, "noiseSuppression",
+                      aOther.mNoiseSuppression,
+                      advanced, aList)
+  , mAutoGainControl(&T::mAutoGainControl, "autoGainControl",
+                     aOther.mAutoGainControl, advanced, aList) {}
 };
 
 template<> bool NormalizedConstraintSet::Range<bool>::Merge(const Range& aOther);
@@ -442,6 +442,15 @@ class MediaConstraintsHelper
   FindBadConstraint(const NormalizedConstraints& aConstraints,
                     const MediaEngineSourceType& aMediaEngineSource,
                     const nsString& aDeviceId);
+
+  // Warn on and convert use of deprecated constraints to new ones
+
+  static void
+  ConvertOldWithWarning(
+      const dom::OwningBooleanOrConstrainBooleanParameters& old,
+      dom::OwningBooleanOrConstrainBooleanParameters& to,
+      const char* aMessageName,
+      nsPIDOMWindowInner* aWindow);
 };
 
 } // namespace mozilla

dom/webidl/MediaStreamTrack.webidl

@@ -55,6 +55,10 @@ dictionary MediaTrackConstraintSet {
     ConstrainLong viewportWidth;
     ConstrainLong viewportHeight;
     ConstrainBoolean echoCancellation;
+    ConstrainBoolean noiseSuppression;
+    ConstrainBoolean autoGainControl;
+
+    // Deprecated with warnings:
     ConstrainBoolean mozNoiseSuppression;
     ConstrainBoolean mozAutoGainControl;
 };

dom/webidl/MediaTrackSettings.webidl

@@ -14,8 +14,8 @@ dictionary MediaTrackSettings {
     DOMString facingMode;
     DOMString deviceId;
     boolean echoCancellation;
-    boolean mozNoiseSuppression;
-    boolean mozAutoGainControl;
+    boolean noiseSuppression;
+    boolean autoGainControl;
 
     // Mozilla-specific extensions:
 
@@ -33,4 +33,4 @@ dictionary MediaTrackSettings {
     long viewportOffsetY;
     long viewportWidth;
     long viewportHeight;
-};
+};

dom/webidl/MediaTrackSupportedConstraints.webidl

@@ -17,8 +17,8 @@ dictionary MediaTrackSupportedConstraints {
     boolean sampleRate;         // to be supported
     boolean sampleSize;         // to be supported
     boolean echoCancellation = true;
-    boolean mozNoiseSuppression = true;
-    boolean mozAutoGainControl = true;
+    boolean noiseSuppression = true;
+    boolean autoGainControl = true;
     boolean latency;            // to be supported
     boolean deviceId = true;
     boolean groupId;            // to be supported