// Name: wx/mediactrl.h
// Purpose: wxMediaCtrl class
// Author: Ryan Norton <wxprojects@comcast.net>
-// Modified by:
+// Modified by:
// Created: 11/07/04
// RCS-ID: $Id$
// Copyright: (c) Ryan Norton
// ----------------------------------------------------------------------------
// Pre-compiled header stuff
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "mediactrl.h"
-#endif
+
+#include "wx/defs.h"
// ----------------------------------------------------------------------------
// Compilation guard
// ----------------------------------------------------------------------------
+
#if wxUSE_MEDIACTRL
// ----------------------------------------------------------------------------
wxMEDIASTATE_PLAYING
};
-enum wxMediaTimeFormat
+enum wxMediaCtrlPlayerControls
{
- wxMEDIATIMEFORMAT_TIME
+ wxMEDIACTRLPLAYERCONTROLS_NONE = 0,
+ //Step controls like fastfoward, step one frame etc.
+ wxMEDIACTRLPLAYERCONTROLS_STEP = 1 << 0,
+ //Volume controls like the speaker icon, volume slider, etc.
+ wxMEDIACTRLPLAYERCONTROLS_VOLUME = 1 << 1,
+ wxMEDIACTRLPLAYERCONTROLS_DEFAULT =
+ wxMEDIACTRLPLAYERCONTROLS_STEP |
+ wxMEDIACTRLPLAYERCONTROLS_VOLUME
};
#define wxMEDIABACKEND_DIRECTSHOW wxT("wxAMMediaBackend")
#define wxMEDIABACKEND_MCI wxT("wxMCIMediaBackend")
#define wxMEDIABACKEND_QUICKTIME wxT("wxQTMediaBackend")
+#define wxMEDIABACKEND_GSTREAMER wxT("wxGStreamerMediaBackend")
+#define wxMEDIABACKEND_REALPLAYER wxT("wxRealPlayerMediaBackend")
+#define wxMEDIABACKEND_WMP10 wxT("wxWMP10MediaBackend")
+
+// ----------------------------------------------------------------------------
+//
+// wxMediaEvent
+//
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_MEDIA wxMediaEvent : public wxNotifyEvent
+{
+public:
+ // ------------------------------------------------------------------------
+ // wxMediaEvent Constructor
+ //
+ // Normal constructor, much the same as wxNotifyEvent
+ // ------------------------------------------------------------------------
+ wxMediaEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
+ : wxNotifyEvent(commandType, winid)
+ { }
+
+ // ------------------------------------------------------------------------
+ // wxMediaEvent Copy Constructor
+ //
+ // Normal copy constructor, much the same as wxNotifyEvent
+ // ------------------------------------------------------------------------
+ wxMediaEvent(const wxMediaEvent &clone)
+ : wxNotifyEvent(clone)
+ { }
+
+ // ------------------------------------------------------------------------
+ // wxMediaEvent::Clone
+ //
+ // Allocates a copy of this object.
+ // Required for wxEvtHandler::AddPendingEvent
+ // ------------------------------------------------------------------------
+ virtual wxEvent *Clone() const
+ { return new wxMediaEvent(*this); }
+
+
+ // Put this class on wxWidget's RTTI table
+ DECLARE_DYNAMIC_CLASS(wxMediaEvent)
+};
// ----------------------------------------------------------------------------
//
//
// ----------------------------------------------------------------------------
-class wxMediaCtrl : public wxControl
+class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl
{
public:
- wxMediaCtrl() : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
+ wxMediaCtrl() : m_imp(NULL), m_bLoaded(false)
{ }
- wxMediaCtrl(wxWindow* parent, wxWindowID id,
- const wxString& fileName = wxT(""),
- const wxPoint& pos = wxDefaultPosition,
+ wxMediaCtrl(wxWindow* parent, wxWindowID winid,
+ const wxString& fileName = wxEmptyString,
+ const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& szBackend = wxT(""),
+ long style = 0,
+ const wxString& szBackend = wxEmptyString,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxT("mediaCtrl"))
- : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
- { Create(parent, id, fileName, pos, size, style,
+ : m_imp(NULL), m_bLoaded(false)
+ { Create(parent, winid, fileName, pos, size, style,
szBackend, validator, name); }
- wxMediaCtrl(wxWindow* parent, wxWindowID id,
+ wxMediaCtrl(wxWindow* parent, wxWindowID winid,
const wxURI& location,
- const wxPoint& pos = wxDefaultPosition,
+ const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& szBackend = wxT(""),
+ long style = 0,
+ const wxString& szBackend = wxEmptyString,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxT("mediaCtrl"))
- : m_imp(NULL), m_bLoop(false)
- { Create(parent, id, location, pos, size, style,
+ : m_imp(NULL), m_bLoaded(false)
+ { Create(parent, winid, location, pos, size, style,
szBackend, validator, name); }
~wxMediaCtrl();
- bool Create(wxWindow* parent, wxWindowID id,
- const wxString& fileName = wxT(""),
- const wxPoint& pos = wxDefaultPosition,
+ bool Create(wxWindow* parent, wxWindowID winid,
+ const wxString& fileName = wxEmptyString,
+ const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& szBackend = wxT(""),
+ long style = 0,
+ const wxString& szBackend = wxEmptyString,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxT("mediaCtrl"));
- bool Create(wxWindow* parent, wxWindowID id,
+ bool Create(wxWindow* parent, wxWindowID winid,
const wxURI& location,
- const wxPoint& pos = wxDefaultPosition,
+ const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& szBackend = wxT(""),
+ long style = 0,
+ const wxString& szBackend = wxEmptyString,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxT("mediaCtrl"));
bool DoCreate(wxClassInfo* instance,
- wxWindow* parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
+ wxWindow* parent, wxWindowID winid,
+ const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = 0,
+ long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxT("mediaCtrl"));
- static wxClassInfo* NextBackend();
-
-
bool Play();
bool Pause();
bool Stop();
bool Load(const wxString& fileName);
+
+ wxMediaState GetState();
+
+ wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
+ wxFileOffset Tell(); //FIXME: This should be const
+ wxFileOffset Length(); //FIXME: This should be const
+
+#if wxABI_VERSION >= 20601 /* 2.6.1+ only */
+ double GetPlaybackRate(); //All but MCI & GStreamer
+ bool SetPlaybackRate(double dRate); //All but MCI & GStreamer
+#endif
+
+#if wxABI_VERSION >= 20602 /* 2.6.2+ only */
bool Load(const wxURI& location);
+ bool Load(const wxURI& location, const wxURI& proxy);
- void Loop(bool bLoop = true);
- bool IsLooped();
+ wxFileOffset GetDownloadProgress(); // DirectShow only
+ wxFileOffset GetDownloadTotal(); // DirectShow only
- wxMediaState GetState();
+ double GetVolume();
+ bool SetVolume(double dVolume);
- double GetPlaybackRate();
- bool SetPlaybackRate(double dRate);
+ bool ShowPlayerControls(
+ wxMediaCtrlPlayerControls flags = wxMEDIACTRLPLAYERCONTROLS_DEFAULT);
- bool SetPosition(wxLongLong where);
- wxLongLong GetPosition();
- wxLongLong GetDuration();
+ //helpers for the wxPython people
+ bool LoadURI(const wxString& fileName)
+ { return Load(wxURI(fileName)); }
+ bool LoadURIWithProxy(const wxString& fileName, const wxString& proxy)
+ { return Load(wxURI(fileName), wxURI(proxy)); }
+#endif
protected:
- void OnMediaFinished(const class wxMediaEvent& evt);
+ static wxClassInfo* NextBackend();
+
+ void OnMediaFinished(wxMediaEvent& evt);
virtual void DoMoveWindow(int x, int y, int w, int h);
wxSize DoGetBestSize() const;
+ //FIXME: This is nasty... find a better way to work around
+ //inheritance issues
+#if defined(__WXMAC__)
+ virtual void MacVisibilityChanged();
+#endif
+#if defined(__WXMAC__) || defined(__WXCOCOA__)
+ friend class wxQTMediaBackend;
+#endif
class wxMediaBackend* m_imp;
bool m_bLoaded;
- bool m_bLoop;
- DECLARE_DYNAMIC_CLASS(wxMediaCtrl);
+ DECLARE_DYNAMIC_CLASS(wxMediaCtrl)
};
// ----------------------------------------------------------------------------
//
// wxMediaBackend
//
-// Currently an internal class - API stability not gauranteed.
+// Derive from this and use standard wxWidgets RTTI
+// (DECLARE_DYNAMIC_CLASS and IMPLEMENT_CLASS) to make a backend
+// for wxMediaCtrl. Backends are searched alphabetically -
+// the one with the earliest letter is tried first.
+//
+// Note that this is currently not API or ABI compatable -
+// so statically link or make the client compile on-site.
//
// ----------------------------------------------------------------------------
-class wxMediaBackend : public wxObject
+class WXDLLIMPEXP_MEDIA wxMediaBackend : public wxObject
{
public:
wxMediaBackend()
virtual ~wxMediaBackend();
- virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
- wxWindow* WXUNUSED(parent),
- wxWindowID WXUNUSED(id),
- const wxPoint& WXUNUSED(pos),
+ virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
+ wxWindow* WXUNUSED(parent),
+ wxWindowID WXUNUSED(winid),
+ const wxPoint& WXUNUSED(pos),
const wxSize& WXUNUSED(size),
- long WXUNUSED(style),
+ long WXUNUSED(style),
const wxValidator& WXUNUSED(validator),
const wxString& WXUNUSED(name))
{ return false; }
- virtual bool Play()
+ virtual bool Play()
{ return false; }
- virtual bool Pause()
+ virtual bool Pause()
{ return false; }
- virtual bool Stop()
+ virtual bool Stop()
{ return false; }
- virtual bool Load(const wxString& WXUNUSED(fileName))
+ virtual bool Load(const wxString& WXUNUSED(fileName))
{ return false; }
- virtual bool Load(const wxURI& WXUNUSED(location))
+ virtual bool Load(const wxURI& WXUNUSED(location))
{ return false; }
- virtual bool SetPosition(wxLongLong WXUNUSED(where))
+ virtual bool SetPosition(wxLongLong WXUNUSED(where))
{ return 0; }
- virtual wxLongLong GetPosition()
+ virtual wxLongLong GetPosition()
{ return 0; }
- virtual wxLongLong GetDuration()
+ virtual wxLongLong GetDuration()
{ return 0; }
- virtual void Move(int WXUNUSED(x), int WXUNUSED(y),
- int WXUNUSED(w), int WXUNUSED(h))
+ virtual void Move(int WXUNUSED(x), int WXUNUSED(y),
+ int WXUNUSED(w), int WXUNUSED(h))
{ }
- virtual wxSize GetVideoSize() const
+ virtual wxSize GetVideoSize() const
{ return wxSize(0,0); }
- virtual double GetPlaybackRate()
+ virtual double GetPlaybackRate()
{ return 0.0; }
- virtual bool SetPlaybackRate(double WXUNUSED(dRate))
+ virtual bool SetPlaybackRate(double WXUNUSED(dRate))
{ return false; }
virtual wxMediaState GetState()
{ return wxMEDIASTATE_STOPPED; }
- DECLARE_CLASS(wxMediaBackend)
-};
-
-// ----------------------------------------------------------------------------
-//
-// wxMediaEvent
-//
-// ----------------------------------------------------------------------------
+ virtual double GetVolume()
+ { return 0.0; }
+ virtual bool SetVolume(double WXUNUSED(dVolume))
+ { return false; }
-class WXDLLEXPORT wxMediaEvent : public wxNotifyEvent
-{
-public:
- // ------------------------------------------------------------------------
- // wxMediaEvent Constructor
- //
- // Normal constructor, much the same as wxNotifyEvent
- // ------------------------------------------------------------------------
- wxMediaEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
- : wxNotifyEvent(commandType, id)
- { }
+ virtual bool Load(const wxURI& WXUNUSED(location),
+ const wxURI& WXUNUSED(proxy))
+ { return false; }
- // ------------------------------------------------------------------------
- // wxMediaEvent Copy Constructor
- //
- // Normal copy constructor, much the same as wxNotifyEvent
- // ------------------------------------------------------------------------
- wxMediaEvent(const wxMediaEvent &clone)
- : wxNotifyEvent(clone)
- { }
+ virtual bool ShowPlayerControls(
+ wxMediaCtrlPlayerControls WXUNUSED(flags))
+ { return false; }
+ virtual bool IsInterfaceShown()
+ { return false; }
- // ------------------------------------------------------------------------
- // wxMediaEvent::Clone
- //
- // Allocates a copy of this object.
- // Required for wxEvtHandler::AddPendingEvent
- // ------------------------------------------------------------------------
- virtual wxEvent *Clone() const
- { return new wxMediaEvent(*this); }
+ virtual wxLongLong GetDownloadProgress()
+ { return 0; }
+ virtual wxLongLong GetDownloadTotal()
+ { return 0; }
+ virtual void MacVisibilityChanged()
+ { }
+ virtual void RESERVED9() {}
- // Put this class on wxWidget's RTTI table
- DECLARE_DYNAMIC_CLASS(wxMediaEvent)
+ DECLARE_DYNAMIC_CLASS(wxMediaBackend)
};
+
//Event ID to give to our events
#define wxMEDIA_FINISHED_ID 13000
#define wxMEDIA_STOP_ID 13001
//Define our event types - we need to call DEFINE_EVENT_TYPE(EVT) later
-DECLARE_EVENT_TYPE(wxEVT_MEDIA_FINISHED, wxMEDIA_FINISHED_ID)
-DECLARE_EVENT_TYPE(wxEVT_MEDIA_STOP, wxMEDIA_STOP_ID)
+DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_FINISHED, wxMEDIA_FINISHED_ID)
+DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_STOP, wxMEDIA_STOP_ID)
//Function type(s) our events need
typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
+#define wxMediaEventHandler(func) \
+ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMediaEventFunction, &func)
+
//Macro for usage with message maps
-#define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+
+#if wxABI_VERSION >= 20602 /* 2.6.2+ only */
+# define wxMEDIA_LOADED_ID 13002
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_LOADED, wxMEDIA_LOADED_ID)
+# define EVT_MEDIA_LOADED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_LOADED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#endif
+
+#if wxABI_VERSION >= 20603 /* 2.6.3+ only */
+# define wxMEDIA_STATECHANGED_ID 13003
+# define wxMEDIA_PLAY_ID 13004
+# define wxMEDIA_PAUSE_ID 13005
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_STATECHANGED, wxMEDIA_STATECHANGED_ID)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_PLAY, wxMEDIA_PLAY_ID)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_PAUSE, wxMEDIA_PAUSE_ID)
+# define EVT_MEDIA_STATECHANGED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STATECHANGED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+# define EVT_MEDIA_PLAY(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_PLAY, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+# define EVT_MEDIA_PAUSE(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_PAUSE, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#endif
+
+// ----------------------------------------------------------------------------
+// common backend base class used by many other backends
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_MEDIA wxMediaBackendCommonBase : public wxMediaBackend
+{
+public:
+ // add a pending wxMediaEvent of the given type
+ void QueueEvent(wxEventType evtType);
+
+ // notify that the movie playback is finished
+ void QueueFinishEvent()
+ {
+#if wxABI_VERSION >= 20603 /* 2.6.3+ only */
+ QueueEvent(wxEVT_MEDIA_STATECHANGED);
+#endif
+ QueueEvent(wxEVT_MEDIA_FINISHED);
+ }
+
+ // send the stop event and return true if it hasn't been vetoed
+ bool SendStopEvent();
+
+ // Queue pause event
+ void QueuePlayEvent();
+
+ // Queue pause event
+ void QueuePauseEvent();
+
+ // Queue stop event (no veto)
+ void QueueStopEvent();
+
+protected:
+ // call this when the movie size has changed but not because it has just
+ // been loaded (in this case, call NotifyMovieLoaded() below)
+ void NotifyMovieSizeChanged();
+
+ // call this when the movie is fully loaded
+ void NotifyMovieLoaded();
+
+
+ wxMediaCtrl *m_ctrl; // parent control
+};
// ----------------------------------------------------------------------------
// End compilation gaurd
projects / wxWidgets.git / blobdiff