Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / audio_content.cc
index dbca6652ca1095abb78fb8d2ca2494d4baf9b2d2..c67a66ed8a00f669e768a32db5be27626524eb19 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <libcxml/cxml.h>
-#include <libdcp/raw_convert.h>
 #include "audio_content.h"
-#include "analyse_audio_job.h"
-#include "job_manager.h"
 #include "film.h"
 #include "exceptions.h"
 #include "config.h"
+#include "frame_rate_change.h"
+#include "raw_convert.h"
+#include "compose.hpp"
+#include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
 using std::string;
+using std::cout;
 using std::vector;
+using std::stringstream;
+using std::fixed;
+using std::setprecision;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
-using libdcp::raw_convert;
+using boost::optional;
 
-int const AudioContentProperty::AUDIO_CHANNELS = 200;
-int const AudioContentProperty::AUDIO_LENGTH = 201;
-int const AudioContentProperty::AUDIO_FRAME_RATE = 202;
-int const AudioContentProperty::AUDIO_GAIN = 203;
-int const AudioContentProperty::AUDIO_DELAY = 204;
-int const AudioContentProperty::AUDIO_MAPPING = 205;
+/** Something stream-related has changed */
+int const AudioContentProperty::AUDIO_STREAMS = 200;
+int const AudioContentProperty::AUDIO_GAIN = 201;
+int const AudioContentProperty::AUDIO_DELAY = 202;
 
-AudioContent::AudioContent (shared_ptr<const Film> f, Time s)
-       : Content (f, s)
+AudioContent::AudioContent (shared_ptr<const Film> film)
+       : Content (film)
        , _audio_gain (0)
        , _audio_delay (Config::instance()->default_audio_delay ())
 {
 
 }
 
-AudioContent::AudioContent (shared_ptr<const Film> f, boost::filesystem::path p)
-       : Content (f, p)
+AudioContent::AudioContent (shared_ptr<const Film> film, DCPTime s)
+       : Content (film, s)
        , _audio_gain (0)
        , _audio_delay (Config::instance()->default_audio_delay ())
 {
 
 }
 
-AudioContent::AudioContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
-       : Content (f, node)
+AudioContent::AudioContent (shared_ptr<const Film> film, boost::filesystem::path p)
+       : Content (film, p)
+       , _audio_gain (0)
+       , _audio_delay (Config::instance()->default_audio_delay ())
+{
+
+}
+
+AudioContent::AudioContent (shared_ptr<const Film> film, cxml::ConstNodePtr node)
+       : Content (film, node)
 {
        _audio_gain = node->number_child<float> ("AudioGain");
        _audio_delay = node->number_child<int> ("AudioDelay");
 }
 
-AudioContent::AudioContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
-       : Content (f, c)
+AudioContent::AudioContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
+       : Content (film, c)
 {
        shared_ptr<AudioContent> ref = dynamic_pointer_cast<AudioContent> (c[0]);
-       assert (ref);
-       
+       DCPOMATIC_ASSERT (ref);
+
        for (size_t i = 0; i < c.size(); ++i) {
                shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (c[i]);
 
@@ -96,13 +109,13 @@ AudioContent::as_xml (xmlpp::Node* node) const
 
 
 void
-AudioContent::set_audio_gain (float g)
+AudioContent::set_audio_gain (double g)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
                _audio_gain = g;
        }
-       
+
        signal_changed (AudioContentProperty::AUDIO_GAIN);
 }
 
@@ -113,38 +126,169 @@ AudioContent::set_audio_delay (int d)
                boost::mutex::scoped_lock lm (_mutex);
                _audio_delay = d;
        }
-       
+
        signal_changed (AudioContentProperty::AUDIO_DELAY);
 }
 
-boost::signals2::connection
-AudioContent::analyse_audio (boost::function<void()> finished)
+string
+AudioContent::technical_summary () const
 {
-       shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-       
-       shared_ptr<AnalyseAudioJob> job (new AnalyseAudioJob (film, dynamic_pointer_cast<AudioContent> (shared_from_this())));
-       boost::signals2::connection c = job->Finished.connect (finished);
-       JobManager::instance()->add (job);
+       string s = "audio :";
+       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+               s += String::compose ("stream channels %1 rate %2", i->channels(), i->frame_rate());
+       }
 
-       return c;
+       return s;
 }
 
