| // Copyright 2014 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "media/video/capture/win/video_capture_device_factory_win.h" |
| |
| #include <mfapi.h> |
| #include <mferror.h> |
| |
| #include "base/command_line.h" |
| #include "base/lazy_instance.h" |
| #include "base/metrics/histogram.h" |
| #include "base/strings/string_util.h" |
| #include "base/strings/sys_string_conversions.h" |
| #include "base/win/metro.h" |
| #include "base/win/scoped_co_mem.h" |
| #include "base/win/scoped_variant.h" |
| #include "base/win/windows_version.h" |
| #include "media/base/media_switches.h" |
| #include "media/video/capture/win/video_capture_device_mf_win.h" |
| #include "media/video/capture/win/video_capture_device_win.h" |
| |
| using base::win::ScopedCoMem; |
| using base::win::ScopedComPtr; |
| using base::win::ScopedVariant; |
| using Name = media::VideoCaptureDevice::Name; |
| using Names = media::VideoCaptureDevice::Names; |
| |
| namespace media { |
| |
| // We would like to avoid enumerating and/or using certain devices due to they |
| // provoking crashes or any other reason. This enum is defined for the purposes |
| // of UMA collection. Existing entries cannot be removed. |
| enum BlacklistedCameraNames { |
| BLACKLISTED_CAMERA_GOOGLE_CAMERA_ADAPTER, |
| BLACKLISTED_CAMERA_IP_CAMERA, |
| BLACKLISTED_CAMERA_CYBERLINK_WEBCAM_SPLITTER, |
| // This one must be last, and equal to the previous enumerated value. |
| BLACKLISTED_CAMERA_MAX = BLACKLISTED_CAMERA_CYBERLINK_WEBCAM_SPLITTER |
| }; |
| |
| // Lazy Instance to initialize the MediaFoundation Library. |
| class MFInitializerSingleton { |
| public: |
| MFInitializerSingleton() { MFStartup(MF_VERSION, MFSTARTUP_LITE); } |
| ~MFInitializerSingleton() { MFShutdown(); } |
| }; |
| |
| static base::LazyInstance<MFInitializerSingleton> g_mf_initialize = |
| LAZY_INSTANCE_INITIALIZER; |
| |
| // Blacklisted devices are identified by a characteristic prefix of the name. |
| // This prefix is used case-insensitively. This list must be kept in sync with |
| // |BlacklistedCameraNames|. |
| static const char* const kBlacklistedCameraNames[] = { |
| // Name of a fake DirectShow filter on computers with GTalk installed. |
| "Google Camera Adapter", |
| // The following two software WebCams cause crashes. |
| "IP Camera [JPEG/MJPEG]", |
| "CyberLink Webcam Splitter", |
| }; |
| |
| static void EnsureMediaFoundationInit() { |
| g_mf_initialize.Get(); |
| } |
| |
| static bool LoadMediaFoundationDlls() { |
| static const wchar_t* const kMfDLLs[] = { |
| L"%WINDIR%\\system32\\mf.dll", |
| L"%WINDIR%\\system32\\mfplat.dll", |
| L"%WINDIR%\\system32\\mfreadwrite.dll", |
| }; |
| |
| for (int i = 0; i < arraysize(kMfDLLs); ++i) { |
| wchar_t path[MAX_PATH] = {0}; |
| ExpandEnvironmentStringsW(kMfDLLs[i], path, arraysize(path)); |
| if (!LoadLibraryExW(path, NULL, LOAD_WITH_ALTERED_SEARCH_PATH)) |
| return false; |
| } |
| return true; |
| } |
| |
| static bool PrepareVideoCaptureAttributesMediaFoundation( |
| IMFAttributes** attributes, |
| int count) { |
| EnsureMediaFoundationInit(); |
| |
| if (FAILED(MFCreateAttributes(attributes, count))) |
| return false; |
| |
| return SUCCEEDED((*attributes)->SetGUID(MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE, |
| MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_GUID)); |
| } |
| |
| static bool CreateVideoCaptureDeviceMediaFoundation(const char* sym_link, |
| IMFMediaSource** source) { |
| ScopedComPtr<IMFAttributes> attributes; |
| if (!PrepareVideoCaptureAttributesMediaFoundation(attributes.Receive(), 2)) |
| return false; |
| |
| attributes->SetString(MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_SYMBOLIC_LINK, |
| base::SysUTF8ToWide(sym_link).c_str()); |
| |
| return SUCCEEDED(MFCreateDeviceSource(attributes, source)); |
| } |
| |
| static bool EnumerateVideoDevicesMediaFoundation(IMFActivate*** devices, |
| UINT32* count) { |
| ScopedComPtr<IMFAttributes> attributes; |
| if (!PrepareVideoCaptureAttributesMediaFoundation(attributes.Receive(), 1)) |
| return false; |
| |
| return SUCCEEDED(MFEnumDeviceSources(attributes, devices, count)); |
| } |
| |
| static bool IsDeviceBlackListed(const std::string& name) { |
| DCHECK_EQ(BLACKLISTED_CAMERA_MAX + 1, |
| static_cast<int>(arraysize(kBlacklistedCameraNames))); |
| for (size_t i = 0; i < arraysize(kBlacklistedCameraNames); ++i) { |
| if (StartsWithASCII(name, kBlacklistedCameraNames[i], false)) { |
| DVLOG(1) << "Enumerated blacklisted device: " << name; |
| UMA_HISTOGRAM_ENUMERATION("Media.VideoCapture.BlacklistedDevice", |
| i, BLACKLISTED_CAMERA_MAX + 1); |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| static void GetDeviceNamesDirectShow( |
| const CLSID& class_id, |
| const Name::CaptureApiType capture_api_type, |
| Names* device_names) { |
| DCHECK(device_names); |
| DVLOG(1) << " GetDeviceNamesDirectShow"; |
| |
| ScopedComPtr<ICreateDevEnum> dev_enum; |
| HRESULT hr = dev_enum.CreateInstance(CLSID_SystemDeviceEnum, NULL, |
| CLSCTX_INPROC); |
| if (FAILED(hr)) |
| return; |
| |
| ScopedComPtr<IEnumMoniker> enum_moniker; |
| hr = dev_enum->CreateClassEnumerator(class_id, enum_moniker.Receive(), 0); |
| // CreateClassEnumerator returns S_FALSE on some Windows OS |
| // when no camera exist. Therefore the FAILED macro can't be used. |
| if (hr != S_OK) |
| return; |
| |
| // Enumerate all video capture devices. |
| for (ScopedComPtr<IMoniker> moniker; |
| enum_moniker->Next(1, moniker.Receive(), NULL) == S_OK; |
| moniker.Release()) { |
| ScopedComPtr<IPropertyBag> prop_bag; |
| hr = moniker->BindToStorage(0, 0, IID_IPropertyBag, prop_bag.ReceiveVoid()); |
| if (FAILED(hr)) |
| continue; |
| |
| // Find the description or friendly name. |
| ScopedVariant name; |
| hr = prop_bag->Read(L"Description", name.Receive(), 0); |
| if (FAILED(hr)) |
| hr = prop_bag->Read(L"FriendlyName", name.Receive(), 0); |
| |
| if (FAILED(hr) || name.type() != VT_BSTR) |
| continue; |
| |
| const std::string device_name(base::SysWideToUTF8(V_BSTR(&name))); |
| if (IsDeviceBlackListed(device_name)) |
| continue; |
| |
| name.Reset(); |
| hr = prop_bag->Read(L"DevicePath", name.Receive(), 0); |
| std::string id; |
| if (FAILED(hr) || name.type() != VT_BSTR) { |
| id = device_name; |
| } else { |
| DCHECK_EQ(name.type(), VT_BSTR); |
| id = base::SysWideToUTF8(V_BSTR(&name)); |
| } |
| device_names->push_back(Name(device_name, id, capture_api_type)); |
| } |
| } |
| |
| static void GetDeviceNamesMediaFoundation(Names* device_names) { |
| DVLOG(1) << " GetDeviceNamesMediaFoundation"; |
| ScopedCoMem<IMFActivate*> devices; |
| UINT32 count; |
| if (!EnumerateVideoDevicesMediaFoundation(&devices, &count)) |
| return; |
| |
| for (UINT32 i = 0; i < count; ++i) { |
| ScopedCoMem<wchar_t> name; |
| UINT32 name_size; |
| HRESULT hr = devices[i]->GetAllocatedString( |
| MF_DEVSOURCE_ATTRIBUTE_FRIENDLY_NAME, &name, &name_size); |
| if (SUCCEEDED(hr)) { |
| ScopedCoMem<wchar_t> id; |
| UINT32 id_size; |
| hr = devices[i]->GetAllocatedString( |
| MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_SYMBOLIC_LINK, &id, |
| &id_size); |
| if (SUCCEEDED(hr)) { |
| device_names->push_back(Name( |
| base::SysWideToUTF8(std::wstring(name, name_size)), |
| base::SysWideToUTF8(std::wstring(id, id_size)), |
| Name::MEDIA_FOUNDATION)); |
| } |
| } |
| DLOG_IF(ERROR, FAILED(hr)) << "GetAllocatedString failed: " |
| << logging::SystemErrorCodeToString(hr); |
| devices[i]->Release(); |
| } |
| } |
| |
| static void GetDeviceSupportedFormatsDirectShow(const Name& device, |
| VideoCaptureFormats* formats) { |
| DVLOG(1) << "GetDeviceSupportedFormatsDirectShow for " << device.name(); |
| ScopedComPtr<ICreateDevEnum> dev_enum; |
| HRESULT hr = dev_enum.CreateInstance(CLSID_SystemDeviceEnum, NULL, |
| CLSCTX_INPROC); |
| if (FAILED(hr)) |
| return; |
| |
| ScopedComPtr<IEnumMoniker> enum_moniker; |
| hr = dev_enum->CreateClassEnumerator(CLSID_VideoInputDeviceCategory, |
| enum_moniker.Receive(), 0); |
| // CreateClassEnumerator returns S_FALSE on some Windows OS when no camera |
| // exists. Therefore the FAILED macro can't be used. |
| if (hr != S_OK) |
| return; |
| |
| // Walk the capture devices. No need to check for device presence again since |
| // that is anyway needed in GetDeviceFilter(). "google camera adapter" and old |
| // VFW devices are already skipped previously in GetDeviceNames() enumeration. |
| base::win::ScopedComPtr<IBaseFilter> capture_filter; |
| hr = VideoCaptureDeviceWin::GetDeviceFilter(device.capabilities_id(), |
| CLSID_VideoInputDeviceCategory, |
| capture_filter.Receive()); |
| if (!capture_filter) { |
| DLOG(ERROR) << "Failed to create capture filter: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| |
| base::win::ScopedComPtr<IPin> output_capture_pin( |
| VideoCaptureDeviceWin::GetPin(capture_filter, |
| PINDIR_OUTPUT, |
| PIN_CATEGORY_CAPTURE, |
| GUID_NULL)); |
| if (!output_capture_pin) { |
| DLOG(ERROR) << "Failed to get capture output pin"; |
| return; |
| } |
| |
| ScopedComPtr<IAMStreamConfig> stream_config; |
| hr = output_capture_pin.QueryInterface(stream_config.Receive()); |
| if (FAILED(hr)) { |
| DLOG(ERROR) << "Failed to get IAMStreamConfig interface from " |
| "capture device: " << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| |
| int count = 0, size = 0; |
| hr = stream_config->GetNumberOfCapabilities(&count, &size); |
| if (FAILED(hr)) { |
| DLOG(ERROR) << "GetNumberOfCapabilities failed: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| |
| scoped_ptr<BYTE[]> caps(new BYTE[size]); |
| for (int i = 0; i < count; ++i) { |
| VideoCaptureDeviceWin::ScopedMediaType media_type; |
| hr = stream_config->GetStreamCaps(i, media_type.Receive(), caps.get()); |
| // GetStreamCaps() may return S_FALSE, so don't use FAILED() or SUCCEED() |
| // macros here since they'll trigger incorrectly. |
| if (hr != S_OK || !media_type.get()) { |
| DLOG(ERROR) << "GetStreamCaps failed: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| |
| if (media_type->majortype == MEDIATYPE_Video && |
| media_type->formattype == FORMAT_VideoInfo) { |
| VideoCaptureFormat format; |
| format.pixel_format = |
| VideoCaptureDeviceWin::TranslateMediaSubtypeToPixelFormat( |
| media_type->subtype); |
| if (format.pixel_format == PIXEL_FORMAT_UNKNOWN) |
| continue; |
| VIDEOINFOHEADER* h = |
| reinterpret_cast<VIDEOINFOHEADER*>(media_type->pbFormat); |
| format.frame_size.SetSize(h->bmiHeader.biWidth, |
| h->bmiHeader.biHeight); |
| // Trust the frame rate from the VIDEOINFOHEADER. |
| format.frame_rate = (h->AvgTimePerFrame > 0) ? |
| kSecondsToReferenceTime / static_cast<float>(h->AvgTimePerFrame) : |
| 0.0f; |
| formats->push_back(format); |
| DVLOG(1) << device.name() << " " << format.ToString(); |
| } |
| } |
| } |
| |
| static void GetDeviceSupportedFormatsMediaFoundation( |
| const Name& device, |
| VideoCaptureFormats* formats) { |
| DVLOG(1) << "GetDeviceSupportedFormatsMediaFoundation for " << device.name(); |
| ScopedComPtr<IMFMediaSource> source; |
| if (!CreateVideoCaptureDeviceMediaFoundation(device.id().c_str(), |
| source.Receive())) { |
| return; |
| } |
| |
| base::win::ScopedComPtr<IMFSourceReader> reader; |
| HRESULT hr = |
| MFCreateSourceReaderFromMediaSource(source, NULL, reader.Receive()); |
| if (FAILED(hr)) { |
| DLOG(ERROR) << "MFCreateSourceReaderFromMediaSource failed: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| |
| DWORD stream_index = 0; |
| ScopedComPtr<IMFMediaType> type; |
| while (SUCCEEDED(reader->GetNativeMediaType( |
| kFirstVideoStream, stream_index, type.Receive()))) { |
| UINT32 width, height; |
| hr = MFGetAttributeSize(type, MF_MT_FRAME_SIZE, &width, &height); |
| if (FAILED(hr)) { |
| DLOG(ERROR) << "MFGetAttributeSize failed: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| VideoCaptureFormat capture_format; |
| capture_format.frame_size.SetSize(width, height); |
| |
| UINT32 numerator, denominator; |
| hr = MFGetAttributeRatio(type, MF_MT_FRAME_RATE, &numerator, &denominator); |
| if (FAILED(hr)) { |
| DLOG(ERROR) << "MFGetAttributeSize failed: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| capture_format.frame_rate = denominator |
| ? static_cast<float>(numerator) / denominator : 0.0f; |
| |
| GUID type_guid; |
| hr = type->GetGUID(MF_MT_SUBTYPE, &type_guid); |
| if (FAILED(hr)) { |
| DLOG(ERROR) << "GetGUID failed: " |
| << logging::SystemErrorCodeToString(hr); |
| return; |
| } |
| VideoCaptureDeviceMFWin::FormatFromGuid(type_guid, |
| &capture_format.pixel_format); |
| type.Release(); |
| formats->push_back(capture_format); |
| ++stream_index; |
| |
| DVLOG(1) << device.name() << " " << capture_format.ToString(); |
| } |
| } |
| |
| // Returns true iff the current platform supports the Media Foundation API |
| // and that the DLLs are available. On Vista this API is an optional download |
| // but the API is advertised as a part of Windows 7 and onwards. However, |
| // we've seen that the required DLLs are not available in some Win7 |
| // distributions such as Windows 7 N and Windows 7 KN. |
| // static |
| bool VideoCaptureDeviceFactoryWin::PlatformSupportsMediaFoundation() { |
| // Even though the DLLs might be available on Vista, we get crashes |
| // when running our tests on the build bots. |
| if (base::win::GetVersion() < base::win::VERSION_WIN7) |
| return false; |
| |
| static bool g_dlls_available = LoadMediaFoundationDlls(); |
| return g_dlls_available; |
| } |
| |
| VideoCaptureDeviceFactoryWin::VideoCaptureDeviceFactoryWin() { |
| // Use Media Foundation for Metro processes (after and including Win8) and |
| // DirectShow for any other versions, unless forced via flag. Media Foundation |
| // can also be forced if appropriate flag is set and we are in Windows 7 or |
| // 8 in non-Metro mode. |
| const CommandLine* cmd_line = CommandLine::ForCurrentProcess(); |
| use_media_foundation_ = (base::win::IsMetroProcess() && |
| !cmd_line->HasSwitch(switches::kForceDirectShowVideoCapture)) || |
| (base::win::GetVersion() >= base::win::VERSION_WIN7 && |
| cmd_line->HasSwitch(switches::kForceMediaFoundationVideoCapture)); |
| } |
| |
| |
| scoped_ptr<VideoCaptureDevice> VideoCaptureDeviceFactoryWin::Create( |
| const Name& device_name) { |
| DCHECK(thread_checker_.CalledOnValidThread()); |
| scoped_ptr<VideoCaptureDevice> device; |
| if (device_name.capture_api_type() == Name::MEDIA_FOUNDATION) { |
| DCHECK(PlatformSupportsMediaFoundation()); |
| device.reset(new VideoCaptureDeviceMFWin(device_name)); |
| DVLOG(1) << " MediaFoundation Device: " << device_name.name(); |
| ScopedComPtr<IMFMediaSource> source; |
| if (!CreateVideoCaptureDeviceMediaFoundation(device_name.id().c_str(), |
| source.Receive())) { |
| return scoped_ptr<VideoCaptureDevice>(); |
| } |
| if (!static_cast<VideoCaptureDeviceMFWin*>(device.get())->Init(source)) |
| device.reset(); |
| } else { |
| DCHECK(device_name.capture_api_type() == Name::DIRECT_SHOW || |
| device_name.capture_api_type() == Name::DIRECT_SHOW_WDM_CROSSBAR); |
| device.reset(new VideoCaptureDeviceWin(device_name)); |
| DVLOG(1) << " DirectShow Device: " << device_name.name(); |
| if (!static_cast<VideoCaptureDeviceWin*>(device.get())->Init()) |
| device.reset(); |
| } |
| return device.Pass(); |
| } |
| |
| void VideoCaptureDeviceFactoryWin::GetDeviceNames(Names* device_names) { |
| DCHECK(thread_checker_.CalledOnValidThread()); |
| if (use_media_foundation_) { |
| GetDeviceNamesMediaFoundation(device_names); |
| } else { |
| GetDeviceNamesDirectShow(CLSID_VideoInputDeviceCategory, |
| Name::DIRECT_SHOW, |
| device_names); |
| |
| Names crossbar_device_names; |
| GetDeviceNamesDirectShow(AM_KSCATEGORY_CROSSBAR, |
| Name::DIRECT_SHOW_WDM_CROSSBAR, |
| &crossbar_device_names); |
| // Search in the listed |device_names| to find a device with matching USB ID |
| // to each device in |crossbar_device_names|. |
| for (Names::iterator crossbar_device_it = crossbar_device_names.begin(); |
| crossbar_device_it != crossbar_device_names.end(); |
| ++crossbar_device_it) { |
| const std::string& crossbar_device_model = crossbar_device_it->GetModel(); |
| for (Names::const_iterator device_it = device_names->begin(); |
| device_it != device_names->end(); ++device_it) { |
| if (crossbar_device_model == device_it->GetModel()) { |
| crossbar_device_it->set_capabilities_id(device_it->id()); |
| device_names->push_back(*crossbar_device_it); |
| break; |
| } |
| } |
| } |
| } |
| } |
| |
| void VideoCaptureDeviceFactoryWin::GetDeviceSupportedFormats( |
| const Name& device, |
| VideoCaptureFormats* formats) { |
| DCHECK(thread_checker_.CalledOnValidThread()); |
| if (use_media_foundation_) |
| GetDeviceSupportedFormatsMediaFoundation(device, formats); |
| else |
| GetDeviceSupportedFormatsDirectShow(device, formats); |
| } |
| |
| } // namespace media |
