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 DVDOMATIC_UTIL_H
  26 #define DVDOMATIC_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
  41 #ifdef DVDOMATIC_DEBUG
  42 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
  43 #else
  44 #define TIMING(...)
  45 #endif
  46
  47 /** The maximum number of audio channels that we can cope with */
  48 #define MAX_AUDIO_CHANNELS 6
  49
  50 class Scaler;
  51
  52 extern std::string seconds_to_hms (int);
  53 extern std::string seconds_to_approximate_hms (int);
  54 extern void stacktrace (std::ostream &, int);
  55 extern std::string dependency_version_summary ();
  56 extern double seconds (struct timeval);
  57 extern void dvdomatic_setup ();
  58 extern void dvdomatic_setup_i18n (std::string);
  59 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  60 extern std::string md5_digest (std::string);
  61 extern std::string md5_digest (void const *, int);
  62 extern void ensure_ui_thread ();
  63 extern std::string audio_channel_name (int);
  64 #ifdef DVDOMATIC_WINDOWS
  65 extern boost::filesystem::path mo_path ();
  66 #endif
  67
  68 typedef int SourceFrame;
  69
  70 struct FrameRateConversion
  71 {
  72         FrameRateConversion (float, int);
  73
  74         /** @return factor by which to multiply a source frame rate
  75             to get the effective rate after any skip or repeat has happened.
  76         */
  77         float factor () const {
  78                 if (skip) {
  79                         return 0.5;
  80                 } else if (repeat) {
  81                         return 2;
  82                 }
  83
  84                 return 1;
  85         }
  86
  87         /** true to skip every other frame */
  88         bool skip;
  89         /** true to repeat every frame once */
  90         bool repeat;
  91         /** true if this DCP will run its video faster or slower than the source
  92          *  without taking into account `repeat' nor `skip'.
  93          *  (e.g. change_speed will be true if
  94          *          source is 29.97fps, DCP is 30fps
  95          *          source is 14.50fps, DCP is 30fps
  96          *  but not if
  97          *          source is 15.00fps, DCP is 30fps
  98          *          source is 12.50fps, DCP is 25fps)
  99          */
 100         bool change_speed;
 101
 102         std::string description;
 103 };
 104
 105 int best_dcp_frame_rate (float);
 106
 107 enum ContentType {
 108         STILL, ///< content is still images
 109         VIDEO  ///< content is a video
 110 };
 111
 112 /** @struct Crop
 113  *  @brief A description of the crop of an image or video.
 114  */
 115 struct Crop
 116 {
 117         Crop () : left (0), right (0), top (0), bottom (0) {}
 118
 119         /** Number of pixels to remove from the left-hand side */
 120         int left;
 121         /** Number of pixels to remove from the right-hand side */
 122         int right;
 123         /** Number of pixels to remove from the top */
 124         int top;
 125         /** Number of pixels to remove from the bottom */
 126         int bottom;
 127 };
 128
 129 extern bool operator== (Crop const & a, Crop const & b);
 130 extern bool operator!= (Crop const & a, Crop const & b);
 131
 132 /** @struct Position
 133  *  @brief A position.
 134  */
 135 struct Position
 136 {
 137         Position ()
 138                 : x (0)
 139                 , y (0)
 140         {}
 141
 142         Position (int x_, int y_)
 143                 : x (x_)
 144                 , y (y_)
 145         {}
 146
 147         /** x coordinate */
 148         int x;
 149         /** y coordinate */
 150         int y;
 151 };
 152
 153 /** @struct Rect
 154  *  @brief A rectangle.
 155  */
 156 struct Rect
 157 {
 158         Rect ()
 159                 : x (0)
 160                 , y (0)
 161                 , width (0)
 162                 , height (0)
 163         {}
 164
 165         Rect (int x_, int y_, int w_, int h_)
 166                 : x (x_)
 167                 , y (y_)
 168                 , width (w_)
 169                 , height (h_)
 170         {}
 171
 172         int x;
 173         int y;
 174         int width;
 175         int height;
 176
 177         Position position () const {
 178                 return Position (x, y);
 179         }
 180
 181         libdcp::Size size () const {
 182                 return libdcp::Size (width, height);
 183         }
 184
 185         Rect intersection (Rect const & other) const;
 186 };
 187
 188 extern std::string crop_string (Position, libdcp::Size);
 189 extern int dcp_audio_sample_rate (int);
 190 extern std::string colour_lut_index_to_name (int index);
 191 extern int stride_round_up (int, int const *, int);
 192 extern int stride_lookup (int c, int const * stride);
 193 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 194 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 195 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 196 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 197 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 198 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 199
 200 /** @class Socket
 201  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 202  *  that are useful for DVD-o-matic.
 203  *
 204  *  This class wraps some things that I could not work out how to do with boost;
 205  *  most notably, sync read/write calls with timeouts.
 206  */
 207 class Socket
 208 {
 209 public:
 210         Socket (int timeout = 30);
 211
 212         /** @return Our underlying socket */
 213         boost::asio::ip::tcp::socket& socket () {
 214                 return _socket;
 215         }
 216
 217         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
 218
 219         void write (uint32_t n);
 220         void write (uint8_t const * data, int size);
 221
 222         void read (uint8_t* data, int size);
 223         uint32_t read_uint32 ();
 224
 225 private:
 226         void check ();
 227
 228         Socket (Socket const &);
 229
 230         boost::asio::io_service _io_service;
 231         boost::asio::deadline_timer _deadline;
 232         boost::asio::ip::tcp::socket _socket;
 233         int _timeout;
 234 };
 235
 236 /** @class AudioBuffers
 237  *  @brief A class to hold multi-channel audio data in float format.
 238  */
 239 class AudioBuffers
 240 {
 241 public:
 242         AudioBuffers (int channels, int frames);
 243         AudioBuffers (AudioBuffers const &);
 244         AudioBuffers (boost::shared_ptr<const AudioBuffers>);
 245         ~AudioBuffers ();
 246
 247         float** data () const {
 248                 return _data;
 249         }
 250
 251         float* data (int) const;
 252
 253         int channels () const {
 254                 return _channels;
 255         }
 256
 257         int frames () const {
 258                 return _frames;
 259         }
 260
 261         void set_frames (int f);
 262
 263         void make_silent ();
 264         void make_silent (int c);
 265
 266         void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
 267         void move (int from, int to, int frames);
 268
 269 private:
 270         /** Number of channels */
 271         int _channels;
 272         /** Number of frames (where a frame is one sample across all channels) */
 273         int _frames;
 274         /** Number of frames that _data can hold */
 275         int _allocated_frames;
 276         /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
 277         float** _data;
 278 };
 279
 280 class AudioMapping
 281 {
 282 public:
 283         AudioMapping (int);
 284
 285         boost::optional<libdcp::Channel> source_to_dcp (int c) const;
 286         boost::optional<int> dcp_to_source (libdcp::Channel c) const;
 287         int dcp_channels () const;
 288
 289 private:
 290         int _source_channels;
 291 };
 292
 293 extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
 294 extern bool still_image_file (std::string);
 295 extern std::pair<std::string, int> cpu_info ();
 296
 297 class LocaleGuard
 298 {
 299 public:
 300         LocaleGuard ();
 301         ~LocaleGuard ();
 302
 303 private:
 304         char* _old;
 305 };
 306
 307
 308 #endif
 309