use gettimeofday() instead of clock_gettime() as the latter lives in librt which...

[wxWidgets.git] / include / wx / mediactrl.h

diff --git a/include/wx/mediactrl.h b/include/wx/mediactrl.h
index 78e62fc1ed6ee0ef1b90914222fc99b81f042c85..4661bde448d484863787395d22380bbc4b94b1be 100644 (file)
--- a/include/wx/mediactrl.h
+++ b/include/wx/mediactrl.h
@@ -22,13 +22,13 @@
 // ----------------------------------------------------------------------------
 // Pre-compiled header stuff
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Pre-compiled header stuff
 // ----------------------------------------------------------------------------

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "mediactrl.h"
-#endif
+
+#include "wx/defs.h"

 
 // ----------------------------------------------------------------------------
 // Compilation guard
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Compilation guard
 // ----------------------------------------------------------------------------

+

 #if wxUSE_MEDIACTRL
 
 // ----------------------------------------------------------------------------
 #if wxUSE_MEDIACTRL
 
 // ----------------------------------------------------------------------------


@@ -55,9 +55,24 @@ enum wxMediaState
     wxMEDIASTATE_PLAYING
 };
 
     wxMEDIASTATE_PLAYING
 };
 

+enum wxMediaCtrlPlayerControls
+{
+    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_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")

 
 // ----------------------------------------------------------------------------
 //
 
 // ----------------------------------------------------------------------------
 //


@@ -109,7 +124,7 @@ public:
 class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl
 {
 public:
 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 winid,
     {                                                                   }
 
     wxMediaCtrl(wxWindow* parent, wxWindowID winid,


@@ -120,7 +135,7 @@ public:
                 const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))

-                : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
+                : m_imp(NULL), m_bLoaded(false)

     {   Create(parent, winid, fileName, pos, size, style,
                szBackend, validator, name);                             }
 
     {   Create(parent, winid, fileName, pos, size, style,
                szBackend, validator, name);                             }
 


@@ -132,11 +147,11 @@ public:
                 const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))

-                : m_imp(NULL), m_bLoop(false)
+                : m_imp(NULL), m_bLoaded(false)

     {   Create(parent, winid, location, pos, size, style,
                szBackend, validator, name);                             }
 
     {   Create(parent, winid, location, pos, size, style,
                szBackend, validator, name);                             }
 

-    ~wxMediaCtrl();
+    virtual ~wxMediaCtrl();

 
     bool Create(wxWindow* parent, wxWindowID winid,
                 const wxString& fileName = wxEmptyString,
 
     bool Create(wxWindow* parent, wxWindowID winid,
                 const wxString& fileName = wxEmptyString,


@@ -154,7 +169,7 @@ public:
                 long style = 0,
                 const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 long style = 0,
                 const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = wxT("mediaCtrl")); //DirectShow only
+                const wxString& name = wxT("mediaCtrl"));

 
     bool DoCreate(wxClassInfo* instance,
                 wxWindow* parent, wxWindowID winid,
 
     bool DoCreate(wxClassInfo* instance,
                 wxWindow* parent, wxWindowID winid,


@@ -169,20 +184,34 @@ public:
     bool Stop();
 
     bool Load(const wxString& fileName);
     bool Stop();
 
     bool Load(const wxString& fileName);

-    bool Load(const wxURI& location); //DirectShow only
-
-    void Loop(bool bLoop = true);
-    bool IsLooped();

 
     wxMediaState GetState();
 
 
     wxMediaState GetState();
 

-    double GetPlaybackRate();           //All but MCI
-    bool SetPlaybackRate(double dRate); //All but MCI
-

     wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
     wxFileOffset Tell(); //FIXME: This should be const
     wxFileOffset Length(); //FIXME: This should be const
 
     wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
     wxFileOffset Tell(); //FIXME: This should be const
     wxFileOffset Length(); //FIXME: This should be const
 

+    double GetPlaybackRate();           //All but MCI & GStreamer
+    bool SetPlaybackRate(double dRate); //All but MCI & GStreamer
+
+    bool Load(const wxURI& location);
+    bool Load(const wxURI& location, const wxURI& proxy);
+
+    wxFileOffset GetDownloadProgress(); // DirectShow only
+    wxFileOffset GetDownloadTotal();    // DirectShow only
+
+    double GetVolume();
+    bool   SetVolume(double dVolume);
+
+    bool    ShowPlayerControls(
+        wxMediaCtrlPlayerControls flags = wxMEDIACTRLPLAYERCONTROLS_DEFAULT);
+
+    //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));       }
+

 protected:
     static wxClassInfo* NextBackend();
 
 protected:
     static wxClassInfo* NextBackend();
 


@@ -190,15 +219,16 @@ protected:
     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 
     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 

-#ifdef __WXMAC__
-    friend class wxQTMediaBackend;
+    //FIXME:  This is nasty... find a better way to work around
+    //inheritance issues
+#if defined(__WXMAC__)
+    virtual void MacVisibilityChanged();

 #endif
 #endif

-#ifdef __WXCOCOA__
+#if defined(__WXMAC__) || defined(__WXCOCOA__)

     friend class wxQTMediaBackend;
 #endif
     class wxMediaBackend* m_imp;
     bool m_bLoaded;
     friend class wxQTMediaBackend;
 #endif
     class wxMediaBackend* m_imp;
     bool m_bLoaded;

-    bool m_bLoop;

 
     DECLARE_DYNAMIC_CLASS(wxMediaCtrl)
 };
 
     DECLARE_DYNAMIC_CLASS(wxMediaCtrl)
 };


