├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmignore ├── LICENSE ├── README.md ├── contour-tracing.js ├── package-lock.json ├── package.json ├── src ├── contour-tracing.ts ├── index.ts ├── utils.ts └── vectorize-pixelart.ts ├── test ├── composer.test.ts └── tracing.test.ts ├── tsconfig.json └── utils.js /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | # Allows you to run this workflow manually from the Actions tab 10 | workflow_dispatch: 11 | 12 | jobs: 13 | build-test: 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - uses: actions/checkout@v3 18 | - uses: actions/setup-node@v3 19 | with: 20 | node-version: '16' 21 | 22 | - run: npm install 23 | - run: npm run lint 24 | - run: npm run build 25 | - run: npm run test 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | # Ignore test files 64 | out.* 65 | 66 | lib/ 67 | /*.png -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | *.png 2 | *.svg 3 | *.eps 4 | browser.js 5 | bundle.js* 6 | *.tgz 7 | vectorize-pixelart-bundle.js 8 | .travis.yml 9 | src 10 | tsconfig.json -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![build-test](https://github.com/und3f/vectorize-pixelart/actions/workflows/main.yml/badge.svg)](https://github.com/und3f/vectorize-pixelart/actions/workflows/main.yml) 2 | 3 | vectorize-pixelart 4 | ================== 5 | 6 | Convert raster pixel art graphics to vector. 7 | 8 | # Installation 9 | 10 | $ npm install vectorize-pixelart 11 | 12 | # CLI usage 13 | 14 | You may vectorize PNG image to SVG using next command: 15 | 16 | $ vectorize-pixelart input.png output.svg 17 | 18 | Also EPS output is supported: 19 | 20 | $ vectorize-pixelart input.png output.eps 21 | 22 | # Online web usage 23 | 24 | The package has been build with a [Browserify](browserify.org) version and 25 | available online: 26 | 27 | http://zasenko.name/vectorize-pixelart.html 28 | 29 | Main limitation of the web version is that browser has issues when processing 30 | large SVG files. As there are no control over image displaying some resulting 31 | SVG might cause browser hang. 32 | 33 | # API 34 | 35 | Please check [vectorize-pixelart.js](src/vectorize-pixelart.ts) code. 36 | 37 | So, basic usage is next: 38 | 39 | 1. Read raster image. 40 | 2. Trace image 41 | 42 | ```js 43 | var fs = require('fs'), 44 | PNG = require('pngjs').PNG, 45 | ContourTracing = require('vectorize-pixelart/contour-tracing'), 46 | paUtils = require('vectorize-pixelart/utils'); 47 | 48 | // PNGImageData provides transparent pixel retrieving/comparasion interface 49 | let image = new paUtils.PNGImageData(PNG.sync.read(fs.readFileSync('in.png'))); 50 | 51 | // Vector composer 52 | let composer = new paUtils.SVG(image.height, image.width); 53 | 54 | process.stdout.write(composer.header()); 55 | 56 | let tracer = new ContourTracing(image); 57 | tracer.traceContours((contour, pixel) => { 58 | // Output next traced contour 59 | process.stdout.write(composer.path(contour, pixel)); 60 | }) 61 | 62 | process.stdout.write(composer.footer()); 63 | ``` 64 | 65 | ## Class: ContourTracing 66 | 67 | Trace contours of a given `image`. 68 | 69 | ### new ContourTracing(image) 70 | 71 | Object image should contain `height` and `width` information. Also it should 72 | provide `function comparePixels(y1, x1, y2, x2) { }` and `function getPixel(y1, 73 | x1)`. See `PNGImageData`. 74 | 75 | ### ContourTracing.traceContours(callback) 76 | Traces contours of a given image and return next contour to callback. The 77 | callback gets one argument `(contour)` that contains array of contour points 78 | `[y, x]`. 79 | 80 | # Copyright 81 | 82 | Copyright (C) 2019-2022 Sergii Zasenko 83 | 84 | This program is free software: you can redistribute it and/or modify 85 | it under the terms of the GNU General Public License as published by 86 | the Free Software Foundation, either version 3 of the License, or 87 | (at your option) any later version. 88 | 89 | This program is distributed in the hope that it will be useful, 90 | but WITHOUT ANY WARRANTY; without even the implied warranty of 91 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 92 | GNU General Public License for more details. 93 | 94 | You should have received a copy of the GNU General Public License 95 | along with this program. If not, see . 96 | -------------------------------------------------------------------------------- /contour-tracing.js: -------------------------------------------------------------------------------- 1 | // Left for backward compatability, please do not rely on it 2 | const { ContourTracing } = require('./lib') 3 | module.exports = ContourTracing 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vectorize-pixelart", 3 | "version": "0.2.0", 4 | "description": "Convert raster pixel art graphics to vector", 5 | "main": "lib/index.js", 6 | "types": "lib/index.d.ts", 7 | "scripts": { 8 | "build": "tsc", 9 | "test": "ts-node node_modules/.bin/tape ./test/**", 10 | "lint": "ts-standard src/", 11 | "format": "ts-standard --fix src/" 12 | }, 13 | "directories": { 14 | "lib": "./lib", 15 | "test": "./test" 16 | }, 17 | "author": "Serhii Zasenko", 18 | "license": "GPL-3.0-or-later", 19 | "dependencies": { 20 | "pngjs": "^7.0.0" 21 | }, 22 | "devDependencies": { 23 | "@types/node": "^20.2.5", 24 | "@types/pngjs": "^6.0.1", 25 | "@types/tape": "^5.6.0", 26 | "eslint": "^8.42.0", 27 | "standard": "^17.1.0", 28 | "tape": "^5.6.3", 29 | "ts-node": "^10.9.1", 30 | "ts-standard": "^12.0.2", 31 | "typescript": "^5.1.3" 32 | }, 33 | "repository": { 34 | "type": "git", 35 | "url": "git+https://github.com/und3f/vectorize-pixelart.git" 36 | }, 37 | "bin": { 38 | "vectorize-pixelart": "lib/vectorize-pixelart.js" 39 | }, 40 | "keywords": [ 41 | "vector", 42 | "svg", 43 | "convert" 44 | ], 45 | "bugs": { 46 | "url": "https://github.com/und3f/vectorize-pixelart/issues" 47 | }, 48 | "homepage": "https://github.com/und3f/vectorize-pixelart#readme" 49 | } 50 | -------------------------------------------------------------------------------- /src/contour-tracing.ts: -------------------------------------------------------------------------------- 1 | import { Coord, Path, Pixel, PNGImageData } from './utils' 2 | 3 | type Direction = Coord 4 | type ContourFoundCb = (contour: Path, pixel: Pixel) => void 5 | 6 | const DIRECTIONS: Direction[] = [ 7 | [1, 0], 8 | [0, -1], 9 | [-1, 0], 10 | [0, 1] 11 | ] 12 | 13 | const DIRECTION_VERTEX: Direction[] = [ 14 | [1, 0], 15 | [0, 0], 16 | [0, 1], 17 | [1, 1] 18 | ] 19 | 20 | const D_MOD = DIRECTIONS.length 21 | 22 | export class ContourTracing { 23 | private readonly image: PNGImageData 24 | private readonly visitedPixels: boolean[] 25 | 26 | constructor (image: PNGImageData) { 27 | this.image = image 28 | this.visitedPixels = new Array(image.width * image.height) 29 | this.visitedPixels.fill(false) 30 | } 31 | 32 | findNeighborbood (y: number, x: number): number | undefined { 33 | // // console.log("findNeighborbood", y, x); 34 | 35 | for (let d = 0; d < DIRECTIONS.length; d++) { 36 | const y1 = y + DIRECTIONS[d][0] 37 | const x1 = x + DIRECTIONS[d][1] 38 | 39 | // console.log("\t", y1, x1); 40 | if (this.image.comparePixels(y, x, y1, x1)) { 41 | // Do not return visited pixels 42 | if (!this.visitedPixels[y1 * this.image.width + x1]) { 43 | return d 44 | } 45 | } 46 | } 47 | } 48 | 49 | addMoveVertexes (contour: Path, y: number, x: number, directionMove: number, directionPrevious: number): void { 50 | // console.log("addMoveVertexes: ", y, x, directionMove, directionPrevious); 51 | 52 | for (let direction = directionPrevious; direction !== directionMove; direction = (direction + 1) % D_MOD) { 53 | const v = DIRECTION_VERTEX[direction] 54 | contour.push([y + v[0], x + v[1]]) 55 | // console.log("\t", contour[contour.length-1]); 56 | } 57 | 58 | // Optimeze path by removing vertexes on straight lines 59 | if (directionMove === directionPrevious) { contour.pop() } 60 | 61 | const v = DIRECTION_VERTEX[directionMove] 62 | contour.push([y + v[0], x + v[1]]) 63 | // console.log("\t", contour[contour.length-1]); 64 | } 65 | 66 | addRotationVertexes (contour: Path, y: number, x: number, currentDirection: number, targetDirection: number): void { 67 | // console.log("addRotationVertexes: ", y, x, currentDirection, targetDirection); 68 | 69 | for (let direction = currentDirection; direction !== targetDirection; direction = (direction + 1) % D_MOD) { 70 | const v = DIRECTION_VERTEX[direction] 71 | contour.push([y + v[0], x + v[1]]) 72 | // console.log("\t", contour[contour.length-1]); 73 | } 74 | } 75 | 76 | addContour (contour: Path, y: number, x: number, startDirection: number, endDirection: number): void { 77 | // console.log("addContour: ", y, x, startDirection, endDirection); 78 | 79 | if (startDirection === endDirection) { return } 80 | 81 | for (let direction = (startDirection + D_MOD - 1) % D_MOD, firstRun = true; firstRun || direction !== endDirection; direction = (direction + 1) % D_MOD, firstRun = false) { 82 | const v = DIRECTION_VERTEX[direction] 83 | contour.push([y + v[0], x + v[1]]) 84 | // console.log("\t", contour[contour.length-1]); 85 | } 86 | } 87 | 88 | traceContour (y0: number, x0: number): Path { 89 | const image = this.image 90 | const width = this.image.width 91 | const height = this.image.height 92 | 93 | const contour: Path = [] 94 | // console.log("traceContour: ", y0, x0); 95 | 96 | // Find neighborhood 97 | const neighborhoodDirection = this.findNeighborbood(y0, x0) 98 | 99 | if (neighborhoodDirection === undefined) { 100 | this.visitedPixels[y0 * width + x0] = true 101 | this.addMoveVertexes(contour, y0, x0, D_MOD - 1, 0) 102 | return contour 103 | } 104 | 105 | this.addContour(contour, y0, x0, 0, neighborhoodDirection) 106 | 107 | let lastDirection = neighborhoodDirection 108 | let ylast = y0 + DIRECTIONS[neighborhoodDirection][0] 109 | let xlast = x0 + DIRECTIONS[neighborhoodDirection][1] 110 | 111 | const trace = [y0 * width + x0, ylast * width + xlast] 112 | 113 | do { 114 | const oppositeDirection = (lastDirection + D_MOD / 2) % D_MOD 115 | const startDirection = (oppositeDirection + 1) % D_MOD 116 | for (let newDirection = startDirection; ; newDirection = (newDirection + 1) % D_MOD) { 117 | const y = ylast + DIRECTIONS[newDirection][0] 118 | const x = xlast + DIRECTIONS[newDirection][1] 119 | 120 | if (y < 0 || y >= height || x < 0 || x >= width) { continue } 121 | 122 | if (image.comparePixels(ylast, xlast, y, x)) { 123 | // console.log("Similar: ", ylast, xlast, y, x); 124 | // Do not visit visited points 125 | if (!this.visitedPixels[y * width + x]) { 126 | // Mark Pixel as visited 127 | trace.push(y * width + x) 128 | 129 | this.addContour(contour, ylast, xlast, lastDirection, newDirection) 130 | ylast = y 131 | xlast = x 132 | lastDirection = newDirection 133 | break 134 | } 135 | } 136 | // console.log(ylast, xlast); 137 | } 138 | } while (!(ylast === y0 && xlast === x0)) 139 | 140 | this.addContour(contour, y0, x0, lastDirection, neighborhoodDirection) 141 | 142 | for (const pos of trace) { 143 | this.visitedPixels[pos] = true 144 | } 145 | 146 | return contour 147 | } 148 | 149 | traceContours (cb: ContourFoundCb): void { 150 | for (let i = 0; i < this.visitedPixels.length; i++) { 151 | if (this.visitedPixels[i]) { continue } 152 | 153 | const y0 = (i / this.image.width) | 0 154 | const x0 = i % this.image.width 155 | // console.log("Tracing", y0, x0); 156 | const contour = this.traceContour(y0, x0) 157 | // console.log("Found contour", contour); 158 | if (contour !== undefined) { cb(contour, this.image.getPixel(y0, x0)) } 159 | } 160 | 161 | /* 162 | let y0 = 0; 163 | let x0 = 2; 164 | console.log("Tracing", y0, x0); 165 | let contour = this.traceContour(y0, x0); 166 | console.log("Found contour", contour); 167 | if (contour !== undefined) 168 | cb(contour, this.image.getPixel(y0, x0)); 169 | */ 170 | } 171 | } 172 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './utils' 2 | export * from './contour-tracing' 3 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | import type { PNG } from 'pngjs' 4 | 5 | const DEFAULT_MULTIPLIER = 1 6 | 7 | export type Pixel = [number, number, number, number] 8 | export type Coord = [number, number] 9 | export type Path = Coord[] 10 | 11 | abstract class Image { 12 | protected readonly height: number 13 | protected readonly width: number 14 | protected readonly multiplier: number 15 | 16 | constructor (height: number, width: number, _multiplier = DEFAULT_MULTIPLIER) { 17 | this.height = height 18 | this.width = width 19 | this.multiplier = _multiplier == null ? 1 : _multiplier 20 | } 21 | 22 | abstract header (): string 23 | abstract footer (): string 24 | // abstract pixel(y: number, x: number, pixel: Pixel): string | undefined 25 | abstract path (contour: Path, pixel: Pixel): string 26 | } 27 | 28 | export class SVG extends Image { 29 | header (): string { 30 | return `\ 31 | 32 | 33 | ` 34 | } 35 | 36 | footer (): string { 37 | return '\n' 38 | } 39 | 40 | pixel (y: number, x: number, pixel: Pixel): string { 41 | if (pixel[3] < 255) { 42 | return '' 43 | } 44 | 45 | const rgba = pixel.join(', ') 46 | return `\ 47 | \n` 50 | } 51 | 52 | path (contour: Path, pixel: Pixel): string { 53 | const m = this.multiplier 54 | const rgba = pixel.join(', ') 55 | 56 | const move = contour[0] 57 | let path = ` \n` 62 | 63 | return path 64 | } 65 | } 66 | 67 | export class EPS extends Image { 68 | header (): string { 69 | return `\ 70 | %!PS-Adobe-3.0 EPSF-3.0 71 | %%Creator: vectorize-pixelart (https://github.com/und3f/vectorize-pixelart) 72 | %%BoundingBox: 0 0 ${this.width * this.multiplier} ${this.height * this.multiplier} 73 | %%Pages: 1 74 | %%EndComments 75 | %%BeginProlog 76 | /m { moveto } bind def 77 | /l { lineto } bind def 78 | /z { closepath } bind def 79 | /f { fill } bind def 80 | /rg { setrgbcolor } bind def 81 | %%EndProlog 82 | %%Page: 1 1 83 | %%BeginPageSetup 84 | %%PageBoundingBox: 0 0 ${this.width * this.multiplier} ${this.height * this.multiplier} 85 | %%EndPageSetup 86 | ` 87 | } 88 | 89 | footer (): string { 90 | return `\ 91 | showpage 92 | %%Trailer 93 | %%EOF 94 | ` 95 | } 96 | 97 | path (contour: Path, pixel: Pixel): string { 98 | const m = this.multiplier 99 | const height = this.height 100 | 101 | let path = '' 102 | for (let i = 0; i < 3; i++) { 103 | path += (pixel[i] / 255).toFixed(3) + ' ' 104 | } 105 | path += ' rg\n' 106 | 107 | const move = contour[0] 108 | path += `${(move[1]) * m} ${(height - move[0]) * m} m` 109 | for (let i = 1; i < contour.length; i++) { 110 | path += ` ${contour[i][1] * m} ${(height - contour[i][0]) * m} l` 111 | } 112 | path += ' z\nf\n' 113 | 114 | return path 115 | } 116 | } 117 | 118 | const BYTES_PER_PIXEL = 4 119 | 120 | export class PNGImageData { 121 | private readonly png: PNG 122 | private readonly data: Buffer 123 | 124 | readonly width: number 125 | readonly height: number 126 | 127 | constructor (png: PNG) { 128 | this.png = png 129 | this.width = this.png.width 130 | this.height = this.png.height 131 | this.data = png.data 132 | } 133 | 134 | comparePixels (y1: number, x1: number, y2: number, x2: number): boolean { 135 | const pixels = this.data 136 | const offset1 = (y1 * this.width + x1) * BYTES_PER_PIXEL 137 | const offset2 = (y2 * this.width + x2) * BYTES_PER_PIXEL 138 | 139 | for (let i = 0; i < BYTES_PER_PIXEL; i++) { 140 | if (pixels[offset1 + i] !== pixels[offset2 + i]) { return false } 141 | } 142 | 143 | return true 144 | } 145 | 146 | getPixel (y: number, x: number): Pixel { 147 | const offset = (y * this.width + x) * BYTES_PER_PIXEL 148 | return Array.prototype.slice.call(this.data, offset, offset + BYTES_PER_PIXEL) as Pixel 149 | } 150 | } 151 | -------------------------------------------------------------------------------- /src/vectorize-pixelart.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | import { createReadStream, createWriteStream } from 'fs' 4 | import { PNG } from 'pngjs' 5 | import { SVG, EPS, PNGImageData, Path, Pixel } from './utils' 6 | import * as Process from 'process' 7 | import { ContourTracing } from './contour-tracing' 8 | 9 | const OutputFileFormats: { [_: string]: any } = { 10 | svg: SVG, 11 | eps: EPS 12 | } 13 | 14 | const targetSize = 2 ** 23 15 | const inputFileName = Process.argv[2] 16 | const outputFileName: string = Process.argv[3] 17 | 18 | if (Process.argv.length < 4) { 19 | Process.stdout.write( 20 | `usage: ${Process.argv[1]} \n`) 21 | Process.exit(1) 22 | } 23 | 24 | const extension = outputFileName.split('.').pop() ?? '' 25 | const VectorFormatterClass = OutputFileFormats[extension] 26 | if (VectorFormatterClass == null) { throw new Error('Unsupported file format ' + outputFileName) } 27 | 28 | createReadStream(inputFileName) 29 | .pipe(new PNG()) 30 | .on('parsed', function () { 31 | // TODO check files exists 32 | const vectorOut = createWriteStream(outputFileName) 33 | 34 | const pixelMultiplier = Math.sqrt(targetSize / (this.height * this.width)) 35 | 36 | const image = new PNGImageData(this) 37 | 38 | const vectorFormatter = new VectorFormatterClass(this.height, this.width, pixelMultiplier) 39 | vectorOut.write(vectorFormatter.header()) 40 | 41 | const tracer = new ContourTracing(image) 42 | tracer.traceContours((contour: Path, pixel: Pixel) => { 43 | vectorOut.write(vectorFormatter.path(contour, pixel)) 44 | }) 45 | 46 | vectorOut.write(vectorFormatter.footer()) 47 | }) 48 | -------------------------------------------------------------------------------- /test/composer.test.ts: -------------------------------------------------------------------------------- 1 | import * as test from 'tape' 2 | import {SVG, EPS} from '../src/utils' 3 | 4 | test('compose SVG image', (t) => { 5 | const svg = new SVG(101, 102) 6 | 7 | const header = svg.header() 8 | t.ok(header.match(//), 'correct footer') 15 | 16 | t.end() 17 | }) 18 | 19 | test('compose EPS image', (t) => { 20 | const eps = new EPS(101, 102) 21 | 22 | const header = eps.header() 23 | t.ok(header.match(/%!PS-Adobe-3.0 EPSF-3.0/), 'correct header') 24 | 25 | t.ok(eps.path( 26 | [[0, 0], [10, 0], [10, 1], [1, 1], [2, 1], [2, 0]], [0, 0, 0, 0]) 27 | .match(/.+\srg.+\sl.+\sf/s), 'correct path') 28 | 29 | t.ok(eps.footer().match(/%%EOF/), 'correct footer') 30 | 31 | t.end() 32 | }) 33 | -------------------------------------------------------------------------------- /test/tracing.test.ts: -------------------------------------------------------------------------------- 1 | import * as test from 'tape' 2 | import { ContourTracing } from '../src/contour-tracing' 3 | import { Coord, Path, PNGImageData } from '../src/utils' 4 | 5 | test('trace contours of sample image', (t) => { 6 | const imageData = [ 7 | 0.0, 0.0, 0.2, 0.0, 0.0, 8 | 0.1, 0.2, 0.2, 0.2, 0.0, 9 | 0.1, 0.0, 0.2, 0.0, 0.0, 10 | 0.1, 0.3, 0.0, 0.0, 0.0, 11 | 0.0, 0.0, 0.0, 0.0, 0.0 12 | ] 13 | 14 | const image = new MockedImage(imageData, 5, 5) as any as PNGImageData 15 | 16 | const ct = new ContourTracing(image) 17 | let foundContours = 0 18 | 19 | ct.traceContours((contour) => { 20 | foundContours++ 21 | if (isStraightContour(contour)) { 22 | t.pass('Retrieved countour is straight') 23 | } else { 24 | t.fail('Wrong contour: ' + contour) 25 | } 26 | }) 27 | 28 | t.ok(foundContours === 6, 'Found exacly 6 contours') 29 | 30 | t.end() 31 | }) 32 | 33 | function isStraight (point1: Coord, point2: Coord) { 34 | const yChange = point1[0] !== point2[0] 35 | const xChange = point1[1] !== point2[1] 36 | return yChange !== xChange 37 | }; 38 | 39 | function isStraightContour (contour: Path) { 40 | for (let i = 0; i < contour.length - 1; i++) { 41 | if (!isStraight(contour[i], contour[i + 1])) { return false } 42 | } 43 | 44 | if (!isStraight(contour[contour.length - 1], contour[0])) { return false } 45 | 46 | return true 47 | } 48 | 49 | class MockedImage { 50 | private readonly image: number[] 51 | private readonly height: number 52 | private readonly width: number 53 | 54 | 55 | constructor (imageArray: number[], height: number, width: number) { 56 | this.image = imageArray 57 | this.height = height 58 | this.width = width 59 | 60 | } 61 | private getOffset (y: number, x: number) { 62 | return y * this.width + x 63 | } 64 | 65 | comparePixels (y1: number, x1: number, y2: number, x2: number) { 66 | return this.image[this.getOffset(y1, x1)] === this.image[this.getOffset(y2, x2)] 67 | } 68 | 69 | getPixel (y: number, x: number) { 70 | const gray = 255 * this.image[this.getOffset(y, x)] 71 | return [gray, gray, gray, 255] 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ES5", 4 | "module": "commonjs", 5 | "declaration": true, 6 | "noImplicitAny": true, 7 | "outDir": "./lib", 8 | "strict": true 9 | }, 10 | "include": ["src/**/*"], 11 | "exclude": ["node_modules", "test"] 12 | } 13 | -------------------------------------------------------------------------------- /utils.js: -------------------------------------------------------------------------------- 1 | // Left for backward compatability, please do not rely on it 2 | const { SVG, EPS, PNGImageData } = require('./lib') 3 | module.exports = { SVG, EPS, PNGImageData } 4 | --------------------------------------------------------------------------------