X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=core%2Fproducer%2Fscene%2Fxml_scene_producer.cpp;h=5e5231ba6aceb551e5cc84b04830ccc48b0ee7e6;hb=d7356d8db9848889deec7904fb0f050c3a603c40;hp=e68f434ff26934a99f2290664d221bc28c5ce36f;hpb=2f790f89abec47bc58b7462e2ce3a6122fbbeff7;p=casparcg diff --git a/core/producer/scene/xml_scene_producer.cpp b/core/producer/scene/xml_scene_producer.cpp index e68f434ff..5e5231ba6 100644 --- a/core/producer/scene/xml_scene_producer.cpp +++ b/core/producer/scene/xml_scene_producer.cpp @@ -19,19 +19,29 @@ * Author: Helge Norberg, helge.norberg@svt.se */ -#include "../../stdafx.h" +#include "../../StdAfx.h" #include "xml_scene_producer.h" #include "expression_parser.h" #include +#include #include #include #include +#include +#include +#include #include +#include +#include + +#include +#include #include "scene_producer.h" +#include "scene_cg_proxy.h" namespace caspar { namespace core { namespace scene { @@ -57,38 +67,54 @@ void deduce_expression(variable& var, const variable_repository& repo) } } +void describe_xml_scene_producer(core::help_sink& sink, const core::help_repository& repo) +{ + sink.short_description(L"A simple producer for dynamic graphics using .scene files."); + sink.syntax(L"[.scene_filename:string] {[param1:string] [value1:string]} {[param2:string] [value2:string]} ..."); + sink.para()->text(L"A simple producer that looks in the ")->code(L"templates")->text(L" folder for .scene files."); + sink.para()->text(L"The .scene file is a simple XML document containing variables, layers and timelines."); + 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."); + sink.para()->text(L"The scene producer also supports setting the variables while playing via the CALL command:"); + sink.example(L">> CALL 1-10 FIRSTNAME \"Jane\"", L"changes the variable FIRSTNAME on an already loaded scene."); +} + spl::shared_ptr create_xml_scene_producer( - const spl::shared_ptr& frame_factory, - const core::video_format_desc& format_desc, + const core::frame_producer_dependencies& dependencies, const std::vector& params) { if (params.empty()) return core::frame_producer::empty(); - std::wstring filename = env::media_folder() + L"\\" + params[0] + L".xml"; - - if (!boost::filesystem::is_regular_file(boost::filesystem::path(filename))) + auto found = find_case_insensitive(env::template_folder() + L"/" + params.at(0) + L".scene"); + if (!found) return core::frame_producer::empty(); + auto filename = *found; + auto template_name = get_relative(filename, env::template_folder()).wstring(); + + CASPAR_SCOPED_CONTEXT_MSG(template_name + L": "); + boost::property_tree::wptree root; - std::wifstream file(filename); + boost::filesystem::wifstream file(filename); boost::property_tree::read_xml( file, root, boost::property_tree::xml_parser::trim_whitespace | boost::property_tree::xml_parser::no_comments); - int width = root.get(L"scene..width"); - int height = root.get(L"scene..height"); + int width = ptree_get(root, L"scene..width"); + int height = ptree_get(root, L"scene..height"); - auto scene = spl::make_shared(width, height); + auto scene = spl::make_shared(L"scene", template_name, width, height, dependencies.format_desc); - BOOST_FOREACH(auto elem, root.get_child(L"scene.variables")) + for (auto elem : root | witerate_children(L"scene.variables") | welement_context_iteration) { - auto type = elem.second.get(L".type"); - auto id = elem.second.get(L".id"); - auto is_public = elem.second.get(L".public", false); - auto expr = elem.second.get_value(); + ptree_verify_element_name(elem, L"variable"); + + auto type = ptree_get(elem.second, L".type"); + auto id = ptree_get(elem.second, L".id"); + auto is_public = elem.second.get(L".public", false); + auto expr = ptree_get_value(elem.second); if (!is_public) id = L"variable." + id; @@ -101,23 +127,88 @@ spl::shared_ptr create_xml_scene_producer( scene->create_variable(id, is_public, expr); } - BOOST_FOREACH(auto elem, root.get_child(L"scene.layers")) + for (auto& elem : root | witerate_children(L"scene.layers") | welement_context_iteration) { - auto id = elem.second.get(L".id"); - auto producer = create_producer(frame_factory, format_desc, elem.second.get(L"producer")); - auto& layer = scene->create_layer(producer, 0, 0, id); - auto variable_prefix = L"layer." + id + L"."; - - layer.hidden = scene->create_variable(variable_prefix + L"hidden", false, elem.second.get(L"hidden", L"false")); - layer.position.x = scene->create_variable(variable_prefix + L"x", false, elem.second.get(L"x")); - layer.position.y = scene->create_variable(variable_prefix + L"y", false, elem.second.get(L"y")); + ptree_verify_element_name(elem, L"layer"); - layer.adjustments.opacity = scene->create_variable(variable_prefix + L"adjustment.opacity", false, elem.second.get(L"adjustments.opacity", L"1.0")); - - scene->create_variable(variable_prefix + L"width", false) = layer.producer.get()->pixel_constraints().width; - scene->create_variable(variable_prefix + L"height", false) = layer.producer.get()->pixel_constraints().height; - - BOOST_FOREACH(auto& var_name, producer->get_variables()) + auto id = ptree_get(elem.second, L".id"); + auto producer_string = ptree_get(elem.second, L"producer"); + auto producer = [&] + { + CASPAR_SCOPED_CONTEXT_MSG(" -> "); + auto adjusted_dependencies = dependencies; + auto& adjusted_format_desc = adjusted_dependencies.format_desc; + + adjusted_format_desc.field_mode = field_mode::progressive; + adjusted_format_desc.fps *= adjusted_format_desc.field_count; + adjusted_format_desc.time_scale *= adjusted_format_desc.field_count; + adjusted_format_desc.framerate *= adjusted_format_desc.field_count; + adjusted_format_desc.field_count = 1; + adjusted_format_desc.audio_cadence = core::find_audio_cadence(adjusted_format_desc.framerate); + + return dependencies.producer_registry->create_producer(adjusted_dependencies, producer_string); + }(); + auto& layer = scene->create_layer(producer, 0, 0, id); + auto variable_prefix = L"layer." + id + L"."; + + auto overridden_width = elem.second.get(L"width", L""); + if (!overridden_width.empty()) + layer.producer.get()->pixel_constraints().width = scene->create_variable(variable_prefix + L"width", false, overridden_width); + else + scene->create_variable(variable_prefix + L"width", false) = layer.producer.get()->pixel_constraints().width; + + auto overridden_height = elem.second.get(L"height", L""); + if (!overridden_height.empty()) + layer.producer.get()->pixel_constraints().height = scene->create_variable(variable_prefix + L"height", false, overridden_height); + else + scene->create_variable(variable_prefix + L"height", false) = layer.producer.get()->pixel_constraints().height; + + layer.hidden = scene->create_variable(variable_prefix + L"hidden", false, elem.second.get(L"hidden", L"false")); + layer.position.x = scene->create_variable(variable_prefix + L"x", false, ptree_get(elem.second, L"x")); + layer.position.y = scene->create_variable(variable_prefix + L"y", false, ptree_get(elem.second, L"y")); + layer.anchor.x = scene->create_variable(variable_prefix + L"anchor_x", false, elem.second.get(L"anchor_x", L"0.0")); + layer.anchor.y = scene->create_variable(variable_prefix + L"anchor_y", false, elem.second.get(L"anchor_y", L"0.0")); + layer.clip.upper_left.x = scene->create_variable(variable_prefix + L"clip.upper_left_x", false, elem.second.get(L"clip.upper_left_x", L"0.0")); + layer.clip.upper_left.y = scene->create_variable(variable_prefix + L"clip.upper_left_y", false, elem.second.get(L"clip.upper_left_y", L"0.0")); + layer.clip.lower_right.x = scene->create_variable(variable_prefix + L"clip.lower_right_x", false, elem.second.get(L"clip.lower_right_x", L"${scene_width}")); + layer.clip.lower_right.y = scene->create_variable(variable_prefix + L"clip.lower_right_y", false, elem.second.get(L"clip.lower_right_y", L"${scene_height}")); + layer.rotation = scene->create_variable(variable_prefix + L"rotation", false, elem.second.get(L"rotation", L"0.0")); + layer.crop.upper_left.x = scene->create_variable(variable_prefix + L"crop.upper_left_x", false, elem.second.get(L"crop.upper_left_x", L"0.0")); + layer.crop.upper_left.y = scene->create_variable(variable_prefix + L"crop.upper_left_y", false, elem.second.get(L"crop.upper_left_y", L"0.0")); + layer.crop.lower_right.x = scene->create_variable(variable_prefix + L"crop.lower_right_x", false, elem.second.get(L"crop.lower_right_x", L"${" + variable_prefix + L"width}")); + layer.crop.lower_right.y = scene->create_variable(variable_prefix + L"crop.lower_right_y", false, elem.second.get(L"crop.lower_right_y", L"${" + variable_prefix + L"height}")); + layer.perspective.upper_left.x = scene->create_variable(variable_prefix + L"perspective.upper_left_x", false, elem.second.get(L"perspective.upper_left_x", L"0.0")); + layer.perspective.upper_left.y = scene->create_variable(variable_prefix + L"perspective.upper_left_y", false, elem.second.get(L"perspective.upper_left_y", L"0.0")); + layer.perspective.upper_right.x = scene->create_variable(variable_prefix + L"perspective.upper_right_x", false, elem.second.get(L"perspective.upper_right_x", L"${" + variable_prefix + L"width}")); + layer.perspective.upper_right.y = scene->create_variable(variable_prefix + L"perspective.upper_right_y", false, elem.second.get(L"perspective.upper_right_y", L"0.0")); + layer.perspective.lower_right.x = scene->create_variable(variable_prefix + L"perspective.lower_right_x", false, elem.second.get(L"perspective.lower_right_x", L"${" + variable_prefix + L"width}")); + layer.perspective.lower_right.y = scene->create_variable(variable_prefix + L"perspective.lower_right_y", false, elem.second.get(L"perspective.lower_right_y", L"${" + variable_prefix + L"height}")); + layer.perspective.lower_left.x = scene->create_variable(variable_prefix + L"perspective.lower_left_x", false, elem.second.get(L"perspective.lower_left_x", L"0.0")); + layer.perspective.lower_left.y = scene->create_variable(variable_prefix + L"perspective.lower_left_y", false, elem.second.get(L"perspective.lower_left_y", L"${" + variable_prefix + L"height}")); + + layer.adjustments.opacity = scene->create_variable(variable_prefix + L"adjustment.opacity", false, elem.second.get(L"adjustments.opacity", L"1.0")); + layer.adjustments.contrast = scene->create_variable(variable_prefix + L"adjustment.contrast", false, elem.second.get(L"adjustments.contrast", L"1.0")); + layer.adjustments.saturation = scene->create_variable(variable_prefix + L"adjustment.saturation", false, elem.second.get(L"adjustments.saturation", L"1.0")); + layer.adjustments.brightness = scene->create_variable(variable_prefix + L"adjustment.brightness", false, elem.second.get(L"adjustments.brightness", L"1.0")); + layer.levels.min_input = scene->create_variable(variable_prefix + L"level.min_input", false, elem.second.get(L"levels.min_input", L"0.0")); + layer.levels.max_input = scene->create_variable(variable_prefix + L"level.max_input", false, elem.second.get(L"levels.max_input", L"1.0")); + layer.levels.gamma = scene->create_variable(variable_prefix + L"level.gamma", false, elem.second.get(L"levels.gamma", L"1.0")); + layer.levels.min_output = scene->create_variable(variable_prefix + L"level.min_output", false, elem.second.get(L"levels.min_output", L"0.0")); + layer.levels.max_output = scene->create_variable(variable_prefix + L"level.max_output", false, elem.second.get(L"levels.max_output", L"1.0")); + layer.volume = scene->create_variable(variable_prefix + L"volume", false, elem.second.get(L"volume", L"1.0")); + layer.is_key = scene->create_variable(variable_prefix + L"is_key", false, elem.second.get(L"is_key", L"false")); + layer.use_mipmap = scene->create_variable(variable_prefix + L"use_mipmap", false, elem.second.get(L"use_mipmap", L"false")); + layer.blend_mode = scene->create_variable(variable_prefix + L"blend_mode", false, elem.second.get(L"blend_mode", L"normal")).transformed([](const std::wstring& b) { return get_blend_mode(b); }); + layer.chroma_key.enable = scene->create_variable(variable_prefix + L"chroma_key.enable", false, elem.second.get(L"chroma_key.enable", L"false")); + layer.chroma_key.target_hue = scene->create_variable(variable_prefix + L"chroma_key.target_hue", false, elem.second.get(L"chroma_key.target_hue", L"120.0")); + layer.chroma_key.hue_width = scene->create_variable(variable_prefix + L"chroma_key.hue_width", false, elem.second.get(L"chroma_key.hue_width", L"0.1")); + layer.chroma_key.min_saturation = scene->create_variable(variable_prefix + L"chroma_key.min_saturation", false, elem.second.get(L"chroma_key.min_saturation", L"0.0")); + layer.chroma_key.min_brightness = scene->create_variable(variable_prefix + L"chroma_key.min_brightness", false, elem.second.get(L"chroma_key.min_brightness", L"0.0")); + layer.chroma_key.softness = scene->create_variable(variable_prefix + L"chroma_key.softness", false, elem.second.get(L"chroma_key.softness", L"0.0")); + layer.chroma_key.spill_suppress = scene->create_variable(variable_prefix + L"chroma_key.spill_suppress", false, elem.second.get(L"chroma_key.spill_suppress", L"0.0")); + layer.chroma_key.spill_suppress_saturation = scene->create_variable(variable_prefix + L"chroma_key.spill_suppress_saturation", false, elem.second.get(L"chroma_key.spill_suppress_saturation", L"1.0")); + + for (auto& var_name : producer->get_variables()) { auto& var = producer->get_variable(var_name); auto expr = elem.second.get(L"parameters." + var_name, L""); @@ -131,32 +222,136 @@ spl::shared_ptr create_xml_scene_producer( } } - BOOST_FOREACH(auto& elem, root.get_child(L"scene.timelines")) + if (root.get_child_optional(L"scene.marks")) { - auto& variable = scene->get_variable(elem.second.get(L".variable")); + for (auto& mark : root | witerate_children(L"scene.marks") | welement_context_iteration) + { + ptree_verify_element_name(mark, L"mark"); - BOOST_FOREACH(auto& k, elem.second) + auto at = ptree_get(mark.second, L".at"); + auto type = get_mark_action(ptree_get(mark.second, L".type")); + auto label = mark.second.get(L".label", L""); + + scene->add_mark(at, type, label); + } + } + + if (root.get_child_optional(L"scene.timelines")) + { + for (auto& elem : root | witerate_children(L"scene.timelines") | welement_context_iteration) { - if (k.first == L"") - continue; + ptree_verify_element_name(elem, L"timeline"); + + auto variable_name = ptree_get(elem.second, L".variable"); + auto& variable = scene->get_variable(variable_name); + + for (auto& k : elem.second) + { + if (k.first == L"") + continue; - auto easing = k.second.get(L".easing", L""); - auto at = k.second.get(L".at"); + ptree_verify_element_name(k, L"keyframe"); - if (variable.is()) - scene->add_keyframe(variable.as(), k.second.get_value(), at, easing); - else if (variable.is()) - scene->add_keyframe(variable.as(), k.second.get_value(), at, easing); + auto easing = k.second.get(L".easing", L""); + auto at = ptree_get(k.second, L".at"); + + auto keyframe_variable_name = L"timeline." + variable_name + L"." + boost::lexical_cast(at); + + if (variable.is()) + scene->add_keyframe(variable.as(), scene->create_variable(keyframe_variable_name, false, ptree_get_value(k.second)), at, easing); + else if (variable.is()) + scene->add_keyframe(variable.as(), scene->create_variable(keyframe_variable_name, false, ptree_get_value(k.second)), at, easing); + } } } auto repo = [&scene](const std::wstring& name) -> variable& { - return scene->get_variable(name); + return scene->get_variable(name); }; - BOOST_FOREACH(auto& var_name, scene->get_variables()) + int task_id = 0; + if (root.get_child_optional(L"scene.tasks")) + { + for (auto& task : root | witerate_children(L"scene.tasks") | welement_context_iteration) + { + auto at_frame = task.second.get_optional(L".at"); + auto when = task.second.get_optional(L".when"); + + binding condition; + + if (at_frame) + condition = scene->timeline_frame() == *at_frame; + else if (when) + condition = scene->create_variable(L"tasks.task_" + boost::lexical_cast(task_id), false, *when); + else + CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Task elements must have either an at attribute or a when attribute")); + + auto& element_name = task.first; + + std::vector call_params; + + if (element_name == L"call") + { + for (auto& arg : task.second) + { + if (arg.first == L"") + continue; + + ptree_verify_element_name(arg, L"arg"); + call_params.push_back(ptree_get_value(arg.second)); + } + } + else if (element_name == L"cg_play") + call_params.push_back(L"play()"); + else if (element_name == L"cg_stop") + call_params.push_back(L"stop()"); + else if (element_name == L"cg_next") + call_params.push_back(L"next()"); + else if (element_name == L"cg_invoke") + { + call_params.push_back(L"invoke()"); + call_params.push_back(ptree_get(task.second, L".label")); + } + else if (element_name == L"goto_mark") + { + auto mark_label = ptree_get(task.second, L".label"); + auto weak_scene = static_cast>(scene); + + scene->add_task(std::move(condition), [=] + { + auto strong = weak_scene.lock(); + + if (strong) + strong->call({ L"play()", mark_label }); + }); + } + else + CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Only valid element names in are call, cg_play, cg_stop, cg_next, cg_invoke and goto_mark")); + + if (!call_params.empty()) + { + auto to_layer = ptree_get(task.second, L".to_layer"); + auto producer = scene->get_layer(to_layer).producer.get(); + + auto weak_producer = static_cast>(producer); + + scene->add_task(std::move(condition), [=] + { + auto strong = weak_producer.lock(); + + if (strong) + strong->call(call_params); + }); + } + + ++task_id; + } + } + + for (auto& var_name : scene->get_variables()) { + CASPAR_SCOPED_CONTEXT_MSG(L"/scene/variables/variable[@id=" + var_name + L"]/text()"); deduce_expression(scene->get_variable(var_name), repo); } @@ -168,4 +363,24 @@ spl::shared_ptr create_xml_scene_producer( return scene; } +void init(module_dependencies dependencies) +{ + dependencies.producer_registry->register_producer_factory(L"XML Scene Producer", create_xml_scene_producer, describe_xml_scene_producer); + dependencies.cg_registry->register_cg_producer( + L"scene", + { L".scene" }, + [](const std::wstring& filename) { return ""; }, + [](const spl::shared_ptr& producer) + { + return spl::make_shared(producer); + }, + []( + const core::frame_producer_dependencies& dependencies, + const std::wstring& filename) + { + return create_xml_scene_producer(dependencies, { filename }); + }, + false); +} + }}}