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