git.sesse.net Git - casparcg/blob - modules/image/producer/image_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: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #include "image_producer.h"
  23
  24 #include "../util/image_loader.h"
  25
  26 #include <core/video_format.h>
  27
  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>
  38
  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>
  44
  45 #include <boost/filesystem.hpp>
  46 #include <boost/property_tree/ptree.hpp>
  47 #include <boost/algorithm/string.hpp>
  48
  49 #include <algorithm>
  50 #include <set>
  51
  52 namespace caspar { namespace image {
  53
  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)
  57 {
  58         auto bitmap = load_image(filename);
  59         FreeImage_FlipVertical(bitmap.get());
  60
  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());
  66
  67         std::copy_n(
  68                         FreeImage_GetBits(bitmap.get()),
  69                         frame.image_data(0).size(),
  70                         frame.image_data(0).begin());
  71
  72         return std::make_pair(
  73                         core::draw_frame(std::move(frame)),
  74                         core::constraints(width, height));
  75 }
  76
  77 struct image_producer : public core::frame_producer_base
  78 {
  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_;
  84
  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)
  88         {
  89                 load(load_image(description_));
  90
  91                 if (thumbnail_mode)
  92                         CASPAR_LOG(debug) << print() << L" Initialized";
  93                 else
  94                         CASPAR_LOG(info) << print() << L" Initialized";
  95         }
  96
  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)
 100         {
 101                 load(load_png_from_memory(png_data, size));
 102
 103                 CASPAR_LOG(info) << print() << L" Initialized";
 104         }
 105
 106         void load(const std::shared_ptr<FIBITMAP>& bitmap)
 107         {
 108                 FreeImage_FlipVertical(bitmap.get());
 109                 auto longest_side = static_cast<int>(std::max(FreeImage_GetWidth(bitmap.get()), FreeImage_GetHeight(bitmap.get())));
 110
 111                 if (longest_side > frame_factory_->get_max_frame_size())
 112                         CASPAR_THROW_EXCEPTION(user_error() << msg_info("Image too large for texture"));
 113
 114                 core::pixel_format_desc desc;
 115                 desc.format = core::pixel_format::bgra;
 116                 desc.planes.push_back(core::pixel_format_desc::plane(FreeImage_GetWidth(bitmap.get()), FreeImage_GetHeight(bitmap.get()), 4));
 117                 auto frame = frame_factory_->create_frame(this, desc, core::audio_channel_layout::invalid());
 118
 119                 std::copy_n(FreeImage_GetBits(bitmap.get()), frame.image_data().size(), frame.image_data().begin());
 120                 frame_ = core::draw_frame(std::move(frame));
 121                 constraints_.width.set(FreeImage_GetWidth(bitmap.get()));
 122                 constraints_.height.set(FreeImage_GetHeight(bitmap.get()));
 123         }
 124
 125         // frame_producer
 126
 127         core::draw_frame receive_impl() override
 128         {
 129                 monitor_subject_ << core::monitor::message("/file/path") % description_;
 130
 131                 return frame_;
 132         }
 133
 134         core::constraints& pixel_constraints() override
 135         {
 136                 return constraints_;
 137         }
 138
 139         std::wstring print() const override
 140         {
 141                 return L"image_producer[" + description_ + L"]";
 142         }
 143
 144         std::wstring name() const override
 145         {
 146                 return L"image";
 147         }
 148
 149         boost::property_tree::wptree info() const override
 150         {
 151                 boost::property_tree::wptree info;
 152                 info.add(L"type", L"image");
 153                 info.add(L"location", description_);
 154                 return info;
 155         }
 156
 157         core::monitor::subject& monitor_output()
 158         {
 159                 return monitor_subject_;
 160         }
 161 };
 162
 163 class ieq
 164 {
 165         std::wstring test_;
 166 public:
 167         ieq(const std::wstring& test)
 168                 : test_(test)
 169         {
 170         }
 171
 172         bool operator()(const std::wstring& elem) const
 173         {
 174                 return boost::iequals(elem, test_);
 175         }
 176 };
 177
 178 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
 179 {
 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.");
 186 }
 187
 188 static const auto g_extensions = {
 189         L".png",
 190         L".tga",
 191         L".bmp",
 192         L".jpg",
 193         L".jpeg",
 194         L".gif",
 195         L".tiff",
 196         L".tif",
 197         L".jp2",
 198         L".jpx",
 199         L".j2k",
 200         L".j2c"
 201 };
 202
 203 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
 204 {
 205
 206         if (boost::iequals(params.at(0), L"[IMG_SEQUENCE]"))
 207         {
 208                 if (params.size() != 2)
 209                         return core::frame_producer::empty();
 210
 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;
 215
 216                 for (boost::filesystem::directory_iterator it(dir); it != end; ++it)
 217                 {
 218                         auto name = it->path().filename().wstring();
 219
 220                         if (!boost::algorithm::istarts_with(name, basename))
 221                                 continue;
 222
 223                         auto extension = it->path().extension().wstring();
 224
 225                         if (std::find_if(g_extensions.begin(), g_extensions.end(), ieq(extension)) == g_extensions.end())
 226                                 continue;
 227
 228                         files.insert(it->path().wstring());
 229                 }
 230
 231                 if (files.empty())
 232                         return core::frame_producer::empty();
 233
 234                 int width = -1;
 235                 int height = -1;
 236                 std::vector<core::draw_frame> frames;
 237                 frames.reserve(files.size());
 238
 239                 for (auto& file : files)
 240                 {
 241                         auto frame = load_image(dependencies.frame_factory, file);
 242
 243                         if (width == -1)
 244                         {
 245                                 width = static_cast<int>(frame.second.width.get());
 246                                 height = static_cast<int>(frame.second.height.get());
 247                         }
 248
 249                         frames.push_back(std::move(frame.first));
 250                 }
 251
 252                 return core::create_const_producer(std::move(frames), width, height);
 253         }
 254         else if(boost::iequals(params.at(0), L"[PNG_BASE64]"))
 255         {
 256                 if (params.size() < 2)
 257                         return core::frame_producer::empty();
 258
 259                 auto png_data = from_base64(std::string(params.at(1).begin(), params.at(1).end()));
 260
 261                 return spl::make_shared<image_producer>(dependencies.frame_factory, png_data.data(), png_data.size());
 262         }
 263
 264         std::wstring filename = env::media_folder() + params.at(0);
 265
 266         auto ext = std::find_if(g_extensions.begin(), g_extensions.end(), [&](const std::wstring& ex) -> bool
 267         {
 268                 auto file = caspar::find_case_insensitive(boost::filesystem::path(filename).wstring() + ex);
 269
 270                 return static_cast<bool>(file);
 271         });
 272
 273         if(ext == g_extensions.end())
 274                 return core::frame_producer::empty();
 275
 276         return spl::make_shared<image_producer>(dependencies.frame_factory, *caspar::find_case_insensitive(filename + *ext), false);
 277 }
 278
 279
 280 core::draw_frame create_thumbnail(const core::frame_producer_dependencies& dependencies, const std::wstring& media_file)
 281 {
 282         std::wstring filename = env::media_folder() + media_file;
 283
 284         auto ext = std::find_if(g_extensions.begin(), g_extensions.end(), [&](const std::wstring& ex) -> bool
 285         {
 286                 auto file = caspar::find_case_insensitive(boost::filesystem::path(filename).wstring() + ex);
 287
 288                 return static_cast<bool>(file);
 289         });
 290
 291         if (ext == g_extensions.end())
 292                 return core::draw_frame::empty();
 293
 294         spl::shared_ptr<core::frame_producer> producer = spl::make_shared<image_producer>(
 295                         dependencies.frame_factory,
 296                         *caspar::find_case_insensitive(filename + *ext),
 297                         true);
 298
 299         return producer->receive();
 300 }
 301
 302 }}