applied patch #997019: '[wxMac] updated wxSound', adds static IsPlaying() and Stop()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28557 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/mac/carbon/sound.h b/include/wx/mac/carbon/sound.h
index ee2743b6316c77e6a46dbf1545231b075c10b4ca..54bceddf37afea011b66544b2a5c95f9dde53e01 100644 (file)
--- a/include/wx/mac/carbon/sound.h
+++ b/include/wx/mac/carbon/sound.h
@@ -2,11 +2,11 @@
 // Name:        sound.h
 // Purpose:     wxSound class (loads and plays short Windows .wav files).
 //              Optional on non-Windows platforms.
 // Name:        sound.h
 // Purpose:     wxSound class (loads and plays short Windows .wav files).
 //              Optional on non-Windows platforms.

-// Author:      Stefan Csomor
+// Author:      Ryan Norton, Stefan Csomor

 // Modified by:
 // Created:     1998-01-01
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     1998-01-01
 // RCS-ID:      $Id$

-// Copyright:   (c) Stefan Csomor
+// Copyright:   (c) Ryan Norton, Stefan Csomor

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -32,12 +32,11 @@ public:
 public:
   bool  Create(const wxString& fileName, bool isResource = FALSE);
   bool  IsOk() const { return !m_sndname.IsEmpty(); }
 public:
   bool  Create(const wxString& fileName, bool isResource = FALSE);
   bool  IsOk() const { return !m_sndname.IsEmpty(); }

+  static void  Stop();
+  static bool IsPlaying();

 
   void* GetHandle();
 
   void* GetHandle();

-protected:
-  // prevent collision with some BSD definitions of macro Free()
-  bool  FreeData();
-  
+protected:  

   bool  DoPlay(unsigned flags) const;
 
 private:
   bool  DoPlay(unsigned flags) const;
 
 private:

diff --git a/src/mac/carbon/sound.cpp b/src/mac/carbon/sound.cpp
index 21ea8612ad2b6efb12cc5d07beda503a0a41ba5e..e346f5c9d4f2029e338cd98eb88c3eed50a67ab4 100644 (file)
--- a/src/mac/carbon/sound.cpp
+++ b/src/mac/carbon/sound.cpp
@@ -1,7 +1,7 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sound.cpp
 // Purpose:     wxSound class implementation: optional
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sound.cpp
 // Purpose:     wxSound class implementation: optional

-// Author:      Ryan Norton, Stefan Csomor
+// Author:      Ryan Norton

 // Modified by:
 // Created:     1998-01-01
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     1998-01-01
 // RCS-ID:      $Id$


