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 \r
  27 #include <string>\r
  28 \r
  29 namespace caspar { namespace core {\r
  30 \r
  31 struct frame_producer;\r
  32 class basic_frame;\r
  33 \r
  34 struct layer_status\r
  35 {\r
  36         std::wstring    foreground;\r
  37         std::wstring    background;\r
  38         bool                    is_paused;\r
  39         int64_t                 total_frames;\r
  40         int64_t                 current_frame;\r
  41 };\r
  42 \r
  43 class layer : boost::noncopyable\r
  44 {\r
  45 public:\r
  46         layer(); // nothrow\r
  47         layer(layer&& other); // nothrow\r
  48         layer& operator=(layer&& other); // nothrow\r
  49         layer(const layer&);\r
  50         layer& operator=(const layer&);\r
  51 \r
  52         void swap(layer& other); // nothrow \r
  53                 \r
  54         void load(const safe_ptr<frame_producer>& producer, bool preview, int auto_play_delta); // nothrow\r
  55         void play(); // nothrow\r
  56         void pause(); // nothrow\r
  57         void stop(); // nothrow\r
  58         std::wstring param(bool foreground, const std::wstring& param);\r
  59 \r
  60         bool is_paused() const;\r
  61         int64_t frame_number() const;\r
  62 \r
  63         layer_status status() const;\r
  64 \r
  65         bool empty() const;\r
  66 \r
  67         safe_ptr<frame_producer> foreground() const; // nothrow\r
  68         safe_ptr<frame_producer> background() const; // nothrow\r
  69 \r
  70         safe_ptr<basic_frame> receive(); // nothrow\r
  71 private:\r
  72         struct implementation;\r
  73         safe_ptr<implementation> impl_;\r
  74 };\r
  75 \r
  76 }}