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/monitor/monitor.h>
35 #include <core/help/help_sink.h>
36 #include <core/help/help_repository.h>
38 #include <common/env.h>
39 #include <common/log.h>
40 #include <common/array.h>
41 #include <common/base64.h>
42 #include <common/os/filesystem.h>
44 #include <boost/filesystem.hpp>
45 #include <boost/property_tree/ptree.hpp>
46 #include <boost/algorithm/string.hpp>
51 namespace caspar { namespace image {
53 std::pair<core::draw_frame, core::constraints> load_image(
54 const spl::shared_ptr<core::frame_factory>& frame_factory,
55 const std::wstring& filename)
57 auto bitmap = load_image(filename);
58 FreeImage_FlipVertical(bitmap.get());
60 core::pixel_format_desc desc = core::pixel_format::bgra;
61 auto width = FreeImage_GetWidth(bitmap.get());
62 auto height = FreeImage_GetHeight(bitmap.get());
63 desc.planes.push_back(core::pixel_format_desc::plane(width, height, 4));
64 auto frame = frame_factory->create_frame(bitmap.get(), desc);
67 FreeImage_GetBits(bitmap.get()),
68 frame.image_data(0).size(),
69 frame.image_data(0).begin());
71 return std::make_pair(
72 core::draw_frame(std::move(frame)),
73 core::constraints(width, height));
76 struct image_producer : public core::frame_producer_base
78 core::monitor::subject monitor_subject_;
79 const std::wstring description_;
80 const spl::shared_ptr<core::frame_factory> frame_factory_;
81 core::draw_frame frame_ = core::draw_frame::empty();
82 core::constraints constraints_;
84 image_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const std::wstring& description)
85 : description_(description)
86 , frame_factory_(frame_factory)
88 load(load_image(description_));
90 CASPAR_LOG(info) << print() << L" Initialized";
93 image_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const void* png_data, size_t size)
94 : description_(L"png from memory")
95 , frame_factory_(frame_factory)
97 load(load_png_from_memory(png_data, size));
99 CASPAR_LOG(info) << print() << L" Initialized";
102 void load(const std::shared_ptr<FIBITMAP>& bitmap)
104 FreeImage_FlipVertical(bitmap.get());
105 core::pixel_format_desc desc;
106 desc.format = core::pixel_format::bgra;
107 desc.planes.push_back(core::pixel_format_desc::plane(FreeImage_GetWidth(bitmap.get()), FreeImage_GetHeight(bitmap.get()), 4));
108 auto frame = frame_factory_->create_frame(this, desc);
110 std::copy_n(FreeImage_GetBits(bitmap.get()), frame.image_data().size(), frame.image_data().begin());
111 frame_ = core::draw_frame(std::move(frame));
112 constraints_.width.set(FreeImage_GetWidth(bitmap.get()));
113 constraints_.height.set(FreeImage_GetHeight(bitmap.get()));
118 core::draw_frame receive_impl() override
120 monitor_subject_ << core::monitor::message("/file/path") % description_;
125 core::draw_frame create_thumbnail_frame() override
130 core::constraints& pixel_constraints() override
135 std::wstring print() const override
137 return L"image_producer[" + description_ + L"]";
140 std::wstring name() const override
145 boost::property_tree::wptree info() const override
147 boost::property_tree::wptree info;
148 info.add(L"type", L"image");
149 info.add(L"location", description_);
153 core::monitor::subject& monitor_output()
155 return monitor_subject_;
163 ieq(const std::wstring& test)
168 bool operator()(const std::wstring& elem) const
170 return boost::iequals(elem, test_);
174 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
176 sink.short_description(L"Loads a still image.");
177 sink.syntax(L"{[image_file:string]},{[PNG_BASE64] [encoded:string]}");
178 sink.para()->text(L"Loads a still image, either from disk or via a base64 encoded image submitted via AMCP.");
179 sink.para()->text(L"Examples:");
180 sink.example(L">> PLAY 1-10 image_file", L"Plays an image from the media folder.");
181 sink.example(L">> PLAY 1-10 [PNG_BASE64] data...", L"Plays a PNG image transferred as a base64 encoded string.");
184 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
186 static const auto extensions = {
201 if (boost::iequals(params.at(0), L"[IMG_SEQUENCE]"))
203 if (params.size() != 2)
204 return core::frame_producer::empty();
206 auto dir = boost::filesystem::path(env::media_folder() + params.at(1)).parent_path();
207 auto basename = boost::filesystem::basename(params.at(1));
208 std::set<std::wstring> files;
209 boost::filesystem::directory_iterator end;
211 for (boost::filesystem::directory_iterator it(dir); it != end; ++it)
213 auto name = it->path().filename().wstring();
215 if (!boost::algorithm::istarts_with(name, basename))
218 auto extension = it->path().extension().wstring();
220 if (std::find_if(extensions.begin(), extensions.end(), ieq(extension)) == extensions.end())
223 files.insert(it->path().wstring());
227 return core::frame_producer::empty();
231 std::vector<core::draw_frame> frames;
232 frames.reserve(files.size());
234 for (auto& file : files)
236 auto frame = load_image(dependencies.frame_factory, file);
240 width = static_cast<int>(frame.second.width.get());
241 height = static_cast<int>(frame.second.height.get());
244 frames.push_back(std::move(frame.first));
247 return core::create_const_producer(std::move(frames), width, height);
249 else if(boost::iequals(params.at(0), L"[PNG_BASE64]"))
251 if (params.size() < 2)
252 return core::frame_producer::empty();
254 auto png_data = from_base64(std::string(params.at(1).begin(), params.at(1).end()));
256 return spl::make_shared<image_producer>(dependencies.frame_factory, png_data.data(), png_data.size());
259 std::wstring filename = env::media_folder() + params.at(0);
261 auto ext = std::find_if(extensions.begin(), extensions.end(), [&](const std::wstring& ex) -> bool
263 auto file = caspar::find_case_insensitive(boost::filesystem::path(filename).replace_extension(ex).wstring());
265 return static_cast<bool>(file);
268 if(ext == extensions.end())
269 return core::frame_producer::empty();
271 return spl::make_shared<image_producer>(dependencies.frame_factory, *caspar::find_case_insensitive(filename + *ext));
275 spl::shared_ptr<core::frame_producer> create_thumbnail_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
277 return caspar::image::create_producer(dependencies, params);