1/*
2 * Copyright (c) 2017 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Giacomo Travaglini
38 */
39
40/**
41 * @file Declaration of a class that writes a frame buffer to a png
42 */
43
44#ifndef __BASE_PNG_HH__
45#define __BASE_PNG_HH__
46
47#include "base/compiler.hh"
48#include "base/framebuffer.hh"
49#include "base/imgwriter.hh"
50
51/** Image writer implementing support for PNG */
52class PngWriter : public ImgWriter
53{
54  public:
55    /**
56     * Create a png that takes data in a given mode & size and
57     * outputs to an ostream.
58     */
59    PngWriter(const FrameBuffer *_fb)
60      : ImgWriter(_fb)
61    {}
62
63    ~PngWriter() {};
64
65    /**
66     * Return Image format as a string
67     *
68     * @return img extension (e.g. .png for Png)
69     */
70    const char* getImgExtension() const override
71    { return _imgExtension; }
72
73    /**
74     * Write the frame buffer data into the provided ostream
75     *
76     * @param png stream to write to
77     */
78    void write(std::ostream &png) const override;
79  private:
80    /** Png Pixel type: not containing padding */
81    struct PngPixel24 {
82        PngPixel24 &operator=(const Pixel &rhs) {
83            red = rhs.red;
84            green = rhs.green;
85            blue = rhs.blue;
86
87            return *this;
88        }
89        uint8_t red;
90        uint8_t green;
91        uint8_t blue;
92    } M5_ATTR_PACKED;
93
94    /**
95     * Handle to resources used by libpng:
96     *   - png_struct: Structure holding write informations
97     *   - png_info  : Structure holding image informations
98     *
99     * The class is automatically taking care of struct
100     * allocation/deallocation
101     */
102    struct PngStructHandle;
103
104    typedef PngPixel24 PixelType;
105
106    static const char* _imgExtension;
107};
108
109#endif // __BASE_PNG_HH__
110