git.sesse.net Git - casparcg/blob - stage.h

   1 /*\r
   2 * Copyright 2013 Sveriges Television AB http://casparcg.com/\r
   3 *\r
   4 * This file is part of CasparCG (www.casparcg.com).\r
   5 *\r
   6 * CasparCG is free software: you can redistribute it and/or modify\r
   7 * it under the terms of the GNU General Public License as published by\r
   8 * the Free Software Foundation, either version 3 of the License, or\r
   9 * (at your option) any later version.\r
  10 *\r
  11 * CasparCG is distributed in the hope that it will be useful,\r
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14 * GNU General Public License for more details.\r
  15 *\r
  16 * You should have received a copy of the GNU General Public License\r
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
  18 *\r
  19 * Author: Robert Nagy, ronag89@gmail.com\r
  20 */\r
  21 \r
  22 #pragma once\r
  23 \r
  24 #include "frame_producer.h"\r
  25 \r
  26 #include "../monitor/monitor.h"\r
  27 \r
  28 #include <common/memory/safe_ptr.h>\r
  29 #include <common/concurrency/target.h>\r
  30 #include <common/diagnostics/graph.h>\r
  31 \r
  32 #include <boost/noncopyable.hpp>\r
  33 #include <boost/property_tree/ptree_fwd.hpp>\r
  34 #include <boost/thread/future.hpp>\r
  35 \r
  36 #include <functional>\r
  37 \r
  38 namespace caspar { namespace core {\r
  39 \r
  40 struct video_format_desc;\r
  41 struct frame_transform;\r
  42 struct write_frame_consumer;\r
  43 \r
  44 class stage : boost::noncopyable\r
  45 {\r
  46 public:\r
  47 \r
  48         // Static Members\r
  49 \r
  50         typedef std::function<struct frame_transform(struct frame_transform)>                                                   transform_func_t;\r
  51         typedef std::tuple<int, transform_func_t, unsigned int, std::wstring>                                                   transform_tuple_t;\r
  52         typedef target<std::pair<std::map<int, safe_ptr<basic_frame>>, std::shared_ptr<void>>> target_t;\r
  53 \r
  54         // Constructors\r
  55 \r
  56         explicit stage(const safe_ptr<diagnostics::graph>& graph, const safe_ptr<target_t>& target, const video_format_desc& format_desc);\r
  57         \r
  58         // Methods\r
  59         \r
  60         void apply_transforms(const std::vector<transform_tuple_t>& transforms);\r
  61         void apply_transform(int index, const transform_func_t& transform, unsigned int mix_duration = 0, const std::wstring& tween = L"linear");\r
  62         void clear_transforms(int index);\r
  63         void clear_transforms();\r
  64         frame_transform get_current_transform(int index);\r
  65 \r
  66         void spawn_token();\r
  67                         \r
  68         void load(int index, const safe_ptr<frame_producer>& producer, bool preview = false, int auto_play_delta = -1);\r
  69         void pause(int index);\r
  70         void resume(int index);\r
  71         void play(int index);\r
  72         void stop(int index);\r
  73         void clear(int index);\r
  74         void clear();   \r
  75         void swap_layers(const safe_ptr<stage>& other);\r
  76         void swap_layer(int index, size_t other_index);\r
  77         void swap_layer(int index, size_t other_index, const safe_ptr<stage>& other);\r
  78 \r
  79         void add_layer_consumer(void* token, int layer, const std::shared_ptr<write_frame_consumer>& layer_consumer);\r
  80         void remove_layer_consumer(void* token, int layer);\r
  81 \r
  82         boost::unique_future<std::wstring>                              call(int index, bool foreground, const std::wstring& param);\r
  83 \r
  84         // Properties\r
  85 \r
  86         boost::unique_future<safe_ptr<frame_producer>>  foreground(int index);\r
  87         boost::unique_future<safe_ptr<frame_producer>>  background(int index);\r
  88 \r
  89         boost::unique_future<boost::property_tree::wptree> info() const;\r
  90         boost::unique_future<boost::property_tree::wptree> info(int layer) const;\r
  91 \r
  92         boost::unique_future<boost::property_tree::wptree> delay_info() const;\r
  93         boost::unique_future<boost::property_tree::wptree> delay_info(int layer) const;\r
  94         \r
  95         void set_video_format_desc(const video_format_desc& format_desc);\r
  96                 \r
  97         monitor::subject& monitor_output();\r
  98 \r
  99 private:\r
 100         struct implementation;\r
 101         safe_ptr<implementation> impl_;\r
 102 };\r
 103 \r
 104 }}