Referência à classe Image

Define uma imagem PPM alocada dinamicamente e fornece vários métodos para manipular e acessar os dados da imagem. Mais...

#include <Image.h>

Membros públicos
	Image ()
	Construtor padrão para a classe Image.
	Image (int w, int h)
	Construtor para inicializar uma imagem com largura e altura fornecidas.
int	GetWidth () const
	Obtém a largura da imagem.
int	GetHeight () const
	Obtém a altura da imagem.
void	AllocatePixels ()
	Alocação de memória da matriz de pixels, fundamental na definição de qualquer objeto Image.
void	LiberatePixels ()
	Libera a memória previamente alocada pela função AllocatePixels(), bem como a memória alocada pelo array dos valores 'R', 'G' e 'B' dos pixels.
void	GetPixels ()
	Função que preenche a matriz de pixels.
void	PrintPPM () const
	Função que imprime os parâmetros de uma imagem PPM. Usada para fins de teste.
bool	ExtensionCheck (const string &input_text, const string &file_type)
	Função que verifica se uma string termina com a substring válida.
string	CreatePPM () const
	Função que cria uma string contendo todos os dados de uma imagem PPM.
bool	ReadPPM (const string &file_name)
	Lê e armazena dinamicamente o conteúdo de uma imagem de um arquivo PPM válido.
void	ShowArray () const
	Função que exibe um array previamente definido de valores 'R', 'G' e 'B'. Usada para fins de teste.
string	IntToBin (int num, int bits=8)
	Função recursiva para converter um valor inteiro em um valor binário.
void	CodeMsg (string msg)
	Função principal usada na codificação e ocultação de uma mensagem ASCII nos bits menos significativos (LSB) dos pixels de uma imagem PPM.
int	BinToInt (string bin_num, int index=0)
	Função recursiva usada para converter um valor binário em um valor inteiro.
void	DecodeMsg ()
	Função principal usada para descobrir e decodificar uma mensagem ASCII oculta nos bits menos significativos (LSB) dos pixels de uma imagem PPM.

Descrição detalhada

Define uma imagem PPM alocada dinamicamente e fornece vários métodos para manipular e acessar os dados da imagem.

Documentação dos Construtores & Destrutor

Image() [1/2]

Image::Image ( )

inline

Construtor padrão para a classe Image.

            : width(0), height(0), pixel(nullptr), pixel_array(nullptr)
    {}

Image() [2/2]

Image::Image ( int w, int h )

inline

Construtor para inicializar uma imagem com largura e altura fornecidas.

< Esta variável define o tamanho do array de pixels, contando cada valor 'R', 'G' e 'B' como uma unidade separada do array.

                        : width(w), height(h)
    {
        size = (width * height) * 3; 
    }

Documentação das funções

AllocatePixels()

void Image::AllocatePixels ( )

inline

Alocação de memória da matriz de pixels, fundamental na definição de qualquer objeto Image.

    {
        pixel = new Pixel *[height];
        for (int i = 0; i < height; i++)
        {
            pixel[i] = new Pixel[width];
        }
    }

BinToInt()

int Image::BinToInt ( string bin_num, int index = 0 )

inline

Função recursiva usada para converter um valor binário em um valor inteiro.

Parâmetros

bin_num	String contendo o valor binário que será convertido em um inteiro.
index	O índice da string.

Retorna

a soma do valor atual e subsequente adquirido recursivamente.

Caso base: se o índice atingir o final da string binária.

Chamada recursiva para calcular o valor do dígito binário atual e subsequente.

    {
        if (index == bin_num.length())
        {
            return 0;
        }
 
        int value_current = (bin_num[index] - '0') * pow(2, bin_num.length() - 1 - index);
        int value_subsequent = BinToInt(bin_num, index + 1);
 
        return value_current + value_subsequent;
    }

CodeMsg()

void Image::CodeMsg ( string msg )

inline

Função principal usada na codificação e ocultação de uma mensagem ASCII nos bits menos significativos (LSB) dos pixels de uma imagem PPM.

Parâmetros

msg	Mensagem que será armazenada dentro da imagem.

‍O número de caracteres na mensagem.

‍Array que armazena os valores ASCII de cada um dos caracteres da mensagem.

Preenche o array chars[].

Armazena o valor binário do número de caracteres na mensagem.

Modificação dos primeiros 8 bits do array de valores 'R', 'G' e 'B' que armazena o tamanho da mensagem.

Modifica os bits do array de valores 'R', 'G' e 'B' que armazenarão a mensagem real.

