Fix missing version string when Popen communicate returns byte strings.
[libdcp.git] / src / dcp.h
index 7d6d1567fbd9a98c496ca9684c4c785affb9bf13..9c97e6aa2bcafd6f15898efd7f12fe7e9a9d8360 100644 (file)
--- a/src/dcp.h
+++ b/src/dcp.h
@@ -1,20 +1,34 @@
 /*
     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    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.
 
-    This program is distributed in the hope that it will be useful,
+    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.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    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/dcp.h
 #define LIBDCP_DCP_H
 
 #include "types.h"
+#include "util.h"
 #include "certificate.h"
 #include "metadata.h"
+#include "name_format.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
 #include <string>
@@ -41,6 +57,7 @@ namespace xmlpp {
 namespace dcp
 {
 
+class PKL;
 class Content;
 class Reel;
 class CPL;
@@ -64,7 +81,7 @@ public:
         *
         *  @param directory Directory containing the DCP's files.
         */
-       DCP (boost::filesystem::path directory);
+       explicit DCP (boost::filesystem::path directory);
 
        typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
 
@@ -88,7 +105,7 @@ public:
        void add (boost::shared_ptr<CPL> cpl);
 
        std::list<boost::shared_ptr<CPL> > cpls () const;
-       std::list<boost::shared_ptr<Asset> > assets () const;
+       std::list<boost::shared_ptr<Asset> > assets (bool ignore_unresolved = false) const;
 
        bool encrypted () const;
 
@@ -97,7 +114,8 @@ public:
        void write_xml (
                Standard standard,
                XMLMetadata metadata = XMLMetadata (),
-               boost::shared_ptr<const CertificateChain> signer = boost::shared_ptr<const CertificateChain> ()
+               boost::shared_ptr<const CertificateChain> signer = boost::shared_ptr<const CertificateChain> (),
+               NameFormat name_format = NameFormat("%t")
        );
 
        void resolve_refs (std::list<boost::shared_ptr<Asset> > assets);
@@ -107,30 +125,34 @@ public:
                return _standard;
        }
 
-private:
+       boost::filesystem::path directory () const {
+               return _directory;
+       }
 
-       /** Write the PKL file.
-        *  @param pkl_uuid UUID to use.
+       /** @return PKL if this DCP was read from an existing one, or if write_xml() has been called on it.
+        *  If neither is true, this method returns 0.
         */
-       boost::filesystem::path write_pkl (
-               Standard standard,
-               std::string pkl_uuid,
-               XMLMetadata metadata,
-               boost::shared_ptr<const CertificateChain> signer
-               ) const;
+       boost::shared_ptr<PKL> pkl () const {
+               return _pkl;
+       }
+
+       static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
+
+private:
 
        void write_volindex (Standard standard) const;
 
        /** Write the ASSETMAP file.
         *  @param pkl_uuid UUID of our PKL.
-        *  @param pkl_length Length of our PKL in bytes.
+        *  @param pkl_path Pathname of our PKL file.
         */
-       void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const;
+       void write_assetmap (Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path, XMLMetadata metadata) const;
 
        /** the directory that we are writing to */
        boost::filesystem::path _directory;
        /** the CPLs that make up this DCP */
        std::list<boost::shared_ptr<CPL> > _cpls;
+       boost::shared_ptr<PKL> _pkl;
 
        /** Standard of DCP that was read in */
        boost::optional<Standard> _standard;