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
22 #include "image_producer.h"
24 #include "../util/image_loader.h"
26 #include <core/video_format.h>
28 #include <core/producer/frame_producer.h>
29 #include <core/producer/scene/const_producer.h>
30 #include <core/frame/frame.h>
31 #include <core/frame/draw_frame.h>
32 #include <core/frame/frame_factory.h>
33 #include <core/frame/pixel_format.h>
34 #include <core/frame/audio_channel_layout.h>
35 #include <core/monitor/monitor.h>
36 #include <core/help/help_sink.h>
37 #include <core/help/help_repository.h>
39 #include <common/env.h>
40 #include <common/log.h>
41 #include <common/array.h>
42 #include <common/base64.h>
43 #include <common/os/filesystem.h>
45 #include <boost/filesystem.hpp>
46 #include <boost/property_tree/ptree.hpp>
47 #include <boost/algorithm/string.hpp>
52 namespace caspar { namespace image {
54 std::pair<core::draw_frame, core::constraints> load_image(
55 const spl::shared_ptr<core::frame_factory>& frame_factory,
56 const std::wstring& filename)
58 auto bitmap = load_image(filename);
59 FreeImage_FlipVertical(bitmap.get());
61 core::pixel_format_desc desc = core::pixel_format::bgra;
62 auto width = FreeImage_GetWidth(bitmap.get());
63 auto height = FreeImage_GetHeight(bitmap.get());
64 desc.planes.push_back(core::pixel_format_desc::plane(width, height, 4));
65 auto frame = frame_factory->create_frame(bitmap.get(), desc, core::audio_channel_layout::invalid());
68 FreeImage_GetBits(bitmap.get()),
69 frame.image_data(0).size(),
70 frame.image_data(0).begin());
72 return std::make_pair(
73 core::draw_frame(std::move(frame)),
74 core::constraints(width, height));
77 struct image_producer : public core::frame_producer_base
79 core::monitor::subject monitor_subject_;
80 const std::wstring description_;
81 const spl::shared_ptr<core::frame_factory> frame_factory_;
82 core::draw_frame frame_ = core::draw_frame::empty();
83 core::constraints constraints_;
85 image_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const std::wstring& description, bool thumbnail_mode)
86 : description_(description)
87 , frame_factory_(frame_factory)
89 load(load_image(description_));
92 CASPAR_LOG(debug) << print() << L" Initialized";
94 CASPAR_LOG(info) << print() << L" Initialized";
97 image_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const void* png_data, size_t size)
98 : description_(L"png from memory")
99 , frame_factory_(frame_factory)
101 load(load_png_from_memory(png_data, size));
103 CASPAR_LOG(info) << print() << L" Initialized";
106 void load(const std::shared_ptr<FIBITMAP>& bitmap)
108 FreeImage_FlipVertical(bitmap.get());
109 core::pixel_format_desc desc;
110 desc.format = core::pixel_format::bgra;
111 desc.planes.push_back(core::pixel_format_desc::plane(FreeImage_GetWidth(bitmap.get()), FreeImage_GetHeight(bitmap.get()), 4));
112 auto frame = frame_factory_->create_frame(this, desc, core::audio_channel_layout::invalid());
114 std::copy_n(FreeImage_GetBits(bitmap.get()), frame.image_data().size(), frame.image_data().begin());
115 frame_ = core::draw_frame(std::move(frame));
116 constraints_.width.set(FreeImage_GetWidth(bitmap.get()));
117 constraints_.height.set(FreeImage_GetHeight(bitmap.get()));
122 core::draw_frame receive_impl() override
124 monitor_subject_ << core::monitor::message("/file/path") % description_;
129 core::draw_frame create_thumbnail_frame() override
134 core::constraints& pixel_constraints() override
139 std::wstring print() const override
141 return L"image_producer[" + description_ + L"]";
144 std::wstring name() const override
149 boost::property_tree::wptree info() const override
151 boost::property_tree::wptree info;
152 info.add(L"type", L"image");
153 info.add(L"location", description_);
157 core::monitor::subject& monitor_output()
159 return monitor_subject_;
167 ieq(const std::wstring& test)
172 bool operator()(const std::wstring& elem) const
174 return boost::iequals(elem, test_);
178 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
180 sink.short_description(L"Loads a still image.");
181 sink.syntax(L"{[image_file:string]},{[PNG_BASE64] [encoded:string]}");
182 sink.para()->text(L"Loads a still image, either from disk or via a base64 encoded image submitted via AMCP.");
183 sink.para()->text(L"Examples:");
184 sink.example(L">> PLAY 1-10 image_file", L"Plays an image from the media folder.");
185 sink.example(L">> PLAY 1-10 [PNG_BASE64] data...", L"Plays a PNG image transferred as a base64 encoded string.");
188 static const auto g_extensions = {
203 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
206 if (boost::iequals(params.at(0), L"[IMG_SEQUENCE]"))
208 if (params.size() != 2)
209 return core::frame_producer::empty();
211 auto dir = boost::filesystem::path(env::media_folder() + params.at(1)).parent_path();
212 auto basename = boost::filesystem::basename(params.at(1));
213 std::set<std::wstring> files;
214 boost::filesystem::directory_iterator end;
216 for (boost::filesystem::directory_iterator it(dir); it != end; ++it)
218 auto name = it->path().filename().wstring();
220 if (!boost::algorithm::istarts_with(name, basename))
223 auto extension = it->path().extension().wstring();
225 if (std::find_if(g_extensions.begin(), g_extensions.end(), ieq(extension)) == g_extensions.end())
228 files.insert(it->path().wstring());
232 return core::frame_producer::empty();
236 std::vector<core::draw_frame> frames;
237 frames.reserve(files.size());
239 for (auto& file : files)
241 auto frame = load_image(dependencies.frame_factory, file);
245 width = static_cast<int>(frame.second.width.get());
246 height = static_cast<int>(frame.second.height.get());
249 frames.push_back(std::move(frame.first));
252 return core::create_const_producer(std::move(frames), width, height);
254 else if(boost::iequals(params.at(0), L"[PNG_BASE64]"))
256 if (params.size() < 2)
257 return core::frame_producer::empty();
259 auto png_data = from_base64(std::string(params.at(1).begin(), params.at(1).end()));
261 return spl::make_shared<image_producer>(dependencies.frame_factory, png_data.data(), png_data.size());
264 std::wstring filename = env::media_folder() + params.at(0);
266 auto ext = std::find_if(g_extensions.begin(), g_extensions.end(), [&](const std::wstring& ex) -> bool
268 auto file = caspar::find_case_insensitive(boost::filesystem::path(filename).replace_extension(ex).wstring());
270 return static_cast<bool>(file);
273 if(ext == g_extensions.end())
274 return core::frame_producer::empty();
276 return spl::make_shared<image_producer>(dependencies.frame_factory, *caspar::find_case_insensitive(filename + *ext), false);
280 spl::shared_ptr<core::frame_producer> create_thumbnail_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
282 std::wstring filename = env::media_folder() + params.at(0);
284 auto ext = std::find_if(g_extensions.begin(), g_extensions.end(), [&](const std::wstring& ex) -> bool
286 auto file = caspar::find_case_insensitive(boost::filesystem::path(filename).replace_extension(ex).wstring());
288 return static_cast<bool>(file);
291 if (ext == g_extensions.end())
292 return core::frame_producer::empty();
294 return spl::make_shared<image_producer>(dependencies.frame_factory, *caspar::find_case_insensitive(filename + *ext), true);