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