Spot

Sp:cyclone:t <a href="https://travis-ci.org/r-lyeh/spot"><img src="https://api.travis-ci.org/r-lyeh/spot.svg?branch=master" align="right" /></a>

• Spot is a compact and embeddable pixel/image library (C++11).
• Spot supports both RGBA/HSLA pixel types.
• Spot provides both pixel and image algebra for pixel/image manipulation.
• Spot loads WEBP, JPG, progressive JPG, PNG, TGA, DDS DXT1/2/3/4/5, BMP, PSD, GIF, PVR2/3 (ETC1/PVRTC), KTX (ETC1/PVRTC), PKM (ETC1), HDR, PIC, PNM (PPM/PGM), CRN, PUG, FLIF, CCZ, EXR and vectorial SVG files.
• Spot saves WEBP, JPG, PNG, TGA, BMP, DDS, PVR3 (PVRTC), KTX (ETC1), PKM (ETC1), CCZ and PUG files.
• Spot is self-contained. All libraries are included and amalgamated.
• Spot is tiny. A couple of source files.
• Spot is cross-platform.
• Spot is zlib/libpng licensed.

File format support

| File format | Read | Write | | :-------------|:-------------:| :-----:| | BMP files | yes | yes | | CCZ (PVR2) files | yes* | yes* | | CRN files | yes | no | | DDS DXT1/2/3/4/5 files | yes | yes | | EXR files | yes | no | | FLIF files | yes | no | | GIF files | yes | no | | HDR files | yes | no | | JPG files (progressive) | yes | no | | JPG files | yes | yes | | KTX (ETC1) files | yes* | yes* | | KTX (PVRTC) files | yes* | no | | PIC files | yes | no | | PKM (ETC1) files | yes | yes | | PNG files | yes | yes | | PNM (PPM/PGM) files | yes | no | | PSD files | yes | no | | PUG files | yes | yes | | PVR2 (PVRTC) files | yes* | no | | PVR3 (ETC1) files | yes* | no | | PVR3 (PVRTC) files | yes* | yes* | | SVG files (rasterized) | yes | no | | TGA files | yes | yes | | WEBP files | yes | yes |

(*) partial support, preliminary, warning, caution, atchung, beware of dog

todo

• document api
• create more image filters
• clean up code

template<typename color>
class image : public std::vector<color>
{
    public:

    size_t w, h, d;
    float delay; // frame delay, when loading an animation

    image();
    image( size_t w, size_t h, size_t d = 0, const color &filler = color::hsla() );
    explicit image( const std::string &filename, bool mirror_w = false, bool mirror_h = false );
    explicit image( const void *ptr, size_t len, bool mirror_w = false, bool mirror_h = false );

    bool load( const void *ptr, size_t len, bool mirror_w = false, bool mirror_h = false );
    bool load( const std::string &filename, bool mirror_w = false, bool mirror_h = false );

    bool save( const std::string &filename ) const;

    bool save_as_bmp( const std::string &filename ) const;
    bool save_as_dds( const std::string &filename ) const;
    bool save_as_tga( const std::string &filename ) const;
    bool save_as_png( const std::string &filename, unsigned stride = 4 ) const;
    bool save_as_pug( const std::string &filename, unsigned quality = 90 ) const;
    bool save_as_jpg( const std::string &filename, unsigned quality = 90 ) const;
    bool save_as_webp(const std::string &filename, unsigned quality = 90 ) const;
    bool save_as_ktx( const std::string &filename, unsigned quality = 90 ) const;
    bool save_as_pvr( const std::string &filename, unsigned quality = 90 ) const;
    bool save_as_pkm( const std::string &filename, unsigned quality = 90 ) const;
    bool save_as_ccz( const std::string &filename, unsigned quality = 90 ) const;

    std::string encode_as_png( unsigned stride = 4 ) const;
    std::string encode_as_pug( unsigned quality = 90 ) const;
    std::string encode_as_jpg( unsigned quality = 90 ) const;
    std::string encode_as_webp(unsigned quality = 90 ) const;
    std::string encode_as_ktx( unsigned quality = 90 ) const;
    std::string encode_as_pvr( unsigned quality = 90 ) const;
    std::string encode_as_pvr( unsigned quality = 90 ) const;
    std::string encode_as_pkm( unsigned quality = 90 ) const;
    std::string encode_as_ccz( unsigned quality = 90 ) const;

    inline const size_t size() const;
    bool loaded() const;

    inline color &at( size_t offset );
    inline color &at( size_t x, size_t y );
    inline color &at( size_t x, size_t y, size_t z );
    inline color &atf( float x01 );
    inline color &atf( float x01, float y01 );
    inline color &atf( float x01, float y01, float z01 );

    inline const color &at( size_t offset ) const;
    inline const color &at( size_t x, size_t y ) const;
    inline const color &at( size_t x, size_t y, size_t z ) const;
    inline const color &atf( float x01 ) const;
    inline const color &atf( float x01, float y01 ) const;
    inline const color &atf( float x01, float y01, float z01 ) const;

