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"
30 #include <dcp/raw_convert.h>
33 #include <libavformat/avio.h>
35 #include <boost/algorithm/string.hpp>
36 #include <boost/dll/runtime_symbol_info.hpp>
60 using std::runtime_error;
61 using std::shared_ptr;
65 using boost::optional;
68 static std::vector<pair<HANDLE, string>> locked_volumes;
71 /** @param s Number of seconds to sleep for */
73 dcpomatic_sleep_seconds (int s)
80 dcpomatic_sleep_milliseconds (int ms)
86 /** @return A string of CPU information (model name etc.) */
93 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, L"HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0", 0, KEY_READ, &key) != ERROR_SUCCESS) {
99 if (RegQueryValueEx (key, L"ProcessorNameString", 0, &type, 0, &data) != ERROR_SUCCESS) {
103 if (type != REG_SZ) {
107 wstring value (data / sizeof (wchar_t), L'\0');
108 if (RegQueryValueEx (key, L"ProcessorNameString", 0, 0, reinterpret_cast<LPBYTE> (&value[0]), &data) != ERROR_SUCCESS) {
113 info = string (value.begin(), value.end());
122 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
124 SECURITY_ATTRIBUTES security;
125 security.nLength = sizeof (security);
126 security.bInheritHandle = TRUE;
127 security.lpSecurityDescriptor = 0;
129 HANDLE child_stderr_read;
130 HANDLE child_stderr_write;
131 if (!CreatePipe (&child_stderr_read, &child_stderr_write, &security, 0)) {
132 LOG_ERROR_NC ("ffprobe call failed (could not CreatePipe)");
137 MultiByteToWideChar (CP_UTF8, 0, directory_containing_executable().string().c_str(), -1, dir, sizeof(dir));
139 STARTUPINFO startup_info;
140 ZeroMemory (&startup_info, sizeof (startup_info));
141 startup_info.cb = sizeof (startup_info);
142 startup_info.hStdError = child_stderr_write;
143 startup_info.dwFlags |= STARTF_USESTDHANDLES;
145 wchar_t command[512];
146 wcscpy (command, L"ffprobe.exe \"");
149 MultiByteToWideChar (CP_UTF8, 0, content.string().c_str(), -1, file, sizeof(file));
150 wcscat (command, file);
152 wcscat (command, L"\"");
154 PROCESS_INFORMATION process_info;
155 ZeroMemory (&process_info, sizeof (process_info));
156 if (!CreateProcess (0, command, 0, 0, TRUE, CREATE_NO_WINDOW, 0, dir, &startup_info, &process_info)) {
157 LOG_ERROR_NC (N_("ffprobe call failed (could not CreateProcess)"));
161 auto o = fopen_boost (out, "w");
163 LOG_ERROR_NC (N_("ffprobe call failed (could not create output file)"));
167 CloseHandle (child_stderr_write);
172 if (!ReadFile(child_stderr_read, buffer, sizeof(buffer), &read, 0) || read == 0) {
175 fwrite (buffer, read, 1, o);
180 WaitForSingleObject (process_info.hProcess, INFINITE);
181 CloseHandle (process_info.hProcess);
182 CloseHandle (process_info.hThread);
183 CloseHandle (child_stderr_read);
187 list<pair<string, string>>
194 boost::filesystem::path
195 directory_containing_executable ()
197 return boost::dll::program_location().parent_path();
201 boost::filesystem::path
204 return directory_containing_executable().parent_path();
208 boost::filesystem::path
211 return directory_containing_executable().parent_path() / "xsd";
215 boost::filesystem::path
218 return directory_containing_executable().parent_path() / "tags";
222 boost::filesystem::path
225 return directory_containing_executable() / "openssl.exe";
229 #ifdef DCPOMATIC_DISK
230 boost::filesystem::path
233 return directory_containing_executable() / "dcpomatic2_disk_writer.exe";
238 /** Windows can't "by default" cope with paths longer than 260 characters, so if you pass such a path to
239 * any boost::filesystem method it will fail. There is a "fix" for this, which is to prepend
240 * the string \\?\ to the path. This will make it work, so long as:
241 * - the path is absolute.
242 * - the path only uses backslashes.
243 * - individual path components are "short enough" (probably less than 255 characters)
245 * See https://www.boost.org/doc/libs/1_57_0/libs/filesystem/doc/reference.html under
246 * "Warning: Long paths on Windows" for some details.
248 * Our fopen_boost uses this method to get this fix, but any other calls to boost::filesystem
249 * will not unless this method is explicitly called to pre-process the pathname.
251 boost::filesystem::path
252 fix_long_path (boost::filesystem::path long_path)
254 using namespace boost::filesystem;
255 path fixed = "\\\\?\\";
256 /* We have to make the path canonical but we can't call canonical() on the long path
257 * as it will fail. So we'll sort of do it ourselves (possibly badly).
259 if (long_path.is_absolute()) {
260 fixed += long_path.make_preferred();
262 fixed += boost::filesystem::current_path() / long_path.make_preferred();
268 /* Apparently there is no way to create an ofstream using a UTF-8
269 filename under Windows. We are hence reduced to using fopen
273 fopen_boost (boost::filesystem::path p, string t)
275 wstring w (t.begin(), t.end());
276 /* c_str() on fixed here should give a UTF-16 string */
277 return _wfopen (fix_long_path(p).c_str(), w.c_str());
282 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
284 return _fseeki64 (stream, offset, whence);
291 boost::mutex::scoped_lock lm (_mutex);
292 SetThreadExecutionState (ES_SYSTEM_REQUIRED);
309 start_tool (string executable)
311 auto batch = directory_containing_executable() / executable;
313 STARTUPINFO startup_info;
314 ZeroMemory (&startup_info, sizeof (startup_info));
315 startup_info.cb = sizeof (startup_info);
317 PROCESS_INFORMATION process_info;
318 ZeroMemory (&process_info, sizeof (process_info));
321 MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
322 CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
327 start_batch_converter ()
329 start_tool ("dcpomatic2_batch");
336 start_tool ("dcpomatic2_player");
343 return (uint64_t) GetCurrentThreadId ();
348 wchar_to_utf8 (wchar_t const * s)
350 int const length = (wcslen(s) + 1) * 2;
351 char* utf8 = new char[length];
352 WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8, length, 0, 0);
360 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
362 return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
367 maybe_open_console ()
369 if (Config::instance()->win32_console ()) {
372 auto handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
373 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
374 auto hf_out = _fdopen(hCrt, "w");
375 setvbuf(hf_out, NULL, _IONBF, 1);
378 auto handle_in = GetStdHandle(STD_INPUT_HANDLE);
379 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
380 auto hf_in = _fdopen(hCrt, "r");
381 setvbuf(hf_in, NULL, _IONBF, 128);
387 boost::filesystem::path
390 return boost::filesystem::path(getenv("HOMEDRIVE")) / boost::filesystem::path(getenv("HOMEPATH"));
394 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
399 IsWow64Process (GetCurrentProcess(), &p);
404 static optional<string>
405 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
407 wchar_t buffer[MAX_PATH];
408 ZeroMemory (&buffer, sizeof(buffer));
409 bool r = SetupDiGetDeviceRegistryPropertyW (
410 device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
413 return optional<string>();
415 return wchar_to_utf8 (buffer);
419 static const GUID GUID_DEVICE_INTERFACE_DISK = {
420 0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
425 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
427 /* Find the Windows path to the device */
429 SP_DEVICE_INTERFACE_DATA device_interface_data;
430 device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
432 auto r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
434 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
435 return optional<int>();
438 /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
440 r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
441 PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
442 if (!device_detail_data) {
443 LOG_DISK_NC("malloc failed");
444 return optional<int>();
447 device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
449 /* And get the path */
450 r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
452 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
453 free (device_detail_data);
454 return optional<int>();
457 /* Open it. We would not be allowed GENERIC_READ access here but specifying 0 for
458 dwDesiredAccess allows us to query some metadata.
460 auto device = CreateFileW (
461 device_detail_data->DevicePath, 0,
462 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
466 free (device_detail_data);
468 if (device == INVALID_HANDLE_VALUE) {
469 LOG_DISK("CreateFileW failed with %1", GetLastError());
470 return optional<int>();
473 /* Get the device number */
474 STORAGE_DEVICE_NUMBER device_number;
475 r = DeviceIoControl (
476 device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
477 &device_number, sizeof(device_number), &size, 0
480 CloseHandle (device);
486 return device_number.DeviceNumber;
490 typedef map<int, vector<boost::filesystem::path>> MountPoints;
493 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
497 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
499 LOG_DISK("Looking at %1", wchar_to_utf8(volume));
501 wchar_t volume_path_names[512];
502 vector<boost::filesystem::path> mp;
504 if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
505 wchar_t* p = volume_path_names;
506 while (*p != L'\0') {
507 mp.push_back (wchar_to_utf8(p));
508 LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
513 /* Strip trailing \ */
514 size_t const len = wcslen (volume);
515 DCPOMATIC_ASSERT (len > 0);
516 volume[len - 1] = L'\0';
518 auto handle = CreateFileW (
520 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
524 DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
526 VOLUME_DISK_EXTENTS extents;
528 BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
529 CloseHandle (handle);
533 DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
535 mount_points[extents.Extents[0].DiskNumber] = mp;
542 MountPoints mount_points;
544 wchar_t volume_name[512];
545 auto volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
546 if (volume == INVALID_HANDLE_VALUE) {
547 return MountPoints();
550 add_volume_mount_points (volume_name, mount_points);
552 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
555 add_volume_mount_points (volume_name, mount_points);
557 FindVolumeClose (volume);
566 vector<Drive> drives;
568 auto mount_points = find_mount_points ();
570 /* Get a `device information set' containing information about all disks */
571 auto device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
572 if (device_info == INVALID_HANDLE_VALUE) {
573 LOG_DISK_NC ("SetupDiClassDevsA failed");
579 /* Find out about the next disk */
580 SP_DEVINFO_DATA device_info_data;
581 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
582 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
583 DWORD e = GetLastError();
584 if (e != ERROR_NO_MORE_ITEMS) {
585 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
591 auto const friendly_name = get_friendly_name (device_info, &device_info_data);
592 auto device_number = get_device_number (device_info, &device_info_data);
593 if (!device_number) {
597 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
599 HANDLE device = CreateFileA (
600 physical_drive.c_str(), 0,
601 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
605 if (device == INVALID_HANDLE_VALUE) {
606 LOG_DISK_NC("Could not open PHYSICALDRIVE");
612 BOOL r = DeviceIoControl (
613 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
614 &geom, sizeof(geom), &returned, 0
617 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
619 for (auto const& i: locked_volumes) {
620 if (i.second == physical_drive) {
626 uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
627 drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
628 LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
631 CloseHandle (device);
641 LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
642 DCPOMATIC_ASSERT (_mount_points.size() == 1);
643 string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
644 string const truncated = device_name.substr (0, device_name.length() - 1);
645 //LOG_DISK("Actually opening %1", _device);
646 //HANDLE device = CreateFileA (_device.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
647 LOG_DISK("Actually opening %1", truncated);
648 HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
649 if (device == INVALID_HANDLE_VALUE) {
650 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
654 BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
656 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
660 LOG_DISK("Unmount of %1 succeeded", _device);
661 locked_volumes.push_back (make_pair(device, _device));
667 boost::filesystem::path
670 boost::filesystem::path p;
671 p /= g_get_user_config_dir ();
678 disk_write_finished ()
680 for (auto const& i: locked_volumes) {
681 CloseHandle (i.first);
687 dcpomatic::get_process_id ()
689 return dcp::raw_convert<string>(GetCurrentProcessId());