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 #include <boost/function.hpp>
  35
  36 #ifdef DCPOMATIC_WINDOWS
  37 #define WEXITSTATUS(w) (w)
  38 #endif
  39
  40 class Log;
  41 struct AVIOContext;
  42
  43 void dcpomatic_sleep_seconds (int);
  44 void dcpomatic_sleep_milliseconds (int);
  45 extern std::string cpu_info ();
  46 extern void run_ffprobe (boost::filesystem::path, boost::filesystem::path);
  47 extern std::list<std::pair<std::string, std::string> > mount_info ();
  48 extern boost::filesystem::path openssl_path ();
  49 #ifdef DCPOMATIC_DISK
  50 extern boost::filesystem::path disk_writer_path ();
  51 #endif
  52 #ifdef DCPOMATIC_OSX
  53 extern boost::filesystem::path app_contents ();
  54 #endif
  55 #ifdef DCPOMATIC_WINDOWS
  56 extern void maybe_open_console ();
  57 #endif
  58 extern boost::filesystem::path shared_path ();
  59 extern FILE * fopen_boost (boost::filesystem::path, std::string);
  60 extern int dcpomatic_fseek (FILE *, int64_t, int);
  61 extern void start_batch_converter (boost::filesystem::path dcpomatic);
  62 extern void start_player (boost::filesystem::path dcpomatic);
  63 extern uint64_t thread_id ();
  64 extern int avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags);
  65 extern boost::filesystem::path home_directory ();
  66 extern std::string command_and_read (std::string cmd);
  67 extern bool running_32_on_64 ();
  68 extern void unprivileged ();
  69 extern boost::filesystem::path config_path ();
  70
  71 class PrivilegeEscalator
  72 {
  73 public:
  74         PrivilegeEscalator ();
  75         ~PrivilegeEscalator ();
  76 };
  77
  78 /** @class Waker
  79  *  @brief A class which tries to keep the computer awake on various operating systems.
  80  *
  81  *  Create a Waker to prevent sleep, and call nudge() every so often (every minute or so).
  82  *  Destroy the Waker to allow sleep again.
  83  */
  84 class Waker
  85 {
  86 public:
  87         Waker ();
  88         ~Waker ();
  89
  90         void nudge ();
  91
  92 private:
  93         boost::mutex _mutex;
  94 #ifdef DCPOMATIC_OSX
  95         IOPMAssertionID _assertion_id;
  96 #endif
  97 };
  98
  99 class Drive
 100 {
 101 public:
 102         Drive (std::string device, std::vector<boost::filesystem::path> mount_points, uint64_t size, boost::optional<std::string> vendor, boost::optional<std::string> model)
 103                 : _device(device)
 104                 , _mount_points(mount_points)
 105                 , _size(size)
 106                 , _vendor(vendor)
 107                 , _model(model)
 108         {}
 109
 110         explicit Drive (std::string);
 111
 112         std::string as_xml () const;
 113
 114         std::string description () const;
 115
 116         std::string device () const {
 117                 return _device;
 118         }
 119
 120         bool mounted () const {
 121                 return !_mount_points.empty();
 122         }
 123
 124         std::string log_summary () const;
 125
 126         /** Unmount any mounted partitions on a drive.
 127          *  @return true on success, false on failure.
 128          */
 129         bool unmount ();
 130
 131         static std::vector<Drive> get ();
 132
 133 private:
 134         std::string _device;
 135         std::vector<boost::filesystem::path> _mount_points;
 136         /** size in bytes */
 137         uint64_t _size;
 138         boost::optional<std::string> _vendor;
 139         boost::optional<std::string> _model;
 140 };
 141
 142 void disk_write_finished ();
 143
 144 #endif