src/asset_map.h

   1 /*
   2     Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 #include "asset_list.h"
  36 #include "object.h"
  37 #include <libcxml/cxml.h>
  38 #include <boost/filesystem.hpp>
  39 #include <boost/optional.hpp>
  40 #include <string>
  41 #include <vector>
  42
  43
  44 namespace dcp {
  45
  46
  47 class AssetMap : public Object, public AssetList
  48 {
  49 public:
  50         AssetMap(Standard standard, boost::optional<std::string> annotation_text, std::string issue_date, std::string issuer, std::string creator)
  51                 : AssetList(standard, annotation_text, issue_date, issuer, creator)
  52         {}
  53
  54         explicit AssetMap(boost::filesystem::path path);
  55
  56         boost::optional<boost::filesystem::path> file() const {
  57                 return _file;
  58         }
  59
  60         std::map<std::string, boost::filesystem::path> asset_ids_and_paths() const;
  61
  62         std::vector<boost::filesystem::path> pkl_paths() const;
  63
  64         void clear_assets();
  65         void add_asset(std::string id, boost::filesystem::path path, bool pkl);
  66
  67         void write_xml(boost::filesystem::path path) const;
  68
  69         class Asset : public Object
  70         {
  71         public:
  72                 Asset(std::string id, boost::filesystem::path path, bool pkl)
  73                         : Object(id)
  74                         , _path(path)
  75                         , _pkl(pkl)
  76                 {}
  77
  78                 Asset(cxml::ConstNodePtr node, boost::filesystem::path root, dcp::Standard standard);
  79
  80                 boost::filesystem::path path() const {
  81                         return _path;
  82                 }
  83
  84                 bool pkl() const {
  85                         return _pkl;
  86                 }
  87
  88                 void write_xml(xmlpp::Element* asset_list, boost::filesystem::path dcp_root_directory) const;
  89
  90         private:
  91                 boost::filesystem::path _path;
  92                 bool _pkl = false;
  93         };
  94
  95         std::vector<Asset> assets() const {
  96                 return _assets;
  97         }
  98
  99 private:
 100         std::vector<Asset> _assets;
 101         mutable boost::optional<boost::filesystem::path> _file;
 102 };
 103
 104
 105 }
 106