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.
21 /** @file src/lib/util.cc
22 * @brief Some utility functions and classes.
30 #ifdef DCPOMATIC_POSIX
34 #include <libssh/libssh.h>
36 #include <boost/algorithm/string.hpp>
37 #include <boost/bind.hpp>
38 #include <boost/lambda/lambda.hpp>
39 #include <boost/lexical_cast.hpp>
40 #include <boost/thread.hpp>
41 #include <boost/filesystem.hpp>
44 #include <openssl/md5.h>
45 #include <magick/MagickCore.h>
46 #include <magick/version.h>
47 #include <libdcp/version.h>
48 #include <libdcp/util.h>
50 #include <libavcodec/avcodec.h>
51 #include <libavformat/avformat.h>
52 #include <libswscale/swscale.h>
53 #include <libavfilter/avfiltergraph.h>
54 #include <libpostproc/postprocess.h>
55 #include <libavutil/pixfmt.h>
57 #include <curl/curl.h>
59 #include "exceptions.h"
61 #include "dcp_content_type.h"
63 #include "sound_processor.h"
67 #ifdef DCPOMATIC_WINDOWS
74 using std::stringstream;
88 using std::numeric_limits;
91 using boost::shared_ptr;
93 using boost::lexical_cast;
94 using boost::optional;
97 static boost::thread::id ui_thread;
98 static boost::filesystem::path backtrace_file;
100 /** Convert some number of seconds to a string representation
101 * in hours, minutes and seconds.
104 * @return String of the form H:M:S (where H is hours, M
105 * is minutes and S is seconds).
108 seconds_to_hms (int s)
118 hms << std::setfill ('0') << m << N_(":");
120 hms << std::setfill ('0') << s;
125 /** @param s Number of seconds.
126 * @return String containing an approximate description of s (e.g. "about 2 hours")
129 seconds_to_approximate_hms (int s)
140 ap << (h + 1) << N_(" ") << _("hours");
143 ap << N_("1 ") << _("hour");
145 ap << h << N_(" ") << _("hours");
150 ap << N_("1 ") << _("minute");
152 ap << m << N_(" ") << _("minutes");
155 ap << s << N_(" ") << _("seconds");
161 #ifdef DCPOMATIC_POSIX
162 /** @param l Mangled C++ identifier.
163 * @return Demangled version.
168 string::size_type const b = l.find_first_of (N_("("));
169 if (b == string::npos) {
173 string::size_type const p = l.find_last_of (N_("+"));
174 if (p == string::npos) {
182 string const fn = l.substr (b + 1, p - b - 1);
187 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
192 } catch (std::exception) {
199 /** Write a stacktrace to an ostream.
200 * @param out Stream to write to.
201 * @param levels Number of levels to go up the call stack.
204 stacktrace (ostream& out, int levels)
207 size_t size = backtrace (array, 200);
208 char** strings = backtrace_symbols (array, size);
211 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
212 out << N_(" ") << demangle (strings[i]) << "\n";
220 /** @param v Version as used by FFmpeg.
221 * @return A string representation of v.
224 ffmpeg_version_to_string (int v)
227 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
231 /** Return a user-readable string summarising the versions of our dependencies */
233 dependency_version_summary ()
236 s << N_("libopenjpeg ") << opj_version () << N_(", ")
237 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
238 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
239 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
240 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
241 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
242 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
243 << MagickVersion << N_(", ")
244 << N_("libssh ") << ssh_version (0) << N_(", ")
245 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
251 seconds (struct timeval t)
253 return t.tv_sec + (double (t.tv_usec) / 1e6);
256 #ifdef DCPOMATIC_WINDOWS
257 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
260 ofstream f (backtrace_file.string().c_str());
261 std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
262 return EXCEPTION_CONTINUE_SEARCH;
266 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
267 * Must be called from the UI thread, if there is one.
272 #ifdef DCPOMATIC_WINDOWS
273 backtrace_file /= g_get_user_config_dir ();
274 backtrace_file /= "backtrace.txt";
275 SetUnhandledExceptionFilter(exception_handler);
278 avfilter_register_all ();
282 Ratio::setup_ratios ();
283 DCPContentType::setup_dcp_content_types ();
284 Scaler::setup_scalers ();
285 Filter::setup_filters ();
286 SoundProcessor::setup_sound_processors ();
288 ui_thread = boost::this_thread::get_id ();
291 #ifdef DCPOMATIC_WINDOWS
292 boost::filesystem::path
296 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
297 boost::filesystem::path p (buffer);
298 p = p.parent_path ();
299 p = p.parent_path ();
306 dcpomatic_setup_gettext_i18n (string lang)
308 #ifdef DCPOMATIC_POSIX
312 if (!lang.empty ()) {
313 /* Override our environment language; this is essential on
317 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
319 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
323 setlocale (LC_ALL, "");
324 textdomain ("libdcpomatic");
326 #ifdef DCPOMATIC_WINDOWS
327 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
328 bind_textdomain_codeset ("libdcpomatic", "UTF8");
331 #ifdef DCPOMATIC_POSIX
332 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
336 /** @param s A string.
337 * @return Parts of the string split at spaces, except when a space is within quotation marks.
340 split_at_spaces_considering_quotes (string s)
343 bool in_quotes = false;
345 for (string::size_type i = 0; i < s.length(); ++i) {
346 if (s[i] == ' ' && !in_quotes) {
349 } else if (s[i] == '"') {
350 in_quotes = !in_quotes;
361 md5_digest (void const * data, int size)
364 MD5_Init (&md5_context);
365 MD5_Update (&md5_context, data, size);
366 unsigned char digest[MD5_DIGEST_LENGTH];
367 MD5_Final (digest, &md5_context);
370 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
371 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
377 /** @param file File name.
378 * @return MD5 digest of file's contents.
381 md5_digest (boost::filesystem::path file)
383 ifstream f (file.string().c_str(), std::ios::binary);
385 throw OpenFileError (file.string());
388 f.seekg (0, std::ios::end);
389 int bytes = f.tellg ();
390 f.seekg (0, std::ios::beg);
392 int const buffer_size = 64 * 1024;
393 char buffer[buffer_size];
396 MD5_Init (&md5_context);
398 int const t = min (bytes, buffer_size);
400 MD5_Update (&md5_context, buffer, t);
404 unsigned char digest[MD5_DIGEST_LENGTH];
405 MD5_Final (digest, &md5_context);
408 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
409 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
415 /** @param job Optional job for which to report progress */
417 md5_digest_directory (boost::filesystem::path directory, shared_ptr<Job> job)
419 int const buffer_size = 64 * 1024;
420 char buffer[buffer_size];
423 MD5_Init (&md5_context);
427 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
433 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
434 ifstream f (i->path().string().c_str(), std::ios::binary);
436 throw OpenFileError (i->path().string());
439 f.seekg (0, std::ios::end);
440 int bytes = f.tellg ();
441 f.seekg (0, std::ios::beg);
444 int const t = min (bytes, buffer_size);
446 MD5_Update (&md5_context, buffer, t);
451 job->set_progress (float (j) / files);
456 unsigned char digest[MD5_DIGEST_LENGTH];
457 MD5_Final (digest, &md5_context);
460 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
461 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
468 about_equal (float a, float b)
470 /* A film of F seconds at f FPS will be Ff frames;
471 Consider some delta FPS d, so if we run the same
472 film at (f + d) FPS it will last F(f + d) seconds.
474 Hence the difference in length over the length of the film will
475 be F(f + d) - Ff frames
476 = Ff + Fd - Ff frames
480 So if we accept a difference of 1 frame, ie 1/f seconds, we can
487 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
488 FPS error is 1/F ~= 0.0001 ~= 10-e4
491 return (fabs (a - b) < 1e-4);
494 /** @param An arbitrary audio frame rate.
495 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
498 dcp_audio_frame_rate (int fs)
507 Socket::Socket (int timeout)
508 : _deadline (_io_service)
509 , _socket (_io_service)
512 _deadline.expires_at (boost::posix_time::pos_infin);
519 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
521 _deadline.expires_at (boost::posix_time::pos_infin);
524 _deadline.async_wait (boost::bind (&Socket::check, this));
527 /** Blocking connect.
528 * @param endpoint End-point to connect to.
531 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
533 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
534 boost::system::error_code ec = boost::asio::error::would_block;
535 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
537 _io_service.run_one();
538 } while (ec == boost::asio::error::would_block);
540 if (ec || !_socket.is_open ()) {
541 throw NetworkError (_("connect timed out"));
546 * @param data Buffer to write.
547 * @param size Number of bytes to write.
550 Socket::write (uint8_t const * data, int size)
552 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
553 boost::system::error_code ec = boost::asio::error::would_block;
555 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
558 _io_service.run_one ();
559 } while (ec == boost::asio::error::would_block);
562 throw NetworkError (ec.message ());
567 Socket::write (uint32_t v)
570 write (reinterpret_cast<uint8_t*> (&v), 4);
574 * @param data Buffer to read to.
575 * @param size Number of bytes to read.
578 Socket::read (uint8_t* data, int size)
580 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
581 boost::system::error_code ec = boost::asio::error::would_block;
583 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
586 _io_service.run_one ();
587 } while (ec == boost::asio::error::would_block);
590 throw NetworkError (ec.message ());
595 Socket::read_uint32 ()
598 read (reinterpret_cast<uint8_t *> (&v), 4);
602 /** Round a number up to the nearest multiple of another number.
604 * @param s Array of numbers to round, indexed by c.
605 * @param t Multiple to round to.
606 * @return Rounded number.
609 stride_round_up (int c, int const * stride, int t)
611 int const a = stride[c] + (t - 1);
615 /** Read a sequence of key / value pairs from a text stream;
616 * the keys are the first words on the line, and the values are
617 * the remainder of the line following the key. Lines beginning
618 * with # are ignored.
619 * @param s Stream to read.
620 * @return key/value pairs.
622 multimap<string, string>
623 read_key_value (istream &s)
625 multimap<string, string> kv;
628 while (getline (s, line)) {
633 if (line[0] == '#') {
637 if (line[line.size() - 1] == '\r') {
638 line = line.substr (0, line.size() - 1);
641 size_t const s = line.find (' ');
642 if (s == string::npos) {
646 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
653 get_required_string (multimap<string, string> const & kv, string k)
655 if (kv.count (k) > 1) {
656 throw StringError (N_("unexpected multiple keys in key-value set"));
659 multimap<string, string>::const_iterator i = kv.find (k);
661 if (i == kv.end ()) {
662 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
669 get_required_int (multimap<string, string> const & kv, string k)
671 string const v = get_required_string (kv, k);
672 return lexical_cast<int> (v);
676 get_required_float (multimap<string, string> const & kv, string k)
678 string const v = get_required_string (kv, k);
679 return lexical_cast<float> (v);
683 get_optional_string (multimap<string, string> const & kv, string k)
685 if (kv.count (k) > 1) {
686 throw StringError (N_("unexpected multiple keys in key-value set"));
689 multimap<string, string>::const_iterator i = kv.find (k);
690 if (i == kv.end ()) {
698 get_optional_int (multimap<string, string> const & kv, string k)
700 if (kv.count (k) > 1) {
701 throw StringError (N_("unexpected multiple keys in key-value set"));
704 multimap<string, string>::const_iterator i = kv.find (k);
705 if (i == kv.end ()) {
709 return lexical_cast<int> (i->second);
712 /** Trip an assert if the caller is not in the UI thread */
716 assert (boost::this_thread::get_id() == ui_thread);
719 /** @param v Content video frame.
720 * @param audio_sample_rate Source audio sample rate.
721 * @param frames_per_second Number of video frames per second.
722 * @return Equivalent number of audio frames for `v'.
725 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
727 return ((int64_t) v * audio_sample_rate / frames_per_second);
731 audio_channel_name (int c)
733 assert (MAX_AUDIO_CHANNELS == 6);
735 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
736 enhancement channel (sub-woofer)./
738 string const channels[] = {
750 FrameRateConversion::FrameRateConversion (float source, int dcp)
753 , change_speed (false)
755 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
757 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
761 change_speed = !about_equal (source * factor(), dcp);
763 if (!skip && !repeat && !change_speed) {
764 description = _("Content and DCP have the same rate.\n");
767 description = _("DCP will use every other frame of the content.\n");
769 description = _("Each content frame will be doubled in the DCP.\n");
773 float const pc = dcp * 100 / (source * factor());
774 description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
779 LocaleGuard::LocaleGuard ()
782 char const * old = setlocale (LC_NUMERIC, 0);
786 if (strcmp (_old, "C")) {
787 setlocale (LC_NUMERIC, "C");
792 LocaleGuard::~LocaleGuard ()
794 setlocale (LC_NUMERIC, _old);
799 valid_image_file (boost::filesystem::path f)
801 string ext = f.extension().string();
802 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
803 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
807 tidy_for_filename (string f)
810 for (size_t i = 0; i < f.length(); ++i) {
811 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
828 send_email_function (void* ptr, size_t size, size_t nmemb, void* userdata)
830 EmailState* state = reinterpret_cast<EmailState*> (userdata);
832 int const now = min (size * nmemb, state->message.length() - state->done);
834 memcpy (ptr, state->message.c_str() + state->done, now);
841 send_email (string from, string to, string message)
843 CURL* curl = curl_easy_init ();
848 string const url = "smtp://" + Config::instance()->mail_server();
850 curl_easy_setopt (curl, CURLOPT_URL, url.c_str ());
851 curl_easy_setopt (curl, CURLOPT_MAIL_FROM, from.c_str ());
852 struct curl_slist* recipients = 0;
853 recipients = curl_slist_append (recipients, to.c_str ());
854 curl_easy_setopt (curl, CURLOPT_READFUNCTION, send_email_function);
857 state.message = message;
859 curl_easy_setopt (curl, CURLOPT_READDATA, &state);
861 if (curl_easy_perform (curl) != CURLE_OK) {
865 curl_slist_free_all (recipients);
866 curl_easy_cleanup (curl);