Some include tidying.

[dcpomatic.git] / src / lib / content.h

diff --git a/src/lib/content.h b/src/lib/content.h
index 6bbf33b35cd4d4e10377bdda2ad77be6cf673f7c..e383f9ff0a599e52e5ba6a97a4083f7cec773ea3 100644 (file)
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -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,13 +62,24 @@ 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.
+        *  @param calculate_digest True to calculate a digest for the content's file(s).
+        */
+       virtual void examine (boost::shared_ptr<Job> job, bool calculate_digest);
        
-       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;
@@ -99,7 +109,7 @@ public:
        bool paths_valid () const;
 
        /** @return MD5 digest of the content's file(s) */
-       std::string digest () const {
+       boost::optional<std::string> digest () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _digest;
        }
@@ -158,7 +168,7 @@ protected:
        std::vector<boost::filesystem::path> _paths;
        
 private:
-       std::string _digest;
+       boost::optional<std::string> _digest;
        DCPTime _position;
        DCPTime _trim_start;
        DCPTime _trim_end;