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 #include <libdcp/util.h>
  33 extern "C" {
  34 #include <libavcodec/avcodec.h>
  35 #include <libavfilter/avfilter.h>
  36 }
  37 #include "compose.hpp"
  38
  39 #ifdef DVDOMATIC_DEBUG
  40 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
  41 #else
  42 #define TIMING(...)
  43 #endif
  44
  45 /** The maximum number of audio channels that we can cope with */
  46 #define MAX_AUDIO_CHANNELS 6
  47
  48 class Scaler;
  49
  50 extern std::string seconds_to_hms (int);
  51 extern std::string seconds_to_approximate_hms (int);
  52 extern void stacktrace (std::ostream &, int);
  53 extern std::string dependency_version_summary ();
  54 extern double seconds (struct timeval);
  55 extern void dvdomatic_setup ();
  56 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  57 extern std::string md5_digest (std::string);
  58 extern std::string md5_digest (void const *, int);
  59 extern void ensure_ui_thread ();
  60 extern std::string audio_channel_name (int);
  61
  62 typedef int SourceFrame;
  63
  64 struct DCPFrameRate
  65 {
  66         DCPFrameRate (float);
  67
  68         /** @return factor by which to multiply a source frame rate
  69             to get the effective rate after any skip or repeat has happened.
  70         */
  71         float factor () const {
  72                 if (skip) {
  73                         return 0.5;
  74                 } else if (repeat) {
  75                         return 2;
  76                 }
  77
  78                 return 1;
  79         }
  80
  81         /** frames per second for the DCP */
  82         int frames_per_second;
  83         /** true to skip every other frame */
  84         bool skip;
  85         /** true to repeat every frame once */
  86         bool repeat;
  87         /** true if this DCP will run its video faster or slower than the source
  88          *  without taking into account `repeat'.
  89          *  (e.g. change_speed will be true if
  90          *          source is 29.97fps, DCP is 30fps
  91          *          source is 14.50fps, DCP is 30fps
  92          *  but not if
  93          *          source is 15.00fps, DCP is 30fps
  94          *          source is 12.50fps, DCP is 25fps)
  95          */
  96         bool change_speed;
  97 };
  98
  99 enum ContentType {
 100         STILL, ///< content is still images
 101         VIDEO  ///< content is a video
 102 };
 103
 104 /** @struct Crop
 105  *  @brief A description of the crop of an image or video.
 106  */
 107 struct Crop
 108 {
 109         Crop () : left (0), right (0), top (0), bottom (0) {}
 110
 111         /** Number of pixels to remove from the left-hand side */
 112         int left;
 113         /** Number of pixels to remove from the right-hand side */
 114         int right;
 115         /** Number of pixels to remove from the top */
 116         int top;
 117         /** Number of pixels to remove from the bottom */
 118         int bottom;
 119 };
 120
 121 extern bool operator== (Crop const & a, Crop const & b);
 122 extern bool operator!= (Crop const & a, Crop const & b);
 123
 124 /** @struct Position
 125  *  @brief A position.
 126  */
 127 struct Position
 128 {
 129         Position ()
 130                 : x (0)
 131                 , y (0)
 132         {}
 133
 134         Position (int x_, int y_)
 135                 : x (x_)
 136                 , y (y_)
 137         {}
 138
 139         /** x coordinate */
 140         int x;
 141         /** y coordinate */
 142         int y;
 143 };
 144
 145 /** @struct Rect
 146  *  @brief A rectangle.
 147  */
 148 struct Rect
 149 {
 150         Rect ()
 151                 : x (0)
 152                 , y (0)
 153                 , width (0)
 154                 , height (0)
 155         {}
 156
 157         Rect (int x_, int y_, int w_, int h_)
 158                 : x (x_)
 159                 , y (y_)
 160                 , width (w_)
 161                 , height (h_)
 162         {}
 163
 164         int x;
 165         int y;
 166         int width;
 167         int height;
 168
 169         Position position () const {
 170                 return Position (x, y);
 171         }
 172
 173         libdcp::Size size () const {
 174                 return libdcp::Size (width, height);
 175         }
 176
 177         Rect intersection (Rect const & other) const;
 178 };
 179
 180 extern std::string crop_string (Position, libdcp::Size);
 181 extern int dcp_audio_sample_rate (int);
 182 extern int dcp_audio_channels (int);
 183 extern std::string colour_lut_index_to_name (int index);
 184 extern int stride_round_up (int, int const *, int);
 185 extern int stride_lookup (int c, int const * stride);
 186 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 187 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 188 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 189 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 190 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 191 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 192
 193 /** @class Socket
 194  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 195  *  that are useful for DVD-o-matic.
 196  *
 197  *  This class wraps some things that I could not work out how to do with boost;
 198  *  most notably, sync read/write calls with timeouts.
 199  */
 200 class Socket
 201 {
 202 public:
 203         Socket (int timeout = 30);
 204
 205         /** @return Our underlying socket */
 206         boost::asio::ip::tcp::socket& socket () {
 207                 return _socket;
 208         }
 209
 210         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
 211
 212         void write (uint32_t n);
 213         void write (uint8_t const * data, int size);
 214
 215         void read (uint8_t* data, int size);
 216         uint32_t read_uint32 ();
 217
 218 private:
 219         void check ();
 220
 221         Socket (Socket const &);
 222
 223         boost::asio::io_service _io_service;
 224         boost::asio::deadline_timer _deadline;
 225         boost::asio::ip::tcp::socket _socket;
 226         int _timeout;
 227 };
 228
 229 /** @class AudioBuffers
 230  *  @brief A class to hold multi-channel audio data in float format.
 231  */
 232 class AudioBuffers
 233 {
 234 public:
 235         AudioBuffers (int channels, int frames);
 236         AudioBuffers (AudioBuffers const &);
 237         ~AudioBuffers ();
 238
 239         float** data () const {
 240                 return _data;
 241         }
 242
 243         float* data (int) const;
 244
 245         int channels () const {
 246                 return _channels;
 247         }
 248
 249         int frames () const {
 250                 return _frames;
 251         }
 252
 253         void set_frames (int f);
 254
 255         void make_silent ();
 256         void make_silent (int c);
 257
 258         void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
 259         void move (int from, int to, int frames);
 260
 261 private:
 262         /** Number of channels */
 263         int _channels;
 264         /** Number of frames (where a frame is one sample across all channels) */
 265         int _frames;
 266         /** Number of frames that _data can hold */
 267         int _allocated_frames;
 268         /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
 269         float** _data;
 270 };
 271
 272 extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
 273 extern bool still_image_file (std::string);
 274 extern std::pair<std::string, int> cpu_info ();
 275
 276 #endif
 277