gem5  v21.1.0.2
imgwriter.cc
Go to the documentation of this file.
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 
38 #include "base/imgwriter.hh"
39 
40 #include "base/bmpwriter.hh"
41 #include "base/logging.hh"
42 #include "config/have_png.hh"
43 
44 #if HAVE_PNG
45 #include "base/pngwriter.hh"
46 
47 #endif
48 
49 namespace gem5
50 {
51 
52 std::unique_ptr<ImgWriter>
53 createImgWriter(enums::ImageFormat type, const FrameBuffer *fb)
54 {
55  switch (type) {
56  case enums::Auto:
57  // The Auto option allows gem5 to choose automatically the
58  // writer type, and it will choose for the best fit in
59  // performance.
60  // gem5 will try PNG first, and it will fallback to BMP if not
61  // available.
62 
64 #if HAVE_PNG
65  case enums::Png:
66  return std::unique_ptr<PngWriter>(new PngWriter(fb));
67 #endif
68  case enums::Bitmap:
69  return std::unique_ptr<BmpWriter>(new BmpWriter(fb));
70  default:
71  warn("Invalid Image Type specified, defaulting to Bitmap\n");
72  return std::unique_ptr<BmpWriter>(new BmpWriter(fb));
73  }
74 }
75 
76 } // namespace gem5
warn
#define warn(...)
Definition: logging.hh:245
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
GEM5_FALLTHROUGH
#define GEM5_FALLTHROUGH
Definition: compiler.hh:61
imgwriter.hh
gem5::BmpWriter
Definition: bmpwriter.hh:54
pngwriter.hh
gem5::X86ISA::type
type
Definition: misc.hh:733
gem5::ArmISA::fb
Bitfield< 9 > fb
Definition: misc_types.hh:274
gem5::createImgWriter
std::unique_ptr< ImgWriter > createImgWriter(enums::ImageFormat type, const FrameBuffer *fb)
Factory Function which allocates a ImgWriter object and returns a smart pointer to it.
Definition: imgwriter.cc:53
bmpwriter.hh
logging.hh
gem5::PngWriter
Image writer implementing support for PNG.
Definition: pngwriter.hh:53
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

Generated on Tue Sep 21 2021 12:24:57 for gem5 by doxygen 1.8.17