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;
65 /** frames per second for the DCP */
66 int frames_per_second;
67 /** Skip every `skip' frames. e.g. if this is 1, we skip nothing;
68 * if it's 2, we skip every other frame.
71 /** true if this DCP will run its video faster than the source
72 * (e.g. if the source is 29.97fps and we will run the DCP at 30fps)
78 STILL, ///< content is still images
79 VIDEO ///< content is a video
83 * @brief A description of the crop of an image or video.
87 Crop () : left (0), right (0), top (0), bottom (0) {}
89 /** Number of pixels to remove from the left-hand side */
91 /** Number of pixels to remove from the right-hand side */
93 /** Number of pixels to remove from the top */
95 /** Number of pixels to remove from the bottom */
99 extern bool operator== (Crop const & a, Crop const & b);
100 extern bool operator!= (Crop const & a, Crop const & b);
112 Position (int x_, int y_)
124 * @brief A rectangle.
135 Rect (int x_, int y_, int w_, int h_)
147 Position position () const {
148 return Position (x, y);
151 libdcp::Size size () const {
152 return libdcp::Size (width, height);
155 Rect intersection (Rect const & other) const;
158 extern std::string crop_string (Position, libdcp::Size);
159 extern int dcp_audio_sample_rate (int);
160 extern DCPFrameRate dcp_frame_rate (float);
161 extern int dcp_audio_channels (int);
162 extern std::string colour_lut_index_to_name (int index);
163 extern int stride_round_up (int, int const *, int);
164 extern int stride_lookup (int c, int const * stride);
165 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
166 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
167 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
168 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
169 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
170 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
173 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
174 * that are useful for DVD-o-matic.
176 * This class wraps some things that I could not work out how to do with boost;
177 * most notably, sync read/write calls with timeouts, and the ability to peek into
185 /** @return Our underlying socket */
186 boost::asio::ip::tcp::socket& socket () {
190 void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
191 void write (uint8_t const * data, int size, int timeout);
193 void read_definite_and_consume (uint8_t* data, int size, int timeout);
194 void read_indefinite (uint8_t* data, int size, int timeout);
195 void consume (int amount);
199 int read (uint8_t* data, int size, int timeout);
201 Socket (Socket const &);
203 boost::asio::io_service _io_service;
204 boost::asio::deadline_timer _deadline;
205 boost::asio::ip::tcp::socket _socket;
206 /** a buffer for small reads */
207 uint8_t _buffer[1024];
208 /** amount of valid data in the buffer */
212 /** @class AudioBuffers
213 * @brief A class to hold multi-channel audio data in float format.
218 AudioBuffers (int channels, int frames);
219 AudioBuffers (AudioBuffers const &);
222 float** data () const {
226 float* data (int) const;
228 int channels () const {
232 int frames () const {
236 void set_frames (int f);
239 void make_silent (int c);
241 void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
242 void move (int from, int to, int frames);
245 /** Number of channels */
247 /** Number of frames (where a frame is one sample across all channels) */
249 /** Number of frames that _data can hold */
250 int _allocated_frames;
251 /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
255 extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
256 extern bool still_image_file (std::string);
257 extern std::pair<std::string, int> cpu_info ();