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 <dcp/raw_convert.h>
30 #include <libavformat/avio.h>
32 #include <boost/algorithm/string.hpp>
33 #include <boost/foreach.hpp>
34 #include <boost/regex.hpp>
35 #include <sys/sysctl.h>
36 #include <mach-o/dyld.h>
37 #include <IOKit/pwr_mgt/IOPMLib.h>
38 #include <IOKit/storage/IOMedia.h>
39 #include <DiskArbitration/DADisk.h>
40 #include <DiskArbitration/DiskArbitration.h>
41 #include <CoreFoundation/CFURL.h>
42 #include <sys/types.h>
44 #include <netinet/in.h>
45 #include <arpa/inet.h>
60 using std::runtime_error;
62 using boost::shared_ptr;
63 using boost::optional;
64 using boost::function;
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 size_t N = sizeof (buffer);
87 if (sysctlbyname ("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
94 /** @return Path of the Contents directory in the .app */
95 boost::filesystem::path
98 /* Could use boost::dll::program_location().parent_path().parent_path() but that
99 * boost library isn't in the 10.6 environment we're currently using and I don't
100 * really want to change it right now.
102 uint32_t size = 1024;
104 if (_NSGetExecutablePath (buffer, &size)) {
105 throw runtime_error ("_NSGetExecutablePath failed");
108 boost::filesystem::path path (buffer);
109 path = boost::filesystem::canonical (path);
110 path = path.parent_path ();
111 path = path.parent_path ();
115 boost::filesystem::path
118 return app_contents() / "Resources";
122 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
124 boost::filesystem::path path = app_contents();
128 string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
129 LOG_GENERAL (N_("Probing with %1"), ffprobe);
130 system (ffprobe.c_str ());
133 list<pair<string, string> >
136 list<pair<string, string> > m;
140 boost::filesystem::path
143 boost::filesystem::path path = app_contents();
149 #ifdef DCPOMATIC_DISK
150 /* Note: this isn't actually used at the moment as the disk writer is started as a service */
151 boost::filesystem::path
154 boost::filesystem::path path = app_contents();
156 path /= "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 /* We should use this */
187 // IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
188 /* but it's not available on 10.5, so we use this */
189 IOPMAssertionCreate (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, &_assertion_id);
194 boost::mutex::scoped_lock lm (_mutex);
195 IOPMAssertionRelease (_assertion_id);
199 start_tool (boost::filesystem::path dcpomatic, string executable, string app)
201 boost::filesystem::path batch = dcpomatic.parent_path ();
202 batch = batch.parent_path (); // MacOS
203 batch = batch.parent_path (); // Contents
204 batch = batch.parent_path (); // DCP-o-matic.app
205 batch = batch.parent_path (); // Applications
213 int const r = system (batch.string().c_str());
214 exit (WEXITSTATUS (r));
219 start_batch_converter (boost::filesystem::path dcpomatic)
221 start_tool (dcpomatic, "dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
225 start_player (boost::filesystem::path dcpomatic)
227 start_tool (dcpomatic, "dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
233 return (uint64_t) pthread_self ();
237 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
239 return avio_open (s, file.c_str(), flags);
242 boost::filesystem::path
245 return getenv("HOME");
249 command_and_read (string cmd)
254 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
258 /* I'm assuming nobody does this on OS X */
262 static optional<string>
263 get_vendor (CFDictionaryRef& description)
265 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceVendorKey);
267 return optional<string>();
270 string s = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
271 boost::algorithm::trim (s);
275 static optional<string>
276 get_model (CFDictionaryRef& description)
278 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceModelKey);
280 return optional<string>();
283 string s = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
284 boost::algorithm::trim (s);
290 bool real; ///< true for a "real" disk, false for a synthesized APFS one
291 std::string prt; ///< "PRT" entry from the media path
294 static optional<MediaPath>
295 analyse_media_path (CFDictionaryRef& description)
297 using namespace boost::algorithm;
299 void const* str = CFDictionaryGetValue (description, kDADiskDescriptionMediaPathKey);
301 return optional<MediaPath>();
304 string path(CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8));
306 if (starts_with(path, "IODeviceTree:")) {
308 } else if (starts_with(path, "IOService:")) {
311 return optional<MediaPath>();
315 split(bits, path, boost::is_any_of("/"));
316 BOOST_FOREACH (string i, bits) {
317 if (starts_with(i, "PRT")) {
326 is_whole_drive (DADiskRef& disk)
328 io_service_t service = DADiskCopyIOMedia (disk);
329 CFTypeRef whole_media_ref = IORegistryEntryCreateCFProperty (service, CFSTR(kIOMediaWholeKey), kCFAllocatorDefault, 0);
330 bool whole_media = false;
331 if (whole_media_ref) {
332 whole_media = CFBooleanGetValue((CFBooleanRef) whole_media_ref);
333 CFRelease (whole_media_ref);
335 IOObjectRelease (service);
339 static optional<boost::filesystem::path>
340 mount_point (CFDictionaryRef& description)
342 CFURLRef volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
343 char mount_path_buffer[1024];
344 if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
345 return boost::optional<boost::filesystem::path>();
347 return boost::filesystem::path(mount_path_buffer);
350 /* Here follows some rather intricate and (probably) fragile code to find the list of available
351 * "real" drives on macOS that we might want to write a DCP to.
353 * We use the Disk Arbitration framework to give us a series of mount_points (/dev/disk0, /dev/disk1,
354 * /dev/disk1s1 and so on) and we use the API to gather useful information about these mount_points into
355 * a vector of Disk structs.
357 * Then we read the Disks that we found and try to derive a list of drives that we should offer to the
358 * user, with details of whether those drives are currently mounted or not.
360 * At the basic level we find the "disk"-level mount_points, looking at whether any of their partitions are mounted.
362 * This is complicated enormously by recent-ish macOS versions' habit of making `synthesized' volumes which
363 * reflect data in `real' partitions. So, for example, we might have a real (physical) drive /dev/disk2 with
364 * a partition /dev/disk2s2 whose content is made into a synthesized /dev/disk3, itself containing some partitions
365 * which are mounted. /dev/disk2s2 is not considered to be mounted, in this case. So we need to know that
366 * disk2s2 is related to disk3 so we can consider disk2s2 as mounted if any parts of disk3 are. In order to do
367 * this I am picking out what looks like a suitable identifier prefixed with PRT from the MediaContentKey.
368 * If disk2s2 and disk3 have the same PRT code I am assuming they are linked.
370 * Lots of this is guesswork and may be broken. In my defence the documentation that I have been able to
371 * unearth is, to put it impolitely, crap.
377 optional<string> vendor;
378 optional<string> model;
382 vector<boost::filesystem::path> mount_points;
387 disk_appeared (DADiskRef disk, void* context)
389 const char* bsd_name = DADiskGetBSDName (disk);
393 LOG_DISK("%1 appeared", bsd_name);
397 this_disk.mount_point = string("/dev/") + bsd_name;
399 CFDictionaryRef description = DADiskCopyDescription (disk);
401 this_disk.vendor = get_vendor (description);
402 this_disk.model = get_model (description);
403 LOG_DISK("Vendor/model: %1 %2", this_disk.vendor.get_value_or("[none]"), this_disk.model.get_value_or("[none]"));
405 optional<MediaPath> media_path = analyse_media_path (description);
407 LOG_DISK("Finding media path for %1 failed", bsd_name);
411 this_disk.real = media_path->real;
412 this_disk.prt = media_path->prt;
413 this_disk.whole = is_whole_drive (disk);
414 optional<boost::filesystem::path> mp = mount_point (description);
416 this_disk.mount_points.push_back (*mp);
420 "%1 prt %2 whole %3 mounted %4",
421 this_disk.real ? "Real" : "Synth",
423 this_disk.whole ? "whole" : "part",
424 mp ? ("mounted at " + mp->string()) : "unmounted"
427 CFNumberGetValue ((CFNumberRef) CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey), kCFNumberLongType, &this_disk.size);
428 CFRelease (description);
430 reinterpret_cast<vector<Disk>*>(context)->push_back(this_disk);
436 using namespace boost::algorithm;
439 DASessionRef session = DASessionCreate(kCFAllocatorDefault);
441 return vector<Drive>();
444 DARegisterDiskAppearedCallback (session, NULL, disk_appeared, &disks);
445 CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
446 DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
447 CFRunLoopStop (run_loop);
448 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.05, 0);
449 DAUnregisterCallback(session, (void *) disk_appeared, &disks);
452 /* Mark disks containing mounted partitions as themselves mounted */
453 BOOST_FOREACH (Disk& i, disks) {
457 BOOST_FOREACH (Disk& j, disks) {
458 if (!j.mount_points.empty() && starts_with(j.mount_point, i.mount_point)) {
459 LOG_DISK("Marking %1 as mounted because %2 is", i.mount_point, j.mount_point);
460 std::copy(j.mount_points.begin(), j.mount_points.end(), back_inserter(i.mount_points));
465 /* Make a map of the PRT codes and mount points of mounted, synthesized disks */
466 map<string, vector<boost::filesystem::path> > mounted_synths;
467 BOOST_FOREACH (Disk& i, disks) {
468 if (!i.real && !i.mount_points.empty()) {
469 LOG_DISK("Found a mounted synth %1 with %2", i.mount_point, i.prt);
470 mounted_synths[i.prt] = i.mount_points;
474 /* Mark containers of those mounted synths as themselves mounted */
475 BOOST_FOREACH (Disk& i, disks) {
477 map<string, vector<boost::filesystem::path> >::const_iterator j = mounted_synths.find(i.prt);
478 if (j != mounted_synths.end()) {
479 LOG_DISK("Marking %1 (%2) as mounted because it contains a mounted synth", i.mount_point, i.prt);
480 std::copy(j->second.begin(), j->second.end(), back_inserter(i.mount_points));
485 vector<Drive> drives;
486 BOOST_FOREACH (Disk& i, disks) {
488 /* A whole disk that is not a container for a mounted synth */
489 drives.push_back(Drive(i.mount_point, i.mount_points, i.size, i.vendor, i.model));
490 LOG_DISK_NC(drives.back().log_summary());
496 boost::filesystem::path
499 boost::filesystem::path p;
500 p /= g_get_home_dir ();
503 p /= "com.dcpomatic";
509 void done_callback(DADiskRef disk, DADissenterRef dissenter, void* context)
511 LOG_DISK_NC("Unmount finished");
512 bool* success = reinterpret_cast<bool*> (context);
514 LOG_DISK("Error: %1", DADissenterGetStatus(dissenter));
517 LOG_DISK_NC("Successful");
526 LOG_DISK_NC("Unmount operation started");
528 DASessionRef session = DASessionCreate(kCFAllocatorDefault);
533 DADiskRef disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
537 LOG_DISK("Requesting unmount of %1 from %2", _device, thread_id());
538 bool success = false;
539 DADiskUnmount(disk, kDADiskUnmountOptionWhole, &done_callback, &success);
542 CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
543 DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
544 CFRunLoopStop (run_loop);
545 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.5, 0);
548 LOG_DISK_NC("End of unmount");
554 disk_write_finished ()