2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3 Copyright (C) 2000-2007 Paul Davis
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.
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.
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.
22 * @brief Some utility functions and classes.
25 #ifndef DCPOMATIC_UTIL_H
26 #define DCPOMATIC_UTIL_H
30 #include <boost/shared_ptr.hpp>
31 #include <boost/asio.hpp>
32 #include <boost/optional.hpp>
33 #include <boost/filesystem.hpp>
35 #include <dcp/signer.h>
37 #include <libavcodec/avcodec.h>
38 #include <libavfilter/avfilter.h>
40 #include "compose.hpp"
42 #include "video_content.h"
44 #ifdef DCPOMATIC_DEBUG
45 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
52 /** The maximum number of audio channels that we can have in a DCP */
53 #define MAX_DCP_AUDIO_CHANNELS 12
55 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
64 extern std::string seconds_to_hms (int);
65 extern std::string seconds_to_approximate_hms (int);
66 extern void stacktrace (std::ostream &, int);
67 extern std::string dependency_version_summary ();
68 extern double seconds (struct timeval);
69 extern void dcpomatic_setup ();
70 extern void dcpomatic_setup_gettext_i18n (std::string);
71 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
72 extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shared_ptr<Job>);
73 extern std::string md5_digest (void const *, int);
74 extern void ensure_ui_thread ();
75 extern std::string audio_channel_name (int);
76 extern bool valid_image_file (boost::filesystem::path);
77 #ifdef DCPOMATIC_WINDOWS
78 extern boost::filesystem::path mo_path ();
80 extern std::string tidy_for_filename (std::string);
81 extern boost::shared_ptr<const dcp::Signer> make_signer ();
82 extern dcp::Size fit_ratio_within (float ratio, dcp::Size);
83 extern std::string entities_to_text (std::string e);
84 extern std::map<std::string, std::string> split_get_request (std::string url);
85 extern int dcp_audio_frame_rate (int);
86 extern int stride_round_up (int, int const *, int);
87 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
88 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
89 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
90 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
91 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
92 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
93 extern void* wrapped_av_malloc (size_t);
94 extern int64_t divide_with_round (int64_t a, int64_t b);
95 extern ContentTimePeriod subtitle_period (AVSubtitle const &);
98 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
99 * that are useful for DCP-o-matic.
101 * This class wraps some things that I could not work out how to do with boost;
102 * most notably, sync read/write calls with timeouts.
107 Socket (int timeout = 30);
110 /** @return Our underlying socket */
111 boost::asio::ip::tcp::socket& socket () {
115 void connect (boost::asio::ip::tcp::endpoint);
118 void write (uint32_t n);
119 void write (uint8_t const * data, int size);
121 void read (uint8_t* data, int size);
122 uint32_t read_uint32 ();
127 Socket (Socket const &);
129 boost::asio::io_service _io_service;
130 boost::asio::deadline_timer _deadline;
131 boost::asio::ip::tcp::socket _socket;
132 boost::asio::ip::tcp::acceptor* _acceptor;
136 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
138 /** @class ScopedTemporary
139 * @brief A temporary file which is deleted when the ScopedTemporary object goes out of scope.
141 class ScopedTemporary
147 /** @return temporary filename */
148 boost::filesystem::path file () const {
152 char const * c_str () const;
153 FILE* open (char const *);
157 boost::filesystem::path _file;