‍Índice para cada um dos bits da mensagem.

    {
        int t = msg.size(); 
        int chars[t];       
        for (int i = 0; i < t; ++i)
        {
            chars[i] = (int)msg[i];
        }
 
        string bin = IntToBin(t);
 
        for (int i = 0; i < 8 && i < size; ++i)
        {
            if (bin[i] == '1')
            {
                if (pixel_array[i] % 2 == 0)
                {
                    pixel_array[i]++;
                }
            }
            else
            {
                if (pixel_array[i] % 2 != 0)
                {
                    pixel_array[i]++;
                }
            }
        }
 
        int bit_index = 0; 
        for (int j = 0; j < t; ++j)
        {
            bin = IntToBin(chars[j]);
            for (int i = 0; i < 8 && (bit_index + 8) < size; ++i, ++bit_index)
            {
                if (bin[i] == '1')
                {
                    if (pixel_array[bit_index + 8] % 2 == 0)
                    {
                        pixel_array[bit_index + 8]++;
                    }
                }
                else
                {
                    if (pixel_array[bit_index + 8] % 2 != 0)
                    {
                        pixel_array[bit_index + 8]++;
                        if (pixel_array[bit_index + 8] == 255)
                        {
                            pixel_array[bit_index + 8]--;
                        }
                    }
                }
            }
        }
    }

CreatePPM()

string Image::CreatePPM ( ) const

inline

Função que cria uma string contendo todos os dados de uma imagem PPM.

Retorna

todas as informações necessárias para definir uma imagem PPM.

Obtém os pixels de um array de pixels previamente definido.

    {
        stringstream img_content;
 
        img_content << "P3" << endl;
        img_content << width << " " << height << endl;
        img_content << max_color << endl;
 
        for (int i = 0; i < size; i += 3)
        {
            img_content << pixel_array[i] << " " << pixel_array[i + 1] << " " << pixel_array[i + 2] << " ";
            if ((i / 3 + 1) % width == 0)
            {
                img_content << endl;
            }
        }
        return img_content.str();
    }

DecodeMsg()

void Image::DecodeMsg ( )

inline

Função principal usada para descobrir e decodificar uma mensagem ASCII oculta nos bits menos significativos (LSB) dos pixels de uma imagem PPM.

‍String que armazena o tamanho da mensagem em binário.

Obtém (em binário) o tamanho da mensagem armazenada na imagem a partir dos primeiros 8 bits dos valores 'R', 'G' e 'B' dos pixels, previamente armazenados em um array.

Adiciona o caractere '0' a bin_size.

Adiciona o caractere '1' a bin_size.

‍String que armazena a mensagem ASCII em binário.

‍Armazena o tamanho da imagem como um valor inteiro.

Obtém (em binário) a mensagem armazenada na imagem, usando o tamanho da mensagem e usando o array de valores 'R', 'G' e 'B' dos pixels.

Adiciona o caractere '0' a bin_msg.

Adiciona o caractere '1' a bin_msg.

‍String que armazena a mensagem completamente decodificada.

Repete o processo abaixo até que todos os caracteres da mensagem tenham sido decodificados e armazenados.

‍Armazena um valor binário de um único caractere.

Obtém 8 bits (ou um único caractere) da mensagem em binário, então adiciona até que faça o mesmo com o próximo bit (se houver um próximo bit).

‍Armazena o caractere ASCII decodificado como um char.

Empurra um novo caractere decodificado na string que armazena a mensagem.

    {
        string bin_size; 
        for (int i = 0; i < 8; ++i)
        {
            if (pixel_array[i] % 2 == 0)
            {
                bin_size.push_back('0'); 
            }
            else
            {
                bin_size.push_back('1'); 
            }
        }
 
        string bin_msg;                    
        int msg_size = BinToInt(bin_size); 
        for (int i = 8; i < 8 + (msg_size * 8); ++i)
        {
            if (pixel_array[i] % 2 == 0)
            {
                bin_msg.push_back('0'); 
            }
            else
            {
                bin_msg.push_back('1'); 
            }
        }
 
        string decoded_msg; 
        for (int j = 0; j < msg_size; ++j)
        {
            string bin_char; 
            for (int i = 0; i < 8; ++i)
            {
                bin_char.push_back(bin_msg[i + (8 * j)]);
            }
 
            char single_char = BinToInt(bin_char); 
            decoded_msg.push_back(single_char);
        }
        cout << "\033[94mA mensagem escondida é: \033[0m" + decoded_msg << "\n";
    }

ExtensionCheck()

bool Image::ExtensionCheck ( const string & input_text, const string & file_type )

inline

Função que verifica se uma string termina com a substring válida.

Parâmetros

input_text	Texto inserido na função, que deve ser verificado.
file_type	A substring que você deseja verificar se existe no final de uma determinada string.

Retorna

true se a substring existir no final da string fornecida, false caso contrário.

    {
        if (input_text.length() >= file_type.length()) 
            {
            return (input_text.compare(input_text.length() - file_type.length(), file_type.length(), file_type) == 0);
            } 
        else 
            {
            return false;
            }
    }

GetHeight()

int Image::GetHeight ( ) const

inline

Obtém a altura da imagem.

    {
        return height;
    }

GetPixels()

void Image::GetPixels ( )

inline

Função que preenche a matriz de pixels.

    {
        for (int h = 0; h < height; h++)
        {
            for (int w = 0; w < width; w++)
            {
                int r, g, b;
                cin >> r >> g >> b;
                pixel[h][w].r = r;
                pixel[h][w].g = g;
                pixel[h][w].b = b;
            }
        }
    }

