Tidying.
[libdcp.git] / src / pkl.h
index ab6c7a60dff386c865103e1fd3571535dc908f49..01988e70eda1746a2053476c7e979a31c7bdc318 100644 (file)
--- a/src/pkl.h
+++ b/src/pkl.h
-#include <boost/shared_ptr.hpp>
-#include "xml.h"
+/*
+    Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
 
-namespace libdcp {
+    This file is part of libdcp.
 
-class PKLAsset : public XMLNode
-{
-public:
-       PKLAsset () {}
-       PKLAsset (xmlpp::Node const * node);
-
-       std::string id;
-       std::string annotation_text;
-       std::string hash;
-       int size;
-       std::string type;
-};
+    libdcp is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 
-class PKLAssetList : public XMLNode
-{
-public:
-       PKLAssetList ();
-       PKLAssetList (xmlpp::Node const * node);
+    libdcp is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
 
-       std::list<boost::shared_ptr<PKLAsset> > assets;
-};
+    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/pkl.cc
+ *  @brief PKL class
+ */
 
-class PKL : public XMLFile
+
+#ifndef LIBDCP_PKL_H
+#define LIBDCP_PKL_H
+
+
+#include "object.h"
+#include "types.h"
+#include "util.h"
+#include "certificate_chain.h"
+#include <libcxml/cxml.h>
+#include <boost/filesystem.hpp>
+
+
+namespace dcp {
+
+
+class PKL : public Object
 {
 public:
-       PKL (std::string file);
-
-       std::string id;
-       std::string annotation_text;
-       std::string issue_date;
-       std::string issuer;
-       std::string creator;
-       boost::shared_ptr<PKLAssetList> asset_list;
+       PKL (Standard standard, boost::optional<std::string> annotation_text, std::string issue_date, std::string issuer, std::string creator)
+               : _standard (standard)
+               , _annotation_text (annotation_text)
+               , _issue_date (issue_date)
+               , _issuer (issuer)
+               , _creator (creator)
+       {}
+
+       explicit PKL (boost::filesystem::path file);
+
+       Standard standard () const {
+               return _standard;
+       }
+
+       boost::optional<std::string> annotation_text () const {
+               return _annotation_text;
+       }
+
+       boost::optional<std::string> hash (std::string id) const;
+       boost::optional<std::string> type (std::string id) const;
+
+       void add_asset (std::string id, boost::optional<std::string> annotation_text, std::string hash, int64_t size, std::string type);
+       void write (boost::filesystem::path file, std::shared_ptr<const CertificateChain> signer) const;
+
+       /** @return the most recent disk file used to read or write this PKL, if there is one */
+       boost::optional<boost::filesystem::path> file () const {
+               return _file;
+       }
+
+       class Asset : public Object
+       {
+       public:
+               Asset (cxml::ConstNodePtr node)
+                       : Object (remove_urn_uuid(node->string_child("Id")))
+                       , _annotation_text (node->optional_string_child("AnnotationText"))
+                       , _hash (node->string_child("Hash"))
+                       , _size (node->number_child<int64_t>("Size"))
+                       , _type (node->string_child("Type"))
+               {}
+
+               Asset (std::string id, boost::optional<std::string> annotation_text, std::string hash, int64_t size, std::string type)
+                       : Object (id)
+                       , _annotation_text (annotation_text)
+                       , _hash (hash)
+                       , _size (size)
+                       , _type (type)
+               {}
+
+               boost::optional<std::string> annotation_text () const {
+                       return _annotation_text;
+               }
+
+               std::string hash () const {
+                       return _hash;
+               }
+
+               int64_t size () const {
+                       return _size;
+               }
+
+               std::string type () const {
+                       return _type;
+               }
+
+       private:
+               boost::optional<std::string> _annotation_text;
+               std::string _hash;
+               int64_t _size = 0;
+               std::string _type;
+       };
+
+       std::vector<std::shared_ptr<Asset>> asset_list () const {
+               return _asset_list;
+       }
+
+private:
+
+       Standard _standard = dcp::Standard::SMPTE;
+       boost::optional<std::string> _annotation_text;
+       std::string _issue_date;
+       std::string _issuer;
+       std::string _creator;
+       std::vector<std::shared_ptr<Asset>> _asset_list;
+       /** The most recent disk file used to read or write this PKL */
+       mutable boost::optional<boost::filesystem::path> _file;
 };
-       
+
+
 }
+
+
+#endif