Bitmap

Data Structures
struct	GSM_BinaryPicture
struct	GSM_Bitmap
struct	GSM_MultiBitmap

Enumerations
enum	GSM_BinaryPicture_Types {   PICTURE_BMP = 1, PICTURE_GIF, PICTURE_JPG, PICTURE_ICN,   PICTURE_PNG }
enum	GSM_Bitmap_Types {   GSM_None = 1, GSM_ColourStartupLogo_ID, GSM_StartupLogo, GSM_ColourOperatorLogo_ID,   GSM_OperatorLogo, GSM_ColourWallPaper_ID, GSM_CallerGroupLogo, GSM_DealerNote_Text,   GSM_WelcomeNote_Text, GSM_PictureImage, GSM_PictureBinary }

Functions
GSM_Error	GSM_GetBitmap (GSM_StateMachine *s, GSM_Bitmap *Bitmap)
GSM_Error	GSM_SetBitmap (GSM_StateMachine *s, GSM_Bitmap *Bitmap)
void	GSM_PrintBitmap (FILE *file, GSM_Bitmap *bitmap)
GSM_Error	GSM_SaveBitmapFile (char *FileName, GSM_MultiBitmap *bitmap)
GSM_Error	GSM_ReadBitmapFile (char *FileName, GSM_MultiBitmap *bitmap)
gboolean	GSM_IsPointBitmap (GSM_Bitmap *bmp, int x, int y)
void	GSM_SetPointBitmap (GSM_Bitmap *bmp, int x, int y)
void	GSM_ClearPointBitmap (GSM_Bitmap *bmp, int x, int y)
void	GSM_ClearBitmap (GSM_Bitmap *bmp)
GSM_Error	GSM_GetScreenshot (GSM_StateMachine *s, GSM_BinaryPicture *picture)

Detailed Description

Bitmaps manipulations.

Enumeration Type Documentation

GSM_BinaryPicture_Types

enum GSM_BinaryPicture_Types

Binary picture types.

Enumerator
PICTURE_BMP
PICTURE_GIF
PICTURE_JPG
PICTURE_ICN
PICTURE_PNG

Definition at line 30 of file gammu-bitmap.h.

             {
        PICTURE_BMP = 1,
        PICTURE_GIF,
        PICTURE_JPG,
        PICTURE_ICN,
        PICTURE_PNG
} GSM_BinaryPicture_Types;

GSM_Bitmap_Types

enum GSM_Bitmap_Types

Enum to handle all possible bitmaps, which are not saved in various filesystems.

Enumerator
GSM_None
GSM_ColourStartupLogo_ID	ID of static file in filesystem displayed during startup
GSM_StartupLogo	Static mono bitmap/ID of animated mono bitmap displayed during startup
GSM_ColourOperatorLogo_ID	ID of static file in filesystem displayed instead of operator name
GSM_OperatorLogo	Mono bitmap displayed instead of operator name
GSM_ColourWallPaper_ID	ID of static file in filesystem displayed as wallpaper
GSM_CallerGroupLogo	Mono bitmap assigned to caller group
GSM_DealerNote_Text	Text displayed during startup, which can't be removed from phone menu
GSM_WelcomeNote_Text	Text displayed during startup
GSM_PictureImage	Image defined in Smart Messaging specification
GSM_PictureBinary	Binary picture (BMP, GIF, etc.)

Definition at line 54 of file gammu-bitmap.h.

             {
        GSM_None = 1,
        GSM_ColourStartupLogo_ID,
        GSM_StartupLogo,
        GSM_ColourOperatorLogo_ID,
        GSM_OperatorLogo,
        GSM_ColourWallPaper_ID,
        GSM_CallerGroupLogo,
        GSM_DealerNote_Text,
        GSM_WelcomeNote_Text,
        GSM_PictureImage,
        GSM_PictureBinary
} GSM_Bitmap_Types;

Function Documentation

GSM_ClearBitmap()

void GSM_ClearBitmap

(

GSM_Bitmap *

bmp

)

Clears bitmap.

Parameters

bmp

Bitmap

Definition at line 247 of file gsmlogo.c.

References GSM_Bitmap::BitmapPoints, and GSM_GetBitmapSize().

Referenced by BMP2Bitmap(), GSM_EncodeEMSMultiPartSMS(), GSM_ResizeBitmap(), loadnlm(), loadnolngg(), and PHONE_DecodeBitmap().

{
        memset(bmp->BitmapPoints,0,GSM_GetBitmapSize(bmp));
}

