/*
- Copyright (C) 2013-2014 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
#ifndef DCPOMATIC_CONTENT_H
#define DCPOMATIC_CONTENT_H
-#include <set>
+#include "types.h"
+#include "signaller.h"
+#include "dcpomatic_time.h"
+#include <libcxml/cxml.h>
#include <boost/filesystem.hpp>
#include <boost/signals2.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/enable_shared_from_this.hpp>
-#include <libxml++/libxml++.h>
-#include <libcxml/cxml.h>
-#include "types.h"
-#include "dcpomatic_time.h"
+
+namespace xmlpp {
+ class Node;
+}
namespace cxml {
class Node;
/** @class Content
* @brief A piece of content represented by one or more files on disk.
*/
-class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
+class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
{
public:
Content (boost::shared_ptr<const Film>);
Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
virtual ~Content () {}
-
- virtual void examine (boost::shared_ptr<Job>);
+
+ /** Examine the content to establish digest, frame rates and any other
+ * useful metadata.
+ * @param job Job to use to report progress, or 0.
+ */
+ virtual void examine (boost::shared_ptr<Job> job);
+
+ /** @return Quick one-line summary of the content, as will be presented in the
+ * film editor.
+ */
virtual std::string summary () const = 0;
+
/** @return Technical details of this content; these are written to logs to
* help with debugging.
*/
virtual std::string technical_summary () const;
- virtual std::string information () const = 0;
+
virtual void as_xml (xmlpp::Node *) const;
virtual DCPTime full_length () const = 0;
virtual std::string identifier () const;
+ std::list<std::pair<std::string, std::string> > properties () const;
+
boost::shared_ptr<Content> clone () const;
void set_path (boost::filesystem::path);
boost::mutex::scoped_lock lm (_mutex);
return _paths[i];
}
-
+
bool paths_valid () const;
- /** @return MD5 digest of the content's file(s) */
+ /** @return Digest of the content's file(s). Note: this is
+ * not a complete MD5-or-whatever hash, but a sort of poor
+ * man's version (see comments in ::examine).
+ */
std::string digest () const {
boost::mutex::scoped_lock lm (_mutex);
return _digest;
return _position;
}
- void set_trim_start (DCPTime);
+ void set_trim_start (ContentTime);
- DCPTime trim_start () const {
+ ContentTime trim_start () const {
boost::mutex::scoped_lock lm (_mutex);
return _trim_start;
}
- void set_trim_end (DCPTime);
-
- DCPTime trim_end () const {
+ void set_trim_end (ContentTime);
+
+ ContentTime trim_end () const {
boost::mutex::scoped_lock lm (_mutex);
return _trim_end;
}
-
+
+ /** @return Time immediately after the last thing in this content */
DCPTime end () const {
return position() + length_after_trim();
}
DCPTime length_after_trim () const;
-
+
void set_change_signals_frequent (bool f) {
_change_signals_frequent = f;
}
- boost::shared_ptr<const Film> film () const {
- return _film.lock ();
- }
+ boost::shared_ptr<const Film> film () const;
boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
protected:
void signal_changed (int);
+ virtual void add_properties (std::list<std::pair<std::string, std::string> > &) const {}
boost::weak_ptr<const Film> _film;
/** Paths of our data files */
std::vector<boost::filesystem::path> _paths;
-
+
private:
std::string _digest;
DCPTime _position;
- DCPTime _trim_start;
- DCPTime _trim_end;
+ ContentTime _trim_start;
+ ContentTime _trim_end;
bool _change_signals_frequent;
};