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 6
  53
  54 namespace libdcp {
  55         class Signer;
  56 }
  57
  58 class Job;
  59
  60 extern std::string seconds_to_hms (int);
  61 extern std::string seconds_to_approximate_hms (int);
  62 extern void stacktrace (std::ostream &, int);
  63 extern std::string dependency_version_summary ();
  64 extern double seconds (struct timeval);
  65 extern void dcpomatic_setup ();
  66 extern void dcpomatic_setup_gettext_i18n (std::string);
  67 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  68 extern std::string md5_digest (boost::filesystem::path);
  69 extern std::string md5_digest_directory (boost::filesystem::path, boost::shared_ptr<Job>);
  70 extern std::string md5_digest (void const *, int);
  71 extern void ensure_ui_thread ();
  72 extern std::string audio_channel_name (int);
  73 extern bool valid_image_file (boost::filesystem::path);
  74 #ifdef DCPOMATIC_WINDOWS
  75 extern boost::filesystem::path mo_path ();
  76 #endif
  77 extern std::string tidy_for_filename (std::string);
  78 boost::shared_ptr<const libdcp::Signer> make_signer ();
  79
  80 struct FrameRateConversion
  81 {
  82         FrameRateConversion (float, int);
  83
  84         /** @return factor by which to multiply a source frame rate
  85             to get the effective rate after any skip or repeat has happened.
  86         */
  87         float factor () const {
  88                 if (skip) {
  89                         return 0.5;
  90                 } else if (repeat) {
  91                         return 2;
  92                 }
  93
  94                 return 1;
  95         }
  96
  97         /** true to skip every other frame */
  98         bool skip;
  99         /** true to repeat every frame once */
 100         bool repeat;
 101         /** true if this DCP will run its video faster or slower than the source
 102          *  without taking into account `repeat' nor `skip'.
 103          *  (e.g. change_speed will be true if
 104          *          source is 29.97fps, DCP is 30fps
 105          *          source is 14.50fps, DCP is 30fps
 106          *  but not if
 107          *          source is 15.00fps, DCP is 30fps
 108          *          source is 12.50fps, DCP is 25fps)
 109          */
 110         bool change_speed;
 111
 112         std::string description;
 113 };
 114
 115 extern int dcp_audio_frame_rate (int);
 116 extern int stride_round_up (int, int const *, int);
 117 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 118 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 119 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 120 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 121 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 122 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 123
 124 /** @class Socket
 125  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 126  *  that are useful for DCP-o-matic.
 127  *
 128  *  This class wraps some things that I could not work out how to do with boost;
 129  *  most notably, sync read/write calls with timeouts.
 130  */
 131 class Socket
 132 {
 133 public:
 134         Socket (int timeout = 30);
 135
 136         /** @return Our underlying socket */
 137         boost::asio::ip::tcp::socket& socket () {
 138                 return _socket;
 139         }
 140
 141         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
 142
 143         void write (uint32_t n);
 144         void write (uint8_t const * data, int size);
 145
 146         void read (uint8_t* data, int size);
 147         uint32_t read_uint32 ();
 148
 149 private:
 150         void check ();
 151
 152         Socket (Socket const &);
 153
 154         boost::asio::io_service _io_service;
 155         boost::asio::deadline_timer _deadline;
 156         boost::asio::ip::tcp::socket _socket;
 157         int _timeout;
 158 };
 159
 160 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
 161
 162 class LocaleGuard
 163 {
 164 public:
 165         LocaleGuard ();
 166         ~LocaleGuard ();
 167
 168 private:
 169         char* _old;
 170 };
 171
 172
 173 #endif
 174