2 Copyright (C) 2012-2020 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/>.
22 #include "compose.hpp"
24 #include "dcpomatic_log.h"
26 #include "exceptions.h"
27 #include "dcpomatic_assert.h"
28 #include <dcp/raw_convert.h>
31 #include <libavformat/avio.h>
33 #include <boost/algorithm/string.hpp>
34 #include <boost/dll/runtime_symbol_info.hpp>
59 using std::runtime_error;
61 using std::shared_ptr;
62 using boost::optional;
64 static std::vector<pair<HANDLE, string> > locked_volumes;
66 /** @param s Number of seconds to sleep for */
68 dcpomatic_sleep_seconds (int s)
74 dcpomatic_sleep_milliseconds (int ms)
79 /** @return A string of CPU information (model name etc.) */
86 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, L"HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0", 0, KEY_READ, &key) != ERROR_SUCCESS) {
92 if (RegQueryValueEx (key, L"ProcessorNameString", 0, &type, 0, &data) != ERROR_SUCCESS) {
100 wstring value (data / sizeof (wchar_t), L'\0');
101 if (RegQueryValueEx (key, L"ProcessorNameString", 0, 0, reinterpret_cast<LPBYTE> (&value[0]), &data) != ERROR_SUCCESS) {
106 info = string (value.begin(), value.end());
114 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
116 SECURITY_ATTRIBUTES security;
117 security.nLength = sizeof (security);
118 security.bInheritHandle = TRUE;
119 security.lpSecurityDescriptor = 0;
121 HANDLE child_stderr_read;
122 HANDLE child_stderr_write;
123 if (!CreatePipe (&child_stderr_read, &child_stderr_write, &security, 0)) {
124 LOG_ERROR_NC ("ffprobe call failed (could not CreatePipe)");
129 MultiByteToWideChar (CP_UTF8, 0, directory_containing_executable().string().c_str(), -1, dir, sizeof(dir));
131 STARTUPINFO startup_info;
132 ZeroMemory (&startup_info, sizeof (startup_info));
133 startup_info.cb = sizeof (startup_info);
134 startup_info.hStdError = child_stderr_write;
135 startup_info.dwFlags |= STARTF_USESTDHANDLES;
137 wchar_t command[512];
138 wcscpy (command, L"ffprobe.exe \"");
141 MultiByteToWideChar (CP_UTF8, 0, content.string().c_str(), -1, file, sizeof(file));
142 wcscat (command, file);
144 wcscat (command, L"\"");
146 PROCESS_INFORMATION process_info;
147 ZeroMemory (&process_info, sizeof (process_info));
148 if (!CreateProcess (0, command, 0, 0, TRUE, CREATE_NO_WINDOW, 0, dir, &startup_info, &process_info)) {
149 LOG_ERROR_NC (N_("ffprobe call failed (could not CreateProcess)"));
153 FILE* o = fopen_boost (out, "w");
155 LOG_ERROR_NC (N_("ffprobe call failed (could not create output file)"));
159 CloseHandle (child_stderr_write);
164 if (!ReadFile(child_stderr_read, buffer, sizeof(buffer), &read, 0) || read == 0) {
167 fwrite (buffer, read, 1, o);
172 WaitForSingleObject (process_info.hProcess, INFINITE);
173 CloseHandle (process_info.hProcess);
174 CloseHandle (process_info.hThread);
175 CloseHandle (child_stderr_read);
178 list<pair<string, string> >
181 list<pair<string, string> > m;
186 boost::filesystem::path
187 directory_containing_executable ()
189 return boost::dll::program_location().parent_path();
193 boost::filesystem::path
196 return directory_containing_executable().parent_path();
200 boost::filesystem::path
203 return directory_containing_executable().parent_path() / "xsd";
207 boost::filesystem::path
210 return directory_containing_executable().parent_path() / "tags";
214 boost::filesystem::path
217 return directory_containing_executable() / "openssl.exe";
221 #ifdef DCPOMATIC_DISK
222 boost::filesystem::path
225 return directory_containing_executable() / "dcpomatic2_disk_writer.exe";
230 /* Apparently there is no way to create an ofstream using a UTF-8
231 filename under Windows. We are hence reduced to using fopen
235 fopen_boost (boost::filesystem::path p, string t)
237 wstring w (t.begin(), t.end());
238 /* c_str() here should give a UTF-16 string */
239 return _wfopen (p.c_str(), w.c_str ());
243 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
245 return _fseeki64 (stream, offset, whence);
251 boost::mutex::scoped_lock lm (_mutex);
252 SetThreadExecutionState (ES_SYSTEM_REQUIRED);
267 start_tool (string executable)
269 boost::filesystem::path batch = directory_containing_executable() / executable;
271 STARTUPINFO startup_info;
272 ZeroMemory (&startup_info, sizeof (startup_info));
273 startup_info.cb = sizeof (startup_info);
275 PROCESS_INFORMATION process_info;
276 ZeroMemory (&process_info, sizeof (process_info));
279 MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
280 CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
285 start_batch_converter ()
287 start_tool ("dcpomatic2_batch");
294 start_tool ("dcpomatic2_player");
301 return (uint64_t) GetCurrentThreadId ();
305 wchar_to_utf8 (wchar_t const * s)
307 int const length = (wcslen(s) + 1) * 2;
308 char* utf8 = new char[length];
309 WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8, length, 0, 0);
316 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
318 return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
322 maybe_open_console ()
324 if (Config::instance()->win32_console ()) {
327 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
328 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
329 FILE* hf_out = _fdopen(hCrt, "w");
330 setvbuf(hf_out, NULL, _IONBF, 1);
333 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
334 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
335 FILE* hf_in = _fdopen(hCrt, "r");
336 setvbuf(hf_in, NULL, _IONBF, 128);
341 boost::filesystem::path
344 return boost::filesystem::path(getenv("HOMEDRIVE")) / boost::filesystem::path(getenv("HOMEPATH"));
347 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
352 IsWow64Process (GetCurrentProcess(), &p);
356 static optional<string>
357 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
359 wchar_t buffer[MAX_PATH];
360 ZeroMemory (&buffer, sizeof(buffer));
361 bool r = SetupDiGetDeviceRegistryPropertyW (
362 device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
365 return optional<string>();
367 return wchar_to_utf8 (buffer);
370 static const GUID GUID_DEVICE_INTERFACE_DISK = {
371 0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
375 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
377 /* Find the Windows path to the device */
379 SP_DEVICE_INTERFACE_DATA device_interface_data;
380 device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
382 BOOL r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
384 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
385 return optional<int>();
388 /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
390 r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
391 PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
392 if (!device_detail_data) {
393 LOG_DISK_NC("malloc failed");
394 return optional<int>();
397 device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
399 /* And get the path */
400 r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
402 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
403 free (device_detail_data);
404 return optional<int>();
407 /* Open it. We would not be allowed GENERIC_READ access here but specifying 0 for
408 dwDesiredAccess allows us to query some metadata.
410 HANDLE device = CreateFileW (
411 device_detail_data->DevicePath, 0,
412 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
416 free (device_detail_data);
418 if (device == INVALID_HANDLE_VALUE) {
419 LOG_DISK("CreateFileW failed with %1", GetLastError());
420 return optional<int>();
423 /* Get the device number */
424 STORAGE_DEVICE_NUMBER device_number;
425 r = DeviceIoControl (
426 device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
427 &device_number, sizeof(device_number), &size, 0
430 CloseHandle (device);
433 return optional<int>();
436 return device_number.DeviceNumber;
439 typedef map<int, vector<boost::filesystem::path> > MountPoints;
441 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
445 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
447 LOG_DISK("Looking at %1", wchar_to_utf8(volume));
449 wchar_t volume_path_names[512];
450 vector<boost::filesystem::path> mp;
452 if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
453 wchar_t* p = volume_path_names;
454 while (*p != L'\0') {
455 mp.push_back (wchar_to_utf8(p));
456 LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
461 /* Strip trailing \ */
462 size_t const len = wcslen (volume);
463 DCPOMATIC_ASSERT (len > 0);
464 volume[len - 1] = L'\0';
466 HANDLE handle = CreateFileW (
468 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
472 DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
474 VOLUME_DISK_EXTENTS extents;
476 BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
477 CloseHandle (handle);
481 DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
483 mount_points[extents.Extents[0].DiskNumber] = mp;
489 MountPoints mount_points;
491 wchar_t volume_name[512];
492 HANDLE volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
493 if (volume == INVALID_HANDLE_VALUE) {
494 return MountPoints();
497 add_volume_mount_points (volume_name, mount_points);
499 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
502 add_volume_mount_points (volume_name, mount_points);
504 FindVolumeClose (volume);
512 vector<Drive> drives;
514 MountPoints mount_points = find_mount_points ();
516 /* Get a `device information set' containing information about all disks */
517 HDEVINFO device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
518 if (device_info == INVALID_HANDLE_VALUE) {
519 LOG_DISK_NC ("SetupDiClassDevsA failed");
525 /* Find out about the next disk */
526 SP_DEVINFO_DATA device_info_data;
527 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
528 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
529 DWORD e = GetLastError();
530 if (e != ERROR_NO_MORE_ITEMS) {
531 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
537 optional<string> const friendly_name = get_friendly_name (device_info, &device_info_data);
538 optional<int> device_number = get_device_number (device_info, &device_info_data);
539 if (!device_number) {
543 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
545 HANDLE device = CreateFileA (
546 physical_drive.c_str(), 0,
547 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
551 if (device == INVALID_HANDLE_VALUE) {
552 LOG_DISK_NC("Could not open PHYSICALDRIVE");
558 BOOL r = DeviceIoControl (
559 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
560 &geom, sizeof(geom), &returned, 0
563 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
565 for (vector<pair<HANDLE, string> >::const_iterator i = locked_volumes.begin(); i != locked_volumes.end(); ++i) {
566 if (i->second == physical_drive) {
572 uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
573 drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
574 LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
577 CloseHandle (device);
587 LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
588 DCPOMATIC_ASSERT (_mount_points.size() == 1);
589 string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
590 string const truncated = device_name.substr (0, device_name.length() - 1);
591 //LOG_DISK("Actually opening %1", _device);
592 //HANDLE device = CreateFileA (_device.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
593 LOG_DISK("Actually opening %1", truncated);
594 HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
595 if (device == INVALID_HANDLE_VALUE) {
596 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
600 BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
602 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
606 LOG_DISK("Unmount of %1 succeeded", _device);
607 locked_volumes.push_back (make_pair(device, _device));
613 boost::filesystem::path
616 boost::filesystem::path p;
617 p /= g_get_user_config_dir ();
623 disk_write_finished ()
625 for (vector<pair<HANDLE, string> >::const_iterator i = locked_volumes.begin(); i != locked_volumes.end(); ++i) {
626 CloseHandle (i->first);
632 dcpomatic::get_process_id ()
634 return dcp::raw_convert<string>(GetCurrentProcessId());