Class which manipulate png image. More...

#include <PImagePng.h>

Public Types
enum	ColorType { RGB = PNG_COLOR_TYPE_RGB , RGBA = PNG_COLOR_TYPE_RGB_ALPHA }

Public Member Functions
void	clear ()
	Clear the image and buffer.

bool	createImage (size_t width, size_t height, PImagePng::ColorType colorType=PImagePng::RGB)
	Create an image.

void	fill (color_t red, color_t green, color_t blue, color_t alpha=255)
	Fill the image with the given color.

void	getColor (size_t idxWidth, size_t idxHeight, color_t &red, color_t &green, color_t &blue) const
	Get the color of the pixel at (idxWidth, idxHeight)

void	getColor (size_t idxWidth, size_t idxHeight, color_t &red, color_t &green, color_t &blue, color_t &alpha) const
	Get the color of the pixel at (idxWidth, idxHeight)

png_byte *	getData ()
	Get the buffer data of the current PImagePng.

const png_byte *	getData () const
	Get the buffer data of the current PImagePng.

unsigned int	getHeight () const
	Get the height of the image.

NbColorByte	getNbBytePerPixel () const
	Get the number of bytes per pixel.

unsigned int	getWidth () const
	Get the width of the image.

PImagePng &	operator= (const PImagePng &other)
	Definition of equal operator of PImagePng.

	PImagePng ()
	Default constructor of PImagePng.

	PImagePng (const PImagePng &other)
	Copy constructor of PImagePng.

bool	read (const PPath &fileName)
	Read the given png image.

template<typename T>
void	setColor (const T *matValue, size_t nbRow, size_t nbCol, const PColorMap &colorMap)
	Set the color of the image by respect to a given matrix of values and the colorMap.

void	setColor (size_t idxWidth, size_t idxHeight, color_t red, color_t green, color_t blue)
	Set the color of the pixel at (idxWidth, idxHeight)

void	setColor (size_t idxWidth, size_t idxHeight, color_t red, color_t green, color_t blue, color_t alpha)
	Set the color of the pixel at (idxWidth, idxHeight)

bool	write (const PPath &fileName)
	Write a png file.

virtual	~PImagePng ()
	Destructor of PImagePng.

Protected Member Functions
void	copyPImagePng (const PImagePng &other)
	Copy function of PImagePng.

Private Member Functions
void	initialisationPImagePng ()
	Initialisation function of the class PImagePng.

Private Attributes
png_byte *	p_buffer
	Buffer use to store the image data.

PImagePng::ColorType	p_colorType
	Type of the color of the current image.

png_image	p_image
	Png image.

NbColorByte	p_nbBytePerPixel
	Number of bytes per pixel (3 for RGB, 4 for RGBA)

Detailed Description

Class which manipulate png image.

Definition at line 19 of file PImagePng.h.

Member Enumeration Documentation

◆ ColorType

enum PImagePng::ColorType

Enumerator
RGB
RGBA

Definition at line 21 of file PImagePng.h.

                              {
                        RGB = PNG_COLOR_TYPE_RGB,
                        RGBA = PNG_COLOR_TYPE_RGB_ALPHA
                };

Constructor & Destructor Documentation

◆ PImagePng() [1/2]

PImagePng::PImagePng ( )

Default constructor of PImagePng.

Definition at line 12 of file PImagePng.cpp.

                    {
        initialisationPImagePng();
}

References initialisationPImagePng().

Referenced by copyPImagePng(), operator=(), and PImagePng().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PImagePng() [2/2]

PImagePng::PImagePng ( const PImagePng & other )

Copy constructor of PImagePng.

Parameters

other : class to copy

Definition at line 19 of file PImagePng.cpp.

                                           {
        initialisationPImagePng();
        copyPImagePng(other);
}

References copyPImagePng(), initialisationPImagePng(), and PImagePng().

Here is the call graph for this function:

◆ ~PImagePng()

PImagePng::~PImagePng ( )

virtual

Destructor of PImagePng.

Definition at line 25 of file PImagePng.cpp.

                     {
        clear();
}

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void PImagePng::clear ( )

Clear the image and buffer.

Definition at line 122 of file PImagePng.cpp.

                     {
        if(p_buffer == NULL){
                png_image_free(&p_image);
        }else{
                free(p_buffer);
        }
}

References p_buffer, and p_image.

Referenced by ~PImagePng().

Here is the caller graph for this function:

◆ copyPImagePng()

void PImagePng::copyPImagePng ( const PImagePng & other )

protected

Copy function of PImagePng.

Parameters

other : class to copy

