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 /** The maximum number of audio channels that we can cope with */
  49 #define MAX_AUDIO_CHANNELS 6
  50
  51 class Scaler;
  52
  53 extern std::string seconds_to_hms (int);
  54 extern std::string seconds_to_approximate_hms (int);
  55 extern void stacktrace (std::ostream &, int);
  56 extern std::string dependency_version_summary ();
  57 extern double seconds (struct timeval);
  58 extern void dcpomatic_setup ();
  59 extern void dcpomatic_setup_i18n (std::string);
  60 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  61 extern std::string md5_digest (boost::filesystem::path);
  62 extern std::string md5_digest (void const *, int);
  63 extern void ensure_ui_thread ();
  64 extern std::string audio_channel_name (int);
  65 #ifdef DCPOMATIC_WINDOWS
  66 extern boost::filesystem::path mo_path ();
  67 #endif
  68
  69 struct FrameRateConversion
  70 {
  71         FrameRateConversion (float, int);
  72
  73         /** @return factor by which to multiply a source frame rate
  74             to get the effective rate after any skip or repeat has happened.
  75         */
  76         float factor () const {
  77                 if (skip) {
  78                         return 0.5;
  79                 } else if (repeat) {
  80                         return 2;
  81                 }
  82
  83                 return 1;
  84         }
  85
  86         /** true to skip every other frame */
  87         bool skip;
  88         /** true to repeat every frame once */
  89         bool repeat;
  90         /** true if this DCP will run its video faster or slower than the source
  91          *  without taking into account `repeat' nor `skip'.
  92          *  (e.g. change_speed will be true if
  93          *          source is 29.97fps, DCP is 30fps
  94          *          source is 14.50fps, DCP is 30fps
  95          *  but not if
  96          *          source is 15.00fps, DCP is 30fps
  97          *          source is 12.50fps, DCP is 25fps)
  98          */
  99         bool change_speed;
 100
 101         std::string description;
 102 };
 103
 104 int best_dcp_frame_rate (float);
 105
 106 extern std::string crop_string (Position, libdcp::Size);
 107 extern int dcp_audio_sample_rate (int);
 108 extern std::string colour_lut_index_to_name (int index);
 109 extern int stride_round_up (int, int const *, int);
 110 extern int stride_lookup (int c, int const * stride);
 111 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 112 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 113 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 114 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 115 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 116 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 117
 118 /** @class Socket
 119  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 120  *  that are useful for DCP-o-matic.
 121  *
 122  *  This class wraps some things that I could not work out how to do with boost;
 123  *  most notably, sync read/write calls with timeouts.
 124  */
 125 class Socket
 126 {
 127 public:
 128         Socket (int timeout = 30);
 129
 130         /** @return Our underlying socket */
 131         boost::asio::ip::tcp::socket& socket () {
 132                 return _socket;
 133         }
 134
 135         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
 136
 137         void write (uint32_t n);
 138         void write (uint8_t const * data, int size);
 139
 140         void read (uint8_t* data, int size);
 141         uint32_t read_uint32 ();
 142
 143 private:
 144         void check ();
 145
 146         Socket (Socket const &);
 147
 148         boost::asio::io_service _io_service;
 149         boost::asio::deadline_timer _deadline;
 150         boost::asio::ip::tcp::socket _socket;
 151         int _timeout;
 152 };
 153
 154 /** @class AudioBuffers
 155  *  @brief A class to hold multi-channel audio data in float format.
 156  */
 157 class AudioBuffers
 158 {
 159 public:
 160         AudioBuffers (int channels, int frames);
 161         AudioBuffers (AudioBuffers const &);
 162         AudioBuffers (boost::shared_ptr<const AudioBuffers>);
 163         ~AudioBuffers ();
 164
 165         float** data () const {
 166                 return _data;
 167         }
 168
 169         float* data (int) const;
 170
 171         int channels () const {
 172                 return _channels;
 173         }
 174
 175         int frames () const {
 176                 return _frames;
 177         }
 178
 179         void set_frames (int f);
 180
 181         void make_silent ();
 182         void make_silent (int c);
 183
 184         void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
 185         void move (int from, int to, int frames);
 186         void accumulate (boost::shared_ptr<const AudioBuffers>, int, int);
 187
 188 private:
 189         /** Number of channels */
 190         int _channels;
 191         /** Number of frames (where a frame is one sample across all channels) */
 192         int _frames;
 193         /** Number of frames that _data can hold */
 194         int _allocated_frames;
 195         /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
 196         float** _data;
 197 };
 198
 199 extern int64_t video_frames_to_audio_frames (ContentVideoFrame v, float audio_sample_rate, float frames_per_second);
 200 extern std::pair<std::string, int> cpu_info ();
 201
 202 class LocaleGuard
 203 {
 204 public:
 205         LocaleGuard ();
 206         ~LocaleGuard ();
 207
 208 private:
 209         char* _old;
 210 };
 211
 212
 213 #endif
 214