Changeset 1386 for portaudio/trunk/src/hostapi/asio/pa_asio.cpp

Timestamp:

06/28/08 14:27:34 (5 months ago)

Author:

philburk

Message:

Supports multiple threads using ASIO by adding CoInitialize?(0) and CoUninitialize?() calls.

Files:

• portaudio/trunk/src/hostapi/asio/pa_asio.cpp (modified) (22 diffs)

portaudio/trunk/src/hostapi/asio/pa_asio.cpp

@@ -966 +966 @@
 }
 
-
+/* Unload whatever we loaded in LoadAsioDriver().
+   Also balance the call to CoInitialize(0).
+*/
+static void UnloadAsioDriver( void )
+{
+        ASIOExit();
+        CoUninitialize();
+}
 
 /*
     load the asio driver named by <driverName> and return statistics about
     the driver in info. If no error occurred, the driver will remain open
-    and must be closed by the called by calling ASIOExit() - if an error
-    is returned the driver will already be closed.
+    and must be closed by the called by calling UnloadAsioDriver() - if an error
+    is returned the driver will already be unloaded.
 */
 static PaError LoadAsioDriver( PaAsioHostApiRepresentation *asioHostApi, const char *driverName,
@@ -981 +988 @@
     int asioIsInitialized = 0;
 
-    /* @todo note that the V18 version always called CoInitialize() here to ensure 
-        that COM was initialized before loading the driver. 
-        probably the docs need to require clients to initialize COM in new threads?
+    /* 
+        ASIO uses CoCreateInstance() to load a driver. That requires that
+        CoInitialize(0) be called for every thread that loads a driver.
+        It is OK to call CoInitialize(0) multiple times form one thread as long
+        as it is balanced by a call to CoUninitialize(). See UnloadAsioDriver().
+
+        The V18 version called CoInitialize() starting on 2/19/02.
+        That was removed from PA V19 for unknown reasons.
+        Phil Burk added it back on 6/27/08 so that JSyn would work.
     */
+        CoInitialize( 0 );
+
     if( !asioHostApi->asioDrivers->loadDriver( const_cast<char*>(driverName) ) )
     {
+                /* If this returns an error then it might be because CoInitialize(0) was removed.
+                  It should be called right before this.
+            */
         result = paUnanticipatedHostError;
         PA_ASIO_SET_LAST_HOST_ERROR( 0, "Failed to load ASIO driver" );
@@ -1032 +1050 @@
 error:
     if( asioIsInitialized )
-        ASIOExit();
-
+        {
+                ASIOExit();
+        }
+        CoUninitialize();
     return result;
 }
@@ -1276 +1296 @@
                 {
                     result = paInsufficientMemory;
-                    goto error;
+                    goto error_unload;
                 }
 
@@ -1289 +1309 @@
                         result = paUnanticipatedHostError;
                         PA_ASIO_SET_LAST_ASIO_ERROR( asioError );
-                        goto error;
+                        goto error_unload;
                     }
                 }
@@ -1302 +1322 @@
                         result = paUnanticipatedHostError;
                         PA_ASIO_SET_LAST_ASIO_ERROR( asioError );
-                        goto error;
+                        goto error_unload;
                     }
                 }
@@ -1308 +1328 @@
 
                 /* unload the driver */
-                ASIOExit();
+                UnloadAsioDriver();
 
                 (*hostApi)->deviceInfos[ (*hostApi)->info.deviceCount ] = deviceInfo;
@@ -1344 +1364 @@
 
     return result;
+
+error_unload:
+        UnloadAsioDriver();
 
 error:
@@ -1517 +1540 @@
     if( asioHostApi->openAsioDeviceIndex == paNoDevice )
     {
-        ASIOExit(); /* not sure if we should check for errors here */
+        UnloadAsioDriver(); /* not sure if we should check for errors here */
     }
 
@@ -1866 +1889 @@
         asioIsInitialized = 1;
     else{
-        PA_DEBUG(("OpenStream ERROR1\n"));
+        PA_DEBUG(("OpenStream ERROR1 - LoadAsioDriver returned %d\n", result));
         goto error;
     }
