git.sesse.net Git - casparcg/blob - core/consumer/output.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
  27 #include <common/forward.h>
  28 #include <common/future_fwd.h>
  29 #include <common/memory.h>
  30
  31 #include <boost/property_tree/ptree_fwd.hpp>
  32
  33 #include <future>
  34
  35 FORWARD2(caspar, diagnostics, class graph);
  36
  37 namespace caspar { namespace core {
  38
  39 class output final
  40 {
  41         output(const output&);
  42         output& operator=(const output&);
  43 public:
  44
  45         // Static Members
  46
  47         // Constructors
  48
  49         explicit output(spl::shared_ptr<caspar::diagnostics::graph> graph, const video_format_desc& format_desc, const core::audio_channel_layout& channel_layout, int channel_index);
  50
  51         // Methods
  52
  53         // Returns when submitted to consumers, but the future indicates when the consumers are ready for a new frame.
  54         std::future<void> operator()(const_frame frame, const video_format_desc& format_desc, const core::audio_channel_layout& channel_layout);
  55
  56         void add(const spl::shared_ptr<frame_consumer>& consumer);
  57         void add(int index, const spl::shared_ptr<frame_consumer>& consumer);
  58         void remove(const spl::shared_ptr<frame_consumer>& consumer);
  59         void remove(int index);
  60
  61         monitor::subject& monitor_output();
  62
  63         // Properties
  64
  65         std::future<boost::property_tree::wptree> info() const;
  66         std::future<boost::property_tree::wptree> delay_info() const;
  67         std::vector<spl::shared_ptr<const frame_consumer>> get_consumers() const;
  68
  69 private:
  70         struct impl;
  71         spl::shared_ptr<impl> impl_;
  72 };
  73
  74 }}