summaryrefslogtreecommitdiffstats
path: root/dom/media/MediaDevices.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:22:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:22:09 +0000
commit43a97878ce14b72f0981164f87f2e35e14151312 (patch)
tree620249daf56c0258faa40cbdcf9cfba06de2a846 /dom/media/MediaDevices.h
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 110.0.1.upstream/110.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/media/MediaDevices.h')
-rw-r--r--dom/media/MediaDevices.h131
1 files changed, 131 insertions, 0 deletions
diff --git a/dom/media/MediaDevices.h b/dom/media/MediaDevices.h
new file mode 100644
index 0000000000..fa6a11c8fb
--- /dev/null
+++ b/dom/media/MediaDevices.h
@@ -0,0 +1,131 @@
+/* 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_MediaDevices_h
+#define mozilla_dom_MediaDevices_h
+
+#include "MediaEventSource.h"
+#include "js/RootingAPI.h"
+#include "mozilla/AlreadyAddRefed.h"
+#include "mozilla/DOMEventTargetHelper.h"
+#include "mozilla/UseCounter.h"
+#include "mozilla/dom/BindingDeclarations.h"
+#include "nsCOMPtr.h"
+#include "nsID.h"
+#include "nsISupports.h"
+#include "nsTHashSet.h"
+
+class AudioDeviceInfo;
+
+namespace mozilla {
+
+class LocalMediaDevice;
+class MediaDevice;
+class MediaMgrError;
+template <typename ResolveValueT, typename RejectValueT, bool IsExclusive>
+class MozPromise;
+
+namespace media {
+template <typename T>
+class Refcountable;
+} // namespace media
+
+namespace dom {
+
+class Promise;
+struct MediaStreamConstraints;
+struct DisplayMediaStreamConstraints;
+struct MediaTrackSupportedConstraints;
+struct AudioOutputOptions;
+
+class MediaDevices final : public DOMEventTargetHelper {
+ public:
+ using SinkInfoPromise = MozPromise<RefPtr<AudioDeviceInfo>, nsresult, true>;
+
+ explicit MediaDevices(nsPIDOMWindowInner* aWindow);
+
+ NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(MediaDevices, DOMEventTargetHelper)
+
+ JSObject* WrapObject(JSContext* cx,
+ JS::Handle<JSObject*> aGivenProto) override;
+
+ // No code needed, as MediaTrackSupportedConstraints members default to true.
+ void GetSupportedConstraints(MediaTrackSupportedConstraints& aResult){};
+
+ already_AddRefed<Promise> GetUserMedia(
+ const MediaStreamConstraints& aConstraints, CallerType aCallerType,
+ ErrorResult& aRv);
+
+ already_AddRefed<Promise> EnumerateDevices(ErrorResult& aRv);
+
+ already_AddRefed<Promise> GetDisplayMedia(
+ const DisplayMediaStreamConstraints& aConstraints, CallerType aCallerType,
+ ErrorResult& aRv);
+
+ already_AddRefed<Promise> SelectAudioOutput(
+ const AudioOutputOptions& aOptions, CallerType aCallerType,
+ ErrorResult& aRv);
+
+ // Get the sink that corresponds to the given device id.
+ // The returned promise will be resolved with the device
+ // information if the aDeviceId matches a device that would be exposed by
+ // enumerateDevices().
+ // The promise will be rejected with NS_ERROR_NOT_AVAILABLE if aDeviceId
+ // does not match any exposed device.
+ RefPtr<SinkInfoPromise> GetSinkDevice(const nsString& aDeviceId);
+
+ // Called when MediaManager encountered a change in its device lists.
+ void OnDeviceChange();
+
+ void SetupDeviceChangeListener();
+
+ mozilla::dom::EventHandlerNonNull* GetOndevicechange();
+ void SetOndevicechange(mozilla::dom::EventHandlerNonNull* aCallback);
+
+ void EventListenerAdded(nsAtom* aType) override;
+ using DOMEventTargetHelper::EventListenerAdded;
+
+ void BackgroundStateChanged() { MaybeResumeDeviceExposure(); }
+ void WindowResumed() { MaybeResumeDeviceExposure(); }
+ void BrowserWindowBecameActive() { MaybeResumeDeviceExposure(); }
+
+ private:
+ using MediaDeviceSet = nsTArray<RefPtr<MediaDevice>>;
+ using MediaDeviceSetRefCnt = media::Refcountable<MediaDeviceSet>;
+ using LocalMediaDeviceSet = nsTArray<RefPtr<LocalMediaDevice>>;
+
+ virtual ~MediaDevices();
+ void MaybeResumeDeviceExposure();
+ void ResumeEnumerateDevices(
+ nsTArray<RefPtr<Promise>>&& aPromises,
+ RefPtr<const MediaDeviceSetRefCnt> aExposedDevices) const;
+ RefPtr<MediaDeviceSetRefCnt> FilterExposedDevices(
+ const MediaDeviceSet& aDevices) const;
+ bool ShouldQueueDeviceChange(const MediaDeviceSet& aExposedDevices) const;
+ void ResolveEnumerateDevicesPromise(
+ Promise* aPromise, const LocalMediaDeviceSet& aDevices) const;
+
+ nsTHashSet<nsString> mExplicitlyGrantedAudioOutputRawIds;
+ nsTArray<RefPtr<Promise>> mPendingEnumerateDevicesPromises;
+ // Set only once, if and when required.
+ mutable nsString mDefaultOutputLabel;
+
+ // Connect/Disconnect on main thread only
+ MediaEventListener mDeviceChangeListener;
+ // Ordered set of the system physical devices when devicechange event
+ // decisions were last performed.
+ RefPtr<const MediaDeviceSetRefCnt> mLastPhysicalDevices;
+ bool mIsDeviceChangeListenerSetUp = false;
+ bool mHaveUnprocessedDeviceListChange = false;
+ bool mCanExposeMicrophoneInfo = false;
+ bool mCanExposeCameraInfo = false;
+
+ void RecordAccessTelemetry(const UseCounter counter) const;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // mozilla_dom_MediaDevices_h