DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Header

Mercurial (1aeaa33a64f9)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 ts=8 et ft=cpp : */
/* 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 "MediaEngineWebRTC.h"

#include "AllocationHandle.h"
#include "CamerasChild.h"
#include "CSFLog.h"
#include "MediaEngineTabVideoSource.h"
#include "MediaEngineRemoteVideoSource.h"
#include "MediaTrackConstraints.h"
#include "mozilla/Logging.h"
#include "nsIComponentRegistrar.h"
#include "nsIPrefService.h"
#include "nsIPrefBranch.h"
#include "nsITabSource.h"
#include "prenv.h"

#ifdef MOZ_WIDGET_ANDROID
#include "AndroidBridge.h"
#include "VideoEngine.h"
#endif

static mozilla::LazyLogModule sGetUserMediaLog("GetUserMedia");
#undef LOG
#define LOG(args) MOZ_LOG(sGetUserMediaLog, mozilla::LogLevel::Debug, args)

namespace mozilla {

// statics from AudioInputCubeb
nsTArray<int>* AudioInputCubeb::mDeviceIndexes;
int AudioInputCubeb::mDefaultDevice = -1;
nsTArray<nsCString>* AudioInputCubeb::mDeviceNames;
cubeb_device_collection AudioInputCubeb::mDevices = {nullptr, 0};
bool AudioInputCubeb::mAnyInUse = false;
StaticMutex AudioInputCubeb::sMutex;
uint32_t AudioInputCubeb::sUserChannelCount = 0;

// AudioDeviceID is an annoying opaque value that's really a string
// pointer, and is freed when the cubeb_device_collection is destroyed

void AudioInputCubeb::UpdateDeviceList() {
  cubeb* cubebContext = CubebUtils::GetCubebContext();
  if (!cubebContext) {
    return;
  }

  cubeb_device_collection devices = {nullptr, 0};

  if (CUBEB_OK != cubeb_enumerate_devices(cubebContext, CUBEB_DEVICE_TYPE_INPUT,
                                          &devices)) {
    return;
  }

  for (auto& device_index : (*mDeviceIndexes)) {
    device_index = -1;  // unmapped
  }
  // We keep all the device names, but wipe the mappings and rebuild them

  // Calculate translation from existing mDevices to new devices. Note we
  // never end up with less devices than before, since people have
  // stashed indexes.
  // For some reason the "fake" device for automation is marked as DISABLED,
  // so white-list it.
  mDefaultDevice = -1;
  for (uint32_t i = 0; i < devices.count; i++) {
    LOG(("Cubeb device %u: type 0x%x, state 0x%x, name %s, id %p", i,
         devices.device[i].type, devices.device[i].state,
         devices.device[i].friendly_name, devices.device[i].device_id));
    if (devices.device[i].type == CUBEB_DEVICE_TYPE_INPUT &&  // paranoia
        (devices.device[i].state == CUBEB_DEVICE_STATE_ENABLED ||
         (devices.device[i].state == CUBEB_DEVICE_STATE_DISABLED &&
          devices.device[i].friendly_name &&
          strcmp(devices.device[i].friendly_name, "Sine source at 440 Hz") ==
              0))) {
      auto j = mDeviceNames->IndexOf(devices.device[i].device_id);
      if (j != nsTArray<nsCString>::NoIndex) {
        // match! update the mapping
        (*mDeviceIndexes)[j] = i;
      } else {
        // new device, add to the array
        mDeviceIndexes->AppendElement(i);
        mDeviceNames->AppendElement(devices.device[i].device_id);
        j = mDeviceIndexes->Length() - 1;
      }
      if (devices.device[i].preferred & CUBEB_DEVICE_PREF_VOICE) {
        // There can be only one... we hope
        NS_ASSERTION(mDefaultDevice == -1,
                     "multiple default cubeb input devices!");
        mDefaultDevice = j;
      }
    }
  }
  LOG(("Cubeb default input device %d", mDefaultDevice));
  StaticMutexAutoLock lock(sMutex);
  // swap state
  cubeb_device_collection_destroy(cubebContext, &mDevices);
  mDevices = devices;
}

MediaEngineWebRTC::MediaEngineWebRTC(MediaEnginePrefs& aPrefs)
    : mMutex("MediaEngineWebRTC::mMutex"),
      mAudioInput(nullptr),
      mFullDuplex(aPrefs.mFullDuplex),
      mDelayAgnostic(aPrefs.mDelayAgnostic),
      mExtendedFilter(aPrefs.mExtendedFilter),
      mHasTabVideoSource(false) {
  nsCOMPtr<nsIComponentRegistrar> compMgr;
  NS_GetComponentRegistrar(getter_AddRefs(compMgr));
  if (compMgr) {
    compMgr->IsContractIDRegistered(NS_TABSOURCESERVICE_CONTRACTID,
                                    &mHasTabVideoSource);
  }

  camera::GetChildAndCall(&camera::CamerasChild::AddDeviceChangeCallback, this);
}

void MediaEngineWebRTC::SetFakeDeviceChangeEvents() {
  camera::GetChildAndCall(&camera::CamerasChild::SetFakeDeviceChangeEvents);
}

void MediaEngineWebRTC::EnumerateDevices(
    uint64_t aWindowId, dom::MediaSourceEnum aMediaSource,
    nsTArray<RefPtr<MediaEngineSource> >* aSources) {
  if (MediaEngineSource::IsVideo(aMediaSource)) {
    // We spawn threads to handle gUM runnables, so we must protect the member
    // vars
    MutexAutoLock lock(mMutex);

    mozilla::camera::CaptureEngine capEngine = mozilla::camera::InvalidEngine;

#ifdef MOZ_WIDGET_ANDROID
    // get the JVM
    JavaVM* jvm;
    JNIEnv* const env = jni::GetEnvForThread();
    MOZ_ALWAYS_TRUE(!env->GetJavaVM(&jvm));

    if (!jvm || mozilla::camera::VideoEngine::SetAndroidObjects(jvm)) {
      LOG(("VideoEngine::SetAndroidObjects Failed"));
      return;
    }
#endif
    bool scaryKind = false;  // flag sources with cross-origin exploit potential

    switch (aMediaSource) {
      case dom::MediaSourceEnum::Window:
        capEngine = mozilla::camera::WinEngine;
        break;
      case dom::MediaSourceEnum::Application:
        capEngine = mozilla::camera::AppEngine;
        break;
      case dom::MediaSourceEnum::Screen:
        capEngine = mozilla::camera::ScreenEngine;
        scaryKind = true;
        break;
      case dom::MediaSourceEnum::Browser:
        capEngine = mozilla::camera::BrowserEngine;
        scaryKind = true;
        break;
      case dom::MediaSourceEnum::Camera:
        capEngine = mozilla::camera::CameraEngine;
        break;
      default:
        MOZ_CRASH("No valid video engine");
        break;
    }

    /*
     * We still enumerate every time, in case a new device was plugged in since
     * the last call. TODO: Verify that WebRTC actually does deal with
     * hotplugging new devices (with or without new engine creation) and
     * accordingly adjust. Enumeration is not neccessary if GIPS reports the
     * same set of devices for a given instance of the engine. Likewise, if a
     * device was plugged out, mVideoSources must be updated.
     */
    int num;
    num = mozilla::camera::GetChildAndCall(
        &mozilla::camera::CamerasChild::NumberOfCaptureDevices, capEngine);

    for (int i = 0; i < num; i++) {
      char deviceName[MediaEngineSource::kMaxDeviceNameLength];
      char uniqueId[MediaEngineSource::kMaxUniqueIdLength];
      bool scarySource = false;

      // paranoia
      deviceName[0] = '\0';
      uniqueId[0] = '\0';
      int error;

      error = mozilla::camera::GetChildAndCall(
          &mozilla::camera::CamerasChild::GetCaptureDevice, capEngine, i,
          deviceName, sizeof(deviceName), uniqueId, sizeof(uniqueId),
          &scarySource);
      if (error) {
        LOG(("camera:GetCaptureDevice: Failed %d", error));
        continue;
      }
#ifdef DEBUG
      LOG(("  Capture Device Index %d, Name %s", i, deviceName));

      webrtc::CaptureCapability cap;
      int numCaps = mozilla::camera::GetChildAndCall(
          &mozilla::camera::CamerasChild::NumberOfCapabilities, capEngine,
          uniqueId);
      LOG(("Number of Capabilities %d", numCaps));
      for (int j = 0; j < numCaps; j++) {
        if (mozilla::camera::GetChildAndCall(
                &mozilla::camera::CamerasChild::GetCaptureCapability, capEngine,
                uniqueId, j, cap) != 0) {
          break;
        }
        LOG(("type=%d width=%d height=%d maxFPS=%d", cap.rawType, cap.width,
             cap.height, cap.maxFPS));
      }
#endif

      if (uniqueId[0] == '\0') {
        // In case a device doesn't set uniqueId!
        strncpy(uniqueId, deviceName, sizeof(uniqueId));
        uniqueId[sizeof(uniqueId) - 1] = '\0';  // strncpy isn't safe
      }

      NS_ConvertUTF8toUTF16 uuid(uniqueId);
      RefPtr<MediaEngineSource> vSource;

      nsRefPtrHashtable<nsStringHashKey, MediaEngineSource>*
          devicesForThisWindow = mVideoSources.LookupOrAdd(aWindowId);

      if (devicesForThisWindow->Get(uuid, getter_AddRefs(vSource)) &&
          vSource->RequiresSharing()) {
        // We've already seen this shared device, just refresh and append.
        static_cast<MediaEngineRemoteVideoSource*>(vSource.get())->Refresh(i);
        aSources->AppendElement(vSource.get());
      } else {
        vSource = new MediaEngineRemoteVideoSource(i, capEngine, aMediaSource,
                                                   scaryKind || scarySource);
        devicesForThisWindow->Put(uuid, vSource);
        aSources->AppendElement(vSource);
      }
    }

    if (mHasTabVideoSource || dom::MediaSourceEnum::Browser == aMediaSource) {
      aSources->AppendElement(new MediaEngineTabVideoSource());
    }
  } else {
    // We spawn threads to handle gUM runnables, so we must protect the member
    // vars
    MutexAutoLock lock(mMutex);

    if (aMediaSource == dom::MediaSourceEnum::AudioCapture) {
      RefPtr<MediaEngineWebRTCAudioCaptureSource> audioCaptureSource =
          new MediaEngineWebRTCAudioCaptureSource(nullptr);
      aSources->AppendElement(audioCaptureSource);
      return;
    }

    if (!mAudioInput) {
      if (!SupportsDuplex()) {
        return;
      }
      mAudioInput = new mozilla::AudioInputCubeb();
    }

    int nDevices = 0;
    mAudioInput->GetNumOfRecordingDevices(nDevices);
    int i;
#if defined(MOZ_WIDGET_ANDROID)
    i = 0;  // Bug 1037025 - let the OS handle defaulting for now on android/b2g
#else
    // -1 is "default communications device" depending on OS in webrtc.org code
    i = -1;
#endif
    for (; i < nDevices; i++) {
      // We use constants here because GetRecordingDeviceName takes char[128].
      char deviceName[128];
      char uniqueId[128];
      // paranoia; jingle doesn't bother with this
      deviceName[0] = '\0';
      uniqueId[0] = '\0';

      int error = mAudioInput->GetRecordingDeviceName(i, deviceName, uniqueId);
      if (error) {
        LOG((" AudioInput::GetRecordingDeviceName: Failed %d", error));
        continue;
      }

      if (uniqueId[0] == '\0') {
        // Mac and Linux don't set uniqueId!
        strcpy(uniqueId,
               deviceName);  // safe given assert and initialization/error-check
      }

      RefPtr<MediaEngineSource> aSource;
      NS_ConvertUTF8toUTF16 uuid(uniqueId);

      nsRefPtrHashtable<nsStringHashKey, MediaEngineSource>*
          devicesForThisWindow = mAudioSources.LookupOrAdd(aWindowId);

      if (devicesForThisWindow->Get(uuid, getter_AddRefs(aSource)) &&
          aSource->RequiresSharing()) {
        // We've already seen this device, just append.
        aSources->AppendElement(aSource.get());
      } else {
        aSource = new MediaEngineWebRTCMicrophoneSource(
            new mozilla::AudioInputCubeb(i), i, deviceName, uniqueId,
            mDelayAgnostic, mExtendedFilter);
        devicesForThisWindow->Put(uuid, aSource);
        aSources->AppendElement(aSource);
      }
    }
  }
}

