Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / subtitle_content.cc
index 3415ae613f5aee8175e122a9dea0d0517b791cf1..2f4c88975cfa98bb55bddcfcc6e5919c12d38f00 100644 (file)
 
 */
 
-#include <libcxml/cxml.h>
-#include <dcp/raw_convert.h>
 #include "subtitle_content.h"
 #include "util.h"
 #include "exceptions.h"
+#include "safe_stringstream.h"
+#include "font.h"
+#include "raw_convert.h"
+#include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
 using std::string;
-using std::stringstream;
 using std::vector;
 using std::cout;
+using std::list;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
-using dcp::raw_convert;
 
 int const SubtitleContentProperty::SUBTITLE_X_OFFSET = 500;
 int const SubtitleContentProperty::SUBTITLE_Y_OFFSET = 501;
-int const SubtitleContentProperty::SUBTITLE_SCALE = 502;
-int const SubtitleContentProperty::USE_SUBTITLES = 503;
+int const SubtitleContentProperty::SUBTITLE_X_SCALE = 502;
+int const SubtitleContentProperty::SUBTITLE_Y_SCALE = 503;
+int const SubtitleContentProperty::USE_SUBTITLES = 504;
+int const SubtitleContentProperty::BURN_SUBTITLES = 505;
+int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 506;
+int const SubtitleContentProperty::FONTS = 507;
+int const SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE = 508;
 
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f)
-       : Content (f)
+SubtitleContent::SubtitleContent (shared_ptr<const Film> film)
+       : Content (film)
        , _use_subtitles (false)
+       , _burn_subtitles (false)
        , _subtitle_x_offset (0)
        , _subtitle_y_offset (0)
-       , _subtitle_scale (1)
+       , _subtitle_x_scale (1)
+       , _subtitle_y_scale (1)
 {
 
 }
 
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f, boost::filesystem::path p)
-       : Content (f, p)
+SubtitleContent::SubtitleContent (shared_ptr<const Film> film, boost::filesystem::path p)
+       : Content (film, p)
        , _use_subtitles (false)
+       , _burn_subtitles (false)
        , _subtitle_x_offset (0)
        , _subtitle_y_offset (0)
-       , _subtitle_scale (1)
+       , _subtitle_x_scale (1)
+       , _subtitle_y_scale (1)
 {
 
 }
 
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
-       : Content (f, node)
+SubtitleContent::SubtitleContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
+       : Content (film, node)
        , _use_subtitles (false)
+       , _burn_subtitles (false)
        , _subtitle_x_offset (0)
        , _subtitle_y_offset (0)
-       , _subtitle_scale (1)
+       , _subtitle_x_scale (1)
+       , _subtitle_y_scale (1)
 {
-       if (version >= 7) {
+       if (version >= 32) {
                _use_subtitles = node->bool_child ("UseSubtitles");
+               _burn_subtitles = node->bool_child ("BurnSubtitles");
+       }
+
+       if (version >= 7) {
                _subtitle_x_offset = node->number_child<float> ("SubtitleXOffset");
                _subtitle_y_offset = node->number_child<float> ("SubtitleYOffset");
        } else {
                _subtitle_y_offset = node->number_child<float> ("SubtitleOffset");
        }
-       
-       _subtitle_scale = node->number_child<float> ("SubtitleScale");
+
+       if (version >= 10) {
+               _subtitle_x_scale = node->number_child<float> ("SubtitleXScale");
+               _subtitle_y_scale = node->number_child<float> ("SubtitleYScale");
+       } else {
+               _subtitle_x_scale = _subtitle_y_scale = node->number_child<float> ("SubtitleScale");
+       }
+
+       _subtitle_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
+
+       list<cxml::NodePtr> fonts = node->node_children ("Font");
+       for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
+               _fonts.push_back (shared_ptr<Font> (new Font (*i)));
+       }
+
+       connect_to_fonts ();
 }
 
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
-       : Content (f, c)
+SubtitleContent::SubtitleContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
+       : Content (film, c)
 {
        shared_ptr<SubtitleContent> ref = dynamic_pointer_cast<SubtitleContent> (c[0]);
-       assert (ref);
-       
+       DCPOMATIC_ASSERT (ref);
+       list<shared_ptr<Font> > ref_fonts = ref->fonts ();
+
        for (size_t i = 0; i < c.size(); ++i) {
                shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c[i]);
 
@@ -89,32 +123,72 @@ SubtitleContent::SubtitleContent (shared_ptr<const Film> f, vector<shared_ptr<Co
                        throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
                }
 
+               if (sc->burn_subtitles() != ref->burn_subtitles()) {
+                       throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
+               }
+
                if (sc->subtitle_x_offset() != ref->subtitle_x_offset()) {
                        throw JoinError (_("Content to be joined must have the same subtitle X offset."));
                }
-               
+
                if (sc->subtitle_y_offset() != ref->subtitle_y_offset()) {
                        throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
                }
 
-               if (sc->subtitle_scale() != ref->subtitle_scale()) {
-                       throw JoinError (_("Content to be joined must have the same subtitle scale."));
+               if (sc->subtitle_x_scale() != ref->subtitle_x_scale()) {
+                       throw JoinError (_("Content to be joined must have the same subtitle X scale."));
+               }
+
+               if (sc->subtitle_y_scale() != ref->subtitle_y_scale()) {
+                       throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
+               }
+
+               list<shared_ptr<Font> > fonts = sc->fonts ();
+               if (fonts.size() != ref_fonts.size()) {
+                       throw JoinError (_("Content to be joined must use the same fonts."));
+               }
+
+               list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
+               list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
+
+               while (j != ref_fonts.end ()) {
+                       if (**j != **k) {
+                               throw JoinError (_("Content to be joined must use the same fonts."));
+                       }
+                       ++j;
+                       ++k;
                }
        }
 
        _use_subtitles = ref->use_subtitles ();
+       _burn_subtitles = ref->burn_subtitles ();
        _subtitle_x_offset = ref->subtitle_x_offset ();
        _subtitle_y_offset = ref->subtitle_y_offset ();
-       _subtitle_scale = ref->subtitle_scale ();
+       _subtitle_x_scale = ref->subtitle_x_scale ();
+       _subtitle_y_scale = ref->subtitle_y_scale ();
+       _subtitle_language = ref->subtitle_language ();
+       _fonts = ref_fonts;
+
+       connect_to_fonts ();
 }
 
