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>
39 #include <boost/thread.hpp>
40 #include <boost/filesystem.hpp>
42 #include <openssl/md5.h>
43 #include <magick/MagickCore.h>
44 #include <magick/version.h>
45 #include <libdcp/version.h>
47 #include <libavcodec/avcodec.h>
48 #include <libavformat/avformat.h>
49 #include <libswscale/swscale.h>
50 #include <libavfilter/avfiltergraph.h>
51 #include <libpostproc/postprocess.h>
52 #include <libavutil/pixfmt.h>
55 #include "exceptions.h"
58 #include "dcp_content_type.h"
61 #include "sound_processor.h"
62 #ifndef DVDOMATIC_DISABLE_PLAYER
63 #include "player_manager.h"
67 using namespace boost;
71 /** Convert some number of seconds to a string representation
72 * in hours, minutes and seconds.
75 * @return String of the form H:M:S (where H is hours, M
76 * is minutes and S is seconds).
79 seconds_to_hms (int s)
89 hms << setfill ('0') << m << ":";
91 hms << setfill ('0') << s;
96 /** @param s Number of seconds.
97 * @return String containing an approximate description of s (e.g. "about 2 hours")
100 seconds_to_approximate_hms (int s)
111 ap << (h + 1) << " hours";
123 ap << m << " minutes";
126 ap << s << " seconds";
132 #ifdef DVDOMATIC_POSIX
133 /** @param l Mangled C++ identifier.
134 * @return Demangled version.
139 string::size_type const b = l.find_first_of ("(");
140 if (b == string::npos) {
144 string::size_type const p = l.find_last_of ("+");
145 if (p == string::npos) {
153 string const fn = l.substr (b + 1, p - b - 1);
158 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
163 } catch (std::exception) {
170 /** Write a stacktrace to an ostream.
171 * @param out Stream to write to.
172 * @param levels Number of levels to go up the call stack.
175 stacktrace (ostream& out, int levels)
182 size = backtrace (array, 200);
183 strings = backtrace_symbols (array, size);
186 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
187 out << " " << demangle (strings[i]) << endl;
195 /** @return Version of vobcopy that is on the path (and hence that we will use) */
199 FILE* f = popen ("vobcopy -V 2>&1", "r");
201 throw EncodeError ("could not run vobcopy to check version");
204 string version = "unknown";
208 if (fgets (buf, sizeof (buf), f)) {
211 split (b, s, is_any_of (" "));
212 if (b.size() >= 2 && b[0] == "Vobcopy") {
223 /** @param v Version as used by FFmpeg.
224 * @return A string representation of v.
227 ffmpeg_version_to_string (int v)
230 s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
234 /** Return a user-readable string summarising the versions of our dependencies */
236 dependency_version_summary ()
239 s << "libopenjpeg " << opj_version () << ", "
240 << "vobcopy " << vobcopy_version() << ", "
241 << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
242 << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
243 << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
244 << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
245 << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
246 << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
247 << MagickVersion << ", "
248 << "libssh " << ssh_version (0) << ", "
249 << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
255 seconds (struct timeval t)
257 return t.tv_sec + (double (t.tv_usec) / 1e6);
261 #ifdef DVDOMATIC_POSIX
263 sigchld_handler (int, siginfo_t* info, void *)
265 #ifndef DVDOMATIC_DISABLE_PLAYER
266 PlayerManager::instance()->child_exited (info->si_pid);
271 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
272 * Must be called from the UI thread, if there is one.
277 Format::setup_formats ();
278 DCPContentType::setup_dcp_content_types ();
279 Scaler::setup_scalers ();
280 Filter::setup_filters ();
281 SoundProcessor::setup_sound_processors ();
283 ui_thread = this_thread::get_id ();
285 #ifdef DVDOMATIC_POSIX
287 sa.sa_flags = SA_SIGINFO;
288 sigemptyset (&sa.sa_mask);
289 sa.sa_sigaction = sigchld_handler;
290 sigaction (SIGCHLD, &sa, 0);
295 crop_string (Position start, Size size)
298 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
303 split_at_spaces_considering_quotes (string s)
306 bool in_quotes = false;
308 for (string::size_type i = 0; i < s.length(); ++i) {
309 if (s[i] == ' ' && !in_quotes) {
312 } else if (s[i] == '"') {
313 in_quotes = !in_quotes;
324 md5_digest (void const * data, int size)
327 MD5_Init (&md5_context);
328 MD5_Update (&md5_context, data, size);
329 unsigned char digest[MD5_DIGEST_LENGTH];
330 MD5_Final (digest, &md5_context);
333 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
334 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
340 /** @param file File name.
341 * @return MD5 digest of file's contents.
344 md5_digest (string file)
346 ifstream f (file.c_str(), ios::binary);
348 throw OpenFileError (file);
351 f.seekg (0, ios::end);
352 int bytes = f.tellg ();
353 f.seekg (0, ios::beg);
355 int const buffer_size = 64 * 1024;
356 char buffer[buffer_size];
359 MD5_Init (&md5_context);
361 int const t = min (bytes, buffer_size);
363 MD5_Update (&md5_context, buffer, t);
367 unsigned char digest[MD5_DIGEST_LENGTH];
368 MD5_Final (digest, &md5_context);
371 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
372 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
379 dcp_frame_rate (float fps)
383 dfr.run_fast = (fps != rint (fps));
384 dfr.frames_per_second = rint (fps);
387 /* XXX: somewhat arbitrary */
389 dfr.frames_per_second = 25;
396 /** @param An arbitrary sampling rate.
397 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
400 dcp_audio_sample_rate (int fs)
409 bool operator== (Size const & a, Size const & b)
411 return (a.width == b.width && a.height == b.height);
414 bool operator== (Crop const & a, Crop const & b)
416 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
419 bool operator!= (Crop const & a, Crop const & b)
424 /** @param index Colour LUT index.
425 * @return Human-readable name.
428 colour_lut_index_to_name (int index)
442 : _deadline (_io_service)
443 , _socket (_io_service)
446 _deadline.expires_at (posix_time::pos_infin);
453 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
455 _deadline.expires_at (posix_time::pos_infin);
458 _deadline.async_wait (boost::bind (&Socket::check, this));
461 /** Blocking connect with timeout.
462 * @param endpoint End-point to connect to.
463 * @param timeout Time-out in seconds.
466 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
468 system::error_code ec = asio::error::would_block;
469 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
471 _io_service.run_one();
472 } while (ec == asio::error::would_block);
474 if (ec || !_socket.is_open ()) {
475 throw NetworkError ("connect timed out");
479 /** Blocking write with timeout.
480 * @param data Buffer to write.
481 * @param size Number of bytes to write.
482 * @param timeout Time-out, in seconds.
485 Socket::write (uint8_t const * data, int size, int timeout)
487 _deadline.expires_from_now (posix_time::seconds (timeout));
488 system::error_code ec = asio::error::would_block;
490 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
492 _io_service.run_one ();
493 } while (ec == asio::error::would_block);
496 throw NetworkError ("write timed out");
500 /** Blocking read with timeout.
501 * @param data Buffer to read to.
502 * @param size Number of bytes to read.
503 * @param timeout Time-out, in seconds.
506 Socket::read (uint8_t* data, int size, int timeout)
508 _deadline.expires_from_now (posix_time::seconds (timeout));
509 system::error_code ec = asio::error::would_block;
513 _socket.async_read_some (
514 asio::buffer (data, size),
515 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
519 _io_service.run_one ();
520 } while (ec == asio::error::would_block);
529 /** Mark some data as being `consumed', so that it will not be returned
531 * @param size Amount of data to consume, in bytes.
534 Socket::consume (int size)
536 assert (_buffer_data >= size);
538 _buffer_data -= size;
539 if (_buffer_data > 0) {
540 /* Shift still-valid data to the start of the buffer */
541 memmove (_buffer, _buffer + size, _buffer_data);
545 /** Read a definite amount of data from our socket, and mark
547 * @param data Where to put the data.
548 * @param size Number of bytes to read.
551 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
553 int const from_buffer = min (_buffer_data, size);
554 if (from_buffer > 0) {
555 /* Get data from our buffer */
556 memcpy (data, _buffer, from_buffer);
557 consume (from_buffer);
558 /* Update our output state */
563 /* read() the rest */
565 int const n = read (data, size, timeout);
567 throw NetworkError ("could not read");
575 /** Read as much data as is available, up to some limit.
576 * @param data Where to put the data.
577 * @param size Maximum amount of data to read.
580 Socket::read_indefinite (uint8_t* data, int size, int timeout)
582 assert (size < int (sizeof (_buffer)));
584 /* Amount of extra data we need to read () */
585 int to_read = size - _buffer_data;
586 while (to_read > 0) {
587 /* read as much of it as we can (into our buffer) */
588 int const n = read (_buffer + _buffer_data, to_read, timeout);
590 throw NetworkError ("could not read");
597 assert (_buffer_data >= size);
599 /* copy data into the output buffer */
600 assert (size >= _buffer_data);
601 memcpy (data, _buffer, size);
605 Rect::intersection (Rect const & other) const
607 int const tx = max (x, other.x);
608 int const ty = max (y, other.y);
612 min (x + width, other.x + other.width) - tx,
613 min (y + height, other.y + other.height) - ty
617 /** Round a number up to the nearest multiple of another number.
618 * @param a Number to round.
619 * @param t Multiple to round to.
620 * @return Rounded number.
624 stride_round_up (int c, int const * stride, int t)
626 int const a = stride[c] + (t - 1);
631 stride_lookup (int c, int const * stride)
636 /** Read a sequence of key / value pairs from a text stream;
637 * the keys are the first words on the line, and the values are
638 * the remainder of the line following the key. Lines beginning
639 * with # are ignored.
640 * @param s Stream to read.
641 * @return key/value pairs.
643 multimap<string, string>
644 read_key_value (istream &s)
646 multimap<string, string> kv;
649 while (getline (s, line)) {
654 if (line[0] == '#') {
658 if (line[line.size() - 1] == '\r') {
659 line = line.substr (0, line.size() - 1);
662 size_t const s = line.find (' ');
663 if (s == string::npos) {
667 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
674 get_required_string (multimap<string, string> const & kv, string k)
676 if (kv.count (k) > 1) {
677 throw StringError ("unexpected multiple keys in key-value set");
680 multimap<string, string>::const_iterator i = kv.find (k);
682 if (i == kv.end ()) {
683 throw StringError (String::compose ("missing key %1 in key-value set", k));
690 get_required_int (multimap<string, string> const & kv, string k)
692 string const v = get_required_string (kv, k);
693 return lexical_cast<int> (v);
697 get_required_float (multimap<string, string> const & kv, string k)
699 string const v = get_required_string (kv, k);
700 return lexical_cast<float> (v);
704 get_optional_string (multimap<string, string> const & kv, string k)
706 if (kv.count (k) > 1) {
707 throw StringError ("unexpected multiple keys in key-value set");
710 multimap<string, string>::const_iterator i = kv.find (k);
711 if (i == kv.end ()) {
719 get_optional_int (multimap<string, string> const & kv, string k)
721 if (kv.count (k) > 1) {
722 throw StringError ("unexpected multiple keys in key-value set");
725 multimap<string, string>::const_iterator i = kv.find (k);
726 if (i == kv.end ()) {
730 return lexical_cast<int> (i->second);
733 AudioBuffers::AudioBuffers (int channels, int frames)
734 : _channels (channels)
736 , _allocated_frames (frames)
738 _data = new float*[_channels];
739 for (int i = 0; i < _channels; ++i) {
740 _data[i] = new float[frames];
744 AudioBuffers::AudioBuffers (AudioBuffers const & other)
745 : _channels (other._channels)
746 , _frames (other._frames)
747 , _allocated_frames (other._frames)
749 _data = new float*[_channels];
750 for (int i = 0; i < _channels; ++i) {
751 _data[i] = new float[_frames];
752 memcpy (_data[i], other._data[i], _frames * sizeof (float));
756 AudioBuffers::~AudioBuffers ()
758 for (int i = 0; i < _channels; ++i) {
766 AudioBuffers::data (int c) const
768 assert (c >= 0 && c < _channels);
773 AudioBuffers::set_frames (int f)
775 assert (f <= _allocated_frames);
780 AudioBuffers::make_silent ()
782 for (int i = 0; i < _channels; ++i) {
783 for (int j = 0; j < _frames; ++j) {
790 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
792 assert (from->channels() == channels());
794 for (int i = 0; i < _channels; ++i) {
795 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
800 AudioBuffers::move (int from, int to, int frames)
807 assert (from < _frames);
809 assert (to < _frames);
811 assert (frames <= _frames);
812 assert ((from + frames) <= _frames);
813 assert ((to + frames) <= _frames);
815 for (int i = 0; i < _channels; ++i) {
816 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
823 assert (this_thread::get_id() == ui_thread);
827 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
829 return ((int64_t) v * audio_sample_rate / frames_per_second);
833 still_image_file (string f)
835 #if BOOST_FILESYSTEM_VERSION == 3
836 string ext = boost::filesystem::path(f).extension().string();
838 string ext = boost::filesystem::path(f).extension();
841 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
843 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");