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