BasicImage.h

/* Copyright (C) 2015 Marc Boris Duerner
   Copyright (C) 2015 Laurentiu-Gheorghe Crisan

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  As a special exception, you may use this file as part of a free
  software library without restriction. Specifically, if other files
  instantiate templates or use macros or inline functions from this
  file, or you compile this file and link it with other files to
  produce an executable, this file does not by itself cause the
  resulting executable to be covered by the GNU General Public
  License. This exception does not however invalidate any other
  reasons why the executable file might be covered by the GNU Library
  General Public License.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301 USA
*/

#ifndef PT_GFX_BASICIMAGE_H
#define PT_GFX_BASICIMAGE_H

#include <Pt/Gfx/Api.h>
#include <Pt/Gfx/Size.h>
#include <Pt/Types.h>
#include <vector>

namespace Pt {

namespace Gfx {

template <typename ModelT>
class BasicView
{
    public:
        typedef ModelT                      Model;
        typedef typename ModelT::Pixel      Pixel;
        typedef typename ModelT::ConstPixel ConstPixel;

        class PixelIterator
        {
            public:
                PixelIterator(BasicView& view, Pt::ssize_t x, Pt::ssize_t y)
                : _pixel(view, x, y)
                { }

                PixelIterator(const PixelIterator& it)
                : _pixel(it._pixel)
                {}

                PixelIterator& operator=(const PixelIterator& it)
                {
                    _pixel.reset(it._pixel);
                    return *this;
                }

                Pixel& operator*()
                { return _pixel; }

                Pixel* operator->()
                { return &_pixel; }

                PixelIterator& operator++()
                {
                    _pixel.advance();
                    return *this;
                }

                PixelIterator& operator+=(Pt::ssize_t n)
                {
                    _pixel.advance(n);
                    return *this;
                }

                bool operator!=(const PixelIterator& it) const
                { return _pixel != it._pixel; }

                bool operator==(const PixelIterator& it) const
                { return _pixel == it._pixel; }

                std::size_t pixelStride() const
                { return Model::pixelStride(); }

            private:
                Pixel _pixel;
        };

        class ConstPixelIterator
        {
            public:
                ConstPixelIterator(const BasicView& view, Pt::ssize_t x, Pt::ssize_t y)
                : _pixel(view, x, y)
                { }

                ConstPixelIterator(const ConstPixelIterator& it)
                : _pixel(it._pixel)
                {}

                ConstPixelIterator& operator=(const ConstPixelIterator& it)
                {
                    _pixel.reset(it._pixel);
                    return *this;
                }

                const ConstPixel& operator*() const
                { return _pixel; }

                const ConstPixel* operator->() const
                { return &_pixel; }

                ConstPixelIterator& operator++()
                {
                    _pixel.advance();
                    return *this;
                }

                ConstPixelIterator& operator+=(Pt::ssize_t n)
                {
                    _pixel.advance(n);
                    return *this;
                }

                bool operator!=(const ConstPixelIterator& it) const
                { return _pixel != it._pixel; }

                bool operator==(const ConstPixelIterator& it) const
                { return _pixel == it._pixel; }

                std::size_t pixelStride() const
                { return Model::pixelStride(); }

            private:
                ConstPixel _pixel;
        };

    public:
        BasicView(Pt::uint8_t* data, const Size& size, Pt::ssize_t padding = 0)
        : _data(data)
        , _size(size)
        , _padding(padding)
        , _stride(0)
        {
            _stride = (_size.width() * ModelT::pixelStride()) + _padding;
        }

        PixelIterator pixel(Pt::ssize_t x, Pt::ssize_t y)
        { return PixelIterator(*this, x, y); }

        PixelIterator begin()
        { return PixelIterator(*this, 0, 0); }

        PixelIterator end()
        { return PixelIterator(*this, 0, height()); }

        ConstPixelIterator pixel(Pt::ssize_t x, Pt::ssize_t y) const
        { return ConstPixelIterator(*this, x, y); }

        ConstPixelIterator begin() const
        { return PixelIterator(*this, 0, 0); }

        ConstPixelIterator end() const
        { return PixelIterator(*this, 0, height()); }

        const Size& size() const
        { return _size; }

        Pt::ssize_t width() const
        { return _size.width(); }

        Pt::ssize_t height() const
        { return _size.height(); }

        bool empty() const
        { return _size.width() == 0 || _size.height() == 0; }

        Pt::uint8_t* data()
        { return _data; }

        const Pt::uint8_t* data() const
        { return _data; }

        Pt::ssize_t stride() const
        { return _stride; }

        Pt::ssize_t padding() const
        { return _padding; }

        std::size_t pixelStride() const
        { return Model::pixelStride(); }

    private:
        Pt::uint8_t* _data;
        Size         _size;
        Pt::ssize_t  _padding;
        Pt::ssize_t  _stride;
};


template <typename ModelT, typename ViewT = BasicView<ModelT> >
class BasicImage
{
    public:
        typedef ModelT                              Model;
        typedef typename ModelT::Pixel              Pixel;
        typedef typename ModelT::ConstPixel         ConstPixel;

        typedef ViewT                               View;
        typedef typename View::PixelIterator        PixelIterator;
        typedef typename View::ConstPixelIterator   ConstPixelIterator;

    public:
        BasicImage(const Size& size, Pt::ssize_t padding = 0)
        : _buffer( Model::imageSize(size, padding) )
        , _view(_buffer.empty() ? 0 : &_buffer[0], size, padding)
        { }

        BasicImage(Pt::uint8_t* data, const Size& size, Pt::ssize_t padding = 0)
        : _view(data, size, padding)
        { }

        virtual ~BasicImage()
        {}

        PixelIterator pixel(Pt::ssize_t x, Pt::ssize_t y)
        { return _view.pixel(x, y); }

        PixelIterator begin()
        { return _view.begin(); }

        PixelIterator end()
        { return _view.end(); }

        ConstPixelIterator pixel(Pt::ssize_t x, Pt::ssize_t y) const
        { return _view.pixel(x, y); }

        ConstPixelIterator begin() const
        { return _view.begin(); }

        ConstPixelIterator end() const
        { return _view.end(); }

        const Size& size() const
        { return _view.size(); }

        Pt::ssize_t width() const
        { return _view.width(); }

        Pt::ssize_t height() const
        { return _view.height(); }

        Pt::ssize_t padding() const
        { return _view.padding(); }

        Pt::uint8_t* data()
        { return _view.data(); }

        const Pt::uint8_t* data() const
        { return _view.data(); }

        bool empty() const
        { return _view.empty(); }

        const View& view() const
        { return _view; }

    private:
        std::vector<Pt::uint8_t> _buffer;
        View                     _view;
};

} // namespace

} // namespace

#endif