2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
23 #include "compose.hpp"
25 #include "dcpomatic_log.h"
27 #include "exceptions.h"
28 #include "dcpomatic_assert.h"
29 #include <dcp/raw_convert.h>
32 #include <libavformat/avio.h>
34 #include <boost/algorithm/string.hpp>
35 #include <boost/dll/runtime_symbol_info.hpp>
59 using std::runtime_error;
60 using std::shared_ptr;
64 using boost::optional;
67 static std::vector<pair<HANDLE, string>> locked_volumes;
70 /** @param s Number of seconds to sleep for */
72 dcpomatic_sleep_seconds (int s)
79 dcpomatic_sleep_milliseconds (int ms)
85 /** @return A string of CPU information (model name etc.) */
92 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, L"HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0", 0, KEY_READ, &key) != ERROR_SUCCESS) {
98 if (RegQueryValueEx (key, L"ProcessorNameString", 0, &type, 0, &data) != ERROR_SUCCESS) {
102 if (type != REG_SZ) {
106 wstring value (data / sizeof (wchar_t), L'\0');
107 if (RegQueryValueEx (key, L"ProcessorNameString", 0, 0, reinterpret_cast<LPBYTE> (&value[0]), &data) != ERROR_SUCCESS) {
112 info = string (value.begin(), value.end());
121 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
123 SECURITY_ATTRIBUTES security;
124 security.nLength = sizeof (security);
125 security.bInheritHandle = TRUE;
126 security.lpSecurityDescriptor = 0;
128 HANDLE child_stderr_read;
129 HANDLE child_stderr_write;
130 if (!CreatePipe (&child_stderr_read, &child_stderr_write, &security, 0)) {
131 LOG_ERROR_NC ("ffprobe call failed (could not CreatePipe)");
136 MultiByteToWideChar (CP_UTF8, 0, directory_containing_executable().string().c_str(), -1, dir, sizeof(dir));
138 STARTUPINFO startup_info;
139 ZeroMemory (&startup_info, sizeof (startup_info));
140 startup_info.cb = sizeof (startup_info);
141 startup_info.hStdError = child_stderr_write;
142 startup_info.dwFlags |= STARTF_USESTDHANDLES;
144 wchar_t command[512];
145 wcscpy (command, L"ffprobe.exe \"");
148 MultiByteToWideChar (CP_UTF8, 0, content.string().c_str(), -1, file, sizeof(file));
149 wcscat (command, file);
151 wcscat (command, L"\"");
153 PROCESS_INFORMATION process_info;
154 ZeroMemory (&process_info, sizeof (process_info));
155 if (!CreateProcess (0, command, 0, 0, TRUE, CREATE_NO_WINDOW, 0, dir, &startup_info, &process_info)) {
156 LOG_ERROR_NC (N_("ffprobe call failed (could not CreateProcess)"));
160 auto o = fopen_boost (out, "w");
162 LOG_ERROR_NC (N_("ffprobe call failed (could not create output file)"));
166 CloseHandle (child_stderr_write);
171 if (!ReadFile(child_stderr_read, buffer, sizeof(buffer), &read, 0) || read == 0) {
174 fwrite (buffer, read, 1, o);
179 WaitForSingleObject (process_info.hProcess, INFINITE);
180 CloseHandle (process_info.hProcess);
181 CloseHandle (process_info.hThread);
182 CloseHandle (child_stderr_read);
186 list<pair<string, string>>
193 boost::filesystem::path
194 directory_containing_executable ()
196 return boost::dll::program_location().parent_path();
200 boost::filesystem::path
203 return directory_containing_executable().parent_path();
207 boost::filesystem::path
210 return directory_containing_executable().parent_path() / "xsd";
214 boost::filesystem::path
217 return directory_containing_executable().parent_path() / "tags";
221 boost::filesystem::path
224 return directory_containing_executable() / "openssl.exe";
228 #ifdef DCPOMATIC_DISK
229 boost::filesystem::path
232 return directory_containing_executable() / "dcpomatic2_disk_writer.exe";
237 /* Apparently there is no way to create an ofstream using a UTF-8
238 filename under Windows. We are hence reduced to using fopen
242 fopen_boost (boost::filesystem::path p, string t)
244 wstring w (t.begin(), t.end());
245 /* c_str() here should give a UTF-16 string */
246 return _wfopen (p.c_str(), w.c_str ());
251 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
253 return _fseeki64 (stream, offset, whence);
260 boost::mutex::scoped_lock lm (_mutex);
261 SetThreadExecutionState (ES_SYSTEM_REQUIRED);
278 start_tool (string executable)
280 auto batch = directory_containing_executable() / executable;
282 STARTUPINFO startup_info;
283 ZeroMemory (&startup_info, sizeof (startup_info));
284 startup_info.cb = sizeof (startup_info);
286 PROCESS_INFORMATION process_info;
287 ZeroMemory (&process_info, sizeof (process_info));
290 MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
291 CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
296 start_batch_converter ()
298 start_tool ("dcpomatic2_batch");
305 start_tool ("dcpomatic2_player");
312 return (uint64_t) GetCurrentThreadId ();
317 wchar_to_utf8 (wchar_t const * s)
319 int const length = (wcslen(s) + 1) * 2;
320 char* utf8 = new char[length];
321 WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8, length, 0, 0);
329 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
331 return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
336 maybe_open_console ()
338 if (Config::instance()->win32_console ()) {
341 auto handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
342 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
343 auto hf_out = _fdopen(hCrt, "w");
344 setvbuf(hf_out, NULL, _IONBF, 1);
347 auto handle_in = GetStdHandle(STD_INPUT_HANDLE);
348 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
349 auto hf_in = _fdopen(hCrt, "r");
350 setvbuf(hf_in, NULL, _IONBF, 128);
356 boost::filesystem::path
359 return boost::filesystem::path(getenv("HOMEDRIVE")) / boost::filesystem::path(getenv("HOMEPATH"));
363 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
368 IsWow64Process (GetCurrentProcess(), &p);
373 static optional<string>
374 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
376 wchar_t buffer[MAX_PATH];
377 ZeroMemory (&buffer, sizeof(buffer));
378 bool r = SetupDiGetDeviceRegistryPropertyW (
379 device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
382 return optional<string>();
384 return wchar_to_utf8 (buffer);
388 static const GUID GUID_DEVICE_INTERFACE_DISK = {
389 0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
394 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
396 /* Find the Windows path to the device */
398 SP_DEVICE_INTERFACE_DATA device_interface_data;
399 device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
401 auto r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
403 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
404 return optional<int>();
407 /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
409 r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
410 PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
411 if (!device_detail_data) {
412 LOG_DISK_NC("malloc failed");
413 return optional<int>();
416 device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
418 /* And get the path */
419 r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
421 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
422 free (device_detail_data);
423 return optional<int>();
426 /* Open it. We would not be allowed GENERIC_READ access here but specifying 0 for
427 dwDesiredAccess allows us to query some metadata.
429 auto device = CreateFileW (
430 device_detail_data->DevicePath, 0,
431 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
435 free (device_detail_data);
437 if (device == INVALID_HANDLE_VALUE) {
438 LOG_DISK("CreateFileW failed with %1", GetLastError());
439 return optional<int>();
442 /* Get the device number */
443 STORAGE_DEVICE_NUMBER device_number;
444 r = DeviceIoControl (
445 device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
446 &device_number, sizeof(device_number), &size, 0
449 CloseHandle (device);
455 return device_number.DeviceNumber;
459 typedef map<int, vector<boost::filesystem::path>> MountPoints;
462 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
466 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
468 LOG_DISK("Looking at %1", wchar_to_utf8(volume));
470 wchar_t volume_path_names[512];
471 vector<boost::filesystem::path> mp;
473 if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
474 wchar_t* p = volume_path_names;
475 while (*p != L'\0') {
476 mp.push_back (wchar_to_utf8(p));
477 LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
482 /* Strip trailing \ */
483 size_t const len = wcslen (volume);
484 DCPOMATIC_ASSERT (len > 0);
485 volume[len - 1] = L'\0';
487 auto handle = CreateFileW (
489 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
493 DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
495 VOLUME_DISK_EXTENTS extents;
497 BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
498 CloseHandle (handle);
502 DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
504 mount_points[extents.Extents[0].DiskNumber] = mp;
511 MountPoints mount_points;
513 wchar_t volume_name[512];
514 auto volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
515 if (volume == INVALID_HANDLE_VALUE) {
516 return MountPoints();
519 add_volume_mount_points (volume_name, mount_points);
521 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
524 add_volume_mount_points (volume_name, mount_points);
526 FindVolumeClose (volume);
535 vector<Drive> drives;
537 auto mount_points = find_mount_points ();
539 /* Get a `device information set' containing information about all disks */
540 auto device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
541 if (device_info == INVALID_HANDLE_VALUE) {
542 LOG_DISK_NC ("SetupDiClassDevsA failed");
548 /* Find out about the next disk */
549 SP_DEVINFO_DATA device_info_data;
550 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
551 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
552 DWORD e = GetLastError();
553 if (e != ERROR_NO_MORE_ITEMS) {
554 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
560 auto const friendly_name = get_friendly_name (device_info, &device_info_data);
561 auto device_number = get_device_number (device_info, &device_info_data);
562 if (!device_number) {
566 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
568 HANDLE device = CreateFileA (
569 physical_drive.c_str(), 0,
570 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
574 if (device == INVALID_HANDLE_VALUE) {
575 LOG_DISK_NC("Could not open PHYSICALDRIVE");
581 BOOL r = DeviceIoControl (
582 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
583 &geom, sizeof(geom), &returned, 0
586 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
588 for (auto const& i: locked_volumes) {
589 if (i.second == physical_drive) {
595 uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
596 drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
597 LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
600 CloseHandle (device);
610 LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
611 DCPOMATIC_ASSERT (_mount_points.size() == 1);
612 string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
613 string const truncated = device_name.substr (0, device_name.length() - 1);
614 //LOG_DISK("Actually opening %1", _device);
615 //HANDLE device = CreateFileA (_device.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
616 LOG_DISK("Actually opening %1", truncated);
617 HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
618 if (device == INVALID_HANDLE_VALUE) {
619 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
623 BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
625 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
629 LOG_DISK("Unmount of %1 succeeded", _device);
630 locked_volumes.push_back (make_pair(device, _device));
636 boost::filesystem::path
639 boost::filesystem::path p;
640 p /= g_get_user_config_dir ();
647 disk_write_finished ()
649 for (auto const& i: locked_volumes) {
650 CloseHandle (i.first);
656 dcpomatic::get_process_id ()
658 return dcp::raw_convert<string>(GetCurrentProcessId());