Definition at line 232 of file PImagePng.cpp.

                                                    {
        createImage(other.getWidth(), other.getHeight(), other.p_colorType);
        memcpy(p_buffer, other.p_buffer, sizeof(char)*other.getWidth()*other.getHeight()*p_nbBytePerPixel);
}

References createImage(), getHeight(), getWidth(), p_buffer, p_colorType, p_nbBytePerPixel, and PImagePng().

Referenced by operator=(), and PImagePng().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createImage()

bool PImagePng::createImage	(	size_t	width,
		size_t	height,
		PImagePng::ColorType	colorType = PImagePng::RGB )

Create an image.

Parameters

width	: width of the image
height	: height of the image
colorType	: color type of the image (ex RGB)

Returns: true on success, false otherwise

Definition at line 44 of file PImagePng.cpp.

                                                                                    {
        p_image.width = width;
        p_image.height = height;
        p_colorType = colorType;
        if(colorType == PImagePng::RGB){
                p_image.format = PNG_FORMAT_RGB;
                p_nbBytePerPixel = 3;
        }else if(colorType == PImagePng::RGBA){
                p_image.format = PNG_FORMAT_RGBA;
                p_nbBytePerPixel = 4;
        }
        if(p_buffer != NULL){
                free(p_buffer);
        }
        p_buffer = (png_byte*)malloc(PNG_IMAGE_SIZE(p_image));
        
//      png_structp pngStruct = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
//      if(pngStruct == NULL){return false;}
//      png_infop infoPtr = png_create_info_struct(pngStruct);
//      if(infoPtr == NULL){return false;}
//      png_set_IHDR(pngStruct, infoPtr, width, height,
//              8, PNG_COLOR_TYPE_RGB, PNG_INTERLACE_NONE,
//              PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
        return true;
}

References p_buffer, p_colorType, p_image, p_nbBytePerPixel, RGB, and RGBA.

Referenced by copyPImagePng().

Here is the caller graph for this function:

◆ fill()

void PImagePng::fill	(	color_t	red,
		color_t	green,
		color_t	blue,
		color_t	alpha = 255 )

Fill the image with the given color.

Parameters

red	: red proportion
green	: green proportion
blue	: blue proportion
alpha	: transparence proportion

Definition at line 136 of file PImagePng.cpp.

                                                                           {
        for(png_uint_32 j(0u); j < p_image.height; ++j){
                for(png_uint_32 i(0u); i < p_image.width; ++i){
                        setColor(i, j, red, green, blue);
                }
        }
}

References p_image, and setColor().

Here is the call graph for this function:

◆ getColor() [1/2]

void PImagePng::getColor	(	size_t	idxWidth,
		size_t	idxHeight,
		color_t &	red,
		color_t &	green,
		color_t &	blue ) const

Get the color of the pixel at (idxWidth, idxHeight)

Parameters

	idxWidth	: index of the pixel on the image width
	idxHeight	: index of the pixel on the image height
[out]	red	: red proportion
[out]	green	: green proportion
[out]	blue	: blue proportion

Definition at line 181 of file PImagePng.cpp.

                                                                                                               {
        color_t alpha(255);
        getColor(idxWidth, idxHeight, red, green , blue, alpha);
}

References getColor().

Referenced by getColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColor() [2/2]

void PImagePng::getColor	(	size_t	idxWidth,
		size_t	idxHeight,
		color_t &	red,
		color_t &	green,
		color_t &	blue,
		color_t &	alpha ) const

Get the color of the pixel at (idxWidth, idxHeight)

Parameters

	idxWidth	: index of the pixel on the image width
	idxHeight	: index of the pixel on the image height
[out]	red	: red proportion
[out]	green	: green proportion
[out]	blue	: blue proportion
[out]	alpha	: alpha proportion

Definition at line 194 of file PImagePng.cpp.

                                                                                                                                {
        size_t index((idxHeight*p_image.width + idxWidth)*p_nbBytePerPixel);
        red = p_buffer[index];
        green = p_buffer[index + 1lu];
        blue = p_buffer[index + 2lu];
        if(p_nbBytePerPixel >= 4lu){
                alpha = p_buffer[index + 3lu];
        }
}

References p_buffer, p_image, and p_nbBytePerPixel.

◆ getData() [1/2]

png_byte * PImagePng::getData ( )

Get the buffer data of the current PImagePng.

Returns: buffer data of the current PImagePng

Definition at line 222 of file PImagePng.cpp.

222{return p_buffer;}

References p_buffer.

◆ getData() [2/2]

const png_byte * PImagePng::getData ( ) const

Get the buffer data of the current PImagePng.

Returns: buffer data of the current PImagePng

Definition at line 217 of file PImagePng.cpp.

217{return p_buffer;}

References p_buffer.

