src/lib/util.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Copyright (C) 2000-2007 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file src/util.h
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #ifndef DCPOMATIC_UTIL_H
  26 #define DCPOMATIC_UTIL_H
  27
  28 #include <string>
  29 #include <vector>
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/asio.hpp>
  32 #include <boost/optional.hpp>
  33 #include <boost/filesystem.hpp>
  34 #include <libdcp/util.h>
  35 extern "C" {
  36 #include <libavcodec/avcodec.h>
  37 #include <libavfilter/avfilter.h>
  38 }
  39 #include "compose.hpp"
  40 #include "types.h"
  41 #include "video_content.h"
  42
  43 #ifdef DCPOMATIC_DEBUG
  44 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
  45 #else
  46 #define TIMING(...)
  47 #endif
  48
  49 #undef check
  50
  51 /** The maximum number of audio channels that we can cope with */
  52 #define MAX_AUDIO_CHANNELS 12
  53
  54 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
  55
  56 namespace libdcp {
  57         class Signer;
  58 }
  59
  60 class Job;
  61
  62 extern std::string seconds_to_hms (int);
  63 extern std::string seconds_to_approximate_hms (int);
  64 extern void stacktrace (std::ostream &, int);
  65 extern std::string dependency_version_summary ();
  66 extern double seconds (struct timeval);
  67 extern void dcpomatic_setup ();
  68 extern void dcpomatic_setup_gettext_i18n (std::string);
  69 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  70 extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shared_ptr<Job>);
  71 extern std::string md5_digest (void const *, int);
  72 extern void ensure_ui_thread ();
  73 extern std::string audio_channel_name (int);
  74 extern bool valid_image_file (boost::filesystem::path);
  75 #ifdef DCPOMATIC_WINDOWS
  76 extern boost::filesystem::path mo_path ();
  77 #endif
  78 extern std::string tidy_for_filename (std::string);
  79 extern boost::shared_ptr<const libdcp::Signer> make_signer ();
  80 extern libdcp::Size fit_ratio_within (float ratio, libdcp::Size);
  81 extern std::string entities_to_text (std::string e);
  82 extern std::map<std::string, std::string> split_get_request (std::string url);
  83
  84 struct FrameRateConversion
  85 {
  86         FrameRateConversion (float, int);
  87
  88         /** @return factor by which to multiply a source frame rate
  89             to get the effective rate after any skip or repeat has happened.
  90         */
  91         float factor () const {
  92                 if (skip) {
  93                         return 0.5;
  94                 }
  95
  96                 return repeat;
  97         }
  98
  99         /** true to skip every other frame */
 100         bool skip;
 101         /** number of times to use each frame (e.g. 1 is normal, 2 means repeat each frame once, and so on) */
 102         int repeat;
 103         /** true if this DCP will run its video faster or slower than the source
 104          *  without taking into account `repeat' nor `skip'.
 105          *  (e.g. change_speed will be true if
 106          *          source is 29.97fps, DCP is 30fps
 107          *          source is 14.50fps, DCP is 30fps
 108          *  but not if
 109          *          source is 15.00fps, DCP is 30fps
 110          *          source is 12.50fps, DCP is 25fps)
 111          */
 112         bool change_speed;
 113
 114         std::string description;
 115 };
 116
 117 extern int dcp_audio_frame_rate (int);
 118 extern int stride_round_up (int, int const *, int);
 119 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 120 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 121 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 122 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 123 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 124 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 125 extern void* wrapped_av_malloc (size_t);
 126 extern int64_t divide_with_round (int64_t a, int64_t b);
 127
 128 /** @class Socket
 129  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 130  *  that are useful for DCP-o-matic.
 131  *
 132  *  This class wraps some things that I could not work out how to do with boost;
 133  *  most notably, sync read/write calls with timeouts.
 134  */
 135 class Socket
 136 {
 137 public:
 138         Socket (int timeout = 30);
 139         ~Socket ();
 140
 141         /** @return Our underlying socket */
 142         boost::asio::ip::tcp::socket& socket () {
 143                 return _socket;
 144         }
 145
 146         void connect (boost::asio::ip::tcp::endpoint);
 147         void accept (int);
 148
 149         void write (uint32_t n);
 150         void write (uint8_t const * data, int size);
 151
 152         void read (uint8_t* data, int size);
 153         uint32_t read_uint32 ();
 154
 155 private:
 156         void check ();
 157
 158         Socket (Socket const &);
 159
 160         boost::asio::io_service _io_service;
 161         boost::asio::deadline_timer _deadline;
 162         boost::asio::ip::tcp::socket _socket;
 163         boost::asio::ip::tcp::acceptor* _acceptor;
 164         int _timeout;
 165 };
 166
 167 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
 168
 169 class LocaleGuard
 170 {
 171 public:
 172         LocaleGuard ();
 173         ~LocaleGuard ();
 174
 175 private:
 176         char* _old;
 177 };
 178
 179 class ScopedTemporary
 180 {
 181 public:
 182         ScopedTemporary ();
 183         ~ScopedTemporary ();
 184
 185         boost::filesystem::path file () const {
 186                 return _file;
 187         }
 188
 189         char const * c_str () const;
 190         FILE* open (char const *);
 191         void close ();
 192
 193 private:
 194         boost::filesystem::path _file;
 195         FILE* _open;
 196 };
 197
 198 #endif
 199