src/dfb/bitmap.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/dfb/bitmap.cpp
   3 // Purpose:     wxBitmap implementation
   4 // Author:      Vaclav Slavik
   5 // Created:     2006-08-04
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2006 REA Elektronik GmbH
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 #ifndef WX_PRECOMP
  19     #include "wx/app.h"
  20     #include "wx/log.h"
  21 #endif
  22
  23 #include "wx/bitmap.h"
  24 #include "wx/colour.h"
  25 #include "wx/image.h"
  26 #include "wx/rawbmp.h"
  27
  28 #include "wx/dfb/private.h"
  29
  30 //-----------------------------------------------------------------------------
  31 // helpers
  32 //-----------------------------------------------------------------------------
  33
  34 // NB: Most of this conversion code is needed because of differences between
  35 //     wxImage and wxDFB's wxBitmap representations:
  36 //     (1) wxImage uses RGB order, while DirectFB uses BGR
  37 //     (2) wxImage has alpha channel in a separate plane, while DirectFB puts
  38 //         all components into single BGRA plane
  39
  40 // pitch = stride = # of bytes between the start of N-th line and (N+1)-th line
  41 // {Src,Dst}PixSize = # of bytes used to represent one pixel
  42 template<int SrcPixSize, int DstPixSize>
  43 static void CopyPixelsAndSwapRGB(unsigned w, unsigned h,
  44                                  const unsigned char *src,
  45                                  unsigned src_pitch,
  46                                  unsigned char *dst,
  47                                  unsigned dst_pitch)
  48 {
  49     unsigned src_advance = src_pitch - SrcPixSize * w;
  50     unsigned dst_advance = dst_pitch - DstPixSize * w;
  51     for ( unsigned y = 0; y < h; y++, src += src_advance, dst += dst_advance )
  52     {
  53         for ( unsigned x = 0; x < w; x++, src += SrcPixSize, dst += DstPixSize )
  54         {
  55             // copy with RGB -> BGR translation:
  56             dst[0] = src[2];
  57             dst[1] = src[1];
  58             dst[2] = src[0];
  59         }
  60     }
  61 }
  62
  63 static void CopySurfaceToImage(const wxIDirectFBSurfacePtr& surface,
  64                                wxImage& image)
  65 {
  66     wxIDirectFBSurface::Locked locked(surface, DSLF_READ);
  67     wxCHECK_RET( locked.ptr, "failed to lock surface" );
  68
  69     const unsigned width = image.GetWidth();
  70     const unsigned height = image.GetHeight();
  71     const DFBSurfacePixelFormat format = surface->GetPixelFormat();
  72
  73     // copy RGB data from the surface:
  74     switch ( format )
  75     {
  76         case DSPF_RGB24:
  77             CopyPixelsAndSwapRGB<3,3>
  78             (
  79                 width, height,
  80                 (unsigned char*)locked.ptr, locked.pitch,
  81                 image.GetData(), width * 3
  82             );
  83             break;
  84
  85         case DSPF_RGB32:
  86         case DSPF_ARGB:
  87             CopyPixelsAndSwapRGB<4,3>
  88             (
  89                 width, height,
  90                 (unsigned char*)locked.ptr, locked.pitch,
  91                 image.GetData(), width * 3
  92             );
  93             break;
  94
  95         default:
  96             wxFAIL_MSG( "unexpected pixel format" );
  97             return;
  98     }
  99
 100     // extract alpha channel if the bitmap has it:
 101     if ( format == DSPF_ARGB )
 102     {
 103         // create alpha plane:
 104         image.SetAlpha();
 105
 106         // and copy alpha data to it:
 107         const unsigned advance = locked.pitch - 4 * width;
 108         unsigned char *alpha = image.GetAlpha();
 109         // NB: "+3" is to get pointer to alpha component
 110         const unsigned char *src = ((unsigned char*)locked.ptr) + 3;
 111
 112         for ( unsigned y = 0; y < height; y++, src += advance )
 113             for ( unsigned x = 0; x < width; x++, src += 4 )
 114                 *(alpha++) = *src;
 115     }
 116 }
 117
 118 static void CopyImageToSurface(const wxImage& image,
 119                                const wxIDirectFBSurfacePtr& surface)
 120 {
 121     wxIDirectFBSurface::Locked locked(surface, DSLF_WRITE);
 122     wxCHECK_RET( locked.ptr, "failed to lock surface" );
 123
 124     const unsigned width = image.GetWidth();
 125     const unsigned height = image.GetHeight();
 126     const DFBSurfacePixelFormat format = surface->GetPixelFormat();
 127
 128     // copy RGB data to the surface:
 129     switch ( format )
 130     {
 131         case DSPF_RGB24:
 132             CopyPixelsAndSwapRGB<3,3>
 133             (
 134                width, height,
 135                image.GetData(), width * 3,
 136                (unsigned char*)locked.ptr, locked.pitch
 137             );
 138             break;
 139
 140         case DSPF_RGB32:
 141         case DSPF_ARGB:
 142             CopyPixelsAndSwapRGB<3,4>
 143             (
 144                width, height,
 145                image.GetData(), width * 3,
 146                (unsigned char*)locked.ptr, locked.pitch
 147             );
 148             break;
 149
 150         default:
 151             wxFAIL_MSG( "unexpected pixel format" );
 152             return;
 153     }
 154
 155     // if the image has alpha channel, merge it in:
 156     if ( format == DSPF_ARGB )
 157     {
 158         wxCHECK_RET( image.HasAlpha(), "logic error - ARGB, but no alpha" );
 159
 160         const unsigned advance = locked.pitch - 4 * width;
 161         const unsigned char *alpha = image.GetAlpha();
 162         // NB: "+3" is to get pointer to alpha component
 163         unsigned char *dest = ((unsigned char*)locked.ptr) + 3;
 164
 165         for ( unsigned y = 0; y < height; y++, dest += advance )
 166             for ( unsigned x = 0; x < width; x++, dest += 4 )
 167                 *dest = *(alpha++);
 168     }
 169 }
 170
 171 static wxIDirectFBSurfacePtr
 172 CreateSurfaceWithFormat(int w, int h, DFBSurfacePixelFormat format)
 173 {
 174     DFBSurfaceDescription desc;
 175     desc.flags = (DFBSurfaceDescriptionFlags)
 176         (DSDESC_CAPS | DSDESC_WIDTH | DSDESC_HEIGHT);
 177     desc.caps = DSCAPS_NONE;
 178     desc.width = w;
 179     desc.height = h;
 180
 181     if ( format != DSPF_UNKNOWN )
 182     {
 183         desc.flags = (DFBSurfaceDescriptionFlags)(
 184                             desc.flags | DSDESC_PIXELFORMAT);
 185         desc.pixelformat = format;
 186     }
 187
 188     return wxIDirectFB::Get()->CreateSurface(&desc);
 189 }
 190
 191 // Creates a surface that will use wxImage's pixel data (RGB only)
 192 static wxIDirectFBSurfacePtr CreateSurfaceForImage(const wxImage& image)
 193 {
 194     wxCHECK_MSG( image.Ok(), NULL, "invalid image" );
 195     // FIXME_DFB: implement alpha handling by merging alpha buffer with RGB
 196     //            into a temporary RGBA surface
 197     wxCHECK_MSG( !image.HasAlpha(), NULL, "alpha channel not supported" );
 198
 199     // NB: wxImage uses RGB order of bytes while DirectFB uses BGR, so we
 200     //     cannot use preallocated surface that shares data with wxImage, we
 201     //     have to copy the data to temporary surface instead
 202     return CreateSurfaceWithFormat(image.GetWidth(), image.GetHeight(),
 203                                    DSPF_RGB24);
 204 }
 205
 206 static bool ConvertSurfaceToFormat(wxIDirectFBSurfacePtr& surface,
 207                                    DFBSurfacePixelFormat format)
 208 {
 209     if ( surface->GetPixelFormat() == format )
 210         return true;
 211
 212     int w, h;
 213     surface->GetSize(&w, &h);
 214     wxIDirectFBSurfacePtr s = CreateSurfaceWithFormat(w, h, format);
 215     if ( !s )
 216         return false;
 217
 218     if ( !s->SetBlittingFlags(DSBLIT_NOFX) )
 219         return false;
 220     if ( !s->Blit(surface->GetRaw(), NULL, 0, 0) )
 221         return false;
 222
 223     surface = s;
 224     return true;
 225 }
 226
 227 static DFBSurfacePixelFormat DepthToFormat(int depth)
 228 {
 229     switch ( depth )
 230     {
 231         case 24:
 232             return DSPF_RGB24;
 233         case 32:
 234             // NB: we treat depth=32 as requesting ARGB for consistency with
 235             //     other ports
 236             return DSPF_ARGB;
 237         default:
 238             wxFAIL_MSG( "unsupported depth requested" );
 239             // fall through
 240         case -1:
 241             return DSPF_UNKNOWN;
 242     }
 243 }
 244
 245 //-----------------------------------------------------------------------------
 246 // wxBitmapRefData
 247 //-----------------------------------------------------------------------------
 248
 249 class wxBitmapRefData: public wxObjectRefData
 250 {
 251 public:
 252     wxBitmapRefData()
 253     {
 254         m_mask = NULL;
 255 #if wxUSE_PALETTE
 256         m_palette = NULL;
 257 #endif
 258     }
 259
 260     wxBitmapRefData(const wxBitmapRefData& data)
 261     {
 262         m_surface = data.m_surface ? data.m_surface->Clone() : NULL;
 263
 264         m_mask = data.m_mask ? new wxMask(*data.m_mask) : NULL;
 265 #if wxUSE_PALETTE
 266         m_palette = data.m_palette ? new wxPalette(*data.m_palette) : NULL;
 267 #endif
 268     }
 269
 270     virtual ~wxBitmapRefData()
 271     {
 272         delete m_mask;
 273 #if wxUSE_PALETTE
 274         delete m_palette;
 275 #endif
 276     }
 277
 278     wxIDirectFBSurfacePtr m_surface;
 279     wxMask               *m_mask;
 280 #if wxUSE_PALETTE
 281     wxPalette            *m_palette;
 282 #endif
 283 };
 284
 285 #define M_BITMAP ((wxBitmapRefData *)m_refData)
 286
 287 //-----------------------------------------------------------------------------
 288 // wxBitmap
 289 //-----------------------------------------------------------------------------
 290
 291 IMPLEMENT_ABSTRACT_CLASS(wxBitmapHandler, wxBitmapHandlerBase)
 292 IMPLEMENT_DYNAMIC_CLASS(wxBitmap, wxBitmapBase)
 293
 294 wxBitmap::wxBitmap(int width, int height, int depth)
 295 {
 296     Create(width, height, depth);
 297 }
 298
 299 bool wxBitmap::Create(const wxIDirectFBSurfacePtr& surface)
 300 {
 301     UnRef();
 302
 303     wxCHECK_MSG( surface, false, "invalid surface" );
 304
 305     m_refData = new wxBitmapRefData();
 306     M_BITMAP->m_surface = surface;
 307     return true;
 308 }
 309
 310 bool wxBitmap::Create(int width, int height, int depth)
 311 {
 312     return CreateWithFormat(width, height, DepthToFormat(depth));
 313 }
 314
 315 bool wxBitmap::CreateWithFormat(int width, int height, int dfbFormat)
 316 {
 317     UnRef();
 318
 319     wxCHECK_MSG( width > 0 && height > 0, false, wxT("invalid bitmap size") );
 320
 321     return Create(CreateSurfaceWithFormat(width, height,
 322                                           DFBSurfacePixelFormat(dfbFormat)));
 323 }
 324
 325 #if wxUSE_IMAGE
 326 wxBitmap::wxBitmap(const wxImage& image, int depth)
 327 {
 328     wxCHECK_RET( image.Ok(), wxT("invalid image") );
 329
 330     DFBSurfacePixelFormat format = DepthToFormat(depth);
 331     if ( format == DSPF_UNKNOWN && image.HasAlpha() )
 332         format = DSPF_ARGB;
 333
 334     // create surface in screen's format (unless we need alpha channel,
 335     // in which case use ARGB):
 336     if ( !CreateWithFormat(image.GetWidth(), image.GetHeight(), format) )
 337         return;
 338
 339     // then copy the image to it:
 340     wxIDirectFBSurfacePtr dst = M_BITMAP->m_surface;
 341
 342     switch ( dst->GetPixelFormat() )
 343     {
 344         case DSPF_RGB24:
 345         case DSPF_RGB32:
 346         case DSPF_ARGB:
 347             CopyImageToSurface(image, dst);
 348             break;
 349
 350         default:
 351         {
 352             // wxBitmap uses different pixel format, so we have to use a
 353             // temporary surface and blit to the bitmap via it:
 354             wxIDirectFBSurfacePtr src(CreateSurfaceForImage(image));
 355             CopyImageToSurface(image, src);
 356
 357             if ( !dst->SetBlittingFlags(DSBLIT_NOFX) )
 358                 return;
 359             if ( !dst->Blit(src->GetRaw(), NULL, 0, 0) )
 360                 return;
 361         }
 362     }
 363
 364     // FIXME: implement mask creation from image's mask (or alpha channel?)
 365     wxASSERT_MSG( !image.HasMask(), "image masks are ignored for now" );
 366 }
 367
 368 wxImage wxBitmap::ConvertToImage() const
 369 {
 370     wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
 371
 372     wxImage img(GetWidth(), GetHeight());
 373     wxIDirectFBSurfacePtr src = M_BITMAP->m_surface;
 374
 375     switch ( src->GetPixelFormat() )
 376     {
 377         case DSPF_RGB24:
 378         case DSPF_RGB32:
 379         case DSPF_ARGB:
 380             CopySurfaceToImage(src, img);
 381             break;
 382         default:
 383         {
 384             // wxBitmap uses different pixel format, so we have to use a
 385             // temporary surface and blit to the bitmap via it:
 386             wxIDirectFBSurfacePtr dst(CreateSurfaceForImage(img));
 387
 388             if ( !dst->SetBlittingFlags(DSBLIT_NOFX) )
 389                 return wxNullImage;
 390             if ( !dst->Blit(src->GetRaw(), NULL, 0, 0) )
 391                 return wxNullImage;
 392
 393             CopySurfaceToImage(dst, img);
 394         }
 395     }
 396
 397     // FIXME: implement mask setting in the image
 398     wxASSERT_MSG( GetMask() == NULL, "bitmap masks are ignored for now" );
 399
 400     return img;
 401 }
 402 #endif // wxUSE_IMAGE
 403
 404 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
 405 {
 406     wxCHECK_MSG( Ok(), NULL, "invalid bitmap" );
 407
 408     AllocExclusive();
 409
 410     DFBSurfacePixelFormat format;
 411     if ( bpp == 32 )
 412         format = DSPF_ARGB;
 413     else
 414         format = DSPF_RGB24;
 415
 416     // convert the bitmap into format compatible with requested raw access;
 417     // note that we don't bother converting the bitmap back in UngetRawData(),
 418     // as unpacked formats (RGB24, RGB32) are the common case and converting
 419     // between them while blitting is fast enough (FIXME?)
 420     if ( !ConvertSurfaceToFormat(M_BITMAP->m_surface, format) )
 421         return NULL;
 422
 423     void *bits = NULL;
 424     if ( !M_BITMAP->m_surface->Lock
 425                                (
 426                                  (DFBSurfaceLockFlags)(DSLF_READ | DSLF_WRITE),
 427                                  &bits,
 428                                  &data.m_stride
 429                                ) )
 430         return NULL;
 431
 432     M_BITMAP->m_surface->GetSize(&data.m_width, &data.m_height);
 433
 434     return bits;
 435 }
 436
 437 void wxBitmap::UngetRawData(wxPixelDataBase& WXUNUSED(data))
 438 {
 439     M_BITMAP->m_surface->Unlock();
 440 }
 441
 442 bool wxBitmap::HasAlpha() const
 443 {
 444     wxCHECK_MSG( Ok(), false, "invalid bitmap" );
 445
 446     return M_BITMAP->m_surface->GetPixelFormat() == DSPF_ARGB;
 447 }
 448
 449 wxBitmap::wxBitmap(const wxString &filename, wxBitmapType type)
 450 {
 451     LoadFile(filename, type);
 452 }
 453
 454 wxBitmap::wxBitmap(const char bits[], int width, int height, int depth)
 455 {
 456     wxCHECK_RET( depth == 1, wxT("can only create mono bitmap from XBM data") );
 457
 458     wxFAIL_MSG( "not implemented" );
 459 }
 460
 461 bool wxBitmap::IsOk() const
 462 {
 463     return (m_refData != NULL && M_BITMAP->m_surface);
 464 }
 465
 466 int wxBitmap::GetHeight() const
 467 {
 468     wxCHECK_MSG( Ok(), -1, wxT("invalid bitmap") );
 469
 470     int h = -1;
 471     M_BITMAP->m_surface->GetSize(NULL, &h);
 472     return h;
 473 }
 474
 475 int wxBitmap::GetWidth() const
 476 {
 477     wxCHECK_MSG( Ok(), -1, wxT("invalid bitmap") );
 478
 479     int w = -1;
 480     M_BITMAP->m_surface->GetSize(&w, NULL);
 481     return w;
 482 }
 483
 484 int wxBitmap::GetDepth() const
 485 {
 486     wxCHECK_MSG( Ok(), -1, wxT("invalid bitmap") );
 487
 488     return M_BITMAP->m_surface->GetDepth();
 489 }
 490
 491 wxMask *wxBitmap::GetMask() const
 492 {
 493     wxCHECK_MSG( Ok(), NULL, wxT("invalid bitmap") );
 494
 495     return M_BITMAP->m_mask;
 496 }
 497
 498 void wxBitmap::SetMask(wxMask *mask)
 499 {
 500     wxCHECK_RET( Ok(), wxT("invalid bitmap") );
 501
 502     AllocExclusive();
 503     delete M_BITMAP->m_mask;
 504     M_BITMAP->m_mask = mask;
 505 }
 506
 507 bool wxBitmap::CopyFromIcon(const wxIcon& icon)
 508 {
 509     *this = *((wxBitmap*)(&icon));
 510     return true;
 511 }
 512
 513 wxBitmap wxBitmap::GetSubBitmap(const wxRect& rect) const
 514 {
 515     wxCHECK_MSG( Ok() &&
 516                  rect.x >= 0 && rect.y >= 0 &&
 517                  rect.x+rect.width <= GetWidth() &&
 518                  rect.y+rect.height <= GetHeight(),
 519                  wxNullBitmap,
 520                  wxT("invalid bitmap or bitmap region") );
 521
 522     // NB: DirectFB subsurfaces share the same pixels buffer, so we must
 523     //     clone the obtained subsurface
 524     DFBRectangle r = { rect.x, rect.y, rect.width, rect.height };
 525     return wxBitmap(M_BITMAP->m_surface->GetSubSurface(&r)->Clone());
 526 }
 527
 528 #warning "to common code"
 529 bool wxBitmap::LoadFile(const wxString &name, wxBitmapType type)
 530 {
 531     UnRef();
 532
 533     wxBitmapHandler *handler = FindHandler(type);
 534
 535     if ( handler == NULL )
 536     {
 537         wxImage image;
 538         if ( !image.LoadFile(name, type) || !image.Ok() )
 539         {
 540             wxLogError(_("No bitmap handler for type %d defined."), type);
 541             return false;
 542         }
 543         else
 544         {
 545             *this = wxBitmap(image);
 546             return true;
 547         }
 548     }
 549
 550     m_refData = new wxBitmapRefData();
 551
 552     return handler->LoadFile(this, name, type, -1, -1);
 553 }
 554
 555 #warning "to common code"
 556 bool wxBitmap::SaveFile(const wxString& filename, wxBitmapType type, const wxPalette *palette) const
 557 {
 558     wxCHECK_MSG( Ok(), false, wxT("invalid bitmap") );
 559
 560     wxBitmapHandler *handler = FindHandler(type);
 561
 562     if ( handler == NULL )
 563     {
 564         wxImage image = ConvertToImage();
 565 #if wxUSE_PALETTE
 566         if ( palette )
 567             image.SetPalette(*palette);
 568 #endif // wxUSE_PALETTE
 569
 570         if ( image.Ok() )
 571             return image.SaveFile(filename, type);
 572         else
 573         {
 574             wxLogError(_("No bitmap handler for type %d defined."), type);
 575             return false;
 576         }
 577     }
 578
 579     return handler->SaveFile(this, filename, type, palette);
 580 }
 581
 582 #if wxUSE_PALETTE
 583 wxPalette *wxBitmap::GetPalette() const
 584 {
 585     wxCHECK_MSG( Ok(), NULL, wxT("invalid bitmap") );
 586
 587     return M_BITMAP->m_palette;
 588 }
 589
 590 void wxBitmap::SetPalette(const wxPalette& palette)
 591 {
 592     wxCHECK_RET( Ok(), wxT("invalid bitmap") );
 593     wxCHECK_RET( GetDepth() > 1 && GetDepth() <= 8, wxT("cannot set palette for bitmap of this depth") );
 594
 595     AllocExclusive();
 596     delete M_BITMAP->m_palette;
 597     M_BITMAP->m_palette = NULL;
 598
 599     if ( !palette.Ok() ) return;
 600
 601     M_BITMAP->m_palette = new wxPalette(palette);
 602 }
 603 #endif // wxUSE_PALETTE
 604
 605 void wxBitmap::SetHeight(int height)
 606 {
 607     AllocExclusive();
 608
 609     wxFAIL_MSG( "SetHeight not implemented" );
 610 }
 611
 612 void wxBitmap::SetWidth(int width)
 613 {
 614     AllocExclusive();
 615
 616     wxFAIL_MSG( "SetWidth not implemented" );
 617 }
 618
 619 void wxBitmap::SetDepth(int depth)
 620 {
 621     DFBSurfacePixelFormat format = DepthToFormat(depth);
 622     if ( M_BITMAP->m_surface->GetPixelFormat() == format )
 623         return;
 624
 625     AllocExclusive();
 626
 627     int w, h;
 628     M_BITMAP->m_surface->GetSize(&w, &h);
 629     wxIDirectFBSurfacePtr s = CreateSurfaceWithFormat(w, h, format);
 630     if ( !s )
 631         return;
 632     if ( !s->SetBlittingFlags(DSBLIT_NOFX) )
 633         return;
 634     if ( !s->Blit(M_BITMAP->m_surface->GetRaw(), NULL, 0, 0) )
 635         return;
 636
 637     M_BITMAP->m_surface = s;
 638 }
 639
 640 wxIDirectFBSurfacePtr wxBitmap::GetDirectFBSurface() const
 641 {
 642     wxCHECK_MSG( Ok(), NULL, wxT("invalid bitmap") );
 643
 644     return M_BITMAP->m_surface;
 645 }
 646
 647 wxObjectRefData *wxBitmap::CreateRefData() const
 648 {
 649     return new wxBitmapRefData;
 650 }
 651
 652 wxObjectRefData *wxBitmap::CloneRefData(const wxObjectRefData *data) const
 653 {
 654     return new wxBitmapRefData(*(wxBitmapRefData *)data);
 655 }
 656
 657
 658 /*static*/
 659 void wxBitmap::InitStandardHandlers()
 660 {
 661     // not wxBitmap handlers, we rely on wxImage
 662 }