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>
33 #include <libavcodec/avcodec.h>
34 #include <libavfilter/avfilter.h>
36 #include "compose.hpp"
38 #ifdef DVDOMATIC_DEBUG
39 #define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
44 #define MAX_AUDIO_CHANNELS 6
48 extern std::string seconds_to_hms (int);
49 extern std::string seconds_to_approximate_hms (int);
50 extern void stacktrace (std::ostream &, int);
51 extern std::string dependency_version_summary ();
52 extern double seconds (struct timeval);
53 extern void dvdomatic_setup ();
54 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
55 extern std::string md5_digest (std::string);
56 extern std::string md5_digest (void const *, int);
57 extern void ensure_ui_thread ();
59 typedef int SourceFrame;
63 int frames_per_second;
74 * @brief Representation of the size of something */
77 /** Construct a zero Size */
97 extern bool operator== (Size const & a, Size const & b);
99 /** A description of the crop of an image or video. */
102 Crop () : left (0), right (0), top (0), bottom (0) {}
104 /** Number of pixels to remove from the left-hand side */
106 /** Number of pixels to remove from the right-hand side */
108 /** Number of pixels to remove from the top */
110 /** Number of pixels to remove from the bottom */
114 extern bool operator== (Crop const & a, Crop const & b);
115 extern bool operator!= (Crop const & a, Crop const & b);
125 Position (int x_, int y_)
146 Rect (int x_, int y_, int w_, int h_)
158 Position position () const {
159 return Position (x, y);
163 return Size (width, height);
166 Rect intersection (Rect const & other) const;
169 extern std::string crop_string (Position, Size);
170 extern int dcp_audio_sample_rate (int);
171 extern DCPFrameRate dcp_frame_rate (float);
172 extern std::string colour_lut_index_to_name (int index);
173 extern int stride_round_up (int, int const *, int);
174 extern int stride_lookup (int c, int const * stride);
175 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
176 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
177 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
178 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
179 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
180 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
183 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
184 * that are useful for DVD-o-matic.
186 * This class wraps some things that I could not work out how to do with boost;
187 * most notably, sync read/write calls with timeouts, and the ability to peek into
195 /** @return Our underlying socket */
196 boost::asio::ip::tcp::socket& socket () {
200 void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
201 void write (uint8_t const * data, int size, int timeout);
203 void read_definite_and_consume (uint8_t* data, int size, int timeout);
204 void read_indefinite (uint8_t* data, int size, int timeout);
205 void consume (int amount);
209 int read (uint8_t* data, int size, int timeout);
211 Socket (Socket const &);
213 boost::asio::io_service _io_service;
214 boost::asio::deadline_timer _deadline;
215 boost::asio::ip::tcp::socket _socket;
216 /** a buffer for small reads */
217 uint8_t _buffer[1024];
218 /** amount of valid data in the buffer */
225 AudioBuffers (int channels, int frames);
226 AudioBuffers (AudioBuffers const &);
229 float** data () const {
233 float* data (int) const;
235 int channels () const {
239 int frames () const {
243 void set_frames (int f);
247 void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
248 void move (int from, int to, int frames);
253 int _allocated_frames;
257 extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);