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