◆ getHeight()

unsigned int PImagePng::getHeight ( ) const

Get the height of the image.

Returns: height of the image

Definition at line 212 of file PImagePng.cpp.

212{return p_image.height;}

References p_image.

Referenced by copyPImagePng().

Here is the caller graph for this function:

◆ getNbBytePerPixel()

NbColorByte PImagePng::getNbBytePerPixel ( ) const

Get the number of bytes per pixel.

Returns: number of bytes per pixel

Definition at line 227 of file PImagePng.cpp.

227{return p_nbBytePerPixel;}

References p_nbBytePerPixel.

◆ getWidth()

unsigned int PImagePng::getWidth ( ) const

Get the width of the image.

Returns: width of the image

Definition at line 207 of file PImagePng.cpp.

207{return p_image.width;}

References p_image.

Referenced by copyPImagePng().

Here is the caller graph for this function:

◆ initialisationPImagePng()

void PImagePng::initialisationPImagePng ( )

private

Initialisation function of the class PImagePng.

Definition at line 238 of file PImagePng.cpp.

                                       {
        memset(&p_image, 0, (sizeof p_image));
        p_image.version = PNG_IMAGE_VERSION;     //We have to set the PNG version for this image
        
        p_buffer = NULL;
        p_nbBytePerPixel = 0;
}

References p_buffer, p_image, and p_nbBytePerPixel.

Referenced by PImagePng(), and PImagePng().

Here is the caller graph for this function:

◆ operator=()

PImagePng & PImagePng::operator= ( const PImagePng & other )

Definition of equal operator of PImagePng.

Parameters

other : class to copy

Returns: copied class

Definition at line 33 of file PImagePng.cpp.

                                                         {
        copyPImagePng(other);
        return *this;
}

References copyPImagePng(), and PImagePng().

Here is the call graph for this function:

◆ read()

bool PImagePng::read ( const PPath & fileName )

Read the given png image.

Parameters

fileName : name of the file to be read

Returns: true on success, false otherwise

Definition at line 74 of file PImagePng.cpp.

                                          {
        if(fileName == ""){return false;}
        if(!check_is_png(fileName)){
                std::cerr << "PImagePng::read : file is not a png '"<<fileName<<"'" << std::endl;
                return false;
        }
        if(png_image_begin_read_from_file(&p_image, fileName.c_str()) == 0){
                std::cerr << "PImagePng::read : cannot read png image '"<<fileName<<"'" << std::endl;
                return false;
        }
        /* Set the format in which to read the PNG file; this code chooses a
        * simple sRGB format with a non-associated alpha channel, adequate to
        * store most images.
        */
        if(p_image.format == PNG_FORMAT_RGB){
                p_nbBytePerPixel = 3;
                p_colorType = PImagePng::RGB;
        }else if(p_image.format == PNG_FORMAT_RGBA){
                p_nbBytePerPixel = 4;
                p_colorType = PImagePng::RGBA;
        }
 
        /* Now allocate enough memory to hold the image in this format; the
        * PNG_IMAGE_SIZE macro uses the information about the image (width,
        * height and format) stored in 'image'.
        */
        p_buffer = (png_byte*)malloc(PNG_IMAGE_SIZE(p_image));
        if(p_buffer != NULL &&
                png_image_finish_read(&p_image, NULL/*background*/, p_buffer, 0/*row_stride*/, NULL/*colormap*/) != 0){
                return true;
        }
        return false;
}

References check_is_png(), p_buffer, p_colorType, p_image, p_nbBytePerPixel, RGB, and RGBA.

Here is the call graph for this function:

◆ setColor() [1/3]

template<typename T>

void PImagePng::setColor	(	const T *	matValue,
		size_t	nbRow,
		size_t	nbCol,
		const PColorMap &	colorMap )

Set the color of the image by respect to a given matrix of values and the colorMap.

Parameters

matValue	: matrix of value to be used to colorize the PImagePng
nbRow	: number of rows of the matrix
nbCol	: number of columns of the matrix
colorMap	: PColorMap to be used to convert values in color

Definition at line 20 of file PImagePng_impl.h.

                                                                                                  {
        size_t nbValueRow(std::min(nbRow, (size_t)p_image.height));
        size_t nbValueCol(std::min(nbCol, (size_t)p_image.width));
        
        for(size_t i(0lu); i < nbValueRow; ++i){
                for(size_t j(0lu); j < nbValueCol; ++j){
                        float value(matValue[i*nbCol + j]);
                        color_t red(0), green(0), blue(0), alpha(0);
                        colorMap.interpolate(red, green, blue, alpha, value);
                        setColor(j, i, red, green, blue, alpha);
                }
        }
        
}

