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 extern void dcpomatic_sleep_seconds (int);
  44 extern 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 extern void make_foreground_application ();
  50 #ifdef DCPOMATIC_DISK
  51 extern boost::filesystem::path disk_writer_path ();
  52 #endif
  53 #ifdef DCPOMATIC_WINDOWS
  54 extern void maybe_open_console ();
  55 #endif
  56 extern boost::filesystem::path resources_path ();
  57 extern boost::filesystem::path xsd_path ();
  58 extern boost::filesystem::path tags_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 ();
  62 extern void start_player ();
  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 bool running_32_on_64 ();
  67 extern void unprivileged ();
  68 extern boost::filesystem::path config_path ();
  69 extern boost::filesystem::path directory_containing_executable ();
  70 extern boost::filesystem::path fix_long_path (boost::filesystem::path path);
  71 namespace dcpomatic {
  72         std::string get_process_id ();
  73 }
  74
  75 class PrivilegeEscalator
  76 {
  77 public:
  78         PrivilegeEscalator ();
  79         ~PrivilegeEscalator ();
  80
  81         static bool test;
  82 };
  83
  84 /** @class Waker
  85  *  @brief A class which tries to keep the computer awake on various operating systems.
  86  *
  87  *  Create a Waker to prevent sleep, and call nudge() every so often (every minute or so).
  88  *  Destroy the Waker to allow sleep again.
  89  */
  90 class Waker
  91 {
  92 public:
  93         Waker ();
  94         ~Waker ();
  95
  96         void nudge ();
  97
  98 private:
  99         boost::mutex _mutex;
 100 #ifdef DCPOMATIC_OSX
 101         IOPMAssertionID _assertion_id;
 102 #endif
 103 };
 104
 105 class Drive
 106 {
 107 public:
 108         Drive (std::string device, std::vector<boost::filesystem::path> mount_points, uint64_t size, boost::optional<std::string> vendor, boost::optional<std::string> model)
 109                 : _device(device)
 110                 , _mount_points(mount_points)
 111                 , _size(size)
 112                 , _vendor(vendor)
 113                 , _model(model)
 114         {}
 115
 116         explicit Drive (std::string);
 117
 118         std::string as_xml () const;
 119
 120         std::string description () const;
 121
 122         std::string device () const {
 123                 return _device;
 124         }
 125
 126         bool mounted () const {
 127                 return !_mount_points.empty();
 128         }
 129
 130         std::string log_summary () const;
 131
 132         /** Unmount any mounted partitions on a drive.
 133          *  @return true on success, false on failure.
 134          */
 135         bool unmount ();
 136
 137         static std::vector<Drive> get ();
 138
 139 private:
 140         std::string _device;
 141         std::vector<boost::filesystem::path> _mount_points;
 142         /** size in bytes */
 143         uint64_t _size;
 144         boost::optional<std::string> _vendor;
 145         boost::optional<std::string> _model;
 146 };
 147
 148 void disk_write_finished ();
 149
 150 #endif