@@ -72,34 +72,41 @@
 class wxQTTimer : public wxTimer
 {
 public:
 class wxQTTimer : public wxTimer
 {
 public:

-    wxQTTimer(Movie movie, bool bLoop) :
-        m_movie(movie), m_bLoop(bLoop)
+    wxQTTimer(Movie movie, bool bLoop, bool& playing) :
+        m_movie(movie), m_bLoop(bLoop), m_pbPlaying(&playing)

     {
     }
 
     ~wxQTTimer()
     {
     {
     }
 
     ~wxQTTimer()
     {

-        Shutdown();
-    }
+        if(m_pbPlaying)
+            *m_pbPlaying = false;

 
 

-    void Shutdown()
-    {

         StopMovie(m_movie);
         DisposeMovie(m_movie);
         StopMovie(m_movie);
         DisposeMovie(m_movie);

-        m_movie = NULL ;

         Stop();
 
         //Note that ExitMovies() is not neccessary, but
         //the docs are fuzzy on whether or not TerminateQTML is
         ExitMovies();
 
         Stop();
 
         //Note that ExitMovies() is not neccessary, but
         //the docs are fuzzy on whether or not TerminateQTML is
         ExitMovies();
 

-     #ifndef __WXMAC__
+#ifndef __WXMAC__

         TerminateQTML();
         TerminateQTML();

-     #endif
+#endif
+    }
+
+    void Shutdown()
+    {
+        delete this;

     }
 
     void Notify()
     {
     }
 
     void Notify()
     {

+        if (m_pbPlaying && !*m_pbPlaying)
+        {
+            Shutdown();
+        }
+

         if(IsMovieDone(m_movie))
         {
             if (!m_bLoop)
         if(IsMovieDone(m_movie))
         {
             if (!m_bLoop)


@@ -107,9 +114,9 @@ public:
             else
             {
                 StopMovie(m_movie);
             else
             {
                 StopMovie(m_movie);

-                GoToBeginningOfMovie(m_movie);            
+                GoToBeginningOfMovie(m_movie);

                 StartMovie(m_movie);
                 StartMovie(m_movie);

-        }
+            }

         }
         else
             MoviesTask(m_movie, MOVIE_DELAY); //Give QT time to play movie
         }
         else
             MoviesTask(m_movie, MOVIE_DELAY); //Give QT time to play movie


@@ -117,61 +124,80 @@ public:
 
 
     Movie& GetMovie() {return m_movie;}
 
 
     Movie& GetMovie() {return m_movie;}

+

 protected:
     Movie m_movie;
     bool m_bLoop;
 protected:
     Movie m_movie;
     bool m_bLoop;

+
+public:
+    bool* m_pbPlaying;
+

 };
 
 
 class wxSMTimer : public wxTimer
 {
 public:
 };
 
 
 class wxSMTimer : public wxTimer
 {
 public:

-    wxSMTimer(void* hSnd, void* pSndChannel, const bool& bLoop)
-       : m_hSnd(hSnd), m_pSndChannel(pSndChannel), m_bLoop(bLoop)
-     {
-     }
+    wxSMTimer(void* hSnd, void* pSndChannel, const bool& bLoop, bool& playing)
+        : m_hSnd(hSnd), m_pSndChannel(pSndChannel), m_bLoop(bLoop), m_pbPlaying(&playing)
+    {
+    }

 
     ~wxSMTimer()
 
     ~wxSMTimer()

-        {
-           Shutdown();
-        }
+    {
+        if(m_pbPlaying)
+            *m_pbPlaying = false;
+        SndDisposeChannel((SndChannelPtr)m_pSndChannel, TRUE);
+        Stop();
+    }

 
     void Notify()
 
     void Notify()

+    {
+        if (m_pbPlaying && !*m_pbPlaying)

         {
         {

-       SCStatus stat;
+            Shutdown();
+        }
+
+        SCStatus stat;

 
         if (SndChannelStatus((SndChannelPtr)m_pSndChannel, sizeof(SCStatus), &stat) != 0)
 
         if (SndChannelStatus((SndChannelPtr)m_pSndChannel, sizeof(SCStatus), &stat) != 0)

-           Shutdown();
-       
-           //if the sound isn't playing anymore, see if it's looped,
-           //and if so play it again, otherwise close things up
-           if (stat.scChannelBusy == FALSE)
-           {
-               if (m_bLoop)
-               {
-                       if(SndPlay((SndChannelPtr)m_pSndChannel, (SndListHandle) m_hSnd, true) != noErr)
-                           Shutdown();
-               }
-               else
-                   Shutdown();
+            Shutdown();
+
+        //if the sound isn't playing anymore, see if it's looped,
+        //and if so play it again, otherwise close things up
+        if (stat.scChannelBusy == FALSE)
+        {
+            if (m_bLoop)
+            {
+                if(SndPlay((SndChannelPtr)m_pSndChannel, (SndListHandle) m_hSnd, true) != noErr)
+                    Shutdown();
+            }
+            else
+                Shutdown();

         }
     }
 
     void Shutdown()
     {
         }
     }
 
     void Shutdown()
     {

-        SndDisposeChannel((SndChannelPtr)m_pSndChannel, TRUE);
-       Stop();
+        delete this;

     }
     }

- 
+
+    void* GetChannel() {return m_pSndChannel;}
+

 protected:
     void* m_hSnd;
     void* m_pSndChannel;
     bool m_bLoop;
 protected:
     void* m_hSnd;
     void* m_pSndChannel;
     bool m_bLoop;

+
+public:
+    bool* m_pbPlaying;

 };
 
 // ------------------------------------------------------------------
 //          wxSound
 // ------------------------------------------------------------------
 };
 
 // ------------------------------------------------------------------
 //          wxSound
 // ------------------------------------------------------------------

+wxTimer* lastSoundTimer=NULL;
+bool lastSoundIsPlaying=false;

 
 //Determines whether version 4 of QT is installed
 Boolean wxIsQuickTime4Installed (void)
 
 //Determines whether version 4 of QT is installed
 Boolean wxIsQuickTime4Installed (void)


@@ -196,15 +222,15 @@ inline bool wxInitQT ()
         //-2093 no dll
             if ((nError = InitializeQTML(0)) != noErr)
                 wxLogSysError(wxString::Format("Couldn't Initialize Quicktime-%i", nError));
         //-2093 no dll
             if ((nError = InitializeQTML(0)) != noErr)
                 wxLogSysError(wxString::Format("Couldn't Initialize Quicktime-%i", nError));

-        #endif 
+        #endif

         EnterMovies();
         return true;
     }
     else
         EnterMovies();
         return true;
     }
     else

