2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
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.
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.
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/>.
19 * Author: Robert Nagy, ronag89@gmail.com
20 * Author: Helge Norberg, helge.norberg@svt.se
23 #include "image_scroll_producer.h"
25 #include "../util/image_loader.h"
26 #include "../util/image_view.h"
27 #include "../util/image_algorithms.h"
29 #include <core/video_format.h>
31 #include <core/frame/frame.h>
32 #include <core/frame/draw_frame.h>
33 #include <core/frame/frame_factory.h>
34 #include <core/frame/frame_transform.h>
35 #include <core/frame/pixel_format.h>
36 #include <core/monitor/monitor.h>
38 #include <common/env.h>
39 #include <common/log.h>
40 #include <common/except.h>
41 #include <common/array.h>
42 #include <common/tweener.h>
43 #include <common/param.h>
45 #include <boost/assign.hpp>
46 #include <boost/filesystem.hpp>
47 #include <boost/foreach.hpp>
48 #include <boost/lexical_cast.hpp>
49 #include <boost/property_tree/ptree.hpp>
50 #include <boost/scoped_array.hpp>
55 using namespace boost::assign;
57 namespace caspar { namespace image {
59 struct image_scroll_producer : public core::frame_producer_base
61 monitor::subject monitor_subject_;
63 const std::wstring filename_;
64 std::vector<core::draw_frame> frames_;
65 core::video_format_desc format_desc_;
68 core::constraints constraints_;
77 explicit image_scroll_producer(
78 const spl::shared_ptr<core::frame_factory>& frame_factory,
79 const core::video_format_desc& format_desc,
80 const std::wstring& filename,
83 int motion_blur_px = 0,
84 bool premultiply_with_alpha = false,
85 bool progressive = false)
88 , format_desc_(format_desc)
92 , progressive_(progressive)
94 auto bitmap = load_image(filename_);
95 FreeImage_FlipVertical(bitmap.get());
97 width_ = FreeImage_GetWidth(bitmap.get());
98 height_ = FreeImage_GetHeight(bitmap.get());
99 constraints_.width.set(width_);
100 constraints_.height.set(height_);
102 bool vertical = width_ == format_desc_.width;
103 bool horizontal = height_ == format_desc_.height;
105 if (!vertical && !horizontal)
106 BOOST_THROW_EXCEPTION(
107 caspar::invalid_argument() << msg_info("Neither width nor height matched the video resolution"));
113 double total_num_pixels = format_desc_.height * 2 + height_;
115 speed_ = total_num_pixels / (duration * format_desc_.fps * static_cast<double>(format_desc_.field_count));
117 if (std::abs(speed_) > 1.0)
118 speed_ = std::ceil(speed_);
123 start_offset_y_ = height_ + format_desc_.height;
130 double total_num_pixels = format_desc_.width * 2 + width_;
132 speed_ = total_num_pixels / (duration * format_desc_.fps * static_cast<double>(format_desc_.field_count));
134 if (std::abs(speed_) > 1.0)
135 speed_ = std::ceil(speed_);
139 start_offset_x_ = format_desc_.width - (width_ % format_desc_.width);
141 start_offset_x_ = format_desc_.width - (width_ % format_desc_.width) + width_ + format_desc_.width;
144 auto bytes = FreeImage_GetBits(bitmap.get());
145 auto count = width_*height_*4;
146 image_view<bgra_pixel> original_view(bytes, width_, height_);
148 if (premultiply_with_alpha)
149 premultiply(original_view);
151 boost::scoped_array<uint8_t> blurred_copy;
153 if (motion_blur_px > 0)
155 double angle = 3.14159265 / 2; // Up
157 if (horizontal && speed_ < 0)
159 else if (vertical && speed > 0)
161 else if (horizontal && speed > 0)
162 angle = 0.0; // Right
164 blurred_copy.reset(new uint8_t[count]);
165 image_view<bgra_pixel> blurred_view(blurred_copy.get(), width_, height_);
166 core::tweener blur_tweener(L"easeInQuad");
167 blur(original_view, blurred_view, angle, motion_blur_px, blur_tweener);
168 bytes = blurred_copy.get();
178 core::pixel_format_desc desc = core::pixel_format::bgra;
179 desc.planes.push_back(core::pixel_format_desc::plane(width_, format_desc_.height, 4));
180 auto frame = frame_factory->create_frame(reinterpret_cast<void*>(rand()), desc);
182 if(count >= frame.image_data(0).size())
184 std::copy_n(bytes + count - frame.image_data(0).size(), frame.image_data(0).size(), frame.image_data(0).begin());
185 count -= static_cast<int>(frame.image_data(0).size());
189 memset(frame.image_data(0).begin(), 0, frame.image_data(0).size());
190 std::copy_n(bytes, count, frame.image_data(0).begin() + format_desc_.size - count);
194 core::draw_frame draw_frame(std::move(frame));
196 // Set the relative position to the other image fragments
197 draw_frame.transform().image_transform.fill_translation[1] = - n++;
199 frames_.push_back(draw_frame);
207 core::pixel_format_desc desc = core::pixel_format::bgra;
208 desc.planes.push_back(core::pixel_format_desc::plane(format_desc_.width, height_, 4));
209 auto frame = frame_factory->create_frame(reinterpret_cast<void*>(rand()), desc);
210 if(count >= frame.image_data(0).size())
212 for(int y = 0; y < height_; ++y)
213 std::copy_n(bytes + i * format_desc_.width*4 + y * width_*4, format_desc_.width*4, frame.image_data(0).begin() + y * format_desc_.width*4);
216 count -= static_cast<int>(frame.image_data(0).size());
220 memset(frame.image_data(0).begin(), 0, frame.image_data(0).size());
221 auto width2 = width_ % format_desc_.width;
222 for(int y = 0; y < height_; ++y)
223 std::copy_n(bytes + i * format_desc_.width*4 + y * width_*4, width2*4, frame.image_data(0).begin() + y * format_desc_.width*4);
228 frames_.push_back(core::draw_frame(std::move(frame)));
231 std::reverse(frames_.begin(), frames_.end());
233 // Set the relative positions of the image fragments.
234 for (size_t n = 0; n < frames_.size(); ++n)
236 double translation = - (static_cast<double>(n) + 1.0);
237 frames_[n].transform().image_transform.fill_translation[0] = translation;
241 CASPAR_LOG(info) << print() << L" Initialized";
244 std::vector<core::draw_frame> get_visible()
246 std::vector<core::draw_frame> result;
247 result.reserve(frames_.size());
249 BOOST_FOREACH(auto& frame, frames_)
251 auto& fill_translation = frame.transform().image_transform.fill_translation;
253 if (width_ == format_desc_.width)
255 auto motion_offset_in_screens = (static_cast<double>(start_offset_y_) + delta_) / static_cast<double>(format_desc_.height);
256 auto vertical_offset = fill_translation[1] + motion_offset_in_screens;
258 if (vertical_offset < -1.0 || vertical_offset > 1.0)
265 auto motion_offset_in_screens = (static_cast<double>(start_offset_x_) + delta_) / static_cast<double>(format_desc_.width);
266 auto horizontal_offset = fill_translation[0] + motion_offset_in_screens;
268 if (horizontal_offset < -1.0 || horizontal_offset > 1.0)
274 result.push_back(frame);
277 return std::move(result);
281 core::draw_frame render_frame(bool allow_eof)
284 return core::draw_frame::empty();
286 core::draw_frame result(get_visible());
287 auto& fill_translation = result.transform().image_transform.fill_translation;
289 if (width_ == format_desc_.width)
291 if (static_cast<size_t>(std::abs(delta_)) >= height_ + format_desc_.height && allow_eof)
292 return core::draw_frame::empty();
294 fill_translation[1] =
295 static_cast<double>(start_offset_y_) / static_cast<double>(format_desc_.height)
296 + delta_ / static_cast<double>(format_desc_.height);
300 if (static_cast<size_t>(std::abs(delta_)) >= width_ + format_desc_.width && allow_eof)
301 return core::draw_frame::empty();
303 fill_translation[0] =
304 static_cast<double>(start_offset_x_) / static_cast<double>(format_desc_.width)
305 + (delta_) / static_cast<double>(format_desc_.width);
311 core::draw_frame render_frame(bool allow_eof, bool advance_delta)
313 auto result = render_frame(allow_eof);
328 core::draw_frame receive_impl() override
330 core::draw_frame result;
332 if (format_desc_.field_mode == core::field_mode::progressive || progressive_)
334 result = render_frame(true, true);
338 auto field1 = render_frame(true, true);
339 auto field2 = render_frame(true, false);
341 if (field1 != core::draw_frame::empty() && field2 == core::draw_frame::empty())
343 field2 = render_frame(false, true);
350 result = core::draw_frame::interlace(field1, field2, format_desc_.field_mode);
353 monitor_subject_ << monitor::message("/file/path") % filename_
354 << monitor::message("/delta") % delta_
355 << monitor::message("/speed") % speed_;
360 core::constraints& pixel_constraints() override
365 std::wstring print() const override
367 return L"image_scroll_producer[" + filename_ + L"]";
370 std::wstring name() const override
372 return L"image-scroll";
375 boost::property_tree::wptree info() const override
377 boost::property_tree::wptree info;
378 info.add(L"type", L"image-scroll");
379 info.add(L"filename", filename_);
383 uint32_t nb_frames() const override
385 if(width_ == format_desc_.width)
387 auto length = (height_ + format_desc_.height * 2);
388 return static_cast<uint32_t>(length / std::abs(speed_));// + length % std::abs(delta_));
392 auto length = (width_ + format_desc_.width * 2);
393 return static_cast<uint32_t>(length / std::abs(speed_));// + length % std::abs(delta_));
397 monitor::source& monitor_output()
399 return monitor_subject_;
403 spl::shared_ptr<core::frame_producer> create_scroll_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const core::video_format_desc& format_desc, const std::vector<std::wstring>& params)
405 static const std::vector<std::wstring> extensions = list_of(L".png")(L".tga")(L".bmp")(L".jpg")(L".jpeg")(L".gif")(L".tiff")(L".tif")(L".jp2")(L".jpx")(L".j2k")(L".j2c");
406 std::wstring filename = env::media_folder() + L"\\" + params[0];
408 auto ext = std::find_if(extensions.begin(), extensions.end(), [&](const std::wstring& ex) -> bool
410 return boost::filesystem::is_regular_file(boost::filesystem::path(filename).replace_extension(ex));
413 if(ext == extensions.end())
414 return core::frame_producer::empty();
416 double duration = 0.0;
417 double speed = get_param(L"SPEED", params, 0.0);
420 duration = get_param(L"DURATION", params, 0.0);
422 if(speed == 0 && duration == 0)
423 return core::frame_producer::empty();
425 int motion_blur_px = get_param(L"BLUR", params, 0);
427 bool premultiply_with_alpha = contains_param(L"PREMULTIPLY", params);
428 bool progressive = contains_param(L"PROGRESSIVE", params);
430 return core::create_destroy_proxy(spl::make_shared<image_scroll_producer>(
437 premultiply_with_alpha,