git.sesse.net Git - casparcg/blob - core/producer/scene/xml_scene_producer.cpp

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   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.
  10 *
  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.
  15 *
  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/>.
  18 *
  19 * Author: Helge Norberg, helge.norberg@svt.se
  20 */
  21
  22 #include "../../StdAfx.h"
  23
  24 #include "xml_scene_producer.h"
  25 #include "expression_parser.h"
  26
  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>
  31
  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>
  39
  40 #include <future>
  41
  42 #include "scene_producer.h"
  43 #include "scene_cg_proxy.h"
  44
  45 namespace caspar { namespace core { namespace scene {
  46
  47 void deduce_expression(variable& var, const variable_repository& repo)
  48 {
  49         auto expr_str = var.original_expr();
  50         auto trimmed = boost::trim_copy(expr_str);
  51
  52         if (boost::starts_with(trimmed, L"${") && boost::ends_with(trimmed, L"}"))
  53         {
  54                 expr_str = trimmed.substr(2, expr_str.length() - 3);
  55
  56                 if (var.is<double>())
  57                         var.as<double>().bind(parse_expression<double>(expr_str, repo));
  58                 else if (var.is<bool>())
  59                         var.as<bool>().bind(parse_expression<bool>(expr_str, repo));
  60                 else if (var.is<std::wstring>())
  61                         var.as<std::wstring>().bind(parse_expression<std::wstring>(expr_str, repo));
  62         }
  63         else if (!expr_str.empty())
  64         {
  65                 var.from_string(expr_str);
  66         }
  67 }
  68
  69 void describe_xml_scene_producer(core::help_sink& sink, const core::help_repository& repo)
  70 {
  71         sink.short_description(L"A simple producer for dynamic graphics using .scene files.");
  72         sink.syntax(L"[.scene_filename:string] {[param1:string] [value1:string]} {[param2:string] [value2:string]} ...");
  73         sink.para()->text(L"A simple producer that looks in the ")->code(L"templates")->text(L" folder for .scene files.");
  74         sink.para()->text(L"The .scene file is a simple XML document containing variables, layers and timelines.");
  75         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.");
  76         sink.para()->text(L"The scene producer also supports setting the variables while playing via the CALL command:");
  77         sink.example(L">> CALL 1-10 FIRSTNAME \"Jane\"", L"changes the variable FIRSTNAME on an already loaded scene.");
  78 }
  79
  80 spl::shared_ptr<core::frame_producer> create_xml_scene_producer(
  81                 const core::frame_producer_dependencies& dependencies,
  82                 const std::vector<std::wstring>& params)
  83 {
  84         if (params.empty())
  85                 return core::frame_producer::empty();
  86
  87         auto found = find_case_insensitive(env::template_folder() + L"/" + params.at(0) + L".scene");
  88         if (!found)
  89                 return core::frame_producer::empty();
  90
  91         std::wstring filename = *found;
  92
  93         CASPAR_SCOPED_CONTEXT_MSG(get_relative(filename, env::template_folder()).string() + ": ");
  94
  95         boost::property_tree::wptree root;
  96         boost::filesystem::wifstream file(filename);
  97         boost::property_tree::read_xml(
  98                         file,
  99                         root,
 100                         boost::property_tree::xml_parser::trim_whitespace
 101                                         | boost::property_tree::xml_parser::no_comments);
 102
 103         int width = ptree_get<int>(root, L"scene.<xmlattr>.width");
 104         int height = ptree_get<int>(root, L"scene.<xmlattr>.height");
 105
 106         auto scene = spl::make_shared<scene_producer>(L"scene", width, height, dependencies.format_desc);
 107
 108         for (auto elem : root | witerate_children(L"scene.variables") | welement_context_iteration)
 109         {
 110                 ptree_verify_element_name(elem, L"variable");
 111
 112                 auto type               = ptree_get<std::wstring>(elem.second, L"<xmlattr>.type");
 113                 auto id                 = ptree_get<std::wstring>(elem.second, L"<xmlattr>.id");
 114                 auto is_public  = elem.second.get(L"<xmlattr>.public", false);
 115                 auto expr               = ptree_get_value<std::wstring>(elem.second);
 116
 117                 if (!is_public)
 118                         id = L"variable." + id;
 119
 120                 if (type == L"number")
 121                         scene->create_variable<double>(id, is_public, expr);
 122                 else if (type == L"string")
 123                         scene->create_variable<std::wstring>(id, is_public, expr);
 124                 else if (type == L"bool")
 125                         scene->create_variable<bool>(id, is_public, expr);
 126         }
 127
 128         for (auto& elem : root | witerate_children(L"scene.layers") | welement_context_iteration)
 129         {
 130                 ptree_verify_element_name(elem, L"layer");
 131
 132                 auto id                                                 = ptree_get<std::wstring>(elem.second, L"<xmlattr>.id");
 133                 auto producer_string                    = ptree_get<std::wstring>(elem.second, L"producer");
 134                 auto producer                                   = [&]
 135                 {
 136                         CASPAR_SCOPED_CONTEXT_MSG(" -> ");
 137                         auto adjusted_dependencies = dependencies;
 138                         auto& adjusted_format_desc = adjusted_dependencies.format_desc;
 139
 140                         adjusted_format_desc.field_mode          = field_mode::progressive;
 141                         adjusted_format_desc.fps                        *= adjusted_format_desc.field_count;
 142                         adjusted_format_desc.duration           /= adjusted_format_desc.field_count;
 143                         adjusted_format_desc.field_count         = 1;
 144
 145                         return dependencies.producer_registry->create_producer(adjusted_dependencies, producer_string);
 146                 }();
 147                 auto& layer                                             = scene->create_layer(producer, 0, 0, id);
 148                 auto variable_prefix                    = L"layer." + id + L".";
 149
 150                 auto overridden_width = elem.second.get<std::wstring>(L"width", L"");
 151                 if (!overridden_width.empty())
 152                         layer.producer.get()->pixel_constraints().width = scene->create_variable<double>(variable_prefix + L"width", false, overridden_width);
 153                 else
 154                         scene->create_variable<double>(variable_prefix + L"width", false) = layer.producer.get()->pixel_constraints().width;
 155
 156                 auto overridden_height = elem.second.get<std::wstring>(L"height", L"");
 157                 if (!overridden_height.empty())
 158                         layer.producer.get()->pixel_constraints().height = scene->create_variable<double>(variable_prefix + L"height", false, overridden_height);
 159                 else
 160                         scene->create_variable<double>(variable_prefix + L"height", false) = layer.producer.get()->pixel_constraints().height;
 161
 162                 layer.hidden                                    = scene->create_variable<bool>(variable_prefix + L"hidden", false, elem.second.get(L"hidden", L"false"));
 163                 layer.position.x                                = scene->create_variable<double>(variable_prefix + L"x", false, ptree_get<std::wstring>(elem.second, L"x"));
 164                 layer.position.y                                = scene->create_variable<double>(variable_prefix + L"y", false, ptree_get<std::wstring>(elem.second, L"y"));
 165                 layer.anchor.x                                  = scene->create_variable<double>(variable_prefix + L"anchor_x", false, elem.second.get<std::wstring>(L"anchor_x", L"0.0"));
 166                 layer.anchor.y                                  = scene->create_variable<double>(variable_prefix + L"anchor_y", false, elem.second.get<std::wstring>(L"anchor_y", L"0.0"));
 167                 layer.rotation                                  = scene->create_variable<double>(variable_prefix + L"rotation", false, elem.second.get<std::wstring>(L"rotation", L"0.0"));
 168                 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"));
 169                 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"));
 170                 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}"));
 171                 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}"));
 172                 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"));
 173                 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"));
 174                 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}"));
 175                 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"));
 176                 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}"));
 177                 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}"));
 178                 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"));
 179                 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}"));
 180
 181                 layer.adjustments.opacity               = scene->create_variable<double>(variable_prefix + L"adjustment.opacity", false, elem.second.get(L"adjustments.opacity", L"1.0"));
 182                 layer.is_key                                    = scene->create_variable<bool>(variable_prefix + L"is_key", false, elem.second.get(L"is_key", L"false"));
 183                 layer.use_mipmap                                = scene->create_variable<bool>(variable_prefix + L"use_mipmap", false, elem.second.get(L"use_mipmap", L"false"));
 184                 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); });
 185                 layer.chroma_key.enable                 = scene->create_variable<bool>(variable_prefix + L"chroma_key.enable", false, elem.second.get(L"chroma_key.enable", L"false"));
 186                 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"));
 187                 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"));
 188                 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"));
 189                 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"));
 190                 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"));
 191                 layer.chroma_key.spill                  = scene->create_variable<double>(variable_prefix + L"chroma_key.spill", false, elem.second.get(L"chroma_key.spill", L"1.0"));
 192                 layer.chroma_key.spill_darken   = scene->create_variable<double>(variable_prefix + L"chroma_key.spill_darken", false, elem.second.get(L"chroma_key.spill_darken", L"2.0"));
 193
 194                 for (auto& var_name : producer->get_variables())
 195                 {
 196                         auto& var = producer->get_variable(var_name);
 197                         auto expr = elem.second.get<std::wstring>(L"parameters." + var_name, L"");
 198
 199                         if (var.is<double>())
 200                                 scene->create_variable<double>(variable_prefix + L"parameter." + var_name, false, expr) = var.as<double>();
 201                         else if (var.is<std::wstring>())
 202                                 scene->create_variable<std::wstring>(variable_prefix + L"parameter." + var_name, false, expr) = var.as<std::wstring>();
 203                         else if (var.is<bool>())
 204                                 scene->create_variable<bool>(variable_prefix + L"parameter." + var_name, false, expr) = var.as<bool>();
 205                 }
 206         }
 207
 208         if (root.get_child_optional(L"scene.marks"))
 209         {
 210                 for (auto& mark : root | witerate_children(L"scene.marks") | welement_context_iteration)
 211                 {
 212                         ptree_verify_element_name(mark, L"mark");
 213
 214                         auto at         = ptree_get<int64_t>(mark.second, L"<xmlattr>.at");
 215                         auto type       = get_mark_action(ptree_get<std::wstring>(mark.second, L"<xmlattr>.type"));
 216                         auto label      = mark.second.get(L"<xmlattr>.label", L"");
 217
 218                         scene->add_mark(at, type, label);
 219                 }
 220         }
 221
 222         if (root.get_child_optional(L"scene.timelines"))
 223         {
 224                 for (auto& elem : root | witerate_children(L"scene.timelines") | welement_context_iteration)
 225                 {
 226                         ptree_verify_element_name(elem, L"timeline");
 227
 228                         auto variable_name      = ptree_get<std::wstring>(elem.second, L"<xmlattr>.variable");
 229                         auto& variable          = scene->get_variable(variable_name);
 230
 231                         for (auto& k : elem.second)
 232                         {
 233                                 if (k.first == L"<xmlattr>")
 234                                         continue;
 235
 236                                 ptree_verify_element_name(k, L"keyframe");
 237
 238                                 auto easing = k.second.get(L"<xmlattr>.easing", L"");
 239                                 auto at = ptree_get<int64_t>(k.second, L"<xmlattr>.at");
 240
 241                                 auto keyframe_variable_name = L"timeline." + variable_name + L"." + boost::lexical_cast<std::wstring>(at);
 242
 243                                 if (variable.is<double>())
 244                                         scene->add_keyframe(variable.as<double>(), scene->create_variable<double>(keyframe_variable_name, false, ptree_get_value<std::wstring>(k.second)), at, easing);
 245                                 else if (variable.is<int>())
 246                                         scene->add_keyframe(variable.as<int>(), scene->create_variable<int>(keyframe_variable_name, false, ptree_get_value<std::wstring>(k.second)), at, easing);
 247                         }
 248                 }
 249         }
 250
 251         auto repo = [&scene](const std::wstring& name) -> variable&
 252         {
 253                 return scene->get_variable(name);
 254         };
 255
 256         for (auto& var_name : scene->get_variables())
 257         {
 258                 CASPAR_SCOPED_CONTEXT_MSG(L"/scene/variables/variable[@id=" + var_name + L"]/text()");
 259                 deduce_expression(scene->get_variable(var_name), repo);
 260         }
 261
 262         auto params2 = params;
 263         params2.erase(params2.begin());
 264
 265         scene->call(params2);
 266
 267         return scene;
 268 }
 269
 270 void init(module_dependencies dependencies)
 271 {
 272         dependencies.producer_registry->register_producer_factory(L"XML Scene Producer", create_xml_scene_producer, describe_xml_scene_producer);
 273         dependencies.cg_registry->register_cg_producer(
 274                         L"scene",
 275                         { L".scene" },
 276                         [](const std::wstring& filename) { return ""; },
 277                         [](const spl::shared_ptr<core::frame_producer>& producer)
 278                         {
 279                                 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
 280                         },
 281                         [](
 282                         const core::frame_producer_dependencies& dependencies,
 283                         const std::wstring& filename)
 284                         {
 285                                 return create_xml_scene_producer(dependencies, { filename });
 286                         },
 287                         false);
 288 }
 289
 290 }}}