Some doxygen documentation improvements.
[dcpomatic.git] / src / lib / util.cc
index 7388539cdf68080ead8e43a31bddea226acb313e..73222083a81c5ee5adf18d2f67c613c2bd938449 100644 (file)
 #include <sstream>
 #include <iomanip>
 #include <iostream>
+#include <fstream>
 #ifdef DVDOMATIC_POSIX
 #include <execinfo.h>
 #include <cxxabi.h>
-#include <sys/types.h> 
-#include <sys/socket.h>
 #endif
 #include <libssh/libssh.h>
 #include <signal.h>
 #include <boost/algorithm/string.hpp>
+#include <boost/bind.hpp>
+#include <boost/lambda/lambda.hpp>
 #include <openjpeg.h>
+#include <openssl/md5.h>
 #include <magick/MagickCore.h>
 #include <magick/version.h>
 #include <libdcp/version.h>
@@ -54,7 +56,10 @@ extern "C" {
 #include "filter.h"
 #include "screen.h"
 #include "film_state.h"
+#include "sound_processor.h"
+#ifndef DVDOMATIC_DISABLE_PLAYER
 #include "player_manager.h"
+#endif
 
 #ifdef DEBUG_HASH
 #include <mhash.h>
@@ -277,43 +282,257 @@ dependency_version_summary ()
        return s.str ();
 }
 
+double
+seconds (struct timeval t)
+{
+       return t.tv_sec + (double (t.tv_usec) / 1e6);
+}
+
+
 #ifdef DVDOMATIC_POSIX
-/** Write some data to a socket.
- *  @param fd Socket file descriptor.
- *  @param data Data.
- *  @param size Amount to write, in bytes.
- */
 void
