src/common/image.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        image.cpp
   3 // Purpose:     wxImage
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "image.h"
  12 #endif
  13
  14 // For compilers that support precompilation, includes "wx.h".
  15 #include "wx/wxprec.h"
  16
  17 #ifdef __BORLANDC__
  18     #pragma hdrstop
  19 #endif
  20
  21 #include "wx/defs.h"
  22
  23 #if wxUSE_IMAGE
  24
  25 #include "wx/image.h"
  26 #include "wx/bitmap.h"
  27 #include "wx/debug.h"
  28 #include "wx/log.h"
  29 #include "wx/app.h"
  30 #include "wx/filefn.h"
  31 #include "wx/wfstream.h"
  32 #include "wx/intl.h"
  33 #include "wx/module.h"
  34 #include "wx/hash.h"
  35
  36 // For memcpy
  37 #include <string.h>
  38 #include <math.h>
  39
  40 #ifdef __SALFORDC__
  41     #undef FAR
  42 #endif
  43
  44
  45 //-----------------------------------------------------------------------------
  46 // wxImage
  47 //-----------------------------------------------------------------------------
  48
  49 class wxImageRefData: public wxObjectRefData
  50 {
  51 public:
  52     wxImageRefData();
  53     virtual ~wxImageRefData();
  54
  55     int             m_width;
  56     int             m_height;
  57     unsigned char  *m_data;
  58
  59     bool            m_hasMask;
  60     unsigned char   m_maskRed,m_maskGreen,m_maskBlue;
  61
  62     // alpha channel data, may be NULL for the formats without alpha support
  63     unsigned char  *m_alpha;
  64
  65     bool            m_ok;
  66     bool            m_static;
  67
  68 #if wxUSE_PALETTE
  69     wxPalette       m_palette;
  70 #endif // wxUSE_PALETTE
  71
  72     wxArrayString   m_optionNames;
  73     wxArrayString   m_optionValues;
  74
  75     DECLARE_NO_COPY_CLASS(wxImageRefData)
  76 };
  77
  78 wxImageRefData::wxImageRefData()
  79 {
  80     m_width = 0;
  81     m_height = 0;
  82     m_data =
  83     m_alpha = (unsigned char *) NULL;
  84
  85     m_maskRed = 0;
  86     m_maskGreen = 0;
  87     m_maskBlue = 0;
  88     m_hasMask = FALSE;
  89
  90     m_ok = FALSE;
  91     m_static = FALSE;
  92 }
  93
  94 wxImageRefData::~wxImageRefData()
  95 {
  96     if ( !m_static )
  97         free( m_data );
  98
  99     free(m_alpha);
 100 }
 101
 102 wxList wxImage::sm_handlers;
 103
 104 wxImage wxNullImage;
 105
 106 //-----------------------------------------------------------------------------
 107
 108 #define M_IMGDATA ((wxImageRefData *)m_refData)
 109
 110 IMPLEMENT_DYNAMIC_CLASS(wxImage, wxObject)
 111
 112 wxImage::wxImage()
 113 {
 114 }
 115
 116 wxImage::wxImage( int width, int height )
 117 {
 118     Create( width, height );
 119 }
 120
 121 wxImage::wxImage( int width, int height, unsigned char* data, bool static_data )
 122 {
 123     Create( width, height, data, static_data );
 124 }
 125
 126 wxImage::wxImage( const wxString& name, long type, int index )
 127 {
 128     LoadFile( name, type, index );
 129 }
 130
 131 wxImage::wxImage( const wxString& name, const wxString& mimetype, int index )
 132 {
 133     LoadFile( name, mimetype, index );
 134 }
 135
 136 #if wxUSE_STREAMS
 137 wxImage::wxImage( wxInputStream& stream, long type, int index )
 138 {
 139     LoadFile( stream, type, index );
 140 }
 141
 142 wxImage::wxImage( wxInputStream& stream, const wxString& mimetype, int index )
 143 {
 144     LoadFile( stream, mimetype, index );
 145 }
 146 #endif // wxUSE_STREAMS
 147
 148 wxImage::wxImage( const wxImage& image )
 149     : wxObject()
 150 {
 151     Ref(image);
 152 }
 153
 154 wxImage::wxImage( const wxImage* image )
 155 {
 156     if (image) Ref(*image);
 157 }
 158
 159 void wxImage::Create( int width, int height )
 160 {
 161     UnRef();
 162
 163     m_refData = new wxImageRefData();
 164
 165     M_IMGDATA->m_data = (unsigned char *) malloc( width*height*3 );
 166     if (M_IMGDATA->m_data)
 167     {
 168         for (int l = 0; l < width*height*3; l++) M_IMGDATA->m_data[l] = 0;
 169
 170         M_IMGDATA->m_width = width;
 171         M_IMGDATA->m_height = height;
 172         M_IMGDATA->m_ok = TRUE;
 173     }
 174     else
 175     {
 176         UnRef();
 177     }
 178 }
 179
 180 void wxImage::Create( int width, int height, unsigned char* data, bool static_data )
 181 {
 182     UnRef();
 183
 184     m_refData = new wxImageRefData();
 185
 186     M_IMGDATA->m_data = data;
 187     if (M_IMGDATA->m_data)
 188     {
 189         M_IMGDATA->m_width = width;
 190         M_IMGDATA->m_height = height;
 191         M_IMGDATA->m_ok = TRUE;
 192         M_IMGDATA->m_static = static_data;
 193     }
 194     else
 195     {
 196         UnRef();
 197     }
 198 }
 199
 200 void wxImage::Destroy()
 201 {
 202     UnRef();
 203 }
 204
 205 wxImage wxImage::Copy() const
 206 {
 207     wxImage image;
 208
 209     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 210
 211     image.Create( M_IMGDATA->m_width, M_IMGDATA->m_height );
 212
 213     unsigned char *data = image.GetData();
 214
 215     wxCHECK_MSG( data, image, wxT("unable to create image") );
 216
 217     image.SetMaskColour( M_IMGDATA->m_maskRed, M_IMGDATA->m_maskGreen, M_IMGDATA->m_maskBlue );
 218     image.SetMask( M_IMGDATA->m_hasMask );
 219
 220     memcpy( data, GetData(), M_IMGDATA->m_width*M_IMGDATA->m_height*3 );
 221
 222     return image;
 223 }
 224
 225 wxImage wxImage::ShrinkBy( int xFactor , int yFactor ) const
 226 {
 227     if( xFactor == 1 && yFactor == 1 )
 228         return Copy() ;
 229
 230     wxImage image;
 231
 232     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 233
 234     // can't scale to/from 0 size
 235     wxCHECK_MSG( (xFactor > 0) && (yFactor > 0), image,
 236                  wxT("invalid new image size") );
 237
 238     long old_height = M_IMGDATA->m_height,
 239          old_width  = M_IMGDATA->m_width;
 240
 241     wxCHECK_MSG( (old_height > 0) && (old_width > 0), image,
 242                  wxT("invalid old image size") );
 243
 244     long width = old_width / xFactor ;
 245     long height = old_height / yFactor ;
 246
 247     image.Create( width , height );
 248
 249     char unsigned *data = image.GetData();
 250
 251     wxCHECK_MSG( data, image, wxT("unable to create image") );
 252
 253     bool hasMask = false ;
 254     unsigned char maskRed = 0;
 255     unsigned char maskGreen = 0;
 256     unsigned char maskBlue =0 ;
 257     if (M_IMGDATA->m_hasMask)
 258     {
 259         hasMask = true ;
 260         maskRed = M_IMGDATA->m_maskRed;
 261         maskGreen = M_IMGDATA->m_maskGreen;
 262         maskBlue =M_IMGDATA->m_maskBlue ;
 263
 264         image.SetMaskColour( M_IMGDATA->m_maskRed,
 265                              M_IMGDATA->m_maskGreen,
 266                              M_IMGDATA->m_maskBlue );
 267     }
 268     char unsigned *source_data = M_IMGDATA->m_data;
 269     char unsigned *target_data = data;
 270
 271     for (long y = 0; y < height; y++)
 272     {
 273         for (long x = 0; x < width; x++)
 274         {
 275             unsigned long avgRed = 0 ;
 276             unsigned long avgGreen = 0;
 277             unsigned long avgBlue = 0;
 278             unsigned long counter = 0 ;
 279             // determine average
 280             for ( int y1 = 0 ; y1 < yFactor ; ++y1 )
 281             {
 282                 long y_offset = (y * yFactor + y1) * old_width;
 283                 for ( int x1 = 0 ; x1 < xFactor ; ++x1 )
 284                 {
 285                     unsigned char *pixel = source_data + 3 * ( y_offset + x * xFactor + x1 ) ;
 286                     unsigned char red = pixel[0] ;
 287                     unsigned char green = pixel[1] ;
 288                     unsigned char blue = pixel[2] ;
 289                     if ( !hasMask || red != maskRed || green != maskGreen || blue != maskBlue )
 290                     {
 291                         avgRed += red ;
 292                         avgGreen += green ;
 293                         avgBlue += blue ;
 294                         counter++ ;
 295                     }
 296                 }
 297             }
 298             if ( counter == 0 )
 299             {
 300                 *(target_data++) = M_IMGDATA->m_maskRed ;
 301                 *(target_data++) = M_IMGDATA->m_maskGreen ;
 302                 *(target_data++) = M_IMGDATA->m_maskBlue ;
 303             }
 304             else
 305             {
 306                 *(target_data++) = avgRed / counter ;
 307                 *(target_data++) = avgGreen / counter ;
 308                 *(target_data++) = avgBlue / counter ;
 309             }
 310         }
 311     }
 312
 313     // In case this is a cursor, make sure the hotspot is scalled accordingly:
 314     if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X) )
 315         image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X,
 316                 (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X))/xFactor);
 317     if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y) )
 318         image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y,
 319                 (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y))/yFactor);
 320
 321     return image;
 322 }
 323
 324 wxImage wxImage::Scale( int width, int height ) const
 325 {
 326     wxImage image;
 327
 328     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 329
 330     // can't scale to/from 0 size
 331     wxCHECK_MSG( (width > 0) && (height > 0), image,
 332                  wxT("invalid new image size") );
 333
 334     long old_height = M_IMGDATA->m_height,
 335          old_width  = M_IMGDATA->m_width;
 336     wxCHECK_MSG( (old_height > 0) && (old_width > 0), image,
 337                  wxT("invalid old image size") );
 338
 339     if ( old_width % width == 0 && old_width >= width &&
 340         old_height % height == 0 && old_height >= height )
 341     {
 342         return ShrinkBy( old_width / width , old_height / height ) ;
 343     }
 344     image.Create( width, height );
 345
 346     unsigned char *data = image.GetData();
 347
 348     wxCHECK_MSG( data, image, wxT("unable to create image") );
 349
 350     if (M_IMGDATA->m_hasMask)
 351     {
 352         image.SetMaskColour( M_IMGDATA->m_maskRed,
 353                              M_IMGDATA->m_maskGreen,
 354                              M_IMGDATA->m_maskBlue );
 355     }
 356
 357     unsigned char *source_data = M_IMGDATA->m_data;
 358     unsigned char *target_data = data;
 359
 360 #if 0
 361     // This is nonsense, RR.
 362
 363     // We do (x, y) -> (x, y)*oldSize/newSize but the valid values of x and y
 364     // are from 0 to size-1, hence all decrement the sizes
 365     long old_old_width = old_width;
 366     old_height--;
 367     old_width--;
 368     height--;
 369     width--;
 370     for ( long j = 0; j <= height; j++ )
 371     {
 372         // don't crash for images with height == 1
 373         long y_offset = height ? (j * old_height / height)* old_old_width : 0;
 374
 375         for ( long i = 0; i <= width; i++ )
 376         {
 377             long x_offset = width ? (i * old_width) / width : 0;
 378
 379             memcpy( target_data, source_data + 3*(y_offset + x_offset), 3 );
 380             target_data += 3;
 381         }
 382     }
 383 #else
 384     for (long j = 0; j < height; j++)
 385     {
 386         long y_offset = (j * old_height / height) * old_width;
 387
 388         for (long i = 0; i < width; i++)
 389         {
 390             memcpy( target_data,
 391                 source_data + 3*(y_offset + ((i * old_width )/ width)),
 392                 3 );
 393             target_data += 3;
 394         }
 395     }
 396 #endif
 397
 398     // In case this is a cursor, make sure the hotspot is scalled accordingly:
 399     if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X) )
 400         image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X,
 401                 (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X)*width)/old_width);
 402     if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y) )
 403         image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y,
 404                 (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y)*height)/old_height);
 405
 406     return image;
 407 }
 408
 409 wxImage wxImage::Rotate90( bool clockwise ) const
 410 {
 411     wxImage image;
 412
 413     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 414
 415     image.Create( M_IMGDATA->m_height, M_IMGDATA->m_width );
 416
 417     unsigned char *data = image.GetData();
 418
 419     wxCHECK_MSG( data, image, wxT("unable to create image") );
 420
 421     if (M_IMGDATA->m_hasMask)
 422         image.SetMaskColour( M_IMGDATA->m_maskRed, M_IMGDATA->m_maskGreen, M_IMGDATA->m_maskBlue );
 423
 424     long height = M_IMGDATA->m_height;
 425     long width  = M_IMGDATA->m_width;
 426
 427     unsigned char *source_data = M_IMGDATA->m_data;
 428     unsigned char *target_data;
 429
 430     for (long j = 0; j < height; j++)
 431     {
 432         for (long i = 0; i < width; i++)
 433         {
 434             if (clockwise)
 435                 target_data = data + (((i+1)*height) - j - 1)*3;
 436             else
 437                 target_data = data + ((height*(width-1)) + j - (i*height))*3;
 438             memcpy( target_data, source_data, 3 );
 439             source_data += 3;
 440         }
 441     }
 442
 443     return image;
 444 }
 445
 446 wxImage wxImage::Mirror( bool horizontally ) const
 447 {
 448     wxImage image;
 449
 450     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 451
 452     image.Create( M_IMGDATA->m_width, M_IMGDATA->m_height );
 453
 454     unsigned char *data = image.GetData();
 455
 456     wxCHECK_MSG( data, image, wxT("unable to create image") );
 457
 458     if (M_IMGDATA->m_hasMask)
 459         image.SetMaskColour( M_IMGDATA->m_maskRed, M_IMGDATA->m_maskGreen, M_IMGDATA->m_maskBlue );
 460
 461     long height = M_IMGDATA->m_height;
 462     long width  = M_IMGDATA->m_width;
 463
 464     unsigned char *source_data = M_IMGDATA->m_data;
 465     unsigned char *target_data;
 466
 467     if (horizontally)
 468     {
 469         for (long j = 0; j < height; j++)
 470         {
 471             data += width*3;
 472             target_data = data-3;
 473             for (long i = 0; i < width; i++)
 474             {
 475                 memcpy( target_data, source_data, 3 );
 476                 source_data += 3;
 477                 target_data -= 3;
 478             }
 479         }
 480     }
 481     else
 482     {
 483         for (long i = 0; i < height; i++)
 484         {
 485             target_data = data + 3*width*(height-1-i);
 486             memcpy( target_data, source_data, (size_t)3*width );
 487             source_data += 3*width;
 488         }
 489     }
 490
 491     return image;
 492 }
 493
 494 wxImage wxImage::GetSubImage( const wxRect &rect ) const
 495 {
 496     wxImage image;
 497
 498     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 499
 500     wxCHECK_MSG( (rect.GetLeft()>=0) && (rect.GetTop()>=0) && (rect.GetRight()<=GetWidth()) && (rect.GetBottom()<=GetHeight()),
 501                  image, wxT("invalid subimage size") );
 502
 503     int subwidth=rect.GetWidth();
 504     const int subheight=rect.GetHeight();
 505
 506     image.Create( subwidth, subheight );
 507
 508     unsigned char *subdata = image.GetData(), *data=GetData();
 509
 510     wxCHECK_MSG( subdata, image, wxT("unable to create image") );
 511
 512     if (M_IMGDATA->m_hasMask)
 513         image.SetMaskColour( M_IMGDATA->m_maskRed, M_IMGDATA->m_maskGreen, M_IMGDATA->m_maskBlue );
 514
 515     const int subleft=3*rect.GetLeft();
 516     const int width=3*GetWidth();
 517     subwidth*=3;
 518
 519     data+=rect.GetTop()*width+subleft;
 520
 521     for (long j = 0; j < subheight; ++j)
 522     {
 523         memcpy( subdata, data, subwidth);
 524         subdata+=subwidth;
 525         data+=width;
 526     }
 527
 528     return image;
 529 }
 530
 531 void wxImage::Paste( const wxImage &image, int x, int y )
 532 {
 533     wxCHECK_RET( Ok(), wxT("invalid image") );
 534     wxCHECK_RET( image.Ok(), wxT("invalid image") );
 535
 536     int xx = 0;
 537     int yy = 0;
 538     int width = image.GetWidth();
 539     int height = image.GetHeight();
 540
 541     if (x < 0)
 542     {
 543         xx = -x;
 544         width += x;
 545     }
 546     if (y < 0)
 547     {
 548         yy = -y;
 549         height += y;
 550     }
 551
 552     if ((x+xx)+width > M_IMGDATA->m_width)
 553         width = M_IMGDATA->m_width - (x+xx);
 554     if ((y+yy)+height > M_IMGDATA->m_height)
 555         height = M_IMGDATA->m_height - (y+yy);
 556
 557     if (width < 1) return;
 558     if (height < 1) return;
 559
 560     if ((!HasMask() && !image.HasMask()) ||
 561        ((HasMask() && image.HasMask() &&
 562          (GetMaskRed()==image.GetMaskRed()) &&
 563          (GetMaskGreen()==image.GetMaskGreen()) &&
 564          (GetMaskBlue()==image.GetMaskBlue()))))
 565     {
 566         width *= 3;
 567         unsigned char* source_data = image.GetData() + xx*3 + yy*3*image.GetWidth();
 568         int source_step = image.GetWidth()*3;
 569
 570         unsigned char* target_data = GetData() + (x+xx)*3 + (y+yy)*3*M_IMGDATA->m_width;
 571         int target_step = M_IMGDATA->m_width*3;
 572         for (int j = 0; j < height; j++)
 573         {
 574             memcpy( target_data, source_data, width );
 575             source_data += source_step;
 576             target_data += target_step;
 577         }
 578         return;
 579     }
 580
 581     if (!HasMask() && image.HasMask())
 582     {
 583         unsigned char r = image.GetMaskRed();
 584         unsigned char g = image.GetMaskGreen();
 585         unsigned char b = image.GetMaskBlue();
 586
 587         width *= 3;
 588         unsigned char* source_data = image.GetData() + xx*3 + yy*3*image.GetWidth();
 589         int source_step = image.GetWidth()*3;
 590
 591         unsigned char* target_data = GetData() + (x+xx)*3 + (y+yy)*3*M_IMGDATA->m_width;
 592         int target_step = M_IMGDATA->m_width*3;
 593
 594         for (int j = 0; j < height; j++)
 595         {
 596             for (int i = 0; i < width; i+=3)
 597             {
 598                 if ((source_data[i]   != r) &&
 599                     (source_data[i+1] != g) &&
 600                     (source_data[i+2] != b))
 601                 {
 602                     memcpy( target_data+i, source_data+i, 3 );
 603                 }
 604             }
 605             source_data += source_step;
 606             target_data += target_step;
 607         }
 608     }
 609 }
 610
 611 void wxImage::Replace( unsigned char r1, unsigned char g1, unsigned char b1,
 612                        unsigned char r2, unsigned char g2, unsigned char b2 )
 613 {
 614     wxCHECK_RET( Ok(), wxT("invalid image") );
 615
 616     unsigned char *data = GetData();
 617
 618     const int w = GetWidth();
 619     const int h = GetHeight();
 620
 621     for (int j = 0; j < h; j++)
 622         for (int i = 0; i < w; i++)
 623         {
 624             if ((data[0] == r1) && (data[1] == g1) && (data[2] == b1))
 625             {
 626                 data[0] = r2;
 627                 data[1] = g2;
 628                 data[2] = b2;
 629             }
 630             data += 3;
 631         }
 632 }
 633
 634 wxImage wxImage::ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const
 635 {
 636     wxImage image;
 637
 638     wxCHECK_MSG( Ok(), image, wxT("invalid image") );
 639
 640     image.Create( M_IMGDATA->m_width, M_IMGDATA->m_height );
 641
 642     unsigned char *data = image.GetData();
 643
 644     wxCHECK_MSG( data, image, wxT("unable to create image") );
 645
 646     if (M_IMGDATA->m_hasMask)
 647     {
 648         if (M_IMGDATA->m_maskRed == r && M_IMGDATA->m_maskGreen == g &&
 649                                          M_IMGDATA->m_maskBlue == b)
 650             image.SetMaskColour( 255, 255, 255 );
 651         else
 652             image.SetMaskColour( 0, 0, 0 );
 653     }
 654
 655     long size = M_IMGDATA->m_height * M_IMGDATA->m_width;
 656
 657     unsigned char *srcd = M_IMGDATA->m_data;
 658     unsigned char *tard = image.GetData();
 659
 660     for ( long i = 0; i < size; i++, srcd += 3, tard += 3 )
 661     {
 662         if (srcd[0] == r && srcd[1] == g && srcd[2] == b)
 663             tard[0] = tard[1] = tard[2] = 255;
 664         else
 665             tard[0] = tard[1] = tard[2] = 0;
 666     }
 667
 668     return image;
 669 }
 670
 671 void wxImage::SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b )
 672 {
 673     wxCHECK_RET( Ok(), wxT("invalid image") );
 674
 675     int w = M_IMGDATA->m_width;
 676     int h = M_IMGDATA->m_height;
 677
 678     wxCHECK_RET( (x>=0) && (y>=0) && (x<w) && (y<h), wxT("invalid image index") );
 679
 680     long pos = (y * w + x) * 3;
 681
 682     M_IMGDATA->m_data[ pos   ] = r;
 683     M_IMGDATA->m_data[ pos+1 ] = g;
 684     M_IMGDATA->m_data[ pos+2 ] = b;
 685 }
 686
 687 unsigned char wxImage::GetRed( int x, int y ) const
 688 {
 689     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 690
 691     int w = M_IMGDATA->m_width;
 692     int h = M_IMGDATA->m_height;
 693
 694     wxCHECK_MSG( (x>=0) && (y>=0) && (x<w) && (y<h), 0, wxT("invalid image index") );
 695
 696     long pos = (y * w + x) * 3;
 697
 698     return M_IMGDATA->m_data[pos];
 699 }
 700
 701 unsigned char wxImage::GetGreen( int x, int y ) const
 702 {
 703     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 704
 705     int w = M_IMGDATA->m_width;
 706     int h = M_IMGDATA->m_height;
 707
 708     wxCHECK_MSG( (x>=0) && (y>=0) && (x<w) && (y<h), 0, wxT("invalid image index") );
 709
 710     long pos = (y * w + x) * 3;
 711
 712     return M_IMGDATA->m_data[pos+1];
 713 }
 714
 715 unsigned char wxImage::GetBlue( int x, int y ) const
 716 {
 717     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 718
 719     int w = M_IMGDATA->m_width;
 720     int h = M_IMGDATA->m_height;
 721
 722     wxCHECK_MSG( (x>=0) && (y>=0) && (x<w) && (y<h), 0, wxT("invalid image index") );
 723
 724     long pos = (y * w + x) * 3;
 725
 726     return M_IMGDATA->m_data[pos+2];
 727 }
 728
 729 bool wxImage::Ok() const
 730 {
 731     // image of 0 width or height can't be considered ok - at least because it
 732     // causes crashes in ConvertToBitmap() if we don't catch it in time
 733     wxImageRefData *data = M_IMGDATA;
 734     return data && data->m_ok && data->m_width && data->m_height;
 735 }
 736
 737 unsigned char *wxImage::GetData() const
 738 {
 739     wxCHECK_MSG( Ok(), (unsigned char *)NULL, wxT("invalid image") );
 740
 741     return M_IMGDATA->m_data;
 742 }
 743
 744 void wxImage::SetData( unsigned char *data )
 745 {
 746     wxCHECK_RET( Ok(), wxT("invalid image") );
 747
 748     wxImageRefData *newRefData = new wxImageRefData();
 749
 750     newRefData->m_width = M_IMGDATA->m_width;
 751     newRefData->m_height = M_IMGDATA->m_height;
 752     newRefData->m_data = data;
 753     newRefData->m_ok = TRUE;
 754     newRefData->m_maskRed = M_IMGDATA->m_maskRed;
 755     newRefData->m_maskGreen = M_IMGDATA->m_maskGreen;
 756     newRefData->m_maskBlue = M_IMGDATA->m_maskBlue;
 757     newRefData->m_hasMask = M_IMGDATA->m_hasMask;
 758
 759     UnRef();
 760
 761     m_refData = newRefData;
 762 }
 763
 764 void wxImage::SetData( unsigned char *data, int new_width, int new_height )
 765 {
 766     wxImageRefData *newRefData = new wxImageRefData();
 767
 768     if (m_refData)
 769     {
 770         newRefData->m_width = new_width;
 771         newRefData->m_height = new_height;
 772         newRefData->m_data = data;
 773         newRefData->m_ok = TRUE;
 774         newRefData->m_maskRed = M_IMGDATA->m_maskRed;
 775         newRefData->m_maskGreen = M_IMGDATA->m_maskGreen;
 776         newRefData->m_maskBlue = M_IMGDATA->m_maskBlue;
 777         newRefData->m_hasMask = M_IMGDATA->m_hasMask;
 778     }
 779     else
 780     {
 781         newRefData->m_width = new_width;
 782         newRefData->m_height = new_height;
 783         newRefData->m_data = data;
 784         newRefData->m_ok = TRUE;
 785     }
 786
 787     UnRef();
 788
 789     m_refData = newRefData;
 790 }
 791
 792 // ----------------------------------------------------------------------------
 793 // alpha channel support
 794 // ----------------------------------------------------------------------------
 795
 796 void wxImage::SetAlpha(int x, int y, unsigned char alpha)
 797 {
 798     wxCHECK_RET( Ok() && HasAlpha(), wxT("invalid image or no alpha channel") );
 799
 800     int w = M_IMGDATA->m_width,
 801         h = M_IMGDATA->m_height;
 802
 803     wxCHECK_RET( x >=0 && y >= 0 && x < w && y < h, wxT("invalid image index") );
 804
 805     M_IMGDATA->m_alpha[y*w + x] = alpha;
 806 }
 807
 808 unsigned char wxImage::GetAlpha(int x, int y)
 809 {
 810     wxCHECK_MSG( Ok() && HasAlpha(), 0, wxT("invalid image or no alpha channel") );
 811
 812     int w = M_IMGDATA->m_width,
 813         h = M_IMGDATA->m_height;
 814
 815     wxCHECK_MSG( x >=0 && y >= 0 && x < w && y < h, 0, wxT("invalid image index") );
 816
 817     return M_IMGDATA->m_alpha[y*w + x];
 818 }
 819
 820 void wxImage::SetAlpha( unsigned char *alpha )
 821 {
 822     wxCHECK_RET( Ok(), wxT("invalid image") );
 823
 824     if ( !alpha )
 825     {
 826         alpha = (unsigned char *)
 827                     malloc(M_IMGDATA->m_width*M_IMGDATA->m_height*3);
 828     }
 829
 830     delete [] M_IMGDATA->m_alpha;
 831     M_IMGDATA->m_alpha = alpha;
 832 }
 833
 834 unsigned char *wxImage::GetAlpha() const
 835 {
 836     wxCHECK_MSG( Ok(), (unsigned char *)NULL, wxT("invalid image") );
 837
 838     return M_IMGDATA->m_alpha;
 839 }
 840
 841 // ----------------------------------------------------------------------------
 842 // mask support
 843 // ----------------------------------------------------------------------------
 844
 845 void wxImage::SetMaskColour( unsigned char r, unsigned char g, unsigned char b )
 846 {
 847     wxCHECK_RET( Ok(), wxT("invalid image") );
 848
 849     M_IMGDATA->m_maskRed = r;
 850     M_IMGDATA->m_maskGreen = g;
 851     M_IMGDATA->m_maskBlue = b;
 852     M_IMGDATA->m_hasMask = TRUE;
 853 }
 854
 855 unsigned char wxImage::GetMaskRed() const
 856 {
 857     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 858
 859     return M_IMGDATA->m_maskRed;
 860 }
 861
 862 unsigned char wxImage::GetMaskGreen() const
 863 {
 864     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 865
 866     return M_IMGDATA->m_maskGreen;
 867 }
 868
 869 unsigned char wxImage::GetMaskBlue() const
 870 {
 871     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 872
 873     return M_IMGDATA->m_maskBlue;
 874 }
 875
 876 void wxImage::SetMask( bool mask )
 877 {
 878     wxCHECK_RET( Ok(), wxT("invalid image") );
 879
 880     M_IMGDATA->m_hasMask = mask;
 881 }
 882
 883 bool wxImage::HasMask() const
 884 {
 885     wxCHECK_MSG( Ok(), FALSE, wxT("invalid image") );
 886
 887     return M_IMGDATA->m_hasMask;
 888 }
 889
 890 int wxImage::GetWidth() const
 891 {
 892     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 893
 894     return M_IMGDATA->m_width;
 895 }
 896
 897 int wxImage::GetHeight() const
 898 {
 899     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
 900
 901     return M_IMGDATA->m_height;
 902 }
 903
 904 bool wxImage::SetMaskFromImage(const wxImage& mask,
 905                                unsigned char mr, unsigned char mg, unsigned char mb)
 906 {
 907     // check that the images are the same size
 908     if ( (M_IMGDATA->m_height != mask.GetHeight() ) || (M_IMGDATA->m_width != mask.GetWidth () ) )
 909     {
 910         wxLogError( _("Image and Mask have different sizes") );
 911         return FALSE;
 912     }
 913
 914     // find unused colour
 915     unsigned char r,g,b ;
 916     if (!FindFirstUnusedColour(&r, &g, &b))
 917     {
 918         wxLogError( _("No Unused Color in image being masked") );
 919         return FALSE ;
 920     }
 921
 922     unsigned char *imgdata = GetData();
 923     unsigned char *maskdata = mask.GetData();
 924
 925     const int w = GetWidth();
 926     const int h = GetHeight();
 927
 928     for (int j = 0; j < h; j++)
 929     {
 930         for (int i = 0; i < w; i++)
 931         {
 932             if ((maskdata[0] == mr) && (maskdata[1]  == mg) && (maskdata[2] == mb))
 933             {
 934                 imgdata[0] = r;
 935                 imgdata[1] = g;
 936                 imgdata[2] = b;
 937             }
 938             imgdata  += 3;
 939             maskdata += 3;
 940         }
 941     }
 942
 943     SetMaskColour(r, g, b);
 944     SetMask(TRUE);
 945
 946     return TRUE;
 947 }
 948
 949 #if wxUSE_PALETTE
 950
 951 // Palette functions
 952
 953 bool wxImage::HasPalette() const
 954 {
 955     if (!Ok())
 956         return FALSE;
 957
 958     return M_IMGDATA->m_palette.Ok();
 959 }
 960
 961 const wxPalette& wxImage::GetPalette() const
 962 {
 963     wxCHECK_MSG( Ok(), wxNullPalette, wxT("invalid image") );
 964
 965     return M_IMGDATA->m_palette;
 966 }
 967
 968 void wxImage::SetPalette(const wxPalette& palette)
 969 {
 970     wxCHECK_RET( Ok(), wxT("invalid image") );
 971
 972     M_IMGDATA->m_palette = palette;
 973 }
 974
 975 #endif // wxUSE_PALETTE
 976
 977 // Option functions (arbitrary name/value mapping)
 978 void wxImage::SetOption(const wxString& name, const wxString& value)
 979 {
 980     wxCHECK_RET( Ok(), wxT("invalid image") );
 981
 982     int idx = M_IMGDATA->m_optionNames.Index(name, FALSE);
 983     if (idx == wxNOT_FOUND)
 984     {
 985         M_IMGDATA->m_optionNames.Add(name);
 986         M_IMGDATA->m_optionValues.Add(value);
 987     }
 988     else
 989     {
 990         M_IMGDATA->m_optionNames[idx] = name;
 991         M_IMGDATA->m_optionValues[idx] = value;
 992     }
 993 }
 994
 995 void wxImage::SetOption(const wxString& name, int value)
 996 {
 997     wxString valStr;
 998     valStr.Printf(wxT("%d"), value);
 999     SetOption(name, valStr);
1000 }
1001
1002 wxString wxImage::GetOption(const wxString& name) const
1003 {
1004     wxCHECK_MSG( Ok(), wxEmptyString, wxT("invalid image") );
1005
1006     int idx = M_IMGDATA->m_optionNames.Index(name, FALSE);
1007     if (idx == wxNOT_FOUND)
1008         return wxEmptyString;
1009     else
1010         return M_IMGDATA->m_optionValues[idx];
1011 }
1012
1013 int wxImage::GetOptionInt(const wxString& name) const
1014 {
1015     wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
1016
1017     return wxAtoi(GetOption(name));
1018 }
1019
1020 bool wxImage::HasOption(const wxString& name) const
1021 {
1022     wxCHECK_MSG( Ok(), FALSE, wxT("invalid image") );
1023
1024     return (M_IMGDATA->m_optionNames.Index(name, FALSE) != wxNOT_FOUND);
1025 }
1026
1027 bool wxImage::LoadFile( const wxString& filename, long type, int index )
1028 {
1029 #if wxUSE_STREAMS
1030     if (wxFileExists(filename))
1031     {
1032         wxFileInputStream stream(filename);
1033         wxBufferedInputStream bstream( stream );
1034         return LoadFile(bstream, type, index);
1035     }
1036     else
1037     {
1038         wxLogError( _("Can't load image from file '%s': file does not exist."), filename.c_str() );
1039
1040         return FALSE;
1041     }
1042 #else // !wxUSE_STREAMS
1043     return FALSE;
1044 #endif // wxUSE_STREAMS
1045 }
1046
1047 bool wxImage::LoadFile( const wxString& filename, const wxString& mimetype, int index )
1048 {
1049 #if wxUSE_STREAMS
1050     if (wxFileExists(filename))
1051     {
1052         wxFileInputStream stream(filename);
1053         wxBufferedInputStream bstream( stream );
1054         return LoadFile(bstream, mimetype, index);
1055     }
1056     else
1057     {
1058         wxLogError( _("Can't load image from file '%s': file does not exist."), filename.c_str() );
1059
1060         return FALSE;
1061     }
1062 #else // !wxUSE_STREAMS
1063     return FALSE;
1064 #endif // wxUSE_STREAMS
1065 }
1066
1067
1068
1069 bool wxImage::SaveFile( const wxString& filename ) const
1070 {
1071     wxString ext = filename.AfterLast('.').Lower();
1072
1073     wxImageHandler * pHandler = FindHandler(ext, -1);
1074     if (pHandler)
1075     {
1076         SaveFile(filename, pHandler->GetType());
1077         return TRUE;
1078     }
1079
1080     wxLogError(_("Can't save image to file '%s': unknown extension."), filename.c_str());
1081
1082     return FALSE;
1083 }
1084
1085 bool wxImage::SaveFile( const wxString& filename, int type ) const
1086 {
1087 #if wxUSE_STREAMS
1088     ((wxImage*)this)->SetOption(wxIMAGE_OPTION_FILENAME, filename);
1089
1090     wxFileOutputStream stream(filename);
1091
1092     if ( stream.IsOk() )
1093     {
1094         wxBufferedOutputStream bstream( stream );
1095         return SaveFile(bstream, type);
1096     }
1097 #endif // wxUSE_STREAMS
1098
1099     return FALSE;
1100 }
1101
1102 bool wxImage::SaveFile( const wxString& filename, const wxString& mimetype ) const
1103 {
1104 #if wxUSE_STREAMS
1105     ((wxImage*)this)->SetOption(wxIMAGE_OPTION_FILENAME, filename);
1106
1107     wxFileOutputStream stream(filename);
1108
1109     if ( stream.IsOk() )
1110     {
1111         wxBufferedOutputStream bstream( stream );
1112         return SaveFile(bstream, mimetype);
1113     }
1114 #endif // wxUSE_STREAMS
1115
1116     return FALSE;
1117 }
1118
1119 bool wxImage::CanRead( const wxString &name )
1120 {
1121 #if wxUSE_STREAMS
1122   wxFileInputStream stream(name);
1123   return CanRead(stream);
1124 #else
1125   return FALSE;
1126 #endif
1127 }
1128
1129 int wxImage::GetImageCount( const wxString &name, long type )
1130 {
1131 #if wxUSE_STREAMS
1132   wxFileInputStream stream(name);
1133   if (stream.Ok())
1134       return GetImageCount(stream, type);
1135 #endif
1136
1137   return 0;
1138 }
1139
1140 #if wxUSE_STREAMS
1141
1142 bool wxImage::CanRead( wxInputStream &stream )
1143 {
1144     const wxList& list = GetHandlers();
1145
1146     for ( wxList::Node *node = list.GetFirst(); node; node = node->GetNext() )
1147     {
1148         wxImageHandler *handler=(wxImageHandler*)node->GetData();
1149         if (handler->CanRead( stream ))
1150             return TRUE;
1151     }
1152
1153     return FALSE;
1154 }
1155
1156 int wxImage::GetImageCount( wxInputStream &stream, long type )
1157 {
1158     wxImageHandler *handler;
1159
1160     if ( type == wxBITMAP_TYPE_ANY )
1161     {
1162         wxList &list=GetHandlers();
1163
1164         for (wxList::Node *node = list.GetFirst(); node; node = node->GetNext())
1165         {
1166              handler=(wxImageHandler*)node->GetData();
1167              if ( handler->CanRead(stream) )
1168                  return handler->GetImageCount(stream);
1169
1170         }
1171
1172         wxLogWarning(_("No handler found for image type."));
1173         return 0;
1174     }
1175
1176     handler = FindHandler(type);
1177
1178     if ( !handler )
1179     {
1180         wxLogWarning(_("No image handler for type %d defined."), type);
1181         return FALSE;
1182     }
1183
1184     if ( handler->CanRead(stream) )
1185     {
1186         return handler->GetImageCount(stream);
1187     }
1188     else
1189     {
1190         wxLogError(_("Image file is not of type %d."), type);
1191         return 0;
1192     }
1193 }
1194
1195 bool wxImage::LoadFile( wxInputStream& stream, long type, int index )
1196 {
1197     UnRef();
1198
1199     m_refData = new wxImageRefData;
1200
1201     wxImageHandler *handler;
1202
1203     if ( type == wxBITMAP_TYPE_ANY )
1204     {
1205         wxList &list=GetHandlers();
1206
1207         for ( wxList::Node *node = list.GetFirst(); node; node = node->GetNext() )
1208         {
1209              handler=(wxImageHandler*)node->GetData();
1210              if ( handler->CanRead(stream) )
1211                  return handler->LoadFile(this, stream, TRUE/*verbose*/, index);
1212
1213         }
1214
1215         wxLogWarning( _("No handler found for image type.") );
1216         return FALSE;
1217     }
1218
1219     handler = FindHandler(type);
1220
1221     if (handler == 0)
1222     {
1223         wxLogWarning( _("No image handler for type %d defined."), type );
1224
1225         return FALSE;
1226     }
1227
1228     return handler->LoadFile(this, stream, TRUE/*verbose*/, index);
1229 }
1230
1231 bool wxImage::LoadFile( wxInputStream& stream, const wxString& mimetype, int index )
1232 {
1233     UnRef();
1234
1235     m_refData = new wxImageRefData;
1236
1237     wxImageHandler *handler = FindHandlerMime(mimetype);
1238
1239     if (handler == 0)
1240     {
1241         wxLogWarning( _("No image handler for type %s defined."), mimetype.GetData() );
1242
1243         return FALSE;
1244     }
1245
1246     return handler->LoadFile( this, stream, TRUE/*verbose*/, index );
1247 }
1248
1249 bool wxImage::SaveFile( wxOutputStream& stream, int type ) const
1250 {
1251     wxCHECK_MSG( Ok(), FALSE, wxT("invalid image") );
1252
1253     wxImageHandler *handler = FindHandler(type);
1254
1255     if (handler == 0)
1256     {
1257         wxLogWarning( _("No image handler for type %d defined."), type );
1258
1259         return FALSE;
1260     }
1261
1262     return handler->SaveFile( (wxImage*)this, stream );
1263 }
1264
1265 bool wxImage::SaveFile( wxOutputStream& stream, const wxString& mimetype ) const
1266 {
1267     wxCHECK_MSG( Ok(), FALSE, wxT("invalid image") );
1268
1269     wxImageHandler *handler = FindHandlerMime(mimetype);
1270
1271     if (handler == 0)
1272     {
1273         wxLogWarning( _("No image handler for type %s defined."), mimetype.GetData() );
1274
1275         return FALSE;
1276     }
1277
1278     return handler->SaveFile( (wxImage*)this, stream );
1279 }
1280 #endif // wxUSE_STREAMS
1281
1282 void wxImage::AddHandler( wxImageHandler *handler )
1283 {
1284     // make sure that the memory will be freed at the program end
1285     sm_handlers.DeleteContents(TRUE);
1286
1287     // Check for an existing handler of the type being added.
1288     if (FindHandler( handler->GetType() ) == 0)
1289     {
1290         sm_handlers.Append( handler );
1291     }
1292     else
1293     {
1294         // This is not documented behaviour, merely the simplest 'fix'
1295         // for preventing duplicate additions.  If someone ever has
1296         // a good reason to add and remove duplicate handlers (and they
1297         // may) we should probably refcount the duplicates.
1298         //   also an issue in InsertHandler below.
1299
1300         wxLogDebug( _T("Adding duplicate image handler for '%s'"),
1301                     handler->GetName().c_str() );
1302         delete handler;
1303     }
1304 }
1305
1306 void wxImage::InsertHandler( wxImageHandler *handler )
1307 {
1308     // make sure that the memory will be freed at the program end
1309     sm_handlers.DeleteContents(TRUE);
1310
1311     // Check for an existing handler of the type being added.
1312     if (FindHandler( handler->GetType() ) == 0)
1313     {
1314         sm_handlers.Insert( handler );
1315     }
1316     else
1317     {
1318         // see AddHandler for additional comments.
1319         wxLogDebug( _T("Inserting duplicate image handler for '%s'"),
1320                     handler->GetName().c_str() );
1321         delete handler;
1322     }
1323 }
1324
1325 bool wxImage::RemoveHandler( const wxString& name )
1326 {
1327     wxImageHandler *handler = FindHandler(name);
1328     if (handler)
1329     {
1330         sm_handlers.DeleteObject(handler);
1331         return TRUE;
1332     }
1333     else
1334         return FALSE;
1335 }
1336
1337 wxImageHandler *wxImage::FindHandler( const wxString& name )
1338 {
1339     wxNode *node = sm_handlers.GetFirst();
1340     while (node)
1341     {
1342         wxImageHandler *handler = (wxImageHandler*)node->GetData();
1343         if (handler->GetName().Cmp(name) == 0) return handler;
1344
1345         node = node->GetNext();
1346     }
1347     return 0;
1348 }
1349
1350 wxImageHandler *wxImage::FindHandler( const wxString& extension, long bitmapType )
1351 {
1352     wxNode *node = sm_handlers.GetFirst();
1353     while (node)
1354     {
1355         wxImageHandler *handler = (wxImageHandler*)node->GetData();
1356         if ( (handler->GetExtension().Cmp(extension) == 0) &&
1357             (bitmapType == -1 || handler->GetType() == bitmapType) )
1358             return handler;
1359         node = node->GetNext();
1360     }
1361     return 0;
1362 }
1363
1364 wxImageHandler *wxImage::FindHandler( long bitmapType )
1365 {
1366     wxNode *node = sm_handlers.GetFirst();
1367     while (node)
1368     {
1369         wxImageHandler *handler = (wxImageHandler *)node->GetData();
1370         if (handler->GetType() == bitmapType) return handler;
1371         node = node->GetNext();
1372     }
1373     return 0;
1374 }
1375
1376 wxImageHandler *wxImage::FindHandlerMime( const wxString& mimetype )
1377 {
1378     wxNode *node = sm_handlers.GetFirst();
1379     while (node)
1380     {
1381         wxImageHandler *handler = (wxImageHandler *)node->GetData();
1382         if (handler->GetMimeType().IsSameAs(mimetype, FALSE)) return handler;
1383         node = node->GetNext();
1384     }
1385     return 0;
1386 }
1387
1388 void wxImage::InitStandardHandlers()
1389 {
1390 #if wxUSE_STREAMS
1391     AddHandler(new wxBMPHandler);
1392 #endif // wxUSE_STREAMS
1393 }
1394
1395 void wxImage::CleanUpHandlers()
1396 {
1397     wxNode *node = sm_handlers.GetFirst();
1398     while (node)
1399     {
1400         wxImageHandler *handler = (wxImageHandler *)node->GetData();
1401         wxNode *next = node->GetNext();
1402         delete handler;
1403         delete node;
1404         node = next;
1405     }
1406 }
1407
1408 //-----------------------------------------------------------------------------
1409 // wxImageHandler
1410 //-----------------------------------------------------------------------------
1411
1412 IMPLEMENT_ABSTRACT_CLASS(wxImageHandler,wxObject)
1413
1414 #if wxUSE_STREAMS
1415 bool wxImageHandler::LoadFile( wxImage *WXUNUSED(image), wxInputStream& WXUNUSED(stream), bool WXUNUSED(verbose), int WXUNUSED(index) )
1416 {
1417     return FALSE;
1418 }
1419
1420 bool wxImageHandler::SaveFile( wxImage *WXUNUSED(image), wxOutputStream& WXUNUSED(stream), bool WXUNUSED(verbose) )
1421 {
1422     return FALSE;
1423 }
1424
1425 int wxImageHandler::GetImageCount( wxInputStream& WXUNUSED(stream) )
1426 {
1427     return 1;
1428 }
1429
1430 bool wxImageHandler::CanRead( const wxString& name )
1431 {
1432     if (wxFileExists(name))
1433     {
1434         wxFileInputStream stream(name);
1435         return CanRead(stream);
1436     }
1437
1438     wxLogError( _("Can't check image format of file '%s': file does not exist."), name.c_str() );
1439
1440     return FALSE;
1441 }
1442
1443 bool wxImageHandler::CallDoCanRead(wxInputStream& stream)
1444 {
1445     off_t posOld = stream.TellI();
1446     if ( posOld == wxInvalidOffset )
1447     {
1448         // can't test unseekable stream
1449         return FALSE;
1450     }
1451
1452     bool ok = DoCanRead(stream);
1453
1454     // restore the old position to be able to test other formats and so on
1455     if ( stream.SeekI(posOld) == wxInvalidOffset )
1456     {
1457         wxLogDebug(_T("Failed to rewind the stream in wxImageHandler!"));
1458
1459         // reading would fail anyhow as we're not at the right position
1460         return FALSE;
1461     }
1462
1463     return ok;
1464 }
1465
1466 #endif // wxUSE_STREAMS
1467
1468
1469
1470 //-----------------------------------------------------------------------------
1471 // Deprecated wxBitmap conversion routines
1472 //-----------------------------------------------------------------------------
1473
1474 #if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI
1475
1476 #ifdef __WXGTK__
1477 wxBitmap wxImage::ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const
1478 {
1479     wxImage mono = this->ConvertToMono( red, green, blue );
1480     wxBitmap bitmap( mono, 1 );
1481     return bitmap;
1482 }
1483 #endif
1484
1485 wxBitmap wxImage::ConvertToBitmap() const
1486 {
1487     wxBitmap bitmap( *this );
1488     return bitmap;
1489 }
1490
1491 wxImage::wxImage( const wxBitmap &bitmap )
1492 {
1493     *this = bitmap.ConvertToImage();
1494 }
1495
1496 #endif // WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI
1497
1498
1499 // ----------------------------------------------------------------------------
1500 // image histogram stuff
1501 // ----------------------------------------------------------------------------
1502
1503 bool
1504 wxImageHistogram::FindFirstUnusedColour(unsigned char *r,
1505                                         unsigned char *g,
1506                                         unsigned char *b,
1507                                         unsigned char r2,
1508                                         unsigned char b2,
1509                                         unsigned char g2) const
1510 {
1511     unsigned long key = MakeKey(r2, g2, b2);
1512
1513     while ( find(key) != end() )
1514     {
1515         // color already used
1516         r2++;
1517         if ( r2 >= 255 )
1518         {
1519             r2 = 0;
1520             g2++;
1521             if ( g2 >= 255 )
1522             {
1523                 g2 = 0;
1524                 b2++;
1525                 if ( b2 >= 255 )
1526                 {
1527                     wxLogError(_("GetUnusedColour:: No Unused Color in image ") );
1528                     return FALSE;
1529                 }
1530             }
1531         }
1532
1533         key = MakeKey(r2, g2, b2);
1534     }
1535
1536     if ( r )
1537         *r = r2;
1538     if ( g )
1539         *g = g2;
1540     if ( b )
1541         *b = b2;
1542
1543     return TRUE;
1544 }
1545
1546 bool
1547 wxImage::FindFirstUnusedColour(unsigned char *r,
1548                                unsigned char *g,
1549                                unsigned char *b,
1550                                unsigned char r2,
1551                                unsigned char b2,
1552                                unsigned char g2) const
1553 {
1554     wxImageHistogram histogram;
1555
1556     ComputeHistogram(histogram);
1557
1558     return histogram.FindFirstUnusedColour(r, g, b, r2, g2, b2);
1559 }
1560
1561
1562
1563 // GRG, Dic/99
1564 // Counts and returns the number of different colours. Optionally stops
1565 // when it exceeds 'stopafter' different colours. This is useful, for
1566 // example, to see if the image can be saved as 8-bit (256 colour or
1567 // less, in this case it would be invoked as CountColours(256)). Default
1568 // value for stopafter is -1 (don't care).
1569 //
1570 unsigned long wxImage::CountColours( unsigned long stopafter ) const
1571 {
1572     wxHashTable h;
1573     wxObject dummy;
1574     unsigned char r, g, b;
1575     unsigned char *p;
1576     unsigned long size, nentries, key;
1577
1578     p = GetData();
1579     size = GetWidth() * GetHeight();
1580     nentries = 0;
1581
1582     for (unsigned long j = 0; (j < size) && (nentries <= stopafter) ; j++)
1583     {
1584         r = *(p++);
1585         g = *(p++);
1586         b = *(p++);
1587         key = wxImageHistogram::MakeKey(r, g, b);
1588
1589         if (h.Get(key) == NULL)
1590         {
1591             h.Put(key, &dummy);
1592             nentries++;
1593         }
1594     }
1595
1596     return nentries;
1597 }
1598
1599
1600 unsigned long wxImage::ComputeHistogram( wxImageHistogram &h ) const
1601 {
1602     unsigned char *p = GetData();
1603     unsigned long nentries = 0;
1604
1605     h.clear();
1606
1607     const unsigned long size = GetWidth() * GetHeight();
1608
1609     unsigned char r, g, b;
1610     for ( unsigned long n = 0; n < size; n++ )
1611     {
1612         r = *p++;
1613         g = *p++;
1614         b = *p++;
1615
1616         wxImageHistogramEntry& entry = h[wxImageHistogram::MakeKey(r, g, b)];
1617
1618         if ( entry.value++ == 0 )
1619             entry.index = nentries++;
1620     }
1621
1622     return nentries;
1623 }
1624
1625 /*
1626  * Rotation code by Carlos Moreno
1627  */
1628
1629 // GRG: I've removed wxRotationPoint - we already have wxRealPoint which
1630 //      does exactly the same thing. And I also got rid of wxRotationPixel
1631 //      bacause of potential problems in architectures where alignment
1632 //      is an issue, so I had to rewrite parts of the code.
1633
1634 static const double gs_Epsilon = 1e-10;
1635
1636 static inline int wxCint (double x)
1637 {
1638     return (x > 0) ? (int) (x + 0.5) : (int) (x - 0.5);
1639 }
1640
1641
1642 // Auxiliary function to rotate a point (x,y) with respect to point p0
1643 // make it inline and use a straight return to facilitate optimization
1644 // also, the function receives the sine and cosine of the angle to avoid
1645 // repeating the time-consuming calls to these functions -- sin/cos can
1646 // be computed and stored in the calling function.
1647
1648 inline wxRealPoint rotated_point (const wxRealPoint & p, double cos_angle, double sin_angle, const wxRealPoint & p0)
1649 {
1650     return wxRealPoint (p0.x + (p.x - p0.x) * cos_angle - (p.y - p0.y) * sin_angle,
1651                         p0.y + (p.y - p0.y) * cos_angle + (p.x - p0.x) * sin_angle);
1652 }
1653
1654 inline wxRealPoint rotated_point (double x, double y, double cos_angle, double sin_angle, const wxRealPoint & p0)
1655 {
1656     return rotated_point (wxRealPoint(x,y), cos_angle, sin_angle, p0);
1657 }
1658
1659 wxImage wxImage::Rotate(double angle, const wxPoint & centre_of_rotation, bool interpolating, wxPoint * offset_after_rotation) const
1660 {
1661     int i;
1662     angle = -angle;     // screen coordinates are a mirror image of "real" coordinates
1663
1664     // Create pointer-based array to accelerate access to wxImage's data
1665     unsigned char ** data = new unsigned char * [GetHeight()];
1666
1667     data[0] = GetData();
1668
1669     for (i = 1; i < GetHeight(); i++)
1670         data[i] = data[i - 1] + (3 * GetWidth());
1671
1672     // precompute coefficients for rotation formula
1673     // (sine and cosine of the angle)
1674     const double cos_angle = cos(angle);
1675     const double sin_angle = sin(angle);
1676
1677     // Create new Image to store the result
1678     // First, find rectangle that covers the rotated image;  to do that,
1679     // rotate the four corners
1680
1681     const wxRealPoint p0(centre_of_rotation.x, centre_of_rotation.y);
1682
1683     wxRealPoint p1 = rotated_point (0, 0, cos_angle, sin_angle, p0);
1684     wxRealPoint p2 = rotated_point (0, GetHeight(), cos_angle, sin_angle, p0);
1685     wxRealPoint p3 = rotated_point (GetWidth(), 0, cos_angle, sin_angle, p0);
1686     wxRealPoint p4 = rotated_point (GetWidth(), GetHeight(), cos_angle, sin_angle, p0);
1687
1688     int x1 = (int) floor (wxMin (wxMin(p1.x, p2.x), wxMin(p3.x, p4.x)));
1689     int y1 = (int) floor (wxMin (wxMin(p1.y, p2.y), wxMin(p3.y, p4.y)));
1690     int x2 = (int) ceil (wxMax (wxMax(p1.x, p2.x), wxMax(p3.x, p4.x)));
1691     int y2 = (int) ceil (wxMax (wxMax(p1.y, p2.y), wxMax(p3.y, p4.y)));
1692
1693     wxImage rotated (x2 - x1 + 1, y2 - y1 + 1);
1694
1695     if (offset_after_rotation != NULL)
1696     {
1697         *offset_after_rotation = wxPoint (x1, y1);
1698     }
1699
1700     // GRG: The rotated (destination) image is always accessed
1701     //      sequentially, so there is no need for a pointer-based
1702     //      array here (and in fact it would be slower).
1703     //
1704     unsigned char * dst = rotated.GetData();
1705
1706     // GRG: if the original image has a mask, use its RGB values
1707     //      as the blank pixel, else, fall back to default (black).
1708     //
1709     unsigned char blank_r = 0;
1710     unsigned char blank_g = 0;
1711     unsigned char blank_b = 0;
1712
1713     if (HasMask())
1714     {
1715         blank_r = GetMaskRed();
1716         blank_g = GetMaskGreen();
1717         blank_b = GetMaskBlue();
1718         rotated.SetMaskColour( blank_r, blank_g, blank_b );
1719     }
1720
1721     // Now, for each point of the rotated image, find where it came from, by
1722     // performing an inverse rotation (a rotation of -angle) and getting the
1723     // pixel at those coordinates
1724
1725     // GRG: I've taken the (interpolating) test out of the loops, so that
1726     //      it is done only once, instead of repeating it for each pixel.
1727
1728     int x;
1729     if (interpolating)
1730     {
1731         for (int y = 0; y < rotated.GetHeight(); y++)
1732         {
1733             for (x = 0; x < rotated.GetWidth(); x++)
1734             {
1735                 wxRealPoint src = rotated_point (x + x1, y + y1, cos_angle, -sin_angle, p0);
1736
1737                 if (-0.25 < src.x && src.x < GetWidth() - 0.75 &&
1738                     -0.25 < src.y && src.y < GetHeight() - 0.75)
1739                 {
1740                     // interpolate using the 4 enclosing grid-points.  Those
1741                     // points can be obtained using floor and ceiling of the
1742                     // exact coordinates of the point
1743                         // C.M. 2000-02-17:  when the point is near the border, special care is required.
1744
1745                     int x1, y1, x2, y2;
1746
1747                     if (0 < src.x && src.x < GetWidth() - 1)
1748                     {
1749                         x1 = wxCint(floor(src.x));
1750                         x2 = wxCint(ceil(src.x));
1751                     }
1752                     else    // else means that x is near one of the borders (0 or width-1)
1753                     {
1754                         x1 = x2 = wxCint (src.x);
1755                     }
1756
1757                     if (0 < src.y && src.y < GetHeight() - 1)
1758                     {
1759                         y1 = wxCint(floor(src.y));
1760                         y2 = wxCint(ceil(src.y));
1761                     }
1762                     else
1763                     {
1764                         y1 = y2 = wxCint (src.y);
1765                     }
1766
1767                     // get four points and the distances (square of the distance,
1768                     // for efficiency reasons) for the interpolation formula
1769
1770                     // GRG: Do not calculate the points until they are
1771                     //      really needed -- this way we can calculate
1772                     //      just one, instead of four, if d1, d2, d3
1773                     //      or d4 are < gs_Epsilon
1774
1775                     const double d1 = (src.x - x1) * (src.x - x1) + (src.y - y1) * (src.y - y1);
1776                     const double d2 = (src.x - x2) * (src.x - x2) + (src.y - y1) * (src.y - y1);
1777                     const double d3 = (src.x - x2) * (src.x - x2) + (src.y - y2) * (src.y - y2);
1778                     const double d4 = (src.x - x1) * (src.x - x1) + (src.y - y2) * (src.y - y2);
1779
1780                     // Now interpolate as a weighted average of the four surrounding
1781                     // points, where the weights are the distances to each of those points
1782
1783                     // If the point is exactly at one point of the grid of the source
1784                     // image, then don't interpolate -- just assign the pixel
1785
1786                     if (d1 < gs_Epsilon)        // d1,d2,d3,d4 are positive -- no need for abs()
1787                     {
1788                         unsigned char *p = data[y1] + (3 * x1);
1789                         *(dst++) = *(p++);
1790                         *(dst++) = *(p++);
1791                         *(dst++) = *(p++);
1792                     }
1793                     else if (d2 < gs_Epsilon)
1794                     {
1795                         unsigned char *p = data[y1] + (3 * x2);
1796                         *(dst++) = *(p++);
1797                         *(dst++) = *(p++);
1798                         *(dst++) = *(p++);
1799                     }
1800                     else if (d3 < gs_Epsilon)
1801                     {
1802                         unsigned char *p = data[y2] + (3 * x2);
1803                         *(dst++) = *(p++);
1804                         *(dst++) = *(p++);
1805                         *(dst++) = *(p++);
1806                     }
1807                     else if (d4 < gs_Epsilon)
1808                     {
1809                         unsigned char *p = data[y2] + (3 * x1);
1810                         *(dst++) = *(p++);
1811                         *(dst++) = *(p++);
1812                         *(dst++) = *(p++);
1813                     }
1814                     else
1815                     {
1816                         // weights for the weighted average are proportional to the inverse of the distance
1817                         unsigned char *v1 = data[y1] + (3 * x1);
1818                         unsigned char *v2 = data[y1] + (3 * x2);
1819                         unsigned char *v3 = data[y2] + (3 * x2);
1820                         unsigned char *v4 = data[y2] + (3 * x1);
1821
1822                         const double w1 = 1/d1, w2 = 1/d2, w3 = 1/d3, w4 = 1/d4;
1823
1824                         // GRG: Unrolled.
1825
1826                         *(dst++) = (unsigned char)
1827                             ( (w1 * *(v1++) + w2 * *(v2++) +
1828                                w3 * *(v3++) + w4 * *(v4++)) /
1829                               (w1 + w2 + w3 + w4) );
1830                         *(dst++) = (unsigned char)
1831                             ( (w1 * *(v1++) + w2 * *(v2++) +
1832                                w3 * *(v3++) + w4 * *(v4++)) /
1833                               (w1 + w2 + w3 + w4) );
1834                         *(dst++) = (unsigned char)
1835                             ( (w1 * *(v1++) + w2 * *(v2++) +
1836                                w3 * *(v3++) + w4 * *(v4++)) /
1837                               (w1 + w2 + w3 + w4) );
1838                     }
1839                 }
1840                 else
1841                 {
1842                     *(dst++) = blank_r;
1843                     *(dst++) = blank_g;
1844                     *(dst++) = blank_b;
1845                 }
1846             }
1847         }
1848     }
1849     else    // not interpolating
1850     {
1851         for (int y = 0; y < rotated.GetHeight(); y++)
1852         {
1853             for (x = 0; x < rotated.GetWidth(); x++)
1854             {
1855                 wxRealPoint src = rotated_point (x + x1, y + y1, cos_angle, -sin_angle, p0);
1856
1857                 const int xs = wxCint (src.x);      // wxCint rounds to the
1858                 const int ys = wxCint (src.y);      // closest integer
1859
1860                 if (0 <= xs && xs < GetWidth() &&
1861                     0 <= ys && ys < GetHeight())
1862                 {
1863                     unsigned char *p = data[ys] + (3 * xs);
1864                     *(dst++) = *(p++);
1865                     *(dst++) = *(p++);
1866                     *(dst++) = *(p++);
1867                 }
1868                 else
1869                 {
1870                     *(dst++) = blank_r;
1871                     *(dst++) = blank_g;
1872                     *(dst++) = blank_b;
1873                 }
1874             }
1875         }
1876     }
1877
1878     delete [] data;
1879
1880     return rotated;
1881 }
1882
1883
1884
1885
1886
1887 // A module to allow wxImage initialization/cleanup
1888 // without calling these functions from app.cpp or from
1889 // the user's application.
1890
1891 class wxImageModule: public wxModule
1892 {
1893 DECLARE_DYNAMIC_CLASS(wxImageModule)
1894 public:
1895     wxImageModule() {}
1896     bool OnInit() { wxImage::InitStandardHandlers(); return TRUE; };
1897     void OnExit() { wxImage::CleanUpHandlers(); };
1898 };
1899
1900 IMPLEMENT_DYNAMIC_CLASS(wxImageModule, wxModule)
1901
1902
1903 #endif // wxUSE_IMAGE