OpenXcom  1.0
Open-source clone of the original X-Com
xbrz.h
1 // ****************************************************************************
2 // * This file is part of the HqMAME project. It is distributed under *
3 // * GNU General Public License: http://www.gnu.org/licenses/gpl-3.0 *
4 // * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved *
5 // * *
6 // * Additionally and as a special exception, the author gives permission *
7 // * to link the code of this program with the MAME library (or with modified *
8 // * versions of MAME that use the same license as MAME), and distribute *
9 // * linked combinations including the two. You must obey the GNU General *
10 // * Public License in all respects for all of the code used other than MAME. *
11 // * If you modify this file, you may extend this exception to your version *
12 // * of the file, but you are not obligated to do so. If you do not wish to *
13 // * do so, delete this exception statement from your version. *
14 // ****************************************************************************
15 
16 #ifndef XBRZ_HEADER_3847894708239054
17 #define XBRZ_HEADER_3847894708239054
18 
19 #include <cstddef> //size_t
20 #include <stdint.h> //uint32_t
21 #include <limits>
22 #include "config.h"
23 
24 namespace xbrz
25 {
26 /*
27 -------------------------------------------------------------------------
28 | xBRZ: "Scale by rules" - high quality image upscaling filter by Zenju |
29 -------------------------------------------------------------------------
30 using a modified approach of xBR:
31 http://board.byuu.org/viewtopic.php?f=10&t=2248
32 - new rule set preserving small image features
33 - highly optimized for performance
34 - support alpha channel
35 - support multithreading
36 - support 64-bit architectures
37 - support processing image slices
38 - support scaling up to 6xBRZ
39 */
40 
41 enum ColorFormat //from high bits -> low bits, 8 bit per channel
42 {
43  RGB, //8 bit for each red, green, blue, upper 8 bits unused
44  ARGB, //including alpha channel, BGRA byte order on little-endian machines
45 };
46 
47 /*
48 -> map source (srcWidth * srcHeight) to target (scale * width x scale * height) image, optionally processing a half-open slice of rows [yFirst, yLast) only
49 -> support for source/target pitch in bytes!
50 -> if your emulator changes only a few image slices during each cycle (e.g. DOSBox) then there's no need to run xBRZ on the complete image:
51  Just make sure you enlarge the source image slice by 2 rows on top and 2 on bottom (this is the additional range the xBRZ algorithm is using during analysis)
52  Caveat: If there are multiple changed slices, make sure they do not overlap after adding these additional rows in order to avoid a memory race condition
53  in the target image data if you are using multiple threads for processing each enlarged slice!
54 
55 THREAD-SAFETY: - parts of the same image may be scaled by multiple threads as long as the [yFirst, yLast) ranges do not overlap!
56  - there is a minor inefficiency for the first row of a slice, so avoid processing single rows only; suggestion: process 8-16 rows at least
57 */
58 void scale(size_t factor, //valid range: 2 - 6
59  const uint32_t* src, uint32_t* trg, int srcWidth, int srcHeight,
60  ColorFormat colFmt,
61  const ScalerCfg& cfg = ScalerCfg(),
62  int yFirst = 0, int yLast = std::numeric_limits<int>::max()); //slice of source image
63 
64 void nearestNeighborScale(const uint32_t* src, int srcWidth, int srcHeight,
65  uint32_t* trg, int trgWidth, int trgHeight);
66 
67 enum SliceType
68 {
69  NN_SCALE_SLICE_SOURCE,
70  NN_SCALE_SLICE_TARGET,
71 };
72 void nearestNeighborScale(const uint32_t* src, int srcWidth, int srcHeight, int srcPitch, //pitch in bytes!
73  uint32_t* trg, int trgWidth, int trgHeight, int trgPitch,
74  SliceType st, int yFirst, int yLast);
75 
76 //parameter tuning
77 bool equalColorTest(uint32_t col1, uint32_t col2, ColorFormat colFmt, double luminanceWeight, double equalColorTolerance);
78 
79 
80 
81 
82 
83 //########################### implementation ###########################
84 inline
85 void nearestNeighborScale(const uint32_t* src, int srcWidth, int srcHeight,
86  uint32_t* trg, int trgWidth, int trgHeight)
87 {
88  nearestNeighborScale(src, srcWidth, srcHeight, srcWidth * sizeof(uint32_t),
89  trg, trgWidth, trgHeight, trgWidth * sizeof(uint32_t),
90  NN_SCALE_SLICE_TARGET, 0, trgHeight);
91 }
92 }
93 
94 #endif
Definition: config.h:21