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