@@ -2578 +2601 @@
 
     if( asioIsInitialized )
-        ASIOExit();
-
+        {
+                UnloadAsioDriver();
+        }
     return result;
 }
@@ -2630 +2654 @@
 
     ASIODisposeBuffers();
-    ASIOExit();
+    UnloadAsioDriver();
 
     return result;
@@ -3383 +3407 @@
 
             /* If the available amount of data frames is insufficient. */
-            if( PaUtil_GetRingBufferReadAvailable(pRb) < lFramesPerBlock )
+            if( PaUtil_GetRingBufferReadAvailable(pRb) < (long) lFramesPerBlock )
             {
                 /* Make sure, the event isn't already set! */
@@ -3558 +3582 @@
 
             /* If the available amount of buffers is insufficient. */
-            if( PaUtil_GetRingBufferWriteAvailable(pRb) < lFramesPerBlock )
+            if( PaUtil_GetRingBufferWriteAvailable(pRb) < (long) lFramesPerBlock )
             {
                 /* Make sure, the event isn't already set! */
@@ -3717 +3741 @@
     asioDeviceInfo = (PaAsioDeviceInfo*)hostApi->deviceInfos[hostApiDevice];
 
-    /* @todo note that the V18 version always called CoInitialize() here to ensure 
-        that COM was initialized before loading the driver. 
-        probably the docs need to require clients to initialize COM in new threads?
-    */
+    /* See notes about CoInitialize(0) in LoadAsioDriver(). */
+        CoInitialize(0);
+
     if( !asioHostApi->asioDrivers->loadDriver( const_cast<char*>(asioDeviceInfo->commonDeviceInfo.name) ) )
     {
@@ -3769 +3792 @@
     }
 
+        CoUninitialize();
 PA_DEBUG(("PaAsio_ShowControlPanel: ASIOExit(): %s\n", PaAsio_GetAsioErrorText(asioError) ));
 
@@ -3775 +3799 @@
 error:
     if( asioIsInitialized )
-        ASIOExit();
+        {
+                ASIOExit();
+        }
+        CoUninitialize();
 
     return result;
@@ -3886 +3913 @@
 
         /* If the blocking i/o buffer contains enough output data, */
-        if( PaUtil_GetRingBufferReadAvailable(pRb) >= framesPerBuffer )
+        if( PaUtil_GetRingBufferReadAvailable(pRb) >= (long) framesPerBuffer )
         {
             /* Extract the requested data from the ring buffer. */
@@ -3900 +3927 @@
 
             /* If playback is to be stopped */
-            if( blockingState->stopFlag && PaUtil_GetRingBufferReadAvailable(pRb) < framesPerBuffer )
+            if( blockingState->stopFlag && PaUtil_GetRingBufferReadAvailable(pRb) < (long) framesPerBuffer )
             {
                 /* Extract all the remaining data from the ring buffer,
@@ -3909 +3936 @@
 
         /* Set blocking i/o event? */
-        if( blockingState->writeBuffersRequestedFlag && PaUtil_GetRingBufferWriteAvailable(pRb) >= blockingState->writeBuffersRequested )
+        if( blockingState->writeBuffersRequestedFlag && PaUtil_GetRingBufferWriteAvailable(pRb) >= (long) blockingState->writeBuffersRequested )
         {
             /* Reset buffer request. */
@@ -3935 +3962 @@
 
         /* If the blocking i/o buffer contains not enough input buffers */
-        if( PaUtil_GetRingBufferWriteAvailable(pRb) < framesPerBuffer )
+        if( PaUtil_GetRingBufferWriteAvailable(pRb) < (long) framesPerBuffer )
         {
             /* Signalize a read-buffer overflow. */
@@ -3948 +3975 @@
 
         /* Set blocking i/o event? */
-        if( blockingState->readFramesRequestedFlag && PaUtil_GetRingBufferReadAvailable(pRb) >= blockingState->readFramesRequested )
+        if( blockingState->readFramesRequestedFlag && PaUtil_GetRingBufferReadAvailable(pRb) >= (long) blockingState->readFramesRequested )
         {
             /* Reset buffer request. */