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

   1 /*\r
   2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 *  This file is part of CasparCG.\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 */\r
  20 \r
  21 #pragma once\r
  22 \r
  23 #include <common/memory/safe_ptr.h>\r
  24 \r
  25 #include <boost/noncopyable.hpp>\r
  26 #include <boost/thread/future.hpp>\r
  27 #include <boost/property_tree/ptree_fwd.hpp>\r
  28 \r
  29 #include <string>\r
  30 \r
  31 namespace caspar { namespace core {\r
  32 \r
  33 struct frame_producer;\r
  34 class basic_frame;\r
  35 \r
  36 struct layer_status\r
  37 {\r
  38         std::wstring    foreground;\r
  39         std::wstring    background;\r
  40         bool                    is_paused;\r
  41         int64_t                 nb_frames;\r
  42         int64_t                 frame_number;\r
  43         int64_t                 file_nb_frames;\r
  44         int64_t                 file_frame_number;\r
  45 };\r
  46 \r
  47 class layer : boost::noncopyable\r
  48 {\r
  49 public:\r
  50         layer(); // nothrow\r
  51         layer(layer&& other); // nothrow\r
  52         layer& operator=(layer&& other); // nothrow\r
  53         layer(const layer&);\r
  54         layer& operator=(const layer&);\r
  55 \r
  56         void swap(layer& other); // nothrow \r
  57                 \r
  58         void load(const safe_ptr<frame_producer>& producer, bool preview, int auto_play_delta); // nothrow\r
  59         void play(); // nothrow\r
  60         void pause(); // nothrow\r
  61         void stop(); // nothrow\r
  62         boost::unique_future<std::wstring> call(bool foreground, const std::wstring& param);\r
  63 \r
  64         bool is_paused() const;\r
  65         int64_t frame_number() const;\r
  66 \r
  67         layer_status status() const;\r
  68 \r
  69         bool empty() const;\r
  70 \r
  71         safe_ptr<frame_producer> foreground() const; // nothrow\r
  72         safe_ptr<frame_producer> background() const; // nothrow\r
  73 \r
  74         safe_ptr<basic_frame> receive(); // nothrow\r
  75 \r
  76         boost::property_tree::wptree info() const;\r
  77 private:\r
  78         struct implementation;\r
  79         safe_ptr<implementation> impl_;\r
  80 };\r
  81 \r
  82 }}