1xBRZ upscaling commandline tool
2===============================
3
4Copyright (c) 2014 Przemysław Grzywacz <nexather@gmail.com>
5
6This file is part of xbrzscale.
7
8xbrzscale is free software: you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation, either version 3 of the License, or
11(at your option) any later version.
12
13This program is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
21
22
23Overview
24--------
25
26This tool allows you to scale your graphics with xBRZ algorithm, see http://en.wikipedia.org/wiki/Image_scaling#xbr_family
27
28This is an example of what xBRZ can do:
29
30![Example of xBRZ](https://upload.wikimedia.org/wikipedia/commons/6/6c/HQx-xBRZ-comparison.png)
31
32
33External code
34-------------
35
36The following external code is included in this repository:
37
38* https://sourceforge.net/projects/xbrz/files/xBRZ/ - xBRZ implementation
39
40Dependencies
41------------
42
43The following dependencies are needed to compile xbrzscale:
44
45* libsdl2-dev
46* libsdl2-image-dev
47
48Under OSX they can be installed using macports
49
50* port install libsdl2_image
51* port install libsdl2
52
53Some additional libraries are needed. I'm sure you'll figure it out.
54
55If you need SDL1.2 support, check sdl1.2 git branch.
56
57
58Compiling
59---------
60
61Just run `make` and you should end up with a binary called `xbrzscale`.
62
63The makefile will probably work only on linux and OSX, but it is simple enough to be ported to other platforms.
64
65
66Usage
67-----
68
69	`xbrztool scale_factor input_image output_image`
70
71* `scale_factor` - Controls how much your image should be scaled. It should be an integer between 2 and 5 (inclusive).
72* `input_image` - Input image is the filename of the image you want to scale. Image format can be anything that SDL_image supports.
73* `output_image` - Filename where the scaled image should be saved. The only supported format is PNG!
74
75Please note I only tested the scaling on 32bit RGBA PNGs, I have no idea if this will work with 8bit indexed images.
76
77
78
79
80