Changeset 112

Timestamp:

Aug 3, 2006, 5:22:52 PM (19 years ago)

Author:

dmik

Message:

Kernel: QSound: Fixed sound playback on single-streamed audio devices:

• Preloaded sounds (allocated QSound instances) could not be played;
• Playing too many sounds simultaneously created too many threads that could screw up the MMPM audio driver (uniaud);
• Sound playback suspended due to the lack of the resources produced orphan sounds upon resumption (reasoned but not nice).

File:

• trunk/src/kernel/qsound_pm.cpp (modified) (18 diffs)

trunk/src/kernel/qsound_pm.cpp

@@ -129 +129 @@
 typedef MMAUDIOHEADER *PMMAUDIOHEADER;
 
-#define MCI_OPEN_TYPE_ID                    0x00001000L
-#define MCI_OPEN_SHAREABLE                  0x00002000L
-#define MCI_OPEN_MMIO                       0x00004000L
-
 typedef struct _MCI_OPEN_PARMS  
 {
@@ -167 +163 @@
 #define MCI_FROM                            0x00000004L
 
+#define MCI_OPEN_TYPE_ID                    0x00001000L
+#define MCI_OPEN_SHAREABLE                  0x00002000L
+#define MCI_OPEN_MMIO                       0x00004000L
+#define MCI_READONLY                        0x00008000L
+
+#define MCI_RETURN_RESOURCE                 0x00000100L
+
+#define MCI_CLOSE_EXIT                 0x10000000L
+
 #define MCI_OPEN                        1
 #define MCI_CLOSE                       2
 #define MCI_PLAY                        4
 #define MCI_STOP                        6
+#define MCI_ACQUIREDEVICE               23
+#define MCI_RELEASEDEVICE               24
+
+#define MM_MCINOTIFY                        0x0500
+#define MM_MCIPASSDEVICE                    0x0501
 
 #define MCI_NOTIFY_SUCCESSFUL               0x0000
-
-#define MM_MCINOTIFY                        0x0500
-
+#define MCI_NOTIFY_SUPERSEDED               0x0001
+
+#define MCI_LOSING_USE                      0x00000001L
+#define MCI_GAINING_USE                     0x00000002L
+
+#define MCIERR_BASE                      5000
 #define MCIERR_SUCCESS                   0
+#define MCIERR_INSTANCE_INACTIVE         (MCIERR_BASE + 34)
+#define MCIERR_DEVICE_LOCKED             (MCIERR_BASE + 32)
 
 // functions resolved by mmio.dll
@@ -232 +247 @@
 private slots:
 
-    void aboutToQuit() { isAboutToQuit = TRUE; } 
+    void serverUninit();
     
 private:    
@@ -238 +253 @@
     HWND hwnd;
     bool isOk;
-    bool isAboutToQuit;
     
     QLibrary mdmLib;
     QLibrary mmioLib;
     
-    QIntDict< QAuBucketMMPM > buckets;
+    QIntDict< QAuBucketMMPM > bucketMap;
+    QPtrList< QAuBucketMMPM > bucketList;
     
     static const char *ClassName;
@@ -258 +273 @@
 public:
 
+    enum State { Stopped, Playing, Waiting };
+
     QAuBucketMMPM( QAuServerMMPM *server, QSound *sound );
     QAuBucketMMPM( QAuServerMMPM *server, const QString &soundFile );
     ~QAuBucketMMPM();
 
-    void play();
+    void open();
+    void close( bool atExit = FALSE );
+    bool play();
     void stop();
-    bool okay() { return fileHandle != NULLHANDLE && deviceId != 0; } 
+    bool okay() { return fileHandle != NULLHANDLE; } 
     
     QSound *sound() { return snd; }
-    
-    static const char *ClassName;
+    State state() { return st; }
+    
+    void onDeviceGained( bool gained );
+    
+#if defined(QT_DEBUG)
+    QCString fileName() { return fName; };
+#endif
     
 private:
@@ -278 +302 @@
     
 #if defined(QT_DEBUG)
-    QCString fileName;
+    QCString fName;
 #endif
 
     HMMIO fileHandle;
     USHORT deviceId;
+    
+    State st;
 };
 
