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 <boost/filesystem.hpp>
  24 #include <boost/signals2.hpp>
  25 #include <boost/thread/mutex.hpp>
  26 #include <boost/enable_shared_from_this.hpp>
  27 #include <libxml++/libxml++.h>
  28 #include "types.h"
  29
  30 namespace cxml {
  31         class Node;
  32 }
  33
  34 class Job;
  35 class Film;
  36
  37 class ContentProperty
  38 {
  39 public:
  40         static int const START;
  41         static int const LENGTH;
  42 };
  43
  44 class Content : public boost::enable_shared_from_this<Content>
  45 {
  46 public:
  47         Content (boost::shared_ptr<const Film>, Time);
  48         Content (boost::shared_ptr<const Film>, boost::filesystem::path);
  49         Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  50         Content (Content const &);
  51         virtual ~Content () {}
  52
  53         virtual void examine (boost::shared_ptr<Job>);
  54         virtual std::string summary () const = 0;
  55         virtual std::string information () const = 0;
  56         virtual void as_xml (xmlpp::Node *) const;
  57         virtual boost::shared_ptr<Content> clone () const = 0;
  58         virtual Time length () const = 0;
  59
  60         boost::filesystem::path file () const {
  61                 boost::mutex::scoped_lock lm (_mutex);
  62                 return _file;
  63         }
  64
  65         std::string digest () const {
  66                 boost::mutex::scoped_lock lm (_mutex);
  67                 return _digest;
  68         }
  69
  70         void set_start (Time);
  71
  72         Time start () const {
  73                 boost::mutex::scoped_lock lm (_mutex);
  74                 return _start;
  75         }
  76
  77         Time end () const {
  78                 return start() + length();
  79         }
  80
  81         boost::signals2::signal<void (boost::weak_ptr<Content>, int)> Changed;
  82
  83 protected:
  84         void signal_changed (int);
  85
  86         boost::weak_ptr<const Film> _film;
  87         mutable boost::mutex _mutex;
  88
  89 private:
  90         boost::filesystem::path _file;
  91         std::string _digest;
  92         Time _start;
  93 };
  94
  95 #endif