src/lib/spl.h

   1 /*
   2     Copyright (C) 2018 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 #ifndef DCPOMATIC_SPL_H
  22 #define DCPOMATIC_SPL_H
  23
  24 #include "spl_entry.h"
  25 #include <dcp/util.h>
  26
  27 class ContentStore;
  28
  29 class SPL
  30 {
  31 public:
  32         SPL ()
  33                 : _id (dcp::make_uuid())
  34                 , _missing (false)
  35         {}
  36
  37         void add (SPLEntry e) {
  38                 _spl.push_back (e);
  39         }
  40
  41         void remove (std::size_t index) {
  42                 _spl.erase (_spl.begin() + index);
  43         }
  44
  45         std::vector<SPLEntry> const & get () const {
  46                 return _spl;
  47         }
  48
  49         SPLEntry & operator[] (std::size_t index) {
  50                 return _spl[index];
  51         }
  52
  53         SPLEntry const & operator[] (std::size_t index) const {
  54                 return _spl[index];
  55         }
  56
  57         void read (boost::filesystem::path path, ContentStore* store);
  58         void write (boost::filesystem::path path) const;
  59
  60         std::string id () const {
  61                 return _id;
  62         }
  63
  64         boost::optional<boost::filesystem::path> path () const {
  65                 return _path;
  66         }
  67
  68         std::string name () const {
  69                 if (!_path) {
  70                         return "";
  71                 }
  72                 return _path->filename().string();
  73         }
  74
  75         bool missing () const {
  76                 return _missing;
  77         }
  78
  79         boost::optional<int> allowed_shows () const {
  80                 return _allowed_shows;
  81         }
  82
  83         bool have_allowed_shows () const {
  84                 return !_allowed_shows || *_allowed_shows > 0;
  85         }
  86
  87         void set_allowed_shows (int s) {
  88                 _allowed_shows = s;
  89         }
  90
  91         void unset_allowed_shows () {
  92                 _allowed_shows = boost::optional<int>();
  93         }
  94
  95         void decrement_allowed_shows () {
  96                 if (_allowed_shows) {
  97                         (*_allowed_shows)--;
  98                 }
  99
 100         }
 101
 102 private:
 103         std::string _id;
 104         mutable boost::optional<boost::filesystem::path> _path;
 105         std::vector<SPLEntry> _spl;
 106         /** true if any content was missing when read() was last called on this SPL */
 107         bool _missing;
 108         /** number of times left that the player will allow this playlist to be played (unset means infinite shows) */
 109         boost::optional<int> _allowed_shows;
 110 };
 111
 112 #endif