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