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 POSITION;
  42         static int const LENGTH;
  43         static int const TRIM_START;
  44         static int const TRIM_END;
  45 };
  46
  47 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
  48 {
  49 public:
  50         Content (boost::shared_ptr<const Film>, Time);
  51         Content (boost::shared_ptr<const Film>, boost::filesystem::path);
  52         Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  53         virtual ~Content () {}
  54
  55         virtual void examine (boost::shared_ptr<Job>);
  56         virtual std::string summary () const = 0;
  57         virtual std::string technical_summary () const;
  58         virtual std::string information () const = 0;
  59         virtual void as_xml (xmlpp::Node *) const;
  60         virtual Time full_length () const = 0;
  61
  62         boost::shared_ptr<Content> clone () const;
  63
  64         boost::filesystem::path path () const {
  65                 boost::mutex::scoped_lock lm (_mutex);
  66                 return _path;
  67         }
  68
  69         /** @return MD5 digest of the content's file(s) */
  70         std::string digest () const {
  71                 boost::mutex::scoped_lock lm (_mutex);
  72                 return _digest;
  73         }
  74
  75         void set_position (Time);
  76
  77         /** Time that this content starts; i.e. the time that the first
  78          *  bit of the content (trimmed or not) will happen.
  79          */
  80         Time position () const {
  81                 boost::mutex::scoped_lock lm (_mutex);
  82                 return _position;
  83         }
  84
  85         void set_trim_start (Time);
  86
  87         Time trim_start () const {
  88                 boost::mutex::scoped_lock lm (_mutex);
  89                 return _trim_start;
  90         }
  91
  92         void set_trim_end (Time);
  93
  94         Time trim_end () const {
  95                 boost::mutex::scoped_lock lm (_mutex);
  96                 return _trim_end;
  97         }
  98
  99         Time end () const {
 100                 return position() + length_after_trim();
 101         }
 102
 103         Time length_after_trim () const;
 104
 105         void set_change_signals_frequent (bool f) {
 106                 _change_signals_frequent = f;
 107         }
 108
 109         bool trimmed (Time) const;
 110
 111         boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
 112
 113 protected:
 114         void signal_changed (int);
 115
 116         boost::weak_ptr<const Film> _film;
 117
 118         /** _mutex which should be used to protect accesses, as examine
 119             jobs can update content state in threads other than the main one.
 120         */
 121         mutable boost::mutex _mutex;
 122
 123 private:
 124         /** Path of a file or a directory containing files */
 125         boost::filesystem::path _path;
 126         std::string _digest;
 127         Time _position;
 128         Time _trim_start;
 129         Time _trim_end;
 130         bool _change_signals_frequent;
 131 };
 132
 133 #endif