    image copy( size_t ox, size_t oy, size_t w = ~0, size_t h = ~0 ) const;
    image paste( size_t at_x, size_t at_y, const image &other ) const;
    image crop( size_t left, size_t right, size_t top, size_t bottom ) const; // each param is number of row/cols to crop

    image flip_w() const;
    image flip_h() const;
    image rotate_left() const;
    image rotate_right() const;

    image operator *( const color &other ) const;
    image operator /( const color &other ) const;
    image operator +( const color &other ) const;
    image operator -( const color &other ) const;

    image &operator *=( const color &other );
    image &operator /=( const color &other );
    image &operator +=( const color &other );
    image &operator -=( const color &other );

    image to_rgba() const;
    image to_hsla() const;

    image to_premultiplied_alpha() const;
    image to_straight_alpha() const;

    std::vector<unsigned int>  rgba32() const;
    std::vector<unsigned char> rgbx( unsigned char ) const;
    std::vector<unsigned char> bgrx( unsigned char ) const;
    std::vector<unsigned char> rgba() const;
    std::vector<unsigned char> bgra() const;
    std::vector<unsigned char> rgb() const;
    std::vector<unsigned char> bgr() const;
    std::vector<unsigned char> ya() const;
    std::vector<unsigned char> y() const;
};

sample

    spot::image img( filename );

    spot::image saturated = img * spot::hsla( 1, 2, 1, 1 );
    spot::image desaturated = img * spot::hsla( 1, 0.5f, 1, 1 );
    spot::image gray = img * spot::hsla( 1, 0, 1, 1 );
    spot::image light = img * spot::hsla( 1, 1, 1.75f, 1 );
    spot::image hue = img + spot::hsla( 0.5f, 0, 0, 0 );
    spot::image warmer = img + spot::hsla( -0.08f, 0, 0, 0 );
    spot::image colder = img + spot::hsla(  0.08f, 0, 0, 0 );

    img.save_as_bmp("collage.bmp");
    img.save_as_dds("collage.dds");
    img.save_as_jpg("collage.jpg", 80);
    img.save_as_ktx("collage.ktx", 10);
    img.save_as_pkm("collage.pkm", 10);
    img.save_as_png("collage.png");
    img.save_as_pug("collage.pug", 80);
    img.save_as_pvr("collage.pvr", 10);
    img.save_as_webp("collage.webp", 80);

possible output

23/04/2015  21:05           786.486 collage.bmp
23/04/2015  21:05           262.272 collage.dds
23/04/2015  21:05            55.018 collage.jpg
23/04/2015  21:05           131.140 collage.ktx
23/04/2015  21:05           131.088 collage.pkm
23/04/2015  21:05           296.619 collage.png
23/04/2015  21:05            55.227 collage.pug
23/04/2015  21:05           131.128 collage.pvr
23/04/2015  21:05            42.272 collage.webp

color transfer sample

todos

• clean ups
• integrate metrics
• dds/dxt and bc5/6/7
• better crn handling
• endianness issues

licenses

• spot (ZLIB license).
• crn2dds by r-lyeh, SpartanJ and Evan Parker (Public Domain).
• crnlib, by Rich Geldreich (ZLIB license).
• DDS writer by Jonathan Dummer (Public Domain).
• etc1utils by Google Inc (Apache 2.0 license).
• etcpak by Bartosz Taudul (BSD-3 license).
• flif by Jon Sneyers and Pieter Wuille (Apache 2.0 license).
• jpge by Rich Geldreich (Public Domain).
• libwebp by Google Inc (BSD license).
• lodepng by Lode Vandevenne (ZLIB license).
• nanosvg by Mikko Mononen (ZLIB license).
• pngrim alpha bleeding algorithm by F-Genesis (Public Domain).
• pug (Public Domain).
• pvrtccompressor by Jeffrey Lim (BSD-3 license).
• rg_etc1 by Rich Geldreich (ZLIB license).
• soil2 by Martin Lucas Golini and Jonathan Dummer (Public Domain).
• stb_image by Sean Barrett (Public Domain).
• tinyexr by Syoyo Fujita (BSD3 license).
• unifont (ZLIB license).

notes

• Samples are Public Domain licensed. Samples use CImg.h by David Tschumperle (CeCILL-C license) to display images.
• gcc users may need strict aliasing disabled if using CRN textures: add -fno-strict-aliasing compilation flag.

changelog

• v2.1.4 (2018/11/16): bump up soil2, stb_image(s), cimg
• v2.1.3 (2016/07/01): ccz loading and saving support (pvr.ccz); bump soil2 and stb_image
• v2.1.2 (2016/02/04): flif and exr loading support
• v2.1.1 (2016/02/01): update nanosvg; add small optimizations
• v2.1.0 (2015/09/28): faster image pasting
• v2.0.9 (2015/05/12): safer decoding on invalid images
• v2.0.8 (2015/05/07): faster etc1 encoding on low quality settings (using custom etcpak library)
• v2.0.7 (2015/05/06): stb image library defined as static (fixes multiple symbol definitions in large projects); upgraded tools
• v2.0.6 (2015/05/05): print() method added
• v2.0.5 (2015/04/27): pvrtc encoder; c++0x su