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 "compose.hpp"
  29 #include "types.h"
  30 #include "video_content.h"
  31 #include <dcp/util.h>
  32 extern "C" {
  33 #include <libavcodec/avcodec.h>
  34 #include <libavfilter/avfilter.h>
  35 }
  36 #include <boost/shared_ptr.hpp>
  37 #include <boost/asio.hpp>
  38 #include <boost/optional.hpp>
  39 #include <boost/filesystem.hpp>
  40 #include <string>
  41 #include <vector>
  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 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
  48 #define HISTORY_SIZE 10
  49 #define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com")
  50
  51 extern std::string program_name;
  52
  53 class Job;
  54 struct AVSubtitle;
  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 void ensure_ui_thread ();
  66 extern std::string audio_channel_name (int);
  67 extern bool valid_image_file (boost::filesystem::path);
  68 extern bool valid_j2k_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 dcp::Size fit_ratio_within (float ratio, dcp::Size, int);
  74 extern std::string entities_to_text (std::string e);
  75 extern int dcp_audio_frame_rate (int);
  76 extern int stride_round_up (int, int const *, int);
  77 extern int round_to (float n, int r);
  78 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
  79 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
  80 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
  81 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
  82 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
  83 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
  84 extern void* wrapped_av_malloc (size_t);
  85 extern int64_t divide_with_round (int64_t a, int64_t b);
  86 extern ContentTimePeriod subtitle_period (AVSubtitle const &);
  87 extern void set_backtrace_file (boost::filesystem::path);
  88
  89 /** @class Socket
  90  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
  91  *  that are useful for DCP-o-matic.
  92  *
  93  *  This class wraps some things that I could not work out how to do with boost;
  94  *  most notably, sync read/write calls with timeouts.
  95  */
  96 class Socket
  97 {
  98 public:
  99         Socket (int timeout = 30);
 100         ~Socket ();
 101
 102         /** @return Our underlying socket */
 103         boost::asio::ip::tcp::socket& socket () {
 104                 return _socket;
 105         }
 106
 107         void connect (boost::asio::ip::tcp::endpoint);
 108         void accept (int);
 109
 110         void write (uint32_t n);
 111         void write (uint8_t const * data, int size);
 112
 113         void read (uint8_t* data, int size);
 114         uint32_t read_uint32 ();
 115
 116 private:
 117         void check ();
 118
 119         Socket (Socket const &);
 120
 121         boost::asio::io_service _io_service;
 122         boost::asio::deadline_timer _deadline;
 123         boost::asio::ip::tcp::socket _socket;
 124         boost::asio::ip::tcp::acceptor* _acceptor;
 125         int _timeout;
 126 };
 127
 128 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
 129
 130 /** @class ScopedTemporary
 131  *  @brief A temporary file which is deleted when the ScopedTemporary object goes out of scope.
 132  */
 133 class ScopedTemporary
 134 {
 135 public:
 136         ScopedTemporary ();
 137         ~ScopedTemporary ();
 138
 139         /** @return temporary filename */
 140         boost::filesystem::path file () const {
 141                 return _file;
 142         }
 143
 144         char const * c_str () const;
 145         FILE* open (char const *);
 146         void close ();
 147
 148 private:
 149         boost::filesystem::path _file;
 150         FILE* _open;
 151 };
 152
 153 #endif
 154