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>
34 #include <libdcp/util.h>
36 #include <libavcodec/avcodec.h>
37 #include <libavfilter/avfilter.h>
39 #include "compose.hpp"
41 #include "video_content.h"
43 #ifdef DCPOMATIC_DEBUG
44 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
51 /** The maximum number of audio channels that we can cope with */
52 #define MAX_AUDIO_CHANNELS 6
57 extern std::string seconds_to_hms (int);
58 extern std::string time_to_hms (Time);
59 extern std::string seconds_to_approximate_hms (int);
60 extern void stacktrace (std::ostream &, int);
61 extern std::string dependency_version_summary ();
62 extern double seconds (struct timeval);
63 extern void dcpomatic_setup ();
64 extern void dcpomatic_setup_gettext_i18n (std::string);
65 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
66 extern std::string md5_digest (boost::filesystem::path);
67 extern std::string md5_digest (void const *, int);
68 extern void ensure_ui_thread ();
69 extern std::string audio_channel_name (int);
70 #ifdef DCPOMATIC_WINDOWS
71 extern boost::filesystem::path mo_path ();
74 struct FrameRateConversion
76 FrameRateConversion (float, int);
78 /** @return factor by which to multiply a source frame rate
79 to get the effective rate after any skip or repeat has happened.
81 float factor () const {
91 /** true to skip every other frame */
93 /** true to repeat every frame once */
95 /** true if this DCP will run its video faster or slower than the source
96 * without taking into account `repeat' nor `skip'.
97 * (e.g. change_speed will be true if
98 * source is 29.97fps, DCP is 30fps
99 * source is 14.50fps, DCP is 30fps
101 * source is 15.00fps, DCP is 30fps
102 * source is 12.50fps, DCP is 25fps)
106 std::string description;
109 extern int dcp_audio_frame_rate (int);
110 extern std::string colour_lut_index_to_name (int index);
111 extern int stride_round_up (int, int const *, int);
112 extern int stride_lookup (int c, int const * stride);
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);
121 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
122 * that are useful for DCP-o-matic.
124 * This class wraps some things that I could not work out how to do with boost;
125 * most notably, sync read/write calls with timeouts.
130 Socket (int timeout = 30);
132 /** @return Our underlying socket */
133 boost::asio::ip::tcp::socket& socket () {
137 void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
139 void write (uint32_t n);
140 void write (uint8_t const * data, int size);
142 void read (uint8_t* data, int size);
143 uint32_t read_uint32 ();
148 Socket (Socket const &);
150 boost::asio::io_service _io_service;
151 boost::asio::deadline_timer _deadline;
152 boost::asio::ip::tcp::socket _socket;
156 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);