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