├── .gitignore
├── LICENSE
├── README.md
├── crunch.sln
├── crunch.vcxproj
├── crunch.vcxproj.filters
├── crunch.xcodeproj
├── project.pbxproj
├── project.xcworkspace
│ └── contents.xcworkspacedata
└── xcuserdata
│ └── ChevyRay.xcuserdatad
│ └── xcschemes
│ ├── crunch.xcscheme
│ └── xcschememanagement.plist
└── crunch
├── GuillotineBinPack.cpp
├── GuillotineBinPack.h
├── MaxRectsBinPack.cpp
├── MaxRectsBinPack.h
├── Rect.cpp
├── Rect.h
├── binary.cpp
├── binary.hpp
├── bitmap.cpp
├── bitmap.hpp
├── hash.cpp
├── hash.hpp
├── lodepng.cpp
├── lodepng.h
├── main.cpp
├── packer.cpp
├── packer.hpp
├── str.cpp
├── str.hpp
└── tinydir.h
/.gitignore:
--------------------------------------------------------------------------------
1 | # Compiled Object files
2 | *.slo
3 | *.lo
4 | *.o
5 | *.obj
6 |
7 | # Precompiled Headers
8 | *.gch
9 | *.pch
10 |
11 | # Compiled Dynamic libraries
12 | *.so
13 | *.dylib
14 | *.dll
15 |
16 | # Fortran module files
17 | *.mod
18 | *.smod
19 |
20 | # Compiled Static libraries
21 | *.lai
22 | *.la
23 | *.a
24 | *.lib
25 |
26 | # Executables
27 | *.exe
28 | *.out
29 | *.app
30 | *.ilk
31 | *.pdb
32 | *.tlog
33 | *.log
34 | Debug/*
35 | Release/*
36 | *.opendb
37 | *.db
38 | *.suo
39 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Unless otherwise specified in a source file, everything
2 | in this project falls under the following license:
3 |
4 | MIT License
5 |
6 | Copyright (c) 2017 Chevy Ray Johnston
7 |
8 | Permission is hereby granted, free of charge, to any person obtaining a copy
9 | of this software and associated documentation files (the "Software"), to deal
10 | in the Software without restriction, including without limitation the rights
11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 | copies of the Software, and to permit persons to whom the Software is
13 | furnished to do so, subject to the following conditions:
14 |
15 | The above copyright notice and this permission notice shall be included in all
16 | copies or substantial portions of the Software.
17 |
18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 | SOFTWARE.
25 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # crunch
2 |
3 | This is a command line tool that will pack a bunch of images into a single, larger image. It was designed for [Celeste](http://www.celestegame.com/), but could be very helpful for other games.
4 |
5 | It is designed using libraries with permissible licenses, so you are able to use it freely in your commercial and non-commercial projects. Please see each source file for its respective copyright and license.
6 |
7 | ### Features
8 |
9 | - Export XML, JSON, or binary data
10 | - Trim excess transparency
11 | - Rotate images to fit
12 | - Control atlas size and padding
13 | - Premultiply pixel values
14 | - Recursively scans folders
15 | - Remove duplicate images
16 | - Caching to prevent redundant builds
17 | - Multi-image atlas when the sprites don't fit
18 |
19 | ### What does it do?
20 |
21 | Given a folder with several images, like so:
22 |
23 | ```
24 | images/
25 | player.png
26 | tree.png
27 | enemy.png
28 | ```
29 |
30 | It will output something like this:
31 |
32 | ```
33 | bin/
34 | images.png
35 | images.xml
36 | images.hash
37 | ```
38 |
39 | Where `images.png` is the packed image, `images.xml` is an xml file describing where each sub-image is located, and `images.hash` is used for file caching (if none of the input files have changed since the last pack, the program will terminate).
40 |
41 | There is also an option to use a binary format instead of xml.
42 |
43 | ### Usage
44 |
45 | `crunch [OUTPUT] [INPUT1,INPUT2,INPUT3...] [OPTIONS...]`
46 |
47 | For example...
48 |
49 | `crunch bin/atlases/atlas assets/characters,assets/tiles -p -t -v -u -r -j`
50 |
51 | This will output the following files:
52 |
53 | ```
54 | bin/atlases/atlas.png
55 | bin/atlases/atlas.json
56 | bin/atlases/atlas.hash
57 | ```
58 |
59 | ### Options
60 |
61 | | option | alias | description |
62 | | ------------- | ------------- | ------------|
63 | | -d | --default | use default settings (-x -p -t -u)
64 | | -x | --xml | saves the atlas data as a .xml file
65 | | -b | --binary | saves the atlas data as a .bin file
66 | | -j | --json | saves the atlas data as a .json file
67 | | -p | --premultiply | premultiplies the pixels of the bitmaps by their alpha channel
68 | | -t | --trim | trims excess transparency off the bitmaps
69 | | -v | --verbose | print to the debug console as the packer works
70 | | -f | --force | ignore caching, forcing the packer to repack
71 | | -u | --unique | remove duplicate bitmaps from the atlas
72 | | -r | --rotate | enabled rotating bitmaps 90 degrees clockwise when packing
73 | | -s# | --size# | max atlas size (# can be 4096, 2048, 1024, 512, 256, 128, or 64)
74 | | -p# | --pad# | padding between images (# can be from 0 to 16)
75 |
76 | ### Binary Format
77 |
78 | ```
79 | [int16] num_textures (below block is repeated this many times)
80 | [string] name
81 | [int16] num_images (below block is repeated this many times)
82 | [string] img_name
83 | [int16] img_x
84 | [int16] img_y
85 | [int16] img_width
86 | [int16] img_height
87 | [int16] img_frame_x (if --trim enabled)
88 | [int16] img_frame_y (if --trim enabled)
89 | [int16] img_frame_width (if --trim enabled)
90 | [int16] img_frame_height (if --trim enabled)
91 | [byte] img_rotated (if --rotate enabled)
92 | ```
93 |
94 | ### License
95 |
96 | Unless otherwise specified in a source file, everything in this project falls under the following license:
97 |
98 | ```
99 | MIT License
100 |
101 | Copyright (c) 2017 Chevy Ray Johnston
102 |
103 | Permission is hereby granted, free of charge, to any person obtaining a copy
104 | of this software and associated documentation files (the "Software"), to deal
105 | in the Software without restriction, including without limitation the rights
106 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
107 | copies of the Software, and to permit persons to whom the Software is
108 | furnished to do so, subject to the following conditions:
109 |
110 | The above copyright notice and this permission notice shall be included in all
111 | copies or substantial portions of the Software.
112 |
113 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
114 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
115 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
116 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
117 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
118 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
119 | SOFTWARE.
120 | ```
121 |
--------------------------------------------------------------------------------
/crunch.sln:
--------------------------------------------------------------------------------
1 |
2 | Microsoft Visual Studio Solution File, Format Version 12.00
3 | # Visual Studio 14
4 | VisualStudioVersion = 14.0.25123.0
5 | MinimumVisualStudioVersion = 10.0.40219.1
6 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "crunch", "crunch.vcxproj", "{45DC29F9-10AB-4642-BE8F-CA01203EDF17}"
7 | EndProject
8 | Global
9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
10 | Debug|x64 = Debug|x64
11 | Debug|x86 = Debug|x86
12 | Release|x64 = Release|x64
13 | Release|x86 = Release|x86
14 | EndGlobalSection
15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
16 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Debug|x64.ActiveCfg = Debug|x64
17 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Debug|x64.Build.0 = Debug|x64
18 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Debug|x86.ActiveCfg = Debug|Win32
19 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Debug|x86.Build.0 = Debug|Win32
20 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Release|x64.ActiveCfg = Release|x64
21 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Release|x64.Build.0 = Release|x64
22 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Release|x86.ActiveCfg = Release|Win32
23 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}.Release|x86.Build.0 = Release|Win32
24 | EndGlobalSection
25 | GlobalSection(SolutionProperties) = preSolution
26 | HideSolutionNode = FALSE
27 | EndGlobalSection
28 | EndGlobal
29 |
--------------------------------------------------------------------------------
/crunch.vcxproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Debug
6 | Win32
7 |
8 |
9 | Release
10 | Win32
11 |
12 |
13 | Debug
14 | x64
15 |
16 |
17 | Release
18 | x64
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | {45DC29F9-10AB-4642-BE8F-CA01203EDF17}
47 | Win32Proj
48 | crunch
49 | 8.1
50 |
51 |
52 |
53 | Application
54 | true
55 | v140
56 | Unicode
57 |
58 |
59 | Application
60 | false
61 | v140
62 | true
63 | Unicode
64 |
65 |
66 | Application
67 | true
68 | v140
69 | Unicode
70 |
71 |
72 | Application
73 | false
74 | v140
75 | true
76 | Unicode
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 | true
98 |
99 |
100 | true
101 |
102 |
103 | false
104 |
105 |
106 | false
107 |
108 |
109 |
110 |
111 |
112 | Level3
113 | Disabled
114 | WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)
115 |
116 |
117 | Console
118 | true
119 |
120 |
121 |
122 |
123 |
124 |
125 | Level3
126 | Disabled
127 | _DEBUG;_CONSOLE;%(PreprocessorDefinitions)
128 |
129 |
130 | Console
131 | true
132 |
133 |
134 |
135 |
136 | Level3
137 |
138 |
139 | Full
140 | true
141 | true
142 | WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)
143 |
144 |
145 | Console
146 | true
147 | true
148 | true
149 |
150 |
151 |
152 |
153 | Level3
154 |
155 |
156 | MaxSpeed
157 | true
158 | true
159 | NDEBUG;_CONSOLE;%(PreprocessorDefinitions)
160 |
161 |
162 | Console
163 | true
164 | true
165 | true
166 |
167 |
168 |
169 |
170 |
171 |
--------------------------------------------------------------------------------
/crunch.vcxproj.filters:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {4FC737F1-C7A5-4376-A066-2A32D752A2FF}
6 | cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx
7 |
8 |
9 | {93995380-89BD-4b04-88EB-625FBE52EBFB}
10 | h;hh;hpp;hxx;hm;inl;inc;xsd
11 |
12 |
13 | {67DA6AB6-F800-4c08-8B7A-83BB121AAD01}
14 | rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms
15 |
16 |
17 |
18 |
19 | Header Files
20 |
21 |
22 | Header Files
23 |
24 |
25 | Header Files
26 |
27 |
28 | Header Files
29 |
30 |
31 | Header Files
32 |
33 |
34 | Header Files
35 |
36 |
37 | Header Files
38 |
39 |
40 | Header Files
41 |
42 |
43 | Header Files
44 |
45 |
46 | Header Files
47 |
48 |
49 |
50 |
51 | Source Files
52 |
53 |
54 | Source Files
55 |
56 |
57 | Source Files
58 |
59 |
60 | Source Files
61 |
62 |
63 | Source Files
64 |
65 |
66 | Source Files
67 |
68 |
69 | Source Files
70 |
71 |
72 | Source Files
73 |
74 |
75 | Source Files
76 |
77 |
78 | Source Files
79 |
80 |
81 |
--------------------------------------------------------------------------------
/crunch.xcodeproj/project.pbxproj:
--------------------------------------------------------------------------------
1 | // !$*UTF8*$!
2 | {
3 | archiveVersion = 1;
4 | classes = {
5 | };
6 | objectVersion = 46;
7 | objects = {
8 |
9 | /* Begin PBXBuildFile section */
10 | 1B08AF1B1E79026300CD496C /* bitmap.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1B08AF191E79026300CD496C /* bitmap.cpp */; };
11 | 1B08AF1E1E7911B200CD496C /* packer.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1B08AF1C1E7911B200CD496C /* packer.cpp */; };
12 | 1B761F8C1E78ECBE00E2E4FC /* GuillotineBinPack.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1B761F861E78ECBE00E2E4FC /* GuillotineBinPack.cpp */; };
13 | 1B761F8D1E78ECBE00E2E4FC /* MaxRectsBinPack.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1B761F881E78ECBE00E2E4FC /* MaxRectsBinPack.cpp */; };
14 | 1B761F8E1E78ECBE00E2E4FC /* Rect.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1B761F8A1E78ECBE00E2E4FC /* Rect.cpp */; };
15 | 1BD1CE521E78EC44009C02A2 /* main.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1BD1CE511E78EC44009C02A2 /* main.cpp */; };
16 | 1BD766C51E79241600523C03 /* lodepng.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1BD766C31E79241600523C03 /* lodepng.cpp */; };
17 | 1BD766CA1E79C94900523C03 /* binary.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1BD766C81E79C94900523C03 /* binary.cpp */; };
18 | 1BD766CD1E79FB5500523C03 /* hash.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1BD766CB1E79FB5500523C03 /* hash.cpp */; };
19 | 1BD766D01E79FBFD00523C03 /* str.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1BD766CE1E79FBFD00523C03 /* str.cpp */; };
20 | /* End PBXBuildFile section */
21 |
22 | /* Begin PBXCopyFilesBuildPhase section */
23 | 1BD1CE4C1E78EC44009C02A2 /* CopyFiles */ = {
24 | isa = PBXCopyFilesBuildPhase;
25 | buildActionMask = 2147483647;
26 | dstPath = /usr/share/man/man1/;
27 | dstSubfolderSpec = 0;
28 | files = (
29 | );
30 | runOnlyForDeploymentPostprocessing = 1;
31 | };
32 | /* End PBXCopyFilesBuildPhase section */
33 |
34 | /* Begin PBXFileReference section */
35 | 1B08AF181E78F91700CD496C /* tinydir.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = tinydir.h; sourceTree = ""; };
36 | 1B08AF191E79026300CD496C /* bitmap.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = bitmap.cpp; sourceTree = ""; };
37 | 1B08AF1A1E79026300CD496C /* bitmap.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = bitmap.hpp; sourceTree = ""; };
38 | 1B08AF1C1E7911B200CD496C /* packer.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = packer.cpp; sourceTree = ""; };
39 | 1B08AF1D1E7911B200CD496C /* packer.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = packer.hpp; sourceTree = ""; };
40 | 1B761F861E78ECBE00E2E4FC /* GuillotineBinPack.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = GuillotineBinPack.cpp; sourceTree = ""; };
41 | 1B761F871E78ECBE00E2E4FC /* GuillotineBinPack.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = GuillotineBinPack.h; sourceTree = ""; };
42 | 1B761F881E78ECBE00E2E4FC /* MaxRectsBinPack.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = MaxRectsBinPack.cpp; sourceTree = ""; };
43 | 1B761F891E78ECBE00E2E4FC /* MaxRectsBinPack.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MaxRectsBinPack.h; sourceTree = ""; };
44 | 1B761F8A1E78ECBE00E2E4FC /* Rect.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Rect.cpp; sourceTree = ""; };
45 | 1B761F8B1E78ECBE00E2E4FC /* Rect.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Rect.h; sourceTree = ""; };
46 | 1BD1CE4E1E78EC44009C02A2 /* crunch */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = crunch; sourceTree = BUILT_PRODUCTS_DIR; };
47 | 1BD1CE511E78EC44009C02A2 /* main.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = main.cpp; sourceTree = ""; };
48 | 1BD766C31E79241600523C03 /* lodepng.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = lodepng.cpp; sourceTree = ""; };
49 | 1BD766C41E79241600523C03 /* lodepng.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = lodepng.h; sourceTree = ""; };
50 | 1BD766C81E79C94900523C03 /* binary.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = binary.cpp; sourceTree = ""; };
51 | 1BD766C91E79C94900523C03 /* binary.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = binary.hpp; sourceTree = ""; };
52 | 1BD766CB1E79FB5500523C03 /* hash.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = hash.cpp; sourceTree = ""; };
53 | 1BD766CC1E79FB5500523C03 /* hash.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = hash.hpp; sourceTree = ""; };
54 | 1BD766CE1E79FBFD00523C03 /* str.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = str.cpp; sourceTree = ""; };
55 | 1BD766CF1E79FBFD00523C03 /* str.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = str.hpp; sourceTree = ""; };
56 | /* End PBXFileReference section */
57 |
58 | /* Begin PBXFrameworksBuildPhase section */
59 | 1BD1CE4B1E78EC44009C02A2 /* Frameworks */ = {
60 | isa = PBXFrameworksBuildPhase;
61 | buildActionMask = 2147483647;
62 | files = (
63 | );
64 | runOnlyForDeploymentPostprocessing = 0;
65 | };
66 | /* End PBXFrameworksBuildPhase section */
67 |
68 | /* Begin PBXGroup section */
69 | 1BD1CE451E78EC44009C02A2 = {
70 | isa = PBXGroup;
71 | children = (
72 | 1BD1CE501E78EC44009C02A2 /* crunch */,
73 | 1BD1CE4F1E78EC44009C02A2 /* Products */,
74 | );
75 | sourceTree = "";
76 | };
77 | 1BD1CE4F1E78EC44009C02A2 /* Products */ = {
78 | isa = PBXGroup;
79 | children = (
80 | 1BD1CE4E1E78EC44009C02A2 /* crunch */,
81 | );
82 | name = Products;
83 | sourceTree = "";
84 | };
85 | 1BD1CE501E78EC44009C02A2 /* crunch */ = {
86 | isa = PBXGroup;
87 | children = (
88 | 1BD1CE511E78EC44009C02A2 /* main.cpp */,
89 | 1B761F861E78ECBE00E2E4FC /* GuillotineBinPack.cpp */,
90 | 1B761F871E78ECBE00E2E4FC /* GuillotineBinPack.h */,
91 | 1BD766C31E79241600523C03 /* lodepng.cpp */,
92 | 1BD766C41E79241600523C03 /* lodepng.h */,
93 | 1B761F881E78ECBE00E2E4FC /* MaxRectsBinPack.cpp */,
94 | 1B761F891E78ECBE00E2E4FC /* MaxRectsBinPack.h */,
95 | 1B761F8A1E78ECBE00E2E4FC /* Rect.cpp */,
96 | 1B761F8B1E78ECBE00E2E4FC /* Rect.h */,
97 | 1B08AF181E78F91700CD496C /* tinydir.h */,
98 | 1B08AF191E79026300CD496C /* bitmap.cpp */,
99 | 1B08AF1A1E79026300CD496C /* bitmap.hpp */,
100 | 1B08AF1C1E7911B200CD496C /* packer.cpp */,
101 | 1B08AF1D1E7911B200CD496C /* packer.hpp */,
102 | 1BD766C81E79C94900523C03 /* binary.cpp */,
103 | 1BD766C91E79C94900523C03 /* binary.hpp */,
104 | 1BD766CB1E79FB5500523C03 /* hash.cpp */,
105 | 1BD766CC1E79FB5500523C03 /* hash.hpp */,
106 | 1BD766CE1E79FBFD00523C03 /* str.cpp */,
107 | 1BD766CF1E79FBFD00523C03 /* str.hpp */,
108 | );
109 | path = crunch;
110 | sourceTree = "";
111 | };
112 | /* End PBXGroup section */
113 |
114 | /* Begin PBXNativeTarget section */
115 | 1BD1CE4D1E78EC44009C02A2 /* crunch */ = {
116 | isa = PBXNativeTarget;
117 | buildConfigurationList = 1BD1CE551E78EC44009C02A2 /* Build configuration list for PBXNativeTarget "crunch" */;
118 | buildPhases = (
119 | 1BD1CE4A1E78EC44009C02A2 /* Sources */,
120 | 1BD1CE4B1E78EC44009C02A2 /* Frameworks */,
121 | 1BD1CE4C1E78EC44009C02A2 /* CopyFiles */,
122 | );
123 | buildRules = (
124 | );
125 | dependencies = (
126 | );
127 | name = crunch;
128 | productName = crunch;
129 | productReference = 1BD1CE4E1E78EC44009C02A2 /* crunch */;
130 | productType = "com.apple.product-type.tool";
131 | };
132 | /* End PBXNativeTarget section */
133 |
134 | /* Begin PBXProject section */
135 | 1BD1CE461E78EC44009C02A2 /* Project object */ = {
136 | isa = PBXProject;
137 | attributes = {
138 | LastUpgradeCheck = 0820;
139 | ORGANIZATIONNAME = "Chevy Ray Johnston";
140 | TargetAttributes = {
141 | 1BD1CE4D1E78EC44009C02A2 = {
142 | CreatedOnToolsVersion = 8.2.1;
143 | ProvisioningStyle = Automatic;
144 | };
145 | };
146 | };
147 | buildConfigurationList = 1BD1CE491E78EC44009C02A2 /* Build configuration list for PBXProject "crunch" */;
148 | compatibilityVersion = "Xcode 3.2";
149 | developmentRegion = English;
150 | hasScannedForEncodings = 0;
151 | knownRegions = (
152 | en,
153 | );
154 | mainGroup = 1BD1CE451E78EC44009C02A2;
155 | productRefGroup = 1BD1CE4F1E78EC44009C02A2 /* Products */;
156 | projectDirPath = "";
157 | projectRoot = "";
158 | targets = (
159 | 1BD1CE4D1E78EC44009C02A2 /* crunch */,
160 | );
161 | };
162 | /* End PBXProject section */
163 |
164 | /* Begin PBXSourcesBuildPhase section */
165 | 1BD1CE4A1E78EC44009C02A2 /* Sources */ = {
166 | isa = PBXSourcesBuildPhase;
167 | buildActionMask = 2147483647;
168 | files = (
169 | 1BD766CA1E79C94900523C03 /* binary.cpp in Sources */,
170 | 1B761F8D1E78ECBE00E2E4FC /* MaxRectsBinPack.cpp in Sources */,
171 | 1BD766CD1E79FB5500523C03 /* hash.cpp in Sources */,
172 | 1B761F8C1E78ECBE00E2E4FC /* GuillotineBinPack.cpp in Sources */,
173 | 1BD1CE521E78EC44009C02A2 /* main.cpp in Sources */,
174 | 1B08AF1B1E79026300CD496C /* bitmap.cpp in Sources */,
175 | 1BD766C51E79241600523C03 /* lodepng.cpp in Sources */,
176 | 1B761F8E1E78ECBE00E2E4FC /* Rect.cpp in Sources */,
177 | 1B08AF1E1E7911B200CD496C /* packer.cpp in Sources */,
178 | 1BD766D01E79FBFD00523C03 /* str.cpp in Sources */,
179 | );
180 | runOnlyForDeploymentPostprocessing = 0;
181 | };
182 | /* End PBXSourcesBuildPhase section */
183 |
184 | /* Begin XCBuildConfiguration section */
185 | 1BD1CE531E78EC44009C02A2 /* Debug */ = {
186 | isa = XCBuildConfiguration;
187 | buildSettings = {
188 | ALWAYS_SEARCH_USER_PATHS = NO;
189 | CLANG_ANALYZER_NONNULL = YES;
190 | CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
191 | CLANG_CXX_LIBRARY = "libc++";
192 | CLANG_ENABLE_MODULES = YES;
193 | CLANG_ENABLE_OBJC_ARC = YES;
194 | CLANG_WARN_BOOL_CONVERSION = YES;
195 | CLANG_WARN_CONSTANT_CONVERSION = YES;
196 | CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
197 | CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
198 | CLANG_WARN_EMPTY_BODY = YES;
199 | CLANG_WARN_ENUM_CONVERSION = YES;
200 | CLANG_WARN_INFINITE_RECURSION = YES;
201 | CLANG_WARN_INT_CONVERSION = YES;
202 | CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
203 | CLANG_WARN_SUSPICIOUS_MOVE = YES;
204 | CLANG_WARN_UNREACHABLE_CODE = YES;
205 | CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
206 | CODE_SIGN_IDENTITY = "-";
207 | COPY_PHASE_STRIP = NO;
208 | DEBUG_INFORMATION_FORMAT = dwarf;
209 | ENABLE_STRICT_OBJC_MSGSEND = YES;
210 | ENABLE_TESTABILITY = YES;
211 | GCC_C_LANGUAGE_STANDARD = gnu99;
212 | GCC_DYNAMIC_NO_PIC = NO;
213 | GCC_NO_COMMON_BLOCKS = YES;
214 | GCC_OPTIMIZATION_LEVEL = 0;
215 | GCC_PREPROCESSOR_DEFINITIONS = (
216 | "DEBUG=1",
217 | "$(inherited)",
218 | );
219 | GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
220 | GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
221 | GCC_WARN_UNDECLARED_SELECTOR = YES;
222 | GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
223 | GCC_WARN_UNUSED_FUNCTION = YES;
224 | GCC_WARN_UNUSED_VARIABLE = YES;
225 | MACOSX_DEPLOYMENT_TARGET = 10.12;
226 | MTL_ENABLE_DEBUG_INFO = YES;
227 | ONLY_ACTIVE_ARCH = YES;
228 | SDKROOT = macosx;
229 | };
230 | name = Debug;
231 | };
232 | 1BD1CE541E78EC44009C02A2 /* Release */ = {
233 | isa = XCBuildConfiguration;
234 | buildSettings = {
235 | ALWAYS_SEARCH_USER_PATHS = NO;
236 | CLANG_ANALYZER_NONNULL = YES;
237 | CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
238 | CLANG_CXX_LIBRARY = "libc++";
239 | CLANG_ENABLE_MODULES = YES;
240 | CLANG_ENABLE_OBJC_ARC = YES;
241 | CLANG_WARN_BOOL_CONVERSION = YES;
242 | CLANG_WARN_CONSTANT_CONVERSION = YES;
243 | CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
244 | CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
245 | CLANG_WARN_EMPTY_BODY = YES;
246 | CLANG_WARN_ENUM_CONVERSION = YES;
247 | CLANG_WARN_INFINITE_RECURSION = YES;
248 | CLANG_WARN_INT_CONVERSION = YES;
249 | CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
250 | CLANG_WARN_SUSPICIOUS_MOVE = YES;
251 | CLANG_WARN_UNREACHABLE_CODE = YES;
252 | CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
253 | CODE_SIGN_IDENTITY = "-";
254 | COPY_PHASE_STRIP = NO;
255 | DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
256 | ENABLE_NS_ASSERTIONS = NO;
257 | ENABLE_STRICT_OBJC_MSGSEND = YES;
258 | GCC_C_LANGUAGE_STANDARD = gnu99;
259 | GCC_NO_COMMON_BLOCKS = YES;
260 | GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
261 | GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
262 | GCC_WARN_UNDECLARED_SELECTOR = YES;
263 | GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
264 | GCC_WARN_UNUSED_FUNCTION = YES;
265 | GCC_WARN_UNUSED_VARIABLE = YES;
266 | MACOSX_DEPLOYMENT_TARGET = 10.12;
267 | MTL_ENABLE_DEBUG_INFO = NO;
268 | SDKROOT = macosx;
269 | };
270 | name = Release;
271 | };
272 | 1BD1CE561E78EC44009C02A2 /* Debug */ = {
273 | isa = XCBuildConfiguration;
274 | buildSettings = {
275 | PRODUCT_NAME = "$(TARGET_NAME)";
276 | };
277 | name = Debug;
278 | };
279 | 1BD1CE571E78EC44009C02A2 /* Release */ = {
280 | isa = XCBuildConfiguration;
281 | buildSettings = {
282 | GCC_OPTIMIZATION_LEVEL = fast;
283 | PRODUCT_NAME = "$(TARGET_NAME)";
284 | };
285 | name = Release;
286 | };
287 | /* End XCBuildConfiguration section */
288 |
289 | /* Begin XCConfigurationList section */
290 | 1BD1CE491E78EC44009C02A2 /* Build configuration list for PBXProject "crunch" */ = {
291 | isa = XCConfigurationList;
292 | buildConfigurations = (
293 | 1BD1CE531E78EC44009C02A2 /* Debug */,
294 | 1BD1CE541E78EC44009C02A2 /* Release */,
295 | );
296 | defaultConfigurationIsVisible = 0;
297 | defaultConfigurationName = Release;
298 | };
299 | 1BD1CE551E78EC44009C02A2 /* Build configuration list for PBXNativeTarget "crunch" */ = {
300 | isa = XCConfigurationList;
301 | buildConfigurations = (
302 | 1BD1CE561E78EC44009C02A2 /* Debug */,
303 | 1BD1CE571E78EC44009C02A2 /* Release */,
304 | );
305 | defaultConfigurationIsVisible = 0;
306 | defaultConfigurationName = Release;
307 | };
308 | /* End XCConfigurationList section */
309 | };
310 | rootObject = 1BD1CE461E78EC44009C02A2 /* Project object */;
311 | }
312 |
--------------------------------------------------------------------------------
/crunch.xcodeproj/project.xcworkspace/contents.xcworkspacedata:
--------------------------------------------------------------------------------
1 |
2 |
4 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/crunch.xcodeproj/xcuserdata/ChevyRay.xcuserdatad/xcschemes/crunch.xcscheme:
--------------------------------------------------------------------------------
1 |
2 |
5 |
8 |
9 |
15 |
21 |
22 |
23 |
24 |
25 |
30 |
31 |
32 |
33 |
39 |
40 |
41 |
42 |
43 |
44 |
54 |
56 |
62 |
63 |
64 |
65 |
66 |
67 |
73 |
75 |
81 |
82 |
83 |
84 |
86 |
87 |
90 |
91 |
92 |
--------------------------------------------------------------------------------
/crunch.xcodeproj/xcuserdata/ChevyRay.xcuserdatad/xcschemes/xcschememanagement.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | SchemeUserState
6 |
7 | crunch.xcscheme
8 |
9 | orderHint
10 | 0
11 |
12 |
13 | SuppressBuildableAutocreation
14 |
15 | 1BD1CE4D1E78EC44009C02A2
16 |
17 | primary
18 |
19 |
20 |
21 |
22 |
23 |
--------------------------------------------------------------------------------
/crunch/GuillotineBinPack.cpp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ChevyRay/crunch/a836f6dbaf2af6bd10e1f1bff0c74ad82ceaa913/crunch/GuillotineBinPack.cpp
--------------------------------------------------------------------------------
/crunch/GuillotineBinPack.h:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ChevyRay/crunch/a836f6dbaf2af6bd10e1f1bff0c74ad82ceaa913/crunch/GuillotineBinPack.h
--------------------------------------------------------------------------------
/crunch/MaxRectsBinPack.cpp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ChevyRay/crunch/a836f6dbaf2af6bd10e1f1bff0c74ad82ceaa913/crunch/MaxRectsBinPack.cpp
--------------------------------------------------------------------------------
/crunch/MaxRectsBinPack.h:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ChevyRay/crunch/a836f6dbaf2af6bd10e1f1bff0c74ad82ceaa913/crunch/MaxRectsBinPack.h
--------------------------------------------------------------------------------
/crunch/Rect.cpp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ChevyRay/crunch/a836f6dbaf2af6bd10e1f1bff0c74ad82ceaa913/crunch/Rect.cpp
--------------------------------------------------------------------------------
/crunch/Rect.h:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ChevyRay/crunch/a836f6dbaf2af6bd10e1f1bff0c74ad82ceaa913/crunch/Rect.h
--------------------------------------------------------------------------------
/crunch/binary.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #include "binary.hpp"
28 | #include
29 |
30 | void WriteString(ofstream& bin, const string& value)
31 | {
32 | bin.write(value.data(), value.length() + 1);
33 | }
34 |
35 | void WriteShort(ofstream& bin, int16_t value)
36 | {
37 | bin.put(static_cast(value & 0xff));
38 | bin.put(static_cast((value >> 8) & 0xff));
39 | }
40 |
41 | void WriteByte(ofstream& bin, char value)
42 | {
43 | bin.write(&value, 1);
44 | }
45 |
46 | string ReadString(ifstream& bin)
47 | {
48 | char data[256];
49 | bin.read(data, 1);
50 | char* chr = data;
51 | while (*chr != '\0')
52 | bin.read(++chr, 1);
53 | return data;
54 | }
55 |
56 | int16_t ReadShort(ifstream& bin)
57 | {
58 | int16_t value;
59 | bin.read(reinterpret_cast(&value), 2);
60 | return value;
61 | }
62 |
--------------------------------------------------------------------------------
/crunch/binary.hpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #ifndef binary_hpp
28 | #define binary_hpp
29 |
30 | #include
31 | #include
32 |
33 | using namespace std;
34 |
35 | void WriteString(ofstream& bin, const string& value);
36 | void WriteShort(ofstream& bin, int16_t value);
37 | void WriteByte(ofstream& bin, char value);
38 | string ReadString(ifstream& bin);
39 | int16_t ReadShort(ifstream& bin);
40 |
41 | #endif
42 |
--------------------------------------------------------------------------------
/crunch/bitmap.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #include "bitmap.hpp"
28 | #include
29 | #define LODEPNG_NO_COMPILE_CPP
30 | #include "lodepng.h"
31 | #include
32 | #include "hash.hpp"
33 |
34 | using namespace std;
35 |
36 | Bitmap::Bitmap(const string& file, const string& name, bool premultiply, bool trim)
37 | : name(name)
38 | {
39 | //Load the png file
40 | unsigned char* pdata;
41 | unsigned int pw, ph;
42 | if (lodepng_decode32_file(&pdata, &pw, &ph, file.data()))
43 | {
44 | cerr << "failed to load png: " << file << endl;
45 | exit(EXIT_FAILURE);
46 | }
47 | int w = static_cast(pw);
48 | int h = static_cast(ph);
49 | uint32_t* pixels = reinterpret_cast(pdata);
50 |
51 | //Premultiply all the pixels by their alpha
52 | if (premultiply)
53 | {
54 | int count = w * h;
55 | uint32_t c,a,r,g,b;
56 | float m;
57 | for (int i = 0; i < count; ++i)
58 | {
59 | c = pixels[i];
60 | a = c >> 24;
61 | m = static_cast(a) / 255.0f;
62 | r = static_cast((c & 0xff) * m);
63 | g = static_cast(((c >> 8) & 0xff) * m);
64 | b = static_cast(((c >> 16) & 0xff) * m);
65 | pixels[i] = (a << 24) | (b << 16) | (g << 8) | r;
66 | }
67 | }
68 |
69 | //TODO: skip if all corners contain opaque pixels?
70 |
71 | //Get pixel bounds
72 | int minX = w - 1;
73 | int minY = h - 1;
74 | int maxX = 0;
75 | int maxY = 0;
76 | if (trim)
77 | {
78 | uint32_t p;
79 | for (int y = 0; y < h; ++y)
80 | {
81 | for (int x = 0; x < w; ++x)
82 | {
83 | p = pixels[y * w + x];
84 | if ((p >> 24) > 0)
85 | {
86 | minX = min(x, minX);
87 | minY = min(y, minY);
88 | maxX = max(x, maxX);
89 | maxY = max(y, maxY);
90 | }
91 | }
92 | }
93 | if (maxX < minX || maxY < minY)
94 | {
95 | minX = 0;
96 | minY = 0;
97 | maxX = w - 1;
98 | maxY = h - 1;
99 | cout << "image is completely transparent: " << file << endl;
100 | }
101 | }
102 | else
103 | {
104 | minX = 0;
105 | minY = 0;
106 | maxX = w - 1;
107 | maxY = h - 1;
108 | }
109 |
110 | //Calculate our trimmed size
111 | width = (maxX - minX) + 1;
112 | height = (maxY - minY) + 1;
113 | frameW = w;
114 | frameH = h;
115 |
116 | if (width == w && height == h)
117 | {
118 | //If we aren't trimmed, use the loaded image data
119 | frameX = 0;
120 | frameY = 0;
121 | data = pixels;
122 | }
123 | else
124 | {
125 | //Create the trimmed image data
126 | data = reinterpret_cast(calloc(width * height, sizeof(uint32_t)));
127 | frameX = -minX;
128 | frameY = -minY;
129 |
130 | //Copy trimmed pixels over to the trimmed pixel array
131 | for (int y = minY; y <= maxY; ++y)
132 | for (int x = minX; x <= maxX; ++x)
133 | data[(y - minY) * width + (x - minX)] = pixels[y * w + x];
134 |
135 | //Free the untrimmed pixels
136 | free(pixels);
137 | }
138 |
139 | //Generate a hash for the bitmap
140 | hashValue = 0;
141 | HashCombine(hashValue, static_cast(width));
142 | HashCombine(hashValue, static_cast(height));
143 | HashData(hashValue, reinterpret_cast(data), sizeof(uint32_t) * width * height);
144 | }
145 |
146 | Bitmap::Bitmap(int width, int height)
147 | : width(width), height(height)
148 | {
149 | data = reinterpret_cast(calloc(width * height, sizeof(uint32_t)));
150 | }
151 |
152 | Bitmap::~Bitmap()
153 | {
154 | free(data);
155 | }
156 |
157 | void Bitmap::SaveAs(const string& file)
158 | {
159 | unsigned char* pdata = reinterpret_cast(data);
160 | unsigned int pw = static_cast(width);
161 | unsigned int ph = static_cast(height);
162 | if (lodepng_encode32_file(file.data(), pdata, pw, ph))
163 | {
164 | cout << "failed to save png: " << file << endl;
165 | exit(EXIT_FAILURE);
166 | }
167 | }
168 |
169 | void Bitmap::CopyPixels(const Bitmap* src, int tx, int ty)
170 | {
171 | for (int y = 0; y < src->height; ++y)
172 | for (int x = 0; x < src->width; ++x)
173 | data[(ty + y) * width + (tx + x)] = src->data[y * src->width + x];
174 | }
175 |
176 | void Bitmap::CopyPixelsRot(const Bitmap* src, int tx, int ty)
177 | {
178 | int r = src->height - 1;
179 | for (int y = 0; y < src->width; ++y)
180 | for (int x = 0; x < src->height; ++x)
181 | data[(ty + y) * width + (tx + x)] = src->data[(r - x) * src->width + y];
182 | }
183 |
184 | bool Bitmap::Equals(const Bitmap* other) const
185 | {
186 | if (width == other->width && height == other->height)
187 | return memcmp(data, other->data, sizeof(uint32_t) * width * height) == 0;
188 | return false;
189 | }
190 |
--------------------------------------------------------------------------------
/crunch/bitmap.hpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #ifndef bitmap_hpp
28 | #define bitmap_hpp
29 |
30 | #include
31 | #include
32 | #include
33 |
34 | using namespace std;
35 |
36 | struct Bitmap
37 | {
38 | string name;
39 | int width;
40 | int height;
41 | int frameX;
42 | int frameY;
43 | int frameW;
44 | int frameH;
45 | uint32_t* data;
46 | size_t hashValue;
47 | Bitmap(const string& file, const string& name, bool premultiply, bool trim);
48 | Bitmap(int width, int height);
49 | ~Bitmap();
50 | void SaveAs(const string& file);
51 | void CopyPixels(const Bitmap* src, int tx, int ty);
52 | void CopyPixelsRot(const Bitmap* src, int tx, int ty);
53 | bool Equals(const Bitmap* other) const;
54 | };
55 |
56 | #endif
57 |
--------------------------------------------------------------------------------
/crunch/hash.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #include "hash.hpp"
28 | #include
29 | #include
30 | #include
31 | #include
32 | #include "tinydir.h"
33 | #include "str.hpp"
34 |
35 | template
36 | void HashCombine(std::size_t& hash, const T& v)
37 | {
38 | std::hash hasher;
39 | hash ^= hasher(v) + 0x9e3779b9 + (hash<<6) + (hash>>2);
40 | }
41 | void HashCombine(std::size_t& hash, size_t v)
42 | {
43 | hash ^= v + 0x9e3779b9 + (hash<<6) + (hash>>2);
44 | }
45 |
46 | void HashString(size_t& hash, const string& str)
47 | {
48 | HashCombine(hash, str);
49 | }
50 |
51 | void HashFile(size_t& hash, const string& file)
52 | {
53 | ifstream stream(file, ios::binary | ios::ate);
54 | streamsize size = stream.tellg();
55 | stream.seekg(0, ios::beg);
56 | vector buffer(size + 1);
57 | if (!stream.read(buffer.data(), size))
58 | {
59 | cerr << "failed to read file: " << file << endl;
60 | exit(EXIT_FAILURE);
61 | }
62 | buffer[size] = '\0';
63 | string text(buffer.begin(), buffer.end());
64 | HashCombine(hash, text);
65 | }
66 |
67 | void HashFiles(size_t& hash, const string& root)
68 | {
69 | static string dot1 = ".";
70 | static string dot2 = "..";
71 |
72 | tinydir_dir dir;
73 | tinydir_open(&dir, StrToPath(root).data());
74 |
75 | while (dir.has_next)
76 | {
77 | tinydir_file file;
78 | tinydir_readfile(&dir, &file);
79 |
80 | if (file.is_dir)
81 | {
82 | if (dot1 != PathToStr(file.name) && dot2 != PathToStr(file.name))
83 | HashFiles(hash, PathToStr(file.path));
84 | }
85 | else if (PathToStr(file.extension) == "png")
86 | HashFile(hash, PathToStr(file.path));
87 |
88 | tinydir_next(&dir);
89 | }
90 |
91 | tinydir_close(&dir);
92 | }
93 |
94 | void HashData(size_t& hash, const char* data, size_t size)
95 | {
96 | string str(data, size);
97 | HashCombine(hash, str);
98 | }
99 |
100 | bool LoadHash(size_t& hash, const string& file)
101 | {
102 | ifstream stream(file);
103 | if (stream)
104 | {
105 | stringstream ss;
106 | ss << stream.rdbuf();
107 | ss >> hash;
108 | return true;
109 | }
110 | return false;
111 | }
112 |
113 | void SaveHash(size_t hash, const string& file)
114 | {
115 | ofstream stream(file);
116 | stream << hash;
117 | }
118 |
--------------------------------------------------------------------------------
/crunch/hash.hpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #ifndef hash_hpp
28 | #define hash_hpp
29 |
30 | #include
31 | using namespace std;
32 |
33 | template
34 | void HashCombine(std::size_t& hash, const T& v);
35 | void HashCombine(std::size_t& hash, size_t v);
36 | void HashString(size_t& hash, const string& str);
37 | void HashFile(size_t& hash, const string& file);
38 | void HashFiles(size_t& hash, const string& root);
39 | void HashData(size_t& hash, const char* data, size_t size);
40 | bool LoadHash(size_t& hash, const string& file);
41 | void SaveHash(size_t hash, const string& file);
42 |
43 | #endif
44 |
--------------------------------------------------------------------------------
/crunch/lodepng.h:
--------------------------------------------------------------------------------
1 | /*
2 | LodePNG version 20161127
3 |
4 | Copyright (c) 2005-2016 Lode Vandevenne
5 |
6 | This software is provided 'as-is', without any express or implied
7 | warranty. In no event will the authors be held liable for any damages
8 | arising from the use of this software.
9 |
10 | Permission is granted to anyone to use this software for any purpose,
11 | including commercial applications, and to alter it and redistribute it
12 | freely, subject to the following restrictions:
13 |
14 | 1. The origin of this software must not be misrepresented; you must not
15 | claim that you wrote the original software. If you use this software
16 | in a product, an acknowledgment in the product documentation would be
17 | appreciated but is not required.
18 |
19 | 2. Altered source versions must be plainly marked as such, and must not be
20 | misrepresented as being the original software.
21 |
22 | 3. This notice may not be removed or altered from any source
23 | distribution.
24 | */
25 |
26 | #ifndef LODEPNG_H
27 | #define LODEPNG_H
28 |
29 | #include /*for size_t*/
30 |
31 | extern const char* LODEPNG_VERSION_STRING;
32 |
33 | /*
34 | The following #defines are used to create code sections. They can be disabled
35 | to disable code sections, which can give faster compile time and smaller binary.
36 | The "NO_COMPILE" defines are designed to be used to pass as defines to the
37 | compiler command to disable them without modifying this header, e.g.
38 | -DLODEPNG_NO_COMPILE_ZLIB for gcc.
39 | In addition to those below, you can also define LODEPNG_NO_COMPILE_CRC to
40 | allow implementing a custom lodepng_crc32.
41 | */
42 | /*deflate & zlib. If disabled, you must specify alternative zlib functions in
43 | the custom_zlib field of the compress and decompress settings*/
44 | #ifndef LODEPNG_NO_COMPILE_ZLIB
45 | #define LODEPNG_COMPILE_ZLIB
46 | #endif
47 | /*png encoder and png decoder*/
48 | #ifndef LODEPNG_NO_COMPILE_PNG
49 | #define LODEPNG_COMPILE_PNG
50 | #endif
51 | /*deflate&zlib decoder and png decoder*/
52 | #ifndef LODEPNG_NO_COMPILE_DECODER
53 | #define LODEPNG_COMPILE_DECODER
54 | #endif
55 | /*deflate&zlib encoder and png encoder*/
56 | #ifndef LODEPNG_NO_COMPILE_ENCODER
57 | #define LODEPNG_COMPILE_ENCODER
58 | #endif
59 | /*the optional built in harddisk file loading and saving functions*/
60 | #ifndef LODEPNG_NO_COMPILE_DISK
61 | #define LODEPNG_COMPILE_DISK
62 | #endif
63 | /*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/
64 | #ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS
65 | #define LODEPNG_COMPILE_ANCILLARY_CHUNKS
66 | #endif
67 | /*ability to convert error numerical codes to English text string*/
68 | #ifndef LODEPNG_NO_COMPILE_ERROR_TEXT
69 | #define LODEPNG_COMPILE_ERROR_TEXT
70 | #endif
71 | /*Compile the default allocators (C's free, malloc and realloc). If you disable this,
72 | you can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your
73 | source files with custom allocators.*/
74 | #ifndef LODEPNG_NO_COMPILE_ALLOCATORS
75 | #define LODEPNG_COMPILE_ALLOCATORS
76 | #endif
77 | /*compile the C++ version (you can disable the C++ wrapper here even when compiling for C++)*/
78 | #ifdef __cplusplus
79 | #ifndef LODEPNG_NO_COMPILE_CPP
80 | #define LODEPNG_COMPILE_CPP
81 | #endif
82 | #endif
83 |
84 | #ifdef LODEPNG_COMPILE_CPP
85 | #include
86 | #include
87 | #endif /*LODEPNG_COMPILE_CPP*/
88 |
89 | #ifdef LODEPNG_COMPILE_PNG
90 | /*The PNG color types (also used for raw).*/
91 | typedef enum LodePNGColorType
92 | {
93 | LCT_GREY = 0, /*greyscale: 1,2,4,8,16 bit*/
94 | LCT_RGB = 2, /*RGB: 8,16 bit*/
95 | LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/
96 | LCT_GREY_ALPHA = 4, /*greyscale with alpha: 8,16 bit*/
97 | LCT_RGBA = 6 /*RGB with alpha: 8,16 bit*/
98 | } LodePNGColorType;
99 |
100 | #ifdef LODEPNG_COMPILE_DECODER
101 | /*
102 | Converts PNG data in memory to raw pixel data.
103 | out: Output parameter. Pointer to buffer that will contain the raw pixel data.
104 | After decoding, its size is w * h * (bytes per pixel) bytes larger than
105 | initially. Bytes per pixel depends on colortype and bitdepth.
106 | Must be freed after usage with free(*out).
107 | Note: for 16-bit per channel colors, uses big endian format like PNG does.
108 | w: Output parameter. Pointer to width of pixel data.
109 | h: Output parameter. Pointer to height of pixel data.
110 | in: Memory buffer with the PNG file.
111 | insize: size of the in buffer.
112 | colortype: the desired color type for the raw output image. See explanation on PNG color types.
113 | bitdepth: the desired bit depth for the raw output image. See explanation on PNG color types.
114 | Return value: LodePNG error code (0 means no error).
115 | */
116 | unsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h,
117 | const unsigned char* in, size_t insize,
118 | LodePNGColorType colortype, unsigned bitdepth);
119 |
120 | /*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/
121 | unsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h,
122 | const unsigned char* in, size_t insize);
123 |
124 | /*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/
125 | unsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h,
126 | const unsigned char* in, size_t insize);
127 |
128 | #ifdef LODEPNG_COMPILE_DISK
129 | /*
130 | Load PNG from disk, from file with given name.
131 | Same as the other decode functions, but instead takes a filename as input.
132 | */
133 | unsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h,
134 | const char* filename,
135 | LodePNGColorType colortype, unsigned bitdepth);
136 |
137 | /*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.*/
138 | unsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h,
139 | const char* filename);
140 |
141 | /*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.*/
142 | unsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h,
143 | const char* filename);
144 | #endif /*LODEPNG_COMPILE_DISK*/
145 | #endif /*LODEPNG_COMPILE_DECODER*/
146 |
147 |
148 | #ifdef LODEPNG_COMPILE_ENCODER
149 | /*
150 | Converts raw pixel data into a PNG image in memory. The colortype and bitdepth
151 | of the output PNG image cannot be chosen, they are automatically determined
152 | by the colortype, bitdepth and content of the input pixel data.
153 | Note: for 16-bit per channel colors, needs big endian format like PNG does.
154 | out: Output parameter. Pointer to buffer that will contain the PNG image data.
155 | Must be freed after usage with free(*out).
156 | outsize: Output parameter. Pointer to the size in bytes of the out buffer.
157 | image: The raw pixel data to encode. The size of this buffer should be
158 | w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth.
159 | w: width of the raw pixel data in pixels.
160 | h: height of the raw pixel data in pixels.
161 | colortype: the color type of the raw input image. See explanation on PNG color types.
162 | bitdepth: the bit depth of the raw input image. See explanation on PNG color types.
163 | Return value: LodePNG error code (0 means no error).
164 | */
165 | unsigned lodepng_encode_memory(unsigned char** out, size_t* outsize,
166 | const unsigned char* image, unsigned w, unsigned h,
167 | LodePNGColorType colortype, unsigned bitdepth);
168 |
169 | /*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/
170 | unsigned lodepng_encode32(unsigned char** out, size_t* outsize,
171 | const unsigned char* image, unsigned w, unsigned h);
172 |
173 | /*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/
174 | unsigned lodepng_encode24(unsigned char** out, size_t* outsize,
175 | const unsigned char* image, unsigned w, unsigned h);
176 |
177 | #ifdef LODEPNG_COMPILE_DISK
178 | /*
179 | Converts raw pixel data into a PNG file on disk.
180 | Same as the other encode functions, but instead takes a filename as output.
181 | NOTE: This overwrites existing files without warning!
182 | */
183 | unsigned lodepng_encode_file(const char* filename,
184 | const unsigned char* image, unsigned w, unsigned h,
185 | LodePNGColorType colortype, unsigned bitdepth);
186 |
187 | /*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.*/
188 | unsigned lodepng_encode32_file(const char* filename,
189 | const unsigned char* image, unsigned w, unsigned h);
190 |
191 | /*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.*/
192 | unsigned lodepng_encode24_file(const char* filename,
193 | const unsigned char* image, unsigned w, unsigned h);
194 | #endif /*LODEPNG_COMPILE_DISK*/
195 | #endif /*LODEPNG_COMPILE_ENCODER*/
196 |
197 |
198 | #ifdef LODEPNG_COMPILE_CPP
199 | namespace lodepng
200 | {
201 | #ifdef LODEPNG_COMPILE_DECODER
202 | /*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype
203 | is the format to output the pixels to. Default is RGBA 8-bit per channel.*/
204 | unsigned decode(std::vector& out, unsigned& w, unsigned& h,
205 | const unsigned char* in, size_t insize,
206 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
207 | unsigned decode(std::vector& out, unsigned& w, unsigned& h,
208 | const std::vector& in,
209 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
210 | #ifdef LODEPNG_COMPILE_DISK
211 | /*
212 | Converts PNG file from disk to raw pixel data in memory.
213 | Same as the other decode functions, but instead takes a filename as input.
214 | */
215 | unsigned decode(std::vector& out, unsigned& w, unsigned& h,
216 | const std::string& filename,
217 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
218 | #endif /* LODEPNG_COMPILE_DISK */
219 | #endif /* LODEPNG_COMPILE_DECODER */
220 |
221 | #ifdef LODEPNG_COMPILE_ENCODER
222 | /*Same as lodepng_encode_memory, but encodes to an std::vector. colortype
223 | is that of the raw input data. The output PNG color type will be auto chosen.*/
224 | unsigned encode(std::vector& out,
225 | const unsigned char* in, unsigned w, unsigned h,
226 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
227 | unsigned encode(std::vector& out,
228 | const std::vector& in, unsigned w, unsigned h,
229 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
230 | #ifdef LODEPNG_COMPILE_DISK
231 | /*
232 | Converts 32-bit RGBA raw pixel data into a PNG file on disk.
233 | Same as the other encode functions, but instead takes a filename as output.
234 | NOTE: This overwrites existing files without warning!
235 | */
236 | unsigned encode(const std::string& filename,
237 | const unsigned char* in, unsigned w, unsigned h,
238 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
239 | unsigned encode(const std::string& filename,
240 | const std::vector& in, unsigned w, unsigned h,
241 | LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
242 | #endif /* LODEPNG_COMPILE_DISK */
243 | #endif /* LODEPNG_COMPILE_ENCODER */
244 | } /* namespace lodepng */
245 | #endif /*LODEPNG_COMPILE_CPP*/
246 | #endif /*LODEPNG_COMPILE_PNG*/
247 |
248 | #ifdef LODEPNG_COMPILE_ERROR_TEXT
249 | /*Returns an English description of the numerical error code.*/
250 | const char* lodepng_error_text(unsigned code);
251 | #endif /*LODEPNG_COMPILE_ERROR_TEXT*/
252 |
253 | #ifdef LODEPNG_COMPILE_DECODER
254 | /*Settings for zlib decompression*/
255 | typedef struct LodePNGDecompressSettings LodePNGDecompressSettings;
256 | struct LodePNGDecompressSettings
257 | {
258 | unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/
259 |
260 | /*use custom zlib decoder instead of built in one (default: null)*/
261 | unsigned (*custom_zlib)(unsigned char**, size_t*,
262 | const unsigned char*, size_t,
263 | const LodePNGDecompressSettings*);
264 | /*use custom deflate decoder instead of built in one (default: null)
265 | if custom_zlib is used, custom_deflate is ignored since only the built in
266 | zlib function will call custom_deflate*/
267 | unsigned (*custom_inflate)(unsigned char**, size_t*,
268 | const unsigned char*, size_t,
269 | const LodePNGDecompressSettings*);
270 |
271 | const void* custom_context; /*optional custom settings for custom functions*/
272 | };
273 |
274 | extern const LodePNGDecompressSettings lodepng_default_decompress_settings;
275 | void lodepng_decompress_settings_init(LodePNGDecompressSettings* settings);
276 | #endif /*LODEPNG_COMPILE_DECODER*/
277 |
278 | #ifdef LODEPNG_COMPILE_ENCODER
279 | /*
280 | Settings for zlib compression. Tweaking these settings tweaks the balance
281 | between speed and compression ratio.
282 | */
283 | typedef struct LodePNGCompressSettings LodePNGCompressSettings;
284 | struct LodePNGCompressSettings /*deflate = compress*/
285 | {
286 | /*LZ77 related settings*/
287 | unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/
288 | unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/
289 | unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/
290 | unsigned minmatch; /*mininum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/
291 | unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/
292 | unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/
293 |
294 | /*use custom zlib encoder instead of built in one (default: null)*/
295 | unsigned (*custom_zlib)(unsigned char**, size_t*,
296 | const unsigned char*, size_t,
297 | const LodePNGCompressSettings*);
298 | /*use custom deflate encoder instead of built in one (default: null)
299 | if custom_zlib is used, custom_deflate is ignored since only the built in
300 | zlib function will call custom_deflate*/
301 | unsigned (*custom_deflate)(unsigned char**, size_t*,
302 | const unsigned char*, size_t,
303 | const LodePNGCompressSettings*);
304 |
305 | const void* custom_context; /*optional custom settings for custom functions*/
306 | };
307 |
308 | extern const LodePNGCompressSettings lodepng_default_compress_settings;
309 | void lodepng_compress_settings_init(LodePNGCompressSettings* settings);
310 | #endif /*LODEPNG_COMPILE_ENCODER*/
311 |
312 | #ifdef LODEPNG_COMPILE_PNG
313 | /*
314 | Color mode of an image. Contains all information required to decode the pixel
315 | bits to RGBA colors. This information is the same as used in the PNG file
316 | format, and is used both for PNG and raw image data in LodePNG.
317 | */
318 | typedef struct LodePNGColorMode
319 | {
320 | /*header (IHDR)*/
321 | LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/
322 | unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/
323 |
324 | /*
325 | palette (PLTE and tRNS)
326 |
327 | Dynamically allocated with the colors of the palette, including alpha.
328 | When encoding a PNG, to store your colors in the palette of the LodePNGColorMode, first use
329 | lodepng_palette_clear, then for each color use lodepng_palette_add.
330 | If you encode an image without alpha with palette, don't forget to put value 255 in each A byte of the palette.
331 |
332 | When decoding, by default you can ignore this palette, since LodePNG already
333 | fills the palette colors in the pixels of the raw RGBA output.
334 |
335 | The palette is only supported for color type 3.
336 | */
337 | unsigned char* palette; /*palette in RGBARGBA... order. When allocated, must be either 0, or have size 1024*/
338 | size_t palettesize; /*palette size in number of colors (amount of bytes is 4 * palettesize)*/
339 |
340 | /*
341 | transparent color key (tRNS)
342 |
343 | This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit.
344 | For greyscale PNGs, r, g and b will all 3 be set to the same.
345 |
346 | When decoding, by default you can ignore this information, since LodePNG sets
347 | pixels with this key to transparent already in the raw RGBA output.
348 |
349 | The color key is only supported for color types 0 and 2.
350 | */
351 | unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/
352 | unsigned key_r; /*red/greyscale component of color key*/
353 | unsigned key_g; /*green component of color key*/
354 | unsigned key_b; /*blue component of color key*/
355 | } LodePNGColorMode;
356 |
357 | /*init, cleanup and copy functions to use with this struct*/
358 | void lodepng_color_mode_init(LodePNGColorMode* info);
359 | void lodepng_color_mode_cleanup(LodePNGColorMode* info);
360 | /*return value is error code (0 means no error)*/
361 | unsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source);
362 |
363 | void lodepng_palette_clear(LodePNGColorMode* info);
364 | /*add 1 color to the palette*/
365 | unsigned lodepng_palette_add(LodePNGColorMode* info,
366 | unsigned char r, unsigned char g, unsigned char b, unsigned char a);
367 |
368 | /*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/
369 | unsigned lodepng_get_bpp(const LodePNGColorMode* info);
370 | /*get the amount of color channels used, based on colortype in the struct.
371 | If a palette is used, it counts as 1 channel.*/
372 | unsigned lodepng_get_channels(const LodePNGColorMode* info);
373 | /*is it a greyscale type? (only colortype 0 or 4)*/
374 | unsigned lodepng_is_greyscale_type(const LodePNGColorMode* info);
375 | /*has it got an alpha channel? (only colortype 2 or 6)*/
376 | unsigned lodepng_is_alpha_type(const LodePNGColorMode* info);
377 | /*has it got a palette? (only colortype 3)*/
378 | unsigned lodepng_is_palette_type(const LodePNGColorMode* info);
379 | /*only returns true if there is a palette and there is a value in the palette with alpha < 255.
380 | Loops through the palette to check this.*/
381 | unsigned lodepng_has_palette_alpha(const LodePNGColorMode* info);
382 | /*
383 | Check if the given color info indicates the possibility of having non-opaque pixels in the PNG image.
384 | Returns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels).
385 | Returns false if the image can only have opaque pixels.
386 | In detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values,
387 | or if "key_defined" is true.
388 | */
389 | unsigned lodepng_can_have_alpha(const LodePNGColorMode* info);
390 | /*Returns the byte size of a raw image buffer with given width, height and color mode*/
391 | size_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color);
392 |
393 | #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
394 | /*The information of a Time chunk in PNG.*/
395 | typedef struct LodePNGTime
396 | {
397 | unsigned year; /*2 bytes used (0-65535)*/
398 | unsigned month; /*1-12*/
399 | unsigned day; /*1-31*/
400 | unsigned hour; /*0-23*/
401 | unsigned minute; /*0-59*/
402 | unsigned second; /*0-60 (to allow for leap seconds)*/
403 | } LodePNGTime;
404 | #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
405 |
406 | /*Information about the PNG image, except pixels, width and height.*/
407 | typedef struct LodePNGInfo
408 | {
409 | /*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/
410 | unsigned compression_method;/*compression method of the original file. Always 0.*/
411 | unsigned filter_method; /*filter method of the original file*/
412 | unsigned interlace_method; /*interlace method of the original file*/
413 | LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/
414 |
415 | #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
416 | /*
417 | suggested background color chunk (bKGD)
418 | This color uses the same color mode as the PNG (except alpha channel), which can be 1-bit to 16-bit.
419 |
420 | For greyscale PNGs, r, g and b will all 3 be set to the same. When encoding
421 | the encoder writes the red one. For palette PNGs: When decoding, the RGB value
422 | will be stored, not a palette index. But when encoding, specify the index of
423 | the palette in background_r, the other two are then ignored.
424 |
425 | The decoder does not use this background color to edit the color of pixels.
426 | */
427 | unsigned background_defined; /*is a suggested background color given?*/
428 | unsigned background_r; /*red component of suggested background color*/
429 | unsigned background_g; /*green component of suggested background color*/
430 | unsigned background_b; /*blue component of suggested background color*/
431 |
432 | /*
433 | non-international text chunks (tEXt and zTXt)
434 |
435 | The char** arrays each contain num strings. The actual messages are in
436 | text_strings, while text_keys are keywords that give a short description what
437 | the actual text represents, e.g. Title, Author, Description, or anything else.
438 |
439 | A keyword is minimum 1 character and maximum 79 characters long. It's
440 | discouraged to use a single line length longer than 79 characters for texts.
441 |
442 | Don't allocate these text buffers yourself. Use the init/cleanup functions
443 | correctly and use lodepng_add_text and lodepng_clear_text.
444 | */
445 | size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/
446 | char** text_keys; /*the keyword of a text chunk (e.g. "Comment")*/
447 | char** text_strings; /*the actual text*/
448 |
449 | /*
450 | international text chunks (iTXt)
451 | Similar to the non-international text chunks, but with additional strings
452 | "langtags" and "transkeys".
453 | */
454 | size_t itext_num; /*the amount of international texts in this PNG*/
455 | char** itext_keys; /*the English keyword of the text chunk (e.g. "Comment")*/
456 | char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/
457 | char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/
458 | char** itext_strings; /*the actual international text - UTF-8 string*/
459 |
460 | /*time chunk (tIME)*/
461 | unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/
462 | LodePNGTime time;
463 |
464 | /*phys chunk (pHYs)*/
465 | unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/
466 | unsigned phys_x; /*pixels per unit in x direction*/
467 | unsigned phys_y; /*pixels per unit in y direction*/
468 | unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/
469 |
470 | /*
471 | unknown chunks
472 | There are 3 buffers, one for each position in the PNG where unknown chunks can appear
473 | each buffer contains all unknown chunks for that position consecutively
474 | The 3 buffers are the unknown chunks between certain critical chunks:
475 | 0: IHDR-PLTE, 1: PLTE-IDAT, 2: IDAT-IEND
476 | Do not allocate or traverse this data yourself. Use the chunk traversing functions declared
477 | later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct.
478 | */
479 | unsigned char* unknown_chunks_data[3];
480 | size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/
481 | #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
482 | } LodePNGInfo;
483 |
484 | /*init, cleanup and copy functions to use with this struct*/
485 | void lodepng_info_init(LodePNGInfo* info);
486 | void lodepng_info_cleanup(LodePNGInfo* info);
487 | /*return value is error code (0 means no error)*/
488 | unsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source);
489 |
490 | #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
491 | void lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/
492 | unsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/
493 |
494 | void lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/
495 | unsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag,
496 | const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/
497 | #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
498 |
499 | /*
500 | Converts raw buffer from one color type to another color type, based on
501 | LodePNGColorMode structs to describe the input and output color type.
502 | See the reference manual at the end of this header file to see which color conversions are supported.
503 | return value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported)
504 | The out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel
505 | of the output color type (lodepng_get_bpp).
506 | For < 8 bpp images, there should not be padding bits at the end of scanlines.
507 | For 16-bit per channel colors, uses big endian format like PNG does.
508 | Return value is LodePNG error code
509 | */
510 | unsigned lodepng_convert(unsigned char* out, const unsigned char* in,
511 | const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in,
512 | unsigned w, unsigned h);
513 |
514 | #ifdef LODEPNG_COMPILE_DECODER
515 | /*
516 | Settings for the decoder. This contains settings for the PNG and the Zlib
517 | decoder, but not the Info settings from the Info structs.
518 | */
519 | typedef struct LodePNGDecoderSettings
520 | {
521 | LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/
522 |
523 | unsigned ignore_crc; /*ignore CRC checksums*/
524 |
525 | unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/
526 |
527 | #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
528 | unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/
529 | /*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/
530 | unsigned remember_unknown_chunks;
531 | #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
532 | } LodePNGDecoderSettings;
533 |
534 | void lodepng_decoder_settings_init(LodePNGDecoderSettings* settings);
535 | #endif /*LODEPNG_COMPILE_DECODER*/
536 |
537 | #ifdef LODEPNG_COMPILE_ENCODER
538 | /*automatically use color type with less bits per pixel if losslessly possible. Default: AUTO*/
539 | typedef enum LodePNGFilterStrategy
540 | {
541 | /*every filter at zero*/
542 | LFS_ZERO,
543 | /*Use filter that gives minimum sum, as described in the official PNG filter heuristic.*/
544 | LFS_MINSUM,
545 | /*Use the filter type that gives smallest Shannon entropy for this scanline. Depending
546 | on the image, this is better or worse than minsum.*/
547 | LFS_ENTROPY,
548 | /*
549 | Brute-force-search PNG filters by compressing each filter for each scanline.
550 | Experimental, very slow, and only rarely gives better compression than MINSUM.
551 | */
552 | LFS_BRUTE_FORCE,
553 | /*use predefined_filters buffer: you specify the filter type for each scanline*/
554 | LFS_PREDEFINED
555 | } LodePNGFilterStrategy;
556 |
557 | /*Gives characteristics about the colors of the image, which helps decide which color model to use for encoding.
558 | Used internally by default if "auto_convert" is enabled. Public because it's useful for custom algorithms.*/
559 | typedef struct LodePNGColorProfile
560 | {
561 | unsigned colored; /*not greyscale*/
562 | unsigned key; /*image is not opaque and color key is possible instead of full alpha*/
563 | unsigned short key_r; /*key values, always as 16-bit, in 8-bit case the byte is duplicated, e.g. 65535 means 255*/
564 | unsigned short key_g;
565 | unsigned short key_b;
566 | unsigned alpha; /*image is not opaque and alpha channel or alpha palette required*/
567 | unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16.*/
568 | unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order*/
569 | unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for greyscale only. 16 if 16-bit per channel required.*/
570 | } LodePNGColorProfile;
571 |
572 | void lodepng_color_profile_init(LodePNGColorProfile* profile);
573 |
574 | /*Get a LodePNGColorProfile of the image.*/
575 | unsigned lodepng_get_color_profile(LodePNGColorProfile* profile,
576 | const unsigned char* image, unsigned w, unsigned h,
577 | const LodePNGColorMode* mode_in);
578 | /*The function LodePNG uses internally to decide the PNG color with auto_convert.
579 | Chooses an optimal color model, e.g. grey if only grey pixels, palette if < 256 colors, ...*/
580 | unsigned lodepng_auto_choose_color(LodePNGColorMode* mode_out,
581 | const unsigned char* image, unsigned w, unsigned h,
582 | const LodePNGColorMode* mode_in);
583 |
584 | /*Settings for the encoder.*/
585 | typedef struct LodePNGEncoderSettings
586 | {
587 | LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/
588 |
589 | unsigned auto_convert; /*automatically choose output PNG color type. Default: true*/
590 |
591 | /*If true, follows the official PNG heuristic: if the PNG uses a palette or lower than
592 | 8 bit depth, set all filters to zero. Otherwise use the filter_strategy. Note that to
593 | completely follow the official PNG heuristic, filter_palette_zero must be true and
594 | filter_strategy must be LFS_MINSUM*/
595 | unsigned filter_palette_zero;
596 | /*Which filter strategy to use when not using zeroes due to filter_palette_zero.
597 | Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/
598 | LodePNGFilterStrategy filter_strategy;
599 | /*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with
600 | the same length as the amount of scanlines in the image, and each value must <= 5. You
601 | have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero
602 | must be set to 0 to ensure this is also used on palette or low bitdepth images.*/
603 | const unsigned char* predefined_filters;
604 |
605 | /*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette).
606 | If colortype is 3, PLTE is _always_ created.*/
607 | unsigned force_palette;
608 | #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
609 | /*add LodePNG identifier and version as a text chunk, for debugging*/
610 | unsigned add_id;
611 | /*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/
612 | unsigned text_compression;
613 | #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
614 | } LodePNGEncoderSettings;
615 |
616 | void lodepng_encoder_settings_init(LodePNGEncoderSettings* settings);
617 | #endif /*LODEPNG_COMPILE_ENCODER*/
618 |
619 |
620 | #if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER)
621 | /*The settings, state and information for extended encoding and decoding.*/
622 | typedef struct LodePNGState
623 | {
624 | #ifdef LODEPNG_COMPILE_DECODER
625 | LodePNGDecoderSettings decoder; /*the decoding settings*/
626 | #endif /*LODEPNG_COMPILE_DECODER*/
627 | #ifdef LODEPNG_COMPILE_ENCODER
628 | LodePNGEncoderSettings encoder; /*the encoding settings*/
629 | #endif /*LODEPNG_COMPILE_ENCODER*/
630 | LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/
631 | LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/
632 | unsigned error;
633 | #ifdef LODEPNG_COMPILE_CPP
634 | /* For the lodepng::State subclass. */
635 | virtual ~LodePNGState(){}
636 | #endif
637 | } LodePNGState;
638 |
639 | /*init, cleanup and copy functions to use with this struct*/
640 | void lodepng_state_init(LodePNGState* state);
641 | void lodepng_state_cleanup(LodePNGState* state);
642 | void lodepng_state_copy(LodePNGState* dest, const LodePNGState* source);
643 | #endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */
644 |
645 | #ifdef LODEPNG_COMPILE_DECODER
646 | /*
647 | Same as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and
648 | getting much more information about the PNG image and color mode.
649 | */
650 | unsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h,
651 | LodePNGState* state,
652 | const unsigned char* in, size_t insize);
653 |
654 | /*
655 | Read the PNG header, but not the actual data. This returns only the information
656 | that is in the header chunk of the PNG, such as width, height and color type. The
657 | information is placed in the info_png field of the LodePNGState.
658 | */
659 | unsigned lodepng_inspect(unsigned* w, unsigned* h,
660 | LodePNGState* state,
661 | const unsigned char* in, size_t insize);
662 | #endif /*LODEPNG_COMPILE_DECODER*/
663 |
664 |
665 | #ifdef LODEPNG_COMPILE_ENCODER
666 | /*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/
667 | unsigned lodepng_encode(unsigned char** out, size_t* outsize,
668 | const unsigned char* image, unsigned w, unsigned h,
669 | LodePNGState* state);
670 | #endif /*LODEPNG_COMPILE_ENCODER*/
671 |
672 | /*
673 | The lodepng_chunk functions are normally not needed, except to traverse the
674 | unknown chunks stored in the LodePNGInfo struct, or add new ones to it.
675 | It also allows traversing the chunks of an encoded PNG file yourself.
676 |
677 | PNG standard chunk naming conventions:
678 | First byte: uppercase = critical, lowercase = ancillary
679 | Second byte: uppercase = public, lowercase = private
680 | Third byte: must be uppercase
681 | Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy
682 | */
683 |
684 | /*
685 | Gets the length of the data of the chunk. Total chunk length has 12 bytes more.
686 | There must be at least 4 bytes to read from. If the result value is too large,
687 | it may be corrupt data.
688 | */
689 | unsigned lodepng_chunk_length(const unsigned char* chunk);
690 |
691 | /*puts the 4-byte type in null terminated string*/
692 | void lodepng_chunk_type(char type[5], const unsigned char* chunk);
693 |
694 | /*check if the type is the given type*/
695 | unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type);
696 |
697 | /*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/
698 | unsigned char lodepng_chunk_ancillary(const unsigned char* chunk);
699 |
700 | /*0: public, 1: private (see PNG standard)*/
701 | unsigned char lodepng_chunk_private(const unsigned char* chunk);
702 |
703 | /*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/
704 | unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk);
705 |
706 | /*get pointer to the data of the chunk, where the input points to the header of the chunk*/
707 | unsigned char* lodepng_chunk_data(unsigned char* chunk);
708 | const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk);
709 |
710 | /*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/
711 | unsigned lodepng_chunk_check_crc(const unsigned char* chunk);
712 |
713 | /*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/
714 | void lodepng_chunk_generate_crc(unsigned char* chunk);
715 |
716 | /*iterate to next chunks. don't use on IEND chunk, as there is no next chunk then*/
717 | unsigned char* lodepng_chunk_next(unsigned char* chunk);
718 | const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk);
719 |
720 | /*
721 | Appends chunk to the data in out. The given chunk should already have its chunk header.
722 | The out variable and outlength are updated to reflect the new reallocated buffer.
723 | Returns error code (0 if it went ok)
724 | */
725 | unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk);
726 |
727 | /*
728 | Appends new chunk to out. The chunk to append is given by giving its length, type
729 | and data separately. The type is a 4-letter string.
730 | The out variable and outlength are updated to reflect the new reallocated buffer.
731 | Returne error code (0 if it went ok)
732 | */
733 | unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length,
734 | const char* type, const unsigned char* data);
735 |
736 |
737 | /*Calculate CRC32 of buffer*/
738 | unsigned lodepng_crc32(const unsigned char* buf, size_t len);
739 | #endif /*LODEPNG_COMPILE_PNG*/
740 |
741 |
742 | #ifdef LODEPNG_COMPILE_ZLIB
743 | /*
744 | This zlib part can be used independently to zlib compress and decompress a
745 | buffer. It cannot be used to create gzip files however, and it only supports the
746 | part of zlib that is required for PNG, it does not support dictionaries.
747 | */
748 |
749 | #ifdef LODEPNG_COMPILE_DECODER
750 | /*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/
751 | unsigned lodepng_inflate(unsigned char** out, size_t* outsize,
752 | const unsigned char* in, size_t insize,
753 | const LodePNGDecompressSettings* settings);
754 |
755 | /*
756 | Decompresses Zlib data. Reallocates the out buffer and appends the data. The
757 | data must be according to the zlib specification.
758 | Either, *out must be NULL and *outsize must be 0, or, *out must be a valid
759 | buffer and *outsize its size in bytes. out must be freed by user after usage.
760 | */
761 | unsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize,
762 | const unsigned char* in, size_t insize,
763 | const LodePNGDecompressSettings* settings);
764 | #endif /*LODEPNG_COMPILE_DECODER*/
765 |
766 | #ifdef LODEPNG_COMPILE_ENCODER
767 | /*
768 | Compresses data with Zlib. Reallocates the out buffer and appends the data.
769 | Zlib adds a small header and trailer around the deflate data.
770 | The data is output in the format of the zlib specification.
771 | Either, *out must be NULL and *outsize must be 0, or, *out must be a valid
772 | buffer and *outsize its size in bytes. out must be freed by user after usage.
773 | */
774 | unsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize,
775 | const unsigned char* in, size_t insize,
776 | const LodePNGCompressSettings* settings);
777 |
778 | /*
779 | Find length-limited Huffman code for given frequencies. This function is in the
780 | public interface only for tests, it's used internally by lodepng_deflate.
781 | */
782 | unsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies,
783 | size_t numcodes, unsigned maxbitlen);
784 |
785 | /*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/
786 | unsigned lodepng_deflate(unsigned char** out, size_t* outsize,
787 | const unsigned char* in, size_t insize,
788 | const LodePNGCompressSettings* settings);
789 |
790 | #endif /*LODEPNG_COMPILE_ENCODER*/
791 | #endif /*LODEPNG_COMPILE_ZLIB*/
792 |
793 | #ifdef LODEPNG_COMPILE_DISK
794 | /*
795 | Load a file from disk into buffer. The function allocates the out buffer, and
796 | after usage you should free it.
797 | out: output parameter, contains pointer to loaded buffer.
798 | outsize: output parameter, size of the allocated out buffer
799 | filename: the path to the file to load
800 | return value: error code (0 means ok)
801 | */
802 | unsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename);
803 |
804 | /*
805 | Save a file from buffer to disk. Warning, if it exists, this function overwrites
806 | the file without warning!
807 | buffer: the buffer to write
808 | buffersize: size of the buffer to write
809 | filename: the path to the file to save to
810 | return value: error code (0 means ok)
811 | */
812 | unsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename);
813 | #endif /*LODEPNG_COMPILE_DISK*/
814 |
815 | #ifdef LODEPNG_COMPILE_CPP
816 | /* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */
817 | namespace lodepng
818 | {
819 | #ifdef LODEPNG_COMPILE_PNG
820 | class State : public LodePNGState
821 | {
822 | public:
823 | State();
824 | State(const State& other);
825 | virtual ~State();
826 | State& operator=(const State& other);
827 | };
828 |
829 | #ifdef LODEPNG_COMPILE_DECODER
830 | /* Same as other lodepng::decode, but using a State for more settings and information. */
831 | unsigned decode(std::vector& out, unsigned& w, unsigned& h,
832 | State& state,
833 | const unsigned char* in, size_t insize);
834 | unsigned decode(std::vector& out, unsigned& w, unsigned& h,
835 | State& state,
836 | const std::vector& in);
837 | #endif /*LODEPNG_COMPILE_DECODER*/
838 |
839 | #ifdef LODEPNG_COMPILE_ENCODER
840 | /* Same as other lodepng::encode, but using a State for more settings and information. */
841 | unsigned encode(std::vector& out,
842 | const unsigned char* in, unsigned w, unsigned h,
843 | State& state);
844 | unsigned encode(std::vector& out,
845 | const std::vector& in, unsigned w, unsigned h,
846 | State& state);
847 | #endif /*LODEPNG_COMPILE_ENCODER*/
848 |
849 | #ifdef LODEPNG_COMPILE_DISK
850 | /*
851 | Load a file from disk into an std::vector.
852 | return value: error code (0 means ok)
853 | */
854 | unsigned load_file(std::vector& buffer, const std::string& filename);
855 |
856 | /*
857 | Save the binary data in an std::vector to a file on disk. The file is overwritten
858 | without warning.
859 | */
860 | unsigned save_file(const std::vector& buffer, const std::string& filename);
861 | #endif /* LODEPNG_COMPILE_DISK */
862 | #endif /* LODEPNG_COMPILE_PNG */
863 |
864 | #ifdef LODEPNG_COMPILE_ZLIB
865 | #ifdef LODEPNG_COMPILE_DECODER
866 | /* Zlib-decompress an unsigned char buffer */
867 | unsigned decompress(std::vector& out, const unsigned char* in, size_t insize,
868 | const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);
869 |
870 | /* Zlib-decompress an std::vector */
871 | unsigned decompress(std::vector& out, const std::vector& in,
872 | const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);
873 | #endif /* LODEPNG_COMPILE_DECODER */
874 |
875 | #ifdef LODEPNG_COMPILE_ENCODER
876 | /* Zlib-compress an unsigned char buffer */
877 | unsigned compress(std::vector& out, const unsigned char* in, size_t insize,
878 | const LodePNGCompressSettings& settings = lodepng_default_compress_settings);
879 |
880 | /* Zlib-compress an std::vector */
881 | unsigned compress(std::vector& out, const std::vector& in,
882 | const LodePNGCompressSettings& settings = lodepng_default_compress_settings);
883 | #endif /* LODEPNG_COMPILE_ENCODER */
884 | #endif /* LODEPNG_COMPILE_ZLIB */
885 | } /* namespace lodepng */
886 | #endif /*LODEPNG_COMPILE_CPP*/
887 |
888 | /*
889 | TODO:
890 | [.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often
891 | [.] check compatibility with various compilers - done but needs to be redone for every newer version
892 | [X] converting color to 16-bit per channel types
893 | [ ] read all public PNG chunk types (but never let the color profile and gamma ones touch RGB values)
894 | [ ] make sure encoder generates no chunks with size > (2^31)-1
895 | [ ] partial decoding (stream processing)
896 | [X] let the "isFullyOpaque" function check color keys and transparent palettes too
897 | [X] better name for the variables "codes", "codesD", "codelengthcodes", "clcl" and "lldl"
898 | [ ] don't stop decoding on errors like 69, 57, 58 (make warnings)
899 | [ ] make warnings like: oob palette, checksum fail, data after iend, wrong/unknown crit chunk, no null terminator in text, ...
900 | [ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes
901 | [ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ...
902 | [ ] allow user to give data (void*) to custom allocator
903 | */
904 |
905 | #endif /*LODEPNG_H inclusion guard*/
906 |
907 | /*
908 | LodePNG Documentation
909 | ---------------------
910 |
911 | 0. table of contents
912 | --------------------
913 |
914 | 1. about
915 | 1.1. supported features
916 | 1.2. features not supported
917 | 2. C and C++ version
918 | 3. security
919 | 4. decoding
920 | 5. encoding
921 | 6. color conversions
922 | 6.1. PNG color types
923 | 6.2. color conversions
924 | 6.3. padding bits
925 | 6.4. A note about 16-bits per channel and endianness
926 | 7. error values
927 | 8. chunks and PNG editing
928 | 9. compiler support
929 | 10. examples
930 | 10.1. decoder C++ example
931 | 10.2. decoder C example
932 | 11. state settings reference
933 | 12. changes
934 | 13. contact information
935 |
936 |
937 | 1. about
938 | --------
939 |
940 | PNG is a file format to store raster images losslessly with good compression,
941 | supporting different color types and alpha channel.
942 |
943 | LodePNG is a PNG codec according to the Portable Network Graphics (PNG)
944 | Specification (Second Edition) - W3C Recommendation 10 November 2003.
945 |
946 | The specifications used are:
947 |
948 | *) Portable Network Graphics (PNG) Specification (Second Edition):
949 | http://www.w3.org/TR/2003/REC-PNG-20031110
950 | *) RFC 1950 ZLIB Compressed Data Format version 3.3:
951 | http://www.gzip.org/zlib/rfc-zlib.html
952 | *) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3:
953 | http://www.gzip.org/zlib/rfc-deflate.html
954 |
955 | The most recent version of LodePNG can currently be found at
956 | http://lodev.org/lodepng/
957 |
958 | LodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds
959 | extra functionality.
960 |
961 | LodePNG exists out of two files:
962 | -lodepng.h: the header file for both C and C++
963 | -lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage
964 |
965 | If you want to start using LodePNG right away without reading this doc, get the
966 | examples from the LodePNG website to see how to use it in code, or check the
967 | smaller examples in chapter 13 here.
968 |
969 | LodePNG is simple but only supports the basic requirements. To achieve
970 | simplicity, the following design choices were made: There are no dependencies
971 | on any external library. There are functions to decode and encode a PNG with
972 | a single function call, and extended versions of these functions taking a
973 | LodePNGState struct allowing to specify or get more information. By default
974 | the colors of the raw image are always RGB or RGBA, no matter what color type
975 | the PNG file uses. To read and write files, there are simple functions to
976 | convert the files to/from buffers in memory.
977 |
978 | This all makes LodePNG suitable for loading textures in games, demos and small
979 | programs, ... It's less suitable for full fledged image editors, loading PNGs
980 | over network (it requires all the image data to be available before decoding can
981 | begin), life-critical systems, ...
982 |
983 | 1.1. supported features
984 | -----------------------
985 |
986 | The following features are supported by the decoder:
987 |
988 | *) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image,
989 | or the same color type as the PNG
990 | *) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image
991 | *) Adam7 interlace and deinterlace for any color type
992 | *) loading the image from harddisk or decoding it from a buffer from other sources than harddisk
993 | *) support for alpha channels, including RGBA color model, translucent palettes and color keying
994 | *) zlib decompression (inflate)
995 | *) zlib compression (deflate)
996 | *) CRC32 and ADLER32 checksums
997 | *) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks.
998 | *) the following chunks are supported (generated/interpreted) by both encoder and decoder:
999 | IHDR: header information
1000 | PLTE: color palette
1001 | IDAT: pixel data
1002 | IEND: the final chunk
1003 | tRNS: transparency for palettized images
1004 | tEXt: textual information
1005 | zTXt: compressed textual information
1006 | iTXt: international textual information
1007 | bKGD: suggested background color
1008 | pHYs: physical dimensions
1009 | tIME: modification time
1010 |
1011 | 1.2. features not supported
1012 | ---------------------------
1013 |
1014 | The following features are _not_ supported:
1015 |
1016 | *) some features needed to make a conformant PNG-Editor might be still missing.
1017 | *) partial loading/stream processing. All data must be available and is processed in one call.
1018 | *) The following public chunks are not supported but treated as unknown chunks by LodePNG
1019 | cHRM, gAMA, iCCP, sRGB, sBIT, hIST, sPLT
1020 | Some of these are not supported on purpose: LodePNG wants to provide the RGB values
1021 | stored in the pixels, not values modified by system dependent gamma or color models.
1022 |
1023 |
1024 | 2. C and C++ version
1025 | --------------------
1026 |
1027 | The C version uses buffers allocated with alloc that you need to free()
1028 | yourself. You need to use init and cleanup functions for each struct whenever
1029 | using a struct from the C version to avoid exploits and memory leaks.
1030 |
1031 | The C++ version has extra functions with std::vectors in the interface and the
1032 | lodepng::State class which is a LodePNGState with constructor and destructor.
1033 |
1034 | These files work without modification for both C and C++ compilers because all
1035 | the additional C++ code is in "#ifdef __cplusplus" blocks that make C-compilers
1036 | ignore it, and the C code is made to compile both with strict ISO C90 and C++.
1037 |
1038 | To use the C++ version, you need to rename the source file to lodepng.cpp
1039 | (instead of lodepng.c), and compile it with a C++ compiler.
1040 |
1041 | To use the C version, you need to rename the source file to lodepng.c (instead
1042 | of lodepng.cpp), and compile it with a C compiler.
1043 |
1044 |
1045 | 3. Security
1046 | -----------
1047 |
1048 | Even if carefully designed, it's always possible that LodePNG contains possible
1049 | exploits. If you discover one, please let me know, and it will be fixed.
1050 |
1051 | When using LodePNG, care has to be taken with the C version of LodePNG, as well
1052 | as the C-style structs when working with C++. The following conventions are used
1053 | for all C-style structs:
1054 |
1055 | -if a struct has a corresponding init function, always call the init function when making a new one
1056 | -if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks
1057 | -if a struct has a corresponding copy function, use the copy function instead of "=".
1058 | The destination must also be inited already.
1059 |
1060 |
1061 | 4. Decoding
1062 | -----------
1063 |
1064 | Decoding converts a PNG compressed image to a raw pixel buffer.
1065 |
1066 | Most documentation on using the decoder is at its declarations in the header
1067 | above. For C, simple decoding can be done with functions such as
1068 | lodepng_decode32, and more advanced decoding can be done with the struct
1069 | LodePNGState and lodepng_decode. For C++, all decoding can be done with the
1070 | various lodepng::decode functions, and lodepng::State can be used for advanced
1071 | features.
1072 |
1073 | When using the LodePNGState, it uses the following fields for decoding:
1074 | *) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here
1075 | *) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get
1076 | *) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use
1077 |
1078 | LodePNGInfo info_png
1079 | --------------------
1080 |
1081 | After decoding, this contains extra information of the PNG image, except the actual
1082 | pixels, width and height because these are already gotten directly from the decoder
1083 | functions.
1084 |
1085 | It contains for example the original color type of the PNG image, text comments,
1086 | suggested background color, etc... More details about the LodePNGInfo struct are
1087 | at its declaration documentation.
1088 |
1089 | LodePNGColorMode info_raw
1090 | -------------------------
1091 |
1092 | When decoding, here you can specify which color type you want
1093 | the resulting raw image to be. If this is different from the colortype of the
1094 | PNG, then the decoder will automatically convert the result. This conversion
1095 | always works, except if you want it to convert a color PNG to greyscale or to
1096 | a palette with missing colors.
1097 |
1098 | By default, 32-bit color is used for the result.
1099 |
1100 | LodePNGDecoderSettings decoder
1101 | ------------------------------
1102 |
1103 | The settings can be used to ignore the errors created by invalid CRC and Adler32
1104 | chunks, and to disable the decoding of tEXt chunks.
1105 |
1106 | There's also a setting color_convert, true by default. If false, no conversion
1107 | is done, the resulting data will be as it was in the PNG (after decompression)
1108 | and you'll have to puzzle the colors of the pixels together yourself using the
1109 | color type information in the LodePNGInfo.
1110 |
1111 |
1112 | 5. Encoding
1113 | -----------
1114 |
1115 | Encoding converts a raw pixel buffer to a PNG compressed image.
1116 |
1117 | Most documentation on using the encoder is at its declarations in the header
1118 | above. For C, simple encoding can be done with functions such as
1119 | lodepng_encode32, and more advanced decoding can be done with the struct
1120 | LodePNGState and lodepng_encode. For C++, all encoding can be done with the
1121 | various lodepng::encode functions, and lodepng::State can be used for advanced
1122 | features.
1123 |
1124 | Like the decoder, the encoder can also give errors. However it gives less errors
1125 | since the encoder input is trusted, the decoder input (a PNG image that could
1126 | be forged by anyone) is not trusted.
1127 |
1128 | When using the LodePNGState, it uses the following fields for encoding:
1129 | *) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be.
1130 | *) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has
1131 | *) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use
1132 |
1133 | LodePNGInfo info_png
1134 | --------------------
1135 |
1136 | When encoding, you use this the opposite way as when decoding: for encoding,
1137 | you fill in the values you want the PNG to have before encoding. By default it's
1138 | not needed to specify a color type for the PNG since it's automatically chosen,
1139 | but it's possible to choose it yourself given the right settings.
1140 |
1141 | The encoder will not always exactly match the LodePNGInfo struct you give,
1142 | it tries as close as possible. Some things are ignored by the encoder. The
1143 | encoder uses, for example, the following settings from it when applicable:
1144 | colortype and bitdepth, text chunks, time chunk, the color key, the palette, the
1145 | background color, the interlace method, unknown chunks, ...
1146 |
1147 | When encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk.
1148 | If the palette contains any colors for which the alpha channel is not 255 (so
1149 | there are translucent colors in the palette), it'll add a tRNS chunk.
1150 |
1151 | LodePNGColorMode info_raw
1152 | -------------------------
1153 |
1154 | You specify the color type of the raw image that you give to the input here,
1155 | including a possible transparent color key and palette you happen to be using in
1156 | your raw image data.
1157 |
1158 | By default, 32-bit color is assumed, meaning your input has to be in RGBA
1159 | format with 4 bytes (unsigned chars) per pixel.
1160 |
1161 | LodePNGEncoderSettings encoder
1162 | ------------------------------
1163 |
1164 | The following settings are supported (some are in sub-structs):
1165 | *) auto_convert: when this option is enabled, the encoder will
1166 | automatically choose the smallest possible color mode (including color key) that
1167 | can encode the colors of all pixels without information loss.
1168 | *) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree,
1169 | 2 = dynamic huffman tree (best compression). Should be 2 for proper
1170 | compression.
1171 | *) use_lz77: whether or not to use LZ77 for compressed block types. Should be
1172 | true for proper compression.
1173 | *) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value
1174 | 2048 by default, but can be set to 32768 for better, but slow, compression.
1175 | *) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE
1176 | chunk if force_palette is true. This can used as suggested palette to convert
1177 | to by viewers that don't support more than 256 colors (if those still exist)
1178 | *) add_id: add text chunk "Encoder: LodePNG " to the image.
1179 | *) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks.
1180 | zTXt chunks use zlib compression on the text. This gives a smaller result on
1181 | large texts but a larger result on small texts (such as a single program name).
1182 | It's all tEXt or all zTXt though, there's no separate setting per text yet.
1183 |
1184 |
1185 | 6. color conversions
1186 | --------------------
1187 |
1188 | An important thing to note about LodePNG, is that the color type of the PNG, and
1189 | the color type of the raw image, are completely independent. By default, when
1190 | you decode a PNG, you get the result as a raw image in the color type you want,
1191 | no matter whether the PNG was encoded with a palette, greyscale or RGBA color.
1192 | And if you encode an image, by default LodePNG will automatically choose the PNG
1193 | color type that gives good compression based on the values of colors and amount
1194 | of colors in the image. It can be configured to let you control it instead as
1195 | well, though.
1196 |
1197 | To be able to do this, LodePNG does conversions from one color mode to another.
1198 | It can convert from almost any color type to any other color type, except the
1199 | following conversions: RGB to greyscale is not supported, and converting to a
1200 | palette when the palette doesn't have a required color is not supported. This is
1201 | not supported on purpose: this is information loss which requires a color
1202 | reduction algorithm that is beyong the scope of a PNG encoder (yes, RGB to grey
1203 | is easy, but there are multiple ways if you want to give some channels more
1204 | weight).
1205 |
1206 | By default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB
1207 | color, no matter what color type the PNG has. And by default when encoding,
1208 | LodePNG automatically picks the best color model for the output PNG, and expects
1209 | the input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control
1210 | the color format of the images yourself, you can skip this chapter.
1211 |
1212 | 6.1. PNG color types
1213 | --------------------
1214 |
1215 | A PNG image can have many color types, ranging from 1-bit color to 64-bit color,
1216 | as well as palettized color modes. After the zlib decompression and unfiltering
1217 | in the PNG image is done, the raw pixel data will have that color type and thus
1218 | a certain amount of bits per pixel. If you want the output raw image after
1219 | decoding to have another color type, a conversion is done by LodePNG.
1220 |
1221 | The PNG specification gives the following color types:
1222 |
1223 | 0: greyscale, bit depths 1, 2, 4, 8, 16
1224 | 2: RGB, bit depths 8 and 16
1225 | 3: palette, bit depths 1, 2, 4 and 8
1226 | 4: greyscale with alpha, bit depths 8 and 16
1227 | 6: RGBA, bit depths 8 and 16
1228 |
1229 | Bit depth is the amount of bits per pixel per color channel. So the total amount
1230 | of bits per pixel is: amount of channels * bitdepth.
1231 |
1232 | 6.2. color conversions
1233 | ----------------------
1234 |
1235 | As explained in the sections about the encoder and decoder, you can specify
1236 | color types and bit depths in info_png and info_raw to change the default
1237 | behaviour.
1238 |
1239 | If, when decoding, you want the raw image to be something else than the default,
1240 | you need to set the color type and bit depth you want in the LodePNGColorMode,
1241 | or the parameters colortype and bitdepth of the simple decoding function.
1242 |
1243 | If, when encoding, you use another color type than the default in the raw input
1244 | image, you need to specify its color type and bit depth in the LodePNGColorMode
1245 | of the raw image, or use the parameters colortype and bitdepth of the simple
1246 | encoding function.
1247 |
1248 | If, when encoding, you don't want LodePNG to choose the output PNG color type
1249 | but control it yourself, you need to set auto_convert in the encoder settings
1250 | to false, and specify the color type you want in the LodePNGInfo of the
1251 | encoder (including palette: it can generate a palette if auto_convert is true,
1252 | otherwise not).
1253 |
1254 | If the input and output color type differ (whether user chosen or auto chosen),
1255 | LodePNG will do a color conversion, which follows the rules below, and may
1256 | sometimes result in an error.
1257 |
1258 | To avoid some confusion:
1259 | -the decoder converts from PNG to raw image
1260 | -the encoder converts from raw image to PNG
1261 | -the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image
1262 | -the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG
1263 | -when encoding, the color type in LodePNGInfo is ignored if auto_convert
1264 | is enabled, it is automatically generated instead
1265 | -when decoding, the color type in LodePNGInfo is set by the decoder to that of the original
1266 | PNG image, but it can be ignored since the raw image has the color type you requested instead
1267 | -if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion
1268 | between the color types is done if the color types are supported. If it is not
1269 | supported, an error is returned. If the types are the same, no conversion is done.
1270 | -even though some conversions aren't supported, LodePNG supports loading PNGs from any
1271 | colortype and saving PNGs to any colortype, sometimes it just requires preparing
1272 | the raw image correctly before encoding.
1273 | -both encoder and decoder use the same color converter.
1274 |
1275 | Non supported color conversions:
1276 | -color to greyscale: no error is thrown, but the result will look ugly because
1277 | only the red channel is taken
1278 | -anything to palette when that palette does not have that color in it: in this
1279 | case an error is thrown
1280 |
1281 | Supported color conversions:
1282 | -anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA
1283 | -any grey or grey+alpha, to grey or grey+alpha
1284 | -anything to a palette, as long as the palette has the requested colors in it
1285 | -removing alpha channel
1286 | -higher to smaller bitdepth, and vice versa
1287 |
1288 | If you want no color conversion to be done (e.g. for speed or control):
1289 | -In the encoder, you can make it save a PNG with any color type by giving the
1290 | raw color mode and LodePNGInfo the same color mode, and setting auto_convert to
1291 | false.
1292 | -In the decoder, you can make it store the pixel data in the same color type
1293 | as the PNG has, by setting the color_convert setting to false. Settings in
1294 | info_raw are then ignored.
1295 |
1296 | The function lodepng_convert does the color conversion. It is available in the
1297 | interface but normally isn't needed since the encoder and decoder already call
1298 | it.
1299 |
1300 | 6.3. padding bits
1301 | -----------------
1302 |
1303 | In the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines
1304 | have a bit amount that isn't a multiple of 8, then padding bits are used so that each
1305 | scanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output.
1306 | The raw input image you give to the encoder, and the raw output image you get from the decoder
1307 | will NOT have these padding bits, e.g. in the case of a 1-bit image with a width
1308 | of 7 pixels, the first pixel of the second scanline will the the 8th bit of the first byte,
1309 | not the first bit of a new byte.
1310 |
1311 | 6.4. A note about 16-bits per channel and endianness
1312 | ----------------------------------------------------
1313 |
1314 | LodePNG uses unsigned char arrays for 16-bit per channel colors too, just like
1315 | for any other color format. The 16-bit values are stored in big endian (most
1316 | significant byte first) in these arrays. This is the opposite order of the
1317 | little endian used by x86 CPU's.
1318 |
1319 | LodePNG always uses big endian because the PNG file format does so internally.
1320 | Conversions to other formats than PNG uses internally are not supported by
1321 | LodePNG on purpose, there are myriads of formats, including endianness of 16-bit
1322 | colors, the order in which you store R, G, B and A, and so on. Supporting and
1323 | converting to/from all that is outside the scope of LodePNG.
1324 |
1325 | This may mean that, depending on your use case, you may want to convert the big
1326 | endian output of LodePNG to little endian with a for loop. This is certainly not
1327 | always needed, many applications and libraries support big endian 16-bit colors
1328 | anyway, but it means you cannot simply cast the unsigned char* buffer to an
1329 | unsigned short* buffer on x86 CPUs.
1330 |
1331 |
1332 | 7. error values
1333 | ---------------
1334 |
1335 | All functions in LodePNG that return an error code, return 0 if everything went
1336 | OK, or a non-zero code if there was an error.
1337 |
1338 | The meaning of the LodePNG error values can be retrieved with the function
1339 | lodepng_error_text: given the numerical error code, it returns a description
1340 | of the error in English as a string.
1341 |
1342 | Check the implementation of lodepng_error_text to see the meaning of each code.
1343 |
1344 |
1345 | 8. chunks and PNG editing
1346 | -------------------------
1347 |
1348 | If you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG
1349 | editor that should follow the rules about handling of unknown chunks, or if your
1350 | program is able to read other types of chunks than the ones handled by LodePNG,
1351 | then that's possible with the chunk functions of LodePNG.
1352 |
1353 | A PNG chunk has the following layout:
1354 |
1355 | 4 bytes length
1356 | 4 bytes type name
1357 | length bytes data
1358 | 4 bytes CRC
1359 |
1360 | 8.1. iterating through chunks
1361 | -----------------------------
1362 |
1363 | If you have a buffer containing the PNG image data, then the first chunk (the
1364 | IHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the
1365 | signature of the PNG and are not part of a chunk. But if you start at byte 8
1366 | then you have a chunk, and can check the following things of it.
1367 |
1368 | NOTE: none of these functions check for memory buffer boundaries. To avoid
1369 | exploits, always make sure the buffer contains all the data of the chunks.
1370 | When using lodepng_chunk_next, make sure the returned value is within the
1371 | allocated memory.
1372 |
1373 | unsigned lodepng_chunk_length(const unsigned char* chunk):
1374 |
1375 | Get the length of the chunk's data. The total chunk length is this length + 12.
1376 |
1377 | void lodepng_chunk_type(char type[5], const unsigned char* chunk):
1378 | unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type):
1379 |
1380 | Get the type of the chunk or compare if it's a certain type
1381 |
1382 | unsigned char lodepng_chunk_critical(const unsigned char* chunk):
1383 | unsigned char lodepng_chunk_private(const unsigned char* chunk):
1384 | unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk):
1385 |
1386 | Check if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are).
1387 | Check if the chunk is private (public chunks are part of the standard, private ones not).
1388 | Check if the chunk is safe to copy. If it's not, then, when modifying data in a critical
1389 | chunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your
1390 | program doesn't handle that type of unknown chunk.
1391 |
1392 | unsigned char* lodepng_chunk_data(unsigned char* chunk):
1393 | const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk):
1394 |
1395 | Get a pointer to the start of the data of the chunk.
1396 |
1397 | unsigned lodepng_chunk_check_crc(const unsigned char* chunk):
1398 | void lodepng_chunk_generate_crc(unsigned char* chunk):
1399 |
1400 | Check if the crc is correct or generate a correct one.
1401 |
1402 | unsigned char* lodepng_chunk_next(unsigned char* chunk):
1403 | const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk):
1404 |
1405 | Iterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these
1406 | functions do no boundary checking of the allocated data whatsoever, so make sure there is enough
1407 | data available in the buffer to be able to go to the next chunk.
1408 |
1409 | unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk):
1410 | unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length,
1411 | const char* type, const unsigned char* data):
1412 |
1413 | These functions are used to create new chunks that are appended to the data in *out that has
1414 | length *outlength. The append function appends an existing chunk to the new data. The create
1415 | function creates a new chunk with the given parameters and appends it. Type is the 4-letter
1416 | name of the chunk.
1417 |
1418 | 8.2. chunks in info_png
1419 | -----------------------
1420 |
1421 | The LodePNGInfo struct contains fields with the unknown chunk in it. It has 3
1422 | buffers (each with size) to contain 3 types of unknown chunks:
1423 | the ones that come before the PLTE chunk, the ones that come between the PLTE
1424 | and the IDAT chunks, and the ones that come after the IDAT chunks.
1425 | It's necessary to make the distionction between these 3 cases because the PNG
1426 | standard forces to keep the ordering of unknown chunks compared to the critical
1427 | chunks, but does not force any other ordering rules.
1428 |
1429 | info_png.unknown_chunks_data[0] is the chunks before PLTE
1430 | info_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT
1431 | info_png.unknown_chunks_data[2] is the chunks after IDAT
1432 |
1433 | The chunks in these 3 buffers can be iterated through and read by using the same
1434 | way described in the previous subchapter.
1435 |
1436 | When using the decoder to decode a PNG, you can make it store all unknown chunks
1437 | if you set the option settings.remember_unknown_chunks to 1. By default, this
1438 | option is off (0).
1439 |
1440 | The encoder will always encode unknown chunks that are stored in the info_png.
1441 | If you need it to add a particular chunk that isn't known by LodePNG, you can
1442 | use lodepng_chunk_append or lodepng_chunk_create to the chunk data in
1443 | info_png.unknown_chunks_data[x].
1444 |
1445 | Chunks that are known by LodePNG should not be added in that way. E.g. to make
1446 | LodePNG add a bKGD chunk, set background_defined to true and add the correct
1447 | parameters there instead.
1448 |
1449 |
1450 | 9. compiler support
1451 | -------------------
1452 |
1453 | No libraries other than the current standard C library are needed to compile
1454 | LodePNG. For the C++ version, only the standard C++ library is needed on top.
1455 | Add the files lodepng.c(pp) and lodepng.h to your project, include
1456 | lodepng.h where needed, and your program can read/write PNG files.
1457 |
1458 | It is compatible with C90 and up, and C++03 and up.
1459 |
1460 | If performance is important, use optimization when compiling! For both the
1461 | encoder and decoder, this makes a large difference.
1462 |
1463 | Make sure that LodePNG is compiled with the same compiler of the same version
1464 | and with the same settings as the rest of the program, or the interfaces with
1465 | std::vectors and std::strings in C++ can be incompatible.
1466 |
1467 | CHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets.
1468 |
1469 | *) gcc and g++
1470 |
1471 | LodePNG is developed in gcc so this compiler is natively supported. It gives no
1472 | warnings with compiler options "-Wall -Wextra -pedantic -ansi", with gcc and g++
1473 | version 4.7.1 on Linux, 32-bit and 64-bit.
1474 |
1475 | *) Clang
1476 |
1477 | Fully supported and warning-free.
1478 |
1479 | *) Mingw
1480 |
1481 | The Mingw compiler (a port of gcc for Windows) should be fully supported by
1482 | LodePNG.
1483 |
1484 | *) Visual Studio and Visual C++ Express Edition
1485 |
1486 | LodePNG should be warning-free with warning level W4. Two warnings were disabled
1487 | with pragmas though: warning 4244 about implicit conversions, and warning 4996
1488 | where it wants to use a non-standard function fopen_s instead of the standard C
1489 | fopen.
1490 |
1491 | Visual Studio may want "stdafx.h" files to be included in each source file and
1492 | give an error "unexpected end of file while looking for precompiled header".
1493 | This is not standard C++ and will not be added to the stock LodePNG. You can
1494 | disable it for lodepng.cpp only by right clicking it, Properties, C/C++,
1495 | Precompiled Headers, and set it to Not Using Precompiled Headers there.
1496 |
1497 | NOTE: Modern versions of VS should be fully supported, but old versions, e.g.
1498 | VS6, are not guaranteed to work.
1499 |
1500 | *) Compilers on Macintosh
1501 |
1502 | LodePNG has been reported to work both with gcc and LLVM for Macintosh, both for
1503 | C and C++.
1504 |
1505 | *) Other Compilers
1506 |
1507 | If you encounter problems on any compilers, feel free to let me know and I may
1508 | try to fix it if the compiler is modern and standards complient.
1509 |
1510 |
1511 | 10. examples
1512 | ------------
1513 |
1514 | This decoder example shows the most basic usage of LodePNG. More complex
1515 | examples can be found on the LodePNG website.
1516 |
1517 | 10.1. decoder C++ example
1518 | -------------------------
1519 |
1520 | #include "lodepng.h"
1521 | #include
1522 |
1523 | int main(int argc, char *argv[])
1524 | {
1525 | const char* filename = argc > 1 ? argv[1] : "test.png";
1526 |
1527 | //load and decode
1528 | std::vector image;
1529 | unsigned width, height;
1530 | unsigned error = lodepng::decode(image, width, height, filename);
1531 |
1532 | //if there's an error, display it
1533 | if(error) std::cout << "decoder error " << error << ": " << lodepng_error_text(error) << std::endl;
1534 |
1535 | //the pixels are now in the vector "image", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ...
1536 | }
1537 |
1538 | 10.2. decoder C example
1539 | -----------------------
1540 |
1541 | #include "lodepng.h"
1542 |
1543 | int main(int argc, char *argv[])
1544 | {
1545 | unsigned error;
1546 | unsigned char* image;
1547 | size_t width, height;
1548 | const char* filename = argc > 1 ? argv[1] : "test.png";
1549 |
1550 | error = lodepng_decode32_file(&image, &width, &height, filename);
1551 |
1552 | if(error) printf("decoder error %u: %s\n", error, lodepng_error_text(error));
1553 |
1554 | / * use image here * /
1555 |
1556 | free(image);
1557 | return 0;
1558 | }
1559 |
1560 | 11. state settings reference
1561 | ----------------------------
1562 |
1563 | A quick reference of some settings to set on the LodePNGState
1564 |
1565 | For decoding:
1566 |
1567 | state.decoder.zlibsettings.ignore_adler32: ignore ADLER32 checksums
1568 | state.decoder.zlibsettings.custom_...: use custom inflate function
1569 | state.decoder.ignore_crc: ignore CRC checksums
1570 | state.decoder.color_convert: convert internal PNG color to chosen one
1571 | state.decoder.read_text_chunks: whether to read in text metadata chunks
1572 | state.decoder.remember_unknown_chunks: whether to read in unknown chunks
1573 | state.info_raw.colortype: desired color type for decoded image
1574 | state.info_raw.bitdepth: desired bit depth for decoded image
1575 | state.info_raw....: more color settings, see struct LodePNGColorMode
1576 | state.info_png....: no settings for decoder but ouput, see struct LodePNGInfo
1577 |
1578 | For encoding:
1579 |
1580 | state.encoder.zlibsettings.btype: disable compression by setting it to 0
1581 | state.encoder.zlibsettings.use_lz77: use LZ77 in compression
1582 | state.encoder.zlibsettings.windowsize: tweak LZ77 windowsize
1583 | state.encoder.zlibsettings.minmatch: tweak min LZ77 length to match
1584 | state.encoder.zlibsettings.nicematch: tweak LZ77 match where to stop searching
1585 | state.encoder.zlibsettings.lazymatching: try one more LZ77 matching
1586 | state.encoder.zlibsettings.custom_...: use custom deflate function
1587 | state.encoder.auto_convert: choose optimal PNG color type, if 0 uses info_png
1588 | state.encoder.filter_palette_zero: PNG filter strategy for palette
1589 | state.encoder.filter_strategy: PNG filter strategy to encode with
1590 | state.encoder.force_palette: add palette even if not encoding to one
1591 | state.encoder.add_id: add LodePNG identifier and version as a text chunk
1592 | state.encoder.text_compression: use compressed text chunks for metadata
1593 | state.info_raw.colortype: color type of raw input image you provide
1594 | state.info_raw.bitdepth: bit depth of raw input image you provide
1595 | state.info_raw: more color settings, see struct LodePNGColorMode
1596 | state.info_png.color.colortype: desired color type if auto_convert is false
1597 | state.info_png.color.bitdepth: desired bit depth if auto_convert is false
1598 | state.info_png.color....: more color settings, see struct LodePNGColorMode
1599 | state.info_png....: more PNG related settings, see struct LodePNGInfo
1600 |
1601 |
1602 | 12. changes
1603 | -----------
1604 |
1605 | The version number of LodePNG is the date of the change given in the format
1606 | yyyymmdd.
1607 |
1608 | Some changes aren't backwards compatible. Those are indicated with a (!)
1609 | symbol.
1610 |
1611 | *) 27 nov 2016: grey+alpha auto color model detection bugfix
1612 | *) 18 apr 2016: Changed qsort to custom stable sort (for platforms w/o qsort).
1613 | *) 09 apr 2016: Fixed colorkey usage detection, and better file loading (within
1614 | the limits of pure C90).
1615 | *) 08 dec 2015: Made load_file function return error if file can't be opened.
1616 | *) 24 okt 2015: Bugfix with decoding to palette output.
1617 | *) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding.
1618 | *) 23 aug 2014: Reduced needless memory usage of decoder.
1619 | *) 28 jun 2014: Removed fix_png setting, always support palette OOB for
1620 | simplicity. Made ColorProfile public.
1621 | *) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization.
1622 | *) 22 dec 2013: Power of two windowsize required for optimization.
1623 | *) 15 apr 2013: Fixed bug with LAC_ALPHA and color key.
1624 | *) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png).
1625 | *) 11 mar 2013 (!): Bugfix with custom free. Changed from "my" to "lodepng_"
1626 | prefix for the custom allocators and made it possible with a new #define to
1627 | use custom ones in your project without needing to change lodepng's code.
1628 | *) 28 jan 2013: Bugfix with color key.
1629 | *) 27 okt 2012: Tweaks in text chunk keyword length error handling.
1630 | *) 8 okt 2012 (!): Added new filter strategy (entropy) and new auto color mode.
1631 | (no palette). Better deflate tree encoding. New compression tweak settings.
1632 | Faster color conversions while decoding. Some internal cleanups.
1633 | *) 23 sep 2012: Reduced warnings in Visual Studio a little bit.
1634 | *) 1 sep 2012 (!): Removed #define's for giving custom (de)compression functions
1635 | and made it work with function pointers instead.
1636 | *) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc
1637 | and free functions and toggle #defines from compiler flags. Small fixes.
1638 | *) 6 may 2012 (!): Made plugging in custom zlib/deflate functions more flexible.
1639 | *) 22 apr 2012 (!): Made interface more consistent, renaming a lot. Removed
1640 | redundant C++ codec classes. Reduced amount of structs. Everything changed,
1641 | but it is cleaner now imho and functionality remains the same. Also fixed
1642 | several bugs and shrunk the implementation code. Made new samples.
1643 | *) 6 nov 2011 (!): By default, the encoder now automatically chooses the best
1644 | PNG color model and bit depth, based on the amount and type of colors of the
1645 | raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color.
1646 | *) 9 okt 2011: simpler hash chain implementation for the encoder.
1647 | *) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching.
1648 | *) 23 aug 2011: tweaked the zlib compression parameters after benchmarking.
1649 | A bug with the PNG filtertype heuristic was fixed, so that it chooses much
1650 | better ones (it's quite significant). A setting to do an experimental, slow,
1651 | brute force search for PNG filter types is added.
1652 | *) 17 aug 2011 (!): changed some C zlib related function names.
1653 | *) 16 aug 2011: made the code less wide (max 120 characters per line).
1654 | *) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors.
1655 | *) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled.
1656 | *) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman
1657 | to optimize long sequences of zeros.
1658 | *) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and
1659 | LodePNG_InfoColor_canHaveAlpha functions for convenience.
1660 | *) 7 nov 2010: added LodePNG_error_text function to get error code description.
1661 | *) 30 okt 2010: made decoding slightly faster
1662 | *) 26 okt 2010: (!) changed some C function and struct names (more consistent).
1663 | Reorganized the documentation and the declaration order in the header.
1664 | *) 08 aug 2010: only changed some comments and external samples.
1665 | *) 05 jul 2010: fixed bug thanks to warnings in the new gcc version.
1666 | *) 14 mar 2010: fixed bug where too much memory was allocated for char buffers.
1667 | *) 02 sep 2008: fixed bug where it could create empty tree that linux apps could
1668 | read by ignoring the problem but windows apps couldn't.
1669 | *) 06 jun 2008: added more error checks for out of memory cases.
1670 | *) 26 apr 2008: added a few more checks here and there to ensure more safety.
1671 | *) 06 mar 2008: crash with encoding of strings fixed
1672 | *) 02 feb 2008: support for international text chunks added (iTXt)
1673 | *) 23 jan 2008: small cleanups, and #defines to divide code in sections
1674 | *) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor.
1675 | *) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder.
1676 | *) 17 jan 2008: ability to encode and decode compressed zTXt chunks added
1677 | Also various fixes, such as in the deflate and the padding bits code.
1678 | *) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved
1679 | filtering code of encoder.
1680 | *) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A
1681 | C++ wrapper around this provides an interface almost identical to before.
1682 | Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code
1683 | are together in these files but it works both for C and C++ compilers.
1684 | *) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks
1685 | *) 30 aug 2007: bug fixed which makes this Borland C++ compatible
1686 | *) 09 aug 2007: some VS2005 warnings removed again
1687 | *) 21 jul 2007: deflate code placed in new namespace separate from zlib code
1688 | *) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images
1689 | *) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing
1690 | invalid std::vector element [0] fixed, and level 3 and 4 warnings removed
1691 | *) 02 jun 2007: made the encoder add a tag with version by default
1692 | *) 27 may 2007: zlib and png code separated (but still in the same file),
1693 | simple encoder/decoder functions added for more simple usage cases
1694 | *) 19 may 2007: minor fixes, some code cleaning, new error added (error 69),
1695 | moved some examples from here to lodepng_examples.cpp
1696 | *) 12 may 2007: palette decoding bug fixed
1697 | *) 24 apr 2007: changed the license from BSD to the zlib license
1698 | *) 11 mar 2007: very simple addition: ability to encode bKGD chunks.
1699 | *) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding
1700 | palettized PNG images. Plus little interface change with palette and texts.
1701 | *) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes.
1702 | Fixed a bug where the end code of a block had length 0 in the Huffman tree.
1703 | *) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented
1704 | and supported by the encoder, resulting in smaller PNGs at the output.
1705 | *) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone.
1706 | *) 24 jan 2007: gave encoder an error interface. Added color conversion from any
1707 | greyscale type to 8-bit greyscale with or without alpha.
1708 | *) 21 jan 2007: (!) Totally changed the interface. It allows more color types
1709 | to convert to and is more uniform. See the manual for how it works now.
1710 | *) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days:
1711 | encode/decode custom tEXt chunks, separate classes for zlib & deflate, and
1712 | at last made the decoder give errors for incorrect Adler32 or Crc.
1713 | *) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel.
1714 | *) 29 dec 2006: Added support for encoding images without alpha channel, and
1715 | cleaned out code as well as making certain parts faster.
1716 | *) 28 dec 2006: Added "Settings" to the encoder.
1717 | *) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now.
1718 | Removed some code duplication in the decoder. Fixed little bug in an example.
1719 | *) 09 dec 2006: (!) Placed output parameters of public functions as first parameter.
1720 | Fixed a bug of the decoder with 16-bit per color.
1721 | *) 15 okt 2006: Changed documentation structure
1722 | *) 09 okt 2006: Encoder class added. It encodes a valid PNG image from the
1723 | given image buffer, however for now it's not compressed.
1724 | *) 08 sep 2006: (!) Changed to interface with a Decoder class
1725 | *) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different
1726 | way. Renamed decodePNG to decodePNGGeneric.
1727 | *) 29 jul 2006: (!) Changed the interface: image info is now returned as a
1728 | struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy.
1729 | *) 28 jul 2006: Cleaned the code and added new error checks.
1730 | Corrected terminology "deflate" into "inflate".
1731 | *) 23 jun 2006: Added SDL example in the documentation in the header, this
1732 | example allows easy debugging by displaying the PNG and its transparency.
1733 | *) 22 jun 2006: (!) Changed way to obtain error value. Added
1734 | loadFile function for convenience. Made decodePNG32 faster.
1735 | *) 21 jun 2006: (!) Changed type of info vector to unsigned.
1736 | Changed position of palette in info vector. Fixed an important bug that
1737 | happened on PNGs with an uncompressed block.
1738 | *) 16 jun 2006: Internally changed unsigned into unsigned where
1739 | needed, and performed some optimizations.
1740 | *) 07 jun 2006: (!) Renamed functions to decodePNG and placed them
1741 | in LodePNG namespace. Changed the order of the parameters. Rewrote the
1742 | documentation in the header. Renamed files to lodepng.cpp and lodepng.h
1743 | *) 22 apr 2006: Optimized and improved some code
1744 | *) 07 sep 2005: (!) Changed to std::vector interface
1745 | *) 12 aug 2005: Initial release (C++, decoder only)
1746 |
1747 |
1748 | 13. contact information
1749 | -----------------------
1750 |
1751 | Feel free to contact me with suggestions, problems, comments, ... concerning
1752 | LodePNG. If you encounter a PNG image that doesn't work properly with this
1753 | decoder, feel free to send it and I'll use it to find and fix the problem.
1754 |
1755 | My email address is (puzzle the account and domain together with an @ symbol):
1756 | Domain: gmail dot com.
1757 | Account: lode dot vandevenne.
1758 |
1759 |
1760 | Copyright (c) 2005-2016 Lode Vandevenne
1761 | */
1762 |
--------------------------------------------------------------------------------
/crunch/main.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | crunch - command line texture packer
26 | ====================================
27 |
28 | usage:
29 | crunch [OUTPUT] [INPUT1,INPUT2,INPUT3...] [OPTIONS...]
30 |
31 | example:
32 | crunch bin/atlases/atlas assets/characters,assets/tiles -p -t -v -u -r
33 |
34 | options:
35 | -d --default use default settings (-x -p -t -u)
36 | -x --xml saves the atlas data as a .xml file
37 | -b --binary saves the atlas data as a .bin file
38 | -j --json saves the atlas data as a .json file
39 | -p --premultiply premultiplies the pixels of the bitmaps by their alpha channel
40 | -t --trim trims excess transparency off the bitmaps
41 | -v --verbose print to the debug console as the packer works
42 | -f --force ignore the hash, forcing the packer to repack
43 | -u --unique remove duplicate bitmaps from the atlas
44 | -r --rotate enabled rotating bitmaps 90 degrees clockwise when packing
45 | -s# --size# max atlas size (# can be 4096, 2048, 1024, 512, 256, 128, or 64)
46 | -p# --pad# padding between images (# can be from 0 to 16)
47 |
48 | binary format:
49 | [int16] num_textures (below block is repeated this many times)
50 | [string] name
51 | [int16] num_images (below block is repeated this many times)
52 | [string] img_name
53 | [int16] img_x
54 | [int16] img_y
55 | [int16] img_width
56 | [int16] img_height
57 | [int16] img_frame_x (if --trim enabled)
58 | [int16] img_frame_y (if --trim enabled)
59 | [int16] img_frame_width (if --trim enabled)
60 | [int16] img_frame_height (if --trim enabled)
61 | [byte] img_rotated (if --rotate enabled)
62 | */
63 |
64 | #include
65 | #include
66 | #include
67 | #include
68 | #include
69 | #include
70 | #include
71 | #include "tinydir.h"
72 | #include "bitmap.hpp"
73 | #include "packer.hpp"
74 | #include "binary.hpp"
75 | #include "hash.hpp"
76 | #include "str.hpp"
77 |
78 | using namespace std;
79 |
80 | static int optSize;
81 | static int optPadding;
82 | static bool optXml;
83 | static bool optBinary;
84 | static bool optJson;
85 | static bool optPremultiply;
86 | static bool optTrim;
87 | static bool optVerbose;
88 | static bool optForce;
89 | static bool optUnique;
90 | static bool optRotate;
91 | static vector bitmaps;
92 | static vector packers;
93 |
94 | static void SplitFileName(const string& path, string* dir, string* name, string* ext)
95 | {
96 | size_t si = path.rfind('/') + 1;
97 | if (si == string::npos)
98 | si = 0;
99 | size_t di = path.rfind('.');
100 | if (dir != nullptr)
101 | {
102 | if (si > 0)
103 | *dir = path.substr(0, si);
104 | else
105 | *dir = "";
106 | }
107 | if (name != nullptr)
108 | {
109 | if (di != string::npos)
110 | *name = path.substr(si, di - si);
111 | else
112 | *name = path.substr(si);
113 | }
114 | if (ext != nullptr)
115 | {
116 | if (di != string::npos)
117 | *ext = path.substr(di);
118 | else
119 | *ext = "";
120 | }
121 | }
122 |
123 | static string GetFileName(const string& path)
124 | {
125 | string name;
126 | SplitFileName(path, nullptr, &name, nullptr);
127 | return name;
128 | }
129 |
130 | static void LoadBitmap(const string& prefix, const string& path)
131 | {
132 | if (optVerbose)
133 | cout << '\t' << PathToStr(path) << endl;
134 |
135 | bitmaps.push_back(new Bitmap(PathToStr(path), prefix + GetFileName(PathToStr(path)), optPremultiply, optTrim));
136 | }
137 |
138 | static void LoadBitmaps(const string& root, const string& prefix)
139 | {
140 | static string dot1 = ".";
141 | static string dot2 = "..";
142 |
143 | tinydir_dir dir;
144 | tinydir_open(&dir, StrToPath(root).data());
145 |
146 | while (dir.has_next)
147 | {
148 | tinydir_file file;
149 | tinydir_readfile(&dir, &file);
150 |
151 | if (file.is_dir)
152 | {
153 | if (dot1 != PathToStr(file.name) && dot2 != PathToStr(file.name))
154 | LoadBitmaps(PathToStr(file.path), prefix + PathToStr(file.name) + "/");
155 | }
156 | else if (PathToStr(file.extension) == "png")
157 | LoadBitmap(prefix, file.path);
158 |
159 | tinydir_next(&dir);
160 | }
161 |
162 | tinydir_close(&dir);
163 | }
164 |
165 | static void RemoveFile(string file)
166 | {
167 | remove(file.data());
168 | }
169 |
170 | static int GetPackSize(const string& str)
171 | {
172 | if (str == "4096")
173 | return 4096;
174 | if (str == "2048")
175 | return 2048;
176 | if (str == "1024")
177 | return 1024;
178 | if (str == "512")
179 | return 512;
180 | if (str == "256")
181 | return 256;
182 | if (str == "128")
183 | return 128;
184 | if (str == "64")
185 | return 64;
186 | cerr << "invalid size: " << str << endl;
187 | exit(EXIT_FAILURE);
188 | return 0;
189 | }
190 |
191 | static int GetPadding(const string& str)
192 | {
193 | for (int i = 0; i <= 16; ++i)
194 | if (str == to_string(i))
195 | return i;
196 | cerr << "invalid padding value: " << str << endl;
197 | exit(EXIT_FAILURE);
198 | return 1;
199 | }
200 |
201 | int main(int argc, const char* argv[])
202 | {
203 | //Print out passed arguments
204 | for (int i = 0; i < argc; ++i)
205 | cout << argv[i] << ' ';
206 | cout << endl;
207 |
208 | if (argc < 3)
209 | {
210 | cerr << "invalid input, expected: \"crunch [INPUT DIRECTORY] [OUTPUT PREFIX] [OPTIONS...]\"" << endl;
211 | return EXIT_FAILURE;
212 | }
213 |
214 | //Get the output directory and name
215 | string outputDir, name;
216 | SplitFileName(argv[1], &outputDir, &name, nullptr);
217 |
218 | //Get all the input files and directories
219 | vector inputs;
220 | stringstream ss(argv[2]);
221 | while (ss.good())
222 | {
223 | string inputStr;
224 | getline(ss, inputStr, ',');
225 | inputs.push_back(inputStr);
226 | }
227 |
228 | //Get the options
229 | optSize = 4096;
230 | optPadding = 1;
231 | optXml = false;
232 | optBinary = false;
233 | optJson = false;
234 | optPremultiply = false;
235 | optTrim = false;
236 | optVerbose = false;
237 | optForce = false;
238 | optUnique = false;
239 | for (int i = 3; i < argc; ++i)
240 | {
241 | string arg = argv[i];
242 | if (arg == "-d" || arg == "--default")
243 | optXml = optPremultiply = optTrim = optUnique = true;
244 | else if (arg == "-x" || arg == "--xml")
245 | optXml = true;
246 | else if (arg == "-b" || arg == "--binary")
247 | optBinary = true;
248 | else if (arg == "-j" || arg == "--json")
249 | optJson = true;
250 | else if (arg == "-p" || arg == "--premultiply")
251 | optPremultiply = true;
252 | else if (arg == "-t" || arg == "--trim")
253 | optTrim = true;
254 | else if (arg == "-v" || arg == "--verbose")
255 | optVerbose = true;
256 | else if (arg == "-f" || arg == "--force")
257 | optForce = true;
258 | else if (arg == "-u" || arg == "--unique")
259 | optUnique = true;
260 | else if (arg == "-r" || arg == "--rotate")
261 | optRotate = true;
262 | else if (arg.find("--size") == 0)
263 | optSize = GetPackSize(arg.substr(6));
264 | else if (arg.find("-s") == 0)
265 | optSize = GetPackSize(arg.substr(2));
266 | else if (arg.find("--pad") == 0)
267 | optPadding = GetPadding(arg.substr(5));
268 | else if (arg.find("-p") == 0)
269 | optPadding = GetPadding(arg.substr(2));
270 | else
271 | {
272 | cerr << "unexpected argument: " << arg << endl;
273 | return EXIT_FAILURE;
274 | }
275 | }
276 |
277 | //Hash the arguments and input directories
278 | size_t newHash = 0;
279 | for (int i = 1; i < argc; ++i)
280 | HashString(newHash, argv[i]);
281 | for (size_t i = 0; i < inputs.size(); ++i)
282 | {
283 | if (inputs[i].rfind('.') == string::npos)
284 | HashFiles(newHash, inputs[i]);
285 | else
286 | HashFile(newHash, inputs[i]);
287 | }
288 |
289 | //Load the old hash
290 | size_t oldHash;
291 | if (LoadHash(oldHash, outputDir + name + ".hash"))
292 | {
293 | if (!optForce && newHash == oldHash)
294 | {
295 | cout << "atlas is unchanged: " << name << endl;
296 | return EXIT_SUCCESS;
297 | }
298 | }
299 |
300 | /*-d --default use default settings (-x -p -t -u)
301 | -x --xml saves the atlas data as a .xml file
302 | -b --binary saves the atlas data as a .bin file
303 | -j --json saves the atlas data as a .json file
304 | -p --premultiply premultiplies the pixels of the bitmaps by their alpha channel
305 | -t --trim trims excess transparency off the bitmaps
306 | -v --verbose print to the debug console as the packer works
307 | -f --force ignore the hash, forcing the packer to repack
308 | -u --unique remove duplicate bitmaps from the atlas
309 | -r --rotate enabled rotating bitmaps 90 degrees clockwise when packing
310 | -s# --size# max atlas size (# can be 4096, 2048, 1024, 512, or 256)
311 | -p# --pad# padding between images (# can be from 0 to 16)*/
312 |
313 | if (optVerbose)
314 | {
315 | cout << "options..." << endl;
316 | cout << "\t--xml: " << (optXml ? "true" : "false") << endl;
317 | cout << "\t--binary: " << (optBinary ? "true" : "false") << endl;
318 | cout << "\t--json: " << (optJson ? "true" : "false") << endl;
319 | cout << "\t--premultiply: " << (optPremultiply ? "true" : "false") << endl;
320 | cout << "\t--trim: " << (optTrim ? "true" : "false") << endl;
321 | cout << "\t--verbose: " << (optVerbose ? "true" : "false") << endl;
322 | cout << "\t--force: " << (optForce ? "true" : "false") << endl;
323 | cout << "\t--unique: " << (optUnique ? "true" : "false") << endl;
324 | cout << "\t--rotate: " << (optRotate ? "true" : "false") << endl;
325 | cout << "\t--size: " << optSize << endl;
326 | cout << "\t--pad: " << optPadding << endl;
327 | }
328 |
329 | //Remove old files
330 | RemoveFile(outputDir + name + ".hash");
331 | RemoveFile(outputDir + name + ".bin");
332 | RemoveFile(outputDir + name + ".xml");
333 | RemoveFile(outputDir + name + ".json");
334 | for (size_t i = 0; i < 16; ++i)
335 | RemoveFile(outputDir + name + to_string(i) + ".png");
336 |
337 | //Load the bitmaps from all the input files and directories
338 | if (optVerbose)
339 | cout << "loading images..." << endl;
340 | for (size_t i = 0; i < inputs.size(); ++i)
341 | {
342 | if (inputs[i].rfind('.') != string::npos)
343 | LoadBitmap("", inputs[i]);
344 | else
345 | LoadBitmaps(inputs[i], "");
346 | }
347 |
348 | //Sort the bitmaps by area
349 | sort(bitmaps.begin(), bitmaps.end(), [](const Bitmap* a, const Bitmap* b) {
350 | return (a->width * a->height) < (b->width * b->height);
351 | });
352 |
353 | //Pack the bitmaps
354 | while (!bitmaps.empty())
355 | {
356 | if (optVerbose)
357 | cout << "packing " << bitmaps.size() << " images..." << endl;
358 | auto packer = new Packer(optSize, optSize, optPadding);
359 | packer->Pack(bitmaps, optVerbose, optUnique, optRotate);
360 | packers.push_back(packer);
361 | if (optVerbose)
362 | cout << "finished packing: " << name << to_string(packers.size() - 1) << " (" << packer->width << " x " << packer->height << ')' << endl;
363 |
364 | if (packer->bitmaps.empty())
365 | {
366 | cerr << "packing failed, could not fit bitmap: " << (bitmaps.back())->name << endl;
367 | return EXIT_FAILURE;
368 | }
369 | }
370 |
371 | //Save the atlas image
372 | for (size_t i = 0; i < packers.size(); ++i)
373 | {
374 | if (optVerbose)
375 | cout << "writing png: " << outputDir << name << to_string(i) << ".png" << endl;
376 | packers[i]->SavePng(outputDir + name + to_string(i) + ".png");
377 | }
378 |
379 | //Save the atlas binary
380 | if (optBinary)
381 | {
382 | if (optVerbose)
383 | cout << "writing bin: " << outputDir << name << ".bin" << endl;
384 |
385 | ofstream bin(outputDir + name + ".bin", ios::binary);
386 | WriteShort(bin, (int16_t)packers.size());
387 | for (size_t i = 0; i < packers.size(); ++i)
388 | packers[i]->SaveBin(name + to_string(i), bin, optTrim, optRotate);
389 | bin.close();
390 | }
391 |
392 | //Save the atlas xml
393 | if (optXml)
394 | {
395 | if (optVerbose)
396 | cout << "writing xml: " << outputDir << name << ".xml" << endl;
397 |
398 | ofstream xml(outputDir + name + ".xml");
399 | xml << "" << endl;
400 | for (size_t i = 0; i < packers.size(); ++i)
401 | packers[i]->SaveXml(name + to_string(i), xml, optTrim, optRotate);
402 | xml << "";
403 | }
404 |
405 | //Save the atlas json
406 | if (optJson)
407 | {
408 | if (optVerbose)
409 | cout << "writing json: " << outputDir << name << ".json" << endl;
410 |
411 | ofstream json(outputDir + name + ".json");
412 | json << '{' << endl;
413 | json << "\t\"textures\":[" << endl;
414 | for (size_t i = 0; i < packers.size(); ++i)
415 | {
416 | json << "\t\t{" << endl;
417 | packers[i]->SaveJson(name + to_string(i), json, optTrim, optRotate);
418 | json << "\t\t}";
419 | if (i + 1 < packers.size())
420 | json << ',';
421 | json << endl;
422 | }
423 | json << "\t]" << endl;
424 | json << '}';
425 | }
426 |
427 | //Save the new hash
428 | SaveHash(newHash, outputDir + name + ".hash");
429 |
430 | return EXIT_SUCCESS;
431 | }
432 |
--------------------------------------------------------------------------------
/crunch/packer.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #include "packer.hpp"
28 | #include "MaxRectsBinPack.h"
29 | #include "GuillotineBinPack.h"
30 | #include "binary.hpp"
31 | #include
32 | #include
33 |
34 | using namespace std;
35 | using namespace rbp;
36 |
37 | Packer::Packer(int width, int height, int pad)
38 | : width(width), height(height), pad(pad)
39 | {
40 |
41 | }
42 |
43 | void Packer::Pack(vector& bitmaps, bool verbose, bool unique, bool rotate)
44 | {
45 | MaxRectsBinPack packer(width, height);
46 |
47 | int ww = 0;
48 | int hh = 0;
49 | while (!bitmaps.empty())
50 | {
51 | auto bitmap = bitmaps.back();
52 |
53 | if (verbose)
54 | cout << '\t' << bitmaps.size() << ": " << bitmap->name << endl;
55 |
56 | //Check to see if this is a duplicate of an already packed bitmap
57 | if (unique)
58 | {
59 | auto di = dupLookup.find(bitmap->hashValue);
60 | if (di != dupLookup.end() && bitmap->Equals(this->bitmaps[di->second]))
61 | {
62 | Point p = points[di->second];
63 | p.dupID = di->second;
64 | points.push_back(p);
65 | this->bitmaps.push_back(bitmap);
66 | bitmaps.pop_back();
67 | continue;
68 | }
69 | }
70 |
71 | //If it's not a duplicate, pack it into the atlas
72 | {
73 | Rect rect = packer.Insert(bitmap->width + pad, bitmap->height + pad, rotate, MaxRectsBinPack::RectBestShortSideFit);
74 |
75 | if (rect.width == 0 || rect.height == 0)
76 | break;
77 |
78 | if (unique)
79 | dupLookup[bitmap->hashValue] = static_cast(points.size());
80 |
81 | //Check if we rotated it
82 | Point p;
83 | p.x = rect.x;
84 | p.y = rect.y;
85 | p.dupID = -1;
86 | p.rot = rotate && bitmap->width != (rect.width - pad);
87 |
88 | points.push_back(p);
89 | this->bitmaps.push_back(bitmap);
90 | bitmaps.pop_back();
91 |
92 | ww = max(rect.x + rect.width, ww);
93 | hh = max(rect.y + rect.height, hh);
94 | }
95 | }
96 |
97 | while (width / 2 >= ww)
98 | width /= 2;
99 | while( height / 2 >= hh)
100 | height /= 2;
101 | }
102 |
103 | void Packer::SavePng(const string& file)
104 | {
105 | Bitmap bitmap(width, height);
106 | for (size_t i = 0, j = bitmaps.size(); i < j; ++i)
107 | {
108 | if (points[i].dupID < 0)
109 | {
110 | if (points[i].rot)
111 | bitmap.CopyPixelsRot(bitmaps[i], points[i].x, points[i].y);
112 | else
113 | bitmap.CopyPixels(bitmaps[i], points[i].x, points[i].y);
114 | }
115 | }
116 | bitmap.SaveAs(file);
117 | }
118 |
119 | void Packer::SaveXml(const string& name, ofstream& xml, bool trim, bool rotate)
120 | {
121 | xml << "\t" << endl;
122 | for (size_t i = 0, j = bitmaps.size(); i < j; ++i)
123 | {
124 | xml << "\t\tname << "\" ";
125 | xml << "x=\"" << points[i].x << "\" ";
126 | xml << "y=\"" << points[i].y << "\" ";
127 | xml << "w=\"" << bitmaps[i]->width << "\" ";
128 | xml << "h=\"" << bitmaps[i]->height << "\" ";
129 | if (trim)
130 | {
131 | xml << "fx=\"" << bitmaps[i]->frameX << "\" ";
132 | xml << "fy=\"" << bitmaps[i]->frameY << "\" ";
133 | xml << "fw=\"" << bitmaps[i]->frameW << "\" ";
134 | xml << "fh=\"" << bitmaps[i]->frameH << "\" ";
135 | }
136 | if (rotate)
137 | xml << "r=\"" << (points[i].rot ? 1 : 0) << "\" ";
138 | xml << "/>" << endl;
139 | }
140 | xml << "\t" << endl;
141 | }
142 |
143 | void Packer::SaveBin(const string& name, ofstream& bin, bool trim, bool rotate)
144 | {
145 | WriteString(bin, name);
146 | WriteShort(bin, (int16_t)bitmaps.size());
147 | for (size_t i = 0, j = bitmaps.size(); i < j; ++i)
148 | {
149 | WriteString(bin, bitmaps[i]->name);
150 | WriteShort(bin, (int16_t)points[i].x);
151 | WriteShort(bin, (int16_t)points[i].y);
152 | WriteShort(bin, (int16_t)bitmaps[i]->width);
153 | WriteShort(bin, (int16_t)bitmaps[i]->height);
154 | if (trim)
155 | {
156 | WriteShort(bin, (int16_t)bitmaps[i]->frameX);
157 | WriteShort(bin, (int16_t)bitmaps[i]->frameY);
158 | WriteShort(bin, (int16_t)bitmaps[i]->frameW);
159 | WriteShort(bin, (int16_t)bitmaps[i]->frameH);
160 | }
161 | if (rotate)
162 | WriteByte(bin, points[i].rot ? 1 : 0);
163 | }
164 | }
165 |
166 | void Packer::SaveJson(const string& name, ofstream& json, bool trim, bool rotate)
167 | {
168 | json << "\t\t\t\"name\":\"" << name << "\"," << endl;
169 | json << "\t\t\t\"images\":[" << endl;
170 | for (size_t i = 0, j = bitmaps.size(); i < j; ++i)
171 | {
172 | json << "\t\t\t\t{ ";
173 | json << "\"n\":\"" << bitmaps[i]->name << "\", ";
174 | json << "\"x\":" << points[i].x << ", ";
175 | json << "\"y\":" << points[i].y << ", ";
176 | json << "\"w\":" << bitmaps[i]->width << ", ";
177 | json << "\"h\":" << bitmaps[i]->height;
178 | if (trim)
179 | {
180 | json << ", \"fx\":" << bitmaps[i]->frameX << ", ";
181 | json << "\"fy\":" << bitmaps[i]->frameY << ", ";
182 | json << "\"fw\":" << bitmaps[i]->frameW << ", ";
183 | json << "\"fh\":" << bitmaps[i]->frameH;
184 | }
185 | if (rotate)
186 | json << ", \"r\":" << (points[i].rot ? "true" : "false");
187 | json << " }";
188 | if(i != bitmaps.size() -1)
189 | json << ",";
190 | json << endl;
191 | }
192 | json << "\t\t\t]" << endl;
193 | }
194 |
--------------------------------------------------------------------------------
/crunch/packer.hpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #ifndef packer_hpp
28 | #define packer_hpp
29 |
30 | #include
31 | #include
32 | #include
33 | #include "bitmap.hpp"
34 |
35 | using namespace std;
36 |
37 | struct Point
38 | {
39 | int x;
40 | int y;
41 | int dupID;
42 | bool rot;
43 | };
44 |
45 | struct Packer
46 | {
47 | int width;
48 | int height;
49 | int pad;
50 |
51 | vector bitmaps;
52 | vector points;
53 | unordered_map dupLookup;
54 |
55 | Packer(int width, int height, int pad);
56 | void Pack(vector& bitmaps, bool verbose, bool unique, bool rotate);
57 | void SavePng(const string& file);
58 | void SaveXml(const string& name, ofstream& xml, bool trim, bool rotate);
59 | void SaveBin(const string& name, ofstream& bin, bool trim, bool rotate);
60 | void SaveJson(const string& name, ofstream& json, bool trim, bool rotate);
61 | };
62 |
63 | #endif
64 |
--------------------------------------------------------------------------------
/crunch/str.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #include "str.hpp"
28 |
29 | #if defined _MSC_VER || defined __MINGW32__
30 | #include
31 | #include
32 | wstring StrToPath(const string& str)
33 | {
34 | std::wstring_convert> converter;
35 | return converter.from_bytes(str);
36 | }
37 | string PathToStr(const wstring& str)
38 | {
39 | std::wstring_convert> converter;
40 | return converter.to_bytes(str);
41 | }
42 | #else
43 | const string& StrToPath(const string& str)
44 | {
45 | return str;
46 | }
47 | const string& PathToStr(const string& str)
48 | {
49 | return str;
50 | }
51 | #endif
52 |
--------------------------------------------------------------------------------
/crunch/str.hpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | MIT License
4 |
5 | Copyright (c) 2017 Chevy Ray Johnston
6 |
7 | Permission is hereby granted, free of charge, to any person obtaining a copy
8 | of this software and associated documentation files (the "Software"), to deal
9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 |
14 | The above copyright notice and this permission notice shall be included in all
15 | copies or substantial portions of the Software.
16 |
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 | SOFTWARE.
24 |
25 | */
26 |
27 | #ifndef str_hpp
28 | #define str_hpp
29 |
30 | #include
31 | using namespace std;
32 |
33 | #if defined _MSC_VER || defined __MINGW32__
34 | #include
35 | #include
36 | wstring StrToPath(const string& str);
37 | string PathToStr(const wstring& str);
38 | #else
39 | const string& StrToPath(const string& str);
40 | const string& PathToStr(const string& str);
41 | #endif
42 |
43 | #endif
44 |
--------------------------------------------------------------------------------
/crunch/tinydir.h:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright (c) 2013-2016, tinydir authors:
3 | - Cong Xu
4 | - Lautis Sun
5 | - Baudouin Feildel
6 | - Andargor
7 | All rights reserved.
8 |
9 | Redistribution and use in source and binary forms, with or without
10 | modification, are permitted provided that the following conditions are met:
11 |
12 | 1. Redistributions of source code must retain the above copyright notice, this
13 | list of conditions and the following disclaimer.
14 | 2. Redistributions in binary form must reproduce the above copyright notice,
15 | this list of conditions and the following disclaimer in the documentation
16 | and/or other materials provided with the distribution.
17 |
18 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22 | ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 | */
29 | #ifndef TINYDIR_H
30 | #define TINYDIR_H
31 |
32 | #ifdef __cplusplus
33 | extern "C" {
34 | #endif
35 |
36 | #if ((defined _UNICODE) && !(defined UNICODE))
37 | #define UNICODE
38 | #endif
39 |
40 | #if ((defined UNICODE) && !(defined _UNICODE))
41 | #define _UNICODE
42 | #endif
43 |
44 | #include
45 | #include
46 | #include
47 | #ifdef _MSC_VER
48 | # define WIN32_LEAN_AND_MEAN
49 | # include
50 | # include
51 | # pragma warning(push)
52 | # pragma warning (disable : 4996)
53 | #else
54 | # include
55 | # include
56 | # include
57 | # include
58 | #endif
59 | #ifdef __MINGW32__
60 | # include
61 | #endif
62 |
63 |
64 | /* types */
65 |
66 | /* Windows UNICODE wide character support */
67 | #if defined _MSC_VER || defined __MINGW32__
68 | #define _tinydir_char_t TCHAR
69 | #define TINYDIR_STRING(s) _TEXT(s)
70 | #define _tinydir_strlen _tcslen
71 | #define _tinydir_strcpy _tcscpy
72 | #define _tinydir_strcat _tcscat
73 | #define _tinydir_strcmp _tcscmp
74 | #define _tinydir_strrchr _tcsrchr
75 | #define _tinydir_strncmp _tcsncmp
76 | #else
77 | #define _tinydir_char_t char
78 | #define TINYDIR_STRING(s) s
79 | #define _tinydir_strlen strlen
80 | #define _tinydir_strcpy strcpy
81 | #define _tinydir_strcat strcat
82 | #define _tinydir_strcmp strcmp
83 | #define _tinydir_strrchr strrchr
84 | #define _tinydir_strncmp strncmp
85 | #endif
86 |
87 | #if (defined _MSC_VER || defined __MINGW32__)
88 | #include
89 | #define _TINYDIR_PATH_MAX MAX_PATH
90 | #elif defined __linux__
91 | #include
92 | #define _TINYDIR_PATH_MAX PATH_MAX
93 | #else
94 | #define _TINYDIR_PATH_MAX 4096
95 | #endif
96 |
97 | #ifdef _MSC_VER
98 | /* extra chars for the "\\*" mask */
99 | # define _TINYDIR_PATH_EXTRA 2
100 | #else
101 | # define _TINYDIR_PATH_EXTRA 0
102 | #endif
103 |
104 | #define _TINYDIR_FILENAME_MAX 256
105 |
106 | #if (defined _MSC_VER || defined __MINGW32__)
107 | #define _TINYDIR_DRIVE_MAX 3
108 | #endif
109 |
110 | #ifdef _MSC_VER
111 | # define _TINYDIR_FUNC static __inline
112 | #elif !defined __STDC_VERSION__ || __STDC_VERSION__ < 199901L
113 | # define _TINYDIR_FUNC static __inline__
114 | #else
115 | # define _TINYDIR_FUNC static inline
116 | #endif
117 |
118 | /* readdir_r usage; define TINYDIR_USE_READDIR_R to use it (if supported) */
119 | #ifdef TINYDIR_USE_READDIR_R
120 |
121 | /* readdir_r is a POSIX-only function, and may not be available under various
122 | * environments/settings, e.g. MinGW. Use readdir fallback */
123 | #if _POSIX_C_SOURCE >= 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE ||\
124 | _POSIX_SOURCE
125 | # define _TINYDIR_HAS_READDIR_R
126 | #endif
127 | #if _POSIX_C_SOURCE >= 200112L
128 | # define _TINYDIR_HAS_FPATHCONF
129 | # include
130 | #endif
131 | #if _BSD_SOURCE || _SVID_SOURCE || \
132 | (_POSIX_C_SOURCE >= 200809L || _XOPEN_SOURCE >= 700)
133 | # define _TINYDIR_HAS_DIRFD
134 | # include
135 | #endif
136 | #if defined _TINYDIR_HAS_FPATHCONF && defined _TINYDIR_HAS_DIRFD &&\
137 | defined _PC_NAME_MAX
138 | # define _TINYDIR_USE_FPATHCONF
139 | #endif
140 | #if defined __MINGW32__ || !defined _TINYDIR_HAS_READDIR_R ||\
141 | !(defined _TINYDIR_USE_FPATHCONF || defined NAME_MAX)
142 | # define _TINYDIR_USE_READDIR
143 | #endif
144 |
145 | /* Use readdir by default */
146 | #else
147 | # define _TINYDIR_USE_READDIR
148 | #endif
149 |
150 | /* MINGW32 has two versions of dirent, ASCII and UNICODE*/
151 | #ifndef _MSC_VER
152 | #if (defined __MINGW32__) && (defined _UNICODE)
153 | #define _TINYDIR_DIR _WDIR
154 | #define _tinydir_dirent _wdirent
155 | #define _tinydir_opendir _wopendir
156 | #define _tinydir_readdir _wreaddir
157 | #define _tinydir_closedir _wclosedir
158 | #else
159 | #define _TINYDIR_DIR DIR
160 | #define _tinydir_dirent dirent
161 | #define _tinydir_opendir opendir
162 | #define _tinydir_readdir readdir
163 | #define _tinydir_closedir closedir
164 | #endif
165 | #endif
166 |
167 | /* Allow user to use a custom allocator by defining _TINYDIR_MALLOC and _TINYDIR_FREE. */
168 | #if defined(_TINYDIR_MALLOC) && defined(_TINYDIR_FREE)
169 | #elif !defined(_TINYDIR_MALLOC) && !defined(_TINYDIR_FREE)
170 | #else
171 | #error "Either define both alloc and free or none of them!"
172 | #endif
173 |
174 | #if !defined(_TINYDIR_MALLOC)
175 | #define _TINYDIR_MALLOC(_size) malloc(_size)
176 | #define _TINYDIR_FREE(_ptr) free(_ptr)
177 | #endif /* !defined(_TINYDIR_MALLOC) */
178 |
179 | typedef struct tinydir_file
180 | {
181 | _tinydir_char_t path[_TINYDIR_PATH_MAX];
182 | _tinydir_char_t name[_TINYDIR_FILENAME_MAX];
183 | _tinydir_char_t *extension;
184 | int is_dir;
185 | int is_reg;
186 |
187 | #ifndef _MSC_VER
188 | #ifdef __MINGW32__
189 | struct _stat _s;
190 | #else
191 | struct stat _s;
192 | #endif
193 | #endif
194 | } tinydir_file;
195 |
196 | typedef struct tinydir_dir
197 | {
198 | _tinydir_char_t path[_TINYDIR_PATH_MAX];
199 | int has_next;
200 | size_t n_files;
201 |
202 | tinydir_file *_files;
203 | #ifdef _MSC_VER
204 | HANDLE _h;
205 | WIN32_FIND_DATA _f;
206 | #else
207 | _TINYDIR_DIR *_d;
208 | struct _tinydir_dirent *_e;
209 | #ifndef _TINYDIR_USE_READDIR
210 | struct _tinydir_dirent *_ep;
211 | #endif
212 | #endif
213 | } tinydir_dir;
214 |
215 |
216 | /* declarations */
217 |
218 | _TINYDIR_FUNC
219 | int tinydir_open(tinydir_dir *dir, const _tinydir_char_t *path);
220 | _TINYDIR_FUNC
221 | int tinydir_open_sorted(tinydir_dir *dir, const _tinydir_char_t *path);
222 | _TINYDIR_FUNC
223 | void tinydir_close(tinydir_dir *dir);
224 |
225 | _TINYDIR_FUNC
226 | int tinydir_next(tinydir_dir *dir);
227 | _TINYDIR_FUNC
228 | int tinydir_readfile(const tinydir_dir *dir, tinydir_file *file);
229 | _TINYDIR_FUNC
230 | int tinydir_readfile_n(const tinydir_dir *dir, tinydir_file *file, size_t i);
231 | _TINYDIR_FUNC
232 | int tinydir_open_subdir_n(tinydir_dir *dir, size_t i);
233 |
234 | _TINYDIR_FUNC
235 | int tinydir_file_open(tinydir_file *file, const _tinydir_char_t *path);
236 | _TINYDIR_FUNC
237 | void _tinydir_get_ext(tinydir_file *file);
238 | _TINYDIR_FUNC
239 | int _tinydir_file_cmp(const void *a, const void *b);
240 | #ifndef _MSC_VER
241 | #ifndef _TINYDIR_USE_READDIR
242 | _TINYDIR_FUNC
243 | size_t _tinydir_dirent_buf_size(_TINYDIR_DIR *dirp);
244 | #endif
245 | #endif
246 |
247 |
248 | /* definitions*/
249 |
250 | _TINYDIR_FUNC
251 | int tinydir_open(tinydir_dir *dir, const _tinydir_char_t *path)
252 | {
253 | #ifndef _MSC_VER
254 | #ifndef _TINYDIR_USE_READDIR
255 | int error;
256 | int size; /* using int size */
257 | #endif
258 | #else
259 | _tinydir_char_t path_buf[_TINYDIR_PATH_MAX];
260 | #endif
261 | _tinydir_char_t *pathp;
262 |
263 | if (dir == NULL || path == NULL || _tinydir_strlen(path) == 0)
264 | {
265 | errno = EINVAL;
266 | return -1;
267 | }
268 | if (_tinydir_strlen(path) + _TINYDIR_PATH_EXTRA >= _TINYDIR_PATH_MAX)
269 | {
270 | errno = ENAMETOOLONG;
271 | return -1;
272 | }
273 |
274 | /* initialise dir */
275 | dir->_files = NULL;
276 | #ifdef _MSC_VER
277 | dir->_h = INVALID_HANDLE_VALUE;
278 | #else
279 | dir->_d = NULL;
280 | #ifndef _TINYDIR_USE_READDIR
281 | dir->_ep = NULL;
282 | #endif
283 | #endif
284 | tinydir_close(dir);
285 |
286 | _tinydir_strcpy(dir->path, path);
287 | /* Remove trailing slashes */
288 | pathp = &dir->path[_tinydir_strlen(dir->path) - 1];
289 | while (pathp != dir->path && (*pathp == TINYDIR_STRING('\\') || *pathp == TINYDIR_STRING('/')))
290 | {
291 | *pathp = TINYDIR_STRING('\0');
292 | pathp++;
293 | }
294 | #ifdef _MSC_VER
295 | _tinydir_strcpy(path_buf, dir->path);
296 | _tinydir_strcat(path_buf, TINYDIR_STRING("\\*"));
297 | dir->_h = FindFirstFile(path_buf, &dir->_f);
298 | if (dir->_h == INVALID_HANDLE_VALUE)
299 | {
300 | errno = ENOENT;
301 | #else
302 | dir->_d = _tinydir_opendir(path);
303 | if (dir->_d == NULL)
304 | {
305 | #endif
306 | goto bail;
307 | }
308 |
309 | /* read first file */
310 | dir->has_next = 1;
311 | #ifndef _MSC_VER
312 | #ifdef _TINYDIR_USE_READDIR
313 | dir->_e = _tinydir_readdir(dir->_d);
314 | #else
315 | /* allocate dirent buffer for readdir_r */
316 | size = _tinydir_dirent_buf_size(dir->_d); /* conversion to int */
317 | if (size == -1) return -1;
318 | dir->_ep = (struct _tinydir_dirent*)_TINYDIR_MALLOC(size);
319 | if (dir->_ep == NULL) return -1;
320 |
321 | error = readdir_r(dir->_d, dir->_ep, &dir->_e);
322 | if (error != 0) return -1;
323 | #endif
324 | if (dir->_e == NULL)
325 | {
326 | dir->has_next = 0;
327 | }
328 | #endif
329 |
330 | return 0;
331 |
332 | bail:
333 | tinydir_close(dir);
334 | return -1;
335 | }
336 |
337 | _TINYDIR_FUNC
338 | int tinydir_open_sorted(tinydir_dir *dir, const _tinydir_char_t *path)
339 | {
340 | /* Count the number of files first, to pre-allocate the files array */
341 | size_t n_files = 0;
342 | if (tinydir_open(dir, path) == -1)
343 | {
344 | return -1;
345 | }
346 | while (dir->has_next)
347 | {
348 | n_files++;
349 | if (tinydir_next(dir) == -1)
350 | {
351 | goto bail;
352 | }
353 | }
354 | tinydir_close(dir);
355 |
356 | if (tinydir_open(dir, path) == -1)
357 | {
358 | return -1;
359 | }
360 |
361 | dir->n_files = 0;
362 | dir->_files = (tinydir_file *)_TINYDIR_MALLOC(sizeof *dir->_files * n_files);
363 | if (dir->_files == NULL)
364 | {
365 | goto bail;
366 | }
367 | while (dir->has_next)
368 | {
369 | tinydir_file *p_file;
370 | dir->n_files++;
371 |
372 | p_file = &dir->_files[dir->n_files - 1];
373 | if (tinydir_readfile(dir, p_file) == -1)
374 | {
375 | goto bail;
376 | }
377 |
378 | if (tinydir_next(dir) == -1)
379 | {
380 | goto bail;
381 | }
382 |
383 | /* Just in case the number of files has changed between the first and
384 | second reads, terminate without writing into unallocated memory */
385 | if (dir->n_files == n_files)
386 | {
387 | break;
388 | }
389 | }
390 |
391 | qsort(dir->_files, dir->n_files, sizeof(tinydir_file), _tinydir_file_cmp);
392 |
393 | return 0;
394 |
395 | bail:
396 | tinydir_close(dir);
397 | return -1;
398 | }
399 |
400 | _TINYDIR_FUNC
401 | void tinydir_close(tinydir_dir *dir)
402 | {
403 | if (dir == NULL)
404 | {
405 | return;
406 | }
407 |
408 | memset(dir->path, 0, sizeof(dir->path));
409 | dir->has_next = 0;
410 | dir->n_files = 0;
411 | _TINYDIR_FREE(dir->_files);
412 | dir->_files = NULL;
413 | #ifdef _MSC_VER
414 | if (dir->_h != INVALID_HANDLE_VALUE)
415 | {
416 | FindClose(dir->_h);
417 | }
418 | dir->_h = INVALID_HANDLE_VALUE;
419 | #else
420 | if (dir->_d)
421 | {
422 | _tinydir_closedir(dir->_d);
423 | }
424 | dir->_d = NULL;
425 | dir->_e = NULL;
426 | #ifndef _TINYDIR_USE_READDIR
427 | _TINYDIR_FREE(dir->_ep);
428 | dir->_ep = NULL;
429 | #endif
430 | #endif
431 | }
432 |
433 | _TINYDIR_FUNC
434 | int tinydir_next(tinydir_dir *dir)
435 | {
436 | if (dir == NULL)
437 | {
438 | errno = EINVAL;
439 | return -1;
440 | }
441 | if (!dir->has_next)
442 | {
443 | errno = ENOENT;
444 | return -1;
445 | }
446 |
447 | #ifdef _MSC_VER
448 | if (FindNextFile(dir->_h, &dir->_f) == 0)
449 | #else
450 | #ifdef _TINYDIR_USE_READDIR
451 | dir->_e = _tinydir_readdir(dir->_d);
452 | #else
453 | if (dir->_ep == NULL)
454 | {
455 | return -1;
456 | }
457 | if (readdir_r(dir->_d, dir->_ep, &dir->_e) != 0)
458 | {
459 | return -1;
460 | }
461 | #endif
462 | if (dir->_e == NULL)
463 | #endif
464 | {
465 | dir->has_next = 0;
466 | #ifdef _MSC_VER
467 | if (GetLastError() != ERROR_SUCCESS &&
468 | GetLastError() != ERROR_NO_MORE_FILES)
469 | {
470 | tinydir_close(dir);
471 | errno = EIO;
472 | return -1;
473 | }
474 | #endif
475 | }
476 |
477 | return 0;
478 | }
479 |
480 | _TINYDIR_FUNC
481 | int tinydir_readfile(const tinydir_dir *dir, tinydir_file *file)
482 | {
483 | if (dir == NULL || file == NULL)
484 | {
485 | errno = EINVAL;
486 | return -1;
487 | }
488 | #ifdef _MSC_VER
489 | if (dir->_h == INVALID_HANDLE_VALUE)
490 | #else
491 | if (dir->_e == NULL)
492 | #endif
493 | {
494 | errno = ENOENT;
495 | return -1;
496 | }
497 | if (_tinydir_strlen(dir->path) +
498 | _tinydir_strlen(
499 | #ifdef _MSC_VER
500 | dir->_f.cFileName
501 | #else
502 | dir->_e->d_name
503 | #endif
504 | ) + 1 + _TINYDIR_PATH_EXTRA >=
505 | _TINYDIR_PATH_MAX)
506 | {
507 | /* the path for the file will be too long */
508 | errno = ENAMETOOLONG;
509 | return -1;
510 | }
511 | if (_tinydir_strlen(
512 | #ifdef _MSC_VER
513 | dir->_f.cFileName
514 | #else
515 | dir->_e->d_name
516 | #endif
517 | ) >= _TINYDIR_FILENAME_MAX)
518 | {
519 | errno = ENAMETOOLONG;
520 | return -1;
521 | }
522 |
523 | _tinydir_strcpy(file->path, dir->path);
524 | _tinydir_strcat(file->path, TINYDIR_STRING("/"));
525 | _tinydir_strcpy(file->name,
526 | #ifdef _MSC_VER
527 | dir->_f.cFileName
528 | #else
529 | dir->_e->d_name
530 | #endif
531 | );
532 | _tinydir_strcat(file->path, file->name);
533 | #ifndef _MSC_VER
534 | #ifdef __MINGW32__
535 | if (_tstat(
536 | #else
537 | if (stat(
538 | #endif
539 | file->path, &file->_s) == -1)
540 | {
541 | return -1;
542 | }
543 | #endif
544 | _tinydir_get_ext(file);
545 |
546 | file->is_dir =
547 | #ifdef _MSC_VER
548 | !!(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY);
549 | #else
550 | S_ISDIR(file->_s.st_mode);
551 | #endif
552 | file->is_reg =
553 | #ifdef _MSC_VER
554 | !!(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_NORMAL) ||
555 | (
556 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_DEVICE) &&
557 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) &&
558 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_ENCRYPTED) &&
559 | #ifdef FILE_ATTRIBUTE_INTEGRITY_STREAM
560 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_INTEGRITY_STREAM) &&
561 | #endif
562 | #ifdef FILE_ATTRIBUTE_NO_SCRUB_DATA
563 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_NO_SCRUB_DATA) &&
564 | #endif
565 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_OFFLINE) &&
566 | !(dir->_f.dwFileAttributes & FILE_ATTRIBUTE_TEMPORARY));
567 | #else
568 | S_ISREG(file->_s.st_mode);
569 | #endif
570 |
571 | return 0;
572 | }
573 |
574 | _TINYDIR_FUNC
575 | int tinydir_readfile_n(const tinydir_dir *dir, tinydir_file *file, size_t i)
576 | {
577 | if (dir == NULL || file == NULL)
578 | {
579 | errno = EINVAL;
580 | return -1;
581 | }
582 | if (i >= dir->n_files)
583 | {
584 | errno = ENOENT;
585 | return -1;
586 | }
587 |
588 | memcpy(file, &dir->_files[i], sizeof(tinydir_file));
589 | _tinydir_get_ext(file);
590 |
591 | return 0;
592 | }
593 |
594 | _TINYDIR_FUNC
595 | int tinydir_open_subdir_n(tinydir_dir *dir, size_t i)
596 | {
597 | _tinydir_char_t path[_TINYDIR_PATH_MAX];
598 | if (dir == NULL)
599 | {
600 | errno = EINVAL;
601 | return -1;
602 | }
603 | if (i >= dir->n_files || !dir->_files[i].is_dir)
604 | {
605 | errno = ENOENT;
606 | return -1;
607 | }
608 |
609 | _tinydir_strcpy(path, dir->_files[i].path);
610 | tinydir_close(dir);
611 | if (tinydir_open_sorted(dir, path) == -1)
612 | {
613 | return -1;
614 | }
615 |
616 | return 0;
617 | }
618 |
619 | /* Open a single file given its path */
620 | _TINYDIR_FUNC
621 | int tinydir_file_open(tinydir_file *file, const _tinydir_char_t *path)
622 | {
623 | tinydir_dir dir;
624 | int result = 0;
625 | int found = 0;
626 | _tinydir_char_t dir_name_buf[_TINYDIR_PATH_MAX];
627 | _tinydir_char_t file_name_buf[_TINYDIR_FILENAME_MAX];
628 | _tinydir_char_t *dir_name;
629 | _tinydir_char_t *base_name;
630 | #if (defined _MSC_VER || defined __MINGW32__)
631 | _tinydir_char_t drive_buf[_TINYDIR_DRIVE_MAX];
632 | _tinydir_char_t ext_buf[_TINYDIR_FILENAME_MAX];
633 | #endif
634 |
635 | if (file == NULL || path == NULL || _tinydir_strlen(path) == 0)
636 | {
637 | errno = EINVAL;
638 | return -1;
639 | }
640 | if (_tinydir_strlen(path) + _TINYDIR_PATH_EXTRA >= _TINYDIR_PATH_MAX)
641 | {
642 | errno = ENAMETOOLONG;
643 | return -1;
644 | }
645 |
646 | /* Get the parent path */
647 | #if (defined _MSC_VER || defined __MINGW32__)
648 | #if ((defined _MSC_VER) && (_MSC_VER >= 1400))
649 | _tsplitpath_s(
650 | path,
651 | drive_buf, _TINYDIR_DRIVE_MAX,
652 | dir_name_buf, _TINYDIR_FILENAME_MAX,
653 | file_name_buf, _TINYDIR_FILENAME_MAX,
654 | ext_buf, _TINYDIR_FILENAME_MAX);
655 | #else
656 | _tsplitpath(
657 | path,
658 | drive_buf,
659 | dir_name_buf,
660 | file_name_buf,
661 | ext_buf);
662 | #endif
663 |
664 | /* _splitpath_s not work fine with only filename and widechar support */
665 | #ifdef _UNICODE
666 | if (drive_buf[0] == L'\xFEFE')
667 | drive_buf[0] = '\0';
668 | if (dir_name_buf[0] == L'\xFEFE')
669 | dir_name_buf[0] = '\0';
670 | #endif
671 |
672 | if (errno)
673 | {
674 | errno = EINVAL;
675 | return -1;
676 | }
677 | /* Emulate the behavior of dirname by returning "." for dir name if it's
678 | empty */
679 | if (drive_buf[0] == '\0' && dir_name_buf[0] == '\0')
680 | {
681 | _tinydir_strcpy(dir_name_buf, TINYDIR_STRING("."));
682 | }
683 | /* Concatenate the drive letter and dir name to form full dir name */
684 | _tinydir_strcat(drive_buf, dir_name_buf);
685 | dir_name = drive_buf;
686 | /* Concatenate the file name and extension to form base name */
687 | _tinydir_strcat(file_name_buf, ext_buf);
688 | base_name = file_name_buf;
689 | #else
690 | _tinydir_strcpy(dir_name_buf, path);
691 | dir_name = dirname(dir_name_buf);
692 | _tinydir_strcpy(file_name_buf, path);
693 | base_name =basename(file_name_buf);
694 | #endif
695 |
696 | /* Open the parent directory */
697 | if (tinydir_open(&dir, dir_name) == -1)
698 | {
699 | return -1;
700 | }
701 |
702 | /* Read through the parent directory and look for the file */
703 | while (dir.has_next)
704 | {
705 | if (tinydir_readfile(&dir, file) == -1)
706 | {
707 | result = -1;
708 | goto bail;
709 | }
710 | if (_tinydir_strcmp(file->name, base_name) == 0)
711 | {
712 | /* File found */
713 | found = 1;
714 | break;
715 | }
716 | tinydir_next(&dir);
717 | }
718 | if (!found)
719 | {
720 | result = -1;
721 | errno = ENOENT;
722 | }
723 |
724 | bail:
725 | tinydir_close(&dir);
726 | return result;
727 | }
728 |
729 | _TINYDIR_FUNC
730 | void _tinydir_get_ext(tinydir_file *file)
731 | {
732 | _tinydir_char_t *period = _tinydir_strrchr(file->name, TINYDIR_STRING('.'));
733 | if (period == NULL)
734 | {
735 | file->extension = &(file->name[_tinydir_strlen(file->name)]);
736 | }
737 | else
738 | {
739 | file->extension = period + 1;
740 | }
741 | }
742 |
743 | _TINYDIR_FUNC
744 | int _tinydir_file_cmp(const void *a, const void *b)
745 | {
746 | const tinydir_file *fa = (const tinydir_file *)a;
747 | const tinydir_file *fb = (const tinydir_file *)b;
748 | if (fa->is_dir != fb->is_dir)
749 | {
750 | return -(fa->is_dir - fb->is_dir);
751 | }
752 | return _tinydir_strncmp(fa->name, fb->name, _TINYDIR_FILENAME_MAX);
753 | }
754 |
755 | #ifndef _MSC_VER
756 | #ifndef _TINYDIR_USE_READDIR
757 | /*
758 | The following authored by Ben Hutchings
759 | from https://womble.decadent.org.uk/readdir_r-advisory.html
760 | */
761 | /* Calculate the required buffer size (in bytes) for directory *
762 | * entries read from the given directory handle. Return -1 if this *
763 | * this cannot be done. *
764 | * *
765 | * This code does not trust values of NAME_MAX that are less than *
766 | * 255, since some systems (including at least HP-UX) incorrectly *
767 | * define it to be a smaller value. */
768 | _TINYDIR_FUNC
769 | size_t _tinydir_dirent_buf_size(_TINYDIR_DIR *dirp)
770 | {
771 | long name_max;
772 | size_t name_end;
773 | /* parameter may be unused */
774 | (void)dirp;
775 |
776 | #if defined _TINYDIR_USE_FPATHCONF
777 | name_max = fpathconf(dirfd(dirp), _PC_NAME_MAX);
778 | if (name_max == -1)
779 | #if defined(NAME_MAX)
780 | name_max = (NAME_MAX > 255) ? NAME_MAX : 255;
781 | #else
782 | return (size_t)(-1);
783 | #endif
784 | #elif defined(NAME_MAX)
785 | name_max = (NAME_MAX > 255) ? NAME_MAX : 255;
786 | #else
787 | #error "buffer size for readdir_r cannot be determined"
788 | #endif
789 | name_end = (size_t)offsetof(struct _tinydir_dirent, d_name) + name_max + 1;
790 | return (name_end > sizeof(struct _tinydir_dirent) ?
791 | name_end : sizeof(struct _tinydir_dirent));
792 | }
793 | #endif
794 | #endif
795 |
796 | #ifdef __cplusplus
797 | }
798 | #endif
799 |
800 | # if defined (_MSC_VER)
801 | # pragma warning(pop)
802 | # endif
803 |
804 | #endif
805 |
--------------------------------------------------------------------------------