utils/formats/bmp/writer.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_FORMATS_BMP_WRITER_H_
#define GENESIS_UTILS_FORMATS_BMP_WRITER_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2020 Lucas Czech and HITS gGmbH
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include <cstdint>
#include <iosfwd>
#include <string>
#include <vector>
 
#include "genesis/utils/io/output_target.hpp"
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class Color;
 
template<typename T>
class Matrix;
 
// =================================================================================================
//     Bmp Writer
// =================================================================================================
 
class BmpWriter
{
public:
 
    // ---------------------------------------------------------------------
    //     Typedefs and Enums
    // ---------------------------------------------------------------------
 
    struct BitmapFileheader
    {
        uint16_t bfType      = 0x4D42; // B=42 M=4D
        uint32_t bfSize;
        uint16_t bfReserved1 = 0;
        uint16_t bfReserved2 = 0;
        uint32_t bfOffBits   = 14 + 40;
    };
 
    struct BitmapInfoheader
    {
        uint32_t biSize          = 40;
        uint32_t biWidth;
        uint32_t biHeight;
        uint16_t biPlanes        = 1;
        uint16_t biBitCount      = 8;
        uint32_t biCompression   = 0;
        uint32_t biSizeImage     = 0;
        uint32_t biXPelsPerMeter = 0;
        uint32_t biYPelsPerMeter = 0;
        uint32_t biClrUsed       = 0;
        uint32_t biClrImportant  = 0;
    };
 
    struct RgbQuad
    {
        unsigned char rgbBlue;
        unsigned char rgbGreen;
        unsigned char rgbRed;
        unsigned char rgbReserved = 0;
    };
 
    struct BitmapInfo {
        BitmapInfoheader     bmiHeader;
        std::vector<RgbQuad> bmiColors;
    };
 
    // ---------------------------------------------------------------------
    //     Constructor and Rule of Five
    // ---------------------------------------------------------------------
 
    BmpWriter()  = default;
 
    ~BmpWriter() = default;
 
    BmpWriter( BmpWriter const& ) = default;
 
    BmpWriter( BmpWriter&& )      = default;
 
    BmpWriter& operator= ( BmpWriter const& ) = default;
 
    BmpWriter& operator= ( BmpWriter&& )      = default;
 
    // ---------------------------------------------------------------------
    //     Writing
    // ---------------------------------------------------------------------
 
    void write(
        Matrix<Color> const& image,
        std::shared_ptr<utils::BaseOutputTarget> target
    ) const;
 
    void write(
        Matrix<unsigned char> const& image,
        std::shared_ptr<utils::BaseOutputTarget> target
    ) const;
 
    void write(
        Matrix<unsigned char> const& image,
        std::vector<Color> const& palette,
        std::shared_ptr<utils::BaseOutputTarget> target
    ) const;
 
    // ---------------------------------------------------------------------
    //     Internal Helpers
    // ---------------------------------------------------------------------
 
private:
 
    void write_uint16_( uint16_t data, std::ostream& target ) const;
    void write_uint32_( uint32_t data, std::ostream& target ) const;
 
    void write_file_header_( BitmapFileheader const& header, std::ostream& target ) const;
    void write_info_header_( BitmapInfoheader const& header, std::ostream& target ) const;
 
    void write_info_( BitmapInfo const& info, std::ostream& target ) const;
 
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard