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"
28 #include <dcp/raw_convert.h>
31 #include <libavformat/avio.h>
33 #include <boost/algorithm/string.hpp>
34 #include <boost/regex.hpp>
35 #if BOOST_VERSION >= 106100
36 #include <boost/dll/runtime_symbol_info.hpp>
38 #include <ApplicationServices/ApplicationServices.h>
39 #include <sys/sysctl.h>
40 #include <mach-o/dyld.h>
41 #include <IOKit/pwr_mgt/IOPMLib.h>
42 #include <IOKit/storage/IOMedia.h>
43 #include <DiskArbitration/DADisk.h>
44 #include <DiskArbitration/DiskArbitration.h>
45 #include <CoreFoundation/CFURL.h>
46 #include <sys/types.h>
48 #include <netinet/in.h>
49 #include <arpa/inet.h>
64 using std::runtime_error;
66 using std::shared_ptr;
67 using boost::optional;
68 using boost::function;
70 /** @param s Number of seconds to sleep for */
72 dcpomatic_sleep_seconds (int s)
78 dcpomatic_sleep_milliseconds (int ms)
83 /** @return A string of CPU information (model name etc.) */
90 size_t N = sizeof (buffer);
91 if (sysctlbyname ("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
99 boost::filesystem::path
100 directory_containing_executable ()
102 return boost::dll::program_location().parent_path();
106 boost::filesystem::path
109 return directory_containing_executable().parent_path() / "Resources";
113 boost::filesystem::path
116 return resources_path() / "xsd";
120 boost::filesystem::path
123 return resources_path() / "tags";
128 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
130 boost::filesystem::path path = directory_containing_executable () / "ffprobe";
132 string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
133 LOG_GENERAL (N_("Probing with %1"), ffprobe);
134 system (ffprobe.c_str ());
138 list<pair<string, string> >
141 list<pair<string, string> > m;
145 boost::filesystem::path
148 return directory_containing_executable() / "openssl";
152 #ifdef DCPOMATIC_DISK
153 /* Note: this isn't actually used at the moment as the disk writer is started as a service */
154 boost::filesystem::path
157 return directory_containing_executable() / "dcpomatic2_disk_writer";
161 /* Apparently there is no way to create an ofstream using a UTF-8
162 filename under Windows. We are hence reduced to using fopen
166 fopen_boost (boost::filesystem::path p, string t)
168 return fopen (p.c_str(), t.c_str ());
172 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
174 return fseek (stream, offset, whence);
185 boost::mutex::scoped_lock lm (_mutex);
186 IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
191 boost::mutex::scoped_lock lm (_mutex);
192 IOPMAssertionRelease (_assertion_id);
196 start_tool (string executable, string app)
198 boost::filesystem::path exe_path = directory_containing_executable();
199 exe_path = exe_path.parent_path (); // Contents
200 exe_path = exe_path.parent_path (); // DCP-o-matic 2.app
201 exe_path = exe_path.parent_path (); // Applications
203 exe_path /= "Contents";
205 exe_path /= executable;
209 LOG_GENERAL ("start_tool %1 %2 with path %3", executable, app, exe_path.string());
210 int const r = system (exe_path.string().c_str());
211 exit (WEXITSTATUS (r));
212 } else if (pid == -1) {
213 LOG_ERROR_NC("Fork failed in start_tool");
219 start_batch_converter ()
221 start_tool ("dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
228 start_tool ("dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
235 return (uint64_t) pthread_self ();
239 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
241 return avio_open (s, file.c_str(), flags);
244 boost::filesystem::path
247 return getenv("HOME");
250 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
254 /* I'm assuming nobody does this on OS X */
258 static optional<string>
259 get_vendor (CFDictionaryRef& description)
261 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceVendorKey);
266 auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
272 boost::algorithm::trim (s);
276 static optional<string>
277 get_model (CFDictionaryRef& description)
279 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceModelKey);
284 auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
290 boost::algorithm::trim (s);
296 bool real; ///< true for a "real" disk, false for a synthesized APFS one
297 std::string prt; ///< "PRT" entry from the media path
300 static optional<MediaPath>
301 analyse_media_path (CFDictionaryRef& description)
303 using namespace boost::algorithm;
305 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionMediaPathKey);
307 LOG_DISK_NC("There is no MediaPathKey (no dictionary value)");
311 auto path_key_cstr = CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8);
312 if (!path_key_cstr) {
313 LOG_DISK_NC("There is no MediaPathKey (no cstring)");
317 string path(path_key_cstr);
318 LOG_DISK("MediaPathKey is %1", path);
320 if (path.find("/IOHDIXController") != string::npos) {
321 /* This is a disk image, so we completely ignore it */
322 LOG_DISK_NC("Ignoring this as it seems to be a disk image");
327 if (starts_with(path, "IODeviceTree:")) {
329 } else if (starts_with(path, "IOService:")) {
336 split(bits, path, boost::is_any_of("/"));
338 if (starts_with(i, "PRT")) {
347 is_whole_drive (DADiskRef& disk)
349 io_service_t service = DADiskCopyIOMedia (disk);
350 CFTypeRef whole_media_ref = IORegistryEntryCreateCFProperty (service, CFSTR(kIOMediaWholeKey), kCFAllocatorDefault, 0);
351 bool whole_media = false;
352 if (whole_media_ref) {
353 whole_media = CFBooleanGetValue((CFBooleanRef) whole_media_ref);
354 CFRelease (whole_media_ref);
356 IOObjectRelease (service);
360 static optional<boost::filesystem::path>
361 mount_point (CFDictionaryRef& description)
363 auto volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
364 if (!volume_path_key) {
368 char mount_path_buffer[1024];
369 if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
372 return boost::filesystem::path(mount_path_buffer);
375 /* Here follows some rather intricate and (probably) fragile code to find the list of available
376 * "real" drives on macOS that we might want to write a DCP to.
378 * We use the Disk Arbitration framework to give us a series of mount_points (/dev/disk0, /dev/disk1,
379 * /dev/disk1s1 and so on) and we use the API to gather useful information about these mount_points into
380 * a vector of Disk structs.
382 * Then we read the Disks that we found and try to derive a list of drives that we should offer to the
383 * user, with details of whether those drives are currently mounted or not.
385 * At the basic level we find the "disk"-level mount_points, looking at whether any of their partitions are mounted.
387 * This is complicated enormously by recent-ish macOS versions' habit of making `synthesized' volumes which
388 * reflect data in `real' partitions. So, for example, we might have a real (physical) drive /dev/disk2 with
389 * a partition /dev/disk2s2 whose content is made into a synthesized /dev/disk3, itself containing some partitions
390 * which are mounted. /dev/disk2s2 is not considered to be mounted, in this case. So we need to know that
391 * disk2s2 is related to disk3 so we can consider disk2s2 as mounted if any parts of disk3 are. In order to do
392 * this I am picking out what looks like a suitable identifier prefixed with PRT from the MediaContentKey.
393 * If disk2s2 and disk3 have the same PRT code I am assuming they are linked.
395 * Lots of this is guesswork and may be broken. In my defence the documentation that I have been able to
396 * unearth is, to put it impolitely, crap.
402 optional<string> vendor;
403 optional<string> model;
407 vector<boost::filesystem::path> mount_points;
412 disk_appeared (DADiskRef disk, void* context)
414 auto bsd_name = DADiskGetBSDName (disk);
416 LOG_DISK_NC("Disk with no BSDName appeared");
419 LOG_DISK("%1 appeared", bsd_name);
423 this_disk.mount_point = string("/dev/") + bsd_name;
424 LOG_DISK("Mount point is %1", this_disk.mount_point);
426 CFDictionaryRef description = DADiskCopyDescription (disk);
428 this_disk.vendor = get_vendor (description);
429 this_disk.model = get_model (description);
430 LOG_DISK("Vendor/model: %1 %2", this_disk.vendor.get_value_or("[none]"), this_disk.model.get_value_or("[none]"));
432 auto media_path = analyse_media_path (description);
434 LOG_DISK("Finding media path for %1 failed", bsd_name);
438 this_disk.real = media_path->real;
439 this_disk.prt = media_path->prt;
440 this_disk.whole = is_whole_drive (disk);
441 auto mp = mount_point (description);
443 this_disk.mount_points.push_back (*mp);
447 "%1 prt %2 whole %3 mounted %4",
448 this_disk.real ? "Real" : "Synth",
450 this_disk.whole ? "whole" : "part",
451 mp ? ("mounted at " + mp->string()) : "unmounted"
454 auto media_size_cstr = CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey);
455 if (!media_size_cstr) {
456 LOG_DISK_NC("Could not read media size");
460 CFNumberGetValue ((CFNumberRef) media_size_cstr, kCFNumberLongType, &this_disk.size);
461 CFRelease (description);
463 reinterpret_cast<vector<Disk>*>(context)->push_back(this_disk);
469 using namespace boost::algorithm;
472 DASessionRef session = DASessionCreate(kCFAllocatorDefault);
477 DARegisterDiskAppearedCallback (session, NULL, disk_appeared, &disks);
478 CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
479 DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
480 CFRunLoopStop (run_loop);
481 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.05, 0);
482 DAUnregisterCallback(session, (void *) disk_appeared, &disks);
485 /* Mark disks containing mounted partitions as themselves mounted */
486 for (auto& i: disks) {
490 for (auto& j: disks) {
491 if (!j.mount_points.empty() && starts_with(j.mount_point, i.mount_point)) {
492 LOG_DISK("Marking %1 as mounted because %2 is", i.mount_point, j.mount_point);
493 std::copy(j.mount_points.begin(), j.mount_points.end(), back_inserter(i.mount_points));
498 /* Make a map of the PRT codes and mount points of mounted, synthesized disks */
499 map<string, vector<boost::filesystem::path> > mounted_synths;
500 for (auto& i: disks) {
501 if (!i.real && !i.mount_points.empty()) {
502 LOG_DISK("Found a mounted synth %1 with %2", i.mount_point, i.prt);
503 mounted_synths[i.prt] = i.mount_points;
507 /* Mark containers of those mounted synths as themselves mounted */
508 for (auto& i: disks) {
510 auto j = mounted_synths.find(i.prt);
511 if (j != mounted_synths.end()) {
512 LOG_DISK("Marking %1 (%2) as mounted because it contains a mounted synth", i.mount_point, i.prt);
513 std::copy(j->second.begin(), j->second.end(), back_inserter(i.mount_points));
518 vector<Drive> drives;
519 for (auto& i: disks) {
521 /* A whole disk that is not a container for a mounted synth */
522 drives.push_back(Drive(i.mount_point, i.mount_points, i.size, i.vendor, i.model));
523 LOG_DISK_NC(drives.back().log_summary());
530 boost::filesystem::path
533 boost::filesystem::path p;
534 p /= g_get_home_dir ();
537 p /= "com.dcpomatic";
543 void done_callback(DADiskRef, DADissenterRef dissenter, void* context)
545 LOG_DISK_NC("Unmount finished");
546 bool* success = reinterpret_cast<bool*> (context);
548 LOG_DISK("Error: %1", DADissenterGetStatus(dissenter));
551 LOG_DISK_NC("Successful");
560 LOG_DISK_NC("Unmount operation started");
562 DASessionRef session = DASessionCreate(kCFAllocatorDefault);
567 DADiskRef disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
571 LOG_DISK("Requesting unmount of %1 from %2", _device, thread_id());
572 bool success = false;
573 DADiskUnmount(disk, kDADiskUnmountOptionWhole, &done_callback, &success);
576 CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
577 DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
578 CFRunLoopStop (run_loop);
579 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.5, 0);
582 LOG_DISK_NC("End of unmount");
588 disk_write_finished ()
595 make_foreground_application ()
597 ProcessSerialNumber serial;
598 DCPOMATIC_DISABLE_WARNINGS
599 GetCurrentProcess (&serial);
600 DCPOMATIC_ENABLE_WARNINGS
601 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
606 dcpomatic::get_process_id ()
608 return dcp::raw_convert<string>(getpid());