2 Copyright (C) 2012-2014 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/thread.hpp>
40 #include <boost/filesystem.hpp>
41 #ifdef DCPOMATIC_WINDOWS
42 #include <boost/locale.hpp>
46 #include <pangomm/init.h>
47 #ifdef DCPOMATIC_IMAGE_MAGICK
48 #include <magick/MagickCore.h>
50 #include <magick/common.h>
51 #include <magick/magick_config.h>
53 #include <magick/version.h>
54 #include <dcp/version.h>
56 #include <dcp/signer.h>
57 #include <dcp/raw_convert.h>
59 #include <libavcodec/avcodec.h>
60 #include <libavformat/avformat.h>
61 #include <libswscale/swscale.h>
62 #include <libavfilter/avfiltergraph.h>
63 #include <libavutil/pixfmt.h>
66 #include "exceptions.h"
68 #include "dcp_content_type.h"
70 #include "cinema_sound_processor.h"
75 #include "video_content.h"
77 #include "md5_digester.h"
78 #include "audio_processor.h"
79 #include "safe_stringstream.h"
80 #ifdef DCPOMATIC_WINDOWS
100 using std::numeric_limits;
103 using std::bad_alloc;
104 using std::streampos;
105 using std::set_terminate;
106 using boost::shared_ptr;
108 using boost::optional;
110 using dcp::raw_convert;
112 static boost::thread::id ui_thread;
113 static boost::filesystem::path backtrace_file;
115 /** Convert some number of seconds to a string representation
116 * in hours, minutes and seconds.
119 * @return String of the form H:M:S (where H is hours, M
120 * is minutes and S is seconds).
123 seconds_to_hms (int s)
130 SafeStringStream hms;
133 hms << std::setfill ('0') << m << N_(":");
135 hms << std::setfill ('0') << s;
140 /** @param s Number of seconds.
141 * @return String containing an approximate description of s (e.g. "about 2 hours")
144 seconds_to_approximate_hms (int s)
153 bool const hours = h > 0;
154 bool const minutes = h < 10 && m > 0;
155 bool const seconds = m < 10 && s > 0;
158 if (m > 30 && !minutes) {
159 /* TRANSLATORS: h here is an abbreviation for hours */
160 ap << (h + 1) << _("h");
162 /* TRANSLATORS: h here is an abbreviation for hours */
166 if (minutes | seconds) {
173 if (s > 30 && !seconds) {
174 /* TRANSLATORS: m here is an abbreviation for minutes */
175 ap << (m + 1) << _("m");
177 /* TRANSLATORS: m here is an abbreviation for minutes */
188 /* TRANSLATORS: s here is an abbreviation for seconds */
195 #ifdef DCPOMATIC_POSIX
196 /** @param l Mangled C++ identifier.
197 * @return Demangled version.
202 string::size_type const b = l.find_first_of (N_("("));
203 if (b == string::npos) {
207 string::size_type const p = l.find_last_of (N_("+"));
208 if (p == string::npos) {
216 string const fn = l.substr (b + 1, p - b - 1);
221 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
226 } catch (std::exception) {
233 /** Write a stacktrace to an ostream.
234 * @param out Stream to write to.
235 * @param levels Number of levels to go up the call stack.
238 stacktrace (ostream& out, int levels)
241 size_t size = backtrace (array, 200);
242 char** strings = backtrace_symbols (array, size);
245 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
246 out << N_(" ") << demangle (strings[i]) << "\n";
254 /** @param v Version as used by FFmpeg.
255 * @return A string representation of v.
258 ffmpeg_version_to_string (int v)
261 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
266 seconds (struct timeval t)
268 return t.tv_sec + (double (t.tv_usec) / 1e6);
271 #ifdef DCPOMATIC_WINDOWS
272 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
275 FILE* f = fopen_boost (backtrace_file, "w");
276 fprintf (f, "Exception thrown:");
277 for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
278 fprintf (f, "%p %s %d %s\n", i->instruction, i->function.c_str(), i->line, i->module.c_str());
281 return EXCEPTION_CONTINUE_SEARCH;
286 set_backtrace_file (boost::filesystem::path p)
291 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
295 static bool tried_throw = false;
298 // try once to re-throw currently active exception
304 catch (const std::exception &e) {
305 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
306 << e.what() << std::endl;
309 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
313 #ifdef DCPOMATIC_POSIX
314 stacktrace (cout, 50);
319 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
320 * Must be called from the UI thread, if there is one.
325 #ifdef DCPOMATIC_WINDOWS
326 boost::filesystem::path p = g_get_user_config_dir ();
327 p /= "backtrace.txt";
328 set_backtrace_file (p);
329 SetUnhandledExceptionFilter(exception_handler);
331 /* Dark voodoo which, I think, gets boost::filesystem::path to
332 correctly convert UTF-8 strings to paths, and also paths
333 back to UTF-8 strings (on path::string()).
335 After this, constructing boost::filesystem::paths from strings
336 converts from UTF-8 to UTF-16 inside the path. Then
337 path::string().c_str() gives UTF-8 and
338 path::c_str() gives UTF-16.
340 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
341 so things are much simpler.
343 std::locale::global (boost::locale::generator().generate (""));
344 boost::filesystem::path::imbue (std::locale ());
347 avfilter_register_all ();
350 /* Add our lib directory to the libltdl search path so that
351 xmlsec can find xmlsec1-openssl.
353 boost::filesystem::path lib = app_contents ();
355 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
358 set_terminate (terminate);
363 Ratio::setup_ratios ();
364 VideoContentScale::setup_scales ();
365 DCPContentType::setup_dcp_content_types ();
366 Scaler::setup_scalers ();
367 Filter::setup_filters ();
368 CinemaSoundProcessor::setup_cinema_sound_processors ();
369 AudioProcessor::setup_audio_processors ();
371 ui_thread = boost::this_thread::get_id ();
374 #ifdef DCPOMATIC_WINDOWS
375 boost::filesystem::path
379 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
380 boost::filesystem::path p (buffer);
381 p = p.parent_path ();
382 p = p.parent_path ();
389 boost::filesystem::path
392 return "DCP-o-matic 2.app/Contents/Resources";
397 dcpomatic_setup_gettext_i18n (string lang)
399 #ifdef DCPOMATIC_LINUX
403 if (!lang.empty ()) {
404 /* Override our environment language. Note that the caller must not
405 free the string passed into putenv().
407 string s = String::compose ("LANGUAGE=%1", lang);
408 putenv (strdup (s.c_str ()));
409 s = String::compose ("LANG=%1", lang);
410 putenv (strdup (s.c_str ()));
411 s = String::compose ("LC_ALL=%1", lang);
412 putenv (strdup (s.c_str ()));
415 setlocale (LC_ALL, "");
416 textdomain ("libdcpomatic");
418 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
419 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
420 bind_textdomain_codeset ("libdcpomatic", "UTF8");
423 #ifdef DCPOMATIC_LINUX
424 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
428 /** @param s A string.
429 * @return Parts of the string split at spaces, except when a space is within quotation marks.
432 split_at_spaces_considering_quotes (string s)
435 bool in_quotes = false;
437 for (string::size_type i = 0; i < s.length(); ++i) {
438 if (s[i] == ' ' && !in_quotes) {
441 } else if (s[i] == '"') {
442 in_quotes = !in_quotes;
452 /** @param job Optional job for which to report progress */
454 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
456 boost::uintmax_t const buffer_size = 64 * 1024;
457 char buffer[buffer_size];
459 MD5Digester digester;
461 vector<int64_t> sizes;
462 for (size_t i = 0; i < files.size(); ++i) {
463 sizes.push_back (boost::filesystem::file_size (files[i]));
466 for (size_t i = 0; i < files.size(); ++i) {
467 FILE* f = fopen_boost (files[i], "rb");
469 throw OpenFileError (files[i].string());
472 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
473 boost::uintmax_t remaining = bytes;
475 while (remaining > 0) {
476 int const t = min (remaining, buffer_size);
477 int const r = fread (buffer, 1, t, f);
479 throw ReadFileError (files[i], errno);
481 digester.add (buffer, t);
485 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
492 return digester.get ();
495 /** @param An arbitrary audio frame rate.
496 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
499 dcp_audio_frame_rate (int fs)
508 Socket::Socket (int timeout)
509 : _deadline (_io_service)
510 , _socket (_io_service)
514 _deadline.expires_at (boost::posix_time::pos_infin);
526 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
528 _acceptor->cancel ();
532 _deadline.expires_at (boost::posix_time::pos_infin);
535 _deadline.async_wait (boost::bind (&Socket::check, this));
538 /** Blocking connect.
539 * @param endpoint End-point to connect to.
542 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
544 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
545 boost::system::error_code ec = boost::asio::error::would_block;
546 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
548 _io_service.run_one();
549 } while (ec == boost::asio::error::would_block);
552 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
555 if (!_socket.is_open ()) {
556 throw NetworkError (_("connect timed out"));
561 Socket::accept (int port)
563 _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
565 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
566 boost::system::error_code ec = boost::asio::error::would_block;
567 _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
569 _io_service.run_one ();
570 } while (ec == boost::asio::error::would_block);
576 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
581 * @param data Buffer to write.
582 * @param size Number of bytes to write.
585 Socket::write (uint8_t const * data, int size)
587 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
588 boost::system::error_code ec = boost::asio::error::would_block;
590 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
593 _io_service.run_one ();
594 } while (ec == boost::asio::error::would_block);
597 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
602 Socket::write (uint32_t v)
605 write (reinterpret_cast<uint8_t*> (&v), 4);
609 * @param data Buffer to read to.
610 * @param size Number of bytes to read.
613 Socket::read (uint8_t* data, int size)
615 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
616 boost::system::error_code ec = boost::asio::error::would_block;
618 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
621 _io_service.run_one ();
622 } while (ec == boost::asio::error::would_block);
625 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
630 Socket::read_uint32 ()
633 read (reinterpret_cast<uint8_t *> (&v), 4);
637 /** Round a number up to the nearest multiple of another number.
639 * @param s Array of numbers to round, indexed by c.
640 * @param t Multiple to round to.
641 * @return Rounded number.
644 stride_round_up (int c, int const * stride, int t)
646 int const a = stride[c] + (t - 1);
650 /** @param n A number.
651 * @param r Rounding `boundary' (must be a power of 2)
652 * @return n rounded to the nearest r
655 round_to (float n, int r)
657 assert (r == 1 || r == 2 || r == 4);
658 return int (n + float(r) / 2) &~ (r - 1);
661 /** Read a sequence of key / value pairs from a text stream;
662 * the keys are the first words on the line, and the values are
663 * the remainder of the line following the key. Lines beginning
664 * with # are ignored.
665 * @param s Stream to read.
666 * @return key/value pairs.
668 multimap<string, string>
669 read_key_value (istream &s)
671 multimap<string, string> kv;
674 while (getline (s, line)) {
679 if (line[0] == '#') {
683 if (line[line.size() - 1] == '\r') {
684 line = line.substr (0, line.size() - 1);
687 size_t const s = line.find (' ');
688 if (s == string::npos) {
692 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
699 get_required_string (multimap<string, string> const & kv, string k)
701 if (kv.count (k) > 1) {
702 throw StringError (N_("unexpected multiple keys in key-value set"));
705 multimap<string, string>::const_iterator i = kv.find (k);
707 if (i == kv.end ()) {
708 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
715 get_required_int (multimap<string, string> const & kv, string k)
717 string const v = get_required_string (kv, k);
718 return raw_convert<int> (v);
722 get_required_float (multimap<string, string> const & kv, string k)
724 string const v = get_required_string (kv, k);
725 return raw_convert<float> (v);
729 get_optional_string (multimap<string, string> const & kv, string k)
731 if (kv.count (k) > 1) {
732 throw StringError (N_("unexpected multiple keys in key-value set"));
735 multimap<string, string>::const_iterator i = kv.find (k);
736 if (i == kv.end ()) {
744 get_optional_int (multimap<string, string> const & kv, string k)
746 if (kv.count (k) > 1) {
747 throw StringError (N_("unexpected multiple keys in key-value set"));
750 multimap<string, string>::const_iterator i = kv.find (k);
751 if (i == kv.end ()) {
755 return raw_convert<int> (i->second);
758 /** Trip an assert if the caller is not in the UI thread */
762 assert (boost::this_thread::get_id() == ui_thread);
766 audio_channel_name (int c)
768 assert (MAX_DCP_AUDIO_CHANNELS == 12);
770 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
771 enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
772 VI is the visually-impaired audio track (audio describe).
774 string const channels[] = {
781 _("Hearing impaired"),
782 _("Visually impaired"),
785 _("Left rear surround"),
786 _("Right rear surround"),
793 valid_image_file (boost::filesystem::path f)
795 string ext = f.extension().string();
796 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
797 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx");
801 valid_j2k_file (boost::filesystem::path f)
803 string ext = f.extension().string();
804 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
805 return (ext == ".j2k" || ext == ".j2c");
809 tidy_for_filename (string f)
812 for (size_t i = 0; i < f.length(); ++i) {
813 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
824 split_get_request (string url)
827 AWAITING_QUESTION_MARK,
830 } state = AWAITING_QUESTION_MARK;
832 map<string, string> r;
835 for (size_t i = 0; i < url.length(); ++i) {
837 case AWAITING_QUESTION_MARK:
852 r.insert (make_pair (k, v));
862 if (state == VALUE) {
863 r.insert (make_pair (k, v));
870 fit_ratio_within (float ratio, dcp::Size full_frame, int round)
872 if (ratio < full_frame.ratio ()) {
873 return dcp::Size (round_to (full_frame.height * ratio, round), full_frame.height);
876 return dcp::Size (full_frame.width, round_to (full_frame.width / ratio, round));
880 wrapped_av_malloc (size_t s)
882 void* p = av_malloc (s);
890 entities_to_text (string e)
892 boost::algorithm::replace_all (e, "%3A", ":");
893 boost::algorithm::replace_all (e, "%2F", "/");
898 divide_with_round (int64_t a, int64_t b)
900 if (a % b >= (b / 2)) {
901 return (a + b - 1) / b;
907 /** Return a user-readable string summarising the versions of our dependencies */
909 dependency_version_summary ()
912 s << N_("libopenjpeg ") << opj_version () << N_(", ")
913 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
914 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
915 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
916 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
917 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
918 << MagickVersion << N_(", ")
919 << N_("libssh ") << ssh_version (0) << N_(", ")
920 << N_("libdcp ") << dcp::version << N_(" git ") << dcp::git_commit;
925 /** Construct a ScopedTemporary. A temporary filename is decided but the file is not opened
926 * until ::open() is called.
928 ScopedTemporary::ScopedTemporary ()
931 _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
934 /** Close and delete the temporary file */
935 ScopedTemporary::~ScopedTemporary ()
938 boost::system::error_code ec;
939 boost::filesystem::remove (_file, ec);
942 /** @return temporary filename */
944 ScopedTemporary::c_str () const
946 return _file.string().c_str ();
949 /** Open the temporary file.
950 * @return File's FILE pointer.
953 ScopedTemporary::open (char const * params)
955 _open = fopen (c_str(), params);
959 /** Close the file */
961 ScopedTemporary::close ()
970 subtitle_period (AVSubtitle const & sub)
972 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
974 ContentTimePeriod period (
975 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
976 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)