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