bool MediaEngineWebRTC::SupportsDuplex() { return mFullDuplex; }

void MediaEngineWebRTC::ReleaseResourcesForWindow(uint64_t aWindowId) {
  {
    nsRefPtrHashtable<nsStringHashKey, MediaEngineSource>*
        audioDevicesForThisWindow = mAudioSources.Get(aWindowId);

    if (audioDevicesForThisWindow) {
      for (auto iter = audioDevicesForThisWindow->Iter(); !iter.Done();
           iter.Next()) {
        iter.UserData()->Shutdown();
      }

      // This makes audioDevicesForThisWindow invalid.
      mAudioSources.Remove(aWindowId);
    }
  }

  {
    nsRefPtrHashtable<nsStringHashKey, MediaEngineSource>*
        videoDevicesForThisWindow = mVideoSources.Get(aWindowId);
    if (videoDevicesForThisWindow) {
      for (auto iter = videoDevicesForThisWindow->Iter(); !iter.Done();
           iter.Next()) {
        iter.UserData()->Shutdown();
      }

      // This makes videoDevicesForThisWindow invalid.
      mVideoSources.Remove(aWindowId);
    }
  }
}

namespace {
template <typename T>
void ShutdownSources(T& aHashTable) {
  for (auto iter = aHashTable.Iter(); !iter.Done(); iter.Next()) {
    for (auto iterInner = iter.UserData()->Iter(); !iterInner.Done();
         iterInner.Next()) {
      MediaEngineSource* source = iterInner.UserData();
      source->Shutdown();
    }
  }
}
}  // namespace

void MediaEngineWebRTC::Shutdown() {
  // This is likely paranoia
  MutexAutoLock lock(mMutex);

  if (camera::GetCamerasChildIfExists()) {
    camera::GetChildAndCall(&camera::CamerasChild::RemoveDeviceChangeCallback,
                            this);
  }

  LOG(("%s", __FUNCTION__));
  // Shutdown all the sources, since we may have dangling references to the
  // sources in nsDOMUserMediaStreams waiting for GC/CC
  ShutdownSources(mVideoSources);
  ShutdownSources(mAudioSources);

  mozilla::camera::Shutdown();
  AudioInputCubeb::CleanupGlobalData();
}

}  // namespace mozilla