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"
29 #include <dcp/raw_convert.h>
32 #include <libavformat/avio.h>
34 #include <boost/algorithm/string.hpp>
35 #include <boost/regex.hpp>
36 #if BOOST_VERSION >= 106100
37 #include <boost/dll/runtime_symbol_info.hpp>
39 #include <ApplicationServices/ApplicationServices.h>
40 #include <sys/sysctl.h>
41 #include <mach-o/dyld.h>
42 #include <IOKit/pwr_mgt/IOPMLib.h>
43 #include <IOKit/storage/IOMedia.h>
44 #include <DiskArbitration/DADisk.h>
45 #include <DiskArbitration/DiskArbitration.h>
46 #include <CoreFoundation/CFURL.h>
47 #include <sys/types.h>
49 #include <netinet/in.h>
50 #include <arpa/inet.h>
66 using std::runtime_error;
68 using std::shared_ptr;
69 using boost::optional;
73 /** @param s Number of seconds to sleep for */
75 dcpomatic_sleep_seconds (int s)
82 dcpomatic_sleep_milliseconds (int ms)
88 /** @return A string of CPU information (model name etc.) */
95 size_t N = sizeof (buffer);
96 if (sysctlbyname("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
104 boost::filesystem::path
105 directory_containing_executable ()
107 return boost::dll::program_location().parent_path();
111 boost::filesystem::path
114 return directory_containing_executable().parent_path() / "Resources";
118 boost::filesystem::path
121 return resources_path() / "xsd";
125 boost::filesystem::path
128 return resources_path() / "tags";
133 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
135 auto path = directory_containing_executable () / "ffprobe";
137 string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
138 LOG_GENERAL (N_("Probing with %1"), ffprobe);
139 system (ffprobe.c_str ());
144 list<pair<string, string>>
151 boost::filesystem::path
154 return directory_containing_executable() / "openssl";
158 #ifdef DCPOMATIC_DISK
159 /* Note: this isn't actually used at the moment as the disk writer is started as a service */
160 boost::filesystem::path
163 return directory_containing_executable() / "dcpomatic2_disk_writer";
168 /* Apparently there is no way to create an ofstream using a UTF-8
169 filename under Windows. We are hence reduced to using fopen
173 fopen_boost (boost::filesystem::path p, string t)
175 return fopen (p.c_str(), t.c_str());
180 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
182 return fseek (stream, offset, whence);
195 boost::mutex::scoped_lock lm (_mutex);
196 IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
202 boost::mutex::scoped_lock lm (_mutex);
203 IOPMAssertionRelease (_assertion_id);
208 start_tool (string executable, string app)
210 auto exe_path = directory_containing_executable();
211 exe_path = exe_path.parent_path(); // Contents
212 exe_path = exe_path.parent_path(); // DCP-o-matic 2.app
213 exe_path = exe_path.parent_path(); // Applications
215 exe_path /= "Contents";
217 exe_path /= executable;
221 LOG_GENERAL ("start_tool %1 %2 with path %3", executable, app, exe_path.string());
222 int const r = system (exe_path.string().c_str());
223 exit (WEXITSTATUS (r));
224 } else if (pid == -1) {
225 LOG_ERROR_NC("Fork failed in start_tool");
231 start_batch_converter ()
233 start_tool ("dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
240 start_tool ("dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
247 return (uint64_t) pthread_self ();
252 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
254 return avio_open (s, file.c_str(), flags);
258 boost::filesystem::path
261 return getenv("HOME");
265 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
269 /* I'm assuming nobody does this on OS X */
274 static optional<string>
275 get_vendor (CFDictionaryRef& description)
277 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceVendorKey);
282 auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
288 boost::algorithm::trim (s);
293 static optional<string>
294 get_model (CFDictionaryRef& description)
296 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceModelKey);
301 auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
307 boost::algorithm::trim (s);
314 bool real; ///< true for a "real" disk, false for a synthesized APFS one
315 std::string prt; ///< "PRT" entry from the media path
319 static optional<MediaPath>
320 analyse_media_path (CFDictionaryRef& description)
322 using namespace boost::algorithm;
324 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionMediaPathKey);
326 LOG_DISK_NC("There is no MediaPathKey (no dictionary value)");
330 auto path_key_cstr = CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8);
331 if (!path_key_cstr) {
332 LOG_DISK_NC("There is no MediaPathKey (no cstring)");
336 string path(path_key_cstr);
337 LOG_DISK("MediaPathKey is %1", path);
339 if (path.find("/IOHDIXController") != string::npos) {
340 /* This is a disk image, so we completely ignore it */
341 LOG_DISK_NC("Ignoring this as it seems to be a disk image");
346 if (starts_with(path, "IODeviceTree:")) {
348 } else if (starts_with(path, "IOService:")) {
355 split(bits, path, boost::is_any_of("/"));
357 if (starts_with(i, "PRT")) {
367 is_whole_drive (DADiskRef& disk)
369 io_service_t service = DADiskCopyIOMedia (disk);
370 CFTypeRef whole_media_ref = IORegistryEntryCreateCFProperty (service, CFSTR(kIOMediaWholeKey), kCFAllocatorDefault, 0);
371 bool whole_media = false;
372 if (whole_media_ref) {
373 whole_media = CFBooleanGetValue((CFBooleanRef) whole_media_ref);
374 CFRelease (whole_media_ref);
376 IOObjectRelease (service);
381 static optional<boost::filesystem::path>
382 mount_point (CFDictionaryRef& description)
384 auto volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
385 if (!volume_path_key) {
389 char mount_path_buffer[1024];
390 if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
393 return boost::filesystem::path(mount_path_buffer);
397 /* Here follows some rather intricate and (probably) fragile code to find the list of available
398 * "real" drives on macOS that we might want to write a DCP to.
400 * We use the Disk Arbitration framework to give us a series of mount_points (/dev/disk0, /dev/disk1,
401 * /dev/disk1s1 and so on) and we use the API to gather useful information about these mount_points into
402 * a vector of Disk structs.
404 * Then we read the Disks that we found and try to derive a list of drives that we should offer to the
405 * user, with details of whether those drives are currently mounted or not.
407 * At the basic level we find the "disk"-level mount_points, looking at whether any of their partitions are mounted.
409 * This is complicated enormously by recent-ish macOS versions' habit of making `synthesized' volumes which
410 * reflect data in `real' partitions. So, for example, we might have a real (physical) drive /dev/disk2 with
411 * a partition /dev/disk2s2 whose content is made into a synthesized /dev/disk3, itself containing some partitions
412 * which are mounted. /dev/disk2s2 is not considered to be mounted, in this case. So we need to know that
413 * disk2s2 is related to disk3 so we can consider disk2s2 as mounted if any parts of disk3 are. In order to do
414 * this I am picking out what looks like a suitable identifier prefixed with PRT from the MediaContentKey.
415 * If disk2s2 and disk3 have the same PRT code I am assuming they are linked.
417 * Lots of this is guesswork and may be broken. In my defence the documentation that I have been able to
418 * unearth is, to put it impolitely, crap.
424 optional<string> vendor;
425 optional<string> model;
429 vector<boost::filesystem::path> mount_points;
435 disk_appeared (DADiskRef disk, void* context)
437 auto bsd_name = DADiskGetBSDName (disk);
439 LOG_DISK_NC("Disk with no BSDName appeared");
442 LOG_DISK("%1 appeared", bsd_name);
446 this_disk.mount_point = string("/dev/") + bsd_name;
447 LOG_DISK("Mount point is %1", this_disk.mount_point);
449 CFDictionaryRef description = DADiskCopyDescription (disk);
451 this_disk.vendor = get_vendor (description);
452 this_disk.model = get_model (description);
453 LOG_DISK("Vendor/model: %1 %2", this_disk.vendor.get_value_or("[none]"), this_disk.model.get_value_or("[none]"));
455 auto media_path = analyse_media_path (description);
457 LOG_DISK("Finding media path for %1 failed", bsd_name);
461 this_disk.real = media_path->real;
462 this_disk.prt = media_path->prt;
463 this_disk.whole = is_whole_drive (disk);
464 auto mp = mount_point (description);
466 this_disk.mount_points.push_back (*mp);
470 "%1 prt %2 whole %3 mounted %4",
471 this_disk.real ? "Real" : "Synth",
473 this_disk.whole ? "whole" : "part",
474 mp ? ("mounted at " + mp->string()) : "unmounted"
477 auto media_size_cstr = CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey);
478 if (!media_size_cstr) {
479 LOG_DISK_NC("Could not read media size");
483 CFNumberGetValue ((CFNumberRef) media_size_cstr, kCFNumberLongType, &this_disk.size);
484 CFRelease (description);
486 reinterpret_cast<vector<Disk>*>(context)->push_back(this_disk);
493 using namespace boost::algorithm;
496 auto session = DASessionCreate(kCFAllocatorDefault);
501 DARegisterDiskAppearedCallback (session, NULL, disk_appeared, &disks);
502 auto run_loop = CFRunLoopGetCurrent ();
503 DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
504 CFRunLoopStop (run_loop);
505 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.05, 0);
506 DAUnregisterCallback(session, (void *) disk_appeared, &disks);
509 /* Mark disks containing mounted partitions as themselves mounted */
510 for (auto& i: disks) {
514 for (auto& j: disks) {
515 if (!j.mount_points.empty() && starts_with(j.mount_point, i.mount_point)) {
516 LOG_DISK("Marking %1 as mounted because %2 is", i.mount_point, j.mount_point);
517 std::copy(j.mount_points.begin(), j.mount_points.end(), back_inserter(i.mount_points));
522 /* Make a map of the PRT codes and mount points of mounted, synthesized disks */
523 map<string, vector<boost::filesystem::path>> mounted_synths;
524 for (auto& i: disks) {
525 if (!i.real && !i.mount_points.empty()) {
526 LOG_DISK("Found a mounted synth %1 with %2", i.mount_point, i.prt);
527 mounted_synths[i.prt] = i.mount_points;
531 /* Mark containers of those mounted synths as themselves mounted */
532 for (auto& i: disks) {
534 auto j = mounted_synths.find(i.prt);
535 if (j != mounted_synths.end()) {
536 LOG_DISK("Marking %1 (%2) as mounted because it contains a mounted synth", i.mount_point, i.prt);
537 std::copy(j->second.begin(), j->second.end(), back_inserter(i.mount_points));
542 vector<Drive> drives;
543 for (auto& i: disks) {
545 /* A whole disk that is not a container for a mounted synth */
546 drives.push_back(Drive(i.mount_point, i.mount_points, i.size, i.vendor, i.model));
547 LOG_DISK_NC(drives.back().log_summary());
554 boost::filesystem::path
555 config_path (optional<string> version)
557 boost::filesystem::path p;
558 p /= g_get_home_dir ();
561 p /= "com.dcpomatic";
570 void done_callback(DADiskRef, DADissenterRef dissenter, void* context)
572 LOG_DISK_NC("Unmount finished");
573 bool* success = reinterpret_cast<bool*> (context);
575 LOG_DISK("Error: %1", DADissenterGetStatus(dissenter));
578 LOG_DISK_NC("Successful");
587 LOG_DISK_NC("Unmount operation started");
589 auto session = DASessionCreate(kCFAllocatorDefault);
594 auto disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
598 LOG_DISK("Requesting unmount of %1 from %2", _device, thread_id());
599 bool success = false;
600 DADiskUnmount(disk, kDADiskUnmountOptionWhole, &done_callback, &success);
603 CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
604 DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
605 CFRunLoopStop (run_loop);
606 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.5, 0);
609 LOG_DISK_NC("End of unmount");
615 disk_write_finished ()
622 make_foreground_application ()
624 ProcessSerialNumber serial;
625 DCPOMATIC_DISABLE_WARNINGS
626 GetCurrentProcess (&serial);
627 DCPOMATIC_ENABLE_WARNINGS
628 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
633 dcpomatic::get_process_id ()
635 return dcp::raw_convert<string>(getpid());
639 boost::filesystem::path
640 fix_long_path (boost::filesystem::path path)
647 show_in_file_manager (boost::filesystem::path, boost::filesystem::path select)
649 int r = system (String::compose("open -R \"%1\"", select.string()).c_str());
650 return static_cast<bool>(WEXITSTATUS(r));