More robust result checks.

kstenerud · kstenerud · commit f3da91dceed0 · 2013-11-13T09:50:30.000-08:00
All returns from OpenAL are now checked. A failure will cause the affected object to abort construction. This includes OALSimpleAudio.
This means that you must check the result of [OALSimpleAudio sharedInstance] at least once to be sure it successfully constructed.
diff --git a/ObjectAL/ObjectAL (iOS)/OALSimpleAudio.m b/ObjectAL/ObjectAL (iOS)/OALSimpleAudio.m
@@ -116,15 +116,29 @@ - (id) initWithReservedSources:(int) reservedSources
 		OAL_LOG_DEBUG(@"%@: Init with %d reserved sources, %d mono, %d stereo",
                       self, reservedSources, monoSources, stereoSources);
 		device = [[ALDevice alloc] initWithDeviceSpecifier:nil];
+        if(device == nil)
+		{
+			OAL_LOG_ERROR(@"%@: Could not create OpenAL device", self);
+            goto initFailed;
+		}
         context = [[ALContext alloc] initOnDevice:device
                                   outputFrequency:44100
                                  refreshIntervals:10
                                synchronousContext:FALSE
                                       monoSources:monoSources
                                     stereoSources:stereoSources];
+        if(context == nil)
+		{
+			OAL_LOG_ERROR(@"%@: Could not create OpenAL context", self);
+            goto initFailed;
+		}
         [self initCommon:reservedSources];
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (id) initWithSources:(int) reservedSources
@@ -133,17 +147,34 @@ - (id) initWithSources:(int) reservedSources
 	{
 		OAL_LOG_DEBUG(@"%@: Init with %d reserved sources", self, reservedSources);
 		device = [[ALDevice alloc] initWithDeviceSpecifier:nil];
+        if(device == nil)
+		{
+			OAL_LOG_ERROR(@"%@: Could not create OpenAL device", self);
+            goto initFailed;
+		}
         context = [[ALContext alloc] initOnDevice:device attributes:nil];
+        if(context == nil)
+		{
+			OAL_LOG_ERROR(@"%@: Could not create OpenAL contextself", self);
+            goto initFailed;
+		}
         [self initCommon:reservedSources];
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
 {
 	OAL_LOG_DEBUG(@"%@: Dealloc", self);
 #if NS_BLOCKS_AVAILABLE && OBJECTAL_CFG_USE_BLOCKS && !__has_feature(objc_arc)
-	dispatch_release(oal_dispatch_queue);
+    if(oal_dispatch_queue != nil)
+    {
+        dispatch_release(oal_dispatch_queue);
+    }
 #endif
 
 	as_release(backgroundTrack);
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALBuffer.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALBuffer.m
@@ -65,21 +65,28 @@ - (id) initWithName:(NSString*) nameIn
 		bufferId = [ALWrapper genBuffer];
 		if(nil == [OpenALManager sharedInstance].currentContext)
 		{
-			OAL_LOG_ERROR(@"Cannot allocate a buffer without a current context. Make sure [OpenALManager sharedInstance].currentContext is valid");
-			as_release(self);
-			return nil;
+			OAL_LOG_ERROR(@"%@: Cannot allocate a buffer without a current context. Make sure [OpenALManager sharedInstance].currentContext is valid", self);
+            goto initFailed;
 		}
 		device = as_retain([OpenALManager sharedInstance].currentContext.device);
 		bufferData = data;
 		format = formatIn;
 		freeDataOnDestroy = YES;
 		parentBuffer = nil;
 
-		[ALWrapper bufferDataStatic:bufferId format:format data:bufferData size:size frequency:frequency];
+		if(![ALWrapper bufferDataStatic:bufferId format:format data:bufferData size:size frequency:frequency])
+        {
+            OAL_LOG_ERROR(@"%@: Failed to create an OpenAL buffer", self);
+            goto initFailed;
+        }
 		
 		duration = (float)self.size / ((float)(self.frequency * self.channels * self.bits) / 8);
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALCaptureDevice.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALCaptureDevice.m
@@ -59,8 +59,17 @@ - (id) initWithDeviceSpecifier:(NSString*) deviceSpecifier
 									frequency:frequency
 									   format:format
 								   bufferSize:bufferSize];
+        if(device == nil)
+        {
+            OAL_LOG_ERROR(@"%@: Failed to initialize OpenAL capture device", self);
+            goto initFailed;
+        }
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALChannelSource.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALChannelSource.m
@@ -102,15 +102,24 @@ - (id) initWithSources:(int) reservedSources
 		OAL_LOG_DEBUG(@"%@: Init with %d sources", self, reservedSources);
 
 		context = as_retain([OpenALManager sharedInstance].currentContext);
+        if(context == nil)
+        {
+            OAL_LOG_ERROR(@"%@: Could not initialize channel: Context is nil", self);
+            goto initFailed;
+        }
 
 		sourcePool = [[ALSoundSourcePool alloc] init];
 
         for(int i = 0; i < reservedSources; i++)
         {
-            [self addSource:[ALSource source]];
+            [self addSource:nil];
         }            
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
@@ -517,6 +526,11 @@ - (void) addSource:(id<ALSoundSource>) source
         if(nil == source)
         {
             source = [ALSource source];
+            if(source == nil)
+            {
+                OAL_LOG_ERROR(@"%@: Could not create an OpenAL source", self);
+                return;
+            }
         }
         if(defaultsInitialized)
         {
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALContext.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALContext.m
@@ -150,9 +150,8 @@ - (id) initOnDevice:(ALDevice *) deviceIn attributes:(NSArray*) attributesIn
 
 		if(nil == deviceIn)
 		{
-			OAL_LOG_ERROR(@"%@: Failed to init because device was nil. Returning nil", self);
-			as_release(self);
-			return nil;
+			OAL_LOG_ERROR(@"%@: Could not init context: Device is nil", self);
+            goto initFailed;
 		}
 
 		suspendHandler = [[OALSuspendHandler alloc] initWithTarget:self selector:@selector(setSuspended:)];
@@ -176,6 +175,11 @@ - (id) initOnDevice:(ALDevice *) deviceIn attributes:(NSArray*) attributesIn
 
 		// Open the context with our list of attributes.
 		context = [ALWrapper createContext:device.device attributes:attributesList];
+        if(context == nil)
+        {
+            OAL_LOG_ERROR(@"%@: Failed to create OpenAL context", self);
+            goto initFailed;
+        }
 		
 		listener = [[ALListener alloc] initWithContext:self];
 		
@@ -213,6 +217,10 @@ - (id) initOnDevice:(ALDevice *) deviceIn attributes:(NSArray*) attributesIn
 		[device addSuspendListener:self];
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALDevice.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALDevice.m
@@ -60,12 +60,15 @@ - (id) initWithDeviceSpecifier:(NSString*) deviceSpecifier
 		device = [ALWrapper openDevice:deviceSpecifier];
 		if(nil == device)
 		{
-			OAL_LOG_ERROR(@"%@: Failed to init device %@. Returning nil", self, deviceSpecifier);
-			as_release(self);
-			return nil;
+			OAL_LOG_ERROR(@"%@: Failed to create OpenAL device %@", self, deviceSpecifier);
+            goto initFailed;
 		}
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALListener.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALListener.m
@@ -56,12 +56,21 @@ - (id) initWithContext:(ALContext*) contextIn
 {
 	if(nil != (self = [super init]))
 	{
+        if(contextIn == nil)
+        {
+            OAL_LOG_ERROR(@"%@: Could not init listener: Context is nil", self);
+            goto initFailed;
+        }
 		suspendHandler = [[OALSuspendHandler alloc] initWithTarget:nil selector:nil];
 
 		self.context = contextIn;
 		gain = 1.0f;
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc
diff --git a/ObjectAL/ObjectAL (iOS)/OpenAL/ALSource.m b/ObjectAL/ObjectAL (iOS)/OpenAL/ALSource.m
@@ -109,9 +109,8 @@ - (id) initOnContext:(ALContext*) contextIn
 
 		if(nil == contextIn)
 		{
-			OAL_LOG_ERROR(@"%@: Failed to init because context was nil. Returning nil", self);
-			as_release(self);
-			return nil;
+			OAL_LOG_ERROR(@"%@: Failed to init source: Context is nil", self);
+            goto initFailed;
 		}
 		
 		suspendHandler = [[OALSuspendHandler alloc] initWithTarget:self selector:@selector(setSuspended:)];
@@ -123,6 +122,11 @@ - (id) initOnContext:(ALContext*) contextIn
 			ALContext* realContext = [OpenALManager sharedInstance].currentContext;
 			[OpenALManager sharedInstance].currentContext = context;
 			sourceId = [ALWrapper genSource];
+            if(sourceId == (ALuint)AL_INVALID)
+            {
+                OAL_LOG_ERROR(@"%@: Failed to create OpenAL source", self);
+                goto initFailed;
+            }
 			[OpenALManager sharedInstance].currentContext = realContext;
 		}
 		OAL_LOG_DEBUG(@"%@: Created source %08x", self, sourceId);
@@ -135,6 +139,10 @@ - (id) initOnContext:(ALContext*) contextIn
         [[self class] notifySourceAllocated:self];
 	}
 	return self;
+
+initFailed:
+    as_release(self);
+    return nil;
 }
 
 - (void) dealloc

Original file line number	Diff line number	Diff line change
`@@ -102,15 +102,24 @@ - (id) initWithSources:(int) reservedSources`
`102`	`102`	`OAL_LOG_DEBUG(@"%@: Init with %d sources", self, reservedSources);`
`103`	`103`
`104`	`104`	`context = as_retain([OpenALManager sharedInstance].currentContext);`
	`105`	`+ if(context == nil)`
	`106`	`+ {`
	`107`	`+ OAL_LOG_ERROR(@"%@: Could not initialize channel: Context is nil", self);`
	`108`	`+ goto initFailed;`
	`109`	`+ }`
`105`	`110`
`106`	`111`	`sourcePool = [[ALSoundSourcePool alloc] init];`
`107`	`112`
`108`	`113`	`for(int i = 0; i < reservedSources; i++)`
`109`	`114`	`{`
`110`		`- [self addSource:[ALSource source]];`
	`115`	`+ [self addSource:nil];`
`111`	`116`	`}`
`112`	`117`	`}`
`113`	`118`	`return self;`
	`119`	`+`
	`120`	`+initFailed:`
	`121`	`+ as_release(self);`
	`122`	`+ return nil;`
`114`	`123`	`}`
`115`	`124`
`116`	`125`	`- (void) dealloc`
`@@ -517,6 +526,11 @@ - (void) addSource:(id<ALSoundSource>) source`
`517`	`526`	`if(nil == source)`
`518`	`527`	`{`
`519`	`528`	`source = [ALSource source];`
	`529`	`+ if(source == nil)`
	`530`	`+ {`
	`531`	`+ OAL_LOG_ERROR(@"%@: Could not create an OpenAL source", self);`
	`532`	`+ return;`
	`533`	`+ }`
`520`	`534`	`}`
`521`	`535`	`if(defaultsInitialized)`
`522`	`536`	`{`
Original file line number	Diff line number	Diff line change
`@@ -60,12 +60,15 @@ - (id) initWithDeviceSpecifier:(NSString*) deviceSpecifier`
`60`	`60`	`device = [ALWrapper openDevice:deviceSpecifier];`
`61`	`61`	`if(nil == device)`
`62`	`62`	`{`
`63`		`- OAL_LOG_ERROR(@"%@: Failed to init device %@. Returning nil", self, deviceSpecifier);`
`64`		`- as_release(self);`
`65`		`- return nil;`
	`63`	`+ OAL_LOG_ERROR(@"%@: Failed to create OpenAL device %@", self, deviceSpecifier);`
	`64`	`+ goto initFailed;`
`66`	`65`	`}`
`67`	`66`	`}`
`68`	`67`	`return self;`
	`68`	`+`
	`69`	`+initFailed:`
	`70`	`+ as_release(self);`
	`71`	`+ return nil;`
`69`	`72`	`}`
`70`	`73`
`71`	`74`	`- (void) dealloc`
Original file line number	Diff line number	Diff line change
`@@ -56,12 +56,21 @@ - (id) initWithContext:(ALContext*) contextIn`
`56`	`56`	`{`
`57`	`57`	`if(nil != (self = [super init]))`
`58`	`58`	`{`
	`59`	`+ if(contextIn == nil)`
	`60`	`+ {`
	`61`	`+ OAL_LOG_ERROR(@"%@: Could not init listener: Context is nil", self);`
	`62`	`+ goto initFailed;`
	`63`	`+ }`
`59`	`64`	`suspendHandler = [[OALSuspendHandler alloc] initWithTarget:nil selector:nil];`
`60`	`65`
`61`	`66`	`self.context = contextIn;`
`62`	`67`	`gain = 1.0f;`
`63`	`68`	`}`
`64`	`69`	`return self;`
	`70`	`+`
	`71`	`+initFailed:`
	`72`	`+ as_release(self);`
	`73`	`+ return nil;`
`65`	`74`	`}`
`66`	`75`
`67`	`76`	`- (void) dealloc`