projects
/
dcpomatic.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Hand-apply bbfb370d7de28ec1e8f307865cc6253bb5d4366e from master; quicker digest calcu...
[dcpomatic.git]
/
src
/
lib
/
content.h
diff --git
a/src/lib/content.h
b/src/lib/content.h
index b4d90b22f4353a28a800424652ba9cd43a3a16f8..c6cede5fa6cafde4d04f18dc1943a3551c858a2c 100644
(file)
--- a/
src/lib/content.h
+++ b/
src/lib/content.h
@@
-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
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
@@
-17,16
+17,21
@@
*/
*/
+/** @file src/lib/content.h
+ * @brief Content class.
+ */
+
#ifndef DCPOMATIC_CONTENT_H
#define DCPOMATIC_CONTENT_H
#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 <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;
namespace cxml {
class Node;
@@
-45,21
+50,37
@@
public:
static int const TRIM_END;
};
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>);
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>, Time);
+ Content (boost::shared_ptr<const Film>,
DCP
Time);
Content (boost::shared_ptr<const Film>, boost::filesystem::path);
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 () {}
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;
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 technical_summary () const;
- virtual std::string information () const = 0;
+
virtual void as_xml (xmlpp::Node *) const;
virtual void as_xml (xmlpp::Node *) const;
- virtual Time full_length () const = 0;
+ virtual
DCP
Time full_length () const = 0;
virtual std::string identifier () const;
boost::shared_ptr<Content> clone () const;
virtual std::string identifier () const;
boost::shared_ptr<Content> clone () const;
@@
-83,49
+104,54
@@
public:
return _paths[i];
}
return _paths[i];
}
- bool path_valid () const;
+ bool path
s
_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;
}
std::string digest () const {
boost::mutex::scoped_lock lm (_mutex);
return _digest;
}
- void set_position (Time);
+ void set_position (
DCP
Time);
- /** Time that this content starts; i.e. the time that the first
+ /**
DCP
Time that this content starts; i.e. the time that the first
* bit of the content (trimmed or not) will happen.
*/
* bit of the content (trimmed or not) will happen.
*/
- Time position () const {
+
DCP
Time position () const {
boost::mutex::scoped_lock lm (_mutex);
return _position;
}
boost::mutex::scoped_lock lm (_mutex);
return _position;
}
- void set_trim_start (Time);
+ void set_trim_start (
DCP
Time);
- Time trim_start () const {
+
DCP
Time trim_start () const {
boost::mutex::scoped_lock lm (_mutex);
return _trim_start;
}
boost::mutex::scoped_lock lm (_mutex);
return _trim_start;
}
- void set_trim_end (Time);
+ void set_trim_end (
DCP
Time);
- Time trim_end () const {
+
DCP
Time trim_end () const {
boost::mutex::scoped_lock lm (_mutex);
return _trim_end;
}
boost::mutex::scoped_lock lm (_mutex);
return _trim_end;
}
- Time end () const {
- return position() + length_after_trim()
- 1
;
+
DCP
Time end () const {
+ return position() + length_after_trim();
}
}
- Time length_after_trim () const;
+
DCP
Time length_after_trim () const;
void set_change_signals_frequent (bool f) {
_change_signals_frequent = f;
}
void set_change_signals_frequent (bool f) {
_change_signals_frequent = f;
}
- bool trimmed (Time) const;
+ boost::shared_ptr<const Film> film () const {
+ return _film.lock ();
+ }
boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
@@
-135,8
+161,8
@@
protected:
boost::weak_ptr<const Film> _film;
/** _mutex which should be used to protect accesses, as examine
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 */
mutable boost::mutex _mutex;
/** Paths of our data files */
@@
-144,9
+170,9
@@
protected:
private:
std::string _digest;
private:
std::string _digest;
- Time _position;
- Time _trim_start;
- Time _trim_end;
+
DCP
Time _position;
+
DCP
Time _trim_start;
+
DCP
Time _trim_end;
bool _change_signals_frequent;
};
bool _change_signals_frequent;
};