@@ -288 +314 @@
 
 QAuBucketMMPM::QAuBucketMMPM( QAuServerMMPM *server, QSound *sound ) :
-    srv( server ), snd( sound ), fileHandle( NULLHANDLE ), deviceId( 0 )
+    srv( server ), snd( sound ), fileHandle( NULLHANDLE ), deviceId( 0 ),
+    st( Stopped )
 {
     Q_ASSERT( srv );
     Q_ASSERT( snd );
+    if ( !srv || !snd )
+        return;
     
     init( snd->fileName() );
-    if ( okay() )
-        srv->buckets.insert( deviceId, this );
 }
 
 QAuBucketMMPM::QAuBucketMMPM( QAuServerMMPM *server, const QString &fileName ) :
-    srv( server ), snd( NULL ), fileHandle( NULLHANDLE ), deviceId( 0 )
+    srv( server ), snd( NULL ), fileHandle( NULLHANDLE ), deviceId( 0 ),
+    st( Stopped )
 {
     Q_ASSERT( srv );
+    if ( !srv )
+        return;
     
     init( fileName );
-    if ( okay() )
-        srv->buckets.insert( deviceId, this );
 }
 
 void QAuBucketMMPM::init( const QString &soundFile )
 {
+    Q_ASSERT( fileHandle == NULLHANDLE );
+    if ( fileHandle != NULLHANDLE )
+        return;
+    
 #if !defined(QT_DEBUG)
     QCString
 #endif    
-    fileName = QFile::encodeName( soundFile );
-    
+    fName = QFile::encodeName( soundFile );
+
     MMIOINFO mmioinfo = { 0 };
     mmioinfo.ulTranslate = MMIO_TRANSLATEDATA | MMIO_TRANSLATEHEADER;
-    fileHandle = mmioOpen( fileName.data(), &mmioinfo, MMIO_READ );
+    fileHandle = mmioOpen( fName.data(), &mmioinfo, MMIO_READ );
     if ( fileHandle == NULLHANDLE ) {
 #if defined(QT_DEBUG)
-        qDebug( "QAuBucketMMPM: falied to open sound file [%s]",
-                fileName.data() );
+        qDebug( "QAuBucketMMPM: falied to open sound file [%s]", fName.data() );
 #endif
         return;
@@ -332 +363 @@
 #if defined(QT_DEBUG)
         qDebug( "QAuBucketMMPM: [%s] is not a sound file or "
-                "has an unsupported format (rc=%04ld)", fileName.data(), rc );
-#endif
-        return;
-    }
+                "has an unsupported format (rc=%04hu:%04hu)",
+                fName.data(), HIUSHORT( rc ), LOUSHORT( rc ) );
+#endif
+        mmioClose( fileHandle, 0 );
+        fileHandle = NULLHANDLE;            
+        return;
+    }
+    
+    srv->bucketList.append( this );
+    
+#if defined(QT_QSOUND_DEBUG)    
+    qDebug( "QAuBucketMMPM::init(): {%p} [%s]", this, fName.data() );
+#endif
+}
+
+QAuBucketMMPM::~QAuBucketMMPM()
+{
+#if defined(QT_QSOUND_DEBUG)    
+    qDebug( "~QAuBucketMMPM(): {%p} [%s]", this, fName.data() );
+#endif    
+
+    if ( deviceId )
+        close( srv->hwnd == NULLHANDLE );
+
+    if ( fileHandle != NULLHANDLE ) {            
+        srv->bucketList.removeRef( this );
+        mmioClose( fileHandle, 0 );
+    }
+}
+
+void QAuBucketMMPM::open()
+{
+    Q_ASSERT( !deviceId );
+    if ( deviceId )
+        return;
     
     MCI_OPEN_PARMS openParams = { 0 };
+    openParams.hwndCallback = srv->hwnd;
     openParams.pszDeviceType = (PSZ) MAKEULONG( MCI_DEVTYPE_WAVEFORM_AUDIO, 0 );
     openParams.pszElementName = (PSZ) fileHandle;
-    rc = mciSendCommand( 0, MCI_OPEN, MCI_WAIT | MCI_OPEN_MMIO |
-                                      MCI_OPEN_SHAREABLE | MCI_OPEN_TYPE_ID,
-                         &openParams, 0 );                
+    ULONG rc = mciSendCommand( 0, MCI_OPEN, MCI_WAIT | MCI_OPEN_MMIO | MCI_READONLY |
+                                  MCI_OPEN_SHAREABLE | MCI_OPEN_TYPE_ID,
+                               &openParams, 0 );                
     if ( rc != MCIERR_SUCCESS ) {
 #if defined(QT_DEBUG)
         qDebug( "QAuBucketMMPM: failed to open a device for sound file [%s] "
-                "(rc=%04ld)", fileName.data(), rc );
+                "(rc=%04hu:%04hu)", fName.data(), HIUSHORT( rc ), LOUSHORT( rc ) );
 #endif
         return;
@@ -352 +415 @@
     
     deviceId = openParams.usDeviceID;
-}
-
-QAuBucketMMPM::~QAuBucketMMPM()
-{
+    
+    srv->bucketMap.insert( deviceId, this );
+
 #if defined(QT_QSOUND_DEBUG)    
-    qDebug( "~QAuBucketMMPM(): this=%p", this );
+    qDebug( "QAuBucketMMPM::open(): {%p} [%s] deviceId=%08hu",
+            this, fName.data(), deviceId );
+#endif
+}
+
+void QAuBucketMMPM::close( bool atExit /* = FALSE */)
+{
+    Q_ASSERT( deviceId );
+    if ( !deviceId )
+        return;
+    
+#if defined(QT_QSOUND_DEBUG)    
+    qDebug( "QAuBucketMMPM()::close(): {%p} [%s]", this, fName.data() );
 #endif    
 
-    if ( okay() )
-        srv->buckets.remove( deviceId );
-
-    if ( okay() && snd && !srv->isAboutToQuit ) {
-        // in order to guarantee that the device is closed only after all
-        // messages for the particular device ID are delivered to WindowProc()
-        // and that no other device is assigned the same ID until then, we post
-        // a special message containing fileHandle and deviceId to be closed 
-        WinPostMsg( srv->hwnd, WM_USER,
-                    MPFROMLONG( fileHandle ), MPFROMSHORT( deviceId ) );
-    } else {
-        if ( deviceId != 0 )
-            mciSendCommand( deviceId, MCI_CLOSE, MCI_WAIT, NULL, 0 );                
-        if ( fileHandle != NULLHANDLE )            
-            mmioClose( fileHandle, 0 );
-    }
-}
-
-void QAuBucketMMPM::play()
-{
+    // remove from the map anyway -- we don't plan to retry 
+    srv->bucketMap.remove( deviceId );
+
+    // Use MCI_CLOSE_EXIT to tell the media control driver it should
+    // close immediately, w/o doing for any notifications, etc.
+    ULONG param = atExit ? MCI_CLOSE_EXIT : 0;
+    
+    ULONG rc = mciSendCommand( deviceId, MCI_CLOSE, param, NULL, 0 );
+#if defined(QT_DEBUG)
+    if ( rc != MCIERR_SUCCESS )
+        qDebug( "QAuBucketMMPM: failed to close the device for sound file [%s] "
+                "(rc=%04hu:%04hu)",
+                fName.data(), HIUSHORT( rc ), LOUSHORT( rc ) );
+#endif
+    Q_UNUSED( rc );
+    
+    st = Stopped;
+    deviceId = 0;
+}
+
+bool QAuBucketMMPM::play()
+{
+#if defined(QT_QSOUND_DEBUG)    
+    qDebug( "QAuBucketMMPM()::play(): {%p} [%s]", this, fName.data() );
+#endif    
+    
+    if ( !deviceId ) {
+        open();
+        if ( !deviceId )
+            return FALSE;
+    }
+    
     MCI_PLAY_PARMS playParams = { 0 };
     playParams.hwndCallback = srv->hwnd;
     playParams.ulFrom = 0; // always play from the beginning
-    
+
     ULONG rc = mciSendCommand( deviceId, MCI_PLAY, MCI_NOTIFY | MCI_FROM,
-                               &playParams, 0 );                
-
-    if ( rc != MCIERR_SUCCESS ) {
-#if defined(QT_DEBUG)
-        qDebug( "QAuBucketMMPM: failed to play sound file [%s] (rc=%04ld)",
-                fileName.data(), rc );
-#endif
-    }
+                               &playParams, 0 );
+    
+    if ( LOUSHORT( rc ) == MCIERR_INSTANCE_INACTIVE ) {
+        // There are not enough simultaneous audio streams. Try to acquire the
+        // resources and play again. Note that if the device is already acquired
+        // for exclusive use, this command will not wait but return immediately.
+        rc = mciSendCommand( deviceId, MCI_ACQUIREDEVICE, MCI_WAIT, NULL, 0 );
+        if ( rc == MCIERR_SUCCESS ) {
+            rc = mciSendCommand( deviceId, MCI_PLAY, MCI_NOTIFY | MCI_FROM,
+                                 &playParams, 0 );                
+        } else if ( LOUSHORT( rc ) == MCIERR_DEVICE_LOCKED &&
+                    snd && snd->loops() < 0 ) {
+            // Enter the special state to let this infinitive sound start
+            // playing when the resource becomes available.
+            st = Waiting;
+            return FALSE;
+        }
+    }
+
+    if ( rc == MCIERR_SUCCESS ) {
+        st = Playing;
+    } else {
+        st = Stopped;
+#if defined(QT_DEBUG)
+        qDebug( "QAuBucketMMPM: failed to play sound file [%s] (rc=%04hu:%04hu)",
+                fName.data(), HIUSHORT( rc ), LOUSHORT( rc ) );
+#endif
+    }
+    
+    return st == Playing;
 }
 
 void QAuBucketMMPM::stop() 
 {
+    if ( st == Stopped )
+        return;
+
+    // always go to Stopped -- we won't retry
+    // (this is also used in MM_MCINOTIFY processing)
+    st = Stopped;
+    
     ULONG rc = mciSendCommand( deviceId, MCI_STOP, MCI_WAIT, NULL, 0 );                
 
-    if ( rc != MCIERR_SUCCESS ) {
-#if defined(QT_DEBUG)
-        qDebug( "QAuBucketMMPM: failed to stop sound file [%s] (rc=%04ld)",
-                fileName.data(), rc );
-#endif
+    if ( rc == MCIERR_SUCCESS ) {
+        // nothing
+    } else if ( LOUSHORT( rc ) == MCIERR_INSTANCE_INACTIVE ) {
+        // The infinite QSound-full bucket is now suspended (some other instance
+        // has gained the resource). Close this instance to prevent it from
+        // being automatically resumed later.
+        close();
+    } else {
+#if defined(QT_DEBUG)
+        qDebug( "QAuBucketMMPM: failed to stop sound file [%s] (rc=%04hu:%04hu)",
+                fName.data(), HIUSHORT( rc ), LOUSHORT( rc ) );
+#endif
+        // last chance to stop
+        close();
+    }
+}
+
+void QAuBucketMMPM::onDeviceGained( bool gained )
+{
+    if ( gained ) {
+        // We gained the device resource.
+        if ( st == Waiting ) {
+            /// @todo (dmik) For some reason, starting playback from here
+            //  (i.e. when we've been given the deivce resource back after
+            //  some other application finished using it exclusively), we can
+            //  get error 5053 (MCIERR_NO_CONNECTION) or even undocumented 5659.
+            //  When it happens, subsequent attempts to play something will
+            //  result into an unkillable hang... Experimemtal for now.  
+#if 1            
+            // A QSound-full bucket attempted to play eventually regained
+            // the resource. Start playing.
+            play();
+#else
+            st = Stopped;
+#endif
+        }
+    } else {
+        // We lost the device resource.
+        if ( st == Playing ) {
+            // Close the instance to prevent the playback from being resumed
+            // when the device is auto-gained again (by another instance that
+            // uses MCI_RETURN_RESOURCE in MCI_RELEASEDEVICE). The exception is
+            // a QSound-full bucket with an infinitive loop (that will continue
+            // playing when the resuorce is back).
+            if ( snd ) {
+                // infinitive loop?
+                if ( snd->loops() < 0 )
+                    return;
+                // decrease loops to zero
+                while ( srv->decLoop( snd ) > 0 ) ;
+            }
+            close();
+            if ( !snd ) {
+                // delete QSound-less bucket
+                delete this;
+            }
+        }
     }
 }
@@ -413 +580 @@
 QAuServerMMPM::QAuServerMMPM( QObject* parent ) :
     QAuServer( parent, "OS/2 MMPM Audio Server" ),
-    isOk( FALSE ), isAboutToQuit( FALSE ),
+    hwnd( NULLHANDLE ), isOk( FALSE ),
     mdmLib( "mdm.dll" ), mmioLib( "mmio.dll" )
 {
@@ -450 +617 @@
 #if defined(QT_DEBUG)
         qDebug( "QAuServerMMPM: failed to open the default waveaudio device "
-                "(rc=%04ld)", rc );
+                "(rc=%04hu:%04hu)", HIUSHORT( rc ), LOUSHORT( rc ) );
 #endif
         return;
@@ -458 +625 @@
     mciSendCommand( openParams.usDeviceID, MCI_CLOSE, MCI_WAIT, NULL, 0 );                
     
-    connect( qApp, SIGNAL( aboutToQuit() ), SLOT( aboutToQuit() ) );
+    connect( qApp, SIGNAL( aboutToQuit() ), SLOT( serverUninit() ) );
     
     isOk = TRUE;
@@ -465 +632 @@
 QAuServerMMPM::~QAuServerMMPM()
 {
+    // still alive?
+    if ( hwnd )
+        serverUninit();
+}    
+
+void QAuServerMMPM::serverUninit()
+{
 #if defined(QT_QSOUND_DEBUG)    
-    qDebug( "~QAuServerMMPM(): buckets left: %d", buckets.count() );
-#endif
-
-    // deassociate all remaining buckets from QSound objects and delete them
-    // (note that deleting a bucket will remove it from the dictionary, which
-    // in turn will update all dictionary iterators to point to the next item,
-    // so there is no iterator increment statement below) 
-    QIntDictIterator< QAuBucketMMPM > it( buckets );
-    while ( it.current() ) {
-        QSound *s = it.current()->sound();
+    qDebug( "QAuServerMMPM::serverUninit(): buckets left: %d",
+            bucketList.count() );
+#endif
+
+    Q_ASSERT( hwnd );
+    if ( hwnd == NULLHANDLE )
+        return;
+
+    WinDestroyWindow( hwnd );
+    hwnd = NULLHANDLE;
+
+    // Deassociate all remaining buckets from QSound objects and delete them
+    // (note that deleting a bucket will remove it from the list, which
+    // in turn will advance the current item to the next one, so current() is
+    // is used instead of next() in the loop). 
+    for ( QAuBucketMMPM *b = bucketList.first(); b; b = bucketList.current() ) {
+        QSound *s = b->sound();
         if ( s ) {
             // the below call will delete the associated bucket
             setBucket ( s, 0 );
         } else {
-            delete it.current();
+            delete b;
         }
     }
     
-    Q_ASSERT( buckets.count() == 0 );
-    
+    Q_ASSERT( bucketList.count() == 0 );
+    Q_ASSERT( bucketMap.count() == 0 );
+
     mmioClose = 0;
     mmioOpen = 0;
@@ -503 +685 @@
         setBucket( s, b );
 #if defined(QT_QSOUND_DEBUG)    
-        qDebug( "init(): bucket=%p sound=[%s]", b, s->fileName().latin1() );
+        qDebug( "QAuServerMMPM::init(): bucket=%p [%s]",
+                b, b->fileName().data() );
 #endif        
     } else {
@@ -519 +702 @@
     if ( b->okay() ) {
 #if defined(QT_QSOUND_DEBUG)    
-        qDebug( "play(QString): bucket=%p sound=[%s]", b, filename.latin1() );
+        qDebug( "play(QString): bucket=%p [%s]", b, b->fileName().data() );
 #endif        
-        b->play();
-        // b will be deleted in WindowProc()
+        if ( b->play() ) {
+            // b will be deleted in WindowProc() or in onDeviceGained()
+        } else {
+            delete b;
+        }
     } else {
         delete b;
@@ -541 +727 @@
     if ( b ) {
 #if defined(QT_QSOUND_DEBUG)    
-        qDebug( "play(QSound): bucket=%p sound=[%s]", b, s->fileName().latin1() );
+        qDebug( "play(QSound): bucket=%p [%s]", b, b->fileName().data() );
 #endif        
         b->play();
@@ -590 +776 @@
             USHORT code = SHORT1FROMMP( mp1 );
             USHORT deviceId = SHORT1FROMMP( mp2 );
+            USHORT mcimsg = SHORT2FROMMP( mp2 );
 #if defined(QT_QSOUND_DEBUG)            
-            qDebug( "MM_MCINOTIFY: code=%04hX deviceId=%04hX", code, deviceId );
+            qDebug( "MM_MCINOTIFY: code=0x%04hX, deviceId=%04hu, mcimsg=%04hu",
+                    code, deviceId, mcimsg );
 #endif            
-
-            QAuBucketMMPM *b = that->buckets.find( deviceId );
+            Q_ASSERT( mcimsg == MCI_PLAY ); 
+            if ( mcimsg != MCI_PLAY )
+                return 0;
+
+            QAuBucketMMPM *b = that->bucketMap.find( deviceId );
+            // There will be a late notification if the sound is
+            // playing when close() happens. Just return silently.
             if ( !b )
                 return 0;
+
 #if defined(QT_QSOUND_DEBUG)            
-            qDebug( "MM_MCINOTIFY: bucket=%p", b );
+            qDebug( "MM_MCINOTIFY: bucket=%p [%s]", b, b->fileName().data() );
 #endif            
             
             QSound *sound = b->sound();
             if ( sound ) {
-                if ( code == MCI_NOTIFY_SUCCESSFUL ) {
+                bool returnResource = FALSE;
+                if ( b->state() == QAuBucketMMPM::Stopped ) {
+                    // It's possible that MCI_STOP is issued right after MCI_PLAY
+                    // has successfilly finished and sent MM_MCINOTIFY but before
+                    // we start it again here. Obey the STOP request.
+                    returnResource = TRUE;
+                } else if ( code == MCI_NOTIFY_SUCCESSFUL ) {
                     // play the sound until there are no loops left
                     int loopsLeft = that->decLoop( sound );
                     if ( loopsLeft != 0 )
                         b->play();
+                    else
+                        returnResource = TRUE;
+                } else if ( code != MCI_NOTIFY_SUPERSEDED ) {
+                    returnResource = TRUE;
+                }
+                if ( returnResource ) {
+                    // let infinitive sounds continue playing
+                    mciSendCommand( deviceId, MCI_RELEASEDEVICE,
+                                    MCI_RETURN_RESOURCE, NULL, 0 );
                 }
             } else {
-                // delete QSound'less bucket when finished or stopped playing
+                // delete QSound-less bucket when finished or stopped playing
+                // (closing the instance will return the resource) 
                 delete b;
             }
@@ -616 +826 @@
             return 0;
         }
-        case WM_USER: {
-            HMMIO fileHandle = LONGFROMMP( mp1 );
-            USHORT deviceId = SHORT1FROMMP( mp2 );
+        case MM_MCIPASSDEVICE: {
+            if ( !that )
+                return 0;
+            
+            USHORT deviceId = SHORT1FROMMP( mp1 );
+            USHORT event = SHORT1FROMMP( mp2 );
 #if defined(QT_QSOUND_DEBUG)            
-            qDebug( "WM_USER: deviceId=%04hX", deviceId );
+            qDebug( "MM_MCIPASSDEVICE: deviceId=%04hu, event=0x%04hX",
+                    deviceId, event );
 #endif            
-            // there should be no buckets with the given ID at this point
-            Q_ASSERT( that->buckets.find( deviceId ) == 0 );
-            mciSendCommand( deviceId, MCI_CLOSE, MCI_WAIT, NULL, 0 );                
-            mmioClose( fileHandle, 0 );
+            QAuBucketMMPM *b = that->bucketMap.find( deviceId );
+            if ( !b )
+                return 0;
+
+#if defined(QT_QSOUND_DEBUG)            
+            qDebug( "MM_MCIPASSDEVICE: bucket=%p [%s]", b, b->fileName().data() );
+#endif
+            // Note: this call may delete b
+            b->onDeviceGained( event == MCI_GAINING_USE );
+            
+            return 0;
         }
     }