git.sesse.net Git - casparcg/blob - core/producer/scene/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 <common/future.h>
  25 #include <common/prec_timer.h>
  26
  27 #include <boost/algorithm/string/split.hpp>
  28 #include <boost/algorithm/string.hpp>
  29
  30 #include "scene_producer.h"
  31
  32 #include "../../frame/draw_frame.h"
  33 #include "../../interaction/interaction_aggregator.h"
  34 #include "../text/text_producer.h"
  35
  36 namespace caspar { namespace core { namespace scene {
  37
  38 layer::layer(const std::wstring& name, const spl::shared_ptr<frame_producer>& producer)
  39         : name(name), producer(producer)
  40 {
  41         crop.lower_right.x.bind(producer.get()->pixel_constraints().width);
  42         crop.lower_right.y.bind(producer.get()->pixel_constraints().height);
  43         perspective.upper_right.x.bind(producer.get()->pixel_constraints().width);
  44         perspective.lower_right.x.bind(producer.get()->pixel_constraints().width);
  45         perspective.lower_right.y.bind(producer.get()->pixel_constraints().height);
  46         perspective.lower_left.y.bind(producer.get()->pixel_constraints().height);
  47 }
  48
  49 adjustments::adjustments()
  50         : opacity(1.0)
  51 {
  52 }
  53
  54 struct timeline
  55 {
  56         std::map<int64_t, keyframe> keyframes;
  57
  58         void on_frame(int64_t frame)
  59         {
  60                 auto before = --keyframes.upper_bound(frame);
  61                 bool found_before = before != keyframes.end() && before->first < frame;
  62                 auto after = keyframes.upper_bound(frame);
  63                 bool found_after = after != keyframes.end() && after->first > frame;
  64                 auto exact_frame = keyframes.find(frame);
  65                 bool found_exact_frame = exact_frame != keyframes.end();
  66
  67                 if (found_exact_frame)
  68                 {
  69                         exact_frame->second.on_destination_frame();
  70
  71                         auto next_frame = ++exact_frame;
  72
  73                         if (next_frame != keyframes.end() && next_frame->second.on_start_animate)
  74                                 next_frame->second.on_start_animate();
  75                 }
  76                 else if (found_after)
  77                 {
  78                         int64_t start_frame = 0;
  79
  80                         if (found_before)
  81                         {
  82                                 start_frame = before->first;
  83                         }
  84
  85                         if (after->second.on_start_animate && frame == 0)
  86                                 after->second.on_start_animate();
  87                         else if (after->second.on_animate_to)
  88                                 after->second.on_animate_to(start_frame, frame);
  89                 }
  90         }
  91 };
  92
  93 mark_action get_mark_action(const std::wstring& name)
  94 {
  95         if (name == L"start")
  96                 return mark_action::start;
  97         else if (name == L"stop")
  98                 return mark_action::stop;
  99         else if (name == L"jump_to")
 100                 return mark_action::jump_to;
 101         else if (name == L"remove")
 102                 return mark_action::remove;
 103         else
 104                 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid mark_action " + name));
 105 }
 106
 107 struct marker
 108 {
 109         mark_action             action;
 110         std::wstring    label_argument;
 111
 112         marker(mark_action action, const std::wstring& label_argument)
 113                 : action(action)
 114                 , label_argument(label_argument)
 115         {
 116         }
 117 };
 118
 119 struct scene_producer::impl
 120 {
 121         std::wstring                                                                                    producer_name_;
 122         constraints                                                                                             pixel_constraints_;
 123         video_format_desc                                                                               format_desc_;
 124         std::list<layer>                                                                                layers_;
 125         interaction_aggregator                                                                  aggregator_;
 126         binding<int64_t>                                                                                frame_number_;
 127         binding<double>                                                                                 speed_;
 128         double                                                                                                  frame_fraction_         = 0.0;
 129         std::map<void*, timeline>                                                               timelines_;
 130         std::map<std::wstring, std::shared_ptr<core::variable>> variables_;
 131         std::vector<std::wstring>                                                               variable_names_;
 132         std::multimap<int64_t, marker>                                                  markers_by_frame_;
 133         monitor::subject                                                                                monitor_subject_;
 134         bool                                                                                                    paused_                         = true;
 135         bool                                                                                                    removed_                        = false;
 136         bool                                                                                                    going_to_mark_          = false;
 137
 138         impl(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
 139                 : producer_name_(std::move(producer_name))
 140                 , pixel_constraints_(width, height)
 141                 , format_desc_(format_desc)
 142                 , aggregator_([=] (double x, double y) { return collission_detect(x, y); })
 143         {
 144                 auto speed_variable = std::make_shared<core::variable_impl<double>>(L"1.0", true, 1.0);
 145                 store_variable(L"scene_speed", speed_variable);
 146                 speed_ = speed_variable->value();
 147                 auto frame_variable = std::make_shared<core::variable_impl<int64_t>>(L"-1", true, -1);
 148                 store_variable(L"frame", frame_variable);
 149                 frame_number_ = frame_variable->value();
 150         }
 151
 152         layer& create_layer(
 153                         const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
 154         {
 155                 layer layer(name, producer);
 156
 157                 layer.position.x.set(x);
 158                 layer.position.y.set(y);
 159
 160                 layers_.push_back(layer);
 161
 162                 return layers_.back();
 163         }
 164
 165         void reverse_layers() {
 166                 layers_.reverse();
 167         }
 168
 169         void store_keyframe(void* timeline_identity, const keyframe& k)
 170         {
 171                 timelines_[timeline_identity].keyframes.insert(std::make_pair(k.destination_frame, k));
 172         }
 173
 174         void store_variable(
 175                         const std::wstring& name, const std::shared_ptr<core::variable>& var)
 176         {
 177                 variables_.insert(std::make_pair(name, var));
 178                 variable_names_.push_back(name);
 179         }
 180
 181         void add_mark(int64_t frame, mark_action action, const std::wstring& label)
 182         {
 183                 markers_by_frame_.insert(std::make_pair(frame, marker(action, label)));
 184         }
 185
 186         core::variable& get_variable(const std::wstring& name)
 187         {
 188                 auto found = variables_.find(name);
 189
 190                 if (found == variables_.end())
 191                         CASPAR_THROW_EXCEPTION(user_error() << msg_info(name + L" not found in scene"));
 192
 193                 return *found->second;
 194         }
 195
 196         const std::vector<std::wstring>& get_variables() const
 197         {
 198                 return variable_names_;
 199         }
 200
 201         binding<int64_t> frame()
 202         {
 203                 return frame_number_;
 204         }
 205
 206         frame_transform get_transform(const layer& layer) const
 207         {
 208                 frame_transform transform;
 209
 210                 auto& anchor            = transform.image_transform.anchor;
 211                 auto& pos                       = transform.image_transform.fill_translation;
 212                 auto& scale                     = transform.image_transform.fill_scale;
 213                 auto& angle                     = transform.image_transform.angle;
 214                 auto& crop                      = transform.image_transform.crop;
 215                 auto& pers                      = transform.image_transform.perspective;
 216
 217                 anchor[0]       = layer.anchor.x.get()                                                                          / layer.producer.get()->pixel_constraints().width.get();
 218                 anchor[1]       = layer.anchor.y.get()                                                                          / layer.producer.get()->pixel_constraints().height.get();
 219                 pos[0]          = layer.position.x.get()                                                                        / pixel_constraints_.width.get();
 220                 pos[1]          = layer.position.y.get()                                                                        / pixel_constraints_.height.get();
 221                 scale[0]        = layer.producer.get()->pixel_constraints().width.get()         / pixel_constraints_.width.get();
 222                 scale[1]        = layer.producer.get()->pixel_constraints().height.get()        / pixel_constraints_.height.get();
 223                 crop.ul[0]      = layer.crop.upper_left.x.get()                                                         / layer.producer.get()->pixel_constraints().width.get();
 224                 crop.ul[1]      = layer.crop.upper_left.y.get()                                                         / layer.producer.get()->pixel_constraints().height.get();
 225                 crop.lr[0]      = layer.crop.lower_right.x.get()                                                        / layer.producer.get()->pixel_constraints().width.get();
 226                 crop.lr[1]      = layer.crop.lower_right.y.get()                                                        / layer.producer.get()->pixel_constraints().height.get();
 227                 pers.ul[0]      = layer.perspective.upper_left.x.get()                                          / layer.producer.get()->pixel_constraints().width.get();
 228                 pers.ul[1]      = layer.perspective.upper_left.y.get()                                          / layer.producer.get()->pixel_constraints().height.get();
 229                 pers.ur[0]      = layer.perspective.upper_right.x.get()                                         / layer.producer.get()->pixel_constraints().width.get();
 230                 pers.ur[1]      = layer.perspective.upper_right.y.get()                                         / layer.producer.get()->pixel_constraints().height.get();
 231                 pers.lr[0]      = layer.perspective.lower_right.x.get()                                         / layer.producer.get()->pixel_constraints().width.get();
 232                 pers.lr[1]      = layer.perspective.lower_right.y.get()                                         / layer.producer.get()->pixel_constraints().height.get();
 233                 pers.ll[0]      = layer.perspective.lower_left.x.get()                                          / layer.producer.get()->pixel_constraints().width.get();
 234                 pers.ll[1]      = layer.perspective.lower_left.y.get()                                          / layer.producer.get()->pixel_constraints().height.get();
 235
 236                 static const double PI = 3.141592653589793;
 237
 238                 angle           = layer.rotation.get() * PI / 180.0;
 239
 240                 transform.image_transform.opacity                       = layer.adjustments.opacity.get();
 241                 transform.image_transform.is_key                        = layer.is_key.get();
 242                 transform.image_transform.use_mipmap            = layer.use_mipmap.get();
 243                 transform.image_transform.blend_mode            = layer.blend_mode.get();
 244                 transform.image_transform.chroma.key            = layer.chroma_key.key.get();
 245                 transform.image_transform.chroma.threshold      = layer.chroma_key.threshold.get();
 246                 transform.image_transform.chroma.softness       = layer.chroma_key.softness.get();
 247                 transform.image_transform.chroma.spill          = layer.chroma_key.spill.get();
 248
 249                 // Mark as sublayer, so it will be composited separately by the mixer.
 250                 transform.image_transform.layer_depth = 1;
 251
 252                 return transform;
 253         }
 254
 255         boost::optional<std::pair<int64_t, marker>> find_first_stop_or_jump_or_remove(int64_t start_frame, int64_t end_frame)
 256         {
 257                 auto lower = markers_by_frame_.lower_bound(start_frame);
 258                 auto upper = markers_by_frame_.upper_bound(end_frame);
 259
 260                 if (lower == markers_by_frame_.end())
 261                         return boost::none;
 262
 263                 for (auto iter = lower; iter != upper; ++iter)
 264                 {
 265                         auto action = iter->second.action;
 266
 267                         if (action == mark_action::stop || action == mark_action::jump_to || action == mark_action::remove)
 268                                 return std::make_pair(iter->first, iter->second);
 269                 }
 270
 271                 return boost::none;
 272         }
 273
 274         boost::optional<std::pair<int64_t, marker>> find_first_start(int64_t start_frame)
 275         {
 276                 auto lower = markers_by_frame_.lower_bound(start_frame);
 277
 278                 if (lower == markers_by_frame_.end())
 279                         return boost::none;
 280
 281                 for (auto iter = lower; iter != markers_by_frame_.end(); ++iter)
 282                 {
 283                         auto action = iter->second.action;
 284
 285                         if (action == mark_action::start)
 286                                 return std::make_pair(iter->first, iter->second);
 287                 }
 288
 289                 return boost::none;
 290         }
 291
 292         draw_frame render_frame()
 293         {
 294                 if (format_desc_.field_count == 1)
 295                         return render_progressive_frame();
 296                 else
 297                 {
 298                         prec_timer timer;
 299                         timer.tick_millis(0);
 300
 301                         auto field1 = render_progressive_frame();
 302
 303                         timer.tick(0.5 / format_desc_.fps);
 304
 305                         auto field2 = render_progressive_frame();
 306
 307                         return draw_frame::interlace(field1, field2, format_desc_.field_mode);
 308                 }
 309         }
 310
 311         void advance()
 312         {
 313                 frame_fraction_ += speed_.get();
 314
 315                 if (std::abs(frame_fraction_) >= 1.0)
 316                 {
 317                         int64_t delta = static_cast<int64_t>(frame_fraction_);
 318                         auto previous_frame = frame_number_.get();
 319                         auto next_frame = frame_number_.get() + delta;
 320                         auto marker = find_first_stop_or_jump_or_remove(previous_frame + 1, next_frame);
 321
 322                         if (marker && marker->second.action == mark_action::remove)
 323                         {
 324                                 remove();
 325                         }
 326                         if (marker && !going_to_mark_)
 327                         {
 328                                 if (marker->second.action == mark_action::stop)
 329                                 {
 330                                         frame_number_.set(marker->first);
 331                                         frame_fraction_ = 0.0;
 332                                         paused_ = true;
 333                                 }
 334                                 else if (marker->second.action == mark_action::jump_to)
 335                                 {
 336                                         go_to_marker(marker->second.label_argument, 0);
 337                                 }
 338                         }
 339                         else
 340                         {
 341                                 frame_number_.set(next_frame);
 342                                 frame_fraction_ -= delta;
 343                         }
 344
 345                         going_to_mark_ = false;
 346                 }
 347         }
 348
 349         draw_frame render_progressive_frame()
 350         {
 351                 if (removed_)
 352                         return draw_frame::empty();
 353
 354                 if (!paused_)
 355                         advance();
 356
 357                 for (auto& timeline : timelines_)
 358                         timeline.second.on_frame(frame_number_.get());
 359
 360                 std::vector<draw_frame> frames;
 361
 362                 for (auto& layer : layers_)
 363                 {
 364                         if (layer.hidden.get())
 365                                 continue;
 366
 367                         draw_frame frame(layer.producer.get()->receive());
 368                         frame.transform() = get_transform(layer);
 369                         frames.push_back(frame);
 370                 }
 371
 372                 return draw_frame(frames);
 373         }
 374
 375         void on_interaction(const interaction_event::ptr& event)
 376         {
 377                 aggregator_.translate_and_send(event);
 378         }
 379
 380         bool collides(double x, double y) const
 381         {
 382                 return static_cast<bool>((collission_detect(x, y)));
 383         }
 384
 385         boost::optional<interaction_target> collission_detect(double x, double y) const
 386         {
 387                 for (auto& layer : layers_ | boost::adaptors::reversed)
 388                 {
 389                         if (layer.hidden.get())
 390                                 continue;
 391
 392                         auto transform = get_transform(layer);
 393                         auto translated = translate(x, y, transform);
 394
 395                         if (translated.first >= 0.0
 396                                 && translated.first <= 1.0
 397                                 && translated.second >= 0.0
 398                                 && translated.second <= 1.0
 399                                 && layer.producer.get()->collides(translated.first, translated.second))
 400                         {
 401                                 return std::make_pair(transform, static_cast<interaction_sink*>(layer.producer.get().get()));
 402                         }
 403                 }
 404
 405                 return boost::optional<interaction_target>();
 406         }
 407
 408         std::future<std::wstring> call(const std::vector<std::wstring>& params)
 409         {
 410                 if (!params.empty() && boost::ends_with(params.at(0), L"()"))
 411                         return make_ready_future(handle_call(params));
 412                 else
 413                         return make_ready_future(handle_variable_set(params));
 414         }
 415
 416         std::wstring handle_variable_set(const std::vector<std::wstring>& params)
 417         {
 418                 for (int i = 0; i + 1 < params.size(); i += 2)
 419                 {
 420                         auto found = variables_.find(boost::to_lower_copy(params.at(i)));
 421
 422                         if (found != variables_.end() && found->second->is_public())
 423                                 found->second->from_string(params.at(i + 1));
 424                 }
 425
 426                 return L"";
 427         }
 428
 429         std::wstring handle_call(const std::vector<std::wstring>& params)
 430         {
 431                 auto call = params.at(0);
 432
 433                 if (call == L"play()")
 434                         go_to_marker(params.at(1), -1);
 435                 else if (call == L"remove()")
 436                         remove();
 437                 else if (call == L"next()")
 438                         next();
 439                 else
 440                         CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Unknown call " + call));
 441
 442                 return L"";
 443         }
 444
 445         void remove()
 446         {
 447                 removed_ = true;
 448                 layers_.clear();
 449         }
 450
 451         void next()
 452         {
 453                 auto marker = find_first_start(frame_number_.get() + 1);
 454
 455                 if (marker)
 456                 {
 457                         frame_number_.set(marker->first - 1);
 458                         frame_fraction_ = 0.0;
 459                         paused_ = false;
 460                         going_to_mark_ = true;
 461                 }
 462                 else
 463                 {
 464                         remove();
 465                 }
 466         }
 467
 468         void go_to_marker(const std::wstring& marker_name, int64_t offset)
 469         {
 470                 for (auto& marker : markers_by_frame_)
 471                 {
 472                         if (marker.second.label_argument == marker_name && marker.second.action == mark_action::start)
 473                         {
 474                                 frame_number_.set(marker.first + offset);
 475                                 frame_fraction_ = 0.0;
 476                                 paused_ = false;
 477                                 going_to_mark_ = true;
 478
 479                                 return;
 480                         }
 481                 }
 482
 483                 if (marker_name == L"intro")
 484                 {
 485                         frame_number_.set(offset);
 486                         frame_fraction_ = 0.0;
 487                         paused_ = false;
 488                         going_to_mark_ = true;
 489                 }
 490                 else if (marker_name == L"outro")
 491                 {
 492                         remove();
 493                 }
 494                 else
 495                         CASPAR_LOG(info) << print() << L" no marker called " << marker_name << " found";
 496         }
 497
 498         std::wstring print() const
 499         {
 500                 return L"scene[type=" + name() + L"]";
 501         }
 502
 503         std::wstring name() const
 504         {
 505                 return producer_name_;
 506         }
 507
 508         boost::property_tree::wptree info() const
 509         {
 510                 boost::property_tree::wptree info;
 511                 info.add(L"type", L"scene");
 512                 info.add(L"producer-name", name());
 513                 info.add(L"frame-number", frame_number_.get());
 514
 515                 for (auto& var : variables_)
 516                 {
 517                         boost::property_tree::wptree variable_info;
 518
 519                         variable_info.add(L"name", var.first);
 520                         variable_info.add(L"public", var.second->is_public());
 521                         variable_info.add(L"value", var.second->to_string());
 522
 523                         info.add_child(L"variables.variable", variable_info);
 524                 }
 525
 526                 for (auto& layer : layers_)
 527                 {
 528                         boost::property_tree::wptree layer_info;
 529
 530                         layer_info.add(L"name", layer.name.get());
 531                         layer_info.add_child(L"producer", layer.producer.get()->info());
 532                         layer_info.add(L"x", layer.position.x.get());
 533                         layer_info.add(L"y", layer.position.y.get());
 534                         layer_info.add(L"width", layer.producer.get()->pixel_constraints().width.get());
 535                         layer_info.add(L"height", layer.producer.get()->pixel_constraints().height.get());
 536
 537                         info.add_child(L"layers.layer", layer_info);
 538                 }
 539
 540                 return info;
 541         }
 542
 543         monitor::subject& monitor_output()
 544         {
 545                 return monitor_subject_;
 546         }
 547 };
 548
 549 scene_producer::scene_producer(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
 550         : impl_(new impl(std::move(producer_name), width, height, format_desc))
 551 {
 552 }
 553
 554 scene_producer::~scene_producer()
 555 {
 556 }
 557
 558 layer& scene_producer::create_layer(
 559                 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
 560 {
 561         return impl_->create_layer(producer, x, y, name);
 562 }
 563
 564 layer& scene_producer::create_layer(
 565                 const spl::shared_ptr<frame_producer>& producer, const std::wstring& name)
 566 {
 567         return impl_->create_layer(producer, 0, 0, name);
 568 }
 569
 570 void scene_producer::reverse_layers() {
 571         impl_->reverse_layers();
 572 }
 573
 574 binding<int64_t> scene_producer::frame()
 575 {
 576         return impl_->frame();
 577 }
 578
 579 draw_frame scene_producer::receive_impl()
 580 {
 581         return impl_->render_frame();
 582 }
 583
 584 constraints& scene_producer::pixel_constraints() { return impl_->pixel_constraints_; }
 585
 586 void scene_producer::on_interaction(const interaction_event::ptr& event)
 587 {
 588         impl_->on_interaction(event);
 589 }
 590
 591 bool scene_producer::collides(double x, double y) const
 592 {
 593         return impl_->collides(x, y);
 594 }
 595
 596 std::wstring scene_producer::print() const
 597 {
 598         return impl_->print();
 599 }
 600
 601 std::wstring scene_producer::name() const
 602 {
 603         return impl_->name();
 604 }
 605
 606 boost::property_tree::wptree scene_producer::info() const
 607 {
 608         return impl_->info();
 609 }
 610
 611 std::future<std::wstring> scene_producer::call(const std::vector<std::wstring>& params)
 612 {
 613         return impl_->call(params);
 614 }
 615
 616 monitor::subject& scene_producer::monitor_output()
 617 {
 618         return impl_->monitor_output();
 619 }
 620
 621 void scene_producer::store_keyframe(void* timeline_identity, const keyframe& k)
 622 {
 623         impl_->store_keyframe(timeline_identity, k);
 624 }
 625
 626 void scene_producer::store_variable(
 627                 const std::wstring& name, const std::shared_ptr<core::variable>& var)
 628 {
 629         impl_->store_variable(name, var);
 630 }
 631
 632 void scene_producer::add_mark(int64_t frame, mark_action action, const std::wstring& label)
 633 {
 634         impl_->add_mark(frame, action, label);
 635 }
 636
 637 core::variable& scene_producer::get_variable(const std::wstring& name)
 638 {
 639         return impl_->get_variable(name);
 640 }
 641
 642 const std::vector<std::wstring>& scene_producer::get_variables() const
 643 {
 644         return impl_->get_variables();
 645 }
 646
 647 }}}