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/>.
25 #include "compose.hpp"
27 #include "dcpomatic_log.h"
29 #include "exceptions.h"
30 #include "dcpomatic_assert.h"
32 #include <dcp/raw_convert.h>
35 #include <libavformat/avio.h>
37 #include <boost/algorithm/string.hpp>
38 #include <boost/dll/runtime_symbol_info.hpp>
49 #include <knownfolders.h>
64 using std::runtime_error;
65 using std::shared_ptr;
69 using boost::optional;
72 static std::vector<pair<HANDLE, string>> locked_volumes;
75 /** @param s Number of seconds to sleep for */
77 dcpomatic_sleep_seconds (int s)
84 dcpomatic_sleep_milliseconds (int ms)
90 /** @return A string of CPU information (model name etc.) */
97 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, L"HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0", 0, KEY_READ, &key) != ERROR_SUCCESS) {
103 if (RegQueryValueEx (key, L"ProcessorNameString", 0, &type, 0, &data) != ERROR_SUCCESS) {
107 if (type != REG_SZ) {
111 wstring value (data / sizeof (wchar_t), L'\0');
112 if (RegQueryValueEx (key, L"ProcessorNameString", 0, 0, reinterpret_cast<LPBYTE> (&value[0]), &data) != ERROR_SUCCESS) {
117 info = string (value.begin(), value.end());
126 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
128 SECURITY_ATTRIBUTES security;
129 security.nLength = sizeof (security);
130 security.bInheritHandle = TRUE;
131 security.lpSecurityDescriptor = 0;
133 HANDLE child_stderr_read;
134 HANDLE child_stderr_write;
135 if (!CreatePipe (&child_stderr_read, &child_stderr_write, &security, 0)) {
136 LOG_ERROR_NC ("ffprobe call failed (could not CreatePipe)");
141 MultiByteToWideChar (CP_UTF8, 0, directory_containing_executable().string().c_str(), -1, dir, sizeof(dir));
143 STARTUPINFO startup_info;
144 ZeroMemory (&startup_info, sizeof (startup_info));
145 startup_info.cb = sizeof (startup_info);
146 startup_info.hStdError = child_stderr_write;
147 startup_info.dwFlags |= STARTF_USESTDHANDLES;
149 wchar_t command[512];
150 wcscpy (command, L"ffprobe.exe \"");
153 MultiByteToWideChar (CP_UTF8, 0, content.string().c_str(), -1, file, sizeof(file));
154 wcscat (command, file);
156 wcscat (command, L"\"");
158 PROCESS_INFORMATION process_info;
159 ZeroMemory (&process_info, sizeof (process_info));
160 if (!CreateProcess (0, command, 0, 0, TRUE, CREATE_NO_WINDOW, 0, dir, &startup_info, &process_info)) {
161 LOG_ERROR_NC (N_("ffprobe call failed (could not CreateProcess)"));
165 auto o = fopen_boost (out, "w");
167 LOG_ERROR_NC (N_("ffprobe call failed (could not create output file)"));
171 CloseHandle (child_stderr_write);
176 if (!ReadFile(child_stderr_read, buffer, sizeof(buffer), &read, 0) || read == 0) {
179 fwrite (buffer, read, 1, o);
184 WaitForSingleObject (process_info.hProcess, INFINITE);
185 CloseHandle (process_info.hProcess);
186 CloseHandle (process_info.hThread);
187 CloseHandle (child_stderr_read);
191 list<pair<string, string>>
198 boost::filesystem::path
199 directory_containing_executable ()
201 return boost::dll::program_location().parent_path();
205 boost::filesystem::path
208 return directory_containing_executable().parent_path();
212 boost::filesystem::path
213 libdcp_resources_path ()
215 return resources_path ();
219 boost::filesystem::path
222 return directory_containing_executable() / "openssl.exe";
226 #ifdef DCPOMATIC_DISK
227 boost::filesystem::path
230 return directory_containing_executable() / "dcpomatic2_disk_writer.exe";
235 /** Windows can't "by default" cope with paths longer than 260 characters, so if you pass such a path to
236 * any boost::filesystem method it will fail. There is a "fix" for this, which is to prepend
237 * the string \\?\ to the path. This will make it work, so long as:
238 * - the path is absolute.
239 * - the path only uses backslashes.
240 * - individual path components are "short enough" (probably less than 255 characters)
242 * See https://www.boost.org/doc/libs/1_57_0/libs/filesystem/doc/reference.html under
243 * "Warning: Long paths on Windows" for some details.
245 * Our fopen_boost uses this method to get this fix, but any other calls to boost::filesystem
246 * will not unless this method is explicitly called to pre-process the pathname.
248 boost::filesystem::path
249 fix_long_path (boost::filesystem::path long_path)
251 using namespace boost::filesystem;
253 if (boost::algorithm::starts_with(long_path.string(), "\\\\")) {
254 /* This could mean it starts with \\ (i.e. a SMB path) or \\?\ (a long path)
255 * or a variety of other things... anyway, we'll leave it alone.
260 /* We have to make the path canonical but we can't call canonical() on the long path
261 * as it will fail. So we'll sort of do it ourselves (possibly badly).
263 path fixed = "\\\\?\\";
264 if (long_path.is_absolute()) {
265 fixed += long_path.make_preferred();
267 fixed += boost::filesystem::current_path() / long_path.make_preferred();
273 /* Apparently there is no way to create an ofstream using a UTF-8
274 filename under Windows. We are hence reduced to using fopen
278 fopen_boost (boost::filesystem::path p, string t)
280 wstring w (t.begin(), t.end());
281 /* c_str() on fixed here should give a UTF-16 string */
282 return _wfopen (fix_long_path(p).c_str(), w.c_str());
287 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
289 return _fseeki64 (stream, offset, whence);
296 boost::mutex::scoped_lock lm (_mutex);
297 SetThreadExecutionState (ES_SYSTEM_REQUIRED);
314 start_tool (string executable)
316 auto batch = directory_containing_executable() / executable;
318 STARTUPINFO startup_info;
319 ZeroMemory (&startup_info, sizeof (startup_info));
320 startup_info.cb = sizeof (startup_info);
322 PROCESS_INFORMATION process_info;
323 ZeroMemory (&process_info, sizeof (process_info));
326 MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
327 CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
332 start_batch_converter ()
334 start_tool ("dcpomatic2_batch");
341 start_tool ("dcpomatic2_player");
348 return (uint64_t) GetCurrentThreadId ();
353 wchar_to_utf8 (wchar_t const * s)
355 int const length = (wcslen(s) + 1) * 2;
356 std::vector<char> utf8(length);
357 WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8.data(), length, 0, 0);
358 string u (utf8.data());
364 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
366 return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
371 maybe_open_console ()
373 if (Config::instance()->win32_console ()) {
376 auto handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
377 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
378 auto hf_out = _fdopen(hCrt, "w");
379 setvbuf(hf_out, NULL, _IONBF, 1);
382 auto handle_in = GetStdHandle(STD_INPUT_HANDLE);
383 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
384 auto hf_in = _fdopen(hCrt, "r");
385 setvbuf(hf_in, NULL, _IONBF, 128);
391 boost::filesystem::path
395 auto result = SHGetKnownFolderPath(FOLDERID_Documents, 0, nullptr, &wide_path);
397 if (result != S_OK) {
398 CoTaskMemFree(wide_path);
399 return boost::filesystem::path("c:\\");
402 auto path = wchar_to_utf8(wide_path);
403 CoTaskMemFree(wide_path);
408 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
413 IsWow64Process (GetCurrentProcess(), &p);
418 static optional<string>
419 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
421 wchar_t buffer[MAX_PATH];
422 ZeroMemory (&buffer, sizeof(buffer));
423 bool r = SetupDiGetDeviceRegistryPropertyW (
424 device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
427 return optional<string>();
429 return wchar_to_utf8 (buffer);
433 static const GUID GUID_DEVICE_INTERFACE_DISK = {
434 0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
439 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
441 /* Find the Windows path to the device */
443 SP_DEVICE_INTERFACE_DATA device_interface_data;
444 device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
446 auto r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
448 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
449 return optional<int>();
452 /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
454 r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
455 PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
456 if (!device_detail_data) {
457 LOG_DISK_NC("malloc failed");
458 return optional<int>();
461 device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
463 /* And get the path */
464 r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
466 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
467 free (device_detail_data);
468 return optional<int>();
471 /* Open it. We would not be allowed GENERIC_READ access here but specifying 0 for
472 dwDesiredAccess allows us to query some metadata.
474 auto device = CreateFileW (
475 device_detail_data->DevicePath, 0,
476 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
480 free (device_detail_data);
482 if (device == INVALID_HANDLE_VALUE) {
483 LOG_DISK("CreateFileW failed with %1", GetLastError());
484 return optional<int>();
487 /* Get the device number */
488 STORAGE_DEVICE_NUMBER device_number;
489 r = DeviceIoControl (
490 device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
491 &device_number, sizeof(device_number), &size, 0
494 CloseHandle (device);
500 return device_number.DeviceNumber;
504 typedef map<int, vector<boost::filesystem::path>> MountPoints;
507 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
511 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
513 LOG_DISK("Looking at %1", wchar_to_utf8(volume));
515 wchar_t volume_path_names[512];
516 vector<boost::filesystem::path> mp;
518 if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
519 wchar_t* p = volume_path_names;
520 while (*p != L'\0') {
521 mp.push_back (wchar_to_utf8(p));
522 LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
527 /* Strip trailing \ */
528 size_t const len = wcslen (volume);
529 DCPOMATIC_ASSERT (len > 0);
530 volume[len - 1] = L'\0';
532 auto handle = CreateFileW (
534 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
538 DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
540 VOLUME_DISK_EXTENTS extents;
542 BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
543 CloseHandle (handle);
547 DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
549 mount_points[extents.Extents[0].DiskNumber] = mp;
556 MountPoints mount_points;
558 wchar_t volume_name[512];
559 auto volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
560 if (volume == INVALID_HANDLE_VALUE) {
561 return MountPoints();
564 add_volume_mount_points (volume_name, mount_points);
566 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
569 add_volume_mount_points (volume_name, mount_points);
571 FindVolumeClose (volume);
580 vector<Drive> drives;
582 auto mount_points = find_mount_points ();
584 /* Get a `device information set' containing information about all disks */
585 auto device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
586 if (device_info == INVALID_HANDLE_VALUE) {
587 LOG_DISK_NC ("SetupDiClassDevsA failed");
593 /* Find out about the next disk */
594 SP_DEVINFO_DATA device_info_data;
595 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
596 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
597 DWORD e = GetLastError();
598 if (e != ERROR_NO_MORE_ITEMS) {
599 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
605 auto const friendly_name = get_friendly_name (device_info, &device_info_data);
606 auto device_number = get_device_number (device_info, &device_info_data);
607 if (!device_number) {
611 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
613 HANDLE device = CreateFileA (
614 physical_drive.c_str(), 0,
615 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
619 if (device == INVALID_HANDLE_VALUE) {
620 LOG_DISK_NC("Could not open PHYSICALDRIVE");
626 BOOL r = DeviceIoControl (
627 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
628 &geom, sizeof(geom), &returned, 0
631 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
633 for (auto const& i: locked_volumes) {
634 if (i.second == physical_drive) {
640 uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
641 drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
642 LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
645 CloseHandle (device);
655 LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
656 DCPOMATIC_ASSERT (_mount_points.size() == 1);
657 string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
658 string const truncated = device_name.substr (0, device_name.length() - 1);
659 LOG_DISK("Actually opening %1", truncated);
660 HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
661 if (device == INVALID_HANDLE_VALUE) {
662 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
666 BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
668 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
672 LOG_DISK("Unmount of %1 succeeded", _device);
673 locked_volumes.push_back (make_pair(device, _device));
679 boost::filesystem::path
680 config_path (optional<string> version)
682 boost::filesystem::path p;
683 p /= g_get_user_config_dir ();
693 disk_write_finished ()
695 for (auto const& i: locked_volumes) {
696 CloseHandle (i.first);
702 dcpomatic::get_process_id ()
704 return dcp::raw_convert<string>(GetCurrentProcessId());
709 show_in_file_manager (boost::filesystem::path, boost::filesystem::path select)
711 std::wstringstream args;
712 args << "/select," << select;
713 auto const r = ShellExecute (0, L"open", L"explorer.exe", args.str().c_str(), 0, SW_SHOWDEFAULT);
714 return (reinterpret_cast<int64_t>(r) <= 32);