src/generic/animateg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        animateg.cpp
   3 // Purpose:     wxAnimation and wxAnimationCtrl
   4 // Author:      Julian Smart and Guillermo Rodriguez Garcia
   5 // Modified by: Francesco Montorsi
   6 // Created:     13/8/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Guillermo Rodriguez Garcia
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15   #pragma hdrstop
  16 #endif  //__BORLANDC__
  17
  18 #if wxUSE_ANIMATIONCTRL && (!defined(__WXGTK20__) || defined(__WXUNIVERSAL__))
  19
  20 #include "wx/animate.h"
  21
  22 #ifndef WX_PRECOMP
  23     #include "wx/log.h"
  24     #include "wx/image.h"
  25     #include "wx/dcmemory.h"
  26     #include "wx/dcclient.h"
  27     #include "wx/module.h"
  28 #endif
  29
  30 #include "wx/wfstream.h"
  31 #include "wx/gifdecod.h"
  32 #include "wx/anidecod.h"
  33
  34 #include "wx/listimpl.cpp"
  35 WX_DEFINE_LIST(wxAnimationDecoderList)
  36
  37 wxAnimationDecoderList wxAnimation::sm_handlers;
  38
  39
  40 // ----------------------------------------------------------------------------
  41 // wxAnimation
  42 // ----------------------------------------------------------------------------
  43
  44 IMPLEMENT_DYNAMIC_CLASS(wxAnimation, wxAnimationBase)
  45 #define M_ANIMDATA      wx_static_cast(wxAnimationDecoder*, m_refData)
  46
  47 wxSize wxAnimation::GetSize() const
  48 {
  49     wxCHECK_MSG( IsOk(), wxDefaultSize, wxT("invalid animation") );
  50
  51     return M_ANIMDATA->GetAnimationSize();
  52 }
  53
  54 size_t wxAnimation::GetFrameCount() const
  55 {
  56     wxCHECK_MSG( IsOk(), 0, wxT("invalid animation") );
  57
  58     return M_ANIMDATA->GetFrameCount();
  59 }
  60
  61 wxImage wxAnimation::GetFrame(size_t i) const
  62 {
  63     wxCHECK_MSG( IsOk(), wxNullImage, wxT("invalid animation") );
  64
  65     wxImage ret;
  66     if (!M_ANIMDATA->ConvertToImage(i, &ret))
  67         return wxNullImage;
  68     return ret;
  69 }
  70
  71 int wxAnimation::GetDelay(size_t i) const
  72 {
  73     wxCHECK_MSG( IsOk(), 0, wxT("invalid animation") );
  74
  75     return M_ANIMDATA->GetDelay(i);
  76 }
  77
  78 wxPoint wxAnimation::GetFramePosition(size_t frame) const
  79 {
  80     wxCHECK_MSG( IsOk(), wxDefaultPosition, wxT("invalid animation") );
  81
  82     return M_ANIMDATA->GetFramePosition(frame);
  83 }
  84
  85 wxSize wxAnimation::GetFrameSize(size_t frame) const
  86 {
  87     wxCHECK_MSG( IsOk(), wxDefaultSize, wxT("invalid animation") );
  88
  89     return M_ANIMDATA->GetFrameSize(frame);
  90 }
  91
  92 wxAnimationDisposal wxAnimation::GetDisposalMethod(size_t frame) const
  93 {
  94     wxCHECK_MSG( IsOk(), wxANIM_UNSPECIFIED, wxT("invalid animation") );
  95
  96     return M_ANIMDATA->GetDisposalMethod(frame);
  97 }
  98
  99 wxColour wxAnimation::GetTransparentColour(size_t frame) const
 100 {
 101     wxCHECK_MSG( IsOk(), wxNullColour, wxT("invalid animation") );
 102
 103     return M_ANIMDATA->GetTransparentColour(frame);
 104 }
 105
 106 wxColour wxAnimation::GetBackgroundColour() const
 107 {
 108     wxCHECK_MSG( IsOk(), wxNullColour, wxT("invalid animation") );
 109
 110     return M_ANIMDATA->GetBackgroundColour();
 111 }
 112
 113 bool wxAnimation::LoadFile(const wxString& filename, wxAnimationType type)
 114 {
 115     wxFileInputStream stream(filename);
 116     if ( !stream.IsOk() )
 117         return false;
 118
 119     return Load(stream, type);
 120 }
 121
 122 bool wxAnimation::Load(wxInputStream &stream, wxAnimationType type)
 123 {
 124     UnRef();
 125
 126     const wxAnimationDecoder *handler;
 127     if ( type == wxANIMATION_TYPE_ANY )
 128     {
 129         for ( wxAnimationDecoderList::compatibility_iterator node = sm_handlers.GetFirst();
 130               node; node = node->GetNext() )
 131         {
 132             handler=(const wxAnimationDecoder*)node->GetData();
 133
 134             if ( handler->CanRead(stream) )
 135             {
 136                 // do a copy of the handler from the static list which we will own
 137                 // as our reference data
 138                 m_refData = handler->Clone();
 139                 return M_ANIMDATA->Load(stream);
 140             }
 141
 142         }
 143
 144         wxLogWarning( _("No handler found for animation type.") );
 145         return false;
 146     }
 147
 148     handler = FindHandler(type);
 149
 150     // do a copy of the handler from the static list which we will own
 151     // as our reference data
 152     m_refData = handler->Clone();
 153
 154     if (handler == NULL)
 155     {
 156         wxLogWarning( _("No animation handler for type %ld defined."), type );
 157
 158         return false;
 159     }
 160
 161     if (stream.IsSeekable() && !M_ANIMDATA->CanRead(stream))
 162     {
 163         wxLogError(_("Animation file is not of type %ld."), type);
 164         return false;
 165     }
 166     else
 167         return M_ANIMDATA->Load(stream);
 168 }
 169
 170
 171 // ----------------------------------------------------------------------------
 172 // animation decoders
 173 // ----------------------------------------------------------------------------
 174
 175 void wxAnimation::AddHandler( wxAnimationDecoder *handler )
 176 {
 177     // Check for an existing handler of the type being added.
 178     if (FindHandler( handler->GetType() ) == 0)
 179     {
 180         sm_handlers.Append( handler );
 181     }
 182     else
 183     {
 184         // This is not documented behaviour, merely the simplest 'fix'
 185         // for preventing duplicate additions.  If someone ever has
 186         // a good reason to add and remove duplicate handlers (and they
 187         // may) we should probably refcount the duplicates.
 188         //   also an issue in InsertHandler below.
 189
 190         wxLogDebug( _T("Adding duplicate animation handler for '%d' type"),
 191                     handler->GetType() );
 192         delete handler;
 193     }
 194 }
 195
 196 void wxAnimation::InsertHandler( wxAnimationDecoder *handler )
 197 {
 198     // Check for an existing handler of the type being added.
 199     if (FindHandler( handler->GetType() ) == 0)
 200     {
 201         sm_handlers.Insert( handler );
 202     }
 203     else
 204     {
 205         // see AddHandler for additional comments.
 206         wxLogDebug( _T("Inserting duplicate animation handler for '%d' type"),
 207                     handler->GetType() );
 208         delete handler;
 209     }
 210 }
 211
 212 const wxAnimationDecoder *wxAnimation::FindHandler( wxAnimationType animType )
 213 {
 214     wxAnimationDecoderList::compatibility_iterator node = sm_handlers.GetFirst();
 215     while (node)
 216     {
 217         const wxAnimationDecoder *handler = (const wxAnimationDecoder *)node->GetData();
 218         if (handler->GetType() == animType) return handler;
 219         node = node->GetNext();
 220     }
 221     return 0;
 222 }
 223
 224 void wxAnimation::InitStandardHandlers()
 225 {
 226 #if wxUSE_GIF
 227     AddHandler(new wxGIFDecoder);
 228 #endif // wxUSE_GIF
 229 #if wxUSE_ICO_CUR
 230     AddHandler(new wxANIDecoder);
 231 #endif // wxUSE_ICO_CUR
 232 }
 233
 234 void wxAnimation::CleanUpHandlers()
 235 {
 236     wxAnimationDecoderList::compatibility_iterator node = sm_handlers.GetFirst();
 237     while (node)
 238     {
 239         wxAnimationDecoder *handler = (wxAnimationDecoder *)node->GetData();
 240         wxAnimationDecoderList::compatibility_iterator next = node->GetNext();
 241         delete handler;
 242         node = next;
 243     }
 244
 245     sm_handlers.Clear();
 246 }
 247
 248
 249 // A module to allow wxAnimation initialization/cleanup
 250 // without calling these functions from app.cpp or from
 251 // the user's application.
 252
 253 class wxAnimationModule: public wxModule
 254 {
 255 DECLARE_DYNAMIC_CLASS(wxAnimationModule)
 256 public:
 257     wxAnimationModule() {}
 258     bool OnInit() { wxAnimation::InitStandardHandlers(); return true; };
 259     void OnExit() { wxAnimation::CleanUpHandlers(); };
 260 };
 261
 262 IMPLEMENT_DYNAMIC_CLASS(wxAnimationModule, wxModule)
 263
 264
 265 // ----------------------------------------------------------------------------
 266 // wxAnimationCtrl
 267 // ----------------------------------------------------------------------------
 268
 269 IMPLEMENT_CLASS(wxAnimationCtrl, wxAnimationCtrlBase)
 270 BEGIN_EVENT_TABLE(wxAnimationCtrl, wxAnimationCtrlBase)
 271     EVT_PAINT(wxAnimationCtrl::OnPaint)
 272     EVT_SIZE(wxAnimationCtrl::OnSize)
 273     EVT_TIMER(wxID_ANY, wxAnimationCtrl::OnTimer)
 274 END_EVENT_TABLE()
 275
 276 void wxAnimationCtrl::Init()
 277 {
 278     m_currentFrame = 0;
 279     m_looped = false;
 280     m_isPlaying = false;
 281
 282     // use the window background colour by default to be consistent
 283     // with the GTK+ native version
 284     m_useWinBackgroundColour = true;
 285 }
 286
 287 bool wxAnimationCtrl::Create(wxWindow *parent, wxWindowID id,
 288             const wxAnimation& animation, const wxPoint& pos,
 289             const wxSize& size, long style, const wxString& name)
 290 {
 291     m_animation = animation;
 292     m_timer.SetOwner(this);
 293
 294     if (!base_type::Create(parent, id, pos, size, style, wxDefaultValidator, name))
 295         return false;
 296
 297     // by default we get the same background colour of our parent
 298     SetBackgroundColour(parent->GetBackgroundColour());
 299     return true;
 300 }
 301
 302 wxAnimationCtrl::~wxAnimationCtrl()
 303 {
 304     Stop();
 305 }
 306
 307 bool wxAnimationCtrl::LoadFile(const wxString& filename, wxAnimationType type)
 308 {
 309     wxAnimation anim;
 310     if (!anim.LoadFile(filename, type) ||
 311         !anim.IsOk())
 312         return false;
 313
 314     SetAnimation(anim);
 315     return true;
 316 }
 317
 318 wxSize wxAnimationCtrl::DoGetBestSize() const
 319 {
 320     if (m_animation.IsOk() && !this->HasFlag(wxAC_NO_AUTORESIZE))
 321         return m_animation.GetSize();
 322
 323     return wxSize(100, 100);
 324 }
 325
 326 void wxAnimationCtrl::SetAnimation(const wxAnimation& animation)
 327 {
 328     if (IsPlaying())
 329         Stop();
 330
 331     m_animation = animation;
 332
 333     if (m_animation.GetBackgroundColour() == wxNullColour)
 334         SetUseWindowBackgroundColour();
 335     if (!this->HasFlag(wxAC_NO_AUTORESIZE))
 336         FitToAnimation();
 337
 338     // reset frame counter
 339     m_currentFrame = 0;
 340
 341     UpdateBackingStoreWithStaticImage();
 342 }
 343
 344 void wxAnimationCtrl::SetInactiveBitmap(const wxBitmap &bmp)
 345 {
 346     m_bmpStatic = bmp;
 347
 348     // if not playing, update the backing store now
 349     if (!IsPlaying())
 350         UpdateBackingStoreWithStaticImage();
 351 }
 352
 353 void wxAnimationCtrl::FitToAnimation()
 354 {
 355     SetSize(m_animation.GetSize());
 356 }
 357
 358
 359 // ----------------------------------------------------------------------------
 360 // wxAnimationCtrl - stop/play methods
 361 // ----------------------------------------------------------------------------
 362
 363 void wxAnimationCtrl::Stop()
 364 {
 365     m_timer.Stop();
 366     m_isPlaying = false;
 367
 368     UpdateBackingStoreWithStaticImage();
 369 }
 370
 371 bool wxAnimationCtrl::Play(bool looped)
 372 {
 373     if (!m_animation.IsOk())
 374         return false;
 375
 376     m_looped = looped;
 377     m_currentFrame = 0;
 378
 379     if (!RebuildBackingStoreUpToFrame(0))
 380         return false;
 381
 382     m_isPlaying = true;
 383
 384     // do a ClearBackground() to avoid that e.g. the custom static bitmap which
 385     // was eventually shown previously remains partially drawn
 386     ClearBackground();
 387
 388     // DrawCurrentFrame() will use our updated backing store
 389     wxClientDC clientDC(this);
 390     DrawCurrentFrame(clientDC);
 391
 392     // start the timer
 393     int delay = m_animation.GetDelay(0);
 394     if (delay == 0)
 395         delay = 1;      // 0 is invalid timeout for wxTimer.
 396     m_timer.Start(delay);
 397
 398     return true;
 399 }
 400
 401
 402
 403 // ----------------------------------------------------------------------------
 404 // wxAnimationCtrl - rendering methods
 405 // ----------------------------------------------------------------------------
 406
 407 bool wxAnimationCtrl::RebuildBackingStoreUpToFrame(size_t frame)
 408 {
 409     // if we've not created the backing store yet or it's too
 410     // small, then recreate it
 411     wxSize sz = m_animation.GetSize(),
 412            winsz = GetClientSize();
 413     int w = wxMin(sz.GetWidth(), winsz.GetWidth());
 414     int h = wxMin(sz.GetHeight(), winsz.GetHeight());
 415
 416     if ( !m_backingStore.IsOk() ||
 417             m_backingStore.GetWidth() < w || m_backingStore.GetHeight() < h )
 418     {
 419         if (!m_backingStore.Create(w, h))
 420             return false;
 421     }
 422
 423     wxMemoryDC dc;
 424     dc.SelectObject(m_backingStore);
 425
 426     // Draw the background
 427     DisposeToBackground(dc);
 428
 429     // Draw all intermediate frames that haven't been removed from the animation
 430     for (size_t i = 0; i < frame; i++)
 431     {
 432         if (m_animation.GetDisposalMethod(i) == wxANIM_DONOTREMOVE ||
 433             m_animation.GetDisposalMethod(i) == wxANIM_UNSPECIFIED)
 434         {
 435             DrawFrame(dc, i);
 436         }
 437         else if (m_animation.GetDisposalMethod(i) == wxANIM_TOBACKGROUND)
 438             DisposeToBackground(dc, m_animation.GetFramePosition(i),
 439                                     m_animation.GetFrameSize(i));
 440     }
 441
 442     // finally draw this frame
 443     DrawFrame(dc, frame);
 444     dc.SelectObject(wxNullBitmap);
 445
 446     return true;
 447 }
 448
 449 void wxAnimationCtrl::IncrementalUpdateBackingStore()
 450 {
 451     wxMemoryDC dc;
 452     dc.SelectObject(m_backingStore);
 453
 454     // OPTIMIZATION:
 455     // since wxAnimationCtrl can only play animations forward, without skipping
 456     // frames, we can be sure that m_backingStore contains the m_currentFrame-1
 457     // frame and thus we just need to dispose the m_currentFrame-1 frame and
 458     // render the m_currentFrame-th one.
 459
 460     if (m_currentFrame == 0)
 461     {
 462         // before drawing the first frame always dispose to bg colour
 463         DisposeToBackground(dc);
 464     }
 465     else
 466     {
 467         switch (m_animation.GetDisposalMethod(m_currentFrame-1))
 468         {
 469         case wxANIM_TOBACKGROUND:
 470             DisposeToBackground(dc, m_animation.GetFramePosition(m_currentFrame-1),
 471                                     m_animation.GetFrameSize(m_currentFrame-1));
 472             break;
 473
 474         case wxANIM_TOPREVIOUS:
 475             // this disposal should never be used too often.
 476             // E.g. GIF specification explicitely say to keep the usage of this
 477             //      disposal limited to the minimum.
 478             // In fact it may require a lot of time to restore
 479             if (m_currentFrame == 1)
 480             {
 481                 // if 0-th frame disposal is to restore to previous frame,
 482                 // the best we can do is to restore to background
 483                 DisposeToBackground(dc);
 484             }
 485             else
 486                 if (!RebuildBackingStoreUpToFrame(m_currentFrame-2))
 487                     Stop();
 488             break;
 489
 490         case wxANIM_DONOTREMOVE:
 491         case wxANIM_UNSPECIFIED:
 492             break;
 493         }
 494     }
 495
 496     // now just draw the current frame on the top of the backing store
 497     DrawFrame(dc, m_currentFrame);
 498     dc.SelectObject(wxNullBitmap);
 499 }
 500
 501 void wxAnimationCtrl::UpdateBackingStoreWithStaticImage()
 502 {
 503     wxASSERT(!IsPlaying());
 504
 505     if (m_bmpStatic.IsOk())
 506     {
 507         // copy the inactive bitmap in the backing store
 508         m_backingStore = m_bmpStatic;
 509     }
 510     else
 511     {
 512         // put in the backing store the first frame of the animation
 513         if (!m_animation.IsOk() ||
 514             !RebuildBackingStoreUpToFrame(0))
 515         {
 516             m_animation = wxNullAnimation;
 517             DisposeToBackground();
 518         }
 519     }
 520
 521     Refresh();
 522 }
 523
 524 void wxAnimationCtrl::DrawFrame(wxDC &dc, size_t frame)
 525 {
 526     // PERFORMANCE NOTE:
 527     // this draw stuff is not as fast as possible: the wxAnimationDecoder
 528     // needs first to convert from its internal format to wxImage RGB24;
 529     // the wxImage is then converted as a wxBitmap and finally blitted.
 530     // If wxAnimationDecoder had a function to convert directly from its
 531     // internal format to a port-specific wxBitmap, it would be somewhat faster.
 532     wxBitmap bmp(m_animation.GetFrame(frame));
 533     dc.DrawBitmap(bmp, m_animation.GetFramePosition(frame),
 534                   true /* use mask */);
 535 }
 536
 537 void wxAnimationCtrl::DrawCurrentFrame(wxDC& dc)
 538 {
 539     wxASSERT( m_backingStore.IsOk() );
 540
 541     // m_backingStore always contains the current frame
 542     dc.DrawBitmap(m_backingStore, 0, 0, true /* use mask in case it's present */);
 543 }
 544
 545 void wxAnimationCtrl::DisposeToBackground()
 546 {
 547     // clear the backing store
 548     wxMemoryDC dc;
 549     dc.SelectObject(m_backingStore);
 550     DisposeToBackground(dc);
 551 }
 552
 553 void wxAnimationCtrl::DisposeToBackground(wxDC& dc)
 554 {
 555     wxColour col = IsUsingWindowBackgroundColour()
 556                     ? GetBackgroundColour()
 557                     : m_animation.GetBackgroundColour();
 558     wxBrush brush(col);
 559     dc.SetBackground(brush);
 560     dc.Clear();
 561 }
 562
 563 void wxAnimationCtrl::DisposeToBackground(wxDC& dc, const wxPoint &pos, const wxSize &sz)
 564 {
 565     wxColour col = IsUsingWindowBackgroundColour()
 566                     ? GetBackgroundColour()
 567                     : m_animation.GetBackgroundColour();
 568     wxBrush brush(col);
 569     dc.SetBrush(brush);         // SetBrush and not SetBackground !!
 570     dc.SetPen(*wxTRANSPARENT_PEN);
 571     dc.DrawRectangle(pos, sz);
 572 }
 573
 574 // ----------------------------------------------------------------------------
 575 // wxAnimationCtrl - event handlers
 576 // ----------------------------------------------------------------------------
 577
 578 void wxAnimationCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 579 {
 580     // VERY IMPORTANT: the wxPaintDC *must* be created in any case
 581     wxPaintDC dc(this);
 582
 583     if ( m_backingStore.IsOk() )
 584         DrawCurrentFrame(dc);
 585     else
 586     {
 587         // m_animation is not valid and thus we don't have a valid backing store...
 588         // clear then our area to the background colour
 589         DisposeToBackground(dc);
 590     }
 591 }
 592
 593 void wxAnimationCtrl::OnTimer(wxTimerEvent &WXUNUSED(event))
 594 {
 595     m_currentFrame++;
 596     if (m_currentFrame == m_animation.GetFrameCount())
 597     {
 598         // Should a non-looped animation display the last frame?
 599         if (!m_looped)
 600         {
 601             Stop();
 602             return;
 603         }
 604         else
 605             m_currentFrame = 0;     // let's restart
 606     }
 607
 608     IncrementalUpdateBackingStore();
 609
 610     wxClientDC dc(this);
 611     DrawCurrentFrame(dc);
 612
 613 #ifdef __WXMAC__
 614     // without this, the animation currently doesn't redraw under Mac
 615     Refresh();
 616 #endif // __WXMAC__
 617
 618     // Set the timer for the next frame
 619     int delay = m_animation.GetDelay(m_currentFrame);
 620     if (delay == 0)
 621         delay = 1;      // 0 is invalid timeout for wxTimer.
 622     m_timer.Start(delay);
 623 }
 624
 625 void wxAnimationCtrl::OnSize(wxSizeEvent &WXUNUSED(event))
 626 {
 627     // NB: resizing an animation control may take a lot of time
 628     //     for big animations as the backing store must be
 629     //     extended and rebuilt. Try to avoid it e.g. using
 630     //     a null proportion value for your wxAnimationCtrls
 631     //     when using them inside sizers.
 632     if (m_animation.IsOk())
 633     {
 634         // be careful to change the backing store *only* if we are
 635         // playing the animation as otherwise we may be displaying
 636         // the inactive bitmap and overwriting the backing store
 637         // with the last played frame is wrong in this case
 638         if (IsPlaying())
 639         {
 640         if (!RebuildBackingStoreUpToFrame(m_currentFrame))
 641             Stop();     // in case we are playing
 642         }
 643     }
 644 }
 645
 646 #endif      // wxUSE_ANIMATIONCTRL
 647