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 class Scaler;
  45
  46 extern std::string seconds_to_hms (int);
  47 extern std::string seconds_to_approximate_hms (int);
  48 extern void stacktrace (std::ostream &, int);
  49 extern std::string dependency_version_summary ();
  50 extern double seconds (struct timeval);
  51 extern void dvdomatic_setup ();
  52 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  53 extern std::string md5_digest (std::string);
  54 extern std::string md5_digest (void const *, int);
  55 extern void ensure_ui_thread ();
  56
  57 struct DCPFrameRate
  58 {
  59         int frames_per_second;
  60         int skip;
  61         bool run_fast;
  62 };
  63
  64 enum ContentType {
  65         STILL,
  66         VIDEO
  67 };
  68
  69 /** @class Size
  70  *  @brief Representation of the size of something */
  71 struct Size
  72 {
  73         /** Construct a zero Size */
  74         Size ()
  75                 : width (0)
  76                 , height (0)
  77         {}
  78
  79         /** @param w Width.
  80          *  @param h Height.
  81          */
  82         Size (int w, int h)
  83                 : width (w)
  84                 , height (h)
  85         {}
  86
  87         /** width */
  88         int width;
  89         /** height */
  90         int height;
  91 };
  92
  93 extern bool operator== (Size const & a, Size const & b);
  94
  95 /** A description of the crop of an image or video. */
  96 struct Crop
  97 {
  98         Crop () : left (0), right (0), top (0), bottom (0) {}
  99
 100         /** Number of pixels to remove from the left-hand side */
 101         int left;
 102         /** Number of pixels to remove from the right-hand side */
 103         int right;
 104         /** Number of pixels to remove from the top */
 105         int top;
 106         /** Number of pixels to remove from the bottom */
 107         int bottom;
 108 };
 109
 110 extern bool operator== (Crop const & a, Crop const & b);
 111 extern bool operator!= (Crop const & a, Crop const & b);
 112
 113 /** A position */
 114 struct Position
 115 {
 116         Position ()
 117                 : x (0)
 118                 , y (0)
 119         {}
 120
 121         Position (int x_, int y_)
 122                 : x (x_)
 123                 , y (y_)
 124         {}
 125
 126         /** x coordinate */
 127         int x;
 128         /** y coordinate */
 129         int y;
 130 };
 131
 132 /** A rectangle */
 133 struct Rect
 134 {
 135         Rect ()
 136                 : x (0)
 137                 , y (0)
 138                 , width (0)
 139                 , height (0)
 140         {}
 141
 142         Rect (int x_, int y_, int w_, int h_)
 143                 : x (x_)
 144                 , y (y_)
 145                 , width (w_)
 146                 , height (h_)
 147         {}
 148
 149         int x;
 150         int y;
 151         int width;
 152         int height;
 153
 154         Position position () const {
 155                 return Position (x, y);
 156         }
 157
 158         Size size () const {
 159                 return Size (width, height);
 160         }
 161
 162         Rect intersection (Rect const & other) const;
 163 };
 164
 165 extern std::string crop_string (Position, Size);
 166 extern int dcp_audio_sample_rate (int);
 167 extern DCPFrameRate dcp_frame_rate (float);
 168 extern std::string colour_lut_index_to_name (int index);
 169 extern int round_up (int, int);
 170 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 171 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 172 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 173 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 174 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 175 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 176
 177 /** @class Socket
 178  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 179  *  that are useful for DVD-o-matic.
 180  *
 181  *  This class wraps some things that I could not work out how to do with boost;
 182  *  most notably, sync read/write calls with timeouts, and the ability to peek into
 183  *  data being read.
 184  */
 185 class Socket
 186 {
 187 public:
 188         Socket ();
 189
 190         /** @return Our underlying socket */
 191         boost::asio::ip::tcp::socket& socket () {
 192                 return _socket;
 193         }
 194
 195         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
 196         void write (uint8_t const * data, int size, int timeout);
 197
 198         void read_definite_and_consume (uint8_t* data, int size, int timeout);
 199         void read_indefinite (uint8_t* data, int size, int timeout);
 200         void consume (int amount);
 201
 202 private:
 203         void check ();
 204         int read (uint8_t* data, int size, int timeout);
 205
 206         Socket (Socket const &);
 207
 208         boost::asio::io_service _io_service;
 209         boost::asio::deadline_timer _deadline;
 210         boost::asio::ip::tcp::socket _socket;
 211         /** a buffer for small reads */
 212         uint8_t _buffer[1024];
 213         /** amount of valid data in the buffer */
 214         int _buffer_data;
 215 };
 216
 217 class AudioBuffers
 218 {
 219 public:
 220         AudioBuffers (int channels, int frames);
 221         ~AudioBuffers ();
 222
 223         float** data () const {
 224                 return _data;
 225         }
 226
 227         float* data (int) const;
 228
 229         int frames () const {
 230                 return _frames;
 231         }
 232
 233         void set_frames (int f);
 234
 235         void make_silent ();
 236
 237 private:
 238         /* no copy construction */
 239         AudioBuffers (AudioBuffers const &);
 240
 241         int _channels;
 242         int _frames;
 243         float** _data;
 244 };
 245
 246 #endif
 247