Improve logging slightly.
[dcpomatic.git] / src / lib / util.cc
index 6179eedaced5f04d7c1511c9c562044eebe01649..b69581eba56a1e8b282f75cff6ad02371d737aac 100644 (file)
@@ -37,6 +37,7 @@
 #include <boost/lambda/lambda.hpp>
 #include <boost/lexical_cast.hpp>
 #include <boost/thread.hpp>
+#include <boost/filesystem.hpp>
 #include <openjpeg.h>
 #include <openssl/md5.h>
 #include <magick/MagickCore.h>
@@ -238,6 +239,10 @@ dvdomatic_setup ()
        ui_thread = this_thread::get_id ();
 }
 
+/** @param start Start position for the crop within the image.
+ *  @param size Size of the cropped area.
+ *  @return FFmpeg crop filter string.
+ */
 string
 crop_string (Position start, Size size)
 {
@@ -246,6 +251,9 @@ crop_string (Position start, Size size)
        return s.str ();
 }
 
+/** @param s A string.
+ *  @return Parts of the string split at spaces, except when a space is within quotation marks.
+ */
 vector<string>
 split_at_spaces_considering_quotes (string s)
 {
@@ -322,6 +330,9 @@ md5_digest (string file)
        return s.str ();
 }
 
+/** @param fps Arbitrary frames-per-second value.
+ *  @return DCPFrameRate for this frames-per-second.
+ */
 DCPFrameRate
 dcp_frame_rate (float fps)
 {
@@ -548,6 +559,9 @@ Socket::read_indefinite (uint8_t* data, int size, int timeout)
        memcpy (data, _buffer, size);
 }
 
+/** @param other A Rect.
+ *  @return The intersection of this with `other'.
+ */
 Rect
 Rect::intersection (Rect const & other) const
 {
@@ -566,14 +580,19 @@ Rect::intersection (Rect const & other) const
  *  @param t Multiple to round to.
  *  @return Rounded number.
  */
-
 int
-round_up (int a, int t)
+stride_round_up (int c, int const * stride, int t)
 {
-       a += (t - 1);
+       int const a = stride[c] + (t - 1);
        return a - (a % t);
 }
 
+int
+stride_lookup (int c, int const * stride)
+{
+       return stride[c];
+}
+
 /** 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
@@ -591,7 +610,7 @@ read_key_value (istream &s)
                if (line.empty ()) {
                        continue;
                }
-               
+
                if (line[0] == '#') {
                        continue;
                }
@@ -671,6 +690,10 @@ get_optional_int (multimap<string, string> const & kv, string k)
        return lexical_cast<int> (i->second);
 }
 
+/** Construct an AudioBuffers.  Audio data is undefined after this constructor.
+ *  @param channels Number of channels.
+ *  @param frames Number of frames to reserve space for.
+ */
 AudioBuffers::AudioBuffers (int channels, int frames)
        : _channels (channels)
        , _frames (frames)
@@ -682,6 +705,9 @@ AudioBuffers::AudioBuffers (int channels, int frames)
        }
 }
 
+/** Copy constructor.
+ *  @param other Other AudioBuffers; data is copied.
+ */
 AudioBuffers::AudioBuffers (AudioBuffers const & other)
        : _channels (other._channels)
        , _frames (other._frames)
@@ -694,6 +720,7 @@ AudioBuffers::AudioBuffers (AudioBuffers const & other)
        }
 }
 
+/** AudioBuffers destructor */
 AudioBuffers::~AudioBuffers ()
 {
        for (int i = 0; i < _channels; ++i) {
@@ -703,13 +730,20 @@ AudioBuffers::~AudioBuffers ()
        delete[] _data;
 }
 
+/** @param c Channel index.
+ *  @return Buffer for this channel.
+ */
 float*
 AudioBuffers::data (int c) const
 {
        assert (c >= 0 && c < _channels);
        return _data[c];
 }
-       
+
+/** Set the number of frames that these AudioBuffers will report themselves
+ *  as having.
+ *  @param f Frames; must be less than or equal to the number of allocated frames.
+ */
 void
 AudioBuffers::set_frames (int f)
 {
@@ -717,26 +751,54 @@ AudioBuffers::set_frames (int f)
        _frames = f;
 }
 
+/** Make all samples on all channels silent */
 void
 AudioBuffers::make_silent ()
 {
        for (int i = 0; i < _channels; ++i) {
-               for (int j = 0; j < _frames; ++j) {
-                       _data[i][j] = 0;
-               }
+               make_silent (i);
        }
 }
 
+/** Make all samples on a given channel silent.
+ *  @param c Channel.
+ */
+void
+AudioBuffers::make_silent (int c)
+{
+       assert (c >= 0 && c < _channels);
+       
+       for (int i = 0; i < _frames; ++i) {
+               _data[c][i] = 0;
+       }
+}
+
+/** Copy data from another AudioBuffers to this one.  All channels are copied.
+ *  @param from AudioBuffers to copy from; must have the same number of channels as this.
+ *  @param frames_to_copy Number of frames to copy.
+ *  @param read_offset Offset to read from in `from'.
+ *  @param write_offset Offset to write to in `to'.
+ */
 void
 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 {
        assert (from->channels() == channels());
 
+       assert (from);
+       assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
+       assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
+
        for (int i = 0; i < _channels; ++i) {
                memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
        }
 }
 
+/** Move audio data around.
+ *  @param from Offset to move from.
+ *  @param to Offset to move to.
+ *  @param frames Number of frames to move.
+ */
+    
 void
 AudioBuffers::move (int from, int to, int frames)
 {
@@ -758,14 +820,37 @@ AudioBuffers::move (int from, int to, int frames)
        }
 }
 
+/** Trip an assert if the caller is not in the UI thread */
 void
 ensure_ui_thread ()
 {
        assert (this_thread::get_id() == ui_thread);
 }
 
+/** @param v Source video frame.
+ *  @param audio_sample_rate Source audio sample rate.
+ *  @param frames_per_second Number of video frames per second.
+ *  @return Equivalent number of audio frames for `v'.
+ */
 int64_t
 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 {
        return ((int64_t) v * audio_sample_rate / frames_per_second);
 }
+
+/** @param f Filename.
+ *  @return true if this file is a still image, false if it is something else.
+ */
+bool
+still_image_file (string f)
+{
+#if BOOST_FILESYSTEM_VERSION == 3
+       string ext = boost::filesystem::path(f).extension().string();
+#else
+       string ext = boost::filesystem::path(f).extension();
+#endif
+
+       transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
+       
+       return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");
+}