Make wxABI_VERSION default be e.g. 20699

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

diff --git a/include/wx/mediactrl.h b/include/wx/mediactrl.h
index 69acc08e9077ecd4d55cf934b51a2336c5051734..9646aeed81d6db9b1da8da320c33264162648334 100644 (file)
--- a/include/wx/mediactrl.h
+++ b/include/wx/mediactrl.h
@@ -2,7 +2,7 @@
 // Name:        wx/mediactrl.h
 // Purpose:     wxMediaCtrl class
 // Author:      Ryan Norton <wxprojects@comcast.net>
 // 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
 // Created:     11/07/04
 // RCS-ID:      $Id$
 // Copyright:   (c) Ryan Norton


@@ -26,9 +26,12 @@
 #pragma interface "mediactrl.h"
 #endif
 
 #pragma interface "mediactrl.h"
 #endif
 

+#include "wx/defs.h"
+

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

+

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


@@ -55,14 +58,51 @@ enum wxMediaState
     wxMEDIASTATE_PLAYING
 };
 
     wxMEDIASTATE_PLAYING
 };
 

-enum wxMediaTimeFormat
-{
-    wxMEDIATIMEFORMAT_TIME
-};
-

 #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")
+
+// ----------------------------------------------------------------------------
+//
+// 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)
+};

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


@@ -70,107 +110,119 @@ enum wxMediaTimeFormat
 //
 // ----------------------------------------------------------------------------
 
 //
 // ----------------------------------------------------------------------------
 

-class wxMediaCtrl : public wxControl
+class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl

 {
 public:
 {
 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,
                 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"))
                 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);                             }
 
                szBackend, validator, name);                             }
 