GSM_ClearPointBitmap()

void GSM_ClearPointBitmap	(	GSM_Bitmap *	bmp,
		int	x,
		int	y
	)

Clears point in bitmap.

Parameters

bmp	Bitmap
x	Horizontal coordinate.
y	Vertical coordinate.

Definition at line 233 of file gsmlogo.c.

References GSM_Bitmap::BitmapPoints, GSM_Bitmap::BitmapWidth, and ClearBit().

Referenced by GSM_DecodeEMSMultiPartSMS(), and GSM_ReverseBitmap().

{
        ClearBit(bmp->BitmapPoints,y*bmp->BitmapWidth+x);
}

GSM_GetBitmap()

GSM_Error GSM_GetBitmap	(	GSM_StateMachine *	s,
		GSM_Bitmap *	Bitmap
	)

Gets bitmap from phone.

Gets bitmap.

Definition at line 1288 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetBitmap, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetBitmap(s, Bitmap);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetScreenshot()

GSM_Error GSM_GetScreenshot	(	GSM_StateMachine *	s,
		GSM_BinaryPicture *	picture
	)

Gets phone screenshot.

Parameters

s	State machine pointer.
picture	Structure which will hold data.

Gets phone screenshot

Definition at line 1870 of file api.c.

References GSM_BinaryPicture::Buffer, CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetScreenshot, GSM_BinaryPicture::Length, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and GSM_BinaryPicture::Type.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        picture->Length = 0;
        picture->Buffer = NULL;
        picture->Type = 0;

        err = s->Phone.Functions->GetScreenshot(s, picture);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_IsPointBitmap()

gboolean GSM_IsPointBitmap	(	GSM_Bitmap *	bmp,
		int	x,
		int	y
	)

Checks whether point is set in bitmap.

Parameters

bmp	Bitmap
x	Horizontal coordinate.
y	Vertical coordinate.

Returns

True if point is set.

Definition at line 238 of file gsmlogo.c.

References GSM_Bitmap::BitmapPoints, GSM_Bitmap::BitmapWidth, FALSE, GetBit(), and TRUE.

Referenced by Bitmap2BMP(), GSM_DecodeEMSMultiPartSMS(), GSM_EncodeEMSMultiPartSMS(), GSM_PrintBitmap(), GSM_ResizeBitmap(), GSM_ReverseBitmap(), PHONE_EncodeBitmap(), PrivSaveNGGNOL(), PrivSaveNLMWBMP(), and savexpm().

{
        if (GetBit(bmp->BitmapPoints, (y * bmp->BitmapWidth) + x)) {
                return TRUE;
        } else {
                return FALSE;
        }
}

GSM_PrintBitmap()

void GSM_PrintBitmap	(	FILE *	file,
		GSM_Bitmap *	bitmap
	)

Prints bitmap to file descriptor.

Parameters

file	Where to print.
bitmap	Bitmap to print.

Definition at line 257 of file gsmlogo.c.

References GSM_Bitmap::BitmapHeight, GSM_Bitmap::BitmapWidth, and GSM_IsPointBitmap().

Referenced by GSM_DecodeMultiPartSMS(), GSM_DecodeNokiaProfile(), and GSM_EncodeEMSMultiPartSMS().

{
        size_t x,y;

        for (y=0;y<bitmap->BitmapHeight;y++) {
                for (x=0;x<bitmap->BitmapWidth;x++) {
                        if (GSM_IsPointBitmap(bitmap,x,y)) {
                                fprintf(file,"#");
                        } else {
                                fprintf(file," ");
                        }
                }
                fprintf(file,"\n");
        }
}

GSM_ReadBitmapFile()

GSM_Error GSM_ReadBitmapFile	(	char *	FileName,
		GSM_MultiBitmap *	bitmap
	)

Reads bitmap from file.

Parameters

FileName	Where to load from.
bitmap	Pointer where to load bitmap.

Returns

Error code

Definition at line 1073 of file gsmlogo.c.

References GSM_MultiBitmap::Bitmap, GSM_Bitmap::DefaultBitmap, EncodeUnicode(), ERR_CANTOPENFILE, ERR_FILENOTSUPPORTED, ERR_MOREMEMORY, FALSE, GSM_BITMAP_TEXT_LENGTH, loadbmp(), loadgif(), loadnlm(), loadnolngg(), loadnsl(), loadwbmp(), GSM_Bitmap::Name, and TRUE.

