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 DVDOMATIC_UTIL_H
26 #define DVDOMATIC_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 #ifdef DVDOMATIC_DEBUG
42 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
47 /** The maximum number of audio channels that we can cope with */
48 #define MAX_AUDIO_CHANNELS 6
52 extern std::string seconds_to_hms (int);
53 extern std::string seconds_to_approximate_hms (int);
54 extern void stacktrace (std::ostream &, int);
55 extern std::string dependency_version_summary ();
56 extern double seconds (struct timeval);
57 extern void dvdomatic_setup ();
58 extern void dvdomatic_setup_i18n (std::string);
59 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
60 extern std::string md5_digest (std::string);
61 extern std::string md5_digest (void const *, int);
62 extern void ensure_ui_thread ();
63 extern std::string audio_channel_name (int);
64 #ifdef DVDOMATIC_WINDOWS
65 extern boost::filesystem::path mo_path ();
68 typedef int SourceFrame;
70 struct FrameRateConversion
72 FrameRateConversion (float, int);
74 /** @return factor by which to multiply a source frame rate
75 to get the effective rate after any skip or repeat has happened.
77 float factor () const {
87 /** true to skip every other frame */
89 /** true to repeat every frame once */
91 /** true if this DCP will run its video faster or slower than the source
92 * without taking into account `repeat' nor `skip'.
93 * (e.g. change_speed will be true if
94 * source is 29.97fps, DCP is 30fps
95 * source is 14.50fps, DCP is 30fps
97 * source is 15.00fps, DCP is 30fps
98 * source is 12.50fps, DCP is 25fps)
102 std::string description;
105 int best_dcp_frame_rate (float);
108 STILL, ///< content is still images
109 VIDEO ///< content is a video
113 * @brief A description of the crop of an image or video.
117 Crop () : left (0), right (0), top (0), bottom (0) {}
119 /** Number of pixels to remove from the left-hand side */
121 /** Number of pixels to remove from the right-hand side */
123 /** Number of pixels to remove from the top */
125 /** Number of pixels to remove from the bottom */
129 extern bool operator== (Crop const & a, Crop const & b);
130 extern bool operator!= (Crop const & a, Crop const & b);
142 Position (int x_, int y_)
154 * @brief A rectangle.
165 Rect (int x_, int y_, int w_, int h_)
177 Position position () const {
178 return Position (x, y);
181 libdcp::Size size () const {
182 return libdcp::Size (width, height);
185 Rect intersection (Rect const & other) const;
188 extern std::string crop_string (Position, libdcp::Size);
189 extern int dcp_audio_sample_rate (int);
190 extern std::string colour_lut_index_to_name (int index);
191 extern int stride_round_up (int, int const *, int);
192 extern int stride_lookup (int c, int const * stride);
193 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
194 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
195 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
196 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
197 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
198 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
201 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
202 * that are useful for DVD-o-matic.
204 * This class wraps some things that I could not work out how to do with boost;
205 * most notably, sync read/write calls with timeouts.
210 Socket (int timeout = 30);
212 /** @return Our underlying socket */
213 boost::asio::ip::tcp::socket& socket () {
217 void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
219 void write (uint32_t n);
220 void write (uint8_t const * data, int size);
222 void read (uint8_t* data, int size);
223 uint32_t read_uint32 ();
228 Socket (Socket const &);
230 boost::asio::io_service _io_service;
231 boost::asio::deadline_timer _deadline;
232 boost::asio::ip::tcp::socket _socket;
236 /** @class AudioBuffers
237 * @brief A class to hold multi-channel audio data in float format.
242 AudioBuffers (int channels, int frames);
243 AudioBuffers (AudioBuffers const &);
246 float** data () const {
250 float* data (int) const;
252 int channels () const {
256 int frames () const {
260 void set_frames (int f);
263 void make_silent (int c);
265 void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
266 void move (int from, int to, int frames);
269 /** Number of channels */
271 /** Number of frames (where a frame is one sample across all channels) */
273 /** Number of frames that _data can hold */
274 int _allocated_frames;
275 /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
284 boost::optional<libdcp::Channel> source_to_dcp (int c) const;
285 boost::optional<int> dcp_to_source (libdcp::Channel c) const;
286 int dcp_channels () const;
289 int _source_channels;
292 extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
293 extern bool still_image_file (std::string);
294 extern std::pair<std::string, int> cpu_info ();