/*
- Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2016 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
#ifndef DCPOMATIC_SUBTITLE_CONTENT_H
#define DCPOMATIC_SUBTITLE_CONTENT_H
-#include "content.h"
+#include "content_part.h"
+#include <libcxml/cxml.h>
+#include <dcp/types.h>
+#include <boost/signals2.hpp>
+
+class Font;
class SubtitleContentProperty
{
public:
- static int const SUBTITLE_X_OFFSET;
- static int const SUBTITLE_Y_OFFSET;
- static int const SUBTITLE_SCALE;
- static int const USE_SUBTITLES;
+ static int const X_OFFSET;
+ static int const Y_OFFSET;
+ static int const X_SCALE;
+ static int const Y_SCALE;
+ static int const USE;
+ static int const BURN;
+ static int const LANGUAGE;
+ static int const FONTS;
+ static int const VIDEO_FRAME_RATE;
+ static int const COLOUR;
+ static int const OUTLINE;
+ static int const OUTLINE_COLOUR;
};
-/** @class SubtitleContent
- * @brief Parent for content which has the potential to include subtitles.
- *
- * Although inheriting from this class indicates that the content could
- * have subtitles, it may not. ::has_subtitles() will tell you.
- */
-class SubtitleContent : public virtual Content
+class SubtitleContent : public ContentPart
{
public:
- SubtitleContent (boost::shared_ptr<const Film>);
- SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
- SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
- SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
+ SubtitleContent (Content* parent, boost::shared_ptr<const Film>);
+ SubtitleContent (Content* parent, boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
+ SubtitleContent (Content* parent, boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
void as_xml (xmlpp::Node *) const;
std::string identifier () const;
- virtual bool has_subtitles () const = 0;
+ bool has_image_subtitles () const {
+ /* XXX */
+ return true;
+ }
+
+ void add_font (boost::shared_ptr<Font> font);
+
+ void set_use (bool);
+ void set_burn (bool);
+ void set_x_offset (double);
+ void set_y_offset (double);
+ void set_x_scale (double);
+ void set_y_scale (double);
+ void set_language (std::string language);
- void set_use_subtitles (bool);
- void set_subtitle_x_offset (double);
- void set_subtitle_y_offset (double);
- void set_subtitle_scale (double);
+ bool use () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _use;
+ }
+
+ bool burn () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _burn;
+ }
+
+ double x_offset () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _x_offset;
+ }
+
+ double y_offset () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _y_offset;
+ }
- bool use_subtitles () const {
+ double x_scale () const {
boost::mutex::scoped_lock lm (_mutex);
- return _use_subtitles;
+ return _x_scale;
}
- double subtitle_x_offset () const {
+ double y_scale () const {
boost::mutex::scoped_lock lm (_mutex);
- return _subtitle_x_offset;
+ return _y_scale;
}
- double subtitle_y_offset () const {
+ std::list<boost::shared_ptr<Font> > fonts () const {
boost::mutex::scoped_lock lm (_mutex);
- return _subtitle_y_offset;
+ return _fonts;
}
- double subtitle_scale () const {
+ std::string language () const {
boost::mutex::scoped_lock lm (_mutex);
- return _subtitle_scale;
+ return _language;
}
+ void set_colour (dcp::Colour);
+
+ dcp::Colour colour () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _colour;
+ }
+
+ void set_outline (bool);
+
+ bool outline () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _outline;
+ }
+
+ void set_outline_colour (dcp::Colour);
+
+ dcp::Colour outline_colour () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _outline_colour;
+ }
+
+ double video_frame_rate () const;
+ void set_video_frame_rate (double r);
+
+protected:
+ /** subtitle language (e.g. "German") or empty if it is not known */
+ std::string _language;
+
private:
friend struct ffmpeg_pts_offset_test;
+ void font_changed ();
+ void connect_to_fonts ();
- bool _use_subtitles;
+ bool _use;
+ bool _burn;
/** x offset for placing subtitles, as a proportion of the container width;
* +ve is further right, -ve is further left.
*/
- double _subtitle_x_offset;
+ double _x_offset;
/** y offset for placing subtitles, as a proportion of the container height;
* +ve is further down the frame, -ve is further up.
*/
- double _subtitle_y_offset;
- /** scale factor to apply to subtitles */
- double _subtitle_scale;
+ double _y_offset;
+ /** x scale factor to apply to subtitles */
+ double _x_scale;
+ /** y scale factor to apply to subtitles */
+ double _y_scale;
+ std::list<boost::shared_ptr<Font> > _fonts;
+ dcp::Colour _colour;
+ bool _outline;
+ dcp::Colour _outline_colour;
+ std::list<boost::signals2::connection> _font_connections;
+ /** Video frame rate that this content has been prepared for, if known */
+ boost::optional<double> _frame_rate;
};
#endif