-socket_write (int fd, uint8_t const * data, int size)
+sigchld_handler (int, siginfo_t* info, void *)
+{
+#ifndef DVDOMATIC_DISABLE_PLAYER       
+       PlayerManager::instance()->child_exited (info->si_pid);
+#endif 
+}
+#endif
+
+/** Call the required functions to set up DVD-o-matic's static arrays, etc. */
+void
+dvdomatic_setup ()
+{
+       Format::setup_formats ();
+       DCPContentType::setup_dcp_content_types ();
+       Scaler::setup_scalers ();
+       Filter::setup_filters ();
+       SoundProcessor::setup_sound_processors ();
+
+#ifdef DVDOMATIC_POSIX 
+       struct sigaction sa;
+       sa.sa_flags = SA_SIGINFO;
+       sigemptyset (&sa.sa_mask);
+       sa.sa_sigaction = sigchld_handler;
+       sigaction (SIGCHLD, &sa, 0);
+#endif 
+}
+
+string
+crop_string (Position start, Size size)
+{
+       stringstream s;
+       s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
+       return s.str ();
+}
+
+vector<string>
+split_at_spaces_considering_quotes (string s)
 {
-       uint8_t const * p = data;
-       while (size) {
-               int const n = send (fd, p, size, MSG_NOSIGNAL);
-               if (n < 0) {
-                       stringstream s;
-                       s << "could not write (" << strerror (errno) << ")";
-                       throw NetworkError (s.str ());
+       vector<string> out;
+       bool in_quotes = false;
+       string c;
+       for (string::size_type i = 0; i < s.length(); ++i) {
+               if (s[i] == ' ' && !in_quotes) {
+                       out.push_back (c);
+                       c = "";
+               } else if (s[i] == '"') {
+                       in_quotes = !in_quotes;
+               } else {
+                       c += s[i];
                }
+       }
 
-               size -= n;
-               p += n;
+       out.push_back (c);
+       return out;
+}
+
+#ifdef DEBUG_HASH
+void
+md5_data (string title, void const * data, int size)
+{
+       MHASH ht = mhash_init (MHASH_MD5);
+       if (ht == MHASH_FAILED) {
+               throw EncodeError ("could not create hash thread");
+       }
+
+       mhash (ht, data, size);
+       
+       uint8_t hash[16];
+       mhash_deinit (ht, hash);
+       
+       printf ("%s [%d]: ", title.c_str (), size);
+       for (int i = 0; i < int (mhash_get_block_size (MHASH_MD5)); ++i) {
+               printf ("%.2x", hash[i]);
        }
+       printf ("\n");
 }
 #endif
 
-double
-seconds (struct timeval t)
+/** @param file File name.
+ *  @return MD5 digest of file's contents.
+ */
+string
+md5_digest (string file)
 {
-       return t.tv_sec + (double (t.tv_usec) / 1e6);
+       ifstream f (file.c_str(), ios::binary);
+       if (!f.good ()) {
+               throw OpenFileError (file);
+       }
+       
+       f.seekg (0, ios::end);
+       int bytes = f.tellg ();
+       f.seekg (0, ios::beg);
+
+       int const buffer_size = 64 * 1024;
+       char buffer[buffer_size];
+
+       MD5_CTX md5_context;
+       MD5_Init (&md5_context);
+       while (bytes > 0) {
+               int const t = min (bytes, buffer_size);
+               f.read (buffer, t);
+               MD5_Update (&md5_context, buffer, t);
+               bytes -= t;
+       }
+
+       unsigned char digest[MD5_DIGEST_LENGTH];
+       MD5_Final (digest, &md5_context);
+
+       stringstream s;
+       for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
+               s << hex << setfill('0') << setw(2) << ((int) digest[i]);
+       }
+
+       return s.str ();
 }
 
-#ifdef DVDOMATIC_POSIX
-/** @param fd File descriptor to read from */
-SocketReader::SocketReader (int fd)
-       : _fd (fd)
+/** @param An arbitrary sampling rate.
+ *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
+ */
+int
+dcp_audio_sample_rate (int fs)
+{
+       if (fs <= 48000) {
+               return 48000;
+       }
+
+       return 96000;
+}
+
+bool operator== (Crop const & a, Crop const & b)
+{
+       return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
+}
+
+bool operator!= (Crop const & a, Crop const & b)
+{
+       return !(a == b);
+}
+
+/** @param index Colour LUT index.
+ *  @return Human-readable name.
+ */
+string
+colour_lut_index_to_name (int index)
+{
+       switch (index) {
+       case 0:
+               return "sRGB";
+       case 1:
+               return "Rec 709";
+       }
+
+       assert (false);
+       return "";
+}
+
+Socket::Socket ()
+       : _deadline (_io_service)
+       , _socket (_io_service)
        , _buffer_data (0)
 {
+       _deadline.expires_at (posix_time::pos_infin);
+       check ();
+}
+
+void
+Socket::check ()
+{
+       if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
+               _socket.close ();
+               _deadline.expires_at (posix_time::pos_infin);
+       }
+
+       _deadline.async_wait (boost::bind (&Socket::check, this));
+}
+
+/** Blocking connect with timeout.
+ *  @param endpoint End-point to connect to.
+ *  @param timeout Time-out in seconds.
+ */
+void
+Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
+{
+       system::error_code ec = asio::error::would_block;
+       _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
+       do {
+               _io_service.run_one();
+       } while (ec == asio::error::would_block);
+
+       if (ec || !_socket.is_open ()) {
+               throw NetworkError ("connect timed out");
+       }
+}
+
+/** Blocking write with timeout.
+ *  @param data Buffer to write.
+ *  @param size Number of bytes to write.
+ *  @param timeout Time-out, in seconds.
+ */
+void
+Socket::write (uint8_t const * data, int size, int timeout)
+{
+       _deadline.expires_from_now (posix_time::seconds (timeout));
+       system::error_code ec = asio::error::would_block;
+
+       asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
+       do {
+               _io_service.run_one ();
+       } while (ec == asio::error::would_block);
+
+       if (ec) {
+               throw NetworkError ("write timed out");
+       }
+}
+
+/** Blocking read with timeout.
+ *  @param data Buffer to read to.
+ *  @param size Number of bytes to read.
+ *  @param timeout Time-out, in seconds.
+ */
+int
+Socket::read (uint8_t* data, int size, int timeout)
+{
+       _deadline.expires_from_now (posix_time::seconds (timeout));
+       system::error_code ec = asio::error::would_block;
+
+       int amount_read = 0;
 
+       _socket.async_read_some (
+               asio::buffer (data, size),
+               (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
+               );
+
+       do {
+               _io_service.run_one ();
+       } while (ec == asio::error::would_block);
+       
+       if (ec) {
+               amount_read = 0;
+       }
+
+       return amount_read;
 }
 
 /** Mark some data as being `consumed', so that it will not be returned
@@ -321,7 +540,7 @@ SocketReader::SocketReader (int fd)
  *  @param size Amount of data to consume, in bytes.
  */
 void
-SocketReader::consume (int size)
+Socket::consume (int size)
 {
        assert (_buffer_data >= size);
        
@@ -338,7 +557,7 @@ SocketReader::consume (int size)
  *  @param size Number of bytes to read.
  */
 void
-SocketReader::read_definite_and_consume (uint8_t* data, int size)
+Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
 {
        int const from_buffer = min (_buffer_data, size);
        if (from_buffer > 0) {
@@ -352,7 +571,7 @@ SocketReader::read_definite_and_consume (uint8_t* data, int size)
 
        /* read() the rest */
        while (size > 0) {
-               int const n = ::read (_fd, data, size);
+               int const n = read (data, size, timeout);
                if (n <= 0) {
                        throw NetworkError ("could not read");
                }
@@ -367,7 +586,7 @@ SocketReader::read_definite_and_consume (uint8_t* data, int size)
  *  @param size Maximum amount of data to read.
  */
 void
-SocketReader::read_indefinite (uint8_t* data, int size)
+Socket::read_indefinite (uint8_t* data, int size, int timeout)
 {
        assert (size < int (sizeof (_buffer)));
 
@@ -375,7 +594,7 @@ SocketReader::read_indefinite (uint8_t* data, int size)
        int to_read = size - _buffer_data;
        while (to_read > 0) {
                /* read as much of it as we can (into our buffer) */
-               int const n = ::read (_fd, _buffer + _buffer_data, to_read);
+               int const n = read (_buffer + _buffer_data, to_read, timeout);
                if (n <= 0) {
                        throw NetworkError ("could not read");
                }
@@ -390,82 +609,3 @@ SocketReader::read_indefinite (uint8_t* data, int size)
        assert (size >= _buffer_data);
        memcpy (data, _buffer, size);
 }
-#endif
-
-#ifdef DVDOMATIC_POSIX
-void
-sigchld_handler (int, siginfo_t* info, void *)
-{
-       PlayerManager::instance()->child_exited (info->si_pid);
-}
-#endif
-
-/** Call the required functions to set up DVD-o-matic's static arrays, etc. */
-void
-dvdomatic_setup ()
-{
-       Format::setup_formats ();
-       DCPContentType::setup_dcp_content_types ();
-       Scaler::setup_scalers ();
-       Filter::setup_filters ();
-
-#ifdef DVDOMATIC_POSIX 
-       struct sigaction sa;
-       sa.sa_flags = SA_SIGINFO;
-       sigemptyset (&sa.sa_mask);
-       sa.sa_sigaction = sigchld_handler;
-       sigaction (SIGCHLD, &sa, 0);
-#endif 
-}
-
-string
-crop_string (Position start, Size size)
-{
-       stringstream s;
-       s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
-       return s.str ();
-}
-
-vector<string>
-split_at_spaces_considering_quotes (string s)
-{
-       vector<string> out;
-       bool in_quotes = false;
-       string c;
-       for (string::size_type i = 0; i < s.length(); ++i) {
-               if (s[i] == ' ' && !in_quotes) {
-                       out.push_back (c);
-                       c = "";
-               } else if (s[i] == '"') {
-                       in_quotes = !in_quotes;
-               } else {
-                       c += s[i];
-               }
-       }
-
-       out.push_back (c);
-       return out;
-}
-
-#ifdef DEBUG_HASH
-void
-md5_data (string title, void const * data, int size)
-{
-       MHASH ht = mhash_init (MHASH_MD5);
-       if (ht == MHASH_FAILED) {
-               throw EncodeError ("could not create hash thread");
-       }
-
-       mhash (ht, data, size);
-       
-       uint8_t hash[16];
-       mhash_deinit (ht, hash);
-       
-       printf ("%s [%d]: ", title.c_str (), size);
-       for (int i = 0; i < int (mhash_get_block_size (MHASH_MD5)); ++i) {
-               printf ("%.2x", hash[i]);
-       }
-       printf ("\n");
-}
-#endif
-