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#ifndef __BASE_IMGWRITER_HH__
40#define __BASE_IMGWRITER_HH__
41
42#include <ostream>
43
44#include "base/compiler.hh"
45#include "base/framebuffer.hh"
46
47#include "enums/ImageFormat.hh"
48
49// write frame buffer to an image
50class ImgWriter
51{
52  public:
53    ImgWriter(const FrameBuffer *_fb)
54      : fb(*_fb)
55    {}
56
57    virtual ~ImgWriter() {};
58    /**
59     * Write the frame buffer data into the provided ostream
60     *
61     * @param out output stream to write to
62     */
63    virtual void write(std::ostream &out) const = 0;
64    /*
65     * Return Image format as a string
66     *
67     * @return img extension (e.g. bmp for Bitmap)
68     */
69    virtual const char* getImgExtension() const = 0;
70
71  protected:
72    const FrameBuffer &fb;
73};
74
75/**
76 * Factory Function which allocates a ImgWriter object and returns
77 * a smart pointer to it. The dynamic type of the object being pointed
78 * depends upon the enum type passed as a first parameter.
79 * If the enum contains an invalid value, the function will produce a warning
80 * and will default to Bitamp.
81 *
82 * @param type Image writer type (e.g. Bitamp, Png)
83 * @param fb Pointer to a FrameBuffer object
84 *           This contains the raw data which will be stored as an image
85 *           when calling the appropriate object method
86 * @return smart pointer to the allocated Image Writer
87 */
88std::unique_ptr<ImgWriter>
89createImgWriter(Enums::ImageFormat type, const FrameBuffer *fb);
90
91#endif //__BASE_IMGWRITER_HH__
92