]> git.sesse.net Git - casparcg/blob - core/producer/frame_producer.cpp
2.0.2: playlist_producer: Added as a simple example/template how to make a playlist...
[casparcg] / core / producer / frame_producer.cpp
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 #include "../StdAfx.h"\r
22 \r
23 #include "frame_producer.h"\r
24 #include "frame/basic_frame.h"\r
25 #include "frame/frame_transform.h"\r
26 \r
27 #include "color/color_producer.h"\r
28 #include "playlist/playlist_producer.h"\r
29 #include "separated/separated_producer.h"\r
30 \r
31 #include <common/memory/safe_ptr.h>\r
32 #include <common/concurrency/executor.h>\r
33 #include <common/exception/exceptions.h>\r
34 #include <common/utility/move_on_copy.h>\r
35 \r
36 namespace caspar { namespace core {\r
37         \r
38 std::vector<const producer_factory_t> g_factories;\r
39         \r
40 class destroy_producer_proxy : public frame_producer\r
41 {       \r
42         std::shared_ptr<frame_producer>* producer_;\r
43 public:\r
44         destroy_producer_proxy(safe_ptr<frame_producer>&& producer) \r
45                 : producer_(new std::shared_ptr<frame_producer>(std::move(producer)))\r
46         {\r
47         }\r
48 \r
49         ~destroy_producer_proxy()\r
50         {               \r
51                 static auto destroyers = std::make_shared<tbb::concurrent_bounded_queue<std::shared_ptr<executor>>>();\r
52                 static tbb::atomic<int> destroyer_count;\r
53 \r
54                 try\r
55                 {\r
56                         std::shared_ptr<executor> destroyer;\r
57                         if(!destroyers->try_pop(destroyer))\r
58                         {\r
59                                 destroyer.reset(new executor(L"destroyer"));\r
60                                 destroyer->set_priority_class(below_normal_priority_class);\r
61                                 if(++destroyer_count > 16)\r
62                                         CASPAR_LOG(warning) << L"Potential destroyer dead-lock detected.";\r
63                                 CASPAR_LOG(trace) << "Created destroyer: " << destroyer_count;\r
64                         }\r
65                                 \r
66                         auto producer = producer_;\r
67                         auto pool         = destroyers;\r
68                         destroyer->begin_invoke([=]\r
69                         {\r
70                                 try\r
71                                 {\r
72                                         if(!producer->unique())\r
73                                                 CASPAR_LOG(trace) << (*producer)->print() << L" Not destroyed on safe asynchronous destruction thread: " << producer->use_count();\r
74                                         else\r
75                                                 CASPAR_LOG(trace) << (*producer)->print() << L" Destroying on safe asynchronous destruction thread.";\r
76                                 }\r
77                                 catch(...){}\r
78 \r
79                                 delete producer;\r
80                                 pool->push(destroyer);\r
81                         }); \r
82                 }\r
83                 catch(...)\r
84                 {\r
85                         CASPAR_LOG_CURRENT_EXCEPTION();\r
86                         try\r
87                         {\r
88                                 delete producer_;\r
89                         }\r
90                         catch(...){}\r
91                 }\r
92         }\r
93 \r
94         virtual safe_ptr<basic_frame>           receive(int hints)                                                                                              {return (*producer_)->receive(hints);}\r
95         virtual safe_ptr<basic_frame>           last_frame() const                                                                                              {return (*producer_)->last_frame();}\r
96         virtual std::wstring                            print() const                                                                                                   {return (*producer_)->print();}\r
97         virtual std::wstring                            param(const std::wstring& str)                                                                  {return (*producer_)->param(str);}\r
98         virtual safe_ptr<frame_producer>        get_following_producer() const                                                                  {return (*producer_)->get_following_producer();}\r
99         virtual void                                            set_leading_producer(const safe_ptr<frame_producer>& producer)  {(*producer_)->set_leading_producer(producer);}\r
100         virtual int64_t                                         nb_frames() const                                                                                               {return (*producer_)->nb_frames();}\r
101 };\r
102 \r
103 safe_ptr<core::frame_producer> create_destroy_proxy(safe_ptr<core::frame_producer>&& producer)\r
104 {\r
105         return make_safe<destroy_producer_proxy>(std::move(producer));\r
106 }\r
107 \r
108 class last_frame_producer : public frame_producer\r
109 {\r
110         const std::wstring                      print_;\r
111         const safe_ptr<basic_frame>     frame_;\r
112         const int64_t                           nb_frames_;\r
113 public:\r
114         last_frame_producer(const safe_ptr<frame_producer>& producer) \r
115                 : print_(producer->print())\r
116                 , frame_(producer->last_frame() != basic_frame::eof() ? producer->last_frame() : basic_frame::empty())\r
117                 , nb_frames_(producer->nb_frames())\r
118         {\r
119         }\r
120         \r
121         virtual safe_ptr<basic_frame> receive(int){return frame_;}\r
122         virtual safe_ptr<core::basic_frame> last_frame() const{return frame_;}\r
123         virtual std::wstring print() const{return L"dummy[" + print_ + L"]";}\r
124         virtual int64_t nb_frames() const {return nb_frames_;}  \r
125 };\r
126 \r
127 struct empty_frame_producer : public frame_producer\r
128 {\r
129         virtual safe_ptr<basic_frame> receive(int){return basic_frame::empty();}\r
130         virtual safe_ptr<basic_frame> last_frame() const{return basic_frame::empty();}\r
131         virtual void set_frame_factory(const safe_ptr<frame_factory>&){}\r
132         virtual int64_t nb_frames() const {return 0;}\r
133         virtual std::wstring print() const { return L"empty";}\r
134 };\r
135 \r
136 const safe_ptr<frame_producer>& frame_producer::empty() // nothrow\r
137 {\r
138         static safe_ptr<frame_producer> producer = make_safe<empty_frame_producer>();\r
139         return producer;\r
140 }       \r
141 \r
142 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints)\r
143 {       \r
144         auto frame = producer->receive(hints);\r
145         if(frame == basic_frame::eof())\r
146         {\r
147                 CASPAR_LOG(info) << producer->print() << " End Of File.";\r
148                 auto following = producer->get_following_producer();\r
149                 if(following != frame_producer::empty())\r
150                 {\r
151                         following->set_leading_producer(producer);\r
152                         producer = std::move(following);\r
153                 }\r
154                 else\r
155                         producer = make_safe<last_frame_producer>(producer);\r
156 \r
157                 return receive_and_follow(producer, hints);\r
158         }\r
159         return frame;\r
160 }\r
161 \r
162 void register_producer_factory(const producer_factory_t& factory)\r
163 {\r
164         g_factories.push_back(factory);\r
165 }\r
166 \r
167 safe_ptr<core::frame_producer> do_create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
168 {\r
169         if(params.empty())\r
170                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
171         \r
172         auto producer = frame_producer::empty();\r
173         std::any_of(g_factories.begin(), g_factories.end(), [&](const producer_factory_t& factory) -> bool\r
174                 {\r
175                         try\r
176                         {\r
177                                 producer = factory(my_frame_factory, params);\r
178                         }\r
179                         catch(...)\r
180                         {\r
181                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
182                         }\r
183                         return producer != frame_producer::empty();\r
184                 });\r
185 \r
186         if(producer == frame_producer::empty())\r
187                 producer = create_color_producer(my_frame_factory, params);\r
188         \r
189         if(producer == frame_producer::empty())\r
190                 producer = create_playlist_producer(my_frame_factory, params);\r
191 \r
192         return producer;\r
193 }\r
194 \r
195 \r
196 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
197 {       \r
198         auto producer = do_create_producer(my_frame_factory, params);\r
199         auto key_producer = frame_producer::empty();\r
200         \r
201         try // to find a key file.\r
202         {\r
203                 auto params_copy = params;\r
204                 if(params_copy.size() > 0)\r
205                 {\r
206                         params_copy[0] += L"_A";\r
207                         key_producer = do_create_producer(my_frame_factory, params_copy);                       \r
208                         if(key_producer == frame_producer::empty())\r
209                         {\r
210                                 params_copy[0] += L"LPHA";\r
211                                 key_producer = do_create_producer(my_frame_factory, params_copy);       \r
212                         }\r
213                 }\r
214         }\r
215         catch(...){}\r
216 \r
217         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
218                 return create_separated_producer(producer, key_producer);\r
219         \r
220         if(producer == frame_producer::empty())\r
221         {\r
222                 std::wstring str;\r
223                 BOOST_FOREACH(auto& param, params)\r
224                         str += param + L" ";\r
225                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(narrow(str)));\r
226         }\r
227 \r
228         return producer;\r
229 }\r
230 \r
231 \r
232 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& factory, const std::wstring& params)\r
233 {\r
234         std::wstringstream iss(params);\r
235         std::vector<std::wstring> tokens;\r
236         typedef std::istream_iterator<std::wstring, wchar_t, std::char_traits<wchar_t> > iterator;\r
237         std::copy(iterator(iss),  iterator(), std::back_inserter(tokens));\r
238         return create_producer(factory, tokens);\r
239 }\r
240 \r
241 }}