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/producer/frame_producer.h>
  29 #include <core/producer/color/color_producer.h>
  30 #include <core/producer/text/text_producer.h>
  31 #include <core/producer/scene/scene_cg_proxy.h>
  32 #include <core/producer/scene/scene_producer.h>
  33 #include <core/producer/scene/const_producer.h>
  34 #include <core/producer/scene/hotswap_producer.h>
  35 #include <core/producer/media_info/media_info.h>
  36 #include <core/frame/draw_frame.h>
  37 #include <core/help/help_repository.h>
  38 #include <core/help/help_sink.h>
  39
  40 #include <common/env.h>
  41 #include <common/memory.h>
  42 #include <common/log.h>
  43 #include <common/os/filesystem.h>
  44
  45 #include <boost/filesystem.hpp>
  46 #include <boost/thread/future.hpp>
  47 #include <boost/algorithm/string.hpp>
  48 #include <boost/rational.hpp>
  49
  50 #include <future>
  51
  52 namespace caspar { namespace psd {
  53
  54 core::text::text_info get_text_info(const boost::property_tree::wptree& ptree)
  55 {
  56         core::text::text_info result;
  57         int font_index = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Font", 0);
  58         result.size = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FontSize", 30.0f);
  59         //result.leading = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Leading", 0);
  60         result.tracking = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Tracking", 0);
  61         result.baseline_shift = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.BaselineShift", 0);
  62         //result.kerning = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Kerning", 0);
  63
  64         int child_index = 0;
  65         auto color_node = ptree.get_child_optional(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FillColor.Values");
  66
  67         if (color_node)
  68         {
  69                 for(auto it = color_node->begin(); it != color_node->end(); ++it, ++child_index)
  70                 {
  71                         auto& value_node = (*it).second;
  72                         float value = value_node.get_value(0.0f);
  73                         switch(child_index)
  74                         {
  75                         case 0: result.color.a = value; break;
  76                         case 1: result.color.r = value; break;
  77                         case 2: result.color.g = value; break;
  78                         case 3: result.color.b = value; break;
  79                         }
  80                 }
  81         }
  82
  83         //find fontname
  84         child_index = 0;
  85         auto fontset_node = ptree.get_child(L"ResourceDict.FontSet");
  86         for(auto it = fontset_node.begin(); it != fontset_node.end(); ++it, ++child_index)
  87         {
  88                 auto& font_node = (*it).second;
  89                 if(child_index == font_index)
  90                 {
  91                         result.font = font_node.get(L"Name", L"");
  92                         break;
  93                 }
  94         }
  95
  96         return result;
  97 }
  98
  99
 100         class layer_link_constructor
 101         {
 102                 struct linked_layer_record
 103                 {
 104                         caspar::core::scene::layer* layer;
 105                         int link_id;
 106                         bool is_master;
 107                         double adjustment_x;
 108                         double adjustment_y;
 109                 };
 110
 111                 std::vector<linked_layer_record> layers;
 112                 std::vector<linked_layer_record> masters;
 113
 114         public:
 115                 void add(caspar::core::scene::layer* layer, int link_group, bool master, double adjustment_x, double adjustment_y)
 116                 {
 117                         linked_layer_record rec;
 118                         rec.layer = layer;
 119                         rec.link_id = link_group;
 120                         rec.is_master = master;
 121                         rec.adjustment_x = adjustment_x;
 122                         rec.adjustment_y = adjustment_y;
 123                         layers.push_back(rec);
 124
 125                         if(rec.is_master)
 126                         {
 127                                 auto it = std::find_if(masters.begin(), masters.end(), [=](linked_layer_record const &r){ return r.link_id == link_group; });
 128                                 if(it == masters.end())
 129                                         masters.push_back(rec);
 130                                 else
 131                                         masters.erase(it);      //ambigous, two linked layers with locked position
 132                         }
 133                 }
 134
 135                 void calculate()
 136                 {
 137                         for(auto it = masters.begin(); it != masters.end(); ++it)
 138                         {
 139                                 auto& master = (*it);
 140                                 //std::for_each(layers.begin(), layers.end(), [&master](linked_layer_record &r) mutable {
 141                                 for (auto &r : layers) {
 142                                         if(r.link_id == master.link_id && r.layer != master.layer)
 143                                         {
 144                                                 {       //x-coords
 145                                                         double slave_left = r.layer->position.x.get() + r.adjustment_x;
 146                                                         double slave_right = slave_left + r.layer->producer.get()->pixel_constraints().width.get();
 147
 148                                                         double master_left = master.layer->position.x.get() + master.adjustment_x;
 149                                                         double master_right = master_left + master.layer->producer.get()->pixel_constraints().width.get();
 150
 151                                                         if((slave_left >= master_left && slave_right <= master_right) || (slave_left <= master_left && slave_right >= master_right))
 152                                                         {
 153                                                                 //change width of slave
 154                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x + (slave_left - master_left));
 155                                                                 r.layer->producer.get()->pixel_constraints().width.bind(master.layer->producer.get()->pixel_constraints().width + (slave_right - slave_left - master_right + master_left));
 156                                                         }
 157                                                         else if(slave_left >= master_right)
 158                                                         {
 159                                                                 //push slave ahead of master
 160                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x + master.layer->producer.get()->pixel_constraints().width + (slave_left - master_right));
 161                                                         }
 162                                                         else if(slave_right <= master_left)
 163                                                         {
 164                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x - (master_left - slave_left));
 165                                                         }
 166                                                 }
 167
 168                                                 {       //y-coords
 169                                                         double slave_top = r.layer->position.y.get() + r.adjustment_y;
 170                                                         double slave_bottom = slave_top + r.layer->producer.get()->pixel_constraints().height.get();
 171
 172                                                         double master_top = master.layer->position.y.get() + master.adjustment_y;
 173                                                         double master_bottom = master_top + master.layer->producer.get()->pixel_constraints().height.get();
 174
 175                                                         if((slave_top >= master_top && slave_bottom <= master_bottom) || (slave_top <= master_top && slave_bottom >= master_bottom))
 176                                                         {
 177                                                                 //change height of slave
 178                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y + (slave_top - master_top));
 179                                                                 r.layer->producer.get()->pixel_constraints().height.bind(master.layer->producer.get()->pixel_constraints().height + (slave_bottom - slave_top - master_bottom + master_top));
 180                                                         }
 181                                                         else if(slave_top >= master_bottom)
 182                                                         {
 183                                                                 //push slave ahead of master
 184                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y + master.layer->producer.get()->pixel_constraints().height + (slave_top - master_bottom));
 185                                                         }
 186                                                         else if(slave_bottom <= master_top)
 187                                                         {
 188                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y - (master_top - slave_top));
 189                                                         }
 190                                                 }
 191
 192                                         }
 193                                 }
 194                         }
 195                 }
 196         };
 197
 198 int64_t get_frame_number(
 199                 const core::video_format_desc& format_desc,
 200                 const boost::rational<int>& at_second)
 201 {
 202         return static_cast<int64_t>(
 203                         boost::rational_cast<double>(at_second) * format_desc.fps);
 204 }
 205
 206 boost::rational<int> get_rational(const boost::property_tree::wptree& node)
 207 {
 208         return boost::rational<int>(
 209                         node.get<int>(L"numerator"), node.get<int>(L"denominator"));
 210 }
 211
 212 void create_marks_from_comments(
 213                 const spl::shared_ptr<core::scene::scene_producer>& scene,
 214                 const core::video_format_desc& format_desc,
 215                 const boost::property_tree::wptree& comment_track)
 216 {
 217         auto keylist = comment_track.get_child_optional(L"keyList");
 218
 219         if (!keylist)
 220                 return;
 221
 222         for (auto& key : *keylist)
 223         {
 224                 auto time = get_rational(key.second.get_child(L"time"));
 225                 auto frame = get_frame_number(format_desc, time);
 226                 auto text = key.second.get<std::wstring>(L"animKey.Vl  ");
 227                 std::vector<std::wstring> marks;
 228                 boost::split(marks, text, boost::is_any_of(","));
 229
 230                 for (auto& mark : marks)
 231                 {
 232                         boost::trim_if(mark, [](wchar_t c) { return isspace(c) || c == 0; });
 233
 234                         std::vector<std::wstring> args;
 235                         boost::split(args, mark, boost::is_any_of(" \t"), boost::algorithm::token_compress_on);
 236
 237                         scene->add_mark(frame, core::scene::get_mark_action(args.at(0)), args.size() == 1 ? L"" : args.at(1));
 238                 }
 239         }
 240 }
 241
 242 void create_marks(
 243                 const spl::shared_ptr<core::scene::scene_producer>& scene,
 244                 const core::video_format_desc& format_desc,
 245                 const boost::property_tree::wptree& global_timeline)
 246 {
 247         auto time = get_rational(global_timeline.get_child(L"duration"));
 248         auto remove_at_frame = get_frame_number(format_desc, time);
 249
 250         scene->add_mark(remove_at_frame, core::scene::mark_action::remove, L"");
 251
 252         auto tracklist = global_timeline.get_child_optional(L"globalTrackList");
 253
 254         if (!tracklist)
 255                 return;
 256
 257         for (auto& track : *tracklist)
 258         {
 259                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
 260
 261                 if (track_id == L"globalCommentTrack")
 262                         create_marks_from_comments(scene, format_desc, track.second);
 263         }
 264 }
 265
 266 void create_timelines(
 267                 const spl::shared_ptr<core::scene::scene_producer>& scene,
 268                 const core::video_format_desc& format_desc,
 269                 core::scene::layer& layer,
 270                 const layer_ptr& psd_layer,
 271                 double adjustment_x,
 272                 double adjustment_y)
 273 {
 274         auto timeline = psd_layer->timeline_data();
 275         auto start = get_rational(timeline.get_child(L"timeScope.Strt"));
 276         auto end_offset = get_rational(timeline.get_child(L"timeScope.outTime"));
 277         auto end = start + end_offset;
 278         auto start_frame = get_frame_number(format_desc, start);
 279         auto end_frame = get_frame_number(format_desc, end);
 280
 281         layer.hidden = scene->frame() < start_frame || scene->frame() > end_frame;
 282
 283         auto tracklist = timeline.get_child_optional(L"trackList");
 284
 285         if (!tracklist)
 286                 return;
 287
 288         double original_pos_x = psd_layer->location().x;
 289         double original_pos_y = psd_layer->location().y;
 290
 291         for (auto& track : *tracklist)
 292         {
 293                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
 294
 295                 if (track_id == L"sheetPositionTrack")
 296                 {
 297                         for (auto& key : track.second.get_child(L"keyList"))
 298                         {
 299                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
 300                                                 == L"Lnr ";
 301                                 auto time = get_rational(key.second.get_child(L"time"));
 302                                 auto hrzn = key.second.get<double>(L"animKey.Hrzn");
 303                                 auto vrtc = key.second.get<double>(L"animKey.Vrtc");
 304                                 auto x = original_pos_x + hrzn + adjustment_x;
 305                                 auto y = original_pos_y + vrtc + adjustment_y;
 306                                 auto frame = get_frame_number(format_desc, time);
 307
 308                                 if (frame == 0) // Consider as initial value (rewind)
 309                                 {
 310                                         layer.position.x.set(x);
 311                                         layer.position.y.set(y);
 312                                 }
 313
 314                                 frame = start_frame + frame; // translate to global timeline
 315
 316                                 if (tween)
 317                                 {
 318                                         scene->add_keyframe(layer.position.x, x, frame, L"easeOutSine");
 319                                         scene->add_keyframe(layer.position.y, y, frame, L"easeOutSine");
 320                                 }
 321                                 else
 322                                 {
 323                                         scene->add_keyframe(layer.position.x, x, frame);
 324                                         scene->add_keyframe(layer.position.y, y, frame);
 325                                 }
 326                         }
 327                 }
 328                 else if (track_id == L"opacityTrack")
 329                 {
 330                         auto& opacity = layer.adjustments.opacity;
 331
 332                         for (auto& key : track.second.get_child(L"keyList"))
 333                         {
 334                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
 335                                                 == L"Lnr ";
 336                                 auto time = get_rational(key.second.get_child(L"time"));
 337                                 auto opct = key.second.get<double>(L"animKey.Opct.#Prc") / 100.0;
 338                                 auto frame = get_frame_number(format_desc, time);
 339
 340                                 if (frame == 0) // Consider as initial value (rewind)
 341                                         opacity.set(opct);
 342
 343                                 frame = start_frame + frame; // translate to global timeline
 344
 345                                 if (tween)
 346                                         scene->add_keyframe(opacity, opct, frame, L"easeOutSine");
 347                                 else
 348                                         scene->add_keyframe(opacity, opct, frame);
 349                         }
 350                 }
 351         }
 352 }
 353
 354 spl::shared_ptr<core::frame_producer> create_psd_scene_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
 355 {
 356         std::wstring filename = env::template_folder() + params.at(0) + L".psd";
 357         auto found_file = find_case_insensitive(filename);
 358
 359         if (!found_file)
 360                 return core::frame_producer::empty();
 361
 362         psd_document doc;
 363         doc.parse(*found_file);
 364
 365         spl::shared_ptr<core::scene::scene_producer> root(spl::make_shared<core::scene::scene_producer>(doc.width(), doc.height(), dependencies.format_desc));
 366
 367         layer_link_constructor link_constructor;
 368
 369         std::vector<std::pair<std::wstring, spl::shared_ptr<core::text_producer>>> text_producers_by_layer_name;
 370
 371         auto layers_end = doc.layers().end();
 372         for(auto it = doc.layers().begin(); it != layers_end; ++it)
 373         {
 374                 if((*it)->is_visible())
 375                 {
 376                         bool is_text = (*it)->is_text();
 377                         bool is_marked_as_dynamic = (*it)->sheet_color() == 4;
 378                         std::wstring layer_name = (*it)->name();
 379                         if(is_text && is_marked_as_dynamic)
 380                         {
 381                                 std::wstring str = (*it)->text_data().get(L"EngineDict.Editor.Text", L"");
 382
 383                                 core::text::text_info text_info(std::move(get_text_info((*it)->text_data())));
 384                                 text_info.size *= (*it)->text_scale();
 385
 386                                 auto text_producer = core::text_producer::create(dependencies.frame_factory, 0, 0, str, text_info, doc.width(), doc.height());
 387
 388                                 core::text::string_metrics metrics = text_producer->measure_string(str);
 389
 390                                 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
 391                                 auto adjustment_y = metrics.bearingY;
 392                                 auto& new_layer = root->create_layer(text_producer, (*it)->location().x + adjustment_x, (*it)->location().y + adjustment_y, (*it)->name());
 393                                 new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
 394                                 new_layer.hidden.set(!(*it)->is_visible());
 395
 396                                 if ((*it)->has_timeline())
 397                                         create_timelines(root, dependencies.format_desc, new_layer, (*it), adjustment_x, adjustment_y);
 398
 399                                 if((*it)->link_group_id() != 0)
 400                                         link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), -adjustment_x, -adjustment_y);
 401
 402                                 text_producers_by_layer_name.push_back(std::make_pair(layer_name, text_producer));
 403                         }
 404                         else
 405                         {
 406                                 std::shared_ptr<core::frame_producer> layer_producer;
 407                                 if((*it)->is_solid())
 408                                 {
 409                                         layer_producer = core::create_const_producer(core::create_color_frame(it->get(), dependencies.frame_factory, (*it)->solid_color().to_uint32()), (*it)->bitmap()->width(), (*it)->bitmap()->height());
 410                                 }
 411                                 else if((*it)->bitmap())
 412                                 {
 413                                         if (boost::algorithm::istarts_with(layer_name, L"[producer]"))
 414                                         {
 415                                                 auto hotswap = std::make_shared<core::hotswap_producer>((*it)->bitmap()->width(), (*it)->bitmap()->height());
 416                                                 hotswap->producer().set(dependencies.producer_registry->create_producer(dependencies, layer_name.substr(10)));
 417                                                 layer_producer = hotswap;
 418                                         }
 419                                         else
 420                                         {
 421                                                 core::pixel_format_desc pfd(core::pixel_format::bgra);
 422                                                 pfd.planes.push_back(core::pixel_format_desc::plane((*it)->bitmap()->width(), (*it)->bitmap()->height(), 4));
 423
 424                                                 auto frame = dependencies.frame_factory->create_frame(it->get(), pfd);
 425                                                 auto destination = frame.image_data().data();
 426                                                 auto source = (*it)->bitmap()->data();
 427                                                 memcpy(destination, source, frame.image_data().size());
 428
 429                                                 layer_producer = core::create_const_producer(core::draw_frame(std::move(frame)), (*it)->bitmap()->width(), (*it)->bitmap()->height());
 430                                         }
 431                                 }
 432
 433                                 if(layer_producer)
 434                                 {
 435                                         auto& new_layer = root->create_layer(spl::make_shared_ptr(layer_producer), (*it)->location().x, (*it)->location().y, (*it)->name());
 436                                         new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
 437                                         new_layer.hidden.set(!(*it)->is_visible());
 438
 439                                         if ((*it)->has_timeline())
 440                                                 create_timelines(root, dependencies.format_desc, new_layer, (*it), 0, 0);
 441
 442                                         if((*it)->link_group_id() != 0)
 443                                                 link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), 0, 0);
 444                                 }
 445                         }
 446                 }
 447         }
 448
 449         link_constructor.calculate();
 450
 451         // Reset all dynamic text fields to empty strings and expose them as a scene parameter.
 452         for (auto& text_layer : text_producers_by_layer_name)
 453                 text_layer.second->text().bind(root->create_variable<std::wstring>(boost::to_lower_copy(text_layer.first), true, L""));
 454
 455         if (doc.has_timeline())
 456                 create_marks(root, dependencies.format_desc, doc.timeline());
 457
 458         auto params2 = params;
 459         params2.erase(params2.begin());
 460
 461         root->call(params2);
 462
 463         return root;
 464 }
 465
 466 void init(core::module_dependencies dependencies)
 467 {
 468         dependencies.cg_registry->register_cg_producer(
 469                         L"scene",
 470                         { L".psd" },
 471                         [](const std::wstring& filename) { return ""; },
 472                         [](const spl::shared_ptr<core::frame_producer>& producer)
 473                         {
 474                                 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
 475                         },
 476                         [](
 477                                         const core::frame_producer_dependencies& dependencies,
 478                                         const std::wstring& filename)
 479                         {
 480                                 return create_psd_scene_producer(dependencies, { filename });
 481                         },
 482                         false);
 483 }
 484
 485 }}