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 #include "dcpomatic_time.h"
  31
  32 namespace cxml {
  33         class Node;
  34 }
  35
  36 class Job;
  37 class Film;
  38
  39 class ContentProperty
  40 {
  41 public:
  42         static int const PATH;
  43         static int const POSITION;
  44         static int const LENGTH;
  45         static int const TRIM_START;
  46         static int const TRIM_END;
  47 };
  48
  49 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
  50 {
  51 public:
  52         Content (boost::shared_ptr<const Film>);
  53         Content (boost::shared_ptr<const Film>, DCPTime);
  54         Content (boost::shared_ptr<const Film>, boost::filesystem::path);
  55         Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  56         Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  57         virtual ~Content () {}
  58
  59         virtual void examine (boost::shared_ptr<Job>);
  60         virtual std::string summary () const = 0;
  61         /** @return Technical details of this content; these are written to logs to
  62          *  help with debugging.
  63          */
  64         virtual std::string technical_summary () const;
  65         virtual std::string information () const = 0;
  66         virtual void as_xml (xmlpp::Node *) const;
  67         virtual DCPTime full_length () const = 0;
  68         virtual std::string identifier () const;
  69
  70         boost::shared_ptr<Content> clone () const;
  71
  72         void set_path (boost::filesystem::path);
  73
  74         std::string path_summary () const;
  75
  76         std::vector<boost::filesystem::path> paths () const {
  77                 boost::mutex::scoped_lock lm (_mutex);
  78                 return _paths;
  79         }
  80
  81         size_t number_of_paths () const {
  82                 boost::mutex::scoped_lock lm (_mutex);
  83                 return _paths.size ();
  84         }
  85
  86         boost::filesystem::path path (size_t i) const {
  87                 boost::mutex::scoped_lock lm (_mutex);
  88                 return _paths[i];
  89         }
  90
  91         bool paths_valid () const;
  92
  93         /** @return MD5 digest of the content's file(s) */
  94         std::string digest () const {
  95                 boost::mutex::scoped_lock lm (_mutex);
  96                 return _digest;
  97         }
  98
  99         void set_position (DCPTime);
 100
 101         /** DCPTime that this content starts; i.e. the time that the first
 102          *  bit of the content (trimmed or not) will happen.
 103          */
 104         DCPTime position () const {
 105                 boost::mutex::scoped_lock lm (_mutex);
 106                 return _position;
 107         }
 108
 109         void set_trim_start (DCPTime);
 110
 111         DCPTime trim_start () const {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 return _trim_start;
 114         }
 115
 116         void set_trim_end (DCPTime);
 117
 118         DCPTime trim_end () const {
 119                 boost::mutex::scoped_lock lm (_mutex);
 120                 return _trim_end;
 121         }
 122
 123         DCPTime end () const {
 124                 return position() + length_after_trim();
 125         }
 126
 127         DCPTime length_after_trim () const;
 128
 129         void set_change_signals_frequent (bool f) {
 130                 _change_signals_frequent = f;
 131         }
 132
 133         boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
 134
 135 protected:
 136         void signal_changed (int);
 137
 138         boost::weak_ptr<const Film> _film;
 139
 140         /** _mutex which should be used to protect accesses, as examine
 141             jobs can update content state in threads other than the main one.
 142         */
 143         mutable boost::mutex _mutex;
 144
 145         /** Paths of our data files */
 146         std::vector<boost::filesystem::path> _paths;
 147
 148 private:
 149         std::string _digest;
 150         DCPTime _position;
 151         DCPTime _trim_start;
 152         DCPTime _trim_end;
 153         bool _change_signals_frequent;
 154 };
 155
 156 #endif