Pad silence for things that already have at least some audio.
[dcpomatic.git] / src / lib / util.h
index f87328dba5b382ac5953fa0e25399b1e91755396..c9e5bef16c0388c34ecbf50182b6ce4d90ac44c9 100644 (file)
@@ -29,6 +29,9 @@
 #include <vector>
 #include <boost/shared_ptr.hpp>
 #include <boost/asio.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <libdcp/util.h>
 extern "C" {
 #include <libavcodec/avcodec.h>
 #include <libavfilter/avfilter.h>
@@ -41,7 +44,13 @@ extern "C" {
 #define TIMING(...)
 #endif
 
+#undef check
+
+/** The maximum number of audio channels that we can cope with */
+#define MAX_AUDIO_CHANNELS 6
+
 class Scaler;
+class Film;
 
 extern std::string seconds_to_hms (int);
 extern std::string seconds_to_approximate_hms (int);
@@ -49,52 +58,63 @@ extern void stacktrace (std::ostream &, int);
 extern std::string dependency_version_summary ();
 extern double seconds (struct timeval);
 extern void dvdomatic_setup ();
+extern void dvdomatic_setup_gettext_i18n (std::string);
 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
 extern std::string md5_digest (std::string);
 extern std::string md5_digest (void const *, int);
 extern void ensure_ui_thread ();
+extern std::string audio_channel_name (int);
+#ifdef DVDOMATIC_WINDOWS
+extern boost::filesystem::path mo_path ();
+#endif
 
 typedef int SourceFrame;
 
-struct DCPFrameRate
+struct FrameRateConversion
 {
-       int frames_per_second;
-       int skip;
-       bool run_fast;
-};
-
-enum ContentType {
-       STILL,
-       VIDEO
-};
-
-/** @class Size
- *  @brief Representation of the size of something */
-struct Size
-{
-       /** Construct a zero Size */
-       Size ()
-               : width (0)
-               , height (0)
-       {}
+       FrameRateConversion (float, int);
+
+       /** @return factor by which to multiply a source frame rate
+           to get the effective rate after any skip or repeat has happened.
+       */
+       float factor () const {
+               if (skip) {
+                       return 0.5;
+               } else if (repeat) {
+                       return 2;
+               }
+
+               return 1;
+       }
 
-       /** @param w Width.
-        *  @param h Height.
+       /** true to skip every other frame */
+       bool skip;
+       /** true to repeat every frame once */
+       bool repeat;
+       /** true if this DCP will run its video faster or slower than the source
+        *  without taking into account `repeat' nor `skip'.
+        *  (e.g. change_speed will be true if
+        *          source is 29.97fps, DCP is 30fps
+        *          source is 14.50fps, DCP is 30fps
+        *  but not if
+        *          source is 15.00fps, DCP is 30fps
+        *          source is 12.50fps, DCP is 25fps)
         */
-       Size (int w, int h)
-               : width (w)
-               , height (h)
-       {}
+       bool change_speed;
 
-       /** width */
-       int width;
-       /** height */
-       int height;
+       std::string description;
 };
 
-extern bool operator== (Size const & a, Size const & b);
+int best_dcp_frame_rate (float);
+
+enum ContentType {
+       STILL, ///< content is still images
+       VIDEO  ///< content is a video
+};
 
-/** A description of the crop of an image or video. */
+/** @struct Crop
+ *  @brief A description of the crop of an image or video.
+ */
 struct Crop
 {
        Crop () : left (0), right (0), top (0), bottom (0) {}
@@ -112,7 +132,9 @@ struct Crop
 extern bool operator== (Crop const & a, Crop const & b);
 extern bool operator!= (Crop const & a, Crop const & b);
 
-/** A position */
+/** @struct Position
+ *  @brief A position.
+ */
 struct Position
 {
        Position ()
@@ -131,7 +153,12 @@ struct Position
        int y;
 };
 
-/** A rectangle */
+namespace dvdomatic
+{
+       
+/** @struct Rect
+ *  @brief A rectangle.
+ */
 struct Rect
 {
        Rect ()
@@ -157,18 +184,20 @@ struct Rect
                return Position (x, y);
        }
 
-       Size size () const {
-               return Size (width, height);
+       libdcp::Size size () const {
+               return libdcp::Size (width, height);
        }
 
        Rect intersection (Rect const & other) const;
 };
 
-extern std::string crop_string (Position, Size);
+}
+
+extern std::string crop_string (Position, libdcp::Size);
 extern int dcp_audio_sample_rate (int);
-extern DCPFrameRate dcp_frame_rate (float);
 extern std::string colour_lut_index_to_name (int index);
-extern int round_up (int, int);
+extern int stride_round_up (int, int const *, int);
+extern int stride_lookup (int c, int const * stride);
 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
@@ -181,45 +210,46 @@ extern std::string get_optional_string (std::multimap<std::string, std::string>
  *  that are useful for DVD-o-matic.
  *
  *  This class wraps some things that I could not work out how to do with boost;
- *  most notably, sync read/write calls with timeouts, and the ability to peek into
- *  data being read.
+ *  most notably, sync read/write calls with timeouts.
  */
 class Socket
 {
 public:
-       Socket ();
+       Socket (int timeout = 30);
 
        /** @return Our underlying socket */
        boost::asio::ip::tcp::socket& socket () {
                return _socket;
        }
 
-       void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
-       void write (uint8_t const * data, int size, int timeout);
+       void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint);
+
+       void write (uint32_t n);
+       void write (uint8_t const * data, int size);
        
-       void read_definite_and_consume (uint8_t* data, int size, int timeout);
-       void read_indefinite (uint8_t* data, int size, int timeout);
-       void consume (int amount);
+       void read (uint8_t* data, int size);
+       uint32_t read_uint32 ();
        
 private:
        void check ();
-       int read (uint8_t* data, int size, int timeout);
 
        Socket (Socket const &);
 
        boost::asio::io_service _io_service;
        boost::asio::deadline_timer _deadline;
        boost::asio::ip::tcp::socket _socket;
-       /** a buffer for small reads */
-       uint8_t _buffer[1024];
-       /** amount of valid data in the buffer */
-       int _buffer_data;
+       int _timeout;
 };
 
+/** @class AudioBuffers
+ *  @brief A class to hold multi-channel audio data in float format.
+ */
 class AudioBuffers
 {
 public:
        AudioBuffers (int channels, int frames);
+       AudioBuffers (AudioBuffers const &);
+       AudioBuffers (boost::shared_ptr<const AudioBuffers>);
        ~AudioBuffers ();
 
        float** data () const {
@@ -228,6 +258,10 @@ public:
        
        float* data (int) const;
 
+       int channels () const {
+               return _channels;
+       }
+
        int frames () const {
                return _frames;
        }
@@ -235,15 +269,51 @@ public:
        void set_frames (int f);
 
        void make_silent ();
+       void make_silent (int c);
+
+       void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
+       void move (int from, int to, int frames);
 
 private:
-       /* no copy construction */
-       AudioBuffers (AudioBuffers const &);
-       
+       /** Number of channels */
        int _channels;
+       /** Number of frames (where a frame is one sample across all channels) */
        int _frames;
+       /** Number of frames that _data can hold */
+       int _allocated_frames;
+       /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
        float** _data;
 };
 
+class AudioMapping
+{
+public:
+       AudioMapping (boost::shared_ptr<const Film>);
+
+       boost::optional<libdcp::Channel> source_to_dcp (int c) const;
+       boost::optional<int> dcp_to_source (libdcp::Channel c) const;
+
+       int minimum_dcp_channels () const;
+       int dcp_channels () const;
+
+private:
+       int _source_channels;
+       int _minimum_channels;
+};
+
+extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
+extern bool still_image_file (std::string);
+
+class LocaleGuard
+{
+public:
+       LocaleGuard ();
+       ~LocaleGuard ();
+       
+private:
+       char* _old;
+};
+
+
 #endif