+/** _mutex must not be held on entry */
 void
 SubtitleContent::as_xml (xmlpp::Node* root) const
 {
+       boost::mutex::scoped_lock lm (_mutex);
+
        root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use_subtitles));
+       root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn_subtitles));
        root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_subtitle_x_offset));
        root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_subtitle_y_offset));
-       root->add_child("SubtitleScale")->add_child_text (raw_convert<string> (_subtitle_scale));
+       root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_subtitle_x_scale));
+       root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_subtitle_y_scale));
+       root->add_child("SubtitleLanguage")->add_child_text (_subtitle_language);
+
+       for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
+               (*i)->as_xml (root->add_child("Font"));
+       }
 }
 
 void
@@ -126,7 +200,17 @@ SubtitleContent::set_use_subtitles (bool u)
        }
        signal_changed (SubtitleContentProperty::USE_SUBTITLES);
 }
-       
+
+void
+SubtitleContent::set_burn_subtitles (bool b)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _burn_subtitles = b;
+       }
+       signal_changed (SubtitleContentProperty::BURN_SUBTITLES);
+}
+
 void
 SubtitleContent::set_subtitle_x_offset (double o)
 {
@@ -148,23 +232,88 @@ SubtitleContent::set_subtitle_y_offset (double o)
 }
 
 void
-SubtitleContent::set_subtitle_scale (double s)
+SubtitleContent::set_subtitle_x_scale (double s)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_scale = s;
+               _subtitle_x_scale = s;
        }
-       signal_changed (SubtitleContentProperty::SUBTITLE_SCALE);
+       signal_changed (SubtitleContentProperty::SUBTITLE_X_SCALE);
+}
+
+void
+SubtitleContent::set_subtitle_y_scale (double s)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _subtitle_y_scale = s;
+       }
+       signal_changed (SubtitleContentProperty::SUBTITLE_Y_SCALE);
+}
+
+void
+SubtitleContent::set_subtitle_language (string language)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _subtitle_language = language;
+       }
+       signal_changed (SubtitleContentProperty::SUBTITLE_LANGUAGE);
 }
 
 string
 SubtitleContent::identifier () const
 {
-       stringstream s;
+       SafeStringStream s;
        s << Content::identifier()
-         << "_" << raw_convert<string> (subtitle_scale())
+         << "_" << raw_convert<string> (subtitle_x_scale())
+         << "_" << raw_convert<string> (subtitle_y_scale())
          << "_" << raw_convert<string> (subtitle_x_offset())
          << "_" << raw_convert<string> (subtitle_y_offset());
 
+       /* XXX: I suppose really _fonts shouldn't be in here, since not all
+          types of subtitle content involve fonts.
+       */
+       BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
+               s << f->file().get_value_or ("Default");
+       }
+
+       /* The language is for metadata only, and doesn't affect
+          how this content looks.
+       */
+
        return s.str ();
 }
+
+void
+SubtitleContent::add_font (shared_ptr<Font> font)
+{
+       _fonts.push_back (font);
+       connect_to_fonts ();
+}
+
+void
+SubtitleContent::connect_to_fonts ()
+{
+       BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
+               i.disconnect ();
+       }
+
+       _font_connections.clear ();
+
+       BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
+               _font_connections.push_back (i->Changed.connect (boost::bind (&SubtitleContent::font_changed, this)));
+       }
+}
+
+void
+SubtitleContent::font_changed ()
+{
+       signal_changed (SubtitleContentProperty::FONTS);
+}
+
+bool
+SubtitleContent::has_subtitles () const
+{
+       return has_text_subtitles() || has_image_subtitles();
+}