git.sesse.net Git - casparcg/blob - core/producer/layer.h

   1 /*\r
   2 * Copyright (c) 2011 Sveriges Television AB <info@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 <common/memory/safe_ptr.h>\r
  25 \r
  26 #include <boost/noncopyable.hpp>\r
  27 #include <boost/thread/future.hpp>\r
  28 #include <boost/property_tree/ptree_fwd.hpp>\r
  29 \r
  30 #include <string>\r
  31 \r
  32 namespace caspar { namespace core {\r
  33 \r
  34 struct frame_producer;\r
  35 class basic_frame;\r
  36 \r
  37 class layer : boost::noncopyable\r
  38 {\r
  39 public:\r
  40         layer(); // nothrow\r
  41         layer(layer&& other); // nothrow\r
  42         layer& operator=(layer&& other); // nothrow\r
  43         layer(const layer&);\r
  44         layer& operator=(const layer&);\r
  45 \r
  46         void swap(layer& other); // nothrow \r
  47                 \r
  48         void load(const safe_ptr<frame_producer>& producer, bool preview, int auto_play_delta); // nothrow\r
  49         void play(); // nothrow\r
  50         void pause(); // nothrow\r
  51         void stop(); // nothrow\r
  52         boost::unique_future<std::string> call(bool foreground, const std::string& param);\r
  53 \r
  54         bool is_paused() const;\r
  55         int64_t frame_number() const;\r
  56         \r
  57         bool empty() const;\r
  58 \r
  59         safe_ptr<frame_producer> foreground() const; // nothrow\r
  60         safe_ptr<frame_producer> background() const; // nothrow\r
  61 \r
  62         safe_ptr<basic_frame> receive(int hints); // nothrow\r
  63 \r
  64         boost::property_tree::ptree info() const;\r
  65 private:\r
  66         struct implementation;\r
  67         safe_ptr<implementation> impl_;\r
  68 };\r
  69 \r
  70 }}