include/wx/mediactrl.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mediactrl.h
   3 // Purpose:     wxMediaCtrl class
   4 // Author:      Ryan Norton <wxprojects@comcast.net>
   5 // Modified by:
   6 // Created:     11/07/04
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Ryan Norton
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // Definitions
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // Header guard
  18 // ----------------------------------------------------------------------------
  19 #ifndef _WX_MEDIACTRL_H_
  20 #define _WX_MEDIACTRL_H_
  21
  22 // ----------------------------------------------------------------------------
  23 // Pre-compiled header stuff
  24 // ----------------------------------------------------------------------------
  25 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  26 #pragma interface "mediactrl.h"
  27 #endif
  28
  29 // ----------------------------------------------------------------------------
  30 // Compilation guard
  31 // ----------------------------------------------------------------------------
  32 #if wxUSE_MEDIACTRL
  33
  34 // ----------------------------------------------------------------------------
  35 // Includes
  36 // ----------------------------------------------------------------------------
  37
  38 #include "wx/control.h"
  39 #include "wx/uri.h"
  40
  41 // ============================================================================
  42 // Declarations
  43 // ============================================================================
  44
  45 // ----------------------------------------------------------------------------
  46 //
  47 // Enumerations
  48 //
  49 // ----------------------------------------------------------------------------
  50
  51 enum wxMediaState
  52 {
  53     wxMEDIASTATE_STOPPED,
  54     wxMEDIASTATE_PAUSED,
  55     wxMEDIASTATE_PLAYING
  56 };
  57
  58 #define wxMEDIABACKEND_DIRECTSHOW   wxT("wxAMMediaBackend")
  59 #define wxMEDIABACKEND_MCI          wxT("wxMCIMediaBackend")
  60 #define wxMEDIABACKEND_QUICKTIME    wxT("wxQTMediaBackend")
  61
  62 // ----------------------------------------------------------------------------
  63 //
  64 // wxMediaEvent
  65 //
  66 // ----------------------------------------------------------------------------
  67
  68 class WXDLLIMPEXP_MEDIA wxMediaEvent : public wxNotifyEvent
  69 {
  70 public:
  71     // ------------------------------------------------------------------------
  72     // wxMediaEvent Constructor
  73     //
  74     // Normal constructor, much the same as wxNotifyEvent
  75     // ------------------------------------------------------------------------
  76     wxMediaEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
  77         : wxNotifyEvent(commandType, winid)
  78     {                                       }
  79
  80     // ------------------------------------------------------------------------
  81     // wxMediaEvent Copy Constructor
  82     //
  83     // Normal copy constructor, much the same as wxNotifyEvent
  84     // ------------------------------------------------------------------------
  85     wxMediaEvent(const wxMediaEvent &clone)
  86             : wxNotifyEvent(clone)
  87     {                                       }
  88
  89     // ------------------------------------------------------------------------
  90     // wxMediaEvent::Clone
  91     //
  92     // Allocates a copy of this object.
  93     // Required for wxEvtHandler::AddPendingEvent
  94     // ------------------------------------------------------------------------
  95     virtual wxEvent *Clone() const
  96     {   return new wxMediaEvent(*this);     }
  97
  98
  99     // Put this class on wxWidget's RTTI table
 100     DECLARE_DYNAMIC_CLASS(wxMediaEvent)
 101 };
 102
 103 // ----------------------------------------------------------------------------
 104 //
 105 // wxMediaCtrl
 106 //
 107 // ----------------------------------------------------------------------------
 108
 109 class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl
 110 {
 111 public:
 112     wxMediaCtrl() : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
 113     {                                                                   }
 114
 115     wxMediaCtrl(wxWindow* parent, wxWindowID winid,
 116                 const wxString& fileName = wxT(""),
 117                 const wxPoint& pos = wxDefaultPosition,
 118                 const wxSize& size = wxDefaultSize,
 119                 long style = 0,
 120                 const wxString& szBackend = wxT(""),
 121                 const wxValidator& validator = wxDefaultValidator,
 122                 const wxString& name = wxT("mediaCtrl"))
 123                 : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
 124     {   Create(parent, winid, fileName, pos, size, style,
 125                szBackend, validator, name);                             }
 126
 127     wxMediaCtrl(wxWindow* parent, wxWindowID winid,
 128                 const wxURI& location,
 129                 const wxPoint& pos = wxDefaultPosition,
 130                 const wxSize& size = wxDefaultSize,
 131                 long style = 0,
 132                 const wxString& szBackend = wxT(""),
 133                 const wxValidator& validator = wxDefaultValidator,
 134                 const wxString& name = wxT("mediaCtrl"))
 135                 : m_imp(NULL), m_bLoop(false)
 136     {   Create(parent, winid, location, pos, size, style,
 137                szBackend, validator, name);                             }
 138
 139     ~wxMediaCtrl();
 140
 141     bool Create(wxWindow* parent, wxWindowID winid,
 142                 const wxString& fileName = wxT(""),
 143                 const wxPoint& pos = wxDefaultPosition,
 144                 const wxSize& size = wxDefaultSize,
 145                 long style = 0,
 146                 const wxString& szBackend = wxT(""),
 147                 const wxValidator& validator = wxDefaultValidator,
 148                 const wxString& name = wxT("mediaCtrl"));
 149
 150     bool Create(wxWindow* parent, wxWindowID winid,
 151                 const wxURI& location,
 152                 const wxPoint& pos = wxDefaultPosition,
 153                 const wxSize& size = wxDefaultSize,
 154                 long style = 0,
 155                 const wxString& szBackend = wxT(""),
 156                 const wxValidator& validator = wxDefaultValidator,
 157                 const wxString& name = wxT("mediaCtrl")); //DirectShow only
 158
 159     bool DoCreate(wxClassInfo* instance,
 160                 wxWindow* parent, wxWindowID winid,
 161                 const wxPoint& pos = wxDefaultPosition,
 162                 const wxSize& size = wxDefaultSize,
 163                 long style = 0,
 164                 const wxValidator& validator = wxDefaultValidator,
 165                 const wxString& name = wxT("mediaCtrl"));
 166
 167     bool Play();
 168     bool Pause();
 169     bool Stop();
 170
 171     bool Load(const wxString& fileName);
 172     bool Load(const wxURI& location); //DirectShow only
 173
 174     void Loop(bool bLoop = true);
 175     bool IsLooped();
 176
 177     wxMediaState GetState();
 178
 179     double GetPlaybackRate();           //All but MCI
 180     bool SetPlaybackRate(double dRate); //All but MCI
 181
 182     wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
 183     wxFileOffset Tell(); //FIXME: This should be const
 184     wxFileOffset Length(); //FIXME: This should be const
 185
 186 protected:
 187     static wxClassInfo* NextBackend();
 188
 189     void OnMediaFinished(wxMediaEvent& evt);
 190     virtual void DoMoveWindow(int x, int y, int w, int h);
 191     wxSize DoGetBestSize() const;
 192
 193 #ifdef __WXMAC__
 194     friend class wxQTMediaBackend;
 195 #endif
 196 #ifdef __WXCOCOA__
 197     friend class wxQTMediaBackend;
 198 #endif
 199     class wxMediaBackend* m_imp;
 200     bool m_bLoaded;
 201     bool m_bLoop;
 202
 203     DECLARE_DYNAMIC_CLASS(wxMediaCtrl)
 204 };
 205
 206 // ----------------------------------------------------------------------------
 207 //
 208 // wxMediaBackend
 209 //
 210 // Currently an internal class - API stability not guaranteed.
 211 //
 212 // ----------------------------------------------------------------------------
 213
 214 class WXDLLIMPEXP_MEDIA wxMediaBackend : public wxObject
 215 {
 216 public:
 217     wxMediaBackend()
 218     {                                   }
 219
 220     virtual ~wxMediaBackend();
 221
 222     virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
 223                                wxWindow* WXUNUSED(parent),
 224                                wxWindowID WXUNUSED(winid),
 225                                const wxPoint& WXUNUSED(pos),
 226                                const wxSize& WXUNUSED(size),
 227                                long WXUNUSED(style),
 228                                const wxValidator& WXUNUSED(validator),
 229                                const wxString& WXUNUSED(name))
 230     {   return false;                   }
 231
 232     virtual bool Play()
 233     {   return false;                   }
 234     virtual bool Pause()
 235     {   return false;                   }
 236     virtual bool Stop()
 237     {   return false;                   }
 238
 239     virtual bool Load(const wxString& WXUNUSED(fileName))
 240     {   return false;                   }
 241     virtual bool Load(const wxURI& WXUNUSED(location))
 242     {   return false;                   }
 243
 244     virtual bool SetPosition(wxLongLong WXUNUSED(where))
 245     {   return 0;                       }
 246     virtual wxLongLong GetPosition()
 247     {   return 0;                       }
 248     virtual wxLongLong GetDuration()
 249     {   return 0;                       }
 250
 251     virtual void Move(int WXUNUSED(x), int WXUNUSED(y),
 252                       int WXUNUSED(w), int WXUNUSED(h))
 253     {                                   }
 254     virtual wxSize GetVideoSize() const
 255     {   return wxSize(0,0);             }
 256
 257     virtual double GetPlaybackRate()
 258     {   return 0.0;                     }
 259     virtual bool SetPlaybackRate(double WXUNUSED(dRate))
 260     {   return false;                   }
 261
 262     virtual wxMediaState GetState()
 263     {   return wxMEDIASTATE_STOPPED;    }
 264
 265     DECLARE_DYNAMIC_CLASS(wxMediaBackend)
 266 };
 267
 268 //Event ID to give to our events
 269 #define wxMEDIA_FINISHED_ID    13000
 270 #define wxMEDIA_STOP_ID    13001
 271
 272 //Define our event types - we need to call DEFINE_EVENT_TYPE(EVT) later
 273 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_FINISHED, wxMEDIA_FINISHED_ID)
 274 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_STOP,     wxMEDIA_STOP_ID)
 275
 276 //Function type(s) our events need
 277 typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
 278
 279 //Macro for usage with message maps
 280 #define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
 281 #define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
 282
 283 // ----------------------------------------------------------------------------
 284 // End compilation gaurd
 285 // ----------------------------------------------------------------------------
 286 #endif // wxUSE_MEDIACTRL
 287
 288 // ----------------------------------------------------------------------------
 289 // End header guard and header itself
 290 // ----------------------------------------------------------------------------
 291 #endif // _WX_MEDIACTRL_H_
 292
 293