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