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