X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fcontent.h;h=c6cede5fa6cafde4d04f18dc1943a3551c858a2c;hb=59e769023c392c332331567a1aea94660002c463;hp=6bbf33b35cd4d4e10377bdda2ad77be6cf673f7c;hpb=05654d0e1799746a9df3ccab040c92e0ed825cac;p=dcpomatic.git

diff --git a/src/lib/content.h b/src/lib/content.h
index 6bbf33b35..c6cede5fa 100644
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -1,5 +1,5 @@
 /*
-    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
@@ -24,15 +24,14 @@
 #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 <libcxml/cxml.h>
-#include "types.h"
-#include "dcpomatic_time.h"
 
 namespace cxml {
 	class Node;
@@ -63,14 +62,23 @@ public:
 	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;
@@ -98,7 +106,10 @@ public:
 	
 	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;