31 #include "formula/callable_objects.hpp"
33 #define GETTEXT_DOMAIN "wesnoth-lib"
36 #define ERR_DP LOG_STREAM(err, log_display)
42 priorities_[mod->priority()].push_back(std::move(mod));
48 auto& mod_list = top_pair->second;
51 mod_list.erase(mod_list.begin());
54 if(mod_list.empty()) {
61 std::size_t count = 0;
78 using mod_parser = std::function<std::unique_ptr<modification>(std::string_view)>;
85 std::map<std::string, mod_parser, std::less<>> mod_parsers;
94 std::unique_ptr<modification> decode_modification(
const std::string& encoded_mod)
98 if(
split.size() != 2) {
99 ERR_DP <<
"error parsing image modifications: " << encoded_mod;
103 const std::string& mod_type =
split[0];
104 const std::string& args =
split[1];
106 if(
const auto parser = mod_parsers.find(mod_type); parser != mod_parsers.end()) {
107 return std::invoke(parser->second, args);
109 ERR_DP <<
"unknown image function in path: " << mod_type;
118 : message(message_stream.str())
143 if(
auto mod = decode_modification(encoded_mod)) {
144 mods.
push(std::move(mod));
158 if(horiz_ && vert_ ) {
171 const int normalized = degrees_ >= 0 ?
172 degrees_ - 360 * (degrees_ / 360) :
173 degrees_ + 360 * (1 + (-degrees_) / 360);
175 switch ( normalized )
203 if(src_rect.w ==
src->w && src_rect.h ==
src->h) {
210 ERR_DP <<
"Failed to either crop or scale the surface";
244 : color_callable(clr), coord(),
w(
w),
h(
h)
252 color_callable::get_inputs(inputs);
253 add_input(inputs,
"x");
254 add_input(inputs,
"y");
255 add_input(inputs,
"u");
256 add_input(inputs,
"v");
257 add_input(inputs,
"height");
258 add_input(inputs,
"width");
265 return variant(coord.x);
266 }
else if(key ==
"y") {
267 return variant(coord.y);
268 }
else if(key ==
"width") {
270 }
else if(key ==
"height") {
272 }
else if(key ==
"u") {
273 return variant(coord.x /
static_cast<float>(
w));
274 }
else if(key ==
"v") {
275 return variant(coord.y /
static_cast<float>(
h));
278 return color_callable::get_value(key);
292 std::size_t
index{0};
298 color.a = std::min<unsigned>(new_alpha.
evaluate(px).
as_int(), 255);
300 pixel = color.to_argb_bytes();
314 std::size_t
index{0};
325 pixel = color.to_argb_bytes();
332 SDL_Rect area = slice_;
347 std::stringstream sstr;
348 sstr <<
"~BLIT(): x-coordinate '"
349 << x_ <<
"' larger than destination image's width '"
350 <<
src->w <<
"' no blitting performed.\n";
356 std::stringstream sstr;
357 sstr <<
"~BLIT(): y-coordinate '"
358 << y_ <<
"' larger than destination image's height '"
359 <<
src->h <<
"' no blitting performed.\n";
364 if(surf_->w + x_ < 0) {
365 std::stringstream sstr;
366 sstr <<
"~BLIT(): offset and width '"
367 << x_ + surf_->w <<
"' less than zero no blitting performed.\n";
372 if(surf_->h + y_ < 0) {
373 std::stringstream sstr;
374 sstr <<
"~BLIT(): offset and height '"
375 << y_ + surf_->h <<
"' less than zero no blitting performed.\n";
380 SDL_Rect r {x_, y_, 0, 0};
386 if(
src->w == mask_->w &&
src->h == mask_->h && x_ == 0 && y_ == 0) {
391 SDL_Rect r {x_, y_, 0, 0};
393 sdl_blit(mask_,
nullptr, new_mask, &r);
399 if(
src ==
nullptr) {
return; }
402 if(surf_->w !=
src->w || surf_->h !=
src->h) {
415 }
else if(flags_ & X_BY_FACTOR) {
416 size.x =
src->w * (
static_cast<double>(
size.x) / 100);
421 }
else if(flags_ & Y_BY_FACTOR) {
422 size.y =
src->h * (
static_cast<double>(
size.y) / 100);
425 if(flags_ & PRESERVE_ASPECT_RATIO) {
426 const auto ratio = std::min(
427 static_cast<long double>(
size.x) /
src->w,
428 static_cast<long double>(
size.y) /
src->h
432 static_cast<int>(
src->w * ratio),
433 static_cast<int>(
src->h * ratio)
437 if(flags_ & SCALE_SHARP) {
461 uint32_t* beg = lock.
pixels();
462 uint32_t* end = beg +
src.
area();
465 uint8_t alpha = (*beg) >> 24;
474 *beg = (alpha << 24) + (r << 16) + (
g << 8) +
b;
484 if((r_ != 0 || g_ != 0 ||
b_ != 0)) {
502 SDL_FillRect(ret,
nullptr, SDL_MapRGBA(ret->format, color_.r, color_.g, color_.b, color_.a));
514 struct parse_mod_registration
516 parse_mod_registration(
const char* name, mod_parser parser)
518 mod_parsers[name] = std::move(parser);
531 #define REGISTER_MOD_PARSER(type, args_var) \
532 static std::unique_ptr<modification> parse_##type##_mod(std::string_view); \
533 static parse_mod_registration parse_##type##_mod_registration_aux(#type, &parse_##type##_mod); \
534 static std::unique_ptr<modification> parse_##type##_mod(std::string_view args_var) \
541 if(params.size() < 2) {
542 ERR_DP <<
"too few arguments passed to the ~TC() function";
547 const int side_n = utils::from_chars<int>(params[0]).value_or(-1);
549 ERR_DP <<
"Invalid side (" << params[0] <<
") passed to the ~TC() function";
557 ERR_DP <<
"could not load TC info for '" << params[1] <<
"' palette";
558 ERR_DP <<
"bailing out from TC";
570 ERR_DP <<
"caught config::error while processing TC: " <<
e.message;
571 ERR_DP <<
"bailing out from TC";
576 return std::make_unique<rc_modification>(rc_map);
584 if(recolor_params.size() <= 1) {
599 <<
"caught config::error while processing color-range RC: "
601 ERR_DP <<
"bailing out from RC";
605 return std::make_unique<rc_modification>(rc_map);
613 if(remap_params.size() < 2) {
614 ERR_DP <<
"not enough arguments passed to the ~PAL() function: " << args;
624 for(std::size_t
i = 0;
i < old_palette.size() &&
i < new_palette.size(); ++
i) {
625 rc_map[old_palette[
i]] = new_palette[
i];
628 return std::make_unique<rc_modification>(rc_map);
631 <<
"caught config::error while processing PAL function: "
634 <<
"bailing out from PAL";
643 bool horiz = (args.empty() || args.find(
"horiz") != std::string::npos);
644 bool vert = (args.find(
"vert") != std::string::npos);
646 return std::make_unique<fl_modification>(horiz, vert);
654 switch(slice_params.size()) {
656 return std::make_unique<rotate_modification>();
658 return std::make_unique<rotate_modification>(
659 utils::from_chars<int>(slice_params[0]).value_or(0));
661 return std::make_unique<rotate_modification>(
662 utils::from_chars<int>(slice_params[0]).value_or(0),
663 utils::from_chars<int>(slice_params[1]).value_or(0));
665 return std::make_unique<rotate_modification>(
666 utils::from_chars<int>(slice_params[0]).value_or(0),
667 utils::from_chars<int>(slice_params[1]).value_or(0),
668 utils::from_chars<int>(slice_params[2]).value_or(0));
676 return std::make_unique<gs_modification>();
682 return std::make_unique<crop_transparency_modification>();
686 bool in_range(
int val,
int min,
int max)
688 return min <= val && val <= max;
696 if(params.size() != 1) {
697 ERR_DP <<
"~BW() requires exactly one argument";
702 const auto threshold = utils::from_chars<int>(params[0]);
704 ERR_DP <<
"unsupported argument in ~BW() function";
708 if(!in_range(*threshold, 0, 255)) {
709 ERR_DP <<
"~BW() argument out of range 0 - 255";
713 return std::make_unique<bw_modification>(*threshold);
719 return std::make_unique<sepia_modification>();
727 switch(params.size()) {
731 return std::make_unique<negative_modification>(-1, -1, -1);
734 const auto threshold = utils::from_chars<int>(params[0]);
736 if(threshold && in_range(*threshold, -1, 255)) {
737 return std::make_unique<negative_modification>(*threshold, *threshold, *threshold);
739 ERR_DP <<
"unsupported argument value in ~NEG() function";
745 const auto thR = utils::from_chars<int>(params[0]);
746 const auto thG = utils::from_chars<int>(params[1]);
747 const auto thB = utils::from_chars<int>(params[2]);
749 if(thR && thG && thB && in_range(*thR, -1, 255) && in_range(*thG, -1, 255) && in_range(*thB, -1, 255)) {
750 return std::make_unique<negative_modification>(*thR, *thG, *thB);
752 ERR_DP <<
"unsupported argument value in ~NEG() function";
758 ERR_DP <<
"~NEG() requires 0, 1 or 3 arguments";
766 return std::make_unique<plot_alpha_modification>();
772 return std::make_unique<wipe_alpha_modification>();
782 if(params.size() != 1) {
783 ERR_DP <<
"~ADJUST_ALPHA() requires exactly 1 arguments";
787 return std::make_unique<adjust_alpha_modification>(params.at(0));
797 if(params.size() < 1 || params.size() > 4) {
798 ERR_DP <<
"~CHAN() requires 1 to 4 arguments";
802 return std::make_unique<adjust_channels_modification>(params);
809 const std::size_t
s = factors.size();
812 ERR_DP <<
"no arguments passed to the ~CS() function";
816 int r = 0,
g = 0,
b = 0;
818 r = utils::from_chars<int>(factors[0]).value_or(0);
821 g = utils::from_chars<int>(factors[1]).value_or(0);
824 b = utils::from_chars<int>(factors[2]).value_or(0);
827 return std::make_unique<cs_modification>(r,
g ,
b);
835 if(params.size() != 4) {
836 ERR_DP <<
"~BLEND() requires exactly 4 arguments";
840 float opacity = 0.0f;
841 const std::string_view& opacity_str = params[3];
842 const std::string_view::size_type p100_pos = opacity_str.find(
'%');
844 if(p100_pos == std::string::npos)
845 opacity = lexical_cast_default<float>(opacity_str);
848 const std::string_view parsed_field = opacity_str.substr(0, p100_pos);
849 opacity = lexical_cast_default<float>(parsed_field);
853 return std::make_unique<blend_modification>(
854 utils::from_chars<int>(params[0]).value_or(0),
855 utils::from_chars<int>(params[1]).value_or(0),
856 utils::from_chars<int>(params[2]).value_or(0),
864 const std::size_t
s = slice_params.size();
866 if(
s == 0 || (
s == 1 && slice_params[0].empty())) {
867 ERR_DP <<
"no arguments passed to the ~CROP() function";
871 SDL_Rect slice_rect { 0, 0, 0, 0 };
873 slice_rect.x = utils::from_chars<int16_t>(slice_params[0]).value_or(0);
876 slice_rect.y = utils::from_chars<int16_t>(slice_params[1]).value_or(0);
879 slice_rect.w = utils::from_chars<uint16_t>(slice_params[2]).value_or(0);
882 slice_rect.h = utils::from_chars<uint16_t>(slice_params[3]).value_or(0);
885 return std::make_unique<crop_modification>(slice_rect);
891 message <<
" image not found: '" <<
img.get_filename() <<
"'\n";
900 const std::size_t
s = param.size();
902 if(
s == 0 || (
s == 1 && param[0].empty())){
903 ERR_DP <<
"no arguments passed to the ~BLIT() function";
908 ERR_DP <<
"too many arguments passed to the ~BLIT() function";
915 x = utils::from_chars<int>(param[1]).value_or(0);
916 y = utils::from_chars<int>(param[2]).value_or(0);
922 if(!check_image(
img, message))
926 return std::make_unique<blit_modification>(
surf, x, y);
933 const std::size_t
s = param.size();
935 if(
s == 0 || (
s == 1 && param[0].empty())){
936 ERR_DP <<
"no arguments passed to the ~MASK() function";
943 x = utils::from_chars<int>(param[1]).value_or(0);
944 y = utils::from_chars<int>(param[2]).value_or(0);
948 ERR_DP <<
"negative position arguments in ~MASK() function";
955 if(!check_image(
img, message))
959 return std::make_unique<mask_modification>(
surf, x, y);
966 ERR_DP <<
"no arguments passed to the ~L() function";
971 return std::make_unique<light_modification>(
surf);
976 std::pair<int, bool> parse_scale_value(std::string_view arg)
978 if(
const std::size_t pos = arg.rfind(
'%'); pos != std::string_view::npos) {
979 return { utils::from_chars<int>(arg.substr(0, pos)).value_or(0),
true };
981 return { utils::from_chars<int>(arg).value_or(0),
false };
986 utils::optional<std::pair<point, uint8_t>> parse_scale_args(std::string_view args)
989 const std::size_t num_args = scale_params.size();
991 if(num_args == 0 || (num_args == 1 && scale_params[0].empty())) {
992 return utils::nullopt;
996 std::array<int, 2> parsed_sizes{0,0};
998 for(
unsigned i = 0; i < std::min<unsigned>(2, num_args); ++
i) {
999 const auto& [
size, relative] = parse_scale_value(scale_params[
i]);
1002 ERR_DP <<
"Negative size passed to scaling IPF. Original image dimension will be used instead";
1006 parsed_sizes[
i] =
size;
1013 return std::pair{
point{parsed_sizes[0], parsed_sizes[1]}, flags};
1021 if(
auto params = parse_scale_args(args)) {
1023 return std::make_unique<scale_modification>(params->first, mode | params->second);
1025 ERR_DP <<
"no arguments passed to the ~SCALE() function";
1032 if(
auto params = parse_scale_args(args)) {
1034 return std::make_unique<scale_modification>(params->first, mode | params->second);
1036 ERR_DP <<
"no arguments passed to the ~SCALE_SHARP() function";
1043 if(
auto params = parse_scale_args(args)) {
1045 return std::make_unique<scale_modification>(params->first, mode | params->second);
1047 ERR_DP <<
"no arguments passed to the ~SCALE_INTO() function";
1054 if(
auto params = parse_scale_args(args)) {
1056 return std::make_unique<scale_modification>(params->first, mode | params->second);
1058 ERR_DP <<
"no arguments passed to the ~SCALE_INTO_SHARP() function";
1066 const int factor = std::clamp(utils::from_chars<int>(args).value_or(1), 1, 6);
1067 return std::make_unique<xbrz_modification>(factor);
1073 const int depth = std::max<int>(0, utils::from_chars<int>(args).value_or(0));
1074 return std::make_unique<bl_modification>(depth);
1080 const std::string::size_type p100_pos = args.find(
'%');
1082 if(p100_pos == std::string::npos) {
1083 num = lexical_cast_default<float, std::string_view>(args);
1086 const std::string_view parsed_field = args.substr(0, p100_pos);
1087 num = lexical_cast_default<float, std::string_view>(parsed_field);
1091 return std::make_unique<o_modification>(num);
1101 const int r = utils::from_chars<int>(args).value_or(0);
1102 return std::make_unique<cs_modification>(r, 0, 0);
1108 const int g = utils::from_chars<int>(args).value_or(0);
1109 return std::make_unique<cs_modification>(0,
g, 0);
1115 const int b = utils::from_chars<int>(args).value_or(0);
1116 return std::make_unique<cs_modification>(0, 0,
b);
1140 int c[4] { 0, 0, 0, SDL_ALPHA_OPAQUE };
1143 for(
int i = 0; i < std::min<int>(factors.size(), 4); ++
i) {
1144 c[
i] = utils::from_chars<int>(factors[
i]).value_or(0);
1147 return std::make_unique<background_modification>(
color_t(
c[0],
c[1],
c[2],
c[3]));
1156 if(params.size() != 3 && params.size() != 4) {
1157 ERR_DP <<
"incorrect number of arguments in ~SWAP() function, they must be 3 or 4";
1161 channel redValue, greenValue, blueValue, alphaValue;
1163 if(params[0] ==
"red") {
1165 }
else if(params[0] ==
"green") {
1167 }
else if(params[0] ==
"blue") {
1169 }
else if(params[0] ==
"alpha") {
1172 ERR_DP <<
"unsupported argument value in ~SWAP() function: " << params[0];
1177 if(params[1] ==
"red") {
1179 }
else if(params[1] ==
"green") {
1181 }
else if(params[1] ==
"blue") {
1183 }
else if(params[1] ==
"alpha") {
1186 ERR_DP <<
"unsupported argument value in ~SWAP() function: " << params[0];
1190 if(params[2] ==
"red") {
1192 }
else if(params[2] ==
"green") {
1194 }
else if(params[2] ==
"blue") {
1196 }
else if(params[2] ==
"alpha") {
1199 ERR_DP <<
"unsupported argument value in ~SWAP() function: " << params[0];
1205 if(params.size() == 3) {
1208 if(params[3] ==
"red") {
1210 }
else if(params[3] ==
"green") {
1212 }
else if(params[3] ==
"blue") {
1214 }
else if(params[3] ==
"alpha") {
1217 ERR_DP <<
"unsupported argument value in ~SWAP() function: " << params[3];
1222 return std::make_unique<swap_modification>(redValue, greenValue, blueValue, alphaValue);
A color range definition is made of four reference RGB colors, used for calculating conversions from ...
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
Generic locator abstracting the location of an image.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
A modified priority queue used to order image modifications.
void push(std::unique_ptr< modification > &&mod)
Adds mod to the queue.
const modification & top() const
Returns a const reference to the top element in the queue.
std::map< int, std::vector< std::unique_ptr< modification > >, std::greater< int > > priorities_
Map from a mod's priority() to the mods having that priority.
void pop()
Removes the top element from the queue.
std::size_t size() const
Returns the number of elements in the queue.
Base abstract class for an image-path modification.
static modification_queue decode(const std::string &)
Decodes modifications from a modification string.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
pixel_callable(std::size_t index, color_t clr, int w, int h)
wfl::variant get_value(const std::string &key) const override
void get_inputs(wfl::formula_input_vector &inputs) const override
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
void store() const noexcept
Stores a copy the current exception to be rethrown.
Helper class for pinning SDL surfaces into memory.
utils::span< pixel_t > pixel_span() const
static const color_range get_side_color_range(int side)
constexpr uint8_t color_multiply(uint8_t n1, uint8_t n2)
Multiply two 8-bit colour values as if in the range [0.0,1.0].
constexpr uint8_t float_to_color(double n)
Convert a double in the range [0.0,1.0] to an 8-bit colour value.
color_range_map recolor_range(const color_range &new_range, const std::vector< color_t > &old_rgb)
Converts a source palette using the specified color_range object.
std::unordered_map< color_t, color_t > color_range_map
Definitions for the interface to Wesnoth Markup Language (WML).
#define REGISTER_MOD_PARSER(type, args_var)
A macro for automatic modification parser registration.
static lg::log_domain log_display("display")
New lexcical_cast header.
Standard logging facilities (interface).
const std::vector< color_t > & tc_info(std::string_view name)
const color_range & color_info(std::string_view name)
Functions to load and save images from/to disk.
bool exists(const image::locator &i_locator)
Returns true if the given image actually exists, without loading it.
surface get_surface(const image::locator &i_locator, TYPE type, bool skip_cache)
Returns an image surface suitable for software manipulation.
std::string img(const std::string &src, const std::string &align, bool floating)
Generates a Help markup tag corresponding to an image.
std::size_t size(std::string_view str)
Length in characters of a UTF-8 string.
std::size_t index(std::string_view str, const std::size_t index)
Codepoint index corresponding to the nth character in a UTF-8 string.
@ STRIP_SPACES
REMOVE_EMPTY: remove empty elements.
std::vector< std::string_view > split_view(std::string_view s, const char sep, const int flags)
std::vector< std::string > parenthetical_split(std::string_view val, const char separator, std::string_view left, std::string_view right, const int flags)
Splits a string based either on a separator, except then the text appears within specified parenthesi...
std::vector< std::string > split(const config_attribute_value &val)
std::vector< formula_input > formula_input_vector
rect src
Non-transparent portion of the surface to compose.
The basic class for representing 8-bit RGB or RGBA colour values.
static constexpr color_t from_argb_bytes(uint32_t c)
Creates a new color_t object from a uint32_t variable.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
Exception thrown by the operator() when an error occurs.
imod_exception(const std::stringstream &message_stream)
Constructor.
virtual void operator()(surface &src) const override
Applies the image-path modification on the specified surface.
An abstract description of a rectangle with integer coordinates.
constexpr int area() const
The area of this rectangle, in square pixels.
static map_location::direction s
void mask_surface(surface &nsurf, const surface &nmask, bool *empty_result, const std::string &filename)
Applies a mask on a surface.
rect get_non_transparent_portion(const surface &nsurf)
void alpha_to_greyscale(surface &nsurf)
surface scale_surface_legacy(const surface &surf, int w, int h)
Scale a surface using simple bilinear filtering (discarding rgb from source pixels with 0 alpha)
void recolor_image(surface &nsurf, const color_range_map &map_rgb)
Recolors a surface using a map with source and converted palette values.
void wipe_alpha(surface &nsurf)
void sepia_image(surface &nsurf)
void blend_surface(surface &nsurf, const double amount, const color_t color)
Blends a surface with a color.
void swap_channels_image(surface &nsurf, channel r, channel g, channel b, channel a)
void adjust_surface_color(surface &nsurf, int red, int green, int blue)
surface cut_surface(const surface &surf, const SDL_Rect &r)
Cuts a rectangle from a surface.
void negative_image(surface &nsurf, const int thresholdR, const int thresholdG, const int thresholdB)
void light_surface(surface &nsurf, const surface &lightmap)
Light surf using lightmap.
surface get_surface_portion(const surface &src, SDL_Rect &area)
Get a portion of the screen.
surface scale_surface_xbrz(const surface &surf, std::size_t z)
Scale a surface using xBRZ algorithm.
surface scale_surface_sharp(const surface &surf, int w, int h)
Scale a surface using modified nearest neighbour algorithm.
void blur_alpha_surface(surface &res, int depth)
Cross-fades a surface with alpha channel.
void greyscale_image(surface &nsurf)
void flop_surface(surface &nsurf)
surface rotate_90_surface(const surface &surf, bool clockwise)
Rotates a surface 90 degrees.
surface rotate_180_surface(const surface &surf)
Rotates a surface 180 degrees.
void flip_surface(surface &nsurf)
surface scale_surface(const surface &surf, int w, int h)
Scale a surface using alpha-weighted modified bilinear filtering Note: causes artifacts with alpha gr...
surface rotate_any_surface(const surface &surf, float angle, int zoom, int offset)
Rotates a surface by any degrees.
void monochrome_image(surface &nsurf, const int threshold)
void sdl_blit(const surface &src, const SDL_Rect *src_rect, surface &dst, SDL_Rect *dst_rect)