/*
- 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
*/
+/** @file src/lib/content.h
+ * @brief Content class.
+ */
+
#ifndef DCPOMATIC_CONTENT_H
#define DCPOMATIC_CONTENT_H
-#include <set>
+#include "types.h"
+#include "dcpomatic_time.h"
+#include <libxml++/libxml++.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 "types.h"
namespace cxml {
class Node;
static int const TRIM_END;
};
+/** @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
{
public:
Content (boost::shared_ptr<const Film>);
Content (boost::shared_ptr<const Film>, DCPTime);
Content (boost::shared_ptr<const Film>, boost::filesystem::path);
- Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
+ Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
virtual ~Content () {}
+
+ /** 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);
- virtual void examine (boost::shared_ptr<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;
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' version (see comments in ::examine).
+ */
std::string digest () const {
boost::mutex::scoped_lock lm (_mutex);
return _digest;
}
DCPTime end () const {
- return position() + length_after_trim() - 1;
+ return position() + length_after_trim();
}
DCPTime length_after_trim () const;
_change_signals_frequent = f;
}
+ boost::shared_ptr<const Film> film () const {
+ return _film.lock ();
+ }
+
boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
protected:
boost::weak_ptr<const Film> _film;
/** _mutex which should be used to protect accesses, as examine
- jobs can update content state in threads other than the main one.
- */
+ * jobs can update content state in threads other than the main one.
+ */
mutable boost::mutex _mutex;
/** Paths of our data files */