-    wxMediaCtrl(wxWindow* parent, wxWindowID id, 
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,

                 const wxURI& location,
                 const wxURI& location,

-                const wxPoint& pos = wxDefaultPosition, 
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 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"))
                 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();
 
                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,
                 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"));
 
                 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 wxURI& location,

-                const wxPoint& pos = wxDefaultPosition, 
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
-                const wxString& szBackend = wxT(""),
+                long style = 0,
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxValidator& validator = wxDefaultValidator,

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

 
     bool DoCreate(wxClassInfo* instance,
 
     bool DoCreate(wxClassInfo* instance,

-                wxWindow* parent, wxWindowID id,
-                const wxPoint& pos = wxDefaultPosition, 
+                wxWindow* parent, wxWindowID winid,
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
+                long style = 0,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 

-    static wxClassInfo* NextBackend();
-
-

     bool Play();
     bool Pause();
     bool Stop();
 
     bool Load(const wxString& fileName);
     bool Play();
     bool Pause();
     bool Stop();
 
     bool Load(const wxString& fileName);

-    bool Load(const wxURI& location);

 
 

-    void Loop(bool bLoop = true);
-    bool IsLooped();

 
     wxMediaState GetState();
 
 
     wxMediaState GetState();
 

-    double GetPlaybackRate();
-    bool SetPlaybackRate(double dRate);
+    wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
+    wxFileOffset Tell(); //FIXME: This should be const
+    wxFileOffset Length(); //FIXME: This should be const

 
 

-    bool SetPosition(wxLongLong where);
-    wxLongLong GetPosition();
-    wxLongLong GetDuration();
+    //
+    // Unofficial parts of API
+    //
+    //DirectShow/GStreamer only.  Quicktime too, but somewhat buggy...
+    bool Load(const wxURI& location);
+
+    double GetPlaybackRate();           //All but MCI & GStreamer
+    bool SetPlaybackRate(double dRate); //All but MCI & GStreamer
+
+    double GetVolume();                 //DirectShow only
+    bool   SetVolume(double dVolume);   //DirectShow only

 
 protected:
 
 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;
 
     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
+#ifdef __WXMAC__
+    friend class wxQTMediaBackend;
+#endif
+#ifdef __WXCOCOA__
+    friend class wxQTMediaBackend;
+#endif

     class wxMediaBackend* m_imp;
     bool m_bLoaded;
     class wxMediaBackend* m_imp;
     bool m_bLoaded;

-    bool m_bLoop;

 
 

-    DECLARE_DYNAMIC_CLASS(wxMediaCtrl);
+    DECLARE_DYNAMIC_CLASS(wxMediaCtrl)

 };
 
 // ----------------------------------------------------------------------------
 //
 // wxMediaBackend
 //
 };
 
 // ----------------------------------------------------------------------------
 //
 // wxMediaBackend
 //

-// Currently an internal class - API stability not gauranteed.
+// Currently an internal class - API stability not guaranteed.

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

-class wxMediaBackend : public wxObject
+class WXDLLIMPEXP_MEDIA wxMediaBackend : public wxObject

 {
 public:
     wxMediaBackend()
 {
 public:
     wxMediaBackend()


@@ -178,89 +230,63 @@ public:
 
     virtual ~wxMediaBackend();
 
 
     virtual ~wxMediaBackend();
 

-    virtual bool CreateControl(wxControl* ctrl, wxWindow* parent, 
-                               wxWindowID id, 
-                               const wxPoint& pos, const wxSize& size,
-                               long style, 
-                               const wxValidator& validator,
-                               const wxString& name)
+    virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
+                               wxWindow* WXUNUSED(parent),
+                               wxWindowID WXUNUSED(winid),
+                               const wxPoint& WXUNUSED(pos),
+                               const wxSize& WXUNUSED(size),
+                               long WXUNUSED(style),
+                               const wxValidator& WXUNUSED(validator),
+                               const wxString& WXUNUSED(name))

     {   return false;                   }
 
     {   return false;                   }
 

-    virtual bool Play() 
+    virtual bool Play()

     {   return false;                   }
     {   return false;                   }

-    virtual bool Pause() 
+    virtual bool Pause()

     {   return false;                   }
     {   return false;                   }

-    virtual bool Stop() 
+    virtual bool Stop()

     {   return false;                   }
 
     {   return false;                   }
 

-    virtual bool Load(const wxString& WXUNUSED(fileName)) 
+    virtual bool Load(const wxString& WXUNUSED(fileName))

     {   return false;                   }
     {   return false;                   }

-    virtual bool Load(const wxURI& WXUNUSED(location)) 
+    virtual bool Load(const wxURI& WXUNUSED(location))

     {   return false;                   }
 
     {   return false;                   }
 

-    virtual bool SetPosition(wxLongLong WXUNUSED(where)) 
+    virtual bool SetPosition(wxLongLong WXUNUSED(where))

     {   return 0;                       }
     {   return 0;                       }

-    virtual wxLongLong GetPosition() 
+    virtual wxLongLong GetPosition()

     {   return 0;                       }
     {   return 0;                       }

-    virtual wxLongLong GetDuration() 
+    virtual wxLongLong GetDuration()

     {   return 0;                       }
 
     {   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);             }
 
     {   return wxSize(0,0);             }
 

-    virtual double GetPlaybackRate() 
+    virtual double GetPlaybackRate()

     {   return 0.0;                     }
     {   return 0.0;                     }

-    virtual bool SetPlaybackRate(double WXUNUSED(dRate)) 
+    virtual bool SetPlaybackRate(double WXUNUSED(dRate))

     {   return false;                   }
 
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 
     {   return false;                   }
 
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 

-    DECLARE_CLASS(wxMediaBackend)
-};
-
-// ----------------------------------------------------------------------------
-//
-// wxMediaEvent
-//
-// ----------------------------------------------------------------------------
-
-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)
-    {                                       }
-
-    // ------------------------------------------------------------------------
-    // 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);     }
+    virtual double GetVolume()
+    {   return 0.0;                     }
+    virtual bool SetVolume(double WXUNUSED(dVolume))
+    {   return false;                   }

 
 

+    virtual void RESERVED3() {}
+    virtual void RESERVED4() {}
+    virtual void RESERVED5() {}
+    virtual void RESERVED6() {}
+    virtual void RESERVED7() {}
+    virtual void RESERVED8() {}
+    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
 };
 
 //Event ID to give to our events


@@ -268,15 +294,18 @@ public:
 #define wxMEDIA_STOP_ID    13001
 
 //Define our event types - we need to call DEFINE_EVENT_TYPE(EVT) later
 #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&);
 
 
 //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 ),

 
 // ----------------------------------------------------------------------------
 // End compilation gaurd
 
 // ----------------------------------------------------------------------------
 // End compilation gaurd