include/wx/sound.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/sound.h
   3 // Purpose:     wxSoundBase class
   4 // Author:      Vaclav Slavik
   5 // Modified by:
   6 // Created:     2004/02/01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2004, Vaclav Slavik
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SOUND_H_BASE_
  13 #define _WX_SOUND_H_BASE_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "soundbase.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_SOUND
  22
  23 #include "wx/object.h"
  24
  25 // ----------------------------------------------------------------------------
  26 // wxSoundBase: common wxSound code and interface
  27 // ----------------------------------------------------------------------------
  28
  29 // Flags for wxSound::Play
  30 #if WXWIN_COMPATIBILITY_2_4
  31     // NB: we can't use enum because there would be ambiguity between the
  32     //     two Play() prototypes when called without explicit parameters
  33     #define wxSOUND_SYNC  ((unsigned)0)
  34     #define wxSOUND_ASYNC ((unsigned)1)
  35     #define wxSOUND_LOOP  ((unsigned)2)
  36 #else
  37     enum wxSoundFlags
  38     {
  39         wxSOUND_SYNC   = 0,
  40         wxSOUND_ASYNC  = 1,
  41         wxSOUND_LOOP   = 2
  42     };
  43 #endif
  44
  45 // Base class for wxSound implementations
  46 class WXDLLIMPEXP_ADV wxSoundBase : public wxObject
  47 {
  48 public:
  49     // Play the sound:
  50     bool Play(unsigned flags = wxSOUND_ASYNC) const
  51     {
  52         wxASSERT_MSG( (flags & wxSOUND_LOOP) == 0 ||
  53                       (flags & wxSOUND_ASYNC) != 0,
  54                      _T("sound can only be looped asynchronously") );
  55         return DoPlay(flags);
  56     }
  57 #if WXWIN_COMPATIBILITY_2_4
  58     wxDEPRECATED( bool Play(bool async, bool looped = false) const );
  59 #endif
  60
  61     // Plays sound from filename:
  62     static bool Play(const wxString& filename, unsigned flags = wxSOUND_ASYNC);
  63
  64 protected:
  65     virtual bool DoPlay(unsigned flags) const = 0;
  66 };
  67
  68 // ----------------------------------------------------------------------------
  69 // wxSound class implementation
  70 // ----------------------------------------------------------------------------
  71
  72 #if defined(__WXMSW__)
  73     #include "wx/msw/sound.h"
  74 #elif defined(__WXMAC__)
  75     #include "wx/mac/sound.h"
  76 #elif defined(__WXPM__)
  77     #include "wx/os2/sound.h"
  78 #elif defined(__UNIX__)
  79     #include "wx/unix/sound.h"
  80 #endif
  81
  82 // ----------------------------------------------------------------------------
  83 // wxSoundBase methods
  84 // ----------------------------------------------------------------------------
  85
  86 inline bool wxSoundBase::Play(const wxString& filename, unsigned flags)
  87 {
  88     wxSound snd(filename);
  89     return snd.IsOk() ? snd.Play(flags) : false;
  90 }
  91
  92 #if WXWIN_COMPATIBILITY_2_4
  93 inline bool wxSoundBase::Play(bool async, bool looped) const
  94 {
  95     unsigned flags = 0;
  96     if (async) flags |= wxSOUND_ASYNC;
  97     if (looped) flags |= wxSOUND_LOOP | wxSOUND_ASYNC;
  98     return DoPlay(flags);
  99 }
 100 #endif
 101
 102 #endif // wxUSE_SOUND
 103
 104 #endif // _WX_SOUND_H_BASE_