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 "xml_scene_producer.h"
25 #include "expression_parser.h"
27 #include <boost/filesystem.hpp>
28 #include <boost/filesystem/fstream.hpp>
29 #include <boost/property_tree/ptree.hpp>
30 #include <boost/property_tree/xml_parser.hpp>
32 #include <common/env.h>
33 #include <common/os/filesystem.h>
34 #include <common/filesystem.h>
35 #include <common/ptree.h>
36 #include <core/producer/frame_producer.h>
37 #include <core/help/help_repository.h>
38 #include <core/help/help_sink.h>
43 #include "scene_producer.h"
44 #include "scene_cg_proxy.h"
46 namespace caspar { namespace core { namespace scene {
48 void deduce_expression(variable& var, const variable_repository& repo)
50 auto expr_str = var.original_expr();
51 auto trimmed = boost::trim_copy(expr_str);
53 if (boost::starts_with(trimmed, L"${") && boost::ends_with(trimmed, L"}"))
55 expr_str = trimmed.substr(2, expr_str.length() - 3);
58 var.as<double>().bind(parse_expression<double>(expr_str, repo));
59 else if (var.is<bool>())
60 var.as<bool>().bind(parse_expression<bool>(expr_str, repo));
61 else if (var.is<std::wstring>())
62 var.as<std::wstring>().bind(parse_expression<std::wstring>(expr_str, repo));
64 else if (!expr_str.empty())
66 var.from_string(expr_str);
70 void describe_xml_scene_producer(core::help_sink& sink, const core::help_repository& repo)
72 sink.short_description(L"A simple producer for dynamic graphics using .scene files.");
73 sink.syntax(L"[.scene_filename:string] {[param1:string] [value1:string]} {[param2:string] [value2:string]} ...");
74 sink.para()->text(L"A simple producer that looks in the ")->code(L"templates")->text(L" folder for .scene files.");
75 sink.para()->text(L"The .scene file is a simple XML document containing variables, layers and timelines.");
76 sink.example(L">> PLAY 1-10 scene_name_sign FIRSTNAME \"John\" LASTNAME \"Doe\"", L"loads and plays templates/scene_name_sign.scene and sets the variables FIRSTNAME and LASTNAME.");
77 sink.para()->text(L"The scene producer also supports setting the variables while playing via the CALL command:");
78 sink.example(L">> CALL 1-10 FIRSTNAME \"Jane\"", L"changes the variable FIRSTNAME on an already loaded scene.");
81 spl::shared_ptr<core::frame_producer> create_xml_scene_producer(
82 const core::frame_producer_dependencies& dependencies,
83 const std::vector<std::wstring>& params)
86 return core::frame_producer::empty();
88 auto found = find_case_insensitive(env::template_folder() + L"/" + params.at(0) + L".scene");
90 return core::frame_producer::empty();
92 auto filename = *found;
93 auto template_name = get_relative(filename, env::template_folder()).wstring();
95 CASPAR_SCOPED_CONTEXT_MSG(template_name + L": ");
97 boost::property_tree::wptree root;
98 boost::filesystem::wifstream file(filename);
99 boost::property_tree::read_xml(
102 boost::property_tree::xml_parser::trim_whitespace
103 | boost::property_tree::xml_parser::no_comments);
105 int width = ptree_get<int>(root, L"scene.<xmlattr>.width");
106 int height = ptree_get<int>(root, L"scene.<xmlattr>.height");
108 auto scene = spl::make_shared<scene_producer>(L"scene", template_name, width, height, dependencies.format_desc);
110 for (auto elem : root | witerate_children(L"scene.variables") | welement_context_iteration)
112 ptree_verify_element_name(elem, L"variable");
114 auto type = ptree_get<std::wstring>(elem.second, L"<xmlattr>.type");
115 auto id = ptree_get<std::wstring>(elem.second, L"<xmlattr>.id");
116 auto is_public = elem.second.get(L"<xmlattr>.public", false);
117 auto expr = ptree_get_value<std::wstring>(elem.second);
120 id = L"variable." + id;
122 if (type == L"number")
123 scene->create_variable<double>(id, is_public, expr);
124 else if (type == L"string")
125 scene->create_variable<std::wstring>(id, is_public, expr);
126 else if (type == L"bool")
127 scene->create_variable<bool>(id, is_public, expr);
130 for (auto& elem : root | witerate_children(L"scene.layers") | welement_context_iteration)
132 ptree_verify_element_name(elem, L"layer");
134 auto id = ptree_get<std::wstring>(elem.second, L"<xmlattr>.id");
135 auto producer_string = ptree_get<std::wstring>(elem.second, L"producer");
138 CASPAR_SCOPED_CONTEXT_MSG(" -> ");
139 auto adjusted_dependencies = dependencies;
140 auto& adjusted_format_desc = adjusted_dependencies.format_desc;
142 adjusted_format_desc.field_mode = field_mode::progressive;
143 adjusted_format_desc.fps *= adjusted_format_desc.field_count;
144 adjusted_format_desc.duration /= adjusted_format_desc.field_count;
145 adjusted_format_desc.field_count = 1;
147 return dependencies.producer_registry->create_producer(adjusted_dependencies, producer_string);
149 auto& layer = scene->create_layer(producer, 0, 0, id);
150 auto variable_prefix = L"layer." + id + L".";
152 auto overridden_width = elem.second.get<std::wstring>(L"width", L"");
153 if (!overridden_width.empty())
154 layer.producer.get()->pixel_constraints().width = scene->create_variable<double>(variable_prefix + L"width", false, overridden_width);
156 scene->create_variable<double>(variable_prefix + L"width", false) = layer.producer.get()->pixel_constraints().width;
158 auto overridden_height = elem.second.get<std::wstring>(L"height", L"");
159 if (!overridden_height.empty())
160 layer.producer.get()->pixel_constraints().height = scene->create_variable<double>(variable_prefix + L"height", false, overridden_height);
162 scene->create_variable<double>(variable_prefix + L"height", false) = layer.producer.get()->pixel_constraints().height;
164 layer.hidden = scene->create_variable<bool>(variable_prefix + L"hidden", false, elem.second.get(L"hidden", L"false"));
165 layer.position.x = scene->create_variable<double>(variable_prefix + L"x", false, ptree_get<std::wstring>(elem.second, L"x"));
166 layer.position.y = scene->create_variable<double>(variable_prefix + L"y", false, ptree_get<std::wstring>(elem.second, L"y"));
167 layer.anchor.x = scene->create_variable<double>(variable_prefix + L"anchor_x", false, elem.second.get<std::wstring>(L"anchor_x", L"0.0"));
168 layer.anchor.y = scene->create_variable<double>(variable_prefix + L"anchor_y", false, elem.second.get<std::wstring>(L"anchor_y", L"0.0"));
169 layer.clip.upper_left.x = scene->create_variable<double>(variable_prefix + L"clip.upper_left_x", false, elem.second.get<std::wstring>(L"clip.upper_left_x", L"0.0"));
170 layer.clip.upper_left.y = scene->create_variable<double>(variable_prefix + L"clip.upper_left_y", false, elem.second.get<std::wstring>(L"clip.upper_left_y", L"0.0"));
171 layer.clip.lower_right.x = scene->create_variable<double>(variable_prefix + L"clip.lower_right_x", false, elem.second.get<std::wstring>(L"clip.lower_right_x", L"${scene_width}"));
172 layer.clip.lower_right.y = scene->create_variable<double>(variable_prefix + L"clip.lower_right_y", false, elem.second.get<std::wstring>(L"clip.lower_right_y", L"${scene_height}"));
173 layer.rotation = scene->create_variable<double>(variable_prefix + L"rotation", false, elem.second.get<std::wstring>(L"rotation", L"0.0"));
174 layer.crop.upper_left.x = scene->create_variable<double>(variable_prefix + L"crop_upper_left_x", false, elem.second.get<std::wstring>(L"crop_upper_left_x", L"0.0"));
175 layer.crop.upper_left.y = scene->create_variable<double>(variable_prefix + L"crop_upper_left_y", false, elem.second.get<std::wstring>(L"crop_upper_left_y", L"0.0"));
176 layer.crop.lower_right.x = scene->create_variable<double>(variable_prefix + L"crop_lower_right_x", false, elem.second.get<std::wstring>(L"crop_lower_right_x", L"${" + variable_prefix + L"width}"));
177 layer.crop.lower_right.y = scene->create_variable<double>(variable_prefix + L"crop_lower_right_y", false, elem.second.get<std::wstring>(L"crop_lower_right_y", L"${" + variable_prefix + L"height}"));
178 layer.perspective.upper_left.x = scene->create_variable<double>(variable_prefix + L"perspective_upper_left_x", false, elem.second.get<std::wstring>(L"perspective_upper_left_x", L"0.0"));
179 layer.perspective.upper_left.y = scene->create_variable<double>(variable_prefix + L"perspective_upper_left_y", false, elem.second.get<std::wstring>(L"perspective_upper_left_y", L"0.0"));
180 layer.perspective.upper_right.x = scene->create_variable<double>(variable_prefix + L"perspective_upper_right_x", false, elem.second.get<std::wstring>(L"perspective_upper_right_x", L"${" + variable_prefix + L"width}"));
181 layer.perspective.upper_right.y = scene->create_variable<double>(variable_prefix + L"perspective_upper_right_y", false, elem.second.get<std::wstring>(L"perspective_upper_right_y", L"0.0"));
182 layer.perspective.lower_right.x = scene->create_variable<double>(variable_prefix + L"perspective_lower_right_x", false, elem.second.get<std::wstring>(L"perspective_lower_right_x", L"${" + variable_prefix + L"width}"));
183 layer.perspective.lower_right.y = scene->create_variable<double>(variable_prefix + L"perspective_lower_right_y", false, elem.second.get<std::wstring>(L"perspective_lower_right_y", L"${" + variable_prefix + L"height}"));
184 layer.perspective.lower_left.x = scene->create_variable<double>(variable_prefix + L"perspective_lower_left_x", false, elem.second.get<std::wstring>(L"perspective_lower_left_x", L"0.0"));
185 layer.perspective.lower_left.y = scene->create_variable<double>(variable_prefix + L"perspective_lower_left_y", false, elem.second.get<std::wstring>(L"perspective_lower_left_y", L"${" + variable_prefix + L"height}"));
187 layer.adjustments.opacity = scene->create_variable<double>(variable_prefix + L"adjustment.opacity", false, elem.second.get(L"adjustments.opacity", L"1.0"));
188 layer.adjustments.contrast = scene->create_variable<double>(variable_prefix + L"adjustment.contrast", false, elem.second.get(L"adjustments.contrast", L"1.0"));
189 layer.adjustments.saturation = scene->create_variable<double>(variable_prefix + L"adjustment.saturation", false, elem.second.get(L"adjustments.saturation", L"1.0"));
190 layer.adjustments.brightness = scene->create_variable<double>(variable_prefix + L"adjustment.brightness", false, elem.second.get(L"adjustments.brightness", L"1.0"));
191 layer.levels.min_input = scene->create_variable<double>(variable_prefix + L"level.min_input", false, elem.second.get(L"levels.min_input", L"0.0"));
192 layer.levels.max_input = scene->create_variable<double>(variable_prefix + L"level.max_input", false, elem.second.get(L"levels.max_input", L"1.0"));
193 layer.levels.gamma = scene->create_variable<double>(variable_prefix + L"level.gamma", false, elem.second.get(L"levels.gamma", L"1.0"));
194 layer.levels.min_output = scene->create_variable<double>(variable_prefix + L"level.min_output", false, elem.second.get(L"levels.min_output", L"0.0"));
195 layer.levels.max_output = scene->create_variable<double>(variable_prefix + L"level.max_output", false, elem.second.get(L"levels.max_output", L"1.0"));
196 layer.volume = scene->create_variable<double>(variable_prefix + L"volume", false, elem.second.get(L"volume", L"1.0"));
197 layer.is_key = scene->create_variable<bool>(variable_prefix + L"is_key", false, elem.second.get(L"is_key", L"false"));
198 layer.use_mipmap = scene->create_variable<bool>(variable_prefix + L"use_mipmap", false, elem.second.get(L"use_mipmap", L"false"));
199 layer.blend_mode = scene->create_variable<std::wstring>(variable_prefix + L"blend_mode", false, elem.second.get(L"blend_mode", L"normal")).transformed([](const std::wstring& b) { return get_blend_mode(b); });
200 layer.chroma_key.enable = scene->create_variable<bool>(variable_prefix + L"chroma_key.enable", false, elem.second.get(L"chroma_key.enable", L"false"));
201 layer.chroma_key.target_hue = scene->create_variable<double>(variable_prefix + L"chroma_key.target_hue", false, elem.second.get(L"chroma_key.target_hue", L"120.0"));
202 layer.chroma_key.hue_width = scene->create_variable<double>(variable_prefix + L"chroma_key.hue_width", false, elem.second.get(L"chroma_key.hue_width", L"0.1"));
203 layer.chroma_key.min_saturation = scene->create_variable<double>(variable_prefix + L"chroma_key.min_saturation", false, elem.second.get(L"chroma_key.min_saturation", L"0.0"));
204 layer.chroma_key.min_brightness = scene->create_variable<double>(variable_prefix + L"chroma_key.min_brightness", false, elem.second.get(L"chroma_key.min_brightness", L"0.0"));
205 layer.chroma_key.softness = scene->create_variable<double>(variable_prefix + L"chroma_key.softness", false, elem.second.get(L"chroma_key.softness", L"0.0"));
206 layer.chroma_key.spill_suppress = scene->create_variable<double>(variable_prefix + L"chroma_key.spill_suppress", false, elem.second.get(L"chroma_key.spill_suppress", L"0.0"));
207 layer.chroma_key.spill_suppress_saturation = scene->create_variable<double>(variable_prefix + L"chroma_key.spill_suppress_saturation", false, elem.second.get(L"chroma_key.spill_suppress_saturation", L"1.0"));
209 for (auto& var_name : producer->get_variables())
211 auto& var = producer->get_variable(var_name);
212 auto expr = elem.second.get<std::wstring>(L"parameters." + var_name, L"");
214 if (var.is<double>())
215 scene->create_variable<double>(variable_prefix + L"parameter." + var_name, false, expr) = var.as<double>();
216 else if (var.is<std::wstring>())
217 scene->create_variable<std::wstring>(variable_prefix + L"parameter." + var_name, false, expr) = var.as<std::wstring>();
218 else if (var.is<bool>())
219 scene->create_variable<bool>(variable_prefix + L"parameter." + var_name, false, expr) = var.as<bool>();
223 if (root.get_child_optional(L"scene.marks"))
225 for (auto& mark : root | witerate_children(L"scene.marks") | welement_context_iteration)
227 ptree_verify_element_name(mark, L"mark");
229 auto at = ptree_get<int64_t>(mark.second, L"<xmlattr>.at");
230 auto type = get_mark_action(ptree_get<std::wstring>(mark.second, L"<xmlattr>.type"));
231 auto label = mark.second.get(L"<xmlattr>.label", L"");
233 scene->add_mark(at, type, label);
237 if (root.get_child_optional(L"scene.timelines"))
239 for (auto& elem : root | witerate_children(L"scene.timelines") | welement_context_iteration)
241 ptree_verify_element_name(elem, L"timeline");
243 auto variable_name = ptree_get<std::wstring>(elem.second, L"<xmlattr>.variable");
244 auto& variable = scene->get_variable(variable_name);
246 for (auto& k : elem.second)
248 if (k.first == L"<xmlattr>")
251 ptree_verify_element_name(k, L"keyframe");
253 auto easing = k.second.get(L"<xmlattr>.easing", L"");
254 auto at = ptree_get<int64_t>(k.second, L"<xmlattr>.at");
256 auto keyframe_variable_name = L"timeline." + variable_name + L"." + boost::lexical_cast<std::wstring>(at);
258 if (variable.is<double>())
259 scene->add_keyframe(variable.as<double>(), scene->create_variable<double>(keyframe_variable_name, false, ptree_get_value<std::wstring>(k.second)), at, easing);
260 else if (variable.is<int>())
261 scene->add_keyframe(variable.as<int>(), scene->create_variable<int>(keyframe_variable_name, false, ptree_get_value<std::wstring>(k.second)), at, easing);
266 auto repo = [&scene](const std::wstring& name) -> variable&
268 return scene->get_variable(name);
272 if (root.get_child_optional(L"scene.tasks"))
274 for (auto& task : root | witerate_children(L"scene.tasks") | welement_context_iteration)
276 auto at_frame = task.second.get_optional<int64_t>(L"<xmlattr>.at");
277 auto when = task.second.get_optional<std::wstring>(L"<xmlattr>.when");
279 binding<bool> condition;
282 condition = scene->timeline_frame() == *at_frame;
284 condition = scene->create_variable<bool>(L"tasks.task_" + boost::lexical_cast<std::wstring>(task_id), false, *when);
286 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Task elements must have either an at attribute or a when attribute"));
288 auto& element_name = task.first;
290 std::vector<std::wstring> call_params;
292 if (element_name == L"call")
294 for (auto& arg : task.second)
296 if (arg.first == L"<xmlattr>")
299 ptree_verify_element_name(arg, L"arg");
300 call_params.push_back(ptree_get_value<std::wstring>(arg.second));
303 else if (element_name == L"cg_play")
304 call_params.push_back(L"play()");
305 else if (element_name == L"cg_stop")
306 call_params.push_back(L"stop()");
307 else if (element_name == L"cg_next")
308 call_params.push_back(L"next()");
309 else if (element_name == L"cg_invoke")
311 call_params.push_back(L"invoke()");
312 call_params.push_back(ptree_get<std::wstring>(task.second, L"<xmlattr>.label"));
314 else if (element_name == L"goto_mark")
316 auto mark_label = ptree_get<std::wstring>(task.second, L"<xmlattr>.label");
317 auto weak_scene = static_cast<std::weak_ptr<scene_producer>>(scene);
319 scene->add_task(std::move(condition), [=]
321 auto strong = weak_scene.lock();
324 strong->call({ L"play()", mark_label });
328 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Only valid element names in <tasks /> are call, cg_play, cg_stop, cg_next, cg_invoke and goto_mark"));
330 if (!call_params.empty())
332 auto to_layer = ptree_get<std::wstring>(task.second, L"<xmlattr>.to_layer");
333 auto producer = scene->get_layer(to_layer).producer.get();
335 auto weak_producer = static_cast<std::weak_ptr<frame_producer>>(producer);
337 scene->add_task(std::move(condition), [=]
339 auto strong = weak_producer.lock();
342 strong->call(call_params);
350 for (auto& var_name : scene->get_variables())
352 CASPAR_SCOPED_CONTEXT_MSG(L"/scene/variables/variable[@id=" + var_name + L"]/text()");
353 deduce_expression(scene->get_variable(var_name), repo);
356 auto params2 = params;
357 params2.erase(params2.begin());
359 scene->call(params2);
364 void init(module_dependencies dependencies)
366 dependencies.producer_registry->register_producer_factory(L"XML Scene Producer", create_xml_scene_producer, describe_xml_scene_producer);
367 dependencies.cg_registry->register_cg_producer(
370 [](const std::wstring& filename) { return ""; },
371 [](const spl::shared_ptr<core::frame_producer>& producer)
373 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
376 const core::frame_producer_dependencies& dependencies,
377 const std::wstring& filename)
379 return create_xml_scene_producer(dependencies, { filename });