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         /** frames per second for the DCP */
  67         int frames_per_second;
  68         /** true to skip every other frame */
  69         bool skip;
  70         /** true to repeat every frame once */
  71         bool repeat;
  72         /** true if this DCP will run its video faster than the source
  73          *  without taking into account `skip' and `repeat'.
  74          *  (i.e. run_fast will be true if
  75          *          source is 29.97fps, DCP is 30fps
  76          *          source is 14.50fps, DCP is 30fps
  77          *  but not if
  78          *          source is 15.00fps, DCP is 30fps
  79          *          source is 12.50fps, DCP is 25fps)
  80          */
  81         bool run_fast;
  82 };
  83
  84 enum ContentType {
  85         STILL, ///< content is still images
  86         VIDEO  ///< content is a video
  87 };
  88
  89 /** @class Size
  90  *  @brief Representation of the size of something */
  91 struct Size
  92 {
  93         /** Construct a zero Size */
  94         Size ()
  95                 : width (0)
  96                 , height (0)
  97         {}
  98
  99         /** @param w Width.
 100          *  @param h Height.
 101          */
 102         Size (int w, int h)
 103                 : width (w)
 104                 , height (h)
 105         {}
 106
 107         /** width */
 108         int width;
 109         /** height */
 110         int height;
 111 };
 112
 113 extern bool operator== (Size const & a, Size const & b);
 114 extern bool operator!= (Size const & a, Size const & b);
 115
 116 /** @struct Crop
 117  *  @brief A description of the crop of an image or video.
 118  */
 119 struct Crop
 120 {
 121         Crop () : left (0), right (0), top (0), bottom (0) {}
 122
 123         /** Number of pixels to remove from the left-hand side */
 124         int left;
 125         /** Number of pixels to remove from the right-hand side */
 126         int right;
 127         /** Number of pixels to remove from the top */
 128         int top;
 129         /** Number of pixels to remove from the bottom */
 130         int bottom;
 131 };
 132
 133 extern bool operator== (Crop const & a, Crop const & b);
 134 extern bool operator!= (Crop const & a, Crop const & b);
 135
 136 /** @struct Position
 137  *  @brief A position.
 138  */
 139 struct Position
 140 {
 141         Position ()
 142                 : x (0)
 143                 , y (0)
 144         {}
 145
 146         Position (int x_, int y_)
 147                 : x (x_)
 148                 , y (y_)
 149         {}
 150
 151         /** x coordinate */
 152         int x;
 153         /** y coordinate */
 154         int y;
 155 };
 156
 157 /** @struct Rect
 158  *  @brief A rectangle.
 159  */
 160 struct Rect
 161 {
 162         Rect ()
 163                 : x (0)
 164                 , y (0)
 165                 , width (0)
 166                 , height (0)
 167         {}
 168
 169         Rect (int x_, int y_, int w_, int h_)
 170                 : x (x_)
 171                 , y (y_)
 172                 , width (w_)
 173                 , height (h_)
 174         {}
 175
 176         int x;
 177         int y;
 178         int width;
 179         int height;
 180
 181         Position position () const {
 182                 return Position (x, y);
 183         }
 184
 185         Size size () const {
 186                 return Size (width, height);
 187         }
 188
 189         Rect intersection (Rect const & other) const;
 190 };
 191
 192 extern std::string crop_string (Position, Size);
 193 extern int dcp_audio_sample_rate (int);
 194 extern int dcp_audio_channels (int);
 195 extern std::string colour_lut_index_to_name (int index);
 196 extern int stride_round_up (int, int const *, int);
 197 extern int stride_lookup (int c, int const * stride);
 198 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 199 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 200 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 201 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 202 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 203 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 204
 205 /** @class Socket
 206  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 207  *  that are useful for DVD-o-matic.
 208  *
 209  *  This class wraps some things that I could not work out how to do with boost;
 210  *  most notably, sync read/write calls with timeouts, and the ability to peek into
 211  *  data being read.
 212  */
 213 class Socket
 214 {
 215 public:
 216         Socket ();
 217
 218         /** @return Our underlying socket */
 219         boost::asio::ip::tcp::socket& socket () {
 220                 return _socket;
 221         }
 222
 223         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
 224         void write (uint8_t const * data, int size, int timeout);
 225
 226         void read_definite_and_consume (uint8_t* data, int size, int timeout);
 227         void read_indefinite (uint8_t* data, int size, int timeout);
 228         void consume (int amount);
 229
 230 private:
 231         void check ();
 232         int read (uint8_t* data, int size, int timeout);
 233
 234         Socket (Socket const &);
 235
 236         boost::asio::io_service _io_service;
 237         boost::asio::deadline_timer _deadline;
 238         boost::asio::ip::tcp::socket _socket;
 239         /** a buffer for small reads */
 240         uint8_t _buffer[1024];
 241         /** amount of valid data in the buffer */
 242         int _buffer_data;
 243 };
 244
 245 /** @class AudioBuffers
 246  *  @brief A class to hold multi-channel audio data in float format.
 247  */
 248 class AudioBuffers
 249 {
 250 public:
 251         AudioBuffers (int channels, int frames);
 252         AudioBuffers (AudioBuffers const &);
 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 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