git.sesse.net Git - casparcg/blob - core/consumer/frame_consumer.h

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG is free software: you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation, either version 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #pragma once
  23
  24 #include "../monitor/monitor.h"
  25 #include "../fwd.h"
  26 #include "../help/help_repository.h"
  27
  28 #include <common/memory.h>
  29 #include <common/future_fwd.h>
  30
  31 #include <boost/property_tree/ptree_fwd.hpp>
  32
  33 #include <functional>
  34 #include <string>
  35 #include <vector>
  36
  37 namespace caspar { namespace core {
  38
  39 // Interface
  40 class frame_consumer
  41 {
  42         frame_consumer(const frame_consumer&);
  43         frame_consumer& operator=(const frame_consumer&);
  44 public:
  45
  46         // Static Members
  47
  48         static const spl::shared_ptr<frame_consumer>& empty();
  49
  50         // Constructors
  51
  52         frame_consumer(){}
  53         virtual ~frame_consumer() {}
  54
  55         // Methods
  56
  57         virtual std::future<bool>                               send(const_frame frame) = 0;
  58         virtual void                                                    initialize(const video_format_desc& format_desc, int channel_index) = 0;
  59
  60         // monitor::observable
  61
  62         virtual monitor::subject& monitor_output() = 0;
  63
  64         // Properties
  65
  66         virtual std::wstring                                    print() const = 0;
  67         virtual std::wstring                                    name() const = 0;
  68         virtual boost::property_tree::wptree    info() const = 0;
  69         virtual bool                                                    has_synchronization_clock() const {return true;}
  70         virtual int                                                             buffer_depth() const = 0; // -1 to not participate in frame presentation synchronization
  71         virtual int                                                             index() const = 0;
  72         virtual int64_t                                                 presentation_frame_age_millis() const = 0;
  73 };
  74
  75 typedef std::function<spl::shared_ptr<frame_consumer>(
  76                 const std::vector<std::wstring>&,
  77                 interaction_sink* sink)> consumer_factory_t;
  78 typedef std::function<spl::shared_ptr<frame_consumer>(
  79                 const boost::property_tree::wptree& element,
  80                 interaction_sink* sink)> preconfigured_consumer_factory_t;
  81
  82 class frame_consumer_registry : boost::noncopyable
  83 {
  84 public:
  85         frame_consumer_registry(spl::shared_ptr<help_repository> help_repo);
  86         void register_consumer_factory(const std::wstring& name, const consumer_factory_t& factory, const help_item_describer& describer);
  87         void register_preconfigured_consumer_factory(
  88                         const std::wstring& element_name,
  89                         const preconfigured_consumer_factory_t& factory);
  90         spl::shared_ptr<frame_consumer> create_consumer(
  91                         const std::vector<std::wstring>& params,
  92                         interaction_sink* sink) const;
  93         spl::shared_ptr<frame_consumer> create_consumer(
  94                         const std::wstring& element_name,
  95                         const boost::property_tree::wptree& element,
  96                         interaction_sink* sink) const;
  97 private:
  98         struct impl;
  99         spl::shared_ptr<impl> impl_;
 100 };
 101
 102 }}