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
28 #include "compose.hpp"
30 #include "video_content.h"
33 #include <libavcodec/avcodec.h>
34 #include <libavfilter/avfilter.h>
36 #include <boost/shared_ptr.hpp>
37 #include <boost/asio.hpp>
38 #include <boost/optional.hpp>
39 #include <boost/filesystem.hpp>
45 /** The maximum number of audio channels that we can have in a DCP */
46 #define MAX_DCP_AUDIO_CHANNELS 12
47 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
48 #define HISTORY_SIZE 10
49 #define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com")
54 extern std::string seconds_to_hms (int);
55 extern std::string seconds_to_approximate_hms (int);
56 extern void stacktrace (std::ostream &, int);
57 extern std::string dependency_version_summary ();
58 extern double seconds (struct timeval);
59 extern void dcpomatic_setup ();
60 extern void dcpomatic_setup_gettext_i18n (std::string);
61 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
62 extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shared_ptr<Job>);
63 extern void ensure_ui_thread ();
64 extern std::string audio_channel_name (int);
65 extern bool valid_image_file (boost::filesystem::path);
66 extern bool valid_j2k_file (boost::filesystem::path);
67 #ifdef DCPOMATIC_WINDOWS
68 extern boost::filesystem::path mo_path ();
70 extern std::string tidy_for_filename (std::string);
71 extern dcp::Size fit_ratio_within (float ratio, dcp::Size, int);
72 extern std::string entities_to_text (std::string e);
73 extern int dcp_audio_frame_rate (int);
74 extern int stride_round_up (int, int const *, int);
75 extern int round_to (float n, int r);
76 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
77 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
78 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
79 extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
80 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
81 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
82 extern void* wrapped_av_malloc (size_t);
83 extern int64_t divide_with_round (int64_t a, int64_t b);
84 extern ContentTimePeriod subtitle_period (AVSubtitle const &);
85 extern void set_backtrace_file (boost::filesystem::path);
88 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
89 * that are useful for DCP-o-matic.
91 * This class wraps some things that I could not work out how to do with boost;
92 * most notably, sync read/write calls with timeouts.
97 Socket (int timeout = 30);
100 /** @return Our underlying socket */
101 boost::asio::ip::tcp::socket& socket () {
105 void connect (boost::asio::ip::tcp::endpoint);
108 void write (uint32_t n);
109 void write (uint8_t const * data, int size);
111 void read (uint8_t* data, int size);
112 uint32_t read_uint32 ();
117 Socket (Socket const &);
119 boost::asio::io_service _io_service;
120 boost::asio::deadline_timer _deadline;
121 boost::asio::ip::tcp::socket _socket;
122 boost::asio::ip::tcp::acceptor* _acceptor;
126 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
128 /** @class ScopedTemporary
129 * @brief A temporary file which is deleted when the ScopedTemporary object goes out of scope.
131 class ScopedTemporary
137 /** @return temporary filename */
138 boost::filesystem::path file () const {
142 char const * c_str () const;
143 FILE* open (char const *);
147 boost::filesystem::path _file;