git.sesse.net Git - casparcg/blob - modules/psd/psd_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: Niklas P Andersson, niklas.p.andersson@svt.se
  20 */
  21
  22 #include "psd_scene_producer.h"
  23 #include "psd_document.h"
  24 #include "layer.h"
  25
  26 #include <core/frame/pixel_format.h>
  27 #include <core/frame/frame_factory.h>
  28 #include <core/frame/audio_channel_layout.h>
  29 #include <core/producer/frame_producer.h>
  30 #include <core/producer/color/color_producer.h>
  31 #include <core/producer/text/text_producer.h>
  32 #include <core/producer/scene/scene_cg_proxy.h>
  33 #include <core/producer/scene/scene_producer.h>
  34 #include <core/producer/scene/const_producer.h>
  35 #include <core/producer/scene/hotswap_producer.h>
  36 #include <core/producer/media_info/media_info.h>
  37 #include <core/frame/draw_frame.h>
  38 #include <core/help/help_repository.h>
  39 #include <core/help/help_sink.h>
  40
  41 #include <common/env.h>
  42 #include <common/memory.h>
  43 #include <common/log.h>
  44 #include <common/os/filesystem.h>
  45
  46 #include <boost/filesystem.hpp>
  47 #include <boost/thread/future.hpp>
  48 #include <boost/algorithm/string.hpp>
  49 #include <boost/rational.hpp>
  50
  51 #include <future>
  52
  53 namespace caspar { namespace psd {
  54
  55 core::text::text_info get_text_info(const boost::property_tree::wptree& ptree)
  56 {
  57         core::text::text_info result;
  58         int font_index = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Font", 0);
  59         result.size = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FontSize", 30.0f);
  60         //result.leading = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Leading", 0);
  61         result.tracking = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Tracking", 0);
  62         result.baseline_shift = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.BaselineShift", 0);
  63         //result.kerning = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Kerning", 0);
  64
  65         int child_index = 0;
  66         auto color_node = ptree.get_child_optional(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FillColor.Values");
  67
  68         if (color_node)
  69         {
  70                 for(auto it = color_node->begin(); it != color_node->end(); ++it, ++child_index)
  71                 {
  72                         auto& value_node = (*it).second;
  73                         float value = value_node.get_value(0.0f);
  74                         switch(child_index)
  75                         {
  76                         case 0: result.color.a = value; break;
  77                         case 1: result.color.r = value; break;
  78                         case 2: result.color.g = value; break;
  79                         case 3: result.color.b = value; break;
  80                         }
  81                 }
  82         }
  83
  84         //find fontname
  85         child_index = 0;
  86         auto fontset_node = ptree.get_child(L"ResourceDict.FontSet");
  87         for(auto it = fontset_node.begin(); it != fontset_node.end(); ++it, ++child_index)
  88         {
  89                 auto& font_node = (*it).second;
  90                 if(child_index == font_index)
  91                 {
  92                         result.font = font_node.get(L"Name", L"");
  93                         break;
  94                 }
  95         }
  96
  97         return result;
  98 }
  99
 100
 101 class dependency_resolver
 102 {
 103         struct layer_record
 104         {
 105                 layer_record() : layer(nullptr), tags(layer_tag::none), adjustment_x(0), adjustment_y(0)
 106                 {}
 107
 108                 caspar::core::scene::layer* layer;
 109                 layer_tag tags;
 110                 double adjustment_x;
 111                 double adjustment_y;
 112         };
 113
 114         std::list<layer_record> layers;
 115         layer_record master;
 116
 117         spl::shared_ptr<core::scene::scene_producer> scene_;
 118         bool is_root_;
 119
 120 public:
 121         dependency_resolver(const spl::shared_ptr<core::scene::scene_producer>& s) :
 122                 scene_(s), is_root_(false)
 123         {}
 124         dependency_resolver(const spl::shared_ptr<core::scene::scene_producer>& s, bool root) :
 125                 scene_(s), is_root_(root)
 126         {}
 127
 128         spl::shared_ptr<core::scene::scene_producer> scene() { return scene_; }
 129
 130         void add(caspar::core::scene::layer* layer, layer_tag tags, double adjustment_x, double adjustment_y)
 131         {
 132                 layer_record rec;
 133                 rec.layer = layer;
 134                 rec.tags = tags;
 135                 rec.adjustment_x = adjustment_x;
 136                 rec.adjustment_y = adjustment_y;
 137                 layers.push_back(rec);
 138
 139                 //if the layer is either explicitly tagged as dynamic or at least not tagged as static/rasterized we should try to set it as master
 140                 if((rec.tags & layer_tag::explicit_dynamic) == layer_tag::explicit_dynamic || (rec.tags & layer_tag::rasterized) == layer_tag::none)
 141                 {
 142                         //if we don't have a master already, just assign this
 143                         if (master.layer == nullptr)
 144                                 master = rec;
 145                         else if ((rec.tags & layer_tag::explicit_dynamic) == layer_tag::explicit_dynamic)
 146                         {
 147                                 if((master.tags & layer_tag::explicit_dynamic) == layer_tag::none)
 148                                 {
 149                                         //if we have a master that's not explicitly tagged as dynamic but this layer is; use this as master
 150                                         master = rec;
 151                                 }
 152                                 else {
 153                                         //we have multiple layers that're tagged as dynamic, warn that the first one will be used
 154                                         CASPAR_LOG(warning) << "Multiple explicitly dynamic layers in the same group. The first one will be used";
 155                                 }
 156                         }
 157                 }
 158         }
 159
 160         void calculate()
 161         {
 162                 if (layers.size() == 0)
 163                         return;
 164
 165                 if (master.layer == nullptr) {
 166                         CASPAR_LOG(warning) << "Dependent layers without any dynamic layer";
 167                         return;
 168                 }
 169
 170                 for (auto &r : layers)
 171                 {
 172                         if (r.layer != master.layer)
 173                         {
 174                                 //x-coords
 175                                 double slave_left = r.layer->position.x.get();
 176                                 double master_left = master.layer->position.x.get();
 177                                 double slave_right = slave_left + r.layer->producer.get()->pixel_constraints().width.get();
 178                                 double master_right = master_left + master.layer->producer.get()->pixel_constraints().width.get();
 179
 180                                 double slave_width = slave_right - slave_left;
 181                                 double master_width = master_right - master_left;
 182
 183                                 double offset_start_x = slave_left - master_left;
 184                                 double offset_end_x = slave_left - master_right;
 185
 186                                 if((r.tags & layer_tag::moveable) == layer_tag::moveable)
 187                                         r.layer->position.x.bind(master.layer->position.x + master.layer->producer.get()->pixel_constraints().width + offset_end_x + r.adjustment_x);
 188                                 else if ((r.tags & layer_tag::resizable) == layer_tag::resizable) {
 189                                         r.layer->position.x.bind(master.layer->position.x + offset_start_x + r.adjustment_x);
 190                                         r.layer->producer.get()->pixel_constraints().width.bind(master.layer->producer.get()->pixel_constraints().width + (slave_width - master_width));
 191                                 }
 192
 193                                 //no support for changes in the y-direction yet
 194                         }
 195                 }
 196         }
 197 };
 198
 199 int64_t get_frame_number(
 200                 const core::video_format_desc& format_desc,
 201                 const boost::rational<int>& at_second)
 202 {
 203         return static_cast<int64_t>(
 204                         boost::rational_cast<double>(at_second) * format_desc.fps);
 205 }
 206
 207 boost::rational<int> get_rational(const boost::property_tree::wptree& node)
 208 {
 209         return boost::rational<int>(
 210                         node.get<int>(L"numerator"), node.get<int>(L"denominator"));
 211 }
 212
 213 void create_marks_from_comments(
 214                 const spl::shared_ptr<core::scene::scene_producer>& scene,
 215                 const core::video_format_desc& format_desc,
 216                 const boost::property_tree::wptree& comment_track)
 217 {
 218         auto keylist = comment_track.get_child_optional(L"keyList");
 219
 220         if (!keylist)
 221                 return;
 222
 223         for (auto& key : *keylist)
 224         {
 225                 auto time = get_rational(key.second.get_child(L"time"));
 226                 auto frame = get_frame_number(format_desc, time);
 227                 auto text = key.second.get<std::wstring>(L"animKey.Vl  ");
 228                 std::vector<std::wstring> marks;
 229                 boost::split(marks, text, boost::is_any_of(","));
 230
 231                 for (auto& mark : marks)
 232                 {
 233                         boost::trim_if(mark, [](wchar_t c) { return isspace(c) || c == 0; });
 234
 235                         std::vector<std::wstring> args;
 236                         boost::split(args, mark, boost::is_any_of(" \t"), boost::algorithm::token_compress_on);
 237
 238                         scene->add_mark(frame, core::scene::get_mark_action(args.at(0)), args.size() == 1 ? L"" : args.at(1));
 239                 }
 240         }
 241 }
 242
 243 void create_marks(
 244                 const spl::shared_ptr<core::scene::scene_producer>& scene,
 245                 const core::video_format_desc& format_desc,
 246                 const boost::property_tree::wptree& global_timeline)
 247 {
 248         auto time = get_rational(global_timeline.get_child(L"duration"));
 249         auto remove_at_frame = get_frame_number(format_desc, time);
 250
 251         scene->add_mark(remove_at_frame, core::scene::mark_action::remove, L"");
 252
 253         auto tracklist = global_timeline.get_child_optional(L"globalTrackList");
 254
 255         if (!tracklist)
 256                 return;
 257
 258         for (auto& track : *tracklist)
 259         {
 260                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
 261
 262                 if (track_id == L"globalCommentTrack")
 263                         create_marks_from_comments(scene, format_desc, track.second);
 264         }
 265 }
 266
 267 void create_timelines(
 268                 const spl::shared_ptr<core::scene::scene_producer>& scene,
 269                 const core::video_format_desc& format_desc,
 270                 core::scene::layer& layer,
 271                 const layer_ptr& psd_layer,
 272                 double adjustment_x,
 273                 double adjustment_y)
 274 {
 275         auto timeline = psd_layer->timeline_data();
 276         auto start = get_rational(timeline.get_child(L"timeScope.Strt"));
 277         auto end_offset = get_rational(timeline.get_child(L"timeScope.outTime"));
 278         auto end = start + end_offset;
 279         auto start_frame = get_frame_number(format_desc, start);
 280         auto end_frame = get_frame_number(format_desc, end);
 281
 282         layer.hidden = scene->frame() < start_frame || scene->frame() > end_frame;
 283
 284         auto tracklist = timeline.get_child_optional(L"trackList");
 285
 286         if (!tracklist)
 287                 return;
 288
 289         double original_pos_x = psd_layer->location().x;
 290         double original_pos_y = psd_layer->location().y;
 291
 292         for (auto& track : *tracklist)
 293         {
 294                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
 295
 296                 if (track_id == L"sheetPositionTrack")
 297                 {
 298                         for (auto& key : track.second.get_child(L"keyList"))
 299                         {
 300                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
 301                                                 == L"Lnr ";
 302                                 auto time = get_rational(key.second.get_child(L"time"));
 303                                 auto hrzn = key.second.get<double>(L"animKey.Hrzn");
 304                                 auto vrtc = key.second.get<double>(L"animKey.Vrtc");
 305                                 auto x = original_pos_x + hrzn + adjustment_x;
 306                                 auto y = original_pos_y + vrtc + adjustment_y;
 307                                 auto frame = get_frame_number(format_desc, time);
 308
 309                                 if (frame == 0) // Consider as initial value (rewind)
 310                                 {
 311                                         layer.position.x.set(x);
 312                                         layer.position.y.set(y);
 313                                 }
 314
 315                                 frame = start_frame + frame; // translate to global timeline
 316
 317                                 if (tween)
 318                                 {
 319                                         scene->add_keyframe(layer.position.x, x, frame, L"easeOutSine");
 320                                         scene->add_keyframe(layer.position.y, y, frame, L"easeOutSine");
 321                                 }
 322                                 else
 323                                 {
 324                                         scene->add_keyframe(layer.position.x, x, frame);
 325                                         scene->add_keyframe(layer.position.y, y, frame);
 326                                 }
 327                         }
 328                 }
 329                 else if (track_id == L"opacityTrack")
 330                 {
 331                         auto& opacity = layer.adjustments.opacity;
 332
 333                         for (auto& key : track.second.get_child(L"keyList"))
 334                         {
 335                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
 336                                                 == L"Lnr ";
 337                                 auto time = get_rational(key.second.get_child(L"time"));
 338                                 auto opct = key.second.get<double>(L"animKey.Opct.#Prc") / 100.0;
 339                                 auto frame = get_frame_number(format_desc, time);
 340
 341                                 if (frame == 0) // Consider as initial value (rewind)
 342                                         opacity.set(opct);
 343
 344                                 frame = start_frame + frame; // translate to global timeline
 345
 346                                 if (tween)
 347                                         scene->add_keyframe(opacity, opct, frame, L"easeOutSine");
 348                                 else
 349                                         scene->add_keyframe(opacity, opct, frame);
 350                         }
 351                 }
 352         }
 353 }
 354
 355 spl::shared_ptr<core::frame_producer> create_psd_scene_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
 356 {
 357         std::wstring filename = env::template_folder() + params.at(0) + L".psd";
 358         auto found_file = find_case_insensitive(filename);
 359
 360         if (!found_file)
 361                 return core::frame_producer::empty();
 362
 363         psd_document doc;
 364         doc.parse(*found_file);
 365
 366         auto root = spl::make_shared<core::scene::scene_producer>(L"psd", doc.width(), doc.height(), dependencies.format_desc);
 367
 368         std::vector<std::pair<std::wstring, spl::shared_ptr<core::text_producer>>> text_producers_by_layer_name;
 369
 370         std::stack<dependency_resolver> scene_stack;
 371         scene_stack.push(dependency_resolver{ root, true });
 372
 373         auto layers_end = doc.layers().rend();
 374         for(auto it = doc.layers().rbegin(); it != layers_end; ++it)
 375         {
 376                 auto& psd_layer = (*it);
 377                 auto& current = scene_stack.top();
 378
 379                 if (psd_layer->group_mode() == layer_type::group) {
 380                         //we've found a group. Create a new scene and add it to the scene-stack
 381
 382                         auto format_desc = (dependencies.format_desc.field_count == 1) ? dependencies.format_desc : core::video_format_desc{ dependencies.format_desc.format,
 383                                                                                                                                                                                                                                                                         dependencies.format_desc.width,
 384                                                                                                                                                                                                                                                                         dependencies.format_desc.height,
 385                                                                                                                                                                                                                                                                         dependencies.format_desc.square_width,
 386                                                                                                                                                                                                                                                                         dependencies.format_desc.square_height,
 387                                                                                                                                                                                                                                                                         core::field_mode::progressive,
 388                                                                                                                                                                                                                                                                         dependencies.format_desc.time_scale*2,
 389                                                                                                                                                                                                                                                                         dependencies.format_desc.duration,
 390                                                                                                                                                                                                                                                                         dependencies.format_desc.name,
 391                                                                                                                                                                                                                                                                         dependencies.format_desc.audio_cadence };
 392
 393                         auto group = spl::make_shared<core::scene::scene_producer>(psd_layer->name(), doc.width(), doc.height(), format_desc);
 394
 395                         auto& scene_layer = current.scene()->create_layer(group, psd_layer->location().x, psd_layer->location().y, psd_layer->name());
 396                         scene_layer.adjustments.opacity.set(psd_layer->opacity() / 255.0);
 397                         scene_layer.hidden.set(!psd_layer->is_visible());
 398
 399                         if (psd_layer->has_timeline())
 400                                 create_timelines(root, dependencies.format_desc, scene_layer, psd_layer, 0, 0);
 401
 402                         if (psd_layer->is_movable())
 403                                 current.add(&scene_layer, psd_layer->tags(), 0, 0);
 404
 405                         if (psd_layer->is_resizable())
 406                                 CASPAR_LOG(warning) << "Groups doesn't support the \"resizable\"-tag.";
 407
 408                         if (psd_layer->is_explicit_dynamic())
 409                                 CASPAR_LOG(warning) << "Groups doesn't support the \"dynamic\"-tag.";
 410
 411                         scene_stack.push(group);
 412                         continue;
 413                 }
 414                 else if (psd_layer->group_mode() == layer_type::group_delimiter) {
 415                         //a group-terminator. Finish the scene
 416                         current.scene()->reverse_layers();
 417                         current.calculate();
 418                         scene_stack.pop();
 419                         continue;
 420                 }
 421
 422                 if(psd_layer->is_visible())
 423                 {
 424                         auto layer_name = psd_layer->name();
 425
 426                         if(psd_layer->is_text() && !psd_layer->is_static())
 427                         {
 428                                 std::wstring str = psd_layer->text_data().get(L"EngineDict.Editor.Text", L"");
 429
 430                                 core::text::text_info text_info(std::move(get_text_info(psd_layer->text_data())));
 431                                 text_info.size *= psd_layer->text_scale();
 432
 433                                 auto text_producer = core::text_producer::create(dependencies.frame_factory, 0, 0, str, text_info, doc.width(), doc.height());
 434                                 text_producer->pixel_constraints().width.set(psd_layer->size().width);
 435                                 text_producer->pixel_constraints().height.set(psd_layer->size().height);
 436                                 core::text::string_metrics metrics = text_producer->measure_string(str);
 437
 438                                 auto adjustment_x = -2; //the 2 offset is just a hack for now. don't know why our text is rendered 2 px to the right of that in photoshop
 439                                 auto adjustment_y = metrics.bearingY;
 440                                 auto& scene_layer = current.scene()->create_layer(text_producer, psd_layer->location().x + adjustment_x, psd_layer->location().y + adjustment_y, layer_name);
 441                                 scene_layer.adjustments.opacity.set(psd_layer->opacity() / 255.0);
 442                                 scene_layer.hidden.set(!psd_layer->is_visible());
 443
 444                                 if (psd_layer->has_timeline())
 445                                         create_timelines(root, dependencies.format_desc, scene_layer, psd_layer, adjustment_x, adjustment_y);
 446
 447                                 current.add(&scene_layer, psd_layer->tags(), -adjustment_x, -adjustment_y);
 448                                 text_producers_by_layer_name.push_back(std::make_pair(layer_name, text_producer));
 449                         }
 450                         else
 451                         {
 452                                 std::shared_ptr<core::frame_producer> layer_producer;
 453                                 if(psd_layer->is_solid())
 454                                 {
 455                                         layer_producer = core::create_const_producer(core::create_color_frame(it->get(), dependencies.frame_factory, psd_layer->solid_color().to_uint32()), psd_layer->bitmap()->width(), psd_layer->bitmap()->height());
 456                                 }
 457                                 else if(psd_layer->bitmap())
 458                                 {
 459                                         if (psd_layer->is_placeholder())
 460                                         {
 461                                                 auto hotswap = std::make_shared<core::hotswap_producer>(psd_layer->bitmap()->width(), psd_layer->bitmap()->height());
 462                                                 hotswap->producer().set(dependencies.producer_registry->create_producer(dependencies, layer_name));
 463                                                 layer_producer = hotswap;
 464                                         }
 465                                         else
 466                                         {
 467                                                 core::pixel_format_desc pfd(core::pixel_format::bgra);
 468                                                 pfd.planes.push_back(core::pixel_format_desc::plane(psd_layer->bitmap()->width(), psd_layer->bitmap()->height(), 4));
 469
 470                                                 auto frame = dependencies.frame_factory->create_frame(it->get(), pfd, core::audio_channel_layout::invalid());
 471                                                 auto destination = frame.image_data().data();
 472                                                 auto source = psd_layer->bitmap()->data();
 473                                                 memcpy(destination, source, frame.image_data().size());
 474
 475                                                 layer_producer = core::create_const_producer(core::draw_frame(std::move(frame)), psd_layer->bitmap()->width(), psd_layer->bitmap()->height());
 476                                         }
 477                                 }
 478
 479                                 if(layer_producer)
 480                                 {
 481                                         auto& scene_layer = current.scene()->create_layer(spl::make_shared_ptr(layer_producer), psd_layer->location().x, psd_layer->location().y, psd_layer->name());
 482                                         scene_layer.adjustments.opacity.set(psd_layer->opacity() / 255.0);
 483                                         scene_layer.hidden.set(!psd_layer->is_visible());
 484
 485                                         if (psd_layer->has_timeline())
 486                                                 create_timelines(root, dependencies.format_desc, scene_layer, psd_layer, 0, 0);
 487
 488                                         if(psd_layer->is_movable() || psd_layer->is_resizable())
 489                                                 current.add(&scene_layer, psd_layer->tags(), 0, 0);
 490                                 }
 491                         }
 492                 }
 493         }
 494         if (scene_stack.size() != 1) {
 495
 496         }
 497         root->reverse_layers();
 498         scene_stack.top().calculate();
 499
 500
 501         // Reset all dynamic text fields to empty strings and expose them as a scene parameter.
 502         for (auto& text_layer : text_producers_by_layer_name)
 503                 text_layer.second->text().bind(root->create_variable<std::wstring>(boost::to_lower_copy(text_layer.first), true, L""));
 504
 505         if (doc.has_timeline())
 506                 create_marks(root, dependencies.format_desc, doc.timeline());
 507
 508         auto params2 = params;
 509         params2.erase(params2.begin());
 510
 511         root->call(params2);
 512
 513         return root;
 514 }
 515
 516 void init(core::module_dependencies dependencies)
 517 {
 518         dependencies.cg_registry->register_cg_producer(
 519                         L"psd",
 520                         { L".psd" },
 521                         [](const std::wstring& filename) { return ""; },
 522                         [](const spl::shared_ptr<core::frame_producer>& producer)
 523                         {
 524                                 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
 525                         },
 526                         [](
 527                                         const core::frame_producer_dependencies& dependencies,
 528                                         const std::wstring& filename)
 529                         {
 530                                 return create_psd_scene_producer(dependencies, { filename });
 531                         },
 532                         false);
 533 }
 534
 535 }}