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 <libdcp/util.h>
34 #include <libavcodec/avcodec.h>
35 #include <libavfilter/avfilter.h>
37 #include "compose.hpp"
39 #ifdef DVDOMATIC_DEBUG
40 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
45 /** The maximum number of audio channels that we can cope with */
46 #define MAX_AUDIO_CHANNELS 6
50 extern std::string seconds_to_hms (int);
51 extern std::string seconds_to_approximate_hms (int);
52 extern void stacktrace (std::ostream &, int);
53 extern std::string dependency_version_summary ();
54 extern double seconds (struct timeval);
55 extern void dvdomatic_setup ();
56 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
57 extern std::string md5_digest (std::string);
58 extern std::string md5_digest (void const *, int);
59 extern void ensure_ui_thread ();
61 typedef int SourceFrame;
67 /** @return factor by which to multiply a source frame rate
68 to get the effective rate after any skip or repeat has happened.
70 float factor () const {
80 /** frames per second for the DCP */
81 int frames_per_second;
82 /** true to skip every other frame */
84 /** true to repeat every frame once */
86 /** true if this DCP will run its video faster or slower than the source
87 * without taking into account `repeat'.
88 * (e.g. change_speed will be true if
89 * source is 29.97fps, DCP is 30fps
90 * source is 14.50fps, DCP is 30fps
92 * source is 15.00fps, DCP is 30fps
93 * source is 12.50fps, DCP is 25fps)
99 STILL, ///< content is still images
100 VIDEO ///< content is a video
104 * @brief A description of the crop of an image or video.
108 Crop () : left (0), right (0), top (0), bottom (0) {}
110 /** Number of pixels to remove from the left-hand side */
112 /** Number of pixels to remove from the right-hand side */
114 /** Number of pixels to remove from the top */
116 /** Number of pixels to remove from the bottom */
120 extern bool operator== (Crop const & a, Crop const & b);
121 extern bool operator!= (Crop const & a, Crop const & b);
133 Position (int x_, int y_)
145 * @brief A rectangle.
156 Rect (int x_, int y_, int w_, int h_)
168 Position position () const {
169 return Position (x, y);
172 libdcp::Size size () const {
173 return libdcp::Size (width, height);
176 Rect intersection (Rect const & other) const;
179 extern std::string crop_string (Position, libdcp::Size);
180 extern int dcp_audio_sample_rate (int);
181 extern int dcp_audio_channels (int);
182 extern std::string colour_lut_index_to_name (int index);
183 extern int stride_round_up (int, int const *, int);
184 extern int stride_lookup (int c, int const * stride);
185 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
186 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
187 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
188 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
189 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
190 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
193 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
194 * that are useful for DVD-o-matic.
196 * This class wraps some things that I could not work out how to do with boost;
197 * most notably, sync read/write calls with timeouts, and the ability to peek into
205 /** @return Our underlying socket */
206 boost::asio::ip::tcp::socket& socket () {
210 void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
211 void write (uint8_t const * data, int size, int timeout);
213 void read_definite_and_consume (uint8_t* data, int size, int timeout);
214 void read_indefinite (uint8_t* data, int size, int timeout);
215 void consume (int amount);
219 int read (uint8_t* data, int size, int timeout);
221 Socket (Socket const &);
223 boost::asio::io_service _io_service;
224 boost::asio::deadline_timer _deadline;
225 boost::asio::ip::tcp::socket _socket;
226 /** a buffer for small reads */
227 uint8_t _buffer[1024];
228 /** amount of valid data in the buffer */
232 /** @class AudioBuffers
233 * @brief A class to hold multi-channel audio data in float format.
238 AudioBuffers (int channels, int frames);
239 AudioBuffers (AudioBuffers const &);
242 float** data () const {
246 float* data (int) const;
248 int channels () const {
252 int frames () const {
256 void set_frames (int f);
259 void make_silent (int c);
261 void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
262 void move (int from, int to, int frames);
265 /** Number of channels */
267 /** Number of frames (where a frame is one sample across all channels) */
269 /** Number of frames that _data can hold */
270 int _allocated_frames;
271 /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
275 extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
276 extern bool still_image_file (std::string);
277 extern std::pair<std::string, int> cpu_info ();