@@ -207,7 +237,13 @@ protected:
 //
 // wxMediaBackend
 //
 //
 // wxMediaBackend
 //

-// Currently an internal class - API stability not guaranteed.
+// 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.

 //
 // ----------------------------------------------------------------------------
 
 //
 // ----------------------------------------------------------------------------
 


@@ -252,7 +288,7 @@ public:
                       int WXUNUSED(w), int WXUNUSED(h))
     {                                   }
     virtual wxSize GetVideoSize() const
                       int WXUNUSED(w), int WXUNUSED(h))
     {                                   }
     virtual wxSize GetVideoSize() const

-    {   return wxSize();                }
+    {   return wxSize(0,0);             }

 
     virtual double GetPlaybackRate()
     {   return 0.0;                     }
 
     virtual double GetPlaybackRate()
     {   return 0.0;                     }


@@ -262,9 +298,34 @@ public:
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 

+    virtual double GetVolume()
+    {   return 0.0;                     }
+    virtual bool SetVolume(double WXUNUSED(dVolume))
+    {   return false;                   }
+
+    virtual bool Load(const wxURI& WXUNUSED(location),
+                      const wxURI& WXUNUSED(proxy))
+    {   return false;                   }
+
+    virtual bool   ShowPlayerControls(
+                    wxMediaCtrlPlayerControls WXUNUSED(flags))
+    {   return false;                   }
+    virtual bool   IsInterfaceShown()
+    {   return false;                   }
+
+    virtual wxLongLong GetDownloadProgress()
+    {    return 0;                      }
+    virtual wxLongLong GetDownloadTotal()
+    {    return 0;                      }
+
+    virtual void MacVisibilityChanged()
+    {                                   }
+    virtual void RESERVED9() {}
+

     DECLARE_DYNAMIC_CLASS(wxMediaBackend)
 };
 
     DECLARE_DYNAMIC_CLASS(wxMediaBackend)
 };
 

+

 //Event ID to give to our events
 #define wxMEDIA_FINISHED_ID    13000
 #define wxMEDIA_STOP_ID    13001
 //Event ID to give to our events
 #define wxMEDIA_FINISHED_ID    13000
 #define wxMEDIA_STOP_ID    13001


@@ -276,9 +337,67 @@ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_STOP,     wxMEDIA_STO
 //Function type(s) our events need
 typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
 
 //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
 //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 ),
+
+#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 ),
+
+#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 ),
+
+// ----------------------------------------------------------------------------
+// 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()
+    {
+        QueueEvent(wxEVT_MEDIA_STATECHANGED);
+        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
 
 // ----------------------------------------------------------------------------
 // End compilation gaurd