-boost::filesystem::path
-AudioContent::audio_analysis_path () const
+void
+AudioContent::set_audio_mapping (AudioMapping mapping)
+{
+       int c = 0;
+       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+               AudioMapping stream_mapping (i->channels (), MAX_DCP_AUDIO_CHANNELS);
+               for (int j = 0; j < i->channels(); ++j) {
+                       for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
+                               stream_mapping.set (j, k, mapping.get (c, k));
+                       }
+                       ++c;
+               }
+               i->set_mapping (stream_mapping);
+       }
+
+       signal_changed (AudioContentProperty::AUDIO_STREAMS);
+}
+
+AudioMapping
+AudioContent::audio_mapping () const
+{
+       int channels = 0;
+       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+               channels += i->channels ();
+       }
+
+       AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
+
+       int c = 0;
+       int s = 0;
+       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+               AudioMapping mapping = i->mapping ();
+               for (int j = 0; j < mapping.input_channels(); ++j) {
+                       for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
+                               merged.set (c, k, mapping.get (j, k));
+                       }
+                       ++c;
+               }
+               ++s;
+       }
+
+       return merged;
+}
+
+/** @return the frame rate that this content should be resampled to in order
+ *  that it is in sync with the active video content at its start time.
+ */
+int
+AudioContent::resampled_audio_frame_rate () const
 {
        shared_ptr<const Film> film = _film.lock ();
-       if (!film) {
-               return boost::filesystem::path ();
+       DCPOMATIC_ASSERT (film);
+
+       /* Resample to a DCI-approved sample rate */
+       double t = has_rate_above_48k() ? 96000 : 48000;
+
+       FrameRateChange frc = film->active_frame_rate_change (position ());
+
+       /* Compensate if the DCP is being run at a different frame rate
+          to the source; that is, if the video is run such that it will
+          look different in the DCP compared to the source (slower or faster).
+       */
+
+       if (frc.change_speed) {
+               t /= frc.speed_up;
        }
 
-       boost::filesystem::path p = film->audio_analysis_dir ();
-       p /= digest() + "_" + audio_mapping().digest();
-       return p;
+       return lrint (t);
 }
 
 string
-AudioContent::technical_summary () const
+AudioContent::processing_description () const
+{
+       vector<AudioStreamPtr> streams = audio_streams ();
+       if (streams.empty ()) {
+               return "";
+       }
+
+       /* Possible answers are:
+          1. all audio will be resampled from x to y.
+          2. all audio will be resampled to y (from a variety of rates)
+          3. some audio will be resampled to y (from a variety of rates)
+          4. nothing will be resampled.
+       */
+
+       bool not_resampled = false;
+       bool resampled = false;
+       bool same = true;
+
+       optional<int> common_frame_rate;
+       BOOST_FOREACH (AudioStreamPtr i, streams) {
+               if (i->frame_rate() != resampled_audio_frame_rate()) {
+                       resampled = true;
+               } else {
+                       not_resampled = true;
+               }
+
+               if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
+                       same = false;
+               }
+               common_frame_rate = i->frame_rate ();
+       }
+
+       if (not_resampled && !resampled) {
+               return _("Audio will not be resampled");
+       }
+
+       if (not_resampled && resampled) {
+               return String::compose (_("Some audio will be resampled to %1kHz"), resampled_audio_frame_rate ());
+       }
+
+       if (!not_resampled && resampled) {
+               if (same) {
+                       return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_audio_frame_rate ());
+               } else {
+                       return String::compose (_("Audio will be resampled to %1kHz"), resampled_audio_frame_rate ());
+               }
+       }
+
+       return "";
+}
+
+/** @return true if any stream in this content has a sampling rate of more than 48kHz */
+bool
+AudioContent::has_rate_above_48k () const
+{
+       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+               if (i->frame_rate() > 48000) {
+                       return true;
+               }
+       }
+
+       return false;
+}
+
+/** @return User-visible names of each of our audio channels */
+vector<string>
+AudioContent::audio_channel_names () const
 {
-       return String::compose ("audio: channels %1, length %2, raw rate %3, out rate %4", audio_channels(), audio_length(), content_audio_frame_rate(), output_audio_frame_rate());
+       vector<string> n;
+
+       int t = 1;
+       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+               for (int j = 0; j < i->channels(); ++j) {
+                       n.push_back (String::compose ("%1:%2", t, j + 1));
+               }
+               ++t;
+       }
+
+       return n;
 }