Merge FilmState / Film.
[dcpomatic.git] / src / lib / util.cc
index d12bd3e775a52a32187fa8ee5a4fc0d75d30c92a..90b27f39a6b08b6aede9fb68de0eb71b75cdaf1a 100644 (file)
@@ -35,6 +35,8 @@
 #include <boost/algorithm/string.hpp>
 #include <boost/bind.hpp>
 #include <boost/lambda/lambda.hpp>
+#include <boost/lexical_cast.hpp>
+#include <boost/thread.hpp>
 #include <openjpeg.h>
 #include <openssl/md5.h>
 #include <magick/MagickCore.h>
@@ -55,19 +57,16 @@ extern "C" {
 #include "dcp_content_type.h"
 #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>
-#endif
-
 using namespace std;
 using namespace boost;
 
+thread::id ui_thread;
+
 /** Convert some number of seconds to a string representation
  *  in hours, minutes and seconds.
  *
@@ -192,37 +191,6 @@ stacktrace (ostream& out, int levels)
 }
 #endif
 
-/** @param s Sample format.
- *  @return String representation.
- */
-string
-audio_sample_format_to_string (AVSampleFormat s)
-{
-       /* Our sample format handling is not exactly complete */
-       
-       switch (s) {
-       case AV_SAMPLE_FMT_S16:
-               return "S16";
-       default:
-               break;
-       }
-
-       return "Unknown";
-}
-
-/** @param s String representation of a sample format, as returned from audio_sample_format_to_string().
- *  @return Sample format.
- */
-AVSampleFormat
-audio_sample_format_from_string (string s)
-{
-       if (s == "S16") {
-               return AV_SAMPLE_FMT_S16;
-       }
-
-       return AV_SAMPLE_FMT_NONE;
-}
-
 /** @return Version of vobcopy that is on the path (and hence that we will use) */
 static string
 vobcopy_version ()
@@ -299,7 +267,9 @@ sigchld_handler (int, siginfo_t* info, void *)
 }
 #endif
 
-/** Call the required functions to set up DVD-o-matic's static arrays, etc. */
+/** Call the required functions to set up DVD-o-matic's static arrays, etc.
+ *  Must be called from the UI thread, if there is one.
+ */
 void
 dvdomatic_setup ()
 {
@@ -309,6 +279,8 @@ dvdomatic_setup ()
        Filter::setup_filters ();
        SoundProcessor::setup_sound_processors ();
 
+       ui_thread = this_thread::get_id ();
+
 #ifdef DVDOMATIC_POSIX 
        struct sigaction sa;
        sa.sa_flags = SA_SIGINFO;
@@ -347,28 +319,26 @@ split_at_spaces_considering_quotes (string s)
        return out;
 }
 
-#ifdef DEBUG_HASH
-void
-md5_data (string title, void const * data, int size)
+string
+md5_digest (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);
+       MD5_CTX md5_context;
+       MD5_Init (&md5_context);
+       MD5_Update (&md5_context, data, size);
+       unsigned char digest[MD5_DIGEST_LENGTH];
+       MD5_Final (digest, &md5_context);
        
-       printf ("%s [%d]: ", title.c_str (), size);
-       for (int i = 0; i < int (mhash_get_block_size (MHASH_MD5)); ++i) {
-               printf ("%.2x", hash[i]);
+       stringstream s;
+       for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
+               s << hex << setfill('0') << setw(2) << ((int) digest[i]);
        }
-       printf ("\n");
+
+       return s.str ();
 }
-#endif
 
+/** @param file File name.
+ *  @return MD5 digest of file's contents.
+ */
 string
 md5_digest (string file)
 {
@@ -404,6 +374,9 @@ md5_digest (string file)
        return s.str ();
 }
 
+/** @param An arbitrary sampling rate.
+ *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
+ */
 int
 dcp_audio_sample_rate (int fs)
 {
@@ -424,6 +397,9 @@ 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)
 {
@@ -458,6 +434,10 @@ Socket::check ()
        _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)
 {
@@ -472,6 +452,11 @@ Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint,
        }
 }
 
