imgwriter.cc revision 12230:48021d6b51eb 
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#include "base/imgwriter.hh"
41#include "base/bmpwriter.hh"
42#include "base/misc.hh"
43
44#include "config/use_png.hh"
45
46#if USE_PNG
47#include "base/pngwriter.hh"
48#endif
49
50std::unique_ptr<ImgWriter>
51createImgWriter(Enums::ImageFormat type, const FrameBuffer *fb)
52{
53    switch (type) {
54      case Enums::Auto:
55        // The Auto option allows gem5 to choose automatically the
56        // writer type, and it will choose for the best fit in
57        // performance.
58        // gem5 will try PNG first, and it will fallback to BMP if not
59        // available.
60
61        /* FALLTHROUGH */
62#if USE_PNG
63      case Enums::Png:
64        return std::unique_ptr<PngWriter>(new PngWriter(fb));
65#endif
66      case Enums::Bitmap:
67        return std::unique_ptr<BmpWriter>(new BmpWriter(fb));
68      default:
69        warn("Invalid Image Type specified, defaulting to Bitmap\n");
70        return std::unique_ptr<BmpWriter>(new BmpWriter(fb));
71    }
72}
73