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 DCPOMATIC_UTIL_H
  26 #define DCPOMATIC_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 <boost/filesystem.hpp>
  34 #include <libdcp/util.h>
  35 extern "C" {
  36 #include <libavcodec/avcodec.h>
  37 #include <libavfilter/avfilter.h>
  38 }
  39 #include "compose.hpp"
  40 #include "types.h"
  41 #include "video_content.h"
  42
  43 #undef check
  44
  45 /** The maximum number of audio channels that we can have in a DCP */
  46 #define MAX_DCP_AUDIO_CHANNELS 12
  47
  48 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
  49
  50 namespace libdcp {
  51         class Signer;
  52 }
  53
  54 class Job;
  55
  56 extern std::string seconds_to_hms (int);
  57 extern std::string seconds_to_approximate_hms (int);
  58 extern void stacktrace (std::ostream &, int);
  59 extern std::string dependency_version_summary ();
  60 extern double seconds (struct timeval);
  61 extern void dcpomatic_setup ();
  62 extern void dcpomatic_setup_gettext_i18n (std::string);
  63 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  64 extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shared_ptr<Job>);
  65 extern std::string md5_digest (void const *, int);
  66 extern void ensure_ui_thread ();
  67 extern std::string audio_channel_name (int);
  68 extern bool valid_image_file (boost::filesystem::path);
  69 #ifdef DCPOMATIC_WINDOWS
  70 extern boost::filesystem::path mo_path ();
  71 #endif
  72 extern std::string tidy_for_filename (std::string);
  73 extern boost::shared_ptr<const libdcp::Signer> make_signer ();
  74 extern libdcp::Size fit_ratio_within (float ratio, libdcp::Size);
  75 extern std::string entities_to_text (std::string e);
  76 extern std::map<std::string, std::string> split_get_request (std::string url);
  77
  78 struct FrameRateConversion
  79 {
  80         FrameRateConversion (float, int);
  81
  82         /** @return factor by which to multiply a source frame rate
  83             to get the effective rate after any skip or repeat has happened.
  84         */
  85         float factor () const {
  86                 if (skip) {
  87                         return 0.5;
  88                 }
  89
  90                 return repeat;
  91         }
  92
  93         /** true to skip every other frame */
  94         bool skip;
  95         /** number of times to use each frame (e.g. 1 is normal, 2 means repeat each frame once, and so on) */
  96         int repeat;
  97         /** true if this DCP will run its video faster or slower than the source
  98          *  without taking into account `repeat' nor `skip'.
  99          *  (e.g. change_speed will be true if
 100          *          source is 29.97fps, DCP is 30fps
 101          *          source is 14.50fps, DCP is 30fps
 102          *  but not if
 103          *          source is 15.00fps, DCP is 30fps
 104          *          source is 12.50fps, DCP is 25fps)
 105          */
 106         bool change_speed;
 107
 108         std::string description;
 109 };
 110
 111 extern int dcp_audio_frame_rate (int);
 112 extern int stride_round_up (int, int const *, int);
 113 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 114 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 115 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
 116 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
 117 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 118 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 119 extern void* wrapped_av_malloc (size_t);
 120 extern int64_t divide_with_round (int64_t a, int64_t b);
 121
 122 /** @class Socket
 123  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 124  *  that are useful for DCP-o-matic.
 125  *
 126  *  This class wraps some things that I could not work out how to do with boost;
 127  *  most notably, sync read/write calls with timeouts.
 128  */
 129 class Socket
 130 {
 131 public:
 132         Socket (int timeout = 30);
 133         ~Socket ();
 134
 135         /** @return Our underlying socket */
 136         boost::asio::ip::tcp::socket& socket () {
 137                 return _socket;
 138         }
 139
 140         void connect (boost::asio::ip::tcp::endpoint);
 141         void accept (int);
 142
 143         void write (uint32_t n);
 144         void write (uint8_t const * data, int size);
 145
 146         void read (uint8_t* data, int size);
 147         uint32_t read_uint32 ();
 148
 149 private:
 150         void check ();
 151
 152         Socket (Socket const &);
 153
 154         boost::asio::io_service _io_service;
 155         boost::asio::deadline_timer _deadline;
 156         boost::asio::ip::tcp::socket _socket;
 157         boost::asio::ip::tcp::acceptor* _acceptor;
 158         int _timeout;
 159 };
 160
 161 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
 162
 163 class ScopedTemporary
 164 {
 165 public:
 166         ScopedTemporary ();
 167         ~ScopedTemporary ();
 168
 169         boost::filesystem::path file () const {
 170                 return _file;
 171         }
 172
 173         char const * c_str () const;
 174         FILE* open (char const *);
 175         void close ();
 176
 177 private:
 178         boost::filesystem::path _file;
 179         FILE* _open;
 180 };
 181
 182 #endif
 183