References PColorMap::interpolate(), p_image, and setColor().

Here is the call graph for this function:

◆ setColor() [2/3]

void PImagePng::setColor	(	size_t	idxWidth,
		size_t	idxHeight,
		color_t	red,
		color_t	green,
		color_t	blue )

Set the color of the pixel at (idxWidth, idxHeight)

Parameters

idxWidth	: index of the pixel on the image width
idxHeight	: index of the pixel on the image height
red	: red proportion
green	: green proportion
blue	: blue proportion

Definition at line 151 of file PImagePng.cpp.

                                                                                                   {
        color_t alpha(255);
        setColor(idxWidth, idxHeight, red, green , blue, alpha);
}

References setColor().

Referenced by fill(), setColor(), and setColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor() [3/3]

void PImagePng::setColor	(	size_t	idxWidth,
		size_t	idxHeight,
		color_t	red,
		color_t	green,
		color_t	blue,
		color_t	alpha )

Set the color of the pixel at (idxWidth, idxHeight)

Parameters

idxWidth	: index of the pixel on the image width
idxHeight	: index of the pixel on the image height
red	: red proportion
green	: green proportion
blue	: blue proportion
alpha	: alpha proportion

Definition at line 164 of file PImagePng.cpp.

                                                                                                                  {
        size_t index((idxHeight*p_image.width + idxWidth)*p_nbBytePerPixel);
        p_buffer[index] = red;
        p_buffer[index + 1lu] = green;
        p_buffer[index + 2lu] = blue;
        if(p_nbBytePerPixel >= 4lu){
                p_buffer[index + 3lu] = alpha;
        }
}

References p_buffer, p_image, and p_nbBytePerPixel.

◆ write()

bool PImagePng::write ( const PPath & fileName )

Write a png file.

Parameters

fileName : name fo the png file to be written

Returns: true on success, false otherwise

Definition at line 112 of file PImagePng.cpp.

                                           {
        if(fileName == "" || p_buffer == NULL){return false;}
        if(png_image_write_to_file(&p_image, fileName.c_str(), 0/*convert_to_8bit*/, p_buffer, 0/*row_stride*/, NULL/*colormap*/) != 0){
                /* The image has been written successfully. */
                return true;
        }
        return false;
}

References p_buffer, and p_image.

Member Data Documentation

◆ p_buffer

png_byte* PImagePng::p_buffer

private

Buffer use to store the image data.

Definition at line 65 of file PImagePng.h.

Referenced by clear(), copyPImagePng(), createImage(), getColor(), getData(), getData(), initialisationPImagePng(), read(), setColor(), and write().

◆ p_colorType

PImagePng::ColorType PImagePng::p_colorType

private

Type of the color of the current image.

Definition at line 69 of file PImagePng.h.

Referenced by copyPImagePng(), createImage(), and read().

◆ p_image

png_image PImagePng::p_image

private

Png image.

Definition at line 63 of file PImagePng.h.

Referenced by clear(), createImage(), fill(), getColor(), getHeight(), getWidth(), initialisationPImagePng(), read(), setColor(), setColor(), and write().

◆ p_nbBytePerPixel

NbColorByte PImagePng::p_nbBytePerPixel

private

Number of bytes per pixel (3 for RGB, 4 for RGBA)

Definition at line 67 of file PImagePng.h.

Referenced by copyPImagePng(), createImage(), getColor(), getNbBytePerPixel(), initialisationPImagePng(), read(), and setColor().

The documentation for this class was generated from the following files:

/builds/CTA-LAPP/PHOENIX_LIBS2/static-site-generator/PhoenixPNG/src/PImagePng.h
/builds/CTA-LAPP/PHOENIX_LIBS2/static-site-generator/PhoenixPNG/src/PImagePng.cpp
/builds/CTA-LAPP/PHOENIX_LIBS2/static-site-generator/PhoenixPNG/src/PImagePng_impl.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ColorType

Constructor & Destructor Documentation

◆ PImagePng() [1/2]

◆ PImagePng() [2/2]

◆ ~PImagePng()

Member Function Documentation

◆ clear()

◆ copyPImagePng()

◆ createImage()

◆ fill()

◆ getColor() [1/2]

◆ getColor() [2/2]

◆ getData() [1/2]

◆ getData() [2/2]

◆ getHeight()

◆ getNbBytePerPixel()

◆ getWidth()

◆ initialisationPImagePng()

◆ operator=()

◆ read()

◆ setColor() [1/3]

◆ setColor() [2/3]

◆ setColor() [3/3]

◆ write()

Member Data Documentation

◆ p_buffer

◆ p_colorType

◆ p_image

◆ p_nbBytePerPixel