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