-        {
+    {

         wxLogSysError("Quicktime is not installed, or Your Version of Quicktime is <= 4.");
         wxLogSysError("Quicktime is not installed, or Your Version of Quicktime is <= 4.");

-            return false;
-        }
+        return false;
+    }

 }
 
 wxSound::wxSound()
 }
 
 wxSound::wxSound()


@@ -221,20 +247,22 @@ wxSound::wxSound(const wxString& sFileName, bool isResource)
 wxSound::wxSound(int size, const wxByte* data)
 : m_hSnd((char*)data), m_waveLength(size), m_pTimer(NULL), m_type(wxSound_MEMORY)
 {
 wxSound::wxSound(int size, const wxByte* data)
 : m_hSnd((char*)data), m_waveLength(size), m_pTimer(NULL), m_type(wxSound_MEMORY)
 {

-    if (!wxInitQT())
-        m_type = wxSound_NONE;

 }
 
 wxSound::~wxSound()
 {
 }
 
 wxSound::~wxSound()
 {

+    if(lastSoundIsPlaying)
+    {
+        if(m_type == wxSound_RESOURCE)
+            ((wxSMTimer*)lastSoundTimer)->m_pbPlaying = NULL;
+        else
+            ((wxQTTimer*)lastSoundTimer)->m_pbPlaying = NULL;
+    }

 }
 
 bool wxSound::Create(const wxString& fileName, bool isResource)
 {
 }
 
 bool wxSound::Create(const wxString& fileName, bool isResource)
 {

-    if(!wxInitQT())
-        return false;
-
-    FreeData();
+    Stop();

 
     if (isResource)
     {
 
     if (isResource)
     {


@@ -245,14 +273,14 @@ bool wxSound::Create(const wxString& fileName, bool isResource)
 
         wxMacStringToPascal( fileName , lpSnd ) ;
 
 
         wxMacStringToPascal( fileName , lpSnd ) ;
 

-               m_sndname = lpSnd;
+        m_sndname = lpSnd;

         m_hSnd = (char*) GetNamedResource('snd ', (const unsigned char *) lpSnd);
 #else
         return false;
 #endif
         m_hSnd = (char*) GetNamedResource('snd ', (const unsigned char *) lpSnd);
 #else
         return false;
 #endif

-        }
-        else
-        {
+    }
+    else
+    {

         m_type = wxSound_FILE;
         m_sndname = fileName;
     }
         m_type = wxSound_FILE;
         m_sndname = fileName;
     }


@@ -262,8 +290,7 @@ bool wxSound::Create(const wxString& fileName, bool isResource)
 
 bool wxSound::DoPlay(unsigned flags) const
 {
 
 bool wxSound::DoPlay(unsigned flags) const
 {

-//    wxASSERT(m_pTimer == NULL || !((wxTimer*)m_pTimer)->IsRunning() );
-    FreeData();
+    Stop();

 
     Movie movie;
 
 
     Movie movie;
 


@@ -271,8 +298,10 @@ bool wxSound::DoPlay(unsigned flags) const
     {
     case wxSound_MEMORY:
         {
     {
     case wxSound_MEMORY:
         {

+            if (!wxInitQT())
+                return false;

             Handle myHandle, dataRef = nil;
             Handle myHandle, dataRef = nil;

-            MovieImportComponent miComponent; 
+            MovieImportComponent miComponent;

             Track targetTrack = nil;
             TimeValue addedDuration = 0;
             long outFlags = 0;
             Track targetTrack = nil;
             TimeValue addedDuration = 0;
             long outFlags = 0;


@@ -280,7 +309,7 @@ bool wxSound::DoPlay(unsigned flags) const
             ComponentResult result;
 
             myHandle = NewHandleClear((Size)m_waveLength);
             ComponentResult result;
 
             myHandle = NewHandleClear((Size)m_waveLength);

-            
+

             BlockMove(m_hSnd, *myHandle, m_waveLength);
 
             err = PtrToHand(&myHandle, &dataRef, sizeof(Handle));
             BlockMove(m_hSnd, *myHandle, m_waveLength);
 
             err = PtrToHand(&myHandle, &dataRef, sizeof(Handle));


@@ -292,7 +321,7 @@ bool wxSound::DoPlay(unsigned flags) const
             else if (memcmp(&m_hSnd[8], "AIFC", 4) == 0)
                 miComponent = OpenDefaultComponent(MovieImportType, kQTFileTypeAIFC);
             else
             else if (memcmp(&m_hSnd[8], "AIFC", 4) == 0)
                 miComponent = OpenDefaultComponent(MovieImportType, kQTFileTypeAIFC);
             else

-    {
+            {

                 wxLogSysError("wxSound - Location in memory does not contain valid data");
                 return false;
             }
                 wxLogSysError("wxSound - Location in memory does not contain valid data");
                 return false;
             }


@@ -308,7 +337,7 @@ bool wxSound::DoPlay(unsigned flags) const
             if (result != noErr)
             {
                 wxLogSysError(wxString::Format(wxT("Couldn't import movie data\nError:%i"), (int)result));
             if (result != noErr)
             {
                 wxLogSysError(wxString::Format(wxT("Couldn't import movie data\nError:%i"), (int)result));

-    }
+            }

 
             SetMovieVolume(movie, kFullVolume);
             GoToBeginningOfMovie(movie);
 
             SetMovieVolume(movie, kFullVolume);
             GoToBeginningOfMovie(movie);


@@ -326,19 +355,21 @@ bool wxSound::DoPlay(unsigned flags) const
 
             SndChannelPtr pSndChannel;
             SndNewChannel(&pSndChannel, sampledSynth,
 
             SndChannelPtr pSndChannel;
             SndNewChannel(&pSndChannel, sampledSynth,

-                                   initNoInterp + 
-                        (data.numChannels == 1 ? initMono : initStereo), NULL);
+                initNoInterp
+                + (data.numChannels == 1 ? initMono : initStereo), NULL);

 
             if(SndPlay(pSndChannel, (SndListHandle) m_hSnd, flags & wxSOUND_ASYNC ? 1 : 0) != noErr)
 
             if(SndPlay(pSndChannel, (SndListHandle) m_hSnd, flags & wxSOUND_ASYNC ? 1 : 0) != noErr)

-                   return false;
+                return false;

 
             if (flags & wxSOUND_ASYNC)
 
             if (flags & wxSOUND_ASYNC)

-    {
-                ((wxSMTimer*&)m_pTimer) = new wxSMTimer(pSndChannel, m_hSnd, flags & wxSOUND_LOOP ? 1 : 0);
- 
-                   ((wxTimer*)m_pTimer)->Start(MOVIE_DELAY, wxTIMER_CONTINUOUS); 
-    }
-    else
+            {
+                lastSoundTimer = ((wxSMTimer*&)m_pTimer)
+                    = new wxSMTimer(pSndChannel, m_hSnd, flags & wxSOUND_LOOP ? 1 : 0,
+                        lastSoundIsPlaying=true);
+
+                ((wxTimer*)m_pTimer)->Start(MOVIE_DELAY, wxTIMER_CONTINUOUS);
+            }
+            else

                 SndDisposeChannel(pSndChannel, TRUE);
 
             return true;
                 SndDisposeChannel(pSndChannel, TRUE);
 
             return true;


@@ -346,6 +377,9 @@ bool wxSound::DoPlay(unsigned flags) const
         break;
     case wxSound_FILE:
         {
         break;
     case wxSound_FILE:
         {

+            if (!wxInitQT())
+                return false;
+

             short movieResFile;
             FSSpec sfFile;
 
             short movieResFile;
             FSSpec sfFile;
 


@@ -354,11 +388,11 @@ bool wxSound::DoPlay(unsigned flags) const
 #else
             int nError;
             if ((nError = NativePathNameToFSSpec ((char*) m_sndname.c_str(), &sfFile, 0)) != noErr)
 #else
             int nError;
             if ((nError = NativePathNameToFSSpec ((char*) m_sndname.c_str(), &sfFile, 0)) != noErr)

-    {
-                wxLogSysError(wxString::Format(wxT("File:%s does not exist\nError:%i"), 
+            {
+                wxLogSysError(wxString::Format(wxT("File:%s does not exist\nError:%i"),

                                 m_sndname.c_str(), nError));
                 return false;
                                 m_sndname.c_str(), nError));
                 return false;

-    }
+            }

 #endif
 
             if (OpenMovieFile (&sfFile, &movieResFile, fsRdPerm) != noErr)
 #endif
 
             if (OpenMovieFile (&sfFile, &movieResFile, fsRdPerm) != noErr)


@@ -383,12 +417,12 @@ bool wxSound::DoPlay(unsigned flags) const
             CloseMovieFile (movieResFile);
 
             if (err != noErr)
             CloseMovieFile (movieResFile);
 
             if (err != noErr)

-    {
+            {

                 wxLogSysError(
                     wxString::Format(wxT("wxSound - Could not open file: %s\nError:%i"), m_sndname.c_str(), err )
                     );
                 return false;
                 wxLogSysError(
                     wxString::Format(wxT("wxSound - Could not open file: %s\nError:%i"), m_sndname.c_str(), err )
                     );
                 return false;

-    }
+            }

         }
         break;
     default:
         }
         break;
     default:


@@ -399,13 +433,7 @@ bool wxSound::DoPlay(unsigned flags) const
     //Start the movie!
     StartMovie(movie);
 
     //Start the movie!
     StartMovie(movie);
 

-    if (flags & wxSOUND_ASYNC)
-    {
-        //Start timer and play movie asyncronously
-        ((wxQTTimer*&)m_pTimer) = new wxQTTimer(movie, flags & wxSOUND_LOOP ? 1 : 0);
-        ((wxQTTimer*)m_pTimer)->Start(MOVIE_DELAY, wxTIMER_CONTINUOUS);
-    }
-    else
+    if (flags & wxSOUND_SYNC)

     {
         wxASSERT_MSG(!(flags & wxSOUND_LOOP), "Can't loop and play syncronously at the same time");
 
     {
         wxASSERT_MSG(!(flags & wxSOUND_LOOP), "Can't loop and play syncronously at the same time");
 


@@ -415,26 +443,36 @@ bool wxSound::DoPlay(unsigned flags) const
 
         DisposeMovie(movie);
     }
 
         DisposeMovie(movie);
     }

+    else
+    {
+        //Start timer and play movie asyncronously
+        lastSoundTimer = ((wxQTTimer*&)m_pTimer) = new wxQTTimer(movie, flags & wxSOUND_LOOP ? 1 : 0,lastSoundIsPlaying=true);
+        ((wxQTTimer*)m_pTimer)->Start(MOVIE_DELAY, wxTIMER_CONTINUOUS);
+    }

 
     return true;
 }
 
 
     return true;
 }
 

-void* wxSound::GetHandle() 
+bool wxSound::IsPlaying()

 {
 {

-    return (void*) ((wxQTTimer*) m_pTimer)->GetMovie();
+    return lastSoundIsPlaying;

 }
 
 }
 

-bool wxSound::FreeData()
+void wxSound::Stop()

 {
 {

-    if (m_pTimer != NULL)
+    if(lastSoundIsPlaying)

     {
     {

-        delete (wxQTTimer*) m_pTimer;
-        m_pTimer = NULL;
+        delete (wxTimer*&) lastSoundTimer;
+        lastSoundIsPlaying = false;

     }
     }

-
-    return true;

 }
 }

-#endif //wxUSE_SOUND

 
 

+void* wxSound::GetHandle()
+{
+    if(m_type == wxSound_RESOURCE)
+        return (void*)  ((wxSMTimer*)m_pTimer)->GetChannel();

 
 

+    return (void*) ((wxQTTimer*) m_pTimer)->GetMovie();
+}

 
 

+#endif //wxUSE_SOUND