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.
29 #ifdef DVDOMATIC_POSIX
33 #include <libssh/libssh.h>
35 #include <boost/algorithm/string.hpp>
36 #include <boost/bind.hpp>
37 #include <boost/lambda/lambda.hpp>
38 #include <boost/lexical_cast.hpp>
40 #include <openssl/md5.h>
41 #include <magick/MagickCore.h>
42 #include <magick/version.h>
43 #include <libdcp/version.h>
45 #include <libavcodec/avcodec.h>
46 #include <libavformat/avformat.h>
47 #include <libswscale/swscale.h>
48 #include <libavfilter/avfiltergraph.h>
49 #include <libpostproc/postprocess.h>
50 #include <libavutil/pixfmt.h>
53 #include "exceptions.h"
56 #include "dcp_content_type.h"
59 #include "film_state.h"
60 #include "sound_processor.h"
61 #ifndef DVDOMATIC_DISABLE_PLAYER
62 #include "player_manager.h"
66 using namespace boost;
68 /** Convert some number of seconds to a string representation
69 * in hours, minutes and seconds.
72 * @return String of the form H:M:S (where H is hours, M
73 * is minutes and S is seconds).
76 seconds_to_hms (int s)
86 hms << setfill ('0') << m << ":";
88 hms << setfill ('0') << s;
93 /** @param s Number of seconds.
94 * @return String containing an approximate description of s (e.g. "about 2 hours")
97 seconds_to_approximate_hms (int s)
108 ap << (h + 1) << " hours";
120 ap << m << " minutes";
123 ap << s << " seconds";
129 #ifdef DVDOMATIC_POSIX
130 /** @param l Mangled C++ identifier.
131 * @return Demangled version.
136 string::size_type const b = l.find_first_of ("(");
137 if (b == string::npos) {
141 string::size_type const p = l.find_last_of ("+");
142 if (p == string::npos) {
150 string const fn = l.substr (b + 1, p - b - 1);
155 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
160 } catch (std::exception) {
167 /** Write a stacktrace to an ostream.
168 * @param out Stream to write to.
169 * @param levels Number of levels to go up the call stack.
172 stacktrace (ostream& out, int levels)
179 size = backtrace (array, 200);
180 strings = backtrace_symbols (array, size);
183 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
184 out << " " << demangle (strings[i]) << endl;
192 /** @return Version of vobcopy that is on the path (and hence that we will use) */
196 FILE* f = popen ("vobcopy -V 2>&1", "r");
198 throw EncodeError ("could not run vobcopy to check version");
201 string version = "unknown";
205 if (fgets (buf, sizeof (buf), f)) {
208 split (b, s, is_any_of (" "));
209 if (b.size() >= 2 && b[0] == "Vobcopy") {
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) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
231 /** Return a user-readable string summarising the versions of our dependencies */
233 dependency_version_summary ()
236 s << "libopenjpeg " << opj_version () << ", "
237 << "vobcopy " << vobcopy_version() << ", "
238 << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
239 << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
240 << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
241 << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
242 << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
243 << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
244 << MagickVersion << ", "
245 << "libssh " << ssh_version (0) << ", "
246 << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
252 seconds (struct timeval t)
254 return t.tv_sec + (double (t.tv_usec) / 1e6);
258 #ifdef DVDOMATIC_POSIX
260 sigchld_handler (int, siginfo_t* info, void *)
262 #ifndef DVDOMATIC_DISABLE_PLAYER
263 PlayerManager::instance()->child_exited (info->si_pid);
268 /** Call the required functions to set up DVD-o-matic's static arrays, etc. */
272 Format::setup_formats ();
273 DCPContentType::setup_dcp_content_types ();
274 Scaler::setup_scalers ();
275 Filter::setup_filters ();
276 SoundProcessor::setup_sound_processors ();
278 #ifdef DVDOMATIC_POSIX
280 sa.sa_flags = SA_SIGINFO;
281 sigemptyset (&sa.sa_mask);
282 sa.sa_sigaction = sigchld_handler;
283 sigaction (SIGCHLD, &sa, 0);
288 crop_string (Position start, Size size)
291 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
296 split_at_spaces_considering_quotes (string s)
299 bool in_quotes = false;
301 for (string::size_type i = 0; i < s.length(); ++i) {
302 if (s[i] == ' ' && !in_quotes) {
305 } else if (s[i] == '"') {
306 in_quotes = !in_quotes;
317 md5_digest (void const * data, int size)
320 MD5_Init (&md5_context);
321 MD5_Update (&md5_context, data, size);
322 unsigned char digest[MD5_DIGEST_LENGTH];
323 MD5_Final (digest, &md5_context);
326 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
327 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
333 /** @param file File name.
334 * @return MD5 digest of file's contents.
337 md5_digest (string file)
339 ifstream f (file.c_str(), ios::binary);
341 throw OpenFileError (file);
344 f.seekg (0, ios::end);
345 int bytes = f.tellg ();
346 f.seekg (0, ios::beg);
348 int const buffer_size = 64 * 1024;
349 char buffer[buffer_size];
352 MD5_Init (&md5_context);
354 int const t = min (bytes, buffer_size);
356 MD5_Update (&md5_context, buffer, t);
360 unsigned char digest[MD5_DIGEST_LENGTH];
361 MD5_Final (digest, &md5_context);
364 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
365 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
371 /** @param An arbitrary sampling rate.
372 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
375 dcp_audio_sample_rate (int fs)
384 bool operator== (Crop const & a, Crop const & b)
386 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
389 bool operator!= (Crop const & a, Crop const & b)
394 /** @param index Colour LUT index.
395 * @return Human-readable name.
398 colour_lut_index_to_name (int index)
412 : _deadline (_io_service)
413 , _socket (_io_service)
416 _deadline.expires_at (posix_time::pos_infin);
423 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
425 _deadline.expires_at (posix_time::pos_infin);
428 _deadline.async_wait (boost::bind (&Socket::check, this));
431 /** Blocking connect with timeout.
432 * @param endpoint End-point to connect to.
433 * @param timeout Time-out in seconds.
436 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
438 system::error_code ec = asio::error::would_block;
439 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
441 _io_service.run_one();
442 } while (ec == asio::error::would_block);
444 if (ec || !_socket.is_open ()) {
445 throw NetworkError ("connect timed out");
449 /** Blocking write with timeout.
450 * @param data Buffer to write.
451 * @param size Number of bytes to write.
452 * @param timeout Time-out, in seconds.
455 Socket::write (uint8_t const * data, int size, int timeout)
457 _deadline.expires_from_now (posix_time::seconds (timeout));
458 system::error_code ec = asio::error::would_block;
460 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
462 _io_service.run_one ();
463 } while (ec == asio::error::would_block);
466 throw NetworkError ("write timed out");
470 /** Blocking read with timeout.
471 * @param data Buffer to read to.
472 * @param size Number of bytes to read.
473 * @param timeout Time-out, in seconds.
476 Socket::read (uint8_t* data, int size, int timeout)
478 _deadline.expires_from_now (posix_time::seconds (timeout));
479 system::error_code ec = asio::error::would_block;
483 _socket.async_read_some (
484 asio::buffer (data, size),
485 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
489 _io_service.run_one ();
490 } while (ec == asio::error::would_block);
499 /** Mark some data as being `consumed', so that it will not be returned
501 * @param size Amount of data to consume, in bytes.
504 Socket::consume (int size)
506 assert (_buffer_data >= size);
508 _buffer_data -= size;
509 if (_buffer_data > 0) {
510 /* Shift still-valid data to the start of the buffer */
511 memmove (_buffer, _buffer + size, _buffer_data);
515 /** Read a definite amount of data from our socket, and mark
517 * @param data Where to put the data.
518 * @param size Number of bytes to read.
521 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
523 int const from_buffer = min (_buffer_data, size);
524 if (from_buffer > 0) {
525 /* Get data from our buffer */
526 memcpy (data, _buffer, from_buffer);
527 consume (from_buffer);
528 /* Update our output state */
533 /* read() the rest */
535 int const n = read (data, size, timeout);
537 throw NetworkError ("could not read");
545 /** Read as much data as is available, up to some limit.
546 * @param data Where to put the data.
547 * @param size Maximum amount of data to read.
550 Socket::read_indefinite (uint8_t* data, int size, int timeout)
552 assert (size < int (sizeof (_buffer)));
554 /* Amount of extra data we need to read () */
555 int to_read = size - _buffer_data;
556 while (to_read > 0) {
557 /* read as much of it as we can (into our buffer) */
558 int const n = read (_buffer + _buffer_data, to_read, timeout);
560 throw NetworkError ("could not read");
567 assert (_buffer_data >= size);
569 /* copy data into the output buffer */
570 assert (size >= _buffer_data);
571 memcpy (data, _buffer, size);
575 Rect::intersection (Rect const & other) const
577 int const tx = max (x, other.x);
578 int const ty = max (y, other.y);
582 min (x + width, other.x + other.width) - tx,
583 min (y + height, other.y + other.height) - ty
587 /** Round a number up to the nearest multiple of another number.
588 * @param a Number to round.
589 * @param t Multiple to round to.
590 * @return Rounded number.
594 round_up (int a, int t)
600 /** Read a sequence of key / value pairs from a text stream;
601 * the keys are the first words on the line, and the values are
602 * the remainder of the line following the key. Lines beginning
603 * with # are ignored.
604 * @param s Stream to read.
605 * @return key/value pairs.
607 multimap<string, string>
608 read_key_value (istream &s)
610 multimap<string, string> kv;
613 while (getline (s, line)) {
618 if (line[0] == '#') {
622 if (line[line.size() - 1] == '\r') {
623 line = line.substr (0, line.size() - 1);
626 size_t const s = line.find (' ');
627 if (s == string::npos) {
631 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
638 get_required_string (multimap<string, string> const & kv, string k)
640 if (kv.count (k) > 1) {
641 throw StringError ("unexpected multiple keys in key-value set");
644 multimap<string, string>::const_iterator i = kv.find (k);
646 if (i == kv.end ()) {
647 throw StringError (String::compose ("missing key %1 in key-value set", k));
654 get_required_int (multimap<string, string> const & kv, string k)
656 string const v = get_required_string (kv, k);
657 return lexical_cast<int> (v);
661 get_required_float (multimap<string, string> const & kv, string k)
663 string const v = get_required_string (kv, k);
664 return lexical_cast<float> (v);
668 get_optional_string (multimap<string, string> const & kv, string k)
670 if (kv.count (k) > 1) {
671 throw StringError ("unexpected multiple keys in key-value set");
674 multimap<string, string>::const_iterator i = kv.find (k);
675 if (i == kv.end ()) {
683 get_optional_int (multimap<string, string> const & kv, string k)
685 if (kv.count (k) > 1) {
686 throw StringError ("unexpected multiple keys in key-value set");
689 multimap<string, string>::const_iterator i = kv.find (k);
690 if (i == kv.end ()) {
694 return lexical_cast<int> (i->second);