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