git.sesse.net Git - casparcg/blob - protocol/amcp/AMCPCommand.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: Nicklas P Andersson\r
  20 */\r
  21 \r
  22 #pragma once\r
  23 \r
  24 #include "../util/clientinfo.h"\r
  25 \r
  26 #include <core/consumer/frame_consumer.h>\r
  27 #include <core/video_channel.h>\r
  28 #include <core/thumbnail_generator.h>\r
  29 \r
  30 #include <boost/algorithm/string.hpp>\r
  31 \r
  32 namespace caspar { namespace protocol {\r
  33 namespace amcp {\r
  34 \r
  35         enum AMCPCommandScheduling\r
  36         {\r
  37                 Default = 0,\r
  38                 AddToQueue,\r
  39                 ImmediatelyAndClear\r
  40         };\r
  41 \r
  42         class AMCPCommand\r
  43         {\r
  44                 AMCPCommand(const AMCPCommand&);\r
  45                 AMCPCommand& operator=(const AMCPCommand&);\r
  46         public:\r
  47                 AMCPCommand();\r
  48                 virtual ~AMCPCommand() {}\r
  49                 virtual bool Execute() = 0;\r
  50 \r
  51                 virtual bool NeedChannel() = 0;\r
  52                 virtual AMCPCommandScheduling GetDefaultScheduling() = 0;\r
  53                 virtual int GetMinimumParameters() = 0;\r
  54 \r
  55                 void SendReply();\r
  56 \r
  57                 void AddParameter(const std::wstring& param){_parameters.push_back(param);}\r
  58 \r
  59                 void SetClientInfo(IO::ClientInfoPtr& s){pClientInfo_ = s;}\r
  60                 IO::ClientInfoPtr GetClientInfo(){return pClientInfo_;}\r
  61 \r
  62                 void SetChannel(const std::shared_ptr<core::video_channel>& pChannel){pChannel_ = pChannel;}\r
  63                 std::shared_ptr<core::video_channel> GetChannel(){return pChannel_;}\r
  64 \r
  65                 void SetChannels(const std::vector<safe_ptr<core::video_channel>>& channels){channels_ = channels;}\r
  66                 const std::vector<safe_ptr<core::video_channel>>& GetChannels() { return channels_; }\r
  67 \r
  68                 void SetThumbGenerator(const std::shared_ptr<core::thumbnail_generator>& thumb_gen) {thumb_gen_ = thumb_gen;}\r
  69                 std::shared_ptr<core::thumbnail_generator> GetThumbGenerator() { return thumb_gen_; }\r
  70 \r
  71                 void SetChannelIndex(unsigned int channelIndex){channelIndex_ = channelIndex;}\r
  72                 unsigned int GetChannelIndex(){return channelIndex_;}\r
  73 \r
  74                 void SetLayerIntex(int layerIndex){layerIndex_ = layerIndex;}\r
  75                 int GetLayerIndex(int defaultValue = 0) const{return layerIndex_ != -1 ? layerIndex_ : defaultValue;}\r
  76 \r
  77                 virtual void Clear();\r
  78 \r
  79                 AMCPCommandScheduling GetScheduling()\r
  80                 {\r
  81                         return scheduling_ == Default ? GetDefaultScheduling() : scheduling_;\r
  82                 }\r
  83 \r
  84                 virtual std::wstring print() const = 0;\r
  85 \r
  86                 void SetScheduling(AMCPCommandScheduling s){scheduling_ = s;}\r
  87                 void SetReplyString(const std::wstring& str){replyString_ = str;}\r
  88 \r
  89         protected:\r
  90                 std::vector<std::wstring> _parameters;\r
  91                 std::vector<std::wstring> _parameters2;\r
  92 \r
  93         private:\r
  94                 unsigned int channelIndex_;\r
  95                 int layerIndex_;\r
  96                 IO::ClientInfoPtr pClientInfo_;\r
  97                 std::shared_ptr<core::video_channel> pChannel_;\r
  98                 std::vector<safe_ptr<core::video_channel>> channels_;\r
  99                 std::shared_ptr<core::thumbnail_generator> thumb_gen_;\r
 100                 AMCPCommandScheduling scheduling_;\r
 101                 std::wstring replyString_;\r
 102         };\r
 103 \r
 104         typedef std::tr1::shared_ptr<AMCPCommand> AMCPCommandPtr;\r
 105 \r
 106         template<bool TNeedChannel, AMCPCommandScheduling TScheduling, int TMinParameters>\r
 107         class AMCPCommandBase : public AMCPCommand\r
 108         {\r
 109         public:\r
 110                 virtual bool Execute()\r
 111                 {\r
 112                         _parameters2 = _parameters;\r
 113                         for(size_t n = 0; n < _parameters.size(); ++n)\r
 114                                 _parameters[n] = boost::to_upper_copy(_parameters[n]);\r
 115                         return (TNeedChannel && !GetChannel()) || _parameters.size() < TMinParameters ? false : DoExecute();\r
 116                 }\r
 117 \r
 118                 virtual bool NeedChannel(){return TNeedChannel;}                \r
 119                 virtual AMCPCommandScheduling GetDefaultScheduling(){return TScheduling;}\r
 120                 virtual int GetMinimumParameters(){return TMinParameters;}\r
 121         protected:\r
 122                 ~AMCPCommandBase(){}\r
 123         private:\r
 124                 virtual bool DoExecute() = 0;\r
 125         };      \r
 126 \r
 127 }}}\r