2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
6 * CasparCG is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * CasparCG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
19 * Author: Helge Norberg, helge.norberg@svt.se
22 #include "../../StdAfx.h"
24 #include <common/future.h>
25 #include <common/prec_timer.h>
27 #include <boost/algorithm/string/split.hpp>
28 #include <boost/algorithm/string.hpp>
30 #include "scene_producer.h"
32 #include "../../frame/draw_frame.h"
33 #include "../../interaction/interaction_aggregator.h"
34 #include "../text/text_producer.h"
36 namespace caspar { namespace core { namespace scene {
38 layer::layer(const std::wstring& name, const spl::shared_ptr<frame_producer>& producer)
39 : name(name), producer(producer)
41 crop.lower_right.x.bind(producer.get()->pixel_constraints().width);
42 crop.lower_right.y.bind(producer.get()->pixel_constraints().height);
43 perspective.upper_right.x.bind(producer.get()->pixel_constraints().width);
44 perspective.lower_right.x.bind(producer.get()->pixel_constraints().width);
45 perspective.lower_right.y.bind(producer.get()->pixel_constraints().height);
46 perspective.lower_left.y.bind(producer.get()->pixel_constraints().height);
49 adjustments::adjustments()
56 std::map<int64_t, keyframe> keyframes;
58 void on_frame(int64_t frame)
60 auto before = --keyframes.upper_bound(frame);
61 bool found_before = before != keyframes.end() && before->first < frame;
62 auto after = keyframes.upper_bound(frame);
63 bool found_after = after != keyframes.end() && after->first > frame;
64 auto exact_frame = keyframes.find(frame);
65 bool found_exact_frame = exact_frame != keyframes.end();
67 if (found_exact_frame)
69 exact_frame->second.on_destination_frame();
71 auto next_frame = ++exact_frame;
73 if (next_frame != keyframes.end() && next_frame->second.on_start_animate)
74 next_frame->second.on_start_animate();
78 int64_t start_frame = 0;
82 start_frame = before->first;
85 if (after->second.on_start_animate && frame == 0)
86 after->second.on_start_animate();
87 else if (after->second.on_animate_to)
88 after->second.on_animate_to(start_frame, frame);
93 mark_action get_mark_action(const std::wstring& name)
96 return mark_action::start;
97 else if (name == L"stop")
98 return mark_action::stop;
99 else if (name == L"jump_to")
100 return mark_action::jump_to;
101 else if (name == L"remove")
102 return mark_action::remove;
104 CASPAR_THROW_EXCEPTION(invalid_argument() << msg_info(L"Invalid mark_action " + name));
110 std::wstring label_argument;
112 marker(mark_action action, const std::wstring& label_argument)
114 , label_argument(label_argument)
119 struct scene_producer::impl
121 std::wstring producer_name_;
122 constraints pixel_constraints_;
123 video_format_desc format_desc_;
124 std::list<layer> layers_;
125 interaction_aggregator aggregator_;
126 binding<int64_t> frame_number_;
127 binding<double> speed_;
128 double frame_fraction_ = 0.0;
129 std::map<void*, timeline> timelines_;
130 std::map<std::wstring, std::shared_ptr<core::variable>> variables_;
131 std::vector<std::wstring> variable_names_;
132 std::multimap<int64_t, marker> markers_by_frame_;
133 monitor::subject monitor_subject_;
135 bool removed_ = false;
136 bool going_to_mark_ = false;
138 impl(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
139 : producer_name_(std::move(producer_name))
140 , pixel_constraints_(width, height)
141 , format_desc_(format_desc)
142 , aggregator_([=] (double x, double y) { return collission_detect(x, y); })
144 auto speed_variable = std::make_shared<core::variable_impl<double>>(L"1.0", true, 1.0);
145 store_variable(L"scene_speed", speed_variable);
146 speed_ = speed_variable->value();
147 auto frame_variable = std::make_shared<core::variable_impl<int64_t>>(L"-1", true, -1);
148 store_variable(L"frame", frame_variable);
149 frame_number_ = frame_variable->value();
153 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
155 layer layer(name, producer);
157 layer.position.x.set(x);
158 layer.position.y.set(y);
160 layers_.push_back(layer);
162 return layers_.back();
165 void store_keyframe(void* timeline_identity, const keyframe& k)
167 timelines_[timeline_identity].keyframes.insert(std::make_pair(k.destination_frame, k));
171 const std::wstring& name, const std::shared_ptr<core::variable>& var)
173 variables_.insert(std::make_pair(name, var));
174 variable_names_.push_back(name);
177 void add_mark(int64_t frame, mark_action action, const std::wstring& label)
179 markers_by_frame_.insert(std::make_pair(frame, marker(action, label)));
182 core::variable& get_variable(const std::wstring& name)
184 auto found = variables_.find(name);
186 if (found == variables_.end())
187 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info(name + L" not found in scene"));
189 return *found->second;
192 const std::vector<std::wstring>& get_variables() const
194 return variable_names_;
197 binding<int64_t> frame()
199 return frame_number_;
202 frame_transform get_transform(const layer& layer) const
204 frame_transform transform;
206 auto& anchor = transform.image_transform.anchor;
207 auto& pos = transform.image_transform.fill_translation;
208 auto& scale = transform.image_transform.fill_scale;
209 auto& angle = transform.image_transform.angle;
210 auto& crop = transform.image_transform.crop;
211 auto& pers = transform.image_transform.perspective;
213 anchor[0] = layer.anchor.x.get() / layer.producer.get()->pixel_constraints().width.get();
214 anchor[1] = layer.anchor.y.get() / layer.producer.get()->pixel_constraints().height.get();
215 pos[0] = layer.position.x.get() / pixel_constraints_.width.get();
216 pos[1] = layer.position.y.get() / pixel_constraints_.height.get();
217 scale[0] = layer.producer.get()->pixel_constraints().width.get() / pixel_constraints_.width.get();
218 scale[1] = layer.producer.get()->pixel_constraints().height.get() / pixel_constraints_.height.get();
219 crop.ul[0] = layer.crop.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
220 crop.ul[1] = layer.crop.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
221 crop.lr[0] = layer.crop.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
222 crop.lr[1] = layer.crop.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
223 pers.ul[0] = layer.perspective.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
224 pers.ul[1] = layer.perspective.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
225 pers.ur[0] = layer.perspective.upper_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
226 pers.ur[1] = layer.perspective.upper_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
227 pers.lr[0] = layer.perspective.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
228 pers.lr[1] = layer.perspective.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
229 pers.ll[0] = layer.perspective.lower_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
230 pers.ll[1] = layer.perspective.lower_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
232 static const double PI = 3.141592653589793;
234 angle = layer.rotation.get() * PI / 180.0;
236 transform.image_transform.opacity = layer.adjustments.opacity.get();
237 transform.image_transform.is_key = layer.is_key.get();
238 transform.image_transform.use_mipmap = layer.use_mipmap.get();
239 transform.image_transform.blend_mode = layer.blend_mode.get();
240 transform.image_transform.chroma.key = layer.chroma_key.key.get();
241 transform.image_transform.chroma.threshold = layer.chroma_key.threshold.get();
242 transform.image_transform.chroma.softness = layer.chroma_key.softness.get();
243 transform.image_transform.chroma.spill = layer.chroma_key.spill.get();
245 // Mark as sublayer, so it will be composited separately by the mixer.
246 transform.image_transform.layer_depth = 1;
251 boost::optional<std::pair<int64_t, marker>> find_first_stop_or_jump_or_remove(int64_t start_frame, int64_t end_frame)
253 auto lower = markers_by_frame_.lower_bound(start_frame);
254 auto upper = markers_by_frame_.upper_bound(end_frame);
256 if (lower == markers_by_frame_.end())
259 for (auto iter = lower; iter != upper; ++iter)
261 auto action = iter->second.action;
263 if (action == mark_action::stop || action == mark_action::jump_to || action == mark_action::remove)
264 return std::make_pair(iter->first, iter->second);
270 boost::optional<std::pair<int64_t, marker>> find_first_start(int64_t start_frame)
272 auto lower = markers_by_frame_.lower_bound(start_frame);
274 if (lower == markers_by_frame_.end())
277 for (auto iter = lower; iter != markers_by_frame_.end(); ++iter)
279 auto action = iter->second.action;
281 if (action == mark_action::start)
282 return std::make_pair(iter->first, iter->second);
288 draw_frame render_frame()
290 if (format_desc_.field_count == 1)
291 return render_progressive_frame();
295 timer.tick_millis(0);
297 auto field1 = render_progressive_frame();
299 timer.tick(0.5 / format_desc_.fps);
301 auto field2 = render_progressive_frame();
303 return draw_frame::interlace(field1, field2, format_desc_.field_mode);
309 frame_fraction_ += speed_.get();
311 if (std::abs(frame_fraction_) >= 1.0)
313 int64_t delta = static_cast<int64_t>(frame_fraction_);
314 auto previous_frame = frame_number_.get();
315 auto next_frame = frame_number_.get() + delta;
316 auto marker = find_first_stop_or_jump_or_remove(previous_frame + 1, next_frame);
318 if (marker && marker->second.action == mark_action::remove)
322 if (marker && !going_to_mark_)
324 if (marker->second.action == mark_action::stop)
326 frame_number_.set(marker->first);
327 frame_fraction_ = 0.0;
330 else if (marker->second.action == mark_action::jump_to)
332 go_to_marker(marker->second.label_argument, 0);
337 frame_number_.set(next_frame);
338 frame_fraction_ -= delta;
341 going_to_mark_ = false;
345 draw_frame render_progressive_frame()
348 return draw_frame::empty();
353 for (auto& timeline : timelines_)
354 timeline.second.on_frame(frame_number_.get());
356 std::vector<draw_frame> frames;
358 for (auto& layer : layers_)
360 if (layer.hidden.get())
363 draw_frame frame(layer.producer.get()->receive());
364 frame.transform() = get_transform(layer);
365 frames.push_back(frame);
368 return draw_frame(frames);
371 void on_interaction(const interaction_event::ptr& event)
373 aggregator_.translate_and_send(event);
376 bool collides(double x, double y) const
378 return static_cast<bool>((collission_detect(x, y)));
381 boost::optional<interaction_target> collission_detect(double x, double y) const
383 for (auto& layer : layers_ | boost::adaptors::reversed)
385 if (layer.hidden.get())
388 auto transform = get_transform(layer);
389 auto translated = translate(x, y, transform);
391 if (translated.first >= 0.0
392 && translated.first <= 1.0
393 && translated.second >= 0.0
394 && translated.second <= 1.0
395 && layer.producer.get()->collides(translated.first, translated.second))
397 return std::make_pair(transform, static_cast<interaction_sink*>(layer.producer.get().get()));
401 return boost::optional<interaction_target>();
404 std::future<std::wstring> call(const std::vector<std::wstring>& params)
406 if (!params.empty() && boost::ends_with(params.at(0), L"()"))
407 return make_ready_future(handle_call(params));
409 return make_ready_future(handle_variable_set(params));
412 std::wstring handle_variable_set(const std::vector<std::wstring>& params)
414 for (int i = 0; i + 1 < params.size(); i += 2)
416 auto found = variables_.find(boost::to_lower_copy(params.at(i)));
418 if (found != variables_.end() && found->second->is_public())
419 found->second->from_string(params.at(i + 1));
425 std::wstring handle_call(const std::vector<std::wstring>& params)
427 auto call = params.at(0);
429 if (call == L"play()")
430 go_to_marker(params.at(1), -1);
431 else if (call == L"remove()")
433 else if (call == L"next()")
436 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info(L"Unknown call " + call));
449 auto marker = find_first_start(frame_number_.get() + 1);
453 frame_number_.set(marker->first - 1);
454 frame_fraction_ = 0.0;
456 going_to_mark_ = true;
464 void go_to_marker(const std::wstring& marker_name, int64_t offset)
466 for (auto& marker : markers_by_frame_)
468 if (marker.second.label_argument == marker_name && marker.second.action == mark_action::start)
470 frame_number_.set(marker.first + offset);
471 frame_fraction_ = 0.0;
473 going_to_mark_ = true;
479 if (marker_name == L"intro")
481 frame_number_.set(offset);
482 frame_fraction_ = 0.0;
484 going_to_mark_ = true;
486 else if (marker_name == L"outro")
491 CASPAR_LOG(info) << print() << L" no marker called " << marker_name << " found";
494 std::wstring print() const
496 return L"scene[type=" + name() + L"]";
499 std::wstring name() const
501 return producer_name_;
504 boost::property_tree::wptree info() const
506 boost::property_tree::wptree info;
507 info.add(L"type", L"scene");
508 info.add(L"producer-name", name());
509 info.add(L"frame-number", frame_number_.get());
511 for (auto& var : variables_)
513 boost::property_tree::wptree variable_info;
515 variable_info.add(L"name", var.first);
516 variable_info.add(L"public", var.second->is_public());
517 variable_info.add(L"value", var.second->to_string());
519 info.add_child(L"variables.variable", variable_info);
522 for (auto& layer : layers_)
524 boost::property_tree::wptree layer_info;
526 layer_info.add(L"name", layer.name.get());
527 layer_info.add_child(L"producer", layer.producer.get()->info());
528 layer_info.add(L"x", layer.position.x.get());
529 layer_info.add(L"y", layer.position.y.get());
530 layer_info.add(L"width", layer.producer.get()->pixel_constraints().width.get());
531 layer_info.add(L"height", layer.producer.get()->pixel_constraints().height.get());
533 info.add_child(L"layers.layer", layer_info);
539 monitor::subject& monitor_output()
541 return monitor_subject_;
545 scene_producer::scene_producer(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
546 : impl_(new impl(std::move(producer_name), width, height, format_desc))
550 scene_producer::~scene_producer()
554 layer& scene_producer::create_layer(
555 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
557 return impl_->create_layer(producer, x, y, name);
560 layer& scene_producer::create_layer(
561 const spl::shared_ptr<frame_producer>& producer, const std::wstring& name)
563 return impl_->create_layer(producer, 0, 0, name);
566 binding<int64_t> scene_producer::frame()
568 return impl_->frame();
571 draw_frame scene_producer::receive_impl()
573 return impl_->render_frame();
576 constraints& scene_producer::pixel_constraints() { return impl_->pixel_constraints_; }
578 void scene_producer::on_interaction(const interaction_event::ptr& event)
580 impl_->on_interaction(event);
583 bool scene_producer::collides(double x, double y) const
585 return impl_->collides(x, y);
588 std::wstring scene_producer::print() const
590 return impl_->print();
593 std::wstring scene_producer::name() const
595 return impl_->name();
598 boost::property_tree::wptree scene_producer::info() const
600 return impl_->info();
603 std::future<std::wstring> scene_producer::call(const std::vector<std::wstring>& params)
605 return impl_->call(params);
608 monitor::subject& scene_producer::monitor_output()
610 return impl_->monitor_output();
613 void scene_producer::store_keyframe(void* timeline_identity, const keyframe& k)
615 impl_->store_keyframe(timeline_identity, k);
618 void scene_producer::store_variable(
619 const std::wstring& name, const std::shared_ptr<core::variable>& var)
621 impl_->store_variable(name, var);
624 void scene_producer::add_mark(int64_t frame, mark_action action, const std::wstring& label)
626 impl_->add_mark(frame, action, label);
629 core::variable& scene_producer::get_variable(const std::wstring& name)
631 return impl_->get_variable(name);
634 const std::vector<std::wstring>& scene_producer::get_variables() const
636 return impl_->get_variables();