src/lib/remembered_asset.h

   1 /*
   2     Copyright (C) 2024 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic 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     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #ifndef DCPOMATIC_REMEMBERED_ASSET_H
  23 #define DCPOMATIC_REMEMBERED_ASSET_H
  24
  25
  26 #include "dcpomatic_time.h"
  27 #include <libcxml/cxml.h>
  28 #include <libxml++/libxml++.h>
  29 #include <boost/filesystem.hpp>
  30
  31
  32 class RememberedAsset
  33 {
  34 public:
  35         explicit RememberedAsset(cxml::ConstNodePtr node);
  36
  37         RememberedAsset(boost::filesystem::path filename, dcpomatic::DCPTimePeriod period, std::string identifier)
  38                 : _filename(filename)
  39                 , _period(period)
  40                 , _identifier(std::move(identifier))
  41         {}
  42
  43         void as_xml(xmlpp::Element* parent) const;
  44
  45         boost::filesystem::path filename() const {
  46                 return _filename;
  47         }
  48
  49         dcpomatic::DCPTimePeriod period() const {
  50                 return _period;
  51         }
  52
  53         std::string identifier() const {
  54                 return _identifier;
  55         }
  56
  57 private:
  58         boost::filesystem::path _filename;
  59         dcpomatic::DCPTimePeriod _period;
  60         std::string _identifier;
  61 };
  62
  63
  64 boost::optional<boost::filesystem::path> find_asset(
  65         std::vector<RememberedAsset> const& assets, boost::filesystem::path directory, dcpomatic::DCPTimePeriod period, std::string identifier
  66         );
  67
  68
  69
  70 #endif
  71