include/gammu-bitmap.h

   1 /**
   2  * \file gammu-bitmap.h
   3  * \author Michal Čihař
   4  *
   5  * Bitmap data and functions.
   6  */
   7 #ifndef __gammu_bitmap_h
   8 #define __gammu_bitmap_h
   9
  10 /**
  11  * \defgroup Bitmap Bitmap
  12  * Bitmaps manipulations.
  13  */
  14
  15 #include <gammu-limits.h>
  16 #include <gammu-types.h>
  17 #include <gammu-error.h>
  18 #include <gammu-statemachine.h>
  19 #include <stdio.h>
  20
  21 /**
  22  * Binary picture types.
  23  *
  24  * \ingroup Bitmap
  25  */
  26 typedef enum {
  27         PICTURE_BMP = 1,
  28         PICTURE_GIF,
  29         PICTURE_JPG,
  30         PICTURE_ICN,
  31         PICTURE_PNG
  32 } GSM_BinaryPicture_Types;
  33
  34 /**
  35  * Binary picture data.
  36  *
  37  * \ingroup Bitmap
  38  */
  39 typedef struct {
  40         GSM_BinaryPicture_Types Type;
  41         unsigned char *Buffer;
  42         size_t Length;
  43 } GSM_BinaryPicture;
  44
  45 /**
  46  * Enum to handle all possible bitmaps, which are not saved in various filesystems.
  47  *
  48  * \ingroup Bitmap
  49  */
  50 typedef enum {
  51         GSM_None = 1,
  52         /**
  53          * ID of static file in filesystem displayed during startup
  54          */
  55         GSM_ColourStartupLogo_ID,
  56         /**
  57          * Static mono bitmap/ID of animated mono bitmap displayed during startup
  58          */
  59         GSM_StartupLogo,
  60         /**
  61          * ID of static file in filesystem displayed instead of operator name
  62          */
  63         GSM_ColourOperatorLogo_ID,
  64         /**
  65          * Mono bitmap displayed instead of operator name
  66          */
  67         GSM_OperatorLogo,
  68         /**
  69          * ID of static file in filesystem displayed as wallpaper
  70          */
  71         GSM_ColourWallPaper_ID,
  72         /**
  73          * Mono bitmap assigned to caller group
  74          */
  75         GSM_CallerGroupLogo,
  76         /**
  77          * Text displayed during startup, which can't be removed from phone menu
  78          */
  79         GSM_DealerNote_Text,
  80         /**
  81          * Text displayed during startup
  82          */
  83         GSM_WelcomeNote_Text,
  84         /**
  85          * Image defined in Smart Messaging specification
  86          */
  87         GSM_PictureImage,
  88         /**
  89          * Binary picture (BMP, GIF, etc.)
  90          */
  91         GSM_PictureBinary
  92 } GSM_Bitmap_Types;
  93
  94 /**
  95  * Structure for all possible bitmaps, which are not saved in various filesystems
  96  *
  97  * \ingroup Bitmap
  98  */
  99 typedef struct {
 100         /**
 101          * For all: bitmap type
 102          */
 103         GSM_Bitmap_Types Type;
 104         /**
 105          * For caller group logos: number of group
 106          * For startup logos: number of animated bitmap
 107          */
 108         unsigned char Location;
 109         /**
 110          * For dealer/welcome note text: text
 111          * For caller group logo: name of group
 112          * For picture images: text assigned to it
 113          */
 114         unsigned char Text[2 * (GSM_BITMAP_TEXT_LENGTH + 1)];
 115         /**
 116          * For caller group logo: TRUE, when logo is enabled in group
 117          */
 118         gboolean BitmapEnabled;
 119         /**
 120          * For caller group logo: TRUE, when group has default name
 121          */
 122         gboolean DefaultName;
 123         /**
 124          * For caller group logo: TRUE, when group has default bitmap
 125          */
 126         gboolean DefaultBitmap;
 127         /**
 128          * For caller group logo: TRUE, when group has default ringtone
 129          */
 130         gboolean DefaultRingtone;
 131         /**
 132          * For caller group logo: ringtone ID. Phone model specific
 133          */
 134         unsigned char RingtoneID;
 135         gboolean FileSystemRingtone;
 136         /**
 137          * For caller group logo: picture ID. Phone model specific
 138          */
 139         int PictureID;
 140         gboolean FileSystemPicture;
 141         /**
 142          * For mono bitmaps: body of bitmap
 143          */
 144         unsigned char BitmapPoints[GSM_BITMAP_SIZE];
 145         /**
 146          * For mono bitmaps: height specified in pixels
 147          */
 148         size_t BitmapHeight;
 149         /**
 150          * For mono bitmaps: width specified in pixels
 151          */
 152         size_t BitmapWidth;
 153         /**
 154          * For operator logos: Network operator code
 155          */
 156         char NetworkCode[7];
 157         /**
 158          * For picture images: number of sender
 159          */
 160         unsigned char Sender[2 * (GSM_MAX_NUMBER_LENGTH + 1)];
 161         /**
 162          * For colour bitmaps: ID
 163          */
 164         unsigned char ID;
 165         /**
 166          * For binary pictures (GIF, BMP, etc.): frame and length
 167          */
 168         GSM_BinaryPicture BinaryPic;
 169         /**
 170          * Bitmap name
 171          */
 172         unsigned char Name[2 * (GSM_BITMAP_TEXT_LENGTH + 1)];
 173 } GSM_Bitmap;
 174
 175 /**
 176  * Structure to handle more than one bitmap
 177  *
 178  * \ingroup Bitmap
 179  */
 180 typedef struct {
 181         /**
 182          * Number of bitmaps
 183          */
 184         unsigned char Number;
 185         /**
 186          * All bitmaps
 187          */
 188         GSM_Bitmap Bitmap[GSM_MAX_MULTI_BITMAP];
 189 } GSM_MultiBitmap;
 190
 191 /**
 192  * Gets bitmap from phone.
 193  *
 194  * \ingroup Bitmap
 195  */
 196 GSM_Error GSM_GetBitmap(GSM_StateMachine * s, GSM_Bitmap * Bitmap);
 197
 198 /**
 199  * Sets bitmap in phone.
 200  *
 201  * \ingroup Bitmap
 202  */
 203 GSM_Error GSM_SetBitmap(GSM_StateMachine * s, GSM_Bitmap * Bitmap);
 204
 205 /**
 206  * Prints bitmap to file descriptor.
 207  *
 208  * \param file Where to print.
 209  * \param bitmap Bitmap to print.
 210  *
 211  * \ingroup Bitmap
 212  */
 213 void GSM_PrintBitmap(FILE * file, GSM_Bitmap * bitmap);
 214
 215 /**
 216  * Saves bitmap to file.
 217  *
 218  * \param FileName Where to save.
 219  * \param bitmap Bitmap to save.
 220  *
 221  * \return Error code
 222  *
 223  * \ingroup Bitmap
 224  */
 225 GSM_Error GSM_SaveBitmapFile(char *FileName, GSM_MultiBitmap * bitmap);
 226
 227 /**
 228  * Reads bitmap from file.
 229  *
 230  * \param FileName Where to load from.
 231  * \param bitmap Pointer where to load bitmap.
 232  *
 233  * \return Error code
 234  *
 235  * \ingroup Bitmap
 236  */
 237 GSM_Error GSM_ReadBitmapFile(char *FileName, GSM_MultiBitmap * bitmap);
 238
 239 /**
 240  * Checks whether point is set in bitmap.
 241  *
 242  * \param bmp Bitmap
 243  * \param x Horizontal coordinate.
 244  * \param y Vertical coordinate.
 245  * \return True if point is set.
 246  *
 247  * \ingroup Bitmap
 248  */
 249 gboolean GSM_IsPointBitmap(GSM_Bitmap * bmp, int x, int y);
 250
 251 /**
 252  * Sets point in bitmap.
 253  *
 254  * \param bmp Bitmap
 255  * \param x Horizontal coordinate.
 256  * \param y Vertical coordinate.
 257  *
 258  * \ingroup Bitmap
 259  */
 260 void GSM_SetPointBitmap(GSM_Bitmap * bmp, int x, int y);
 261
 262 /**
 263  * Clears point in bitmap.
 264  *
 265  * \param bmp Bitmap
 266  * \param x Horizontal coordinate.
 267  * \param y Vertical coordinate.
 268  *
 269  * \ingroup Bitmap
 270  */
 271 void GSM_ClearPointBitmap(GSM_Bitmap * bmp, int x, int y);
 272
 273 /**
 274  * Clears bitmap.
 275  *
 276  * \param bmp Bitmap
 277  *
 278  * \ingroup Bitmap
 279  */
 280 void GSM_ClearBitmap(GSM_Bitmap * bmp);
 281
 282 /**
 283  * Gets phone screenshot.
 284  *
 285  * \param s State machine pointer.
 286  * \param picture Structure which will hold data.
 287  *
 288  * \ingroup Bitmap
 289  */
 290 GSM_Error GSM_GetScreenshot(GSM_StateMachine *s, GSM_BinaryPicture *picture);
 291
 292 #endif
 293
 294 /* Editor configuration
 295  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 296  */