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