{
        FILE            *file;
        unsigned char   buffer[300];
        GSM_Error       error = ERR_FILENOTSUPPORTED;
        char    *file_only_name;
        size_t len;

        file = fopen(FileName, "rb");
        if (file == NULL) return ERR_CANTOPENFILE;

        file_only_name = strrchr(FileName, '/');
        if (file_only_name == NULL) {
                file_only_name = strrchr(FileName, '\\');
        } else {
                file_only_name++;
        }
        if (file_only_name == NULL) {
                file_only_name = FileName;
        } else {
                file_only_name++;
        }
        len = strlen(file_only_name);
        if (len > GSM_BITMAP_TEXT_LENGTH) {
                fclose(file);
                return ERR_MOREMEMORY;
        }

        EncodeUnicode(bitmap->Bitmap[0].Name, file_only_name, len);

        /* Read the header of the file. */
        if (fread(buffer, 1, 9, file) != 9) {
                fclose(file);
                return ERR_FILENOTSUPPORTED;
        }
        rewind(file);

        bitmap->Bitmap[0].DefaultBitmap = FALSE;

        /* Attempt to identify filetype */
        if (memcmp(buffer, "BM",2)==0) {
                error = loadbmp(file,bitmap);
        } else if (buffer[0] == 0x00 && buffer[1] == 0x00) {
                error = loadwbmp(file,bitmap);
        } else if (memcmp(buffer, "NLM",3)==0) {
                error = loadnlm(file,bitmap);
        } else if (memcmp(buffer, "NOL",3)==0) {
                error = loadnolngg(file,bitmap,TRUE);
        } else if (memcmp(buffer, "NGG",3)==0) {
                error = loadnolngg(file,bitmap,FALSE);
        } else if (memcmp(buffer, "FORM",4)==0) {
                error = loadnsl(file,bitmap);
        } else if (memcmp(buffer, "GIF",3)==0) {
                error = loadgif(file,bitmap);
        }
        fclose(file);
        return error;
}

GSM_SaveBitmapFile()

GSM_Error GSM_SaveBitmapFile	(	char *	FileName,
		GSM_MultiBitmap *	bitmap
	)

Saves bitmap to file.

Parameters

FileName	Where to save.
bitmap	Bitmap to save.

Returns

Error code

Definition at line 676 of file gsmlogo.c.

References ERR_CANTOPENFILE, ERR_NONE, savebmp(), savengg(), savenlm(), savenol(), savensl(), savewbmp(), and savexpm().

{
        FILE            *file;
        GSM_Error       error=ERR_NONE;

        file = fopen(FileName, "wb");
        if (file == NULL) return ERR_CANTOPENFILE;

        /* Attempt to identify filetype */
        if (strcasestr(FileName,".nlm")) {
                error=savenlm(file,bitmap);
        } else if (strcasestr(FileName,".ngg")) {
                error=savengg(file,bitmap);
        } else if (strcasestr(FileName,".nol")) {
                error=savenol(file,bitmap);
        } else if (strcasestr(FileName,".xpm")) {
                error=savexpm(file,bitmap);
        } else if (strcasestr(FileName,".nsl")) {
                error=savensl(file,bitmap);
        } else if (strcasestr(FileName,".wbmp")) {
                error=savewbmp(file,bitmap);
        } else {
                error=savebmp(file,bitmap);
        }
        fclose(file);

        return error;
}

GSM_SetBitmap()

GSM_Error GSM_SetBitmap	(	GSM_StateMachine *	s,
		GSM_Bitmap *	Bitmap
	)

Sets bitmap in phone.

Sets bitmap.

Definition at line 1301 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and GSM_Phone_Functions::SetBitmap.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->SetBitmap(s, Bitmap);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_SetPointBitmap()

void GSM_SetPointBitmap	(	GSM_Bitmap *	bmp,
		int	x,
		int	y
	)

Sets point in bitmap.

Parameters

bmp	Bitmap
x	Horizontal coordinate.
y	Vertical coordinate.

Definition at line 228 of file gsmlogo.c.

References GSM_Bitmap::BitmapPoints, GSM_Bitmap::BitmapWidth, and SetBit().

Referenced by BMP2Bitmap(), GSM_DecodeEMSMultiPartSMS(), GSM_EncodeEMSMultiPartSMS(), GSM_ResizeBitmap(), GSM_ReverseBitmap(), loadnlm(), loadnolngg(), and PHONE_DecodeBitmap().

{
        SetBit(bmp->BitmapPoints,y*bmp->BitmapWidth+x);
}