GetWidth()

int Image::GetWidth ( ) const

inline

Obtém a largura da imagem.

    {
        return width;
    }

IntToBin()

string Image::IntToBin ( int num, int bits = 8 )

inline

Função recursiva para converter um valor inteiro em um valor binário.

Parâmetros

num	Valor inteiro a ser convertido em valor binário.
bits	O tamanho máximo do valor binário a ser retornado.

Retorna

uma string contendo a representação binária do número recebido.

Caso base: quando não restam mais bits para converter.

Determina o bit atual em binário.

Chamada recursiva para calcular os bits remanescentes em binário.

    {
        if (bits == 0)
        {
            return "";
        }
 
        int bit_current = num % 2;
 
        string bit_subsequent = IntToBin(num / 2, bits - 1);
        
        return bit_subsequent + (bit_current == 0 ? '0' : '1');
    }

LiberatePixels()

void Image::LiberatePixels ( )

inline

Libera a memória previamente alocada pela função AllocatePixels(), bem como a memória alocada pelo array dos valores 'R', 'G' e 'B' dos pixels.

Libera a memória utilizada pelo array dos valores 'R', 'G' e 'B' dos pixels, usado nas funções CreatePPM(), ReadPPM(), ShowArray(), CodeMsg() e DecodeMsg().

    {
        if (pixel != nullptr)
        {
            for (int i = 0; i < height; i++)
            {
                delete[] pixel[i];
            }
            delete[] pixel;
            pixel = nullptr;
        }
        if (pixel_array != nullptr)
        {
            delete[] pixel_array;
            pixel_array = nullptr;
        }
    }

PrintPPM()

void Image::PrintPPM ( ) const

inline

Função que imprime os parâmetros de uma imagem PPM. Usada para fins de teste.

    {
        cout << "\033[94mDados da imagem: \033[0m\n";
        cout << "\033[33m- Comprimento: \033[0m\n"
             << width << endl;
        cout << "\033[33m- Largura: \033[0m\n"
             << height << endl;
        cout << "\033[33m- Tipo de imagem: \033[0m\n"
             << img_type << endl;
        cout << "\033[33m- Valor máximo de cor: \033[0m\n"
             << max_color << endl;
        cout << "\033[33m- Valor RGB de cada pixel:\033[0m\n";
 
        for (int h = 0; h < height; h++)
        {
            for (int w = 0; w < width; w++)
            {
                Pixel p = pixel[h][w];
                cout << (int)p.r << " ";
                cout << (int)p.g << " ";
                cout << (int)p.b << "   ";
            }
            cout << endl;
        }
        cout << endl;
    }

ReadPPM()

bool Image::ReadPPM ( const string & file_name )

inline

Lê e armazena dinamicamente o conteúdo de uma imagem de um arquivo PPM válido.

Parâmetros

file_name

O nome de um arquivo PPM armazenado previamente dentro da pasta de origem, que será lido pela função.

Retorna

true se a imagem foi lida com sucesso, false caso contrário.

Testa se o arquivo existe dentro da pasta de origem.

Testa se o arquivo é de fato um arquivo P3/PPM.

Alocação de memória do array de pixels, usado na decodificação e codificação.

Lê e armazena em um array os valores 'R', 'G' e 'B' dos pixels.

    {
        ifstream file(file_name);
        if (!file)
        {
            cerr << "\033[31mErro de leitura. O arquivo " << file_name << " não existe.\033[0m\n";
            return false;
        }
 
        string file_type;
        file >> file_type;
 
        if (file_type != "P3")
        {
            cerr << "\033[31mErro de leitura. O arquivo " << file_name << " não é uma imagem PPM no formato P3.\033[0m\n"
                 << endl;
            return false;
        }
 
        file >> width >> height >> max_color;
        size = width * height * 3;
 
        AllocatePixels();
 
        pixel_array = new int[size];
        int index = 0;
 
        for (int h = 0; h < height; h++)
        {
            for (int w = 0; w < width; w++)
            {
                int r, g, b;
                file >> r >> g >> b;
                pixel[h][w].r = r;
                pixel[h][w].g = g;
                pixel[h][w].b = b;
                pixel_array[index++] = r;
                pixel_array[index++] = g;
                pixel_array[index++] = b;
            }
        }
        file.close();
        return true;
    }

ShowArray()

void Image::ShowArray ( ) const

inline

Função que exibe um array previamente definido de valores 'R', 'G' e 'B'. Usada para fins de teste.

    {
        if (pixel_array == nullptr)
        {
            cout << "Array não inicializado." << endl;
            return;
        }
        for (int i = 0; i < size; i += 3)
        {
            cout << "Pixel [" << i / 3 << "]: R = " << pixel_array[i] << ", G = " << pixel_array[i + 1]
                 << ", B = " << pixel_array[i + 2] << endl;
        }
    }

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• D:/Usuario/OneDrive/Documentos/UFRN/ITP/esteganografia-lucas-e-malva/include/Image.h