src/lib/content.h

   1 /*
   2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_CONTENT_H
  21 #define DCPOMATIC_CONTENT_H
  22
  23 #include <set>
  24 #include <boost/filesystem.hpp>
  25 #include <boost/signals2.hpp>
  26 #include <boost/thread/mutex.hpp>
  27 #include <boost/enable_shared_from_this.hpp>
  28 #include <libxml++/libxml++.h>
  29 #include "types.h"
  30
  31 namespace cxml {
  32         class Node;
  33 }
  34
  35 class Job;
  36 class Film;
  37
  38 class ContentProperty
  39 {
  40 public:
  41         static int const PATH;
  42         static int const POSITION;
  43         static int const LENGTH;
  44         static int const TRIM_START;
  45         static int const TRIM_END;
  46 };
  47
  48 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
  49 {
  50 public:
  51         Content (boost::shared_ptr<const Film>);
  52         Content (boost::shared_ptr<const Film>, DCPTime);
  53         Content (boost::shared_ptr<const Film>, boost::filesystem::path);
  54         Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  55         Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  56         virtual ~Content () {}
  57
  58         virtual void examine (boost::shared_ptr<Job>);
  59         virtual std::string summary () const = 0;
  60         virtual std::string technical_summary () const;
  61         virtual std::string information () const = 0;
  62         virtual void as_xml (xmlpp::Node *) const;
  63         virtual DCPTime full_length () const = 0;
  64         virtual std::string identifier () const;
  65
  66         boost::shared_ptr<Content> clone () const;
  67
  68         void set_path (boost::filesystem::path);
  69
  70         std::string path_summary () const;
  71
  72         std::vector<boost::filesystem::path> paths () const {
  73                 boost::mutex::scoped_lock lm (_mutex);
  74                 return _paths;
  75         }
  76
  77         size_t number_of_paths () const {
  78                 boost::mutex::scoped_lock lm (_mutex);
  79                 return _paths.size ();
  80         }
  81
  82         boost::filesystem::path path (size_t i) const {
  83                 boost::mutex::scoped_lock lm (_mutex);
  84                 return _paths[i];
  85         }
  86
  87         bool paths_valid () const;
  88
  89         /** @return MD5 digest of the content's file(s) */
  90         std::string digest () const {
  91                 boost::mutex::scoped_lock lm (_mutex);
  92                 return _digest;
  93         }
  94
  95         void set_position (DCPTime);
  96
  97         /** DCPTime that this content starts; i.e. the time that the first
  98          *  bit of the content (trimmed or not) will happen.
  99          */
 100         DCPTime position () const {
 101                 boost::mutex::scoped_lock lm (_mutex);
 102                 return _position;
 103         }
 104
 105         void set_trim_start (DCPTime);
 106
 107         DCPTime trim_start () const {
 108                 boost::mutex::scoped_lock lm (_mutex);
 109                 return _trim_start;
 110         }
 111
 112         void set_trim_end (DCPTime);
 113
 114         DCPTime trim_end () const {
 115                 boost::mutex::scoped_lock lm (_mutex);
 116                 return _trim_end;
 117         }
 118
 119         DCPTime end () const {
 120                 return position() + length_after_trim() - 1;
 121         }
 122
 123         DCPTime length_after_trim () const;
 124
 125         void set_change_signals_frequent (bool f) {
 126                 _change_signals_frequent = f;
 127         }
 128
 129         bool trimmed (DCPTime) const;
 130
 131         boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
 132
 133 protected:
 134         void signal_changed (int);
 135
 136         boost::weak_ptr<const Film> _film;
 137
 138         /** _mutex which should be used to protect accesses, as examine
 139             jobs can update content state in threads other than the main one.
 140         */
 141         mutable boost::mutex _mutex;
 142
 143         /** Paths of our data files */
 144         std::vector<boost::filesystem::path> _paths;
 145
 146 private:
 147         std::string _digest;
 148         DCPTime _position;
 149         DCPTime _trim_start;
 150         DCPTime _trim_end;
 151         bool _change_signals_frequent;
 152 };
 153
 154 #endif