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 #include <libdcp/signer.h>
  36 extern "C" {
  37 #include <libavcodec/avcodec.h>
  38 #include <libavfilter/avfilter.h>
  39 }
  40 #include "compose.hpp"
  41 #include "types.h"
  42 #include "video_content.h"
  43
  44 #ifdef DCPOMATIC_DEBUG
  45 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
  46 #else
  47 #define TIMING(...)
  48 #endif
  49
  50 #undef check
  51
  52 /** The maximum number of audio channels that we can cope with */
  53 #define MAX_AUDIO_CHANNELS 6
  54
  55 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
  56
  57 namespace libdcp {
  58         class Signer;
  59 }
  60
  61 class Job;
  62
  63 extern std::string seconds_to_hms (int);
  64 extern std::string seconds_to_approximate_hms (int);
  65 extern void stacktrace (std::ostream &, int);
  66 extern std::string dependency_version_summary ();
  67 extern double seconds (struct timeval);
  68 extern void dcpomatic_setup ();
  69 extern void dcpomatic_setup_gettext_i18n (std::string);
  70 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  71 extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shared_ptr<Job>);
  72 extern std::string md5_digest (void const *, int);
  73 extern void ensure_ui_thread ();
  74 extern std::string audio_channel_name (int);
  75 extern bool valid_image_file (boost::filesystem::path);
  76 #ifdef DCPOMATIC_WINDOWS
  77 extern boost::filesystem::path mo_path ();
  78 #endif
  79 extern std::string tidy_for_filename (std::string);
  80 extern boost::shared_ptr<const dcp::Signer> make_signer ();
  81 extern dcp::Size fit_ratio_within (float ratio, dcp::Size);
  82
  83 struct FrameRateChange
  84 {
  85         FrameRateChange (float, int);
  86
  87         /** @return factor by which to multiply a source frame rate
  88             to get the effective rate after any skip or repeat has happened.
  89         */
  90         float factor () const {
  91                 if (skip) {
  92                         return 0.5;
  93                 }
  94
  95                 return repeat;
  96         }
  97
  98         /** true to skip every other frame */
  99         bool skip;
 100         /** number of times to use each frame (e.g. 1 is normal, 2 means repeat each frame once, and so on) */
 101         int repeat;
 102         /** true if this DCP will run its video faster or slower than the source
 103          *  without taking into account `repeat' nor `skip'.
 104          *  (e.g. change_speed will be true if
 105          *          source is 29.97fps, DCP is 30fps
 106          *          source is 14.50fps, DCP is 30fps
 107          *  but not if
 108          *          source is 15.00fps, DCP is 30fps
 109          *          source is 12.50fps, DCP is 25fps)
 110          */
 111         bool change_speed;
 112
 113         /** Amount by which the video is being sped-up in the DCP; e.g. for a
 114          *  24fps source in a 25fps DCP this would be 25/24.
 115          */
 116         float speed_up;
 117
 118         std::string description;
 119 };
 120
 121 extern int dcp_audio_frame_rate (int);
 122 extern int stride_round_up (int, int const *, int);
 123 extern DCPTime time_round_up (DCPTime, DCPTime);
 124 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 125 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 126 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 127 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 128 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 129 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 130 extern void* wrapped_av_malloc (size_t);
 131
 132 /** @class Socket
 133  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 134  *  that are useful for DCP-o-matic.
 135  *
 136  *  This class wraps some things that I could not work out how to do with boost;
 137  *  most notably, sync read/write calls with timeouts.
 138  */
 139 class Socket
 140 {
 141 public:
 142         Socket (int timeout = 30);
 143         ~Socket ();
 144
 145         /** @return Our underlying socket */
 146         boost::asio::ip::tcp::socket& socket () {
 147                 return _socket;
 148         }
 149
 150         void connect (boost::asio::ip::tcp::endpoint);
 151         void accept (int);
 152
 153         void write (uint32_t n);
 154         void write (uint8_t const * data, int size);
 155
 156         void read (uint8_t* data, int size);
 157         uint32_t read_uint32 ();
 158
 159 private:
 160         void check ();
 161
 162         Socket (Socket const &);
 163
 164         boost::asio::io_service _io_service;
 165         boost::asio::deadline_timer _deadline;
 166         boost::asio::ip::tcp::socket _socket;
 167         boost::asio::ip::tcp::acceptor* _acceptor;
 168         int _timeout;
 169 };
 170
 171 extern int64_t video_frames_to_audio_frames (VideoFrame v, float audio_sample_rate, float frames_per_second);
 172
 173 class LocaleGuard
 174 {
 175 public:
 176         LocaleGuard ();
 177         ~LocaleGuard ();
 178
 179 private:
 180         char* _old;
 181 };
 182
 183
 184 #endif
 185