]> git.sesse.net Git - casparcg/blob - core/consumer/frame_consumer.cpp
2.0.2: Is now locked, only bug fixes should be added. New features go into 2.1.0.
[casparcg] / core / consumer / frame_consumer.cpp
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 #include "../StdAfx.h"\r
23 \r
24 #include "frame_consumer.h"\r
25 \r
26 #include <common/env.h>\r
27 #include <common/memory/safe_ptr.h>\r
28 #include <common/exception/exceptions.h>\r
29 #include <core/video_format.h>\r
30 #include <core/mixer/read_frame.h>\r
31 \r
32 #include <boost/circular_buffer.hpp>\r
33 \r
34 namespace caspar { namespace core {\r
35                 \r
36 std::vector<const consumer_factory_t> g_factories;\r
37 \r
38 void register_consumer_factory(const consumer_factory_t& factory)\r
39 {\r
40         g_factories.push_back(factory);\r
41 }\r
42 \r
43 safe_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)\r
44 {\r
45         if(params.empty())\r
46                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
47         \r
48         auto consumer = frame_consumer::empty();\r
49         std::any_of(g_factories.begin(), g_factories.end(), [&](const consumer_factory_t& factory) -> bool\r
50                 {\r
51                         try\r
52                         {\r
53                                 consumer = factory(params);\r
54                         }\r
55                         catch(...)\r
56                         {\r
57                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
58                         }\r
59                         return consumer != frame_consumer::empty();\r
60                 });\r
61 \r
62         if(consumer == frame_consumer::empty())\r
63                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax."));\r
64 \r
65         return consumer;\r
66 }\r
67 \r
68 // This class is used to guarantee that audio cadence is correct. This is important for NTSC audio.\r
69 class cadence_guard : public frame_consumer\r
70 {\r
71         safe_ptr<frame_consumer>                consumer_;\r
72         std::vector<size_t>                             audio_cadence_;\r
73         boost::circular_buffer<size_t>  sync_buffer_;\r
74         bool                                                    synced_;\r
75 public:\r
76         cadence_guard(const safe_ptr<frame_consumer>& consumer)\r
77                 : consumer_(consumer)\r
78         {\r
79         }\r
80         \r
81         virtual void initialize(const video_format_desc& format_desc, int channel_index) override\r
82         {\r
83                 audio_cadence_  = format_desc.audio_cadence;\r
84                 sync_buffer_    = boost::circular_buffer<size_t>(format_desc.audio_cadence.size());\r
85                 consumer_->initialize(format_desc, channel_index);\r
86         }\r
87 \r
88         virtual bool send(const safe_ptr<read_frame>& frame) override\r
89         {               \r
90                 sync_buffer_.push_back(static_cast<size_t>(frame->audio_data().size()));\r
91                 \r
92                 if(!boost::range::equal(sync_buffer_, audio_cadence_))\r
93                 {\r
94                         synced_ = false;\r
95                         CASPAR_LOG(trace) << L"[cadence_guard] Audio cadence unsynced. Skipping frame.";\r
96                         return true;\r
97                 }\r
98                 else if(!synced_)\r
99                 {\r
100                         synced_ = true;\r
101                         boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);\r
102                         return true;\r
103                 }\r
104 \r
105                 boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);\r
106 \r
107                 return consumer_->send(frame);\r
108         }\r
109 \r
110         virtual std::wstring print() const override\r
111         {\r
112                 return consumer_->print();\r
113         }\r
114 \r
115         virtual boost::property_tree::wptree info() const override\r
116         {\r
117                 return consumer_->info();\r
118         }\r
119 \r
120         virtual bool has_synchronization_clock() const override\r
121         {\r
122                 return consumer_->has_synchronization_clock();\r
123         }\r
124 \r
125         virtual size_t buffer_depth() const override\r
126         {\r
127                 return consumer_->buffer_depth();\r
128         }\r
129 \r
130         virtual int index() const override\r
131         {\r
132                 return consumer_->index();\r
133         }\r
134 };\r
135 \r
136 safe_ptr<frame_consumer> create_consumer_cadence_guard(const safe_ptr<frame_consumer>& consumer)\r
137 {\r
138         return make_safe<cadence_guard>(std::move(consumer));\r
139 }\r
140 \r
141 const safe_ptr<frame_consumer>& frame_consumer::empty()\r
142 {\r
143         struct empty_frame_consumer : public frame_consumer\r
144         {\r
145                 virtual bool send(const safe_ptr<read_frame>&) override {return false;}\r
146                 virtual void initialize(const video_format_desc&, int) override{}\r
147                 virtual std::wstring print() const override {return L"empty";}\r
148                 virtual bool has_synchronization_clock() const override {return false;}\r
149                 virtual size_t buffer_depth() const override {return 0;};\r
150                 virtual int index() const{return -1;}\r
151                 virtual boost::property_tree::wptree info() const override\r
152                 {\r
153                         boost::property_tree::wptree info;\r
154                         info.add(L"type", L"empty-consumer");\r
155                         return info;\r
156                 }\r
157         };\r
158         static safe_ptr<frame_consumer> consumer = make_safe<empty_frame_consumer>();\r
159         return consumer;\r
160 }\r
161 \r
162 }}