src/lib/cross.h

   1 /*
   2     Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file  src/lib/cross.h
  22  *  @brief Cross-platform compatibility code.
  23  */
  24
  25 #ifndef DCPOMATIC_CROSS_H
  26 #define DCPOMATIC_CROSS_H
  27
  28 #ifdef DCPOMATIC_OSX
  29 #include <IOKit/pwr_mgt/IOPMLib.h>
  30 #endif
  31 #include <boost/filesystem.hpp>
  32 #include <boost/thread/mutex.hpp>
  33 #include <boost/optional.hpp>
  34
  35 #ifdef DCPOMATIC_WINDOWS
  36 #define WEXITSTATUS(w) (w)
  37 #endif
  38
  39 class Log;
  40 struct AVIOContext;
  41
  42 extern void dcpomatic_sleep_seconds (int);
  43 extern void dcpomatic_sleep_milliseconds (int);
  44 extern std::string cpu_info ();
  45 extern void run_ffprobe (boost::filesystem::path, boost::filesystem::path);
  46 extern std::list<std::pair<std::string, std::string> > mount_info ();
  47 extern boost::filesystem::path openssl_path ();
  48 extern void make_foreground_application ();
  49 #ifdef DCPOMATIC_DISK
  50 extern boost::filesystem::path disk_writer_path ();
  51 #endif
  52 #ifdef DCPOMATIC_WINDOWS
  53 extern void maybe_open_console ();
  54 #endif
  55 extern boost::filesystem::path resources_path ();
  56 extern boost::filesystem::path xsd_path ();
  57 extern boost::filesystem::path tags_path ();
  58 extern FILE * fopen_boost (boost::filesystem::path, std::string);
  59 extern int dcpomatic_fseek (FILE *, int64_t, int);
  60 extern void start_batch_converter ();
  61 extern void start_player ();
  62 extern uint64_t thread_id ();
  63 extern int avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags);
  64 extern boost::filesystem::path home_directory ();
  65 extern bool running_32_on_64 ();
  66 extern void unprivileged ();
  67 extern boost::filesystem::path config_path (boost::optional<std::string> version);
  68 extern boost::filesystem::path directory_containing_executable ();
  69 extern boost::filesystem::path fix_long_path (boost::filesystem::path path);
  70 extern bool show_in_file_manager (boost::filesystem::path dir, boost::filesystem::path select);
  71 namespace dcpomatic {
  72         std::string get_process_id ();
  73 }
  74
  75
  76 /** @class Waker
  77  *  @brief A class which tries to keep the computer awake on various operating systems.
  78  *
  79  *  Create a Waker to prevent sleep, and call nudge() every so often (every minute or so).
  80  *  Destroy the Waker to allow sleep again.
  81  */
  82 class Waker
  83 {
  84 public:
  85         Waker ();
  86         ~Waker ();
  87
  88         void nudge ();
  89
  90 private:
  91         boost::mutex _mutex;
  92 #ifdef DCPOMATIC_OSX
  93         IOPMAssertionID _assertion_id;
  94 #endif
  95 };
  96
  97 class Drive
  98 {
  99 public:
 100         Drive (std::string device, std::vector<boost::filesystem::path> mount_points, uint64_t size, boost::optional<std::string> vendor, boost::optional<std::string> model)
 101                 : _device(device)
 102                 , _mount_points(mount_points)
 103                 , _size(size)
 104                 , _vendor(vendor)
 105                 , _model(model)
 106         {}
 107
 108         explicit Drive (std::string);
 109
 110         std::string as_xml () const;
 111
 112         std::string description () const;
 113
 114         std::string device () const {
 115                 return _device;
 116         }
 117
 118         bool mounted () const {
 119                 return !_mount_points.empty();
 120         }
 121
 122         std::string log_summary () const;
 123
 124         /** Unmount any mounted partitions on a drive.
 125          *  @return true on success, false on failure.
 126          */
 127         bool unmount ();
 128
 129         static std::vector<Drive> get ();
 130
 131 private:
 132         std::string _device;
 133         std::vector<boost::filesystem::path> _mount_points;
 134         /** size in bytes */
 135         uint64_t _size;
 136         boost::optional<std::string> _vendor;
 137         boost::optional<std::string> _model;
 138 };
 139
 140 void disk_write_finished ();
 141
 142
 143 struct OSXMediaPath
 144 {
 145         bool real;       ///< true for a "real" disk, false for a synthesized APFS one
 146         std::string prt; ///< "PRT" entry from the media path
 147 };
 148
 149
 150
 151 struct OSXDisk
 152 {
 153         std::string mount_point;
 154         boost::optional<std::string> vendor;
 155         boost::optional<std::string> model;
 156         bool real;
 157         std::string prt;
 158         bool whole;
 159         std::vector<boost::filesystem::path> mount_points;
 160         unsigned long size;
 161 };
 162
 163
 164 boost::optional<OSXMediaPath> analyse_osx_media_path (std::string path);
 165 std::vector<Drive> osx_disks_to_drives (std::vector<OSXDisk> disks);
 166
 167
 168 #endif