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