+/** 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)
 {
@@ -488,6 +473,11 @@ Socket::write (uint8_t const * data, int size, int timeout)
        }
 }
 
+/** 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)
 {
@@ -586,3 +576,175 @@ Socket::read_indefinite (uint8_t* data, int size, int timeout)
        assert (size >= _buffer_data);
        memcpy (data, _buffer, size);
 }
+
+Rect
+Rect::intersection (Rect const & other) const
+{
+       int const tx = max (x, other.x);
+       int const ty = max (y, other.y);
+       
+       return Rect (
+               tx, ty,
+               min (x + width, other.x + other.width) - tx,
+               min (y + height, other.y + other.height) - ty
+               );
+}
+
+/** Round a number up to the nearest multiple of another number.
+ *  @param a Number to round.
+ *  @param t Multiple to round to.
+ *  @return Rounded number.
+ */
+
+int
+round_up (int a, int t)
+{
+       a += (t - 1);
+       return a - (a % t);
+}
+
+/** Read a sequence of key / value pairs from a text stream;
+ *  the keys are the first words on the line, and the values are
+ *  the remainder of the line following the key.  Lines beginning
+ *  with # are ignored.
+ *  @param s Stream to read.
+ *  @return key/value pairs.
+ */
+multimap<string, string>
+read_key_value (istream &s) 
+{
+       multimap<string, string> kv;
+       
+       string line;
+       while (getline (s, line)) {
+               if (line.empty ()) {
+                       continue;
+               }
+               
+               if (line[0] == '#') {
+                       continue;
+               }
+
+               if (line[line.size() - 1] == '\r') {
+                       line = line.substr (0, line.size() - 1);
+               }
+
+               size_t const s = line.find (' ');
+               if (s == string::npos) {
+                       continue;
+               }
+
+               kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
+       }
+
+       return kv;
+}
+
+string
+get_required_string (multimap<string, string> const & kv, string k)
+{
+       if (kv.count (k) > 1) {
+               throw StringError ("unexpected multiple keys in key-value set");
+       }
+
+       multimap<string, string>::const_iterator i = kv.find (k);
+       
+       if (i == kv.end ()) {
+               throw StringError (String::compose ("missing key %1 in key-value set", k));
+       }
+
+       return i->second;
+}
+
+int
+get_required_int (multimap<string, string> const & kv, string k)
+{
+       string const v = get_required_string (kv, k);
+       return lexical_cast<int> (v);
+}
+
+float
+get_required_float (multimap<string, string> const & kv, string k)
+{
+       string const v = get_required_string (kv, k);
+       return lexical_cast<float> (v);
+}
+
+string
+get_optional_string (multimap<string, string> const & kv, string k)
+{
+       if (kv.count (k) > 1) {
+               throw StringError ("unexpected multiple keys in key-value set");
+       }
+
+       multimap<string, string>::const_iterator i = kv.find (k);
+       if (i == kv.end ()) {
+               return "";
+       }
+
+       return i->second;
+}
+
+int
+get_optional_int (multimap<string, string> const & kv, string k)
+{
+       if (kv.count (k) > 1) {
+               throw StringError ("unexpected multiple keys in key-value set");
+       }
+
+       multimap<string, string>::const_iterator i = kv.find (k);
+       if (i == kv.end ()) {
+               return 0;
+       }
+
+       return lexical_cast<int> (i->second);
+}
+
+AudioBuffers::AudioBuffers (int channels, int frames)
+       : _channels (channels)
+       , _frames (frames)
+{
+       _data = new float*[_channels];
+       for (int i = 0; i < _channels; ++i) {
+               _data[i] = new float[frames];
+       }
+}
+
+AudioBuffers::~AudioBuffers ()
+{
+       for (int i = 0; i < _channels; ++i) {
+               delete[] _data[i];
+       }
+
+       delete[] _data;
+}
+
+float*
+AudioBuffers::data (int c) const
+{
+       assert (c >= 0 && c < _channels);
+       return _data[c];
+}
+       
+void
+AudioBuffers::set_frames (int f)
+{
+       assert (f <= _frames);
+       _frames = f;
+}
+
+void
+AudioBuffers::make_silent ()
+{
+       for (int i = 0; i < _channels; ++i) {
+               for (int j = 0; j < _frames; ++j) {
+                       _data[i][j] = 0;
+               }
+       }
+}
+
+void
+ensure_ui_thread ()
+{
+       assert (this_thread::get_id() == ui_thread);
+}