├── .gitignore ├── COPYING ├── ChangeLog ├── MANIFEST.in ├── Makefile ├── README.rst ├── TODO ├── examples └── matplotlib_example.py ├── setup.py └── sixel ├── __init__.py ├── cellsize.py ├── converter.py ├── sixel.py └── sixel_cimpl.c /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | *.un~ 3 | *.pyc 4 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | 2 | GNU GENERAL PUBLIC LICENSE 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for 12 | software and other kinds of works. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | the GNU General Public License is intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. We, the Free Software Foundation, use the 19 | GNU General Public License for most of our software; it applies also to 20 | any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you 31 | these rights or asking you to surrender the rights. Therefore, you have 32 | certain responsibilities if you distribute copies of the software, or if 33 | you modify it: responsibilities to respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must pass on to the recipients the same 37 | freedoms that you received. You must make sure that they, too, receive 38 | or can get the source code. And you must show them these terms so they 39 | know their rights. 40 | 41 | Developers that use the GNU GPL protect your rights with two steps: 42 | (1) assert copyright on the software, and (2) offer you this License 43 | giving you legal permission to copy, distribute and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains 46 | that there is no warranty for this free software. For both users' and 47 | authors' sake, the GPL requires that modified versions be marked as 48 | changed, so that their problems will not be attributed erroneously to 49 | authors of previous versions. 50 | 51 | Some devices are designed to deny users access to install or run 52 | modified versions of the software inside them, although the manufacturer 53 | can do so. This is fundamentally incompatible with the aim of 54 | protecting users' freedom to change the software. The systematic 55 | pattern of such abuse occurs in the area of products for individuals to 56 | use, which is precisely where it is most unacceptable. Therefore, we 57 | have designed this version of the GPL to prohibit the practice for those 58 | products. If such problems arise substantially in other domains, we 59 | stand ready to extend this provision to those domains in future versions 60 | of the GPL, as needed to protect the freedom of users. 61 | 62 | Finally, every program is threatened constantly by software patents. 63 | States should not allow patents to restrict development and use of 64 | software on general-purpose computers, but in those that do, we wish to 65 | avoid the special danger that patents applied to a free program could 66 | make it effectively proprietary. To prevent this, the GPL assures that 67 | patents cannot be used to render the program non-free. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Use with the GNU Affero General Public License. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU Affero General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the special requirements of the GNU Affero General Public License, 561 | section 13, concerning interaction through a network will apply to the 562 | combination as such. 563 | 564 | 14. Revised Versions of this License. 565 | 566 | The Free Software Foundation may publish revised and/or new versions of 567 | the GNU General Public License from time to time. Such new versions will 568 | be similar in spirit to the present version, but may differ in detail to 569 | address new problems or concerns. 570 | 571 | Each version is given a distinguishing version number. If the 572 | Program specifies that a certain numbered version of the GNU General 573 | Public License "or any later version" applies to it, you have the 574 | option of following the terms and conditions either of that numbered 575 | version or of any later version published by the Free Software 576 | Foundation. If the Program does not specify a version number of the 577 | GNU General Public License, you may choose any version ever published 578 | by the Free Software Foundation. 579 | 580 | If the Program specifies that a proxy can decide which future 581 | versions of the GNU General Public License can be used, that proxy's 582 | public statement of acceptance of a version permanently authorizes you 583 | to choose that version for the Program. 584 | 585 | Later license versions may give you additional or different 586 | permissions. However, no additional obligations are imposed on any 587 | author or copyright holder as a result of your choosing to follow a 588 | later version. 589 | 590 | 15. Disclaimer of Warranty. 591 | 592 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 593 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 594 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 595 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 596 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 597 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 598 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 599 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 600 | 601 | 16. Limitation of Liability. 602 | 603 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 604 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 605 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 606 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 607 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 608 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 609 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 610 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 611 | SUCH DAMAGES. 612 | 613 | 17. Interpretation of Sections 15 and 16. 614 | 615 | If the disclaimer of warranty and limitation of liability provided 616 | above cannot be given local legal effect according to their terms, 617 | reviewing courts shall apply local law that most closely approximates 618 | an absolute waiver of all civil liability in connection with the 619 | Program, unless a warranty or assumption of liability accompanies a 620 | copy of the Program in return for a fee. 621 | 622 | END OF TERMS AND CONDITIONS 623 | 624 | How to Apply These Terms to Your New Programs 625 | 626 | If you develop a new program, and you want it to be of the greatest 627 | possible use to the public, the best way to achieve this is to make it 628 | free software which everyone can redistribute and change under these terms. 629 | 630 | To do so, attach the following notices to the program. It is safest 631 | to attach them to the start of each source file to most effectively 632 | state the exclusion of warranty; and each file should have at least 633 | the "copyright" line and a pointer to where the full notice is found. 634 | 635 | 636 | Copyright (C) 637 | 638 | This program is free software: you can redistribute it and/or modify 639 | it under the terms of the GNU General Public License as published by 640 | the Free Software Foundation, either version 3 of the License, or 641 | (at your option) any later version. 642 | 643 | This program is distributed in the hope that it will be useful, 644 | but WITHOUT ANY WARRANTY; without even the implied warranty of 645 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 646 | GNU General Public License for more details. 647 | 648 | You should have received a copy of the GNU General Public License 649 | along with this program. If not, see . 650 | 651 | Also add information on how to contact you by electronic and paper mail. 652 | 653 | If the program does terminal interaction, make it output a short 654 | notice like this when it starts in an interactive mode: 655 | 656 | Copyright (C) 657 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 658 | This is free software, and you are welcome to redistribute it 659 | under certain conditions; type `show c' for details. 660 | 661 | The hypothetical commands `show w' and `show c' should show the appropriate 662 | parts of the General Public License. Of course, your program's commands 663 | might be different; for a GUI interface, you would use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or school, 666 | if any, to sign a "copyright disclaimer" for the program, if necessary. 667 | For more information on this, and how to apply and follow the GNU GPL, see 668 | . 669 | 670 | The GNU General Public License does not permit incorporating your program 671 | into proprietary programs. If your program is a subroutine library, you 672 | may consider it more useful to permit linking proprietary applications with 673 | the library. If this is what you want to do, use the GNU Lesser General 674 | Public License instead of this License. But first, please read 675 | . 676 | 677 | -------------------------------------------------------------------------------- /ChangeLog: -------------------------------------------------------------------------------- 1 | 2 | 2014-01-26 Hayaki Saito 3 | 4 | * Use alternative C-implemented module if possible 5 | * Add an option --ncolor(-n), specify number of colors 6 | 7 | 2013-01-05 Hayaki Saito 8 | 9 | * Fix stupid alpha-threshold bug (pointed by Araki Ken, thanks!) 10 | 11 | 2013-08-10 Hayaki Saito 12 | 13 | * Use imageloader module if it exists 14 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include COPYING 2 | include README.rst 3 | include *.py 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | 2 | PACKAGE_NAME=PySixel 3 | DEPENDENCIES=Pillow 4 | PYTHON=python 5 | SETUP_SCRIPT=setup.py 6 | RM=rm -rf 7 | PIP=pip 8 | CYTHON=cython 9 | 10 | .PHONY: smoketest nosetest build setuptools install uninstall clean update 11 | 12 | build: smoketest 13 | ln -f sixel/converter.py /tmp/sixel_cimpl.pyx 14 | $(CYTHON) /tmp/sixel_cimpl.pyx -o sixel/sixel_cimpl.c 15 | $(PYTHON) $(SETUP_SCRIPT) sdist 16 | $(PYTHON) $(SETUP_SCRIPT) bdist_egg 17 | 18 | setup_environment: 19 | if test -d tools; do \ 20 | ln -f tools/gitignore .gitignore \ 21 | ln -f tools/vimprojects .vimprojects \ 22 | fi 23 | 24 | setuptools: 25 | $(PYTHON) -c "import setuptools" || \ 26 | curl http://peak.telecommunity.com/dist/ez_$(SETUP_SCRIPT) | $(PYTHON) 27 | 28 | install: smoketest setuptools build 29 | $(PYTHON) $(SETUP_SCRIPT) install 30 | 31 | uninstall: 32 | for package in $(PACKAGE_NAME) $(DEPENDENCIES); \ 33 | do \ 34 | $(PIP) uninstall -y $$package; \ 35 | done 36 | 37 | clean: 38 | for name in dist cover build *.egg-info *.egg htmlcov; \ 39 | do find . -type d -name $$name || true; \ 40 | done | xargs $(RM) 41 | for name in *.pyc *.o .coverage; \ 42 | do find . -type f -name $$name || true; \ 43 | done | xargs $(RM) 44 | 45 | test: smoketest nosetest 46 | 47 | smoketest: 48 | $(PYTHON) $(SETUP_SCRIPT) test 49 | 50 | nosetest: 51 | 52 | update: build clean test 53 | $(PYTHON) $(SETUP_SCRIPT) register 54 | $(PYTHON) $(SETUP_SCRIPT) sdist upload 55 | $(PYTHON) $(SETUP_SCRIPT) bdist_egg upload 56 | 57 | cleanupdate: update 58 | ssh zuse.jp "rm -rf $(PACKAGE_NAME)" 59 | ssh zuse.jp "git clone git@github.com:saitoha/$(PACKAGE_NAME) --recursive" 60 | ssh zuse.jp "cd $(PACKAGE_NAME) && $(PYTHON) $(SETUP_SCRIPT) bdist_egg upload" 61 | 62 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | pysixel 2 | ======= 3 | 4 | What is SIXEL? 5 | -------------- 6 | 7 | .. image:: https://raw.githubusercontent.com/saitoha/PySIXEL/data/data/sixel_gnuplot.png 8 | :width: 640 9 | 10 | SIXEL is one of image formats for terminal imaging introduced by DEC VT series. 11 | SIXEL image data scheme is represented as a terminal-friendly escape sequence. 12 | So if you want to show a SIXEL image file, all you have to do is "cat" it to your terminal. 13 | 14 | *See also more faster high quality C implementation* 15 | libsixel: https://github.com/saitoha/libsixel 16 | 17 | .. image:: https://raw.githubusercontent.com/saitoha/PySIXEL/data/data/sixel_hikari.png 18 | :width: 640 19 | 20 | I heard SIXEL was supported by some old terminal applications, such as SAS, WordPerfect. 21 | 22 | Nowadays netpbm and Gnuplot support this. 23 | 24 | .. image:: https://raw.githubusercontent.com/saitoha/PySIXEL/data/data/sixel_ls.png 25 | :width: 640 26 | 27 | 28 | Requirements 29 | ------------ 30 | 31 | If you want to view a SIXEL image, you have to get a terminal 32 | which support sixel graphics. 33 | 34 | Now SIXEL feature is supported by the following terminals. 35 | 36 | - RLogin (Japanese terminal emulator) 37 | 38 | http://nanno.dip.jp/softlib/man/rlogin/ 39 | 40 | - tanasinn (Works with firefox) 41 | 42 | http://github.com/saitoha/tanasinn/ 43 | 44 | - mlterm 45 | 46 | Works on each of X, win32/cygwin, framebuffer version. 47 | http://mlterm.sourceforge.net/ 48 | 49 | - XTerm (compiled with --enable-sixel option) 50 | You should launch xterm with "-ti 340" option. 51 | the SIXEL palette is limited to a maximum of 16 colors. 52 | http://invisible-island.net/xterm/ 53 | 54 | - DECterm 55 | 56 | - Kermit 57 | 58 | - WRQ Reflection 59 | 60 | - ZSTEM 61 | 62 | 63 | Install 64 | ------- 65 | 66 | via github :: 67 | 68 | $ git clone https://github.com/saitoha/PySixel.git 69 | $ cd pysixel 70 | $ python setup.py install 71 | 72 | or via pip :: 73 | 74 | $ pip install PySixel 75 | 76 | 77 | Usage 78 | ----- 79 | 80 | PySixel provides a Command line tool:: 81 | 82 | $ sixelconv [options] filename 83 | 84 | or :: 85 | 86 | $ cat filename | sixelconv [options] 87 | 88 | 89 | * Options:: 90 | 91 | -h, --help show this help message and exit 92 | -8, --8bit-mode Generate a sixel image for 8bit terminal or printer 93 | -7, --7bit-mode Generate a sixel image for 7bit terminal or printer 94 | -r, --relative-position Treat specified position as relative one 95 | -a, --absolute-position Treat specified position as absolute one 96 | -x LEFT, --left=LEFT Left position in cell size, or pixel size with unit 'px' 97 | -y TOP, --top=TOP Top position in cell size, or pixel size with unit 'px' 98 | -w WIDTH, --width=WIDTH Width in cell size, or pixel size with unit 'px' 99 | -e HEIGHT, --height=HEIGHT Height in cell size, or pixel size with unit 'px' 100 | -t ALPHATHRESHOLD, --alpha-threshold=ALPHATHRESHOLD Alpha threshold for PNG-to-SIXEL image conversion 101 | -c, --chromakey Enable auto chroma key processing 102 | -n NCOLOR, --ncolor=NCOLOR Specify number of colors 103 | -b, --body-only Output sixel without header and DCS envelope 104 | -f, --fast The speed priority mode (default) 105 | -s, --size The size priority mode 106 | 107 | 108 | Example 109 | ------- 110 | 111 | View an image file:: 112 | 113 | $ sixelconv test.png 114 | 115 | Generate sixel file from an image file:: 116 | 117 | $ sixelconv < test.png > test.six 118 | 119 | View generated sixel file:: 120 | 121 | $ cat test.six 122 | 123 | Show sixel in xterm :: 124 | 125 | $ curl ftp://invisible-island.net/xterm/xterm-301.tgz | tar xz 126 | $ cd xterm-301 127 | $ ./configure --enable-wide-chars --enable-sixel-graphics --enable-256-color 128 | $ make 129 | # make install 130 | $ xterm -ti vt340 -e 'sixelconv -n16 ~/testdir/test.jpg' 131 | 132 | 133 | Code Example 134 | ------------ 135 | 136 | :: 137 | 138 | import sixel 139 | writer = sixel.SixelWriter() 140 | writer.draw('test.png') 141 | 142 | Dependency 143 | ---------- 144 | 145 | - Pillow 146 | https://github.com/python-imaging/Pillow 147 | 148 | - Python imageloader module 149 | https://pypi.python.org/pypi/imageloader 150 | 151 | Contributors 152 | ----------- 153 | 154 | - @cocuh (Python3 support) 155 | 156 | Reference 157 | --------- 158 | - Chris_F_Chiesa, 1990 : All About SIXELs 159 | ftp://ftp.cs.utk.edu/pub/shuford/terminal/all_about_sixels.txt 160 | 161 | - Netpbm http://netpbm.sourceforge.net/ 162 | 163 | It includes ppmtosixel command 164 | http://netpbm.sourceforge.net/doc/ppmtosixel.html 165 | 166 | - vt100.net http://vt100.net/ 167 | 168 | -------------------------------------------------------------------------------- /TODO: -------------------------------------------------------------------------------- 1 | 2 | - support monochrome encoding 3 | - support 2-pass encoding 4 | -------------------------------------------------------------------------------- /examples/matplotlib_example.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | #vim:fileencoding=utf8 3 | import matplotlib 4 | matplotlib.rcParams["backend"]="Agg" 5 | import pylab as pl 6 | import numpy as np 7 | from cStringIO import StringIO 8 | import sixel 9 | 10 | def sixelfig(): 11 | buf = StringIO() 12 | pl.savefig(buf) 13 | buf.seek(0) 14 | writer = sixel.SixelWriter() 15 | writer.draw(buf) 16 | 17 | def main(): 18 | pl.figure(figsize=(4,3)) 19 | x = np.linspace(0,1,100) 20 | y = x**2 21 | pl.plot(x,y) 22 | sixelfig() 23 | pass 24 | 25 | if __name__=="__main__": 26 | main() 27 | 28 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from setuptools import setup, find_packages, Extension 4 | from sixel import __version__, __license__, __author__ 5 | import inspect, os 6 | 7 | filename = inspect.getfile(inspect.currentframe()) 8 | dirpath = os.path.abspath(os.path.dirname(inspect.getfile(inspect.currentframe()))) 9 | long_description = open(os.path.join(dirpath, "README.rst")).read() 10 | 11 | extra_args = [] 12 | 13 | if os.uname()[0] == 'Darwin': 14 | # Clang no longer supports GCC arguments, and will fail in the future 15 | extra_args.append('-Wno-error=unused-command-line-argument-hard-error-in-future') 16 | 17 | setup(name = 'PySixel', 18 | version = __version__, 19 | description = ('View full-pixel color graphics on SIXEL-supported terminals' 20 | '(xterm/mlterm/DECterm/Reflection/RLogin/tanasinn/yaft)'), 21 | long_description = long_description, 22 | py_modules = ['sixel'], 23 | ext_modules = [Extension('sixel_cimpl', sources = ['sixel/sixel_cimpl.c'], extra_compile_args = extra_args)], 24 | eager_resources = [], 25 | classifiers = ['Development Status :: 4 - Beta', 26 | 'Topic :: Terminals', 27 | 'Environment :: Console', 28 | 'Intended Audience :: End Users/Desktop', 29 | 'License :: OSI Approved :: GNU General Public License (GPL)', 30 | 'Programming Language :: Python' 31 | ], 32 | keywords = 'sixel terminal image', 33 | author = __author__, 34 | author_email = 'user@zuse.jp', 35 | url = 'https://github.com/saitoha/PySixel', 36 | license = __license__, 37 | packages = find_packages(exclude=[]), 38 | zip_safe = False, 39 | include_package_data = False, 40 | install_requires = ['imageloader', 'Pillow'], 41 | entry_points = """ 42 | [console_scripts] 43 | sixelconv = sixel:main 44 | """ 45 | ) 46 | 47 | -------------------------------------------------------------------------------- /sixel/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | # ***** BEGIN LICENSE BLOCK ***** 5 | # Copyright (C) 2012-2014 Hayaki Saito 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # ***** END LICENSE BLOCK ***** 20 | 21 | __author__ = "Hayaki Saito (user@zuse.jp)" 22 | __version__ = "0.1.11" 23 | __license__ = "GPL v3" 24 | 25 | import os 26 | import sys 27 | import optparse 28 | import select 29 | import logging 30 | 31 | from .cellsize import CellSizeDetector 32 | from .sixel import SixelWriter 33 | 34 | license_text = """ 35 | Copyright (C) 2012-2014 Hayaki Saito 36 | 37 | This program is free software: you can redistribute it and/or modify 38 | it under the terms of the GNU General Public License as published by 39 | the Free Software Foundation, either version 3 of the License, or 40 | (at your option) any later version. 41 | 42 | This program is distributed in the hope that it will be useful, 43 | but WITHOUT ANY WARRANTY; without even the implied warranty of 44 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 45 | GNU General Public License for more details. 46 | 47 | You should have received a copy of the GNU General Public License 48 | along with this program. If not, see . 49 | """ 50 | 51 | 52 | def _filenize(f): 53 | import stat 54 | 55 | mode = os.fstat(f.fileno()).st_mode 56 | if stat.S_ISFIFO(mode) or os.isatty(f.fileno()): 57 | try: 58 | from cStringIO import StringIO 59 | except ImportError: 60 | from StringIO import StringIO 61 | return StringIO(f.read()) 62 | return f 63 | 64 | 65 | def main(): 66 | 67 | parser = optparse.OptionParser() 68 | 69 | parser.add_option("-8", "--8bit-mode", 70 | action="store_true", 71 | dest="f8bit", 72 | help="Generate a sixel image for 8bit terminal or printer") 73 | 74 | parser.add_option("-7", "--7bit-mode", 75 | action="store_false", 76 | dest="f8bit", 77 | help="Generate a sixel image for 7bit terminal or printer") 78 | 79 | parser.add_option("-r", "--relative-position", 80 | action="store_false", 81 | default=False, 82 | dest="fabsolute", 83 | help="Treat specified position as relative one") 84 | 85 | parser.add_option("-a", "--absolute-position", 86 | action="store_true", 87 | dest="fabsolute", 88 | help="Treat specified position as absolute one") 89 | 90 | parser.add_option("-x", "--left", 91 | action="store", 92 | dest="left", 93 | help="Left position in cell size, or pixel size with unit 'px'") 94 | 95 | parser.add_option("-y", "--top", 96 | action="store", 97 | dest="top", 98 | help="Top position in cell size, or pixel size with unit 'px'") 99 | 100 | parser.add_option("-w", "--width", 101 | action="store", 102 | dest="width", 103 | help="Width in cell size, or pixel size with unit 'px'") 104 | 105 | parser.add_option("-e", "--height", 106 | action="store", 107 | dest="height", 108 | help="Height in cell size, or pixel size with unit 'px'") 109 | 110 | parser.add_option("-t", "--alpha-threshold", 111 | action="store", 112 | type="int", 113 | dest="alphathreshold", 114 | default="0", 115 | help="Alpha threthold for PNG-to-SIXEL image conversion") 116 | 117 | parser.add_option("-c", "--chromakey", 118 | dest="chromakey", 119 | default=False, 120 | action="store_true", 121 | help="Enable auto chroma key processing") 122 | 123 | parser.add_option("-n", "--ncolor", 124 | action="store", 125 | type="int", 126 | dest="ncolor", 127 | default=256, 128 | help="Specify number of colors") 129 | 130 | parser.add_option("-b", "--body-only", 131 | action="store_true", 132 | dest="bodyonly", 133 | default=False, 134 | help="Output sixel without header and DCS envelope") 135 | 136 | parser.add_option("-f", "--fast", 137 | action="store_true", 138 | dest="fast", 139 | default=True, 140 | help="The speed priority mode (default)") 141 | 142 | parser.add_option("-s", "--size", 143 | action="store_false", 144 | dest="fast", 145 | default=True, 146 | help="The size priority mode") 147 | 148 | parser.add_option("-v", "--version", 149 | action="store_true", 150 | dest="version", 151 | default=False, 152 | help="Show version") 153 | 154 | options, args = parser.parse_args() 155 | 156 | if options.version: 157 | print(license_text) 158 | sys.exit(0) 159 | 160 | rcdir = os.path.join(os.getenv("HOME"), ".pysixel") 161 | logdir = os.path.join(rcdir, "log") 162 | if not os.path.exists(logdir): 163 | os.makedirs(logdir) 164 | 165 | logfile = os.path.join(logdir, "log.txt") 166 | logging.basicConfig(filename=logfile, filemode="w") 167 | 168 | stdin, stdout = sys.stdin, sys.stdout 169 | left = options.left 170 | top = options.top 171 | width = options.width 172 | height = options.height 173 | 174 | if (left, top, width, height) != (None, None, None, None): 175 | if os.isatty(stdout.fileno()) and os.isatty(stdin.fileno()): 176 | try: 177 | char_width, char_height = CellSizeDetector().get_size() 178 | except Exception: 179 | char_width, char_height = (10, 20) 180 | else: 181 | char_width, char_height = (10, 20) 182 | 183 | if not left is None: 184 | pos = left.find("px") 185 | if pos > 0: 186 | left = int(left[:pos]) / char_width 187 | else: 188 | left = int(left) 189 | 190 | if not top is None: 191 | pos = top.find("px") 192 | if pos > 0: 193 | top = int(top[:pos]) / char_width 194 | else: 195 | top = int(top) 196 | 197 | if not width is None: 198 | pos = width.find("px") 199 | if pos > 0: 200 | width = int(width[:pos]) 201 | else: 202 | width = int(width) * char_width 203 | 204 | if not height is None: 205 | pos = height.find("px") 206 | if pos > 0: 207 | height = int(height[:pos]) 208 | else: 209 | height = int(height) * char_height 210 | 211 | writer = SixelWriter(f8bit=options.f8bit, 212 | bodyonly=options.bodyonly) 213 | 214 | try: 215 | if select.select([stdin, ], [], [], 0.0)[0]: 216 | imagefile = _filenize(stdin) 217 | elif len(args) == 0 or args[0] == '-': 218 | imagefile = _filenize(stdin) 219 | else: 220 | imagefile = args[0] 221 | 222 | writer.draw(imagefile, 223 | output=sys.stdout, 224 | absolute=options.fabsolute, 225 | x=left, 226 | y=top, 227 | w=width, 228 | h=height, 229 | ncolor=int(options.ncolor), 230 | alphathreshold=options.alphathreshold, 231 | chromakey=options.chromakey, 232 | fast=options.fast) 233 | except KeyboardInterrupt: 234 | pass 235 | 236 | if __name__ == '__main__': 237 | main() 238 | -------------------------------------------------------------------------------- /sixel/cellsize.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # ***** BEGIN LICENSE BLOCK ***** 5 | # Copyright (C) 2012-2014 Hayaki Saito 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # ***** END LICENSE BLOCK ***** 20 | 21 | import sys 22 | import os 23 | import termios 24 | import select 25 | 26 | 27 | class CellSizeDetector: 28 | 29 | def __set_raw(self): 30 | fd = sys.stdin.fileno() 31 | backup = termios.tcgetattr(fd) 32 | try: 33 | new = termios.tcgetattr(fd) 34 | new[0] = 0 # c_iflag = 0 35 | new[3] = 0 # c_lflag = 0 36 | new[3] = new[3] & ~(termios.ECHO | termios.ICANON) 37 | termios.tcsetattr(fd, termios.TCSANOW, new) 38 | except Exception: 39 | termios.tcsetattr(fd, termios.TCSANOW, backup) 40 | return backup 41 | 42 | def __reset_raw(self, old): 43 | fd = sys.stdin.fileno() 44 | termios.tcsetattr(fd, termios.TCSAFLUSH, old) 45 | 46 | def __get_report(self, query): 47 | result = '' 48 | fd = sys.stdin.fileno() 49 | rfds = [fd] 50 | wfds = [] 51 | xfds = [] 52 | 53 | sys.stdout.write(query) 54 | sys.stdout.flush() 55 | 56 | rfd, wfd, xfd = select.select(rfds, wfds, xfds, 0.5) 57 | if rfd: 58 | result = os.read(fd, 1024) 59 | return result[:-1].split(';')[1:] 60 | return None 61 | 62 | def get_size(self): 63 | 64 | backup_termios = self.__set_raw() 65 | try: 66 | height, width = self.__get_report("\x1b[14t") 67 | row, column = self.__get_report("\x1b[18t") 68 | 69 | char_width = int(width) / int(column) 70 | char_height = int(height) / int(row) 71 | finally: 72 | self.__reset_raw(backup_termios) 73 | return char_width, char_height 74 | -------------------------------------------------------------------------------- /sixel/converter.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # ***** BEGIN LICENSE BLOCK ***** 5 | # Copyright (C) 2012-2014 Hayaki Saito 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # ***** END LICENSE BLOCK ***** 20 | 21 | import sys 22 | if sys.version_info[0] == 3: 23 | xrange = range 24 | del sys 25 | 26 | 27 | class SixelConverter: 28 | 29 | def __init__(self, file, 30 | f8bit=False, 31 | w=None, 32 | h=None, 33 | ncolor=256, 34 | alphathreshold=0, 35 | chromakey=False, 36 | fast=True): 37 | 38 | self.__alphathreshold = alphathreshold 39 | self.__chromakey = chromakey 40 | self._slots = [0] * 257 41 | self._fast = fast 42 | 43 | if ncolor >= 256: 44 | ncolor = 256 45 | 46 | self._ncolor = ncolor 47 | 48 | if f8bit: # 8bit mode 49 | self.DCS = '\x90' 50 | self.ST = '\x9c' 51 | else: 52 | self.DCS = '\x1bP' 53 | self.ST = '\x1b\\' 54 | 55 | try: 56 | from PIL import Image # PIL 57 | except ImportError: 58 | import imageloader as Image 59 | 60 | image = Image.open(file) 61 | image = image.convert("RGB").convert("P", 62 | palette=Image.ADAPTIVE, 63 | colors=ncolor) 64 | if w or h: 65 | width, height = image.size 66 | if not w: 67 | w = width 68 | if not h: 69 | h = height 70 | image = image.resize((w, h)) 71 | 72 | self.palette = image.getpalette() 73 | self.data = image.getdata() 74 | self.width, self.height = image.size 75 | 76 | if alphathreshold > 0: 77 | self.rawdata = Image.open(file).convert("RGBA").getdata() 78 | 79 | def __write_header(self, output): 80 | # start Device Control String (DCS) 81 | output.write(self.DCS) 82 | 83 | # write header 84 | aspect_ratio = 7 # means 1:1 85 | if self.__chromakey: 86 | background_option = 2 87 | else: 88 | background_option = 1 89 | dpi = 75 # dummy value 90 | template = '%d;%d;%dq"1;1;%d;%d' 91 | args = (aspect_ratio, background_option, dpi, self.width, self.height) 92 | output.write(template % args) 93 | 94 | def __write_palette_section(self, output): 95 | 96 | palette = self.palette 97 | 98 | # write palette section 99 | for i in xrange(0, self._ncolor * 3, 3): 100 | no = i / 3 101 | r = palette[i + 0] * 100 / 256 102 | g = palette[i + 1] * 100 / 256 103 | b = palette[i + 2] * 100 / 256 104 | output.write('#%d;2;%d;%d;%d' % (no, r, g, b)) 105 | 106 | def __write_body_without_alphathreshold(self, output, data, keycolor): 107 | for n in xrange(0, self._ncolor): 108 | palette = self.palette 109 | r = palette[n * 3 + 0] * 100 / 256 110 | g = palette[n * 3 + 1] * 100 / 256 111 | b = palette[n * 3 + 2] * 100 / 256 112 | output.write('#%d;2;%d;%d;%d\n' % (n, r, g, b)) 113 | height = self.height 114 | width = self.width 115 | for y in xrange(0, height, 6): 116 | if height - y <= 5: 117 | band = height - y 118 | else: 119 | band = 6 120 | buf = [] 121 | set_ = set() 122 | 123 | def add_node(n, s): 124 | node = [] 125 | cache = 0 126 | count = 0 127 | if s: 128 | node.append((0, s)) 129 | for x in xrange(s, width): 130 | count += 1 131 | p = y * width + x 132 | six = 0 133 | for i in xrange(0, band): 134 | d = data[p + width * i] 135 | if d == n: 136 | six |= 1 << i 137 | elif not d in set_: 138 | set_.add(d) 139 | add_node(d, x) 140 | if six != cache: 141 | node.append([cache, count]) 142 | count = 0 143 | cache = six 144 | if cache != 0: 145 | node.append([cache, count]) 146 | buf.append((n, node)) 147 | 148 | add_node(data[y * width], 0) 149 | 150 | for n, node in buf: 151 | output.write("#%d\n" % n) 152 | for six, count in node: 153 | if count < 4: 154 | output.write(chr(0x3f + six) * count) 155 | else: 156 | output.write('!%d%c' % (count, 0x3f + six)) 157 | output.write("$\n") 158 | output.write("-\n") 159 | 160 | def __write_body_without_alphathreshold_fast(self, output, data, keycolor): 161 | height = self.height 162 | width = self.width 163 | n = 1 164 | for y in xrange(0, height): 165 | p = y * width 166 | cached_no = data[p] 167 | count = 1 168 | c = -1 169 | for x in xrange(0, width): 170 | color_no = data[p + x] 171 | if color_no == cached_no: # and count < 255: 172 | count += 1 173 | else: 174 | if cached_no == keycolor: 175 | c = 0x3f 176 | else: 177 | c = 0x3f + n 178 | if self._slots[cached_no] == 0: 179 | palette = self.palette 180 | r = palette[cached_no * 3 + 0] * 100 / 256 181 | g = palette[cached_no * 3 + 1] * 100 / 256 182 | b = palette[cached_no * 3 + 2] * 100 / 256 183 | self._slots[cached_no] = 1 184 | output.write('#%d;2;%d;%d;%d' % (cached_no, r, g, b)) 185 | output.write('#%d' % cached_no) 186 | if count < 3: 187 | output.write(chr(c) * count) 188 | else: 189 | output.write('!%d%c' % (count, c)) 190 | count = 1 191 | cached_no = color_no 192 | if c != -1 and count > 1: 193 | if cached_no == keycolor: 194 | c = 0x3f 195 | else: 196 | if self._slots[cached_no] == 0: 197 | palette = self.palette 198 | r = palette[cached_no * 3 + 0] * 100 / 256 199 | g = palette[cached_no * 3 + 1] * 100 / 256 200 | b = palette[cached_no * 3 + 2] * 100 / 256 201 | self._slots[cached_no] = 1 202 | output.write('#%d;2;%d;%d;%d' % (cached_no, r, g, b)) 203 | output.write('#%d' % cached_no) 204 | if count < 3: 205 | output.write(chr(c) * count) 206 | else: 207 | output.write('!%d%c' % (count, c)) 208 | if n == 32: 209 | n = 1 210 | output.write('-') # write sixel line separator 211 | else: 212 | n <<= 1 213 | output.write('$') # write line terminator 214 | 215 | def __write_body_with_alphathreshold(self, output, data, keycolor): 216 | rawdata = self.rawdata 217 | height = self.height 218 | width = self.width 219 | max_runlength = 255 220 | n = 1 221 | for y in xrange(0, height): 222 | p = y * width 223 | cached_no = data[p] 224 | cached_alpha = rawdata[p][3] 225 | count = 1 226 | c = -1 227 | for x in xrange(0, width): 228 | color_no = data[p + x] 229 | alpha = rawdata[p + x][3] 230 | if color_no == cached_no: 231 | if alpha == cached_alpha: 232 | if count < max_runlength: 233 | count += 1 234 | continue 235 | if cached_no == keycolor: 236 | c = 0x3f 237 | elif cached_alpha < self.__alphathreshold: 238 | c = 0x3f 239 | else: 240 | c = n + 0x3f 241 | if count == 1: 242 | output.write('#%d%c' % (cached_no, c)) 243 | elif count == 2: 244 | output.write('#%d%c%c' % (cached_no, c, c)) 245 | count = 1 246 | else: 247 | output.write('#%d!%d%c' % (cached_no, count, c)) 248 | count = 1 249 | cached_no = color_no 250 | cached_alpha = alpha 251 | if c != -1: 252 | if cached_no == keycolor: 253 | c = 0x3f 254 | if count == 1: 255 | output.write('#%d%c' % (cached_no, c)) 256 | elif count == 2: 257 | output.write('#%d%c%c' % (cached_no, c, c)) 258 | else: 259 | output.write('#%d!%d%c' % (cached_no, count, c)) 260 | output.write('$') # write line terminator 261 | if n == 32: 262 | n = 1 263 | output.write('-') # write sixel line separator 264 | else: 265 | n <<= 1 266 | 267 | def __write_body_section(self, output): 268 | data = self.data 269 | if self.__chromakey: 270 | keycolor = data[0] 271 | else: 272 | keycolor = -1 273 | if self.__alphathreshold == 0: 274 | if self._fast: 275 | self.__write_body_without_alphathreshold_fast(output, data, keycolor) 276 | else: 277 | self.__write_body_without_alphathreshold(output, data, keycolor) 278 | else: 279 | self.__write_body_with_alphathreshold(output, data, keycolor) 280 | 281 | def __write_terminator(self, output): 282 | # write ST 283 | output.write(self.ST) # terminate Device Control String 284 | 285 | def getvalue(self): 286 | 287 | try: 288 | from cStringIO import StringIO 289 | except ImportError: 290 | from StringIO import StringIO 291 | output = StringIO() 292 | 293 | try: 294 | self.write(output) 295 | value = output.getvalue() 296 | 297 | finally: 298 | output.close() 299 | 300 | return value 301 | 302 | def write(self, output, bodyonly=False): 303 | if not bodyonly: 304 | self.__write_header(output) 305 | self.__write_body_section(output) 306 | if not bodyonly: 307 | self.__write_terminator(output) 308 | -------------------------------------------------------------------------------- /sixel/sixel.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # ***** BEGIN LICENSE BLOCK ***** 5 | # Copyright (C) 2012-2014 Hayaki Saito 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # ***** END LICENSE BLOCK ***** 20 | 21 | import sys 22 | import os 23 | import logging 24 | try: 25 | from sixel_cimpl import SixelConverter 26 | except ImportError as e: 27 | logging.exception(e) 28 | from .converter import SixelConverter 29 | 30 | 31 | class SixelWriter: 32 | 33 | def __init__(self, f8bit=False, bodyonly=False): 34 | self.f8bit = f8bit 35 | self._bodyonly = bodyonly 36 | if f8bit: # 8bit mode 37 | self.CSI = '\x9b' 38 | else: 39 | self.CSI = '\x1b[' 40 | 41 | def save_position(self, output): 42 | if not self._bodyonly: 43 | if os.isatty(output.fileno()): 44 | output.write('\x1b7') # DECSC 45 | 46 | def restore_position(self, output): 47 | if not self._bodyonly: 48 | if os.isatty(output.fileno()): 49 | output.write('\x1b8') # DECRC 50 | 51 | def move_x(self, n, fabsolute, output): 52 | if not self._bodyonly: 53 | output.write(self.CSI) 54 | if fabsolute: 55 | output.write('%d`' % n) 56 | elif n > 0: 57 | output.write('%dC' % n) 58 | elif n < 0: 59 | output.write('%dD' % -n) 60 | 61 | def move_y(self, n, fabsolute, output): 62 | if not self._bodyonly: 63 | output.write(self.CSI) 64 | if fabsolute: 65 | output.write('%dd' % n) 66 | elif n > 0: 67 | output.write('%dB' % n) 68 | elif n < 0: 69 | output.write('%dA' % n) 70 | 71 | def draw(self, 72 | filename, 73 | output=sys.stdout, 74 | absolute=False, 75 | x=None, 76 | y=None, 77 | w=None, 78 | h=None, 79 | ncolor=256, 80 | alphathreshold=0, 81 | chromakey=False, 82 | fast=True): 83 | 84 | try: 85 | filename.seek(0) 86 | except Exception: 87 | pass 88 | self.save_position(output) 89 | 90 | try: 91 | if not x is None: 92 | self.move_x(x, absolute, output) 93 | 94 | if not y is None: 95 | self.move_y(y, absolute, output) 96 | 97 | sixel_converter = SixelConverter(filename, 98 | self.f8bit, 99 | w, 100 | h, 101 | ncolor, 102 | alphathreshold=alphathreshold, 103 | chromakey=chromakey, 104 | fast=fast) 105 | sixel_converter.write(output, bodyonly=self._bodyonly) 106 | 107 | finally: 108 | self.restore_position(output) 109 | --------------------------------------------------------------------------------