framebuffer.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2015 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Andreas Sandberg
 */

#ifndef __BASE_FRAMEBUFFER_HH__
#define __BASE_FRAMEBUFFER_HH__

#include <cmath>
#include <cstdint>

#include <string>
#include <vector>

#include "base/compiler.hh"
#include "base/cprintf.hh"
#include "base/str.hh"
#include "base/types.hh"
#include "sim/serialize.hh"

struct Pixel
{
    Pixel()
        : red(0), green(0), blue(0), padding(0) {}

    Pixel(uint8_t _red, uint8_t _green, uint8_t _blue)
        : red(_red), green(_green), blue(_blue), padding(0) {}

    uint8_t red;
    uint8_t green;
    uint8_t blue;
    uint8_t padding;
};

inline bool
operator==(const Pixel &lhs, const Pixel &rhs)
{
    return lhs.red == rhs.red &&
        lhs.green == rhs.green &&
        lhs.blue == rhs.blue &&
        lhs.padding == rhs.padding;
}

class PixelConverter
{
  public:
    struct Channel {
        Channel(unsigned offset, unsigned width);

        uint8_t toPixel(uint32_t word) const {
            return round(((word >> offset) & mask) * factor);
        }

        uint32_t fromPixel(uint8_t ch) const {
            return (static_cast<uint8_t>(round(ch / factor)) & mask) << offset;
        }

        unsigned offset;
        unsigned mask;
        float factor;
    };

    PixelConverter(unsigned length,
                   unsigned ro, unsigned go, unsigned bo,
                   unsigned rw, unsigned gw, unsigned bw,
                   ByteOrder byte_order = LittleEndianByteOrder);

    Pixel toPixel(uint32_t word) const {
        return Pixel(ch_r.toPixel(word),
                     ch_g.toPixel(word),
                     ch_b.toPixel(word));
    }

    Pixel toPixel(const uint8_t *rfb) const {
        return toPixel(readWord(rfb));
    }

    uint32_t fromPixel(const Pixel &pixel) const {
        return ch_r.fromPixel(pixel.red) |
            ch_g.fromPixel(pixel.green) |
            ch_b.fromPixel(pixel.blue);
    }

    void fromPixel(uint8_t *rfb, const Pixel &pixel) const {
        writeWord(rfb, fromPixel(pixel));
    }

    uint32_t readWord(const uint8_t *p) const;
    void writeWord(uint8_t *p, uint32_t word) const;

    unsigned length;
    unsigned depth;
    ByteOrder byte_order;

    Channel ch_r;
    Channel ch_g;
    Channel ch_b;

    static const PixelConverter rgba8888_le;
    static const PixelConverter rgb565_le;

    static const PixelConverter rgba8888_be;
    static const PixelConverter rgb565_be;
};

inline bool
to_number(const std::string &value, Pixel &retval)
{
    uint32_t num;
    if (!to_number(value, num))
        return false;

    retval = PixelConverter::rgba8888_le.toPixel(num);
    return true;
}

inline std::ostream &
operator<<(std::ostream &os, const Pixel &pxl)
{
    os << csprintf("0x%.08x", PixelConverter::rgba8888_le.fromPixel(pxl));
    return os;
}

class FrameBuffer : public Serializable
{
  public:
    FrameBuffer(unsigned width, unsigned height);
    FrameBuffer();

    virtual ~FrameBuffer();

    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;

    void resize(unsigned width, unsigned height);

    unsigned width() const { return _width; }
    unsigned height() const { return _height; }
    unsigned area() const { return _width * _height; }

    void fill(const Pixel &pixel);
    void clear();

    void copyIn(const uint8_t *fb, const PixelConverter &conv);
    void copyIn(const std::vector<uint8_t> &fb, const PixelConverter &conv) {
        copyIn(fb.data(), conv);
    }

    void copyOut(uint8_t *fb, const PixelConverter &conv) const;
    void copyOut(std::vector<uint8_t> &fb, const PixelConverter &conv) const {
        copyOut(fb.data(), conv);
    }

    const Pixel &pixel(unsigned x, unsigned y) const {
        assert(x < _width);
        assert(y < _height);

        return pixels[y * _width + x];
    }

    Pixel &pixel(unsigned x, unsigned y) {
        assert(x < _width);
        assert(y < _height);

        return pixels[y * _width + x];
    }

    uint64_t getHash() const;

    static const FrameBuffer dummy;

    std::vector<Pixel> pixels;

  protected:
    unsigned _width;
    unsigned _height;
};

#endif // __BASE_FRAMEBUFFER_HH__