Hopefully-correct PKL and AssetMap when using Interop PNG subtitles.

[libdcp.git] / src / asset.h

diff --git a/src/asset.h b/src/asset.h
index 7adf009087d0870abd5ef33d03c14837fabff4cc..b6ab8fd26101fd48a41b628c59dceab8931266a8 100644 (file)
--- a/src/asset.h
+++ b/src/asset.h
@@ -15,6 +15,20 @@
 
     You should have received a copy of the GNU General Public License
     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
 /** @file  src/asset.h
@@ -26,6 +40,7 @@
 
 #include "object.h"
 #include "types.h"
+#include "pkl.h"
 #include <boost/filesystem.hpp>
 #include <boost/function.hpp>
 #include <boost/bind.hpp>
@@ -49,7 +64,7 @@ class Asset : public Object
 {
 public:
        Asset ();
-       Asset (boost::filesystem::path file);
+       explicit Asset (boost::filesystem::path file);
        Asset (std::string id, boost::filesystem::path file);
 
        virtual bool equals (
@@ -61,16 +76,12 @@ public:
        /** Write details of the asset to a ASSETMAP.
         *  @param node Parent node.
         */
-       void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
+       virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
 
-       /** Write details of the asset to a PKL AssetList node.
-        *  @param node Parent node.
-        *  @param standard Standard to use.
-        */
-       void write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const;
+       virtual void add_to_pkl (boost::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
 
-       /** @return the most recent disk file used to read or write this asset; may be empty */
-       boost::filesystem::path file () const {
+       /** @return the most recent disk file used to read or write this asset, if there is one */
+       boost::optional<boost::filesystem::path> file () const {
                return _file;
        }
 
@@ -79,14 +90,19 @@ public:
        /** @return the hash of this asset's file */
        std::string hash (boost::function<void (float)> progress = 0) const;
 
+       void set_hash (std::string hash);
+
 protected:
 
-       /** The most recent disk file used to read or write this asset; may be empty */
-       mutable boost::filesystem::path _file;
+       /** The most recent disk file used to read or write this asset */
+       mutable boost::optional<boost::filesystem::path> _file;
+
+       static void write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, std::string id);
 
 private:
        friend struct ::asset_test;
 
+       /** @return type string for PKLs for this asset */
        virtual std::string pkl_type (Standard standard) const = 0;
 
        /** Hash of _file if it has been computed */