112230Sgiacomo.travaglini@arm.com/* 212230Sgiacomo.travaglini@arm.com * Copyright (c) 2017 ARM Limited 312230Sgiacomo.travaglini@arm.com * All rights reserved 412230Sgiacomo.travaglini@arm.com * 512230Sgiacomo.travaglini@arm.com * The license below extends only to copyright in the software and shall 612230Sgiacomo.travaglini@arm.com * not be construed as granting a license to any other intellectual 712230Sgiacomo.travaglini@arm.com * property including but not limited to intellectual property relating 812230Sgiacomo.travaglini@arm.com * to a hardware implementation of the functionality of the software 912230Sgiacomo.travaglini@arm.com * licensed hereunder. You may use the software subject to the license 1012230Sgiacomo.travaglini@arm.com * terms below provided that you ensure that this notice is replicated 1112230Sgiacomo.travaglini@arm.com * unmodified and in its entirety in all distributions of the software, 1212230Sgiacomo.travaglini@arm.com * modified or unmodified, in source code or in binary form. 1312230Sgiacomo.travaglini@arm.com * 1412230Sgiacomo.travaglini@arm.com * Redistribution and use in source and binary forms, with or without 1512230Sgiacomo.travaglini@arm.com * modification, are permitted provided that the following conditions are 1612230Sgiacomo.travaglini@arm.com * met: redistributions of source code must retain the above copyright 1712230Sgiacomo.travaglini@arm.com * notice, this list of conditions and the following disclaimer; 1812230Sgiacomo.travaglini@arm.com * redistributions in binary form must reproduce the above copyright 1912230Sgiacomo.travaglini@arm.com * notice, this list of conditions and the following disclaimer in the 2012230Sgiacomo.travaglini@arm.com * documentation and/or other materials provided with the distribution; 2112230Sgiacomo.travaglini@arm.com * neither the name of the copyright holders nor the names of its 2212230Sgiacomo.travaglini@arm.com * contributors may be used to endorse or promote products derived from 2312230Sgiacomo.travaglini@arm.com * this software without specific prior written permission. 2412230Sgiacomo.travaglini@arm.com * 2512230Sgiacomo.travaglini@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2612230Sgiacomo.travaglini@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2712230Sgiacomo.travaglini@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2812230Sgiacomo.travaglini@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2912230Sgiacomo.travaglini@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3012230Sgiacomo.travaglini@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3112230Sgiacomo.travaglini@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3212230Sgiacomo.travaglini@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3312230Sgiacomo.travaglini@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3412230Sgiacomo.travaglini@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3512230Sgiacomo.travaglini@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3612230Sgiacomo.travaglini@arm.com * 3712230Sgiacomo.travaglini@arm.com * Authors: Giacomo Travaglini 3812230Sgiacomo.travaglini@arm.com */ 3912230Sgiacomo.travaglini@arm.com#ifndef __BASE_IMGWRITER_HH__ 4012230Sgiacomo.travaglini@arm.com#define __BASE_IMGWRITER_HH__ 4112230Sgiacomo.travaglini@arm.com 4212230Sgiacomo.travaglini@arm.com#include <ostream> 4312230Sgiacomo.travaglini@arm.com 4412230Sgiacomo.travaglini@arm.com#include "base/compiler.hh" 4512230Sgiacomo.travaglini@arm.com#include "base/framebuffer.hh" 4612230Sgiacomo.travaglini@arm.com 4712230Sgiacomo.travaglini@arm.com#include "enums/ImageFormat.hh" 4812230Sgiacomo.travaglini@arm.com 4912230Sgiacomo.travaglini@arm.com// write frame buffer to an image 5012230Sgiacomo.travaglini@arm.comclass ImgWriter 5112230Sgiacomo.travaglini@arm.com{ 5212230Sgiacomo.travaglini@arm.com public: 5312230Sgiacomo.travaglini@arm.com ImgWriter(const FrameBuffer *_fb) 5412230Sgiacomo.travaglini@arm.com : fb(*_fb) 5512230Sgiacomo.travaglini@arm.com {} 5612230Sgiacomo.travaglini@arm.com 5712230Sgiacomo.travaglini@arm.com virtual ~ImgWriter() {}; 5812230Sgiacomo.travaglini@arm.com /** 5912230Sgiacomo.travaglini@arm.com * Write the frame buffer data into the provided ostream 6012230Sgiacomo.travaglini@arm.com * 6112230Sgiacomo.travaglini@arm.com * @param out output stream to write to 6212230Sgiacomo.travaglini@arm.com */ 6312230Sgiacomo.travaglini@arm.com virtual void write(std::ostream &out) const = 0; 6412230Sgiacomo.travaglini@arm.com /* 6512230Sgiacomo.travaglini@arm.com * Return Image format as a string 6612230Sgiacomo.travaglini@arm.com * 6712230Sgiacomo.travaglini@arm.com * @return img extension (e.g. bmp for Bitmap) 6812230Sgiacomo.travaglini@arm.com */ 6912230Sgiacomo.travaglini@arm.com virtual const char* getImgExtension() const = 0; 7012230Sgiacomo.travaglini@arm.com 7112230Sgiacomo.travaglini@arm.com protected: 7212230Sgiacomo.travaglini@arm.com const FrameBuffer &fb; 7312230Sgiacomo.travaglini@arm.com}; 7412230Sgiacomo.travaglini@arm.com 7512230Sgiacomo.travaglini@arm.com/** 7612230Sgiacomo.travaglini@arm.com * Factory Function which allocates a ImgWriter object and returns 7712230Sgiacomo.travaglini@arm.com * a smart pointer to it. The dynamic type of the object being pointed 7812230Sgiacomo.travaglini@arm.com * depends upon the enum type passed as a first parameter. 7912230Sgiacomo.travaglini@arm.com * If the enum contains an invalid value, the function will produce a warning 8012230Sgiacomo.travaglini@arm.com * and will default to Bitamp. 8112230Sgiacomo.travaglini@arm.com * 8212230Sgiacomo.travaglini@arm.com * @param type Image writer type (e.g. Bitamp, Png) 8312230Sgiacomo.travaglini@arm.com * @param fb Pointer to a FrameBuffer object 8412230Sgiacomo.travaglini@arm.com * This contains the raw data which will be stored as an image 8512230Sgiacomo.travaglini@arm.com * when calling the appropriate object method 8612230Sgiacomo.travaglini@arm.com * @return smart pointer to the allocated Image Writer 8712230Sgiacomo.travaglini@arm.com */ 8812230Sgiacomo.travaglini@arm.comstd::unique_ptr<ImgWriter> 8912230Sgiacomo.travaglini@arm.comcreateImgWriter(Enums::ImageFormat type, const FrameBuffer *fb); 9012230Sgiacomo.travaglini@arm.com 9112230Sgiacomo.travaglini@arm.com#endif //__BASE_IMGWRITER_HH__ 92