/* 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 "MediaManager.h" #include "MediaStreamGraph.h" #include "nsIDOMFile.h" #include "nsIEventTarget.h" #include "nsIUUIDGenerator.h" #include "nsIScriptGlobalObject.h" #include "nsIPopupWindowManager.h" // For PR_snprintf #include "prprf.h" #include "nsJSUtils.h" #include "nsDOMFile.h" #include "nsGlobalWindow.h" #include "mozilla/Preferences.h" /* Using WebRTC backend on Desktops (Mac, Windows, Linux), otherwise default */ #include "MediaEngineDefault.h" #if defined(MOZ_WEBRTC) #include "MediaEngineWebRTC.h" #endif namespace mozilla { // We only support 1 audio and 1 video track for now. enum { kVideoTrack = 1, kAudioTrack = 2 }; /** * Send an error back to content. The error is the form a string. * Do this only on the main thread. The success callback is also passed here * so it can be released correctly. */ class ErrorCallbackRunnable : public nsRunnable { public: ErrorCallbackRunnable( already_AddRefed aSuccess, already_AddRefed aError, const nsString& aErrorMsg, uint64_t aWindowID) : mSuccess(aSuccess) , mError(aError) , mErrorMsg(aErrorMsg) , mWindowID(aWindowID) {} NS_IMETHOD Run() { // Only run if the window is still active. NS_ASSERTION(NS_IsMainThread(), "Only call on main thread"); nsCOMPtr success(mSuccess); nsCOMPtr error(mError); WindowTable* activeWindows = MediaManager::Get()->GetActiveWindows(); if (activeWindows->Get(mWindowID)) { error->OnError(mErrorMsg); } return NS_OK; } private: already_AddRefed mSuccess; already_AddRefed mError; const nsString mErrorMsg; uint64_t mWindowID; }; /** * Invoke the "onSuccess" callback in content. The callback will take a * DOMBlob in the case of {picture:true}, and a MediaStream in the case of * {audio:true} or {video:true}. There is a constructor available for each * form. Do this only on the main thread. */ class SuccessCallbackRunnable : public nsRunnable { public: SuccessCallbackRunnable( already_AddRefed aSuccess, already_AddRefed aError, nsIDOMFile* aFile, uint64_t aWindowID) : mSuccess(aSuccess) , mError(aError) , mFile(aFile) , mWindowID(aWindowID) {} NS_IMETHOD Run() { // Only run if the window is still active. NS_ASSERTION(NS_IsMainThread(), "Only call on main thread"); nsCOMPtr success(mSuccess); nsCOMPtr error(mError); WindowTable* activeWindows = MediaManager::Get()->GetActiveWindows(); if (activeWindows->Get(mWindowID)) { // XPConnect is a magical unicorn. success->OnSuccess(mFile); } return NS_OK; } private: already_AddRefed mSuccess; already_AddRefed mError; nsCOMPtr mFile; uint64_t mWindowID; }; /** * Invoke the GetUserMediaDevices success callback. Wrapped in a runnable * so that it may be called on the main thread. The error callback is also * passed so it can be released correctly. */ class DeviceSuccessCallbackRunnable: public nsRunnable { public: DeviceSuccessCallbackRunnable( already_AddRefed aSuccess, already_AddRefed aError, const nsTArray >& aDevices) : mSuccess(aSuccess) , mError(aError) , mDevices(aDevices) {} NS_IMETHOD Run() { NS_ASSERTION(NS_IsMainThread(), "Only call on main thread"); nsCOMPtr success(mSuccess); nsCOMPtr error(mError); nsCOMPtr devices = do_CreateInstance("@mozilla.org/variant;1"); int32_t len = mDevices.Length(); if (len == 0) { devices->SetAsEmptyArray(); success->OnSuccess(devices); return NS_OK; } nsTArray tmp(len); for (int32_t i = 0; i < len; i++) { tmp.AppendElement(mDevices.ElementAt(i)); } devices->SetAsArray(nsIDataType::VTYPE_INTERFACE, &NS_GET_IID(nsIMediaDevice), mDevices.Length(), const_cast( static_cast(tmp.Elements()) )); success->OnSuccess(devices); return NS_OK; } private: already_AddRefed mSuccess; already_AddRefed mError; nsTArray > mDevices; }; /** * nsIMediaDevice implementation. */ NS_IMPL_THREADSAFE_ISUPPORTS1(MediaDevice, nsIMediaDevice) NS_IMETHODIMP MediaDevice::GetName(nsAString& aName) { aName.Assign(mName); return NS_OK; } NS_IMETHODIMP MediaDevice::GetType(nsAString& aType) { aType.Assign(mType); return NS_OK; } MediaEngineSource* MediaDevice::GetSource() { return mSource; } /** * Creates a MediaStream, attaches a listener and fires off a success callback * to the DOM with the stream. We also pass in the error callback so it can * be released correctly. * * All of this must be done on the main thread! */ class GetUserMediaStreamRunnable : public nsRunnable { public: GetUserMediaStreamRunnable( already_AddRefed aSuccess, already_AddRefed aError, MediaEngineSource* aSource, StreamListeners* aListeners, uint64_t aWindowID, TrackID aTrackID) : mSuccess(aSuccess) , mError(aError) , mSource(aSource) , mListeners(aListeners) , mWindowID(aWindowID) , mTrackID(aTrackID) {} ~GetUserMediaStreamRunnable() {} NS_IMETHOD Run() { NS_ASSERTION(NS_IsMainThread(), "Only call on main thread"); // Create a media stream. nsCOMPtr stream; if (mTrackID == kVideoTrack) { stream = nsDOMMediaStream::CreateInputStream( nsDOMMediaStream::HINT_CONTENTS_VIDEO ); } else { stream = nsDOMMediaStream::CreateInputStream( nsDOMMediaStream::HINT_CONTENTS_AUDIO ); } nsPIDOMWindow *window = static_cast (nsGlobalWindow::GetInnerWindowWithId(mWindowID)); if (window && window->GetExtantDoc()) { stream->CombineWithPrincipal(window->GetExtantDoc()->NodePrincipal()); } // Add our listener. We'll call Start() on the source when get a callback // that the MediaStream has started consuming. The listener is freed // when the page is invalidated (on navigation or close). GetUserMediaCallbackMediaStreamListener* listener = new GetUserMediaCallbackMediaStreamListener(mSource, stream, mTrackID); stream->GetStream()->AddListener(listener); // No need for locking because we always do this in the main thread. mListeners->AppendElement(listener); // We're in the main thread, so no worries here either. nsCOMPtr success(mSuccess); nsCOMPtr error(mError); WindowTable* activeWindows = MediaManager::Get()->GetActiveWindows(); if (activeWindows->Get(mWindowID)) { success->OnSuccess(stream); } return NS_OK; } private: already_AddRefed mSuccess; already_AddRefed mError; nsRefPtr mSource; StreamListeners* mListeners; uint64_t mWindowID; TrackID mTrackID; }; /** * Runs on a seperate thread and is responsible for enumerating devices. * Depending on whether a picture or stream was asked for, either * ProcessGetUserMedia or ProcessGetUserMediaSnapshot is called, and the results * are sent back to the DOM. * * Do not run this on the main thread. The success and error callbacks *MUST* * be dispatched on the main thread! */ class GetUserMediaRunnable : public nsRunnable { public: /** * The caller can choose to provide a MediaDevice as the last argument, * if one is not provided, a default device is automatically chosen. */ GetUserMediaRunnable(bool aAudio, bool aVideo, bool aPicture, already_AddRefed aSuccess, already_AddRefed aError, StreamListeners* aListeners, uint64_t aWindowID, MediaDevice* aDevice) : mAudio(aAudio) , mVideo(aVideo) , mPicture(aPicture) , mSuccess(aSuccess) , mError(aError) , mListeners(aListeners) , mWindowID(aWindowID) , mDevice(aDevice) , mDeviceChosen(true) , mBackendChosen(false) {} GetUserMediaRunnable(bool aAudio, bool aVideo, bool aPicture, already_AddRefed aSuccess, already_AddRefed aError, StreamListeners* aListeners, uint64_t aWindowID) : mAudio(aAudio) , mVideo(aVideo) , mPicture(aPicture) , mSuccess(aSuccess) , mError(aError) , mListeners(aListeners) , mWindowID(aWindowID) , mDeviceChosen(false) , mBackendChosen(false) {} /** * The caller can also choose to provide their own backend instead of * using the one provided by MediaManager::GetBackend. */ GetUserMediaRunnable(bool aAudio, bool aVideo, already_AddRefed aSuccess, already_AddRefed aError, StreamListeners* aListeners, uint64_t aWindowID, MediaEngine* aBackend) : mAudio(aAudio) , mVideo(aVideo) , mPicture(false) , mSuccess(aSuccess) , mError(aError) , mListeners(aListeners) , mWindowID(aWindowID) , mDeviceChosen(false) , mBackendChosen(true) , mBackend(aBackend) {} ~GetUserMediaRunnable() { if (mBackendChosen) { delete mBackend; } } NS_IMETHOD Run() { NS_ASSERTION(!NS_IsMainThread(), "Don't call on main thread"); mManager = MediaManager::Get(); // Was a backend provided? if (!mBackendChosen) { mBackend = mManager->GetBackend(); } // Was a device provided? if (!mDeviceChosen) { nsresult rv = SelectDevice(); if (rv != NS_OK) { return rv; } } // It is an error if audio or video are requested along with picture. if (mPicture && (mAudio || mVideo)) { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("NOT_SUPPORTED_ERR"), mWindowID )); return NS_OK; } // XXX: Implement merging two streams (See bug 758391). if (mAudio && mVideo) { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("NOT_IMPLEMENTED"), mWindowID )); return NS_OK; } if (mPicture) { ProcessGetUserMediaSnapshot(mDevice->GetSource(), 0); return NS_OK; } if (mVideo) { ProcessGetUserMedia(mDevice->GetSource(), kVideoTrack); return NS_OK; } if (mAudio) { ProcessGetUserMedia(mDevice->GetSource(), kAudioTrack); return NS_OK; } return NS_OK; } nsresult Denied() { if (NS_IsMainThread()) { nsCOMPtr error(mError); error->OnError(NS_LITERAL_STRING("PERMISSION_DENIED")); } else { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("PERMISSION_DENIED"), mWindowID )); } return NS_OK; } nsresult SetDevice(MediaDevice* aDevice) { mDevice = aDevice; mDeviceChosen = true; return NS_OK; } nsresult SelectDevice() { uint32_t count; if (mPicture || mVideo) { nsTArray > videoSources; mBackend->EnumerateVideoDevices(&videoSources); count = videoSources.Length(); if (count <= 0) { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("NO_DEVICES_FOUND"), mWindowID )); return NS_ERROR_FAILURE; } mDevice = new MediaDevice(videoSources[0]); } else { nsTArray > audioSources; mBackend->EnumerateAudioDevices(&audioSources); count = audioSources.Length(); if (count <= 0) { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("NO_DEVICES_FOUND"), mWindowID )); return NS_ERROR_FAILURE; } mDevice = new MediaDevice(audioSources[0]); } return NS_OK; } /** * Allocates a video or audio device and returns a MediaStream via * a GetUserMediaStreamRunnable. Runs off the main thread. */ void ProcessGetUserMedia(MediaEngineSource* aSource, TrackID aTrackID) { nsresult rv = aSource->Allocate(); if (NS_FAILED(rv)) { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("HARDWARE_UNAVAILABLE"), mWindowID )); return; } NS_DispatchToMainThread(new GetUserMediaStreamRunnable( mSuccess, mError, aSource, mListeners, mWindowID, aTrackID )); return; } /** * Allocates a video device, takes a snapshot and returns a DOMFile via * a SuccessRunnable or an error via the ErrorRunnable. Off the main thread. */ void ProcessGetUserMediaSnapshot(MediaEngineSource* aSource, int aDuration) { nsresult rv = aSource->Allocate(); if (NS_FAILED(rv)) { NS_DispatchToMainThread(new ErrorCallbackRunnable( mSuccess, mError, NS_LITERAL_STRING("HARDWARE_UNAVAILABLE"), mWindowID )); return; } /** * Display picture capture UI here before calling Snapshot() - Bug 748835. */ nsCOMPtr file; aSource->Snapshot(aDuration, getter_AddRefs(file)); aSource->Deallocate(); NS_DispatchToMainThread(new SuccessCallbackRunnable( mSuccess, mError, file, mWindowID )); return; } private: bool mAudio; bool mVideo; bool mPicture; already_AddRefed mSuccess; already_AddRefed mError; StreamListeners* mListeners; uint64_t mWindowID; nsRefPtr mDevice; bool mDeviceChosen; bool mBackendChosen; MediaEngine* mBackend; MediaManager* mManager; }; /** * Similar to GetUserMediaRunnable, but used for the chrome-only * GetUserMediaDevices function. Enumerates a list of audio & video devices, * wraps them up in nsIMediaDevice objects and returns it to the success * callback. */ class GetUserMediaDevicesRunnable : public nsRunnable { public: GetUserMediaDevicesRunnable( already_AddRefed aSuccess, already_AddRefed aError) : mSuccess(aSuccess) , mError(aError) {} ~GetUserMediaDevicesRunnable() {} NS_IMETHOD Run() { NS_ASSERTION(!NS_IsMainThread(), "Don't call on main thread"); uint32_t audioCount, videoCount, i; MediaManager* manager = MediaManager::Get(); nsTArray > videoSources; manager->GetBackend()->EnumerateVideoDevices(&videoSources); videoCount = videoSources.Length(); nsTArray > audioSources; manager->GetBackend()->EnumerateAudioDevices(&audioSources); audioCount = audioSources.Length(); nsTArray > *devices = new nsTArray >; for (i = 0; i < videoCount; i++) { devices->AppendElement(new MediaDevice(videoSources[i])); } for (i = 0; i < audioCount; i++) { devices->AppendElement(new MediaDevice(audioSources[i])); } NS_DispatchToMainThread(new DeviceSuccessCallbackRunnable( mSuccess, mError, *devices )); return NS_OK; } private: already_AddRefed mSuccess; already_AddRefed mError; }; nsRefPtr MediaManager::sSingleton; NS_IMPL_THREADSAFE_ISUPPORTS1(MediaManager, nsIObserver) /** * The entry point for this file. A call from Navigator::mozGetUserMedia * will end up here. MediaManager is a singleton that is responsible * for handling all incoming getUserMedia calls from every window. */ nsresult MediaManager::GetUserMedia(bool aPrivileged, nsPIDOMWindow* aWindow, nsIMediaStreamOptions* aParams, nsIDOMGetUserMediaSuccessCallback* aOnSuccess, nsIDOMGetUserMediaErrorCallback* aOnError) { NS_ASSERTION(NS_IsMainThread(), "Only call on main thread"); NS_ENSURE_TRUE(aParams, NS_ERROR_NULL_POINTER); NS_ENSURE_TRUE(aWindow, NS_ERROR_NULL_POINTER); nsCOMPtr onSuccess(aOnSuccess); nsCOMPtr onError(aOnError); /* Get options */ nsresult rv; bool fake, audio, video, picture; rv = aParams->GetFake(&fake); NS_ENSURE_SUCCESS(rv, rv); rv = aParams->GetPicture(&picture); NS_ENSURE_SUCCESS(rv, rv); rv = aParams->GetAudio(&audio); NS_ENSURE_SUCCESS(rv, rv); rv = aParams->GetVideo(&video); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr device; rv = aParams->GetDevice(getter_AddRefs(device)); NS_ENSURE_SUCCESS(rv, rv); // If a device was provided, make sure it support the type of stream requested. if (device) { nsString type; device->GetType(type); if ((picture || video) && !type.EqualsLiteral("video")) { return NS_ERROR_FAILURE; } if (audio && !type.EqualsLiteral("audio")) { return NS_ERROR_FAILURE; } } // We only support "front" or "back". TBD: Send to GetUserMediaRunnable. nsString cameraType; rv = aParams->GetCamera(cameraType); NS_ENSURE_SUCCESS(rv, rv); /** * If we were asked to get a picture, before getting a snapshot, we check if * the calling page is allowed to open a popup. We do this because * {picture:true} will open a new "window" to let the user preview or select * an image, on Android. The desktop UI for {picture:true} is TBD, at which * may point we can decide whether to extend this test there as well. */ #if !defined(MOZ_WEBRTC) if (picture && !aPrivileged) { if (aWindow->GetPopupControlState() > openControlled) { nsCOMPtr pm = do_GetService(NS_POPUPWINDOWMANAGER_CONTRACTID); if (!pm) { return NS_OK; } uint32_t permission; nsCOMPtr doc = aWindow->GetExtantDoc(); pm->TestPermission(doc->NodePrincipal(), &permission); if ((permission == nsIPopupWindowManager::DENY_POPUP)) { nsCOMPtr domDoc = aWindow->GetExtantDocument(); nsGlobalWindow::FirePopupBlockedEvent( domDoc, aWindow, nullptr, EmptyString(), EmptyString() ); return NS_OK; } } } #endif // Store the WindowID in a hash table and mark as active. The entry is removed // when this window is closed or navigated away from. uint64_t windowID = aWindow->WindowID(); StreamListeners* listeners = mActiveWindows.Get(windowID); if (!listeners) { listeners = new StreamListeners; mActiveWindows.Put(windowID, listeners); } // Developer preference for turning off permission check. if (Preferences::GetBool("media.navigator.permission.disabled", false)) { aPrivileged = true; } /** * Pass runnables along to GetUserMediaRunnable so it can add the * MediaStreamListener to the runnable list. The last argument can * optionally be a MediaDevice object, which should provided if one was * selected by the user via the UI, or was provided by privileged code * via the device: attribute via nsIMediaStreamOptions. * * If a fake stream was requested, we force the use of the default backend. */ nsRefPtr gUMRunnable; if (fake) { // Fake stream from default backend. gUMRunnable = new GetUserMediaRunnable( audio, video, onSuccess.forget(), onError.forget(), listeners, windowID, new MediaEngineDefault() ); } else if (device) { // Stream from provided device. gUMRunnable = new GetUserMediaRunnable( audio, video, picture, onSuccess.forget(), onError.forget(), listeners, windowID, static_cast(device.get()) ); } else { // Stream from default device from WebRTC backend. gUMRunnable = new GetUserMediaRunnable( audio, video, picture, onSuccess.forget(), onError.forget(), listeners, windowID ); } if (picture) { // ShowFilePickerForMimeType() must run on the Main Thread! (on Android) NS_DispatchToMainThread(gUMRunnable); } else if (aPrivileged || fake) { if (!mMediaThread) { nsresult rv = NS_NewThread(getter_AddRefs(mMediaThread)); NS_ENSURE_SUCCESS(rv, rv); } mMediaThread->Dispatch(gUMRunnable, NS_DISPATCH_NORMAL); } else { // Ask for user permission, and dispatch runnable (or not) when a response // is received via an observer notification. Each call is paired with its // runnable by a GUID. nsresult rv; nsCOMPtr uuidgen = do_GetService("@mozilla.org/uuid-generator;1", &rv); NS_ENSURE_SUCCESS(rv, rv); // Generate a call ID. nsID id; rv = uuidgen->GenerateUUIDInPlace(&id); NS_ENSURE_SUCCESS(rv, rv); char buffer[NSID_LENGTH]; id.ToProvidedString(buffer); NS_ConvertUTF8toUTF16 callID(buffer); // Store the current callback. mActiveCallbacks.Put(callID, gUMRunnable); // Construct JSON structure with both the windowID and the callID. nsAutoString data; data.Append(NS_LITERAL_STRING("{\"windowID\":")); // Convert window ID to string. char windowBuffer[32]; PR_snprintf(windowBuffer, 32, "%llu", aWindow->GetOuterWindow()->WindowID()); data.Append(NS_ConvertUTF8toUTF16(windowBuffer)); data.Append(NS_LITERAL_STRING(", \"callID\":\"")); data.Append(callID); data.Append(NS_LITERAL_STRING("\"}")); nsCOMPtr obs = services::GetObserverService(); obs->NotifyObservers(aParams, "getUserMedia:request", data.get()); } return NS_OK; } nsresult MediaManager::GetUserMediaDevices(nsPIDOMWindow* aWindow, nsIGetUserMediaDevicesSuccessCallback* aOnSuccess, nsIDOMGetUserMediaErrorCallback* aOnError) { NS_ASSERTION(NS_IsMainThread(), "Only call on main thread"); nsCOMPtr onSuccess(aOnSuccess); nsCOMPtr onError(aOnError); nsCOMPtr gUMDRunnable = new GetUserMediaDevicesRunnable( onSuccess.forget(), onError.forget() ); nsCOMPtr deviceThread; nsresult rv = NS_NewThread(getter_AddRefs(deviceThread)); NS_ENSURE_SUCCESS(rv, rv); deviceThread->Dispatch(gUMDRunnable, NS_DISPATCH_NORMAL); return NS_OK; } MediaEngine* MediaManager::GetBackend() { // Plugin backends as appropriate. The default engine also currently // includes picture support for Android. if (!mBackend) { #if defined(MOZ_WEBRTC) mBackend = new MediaEngineWebRTC(); #else mBackend = new MediaEngineDefault(); #endif } return mBackend; } WindowTable* MediaManager::GetActiveWindows() { return &mActiveWindows; } void MediaManager::OnNavigation(uint64_t aWindowID) { // Invalidate this window. The runnables check this value before making // a call to content. StreamListeners* listeners = mActiveWindows.Get(aWindowID); if (!listeners) { return; } uint32_t length = listeners->Length(); for (uint32_t i = 0; i < length; i++) { nsRefPtr listener = listeners->ElementAt(i); listener->Invalidate(); listener = nullptr; } listeners->Clear(); mActiveWindows.Remove(aWindowID); } nsresult MediaManager::Observe(nsISupports* aSubject, const char* aTopic, const PRUnichar* aData) { NS_ASSERTION(NS_IsMainThread(), "Observer invoked off the main thread"); nsCOMPtr obs = mozilla::services::GetObserverService(); if (!strcmp(aTopic, "xpcom-shutdown")) { obs->RemoveObserver(this, "xpcom-shutdown"); obs->RemoveObserver(this, "getUserMedia:response:allow"); obs->RemoveObserver(this, "getUserMedia:response:deny"); // Close off any remaining active windows. mActiveWindows.Clear(); mActiveCallbacks.Clear(); sSingleton = nullptr; return NS_OK; } if (!strcmp(aTopic, "getUserMedia:response:allow")) { nsString key(aData); nsRefPtr runnable; if (!mActiveCallbacks.Get(key, getter_AddRefs(runnable))) { return NS_OK; } // Reuse the same thread to save memory. if (!mMediaThread) { nsresult rv = NS_NewThread(getter_AddRefs(mMediaThread)); NS_ENSURE_SUCCESS(rv, rv); } if (aSubject) { // A particular device was chosen by the user. nsCOMPtr device = do_QueryInterface(aSubject); if (device) { GetUserMediaRunnable* gUMRunnable = static_cast(runnable.get()); gUMRunnable->SetDevice(static_cast(device.get())); } } mMediaThread->Dispatch(runnable, NS_DISPATCH_NORMAL); mActiveCallbacks.Remove(key); return NS_OK; } if (!strcmp(aTopic, "getUserMedia:response:deny")) { nsString key(aData); nsRefPtr runnable; if (mActiveCallbacks.Get(key, getter_AddRefs(runnable))) { GetUserMediaRunnable* gUMRunnable = static_cast(runnable.get()); gUMRunnable->Denied(); mActiveCallbacks.Remove(key); } return NS_OK; } return NS_OK; } } // namespace mozilla