Merge lp:~rockstar/ubuntuone-ios-music/remove-audiostreamer into lp:ubuntuone-ios-music

[Paul Hummer]

Replace AudioStreamer dependency with AVPlayer

This branch removes the need for AudioStreamer, a dilapidated dependency that hasn't really been needed since iOS 4, but has remained around for historical reasons. I've swapped it out for iOS's AVPlayer.

This has a wonderful side effect of removing a few (potential) memory leaks. UOPlayer hasn't lost any functionality in this change, and will make it easier to implement scrubbing when we get around to it.

[lp:~rockstar/ubuntuone-ios-music/remove-audiostreamer]

259. By Paul Hummer on 2013-02-13

Add support for the AudioSession (for backgrounding)

260. By Paul Hummer on 2013-02-13

Use notifications rather than the fragile time observer

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'Music/Models/Song.h'
--- Music/Models/Song.h	2013-02-07 00:26:32 +0000
+++ Music/Models/Song.h	2013-02-13 18:19:23 +0000
@@ -44,5 +44,6 @@
 
 @property (nonatomic, retain, readonly) NSString *cacheFilePath;
 @property (nonatomic, readonly) BOOL isDownloaded;
+@property (nonatomic, readonly) NSURL *localURL;
 
 @end

=== modified file 'Music/Models/Song.m'
--- Music/Models/Song.m	2013-01-28 23:11:50 +0000
+++ Music/Models/Song.m	2013-02-13 18:19:23 +0000
@@ -179,6 +179,12 @@
     return [[NSFileManager defaultManager] fileExistsAtPath:self.cacheFilePath];
 }
 
+- (NSURL *)localURL {
+    NSString *songPath = [[self idPath] urlParameterEncodedString];
+    NSURL *localURL = [NSURL URLWithString:[NSString stringWithFormat:@"http://localhost:9990/%@", songPath]];
+    return localURL;
+}
+
 /* This method exists for historical reasons currently, but should be deprecated soon. It formulates a path to send to the
    local auth server, and that auth server then disassembles the path to get the needed info out of it. I think it'd be much
    more efficient to just pass the song id currently.

=== modified file 'Music/Utilities/UOPlayer.h'
--- Music/Utilities/UOPlayer.h	2013-02-09 05:59:29 +0000
+++ Music/Utilities/UOPlayer.h	2013-02-13 18:19:23 +0000
@@ -7,6 +7,7 @@
 //
 
 #import <Foundation/Foundation.h>
+#import <CoreMedia/CoreMedia.h>
 
 @class Song;
 
@@ -30,8 +31,8 @@
 @interface UOPlayer : NSObject
 + (id)player;
 
-- (void)addSongs:(NSArray *)songs;
-- (void)addSongs:(NSArray *)songs withIndex:(NSUInteger)index;
+- (void)setSongs:(NSArray *)songs;
+- (void)setSongs:(NSArray *)songs withIndex:(NSUInteger)index;
 
 - (void)playPause;
 - (void)next;
@@ -40,11 +41,11 @@
 @property (nonatomic, readonly) NSUInteger currentIndex;
 @property (nonatomic, readonly) Song *currentSong;
 @property (nonatomic, readonly) NSArray *currentPlaylist;
-@property PlayerState state;
+@property (nonatomic, readonly) PlayerState state;
 
 @property (nonatomic) BOOL shuffle;
 @property (nonatomic) RepeatState repeat;
 
-- (double)streamerProgress;
+- (CMTime)streamerProgress;
 
 @end

=== modified file 'Music/Utilities/UOPlayer.m'
--- Music/Utilities/UOPlayer.m	2013-02-09 05:59:29 +0000
+++ Music/Utilities/UOPlayer.m	2013-02-13 18:19:23 +0000
@@ -7,17 +7,26 @@
 //
 
 #import "UOPlayer.h"
-#import "AudioStreamer.h"
 #import "Song.h"
+#import "Artist.h"
+#import "Album.h"
+#import <AVFoundation/AVFoundation.h>
+#import <CoreMedia/CoreMedia.h>
+#import <MediaPlayer/MediaPlayer.h>
 
 #import "U1AutoDownloadsManager.h"
 
-@interface UOPlayer () {
+#define AVPLAYERRATEPAUSE 0.0
+#define AVPLAYERRATEPLAY 1.0
+#define AVPLAYERPREVTHRESHOLD 5.0
+
+@interface UOPlayer () <AVAudioSessionDelegate> {
     NSArray *songs;
     NSArray *shuffledSongs;
     
-    AudioStreamer *streamer;
     float seekTime;
+    
+    AVPlayer *player;
 }
 @property (nonatomic, readwrite) NSUInteger currentIndex;
 @property (nonatomic, strong) U1AutoDownloadsManager *downloadManager;
@@ -47,22 +56,31 @@
     if (self == nil) { return self; }
     
     [self restoreSettings];
-    
     self.downloadManager = [[U1AutoDownloadsManager alloc] init];
-    
-    self.state = PLAYERSTATESTOP;
-    [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
-    
     [self addObserver:self forKeyPath:@"currentIndex" options:nil context:NULL];
     
+    player = [[AVPlayer alloc] init];
+    NSError *error;
+    AVAudioSession *audioSession = [AVAudioSession sharedInstance];
+    [audioSession setDelegate:self];
+    if ([audioSession setCategory:AVAudioSessionCategoryPlayback error:&error]) {
+        if ([audioSession setActive:YES error:nil]) {
+            [[UIApplication sharedApplication] beginReceivingRemoteControlEvents];
+        } else {
+            NSLog(@"AVAudioSession not active. Reason: %@", error.localizedDescription);
+        }
+    } else {
+        NSLog(@"AVAudioSession category not set. Reason: %@", error.localizedDescription);
+    }
+    
+    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(songComplete) name:AVPlayerItemDidPlayToEndTimeNotification object:nil];
+    
+    [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
     return self;
 }
 
 - (void)dealloc {
-    if (streamer) {
-        [streamer stop];
-        streamer = nil;
-    }
+    player = nil;
     songs = nil;
     shuffledSongs = nil;
     downloadManager = nil;
@@ -72,7 +90,7 @@
 
 - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
     if ([keyPath isEqual:@"currentIndex"]) {
-        [self.downloadManager setPlaylist:[self currentPlaylist] andIndex:self.currentIndex];
+        [self currentIndexChange];
     } else {
         [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
     }
@@ -106,8 +124,8 @@
 
 #pragma mark - Player state
 
-- (double)streamerProgress {
-    return streamer.progress;
+- (CMTime)streamerProgress {
+    return player.currentTime;
 }
 
 #pragma mark - Play queue management
@@ -123,17 +141,12 @@
     return (shuffle ? shuffledSongs : songs);
 }
 
-- (void)addSongs:(NSArray *)_songs {
-    [self addSongs:_songs withIndex:0];
+- (void)setSongs:(NSArray *)_songs {
+    [self setSongs:_songs withIndex:0];
 }
 
-- (void)addSongs:(NSArray *)_songs withIndex:(NSUInteger)index {
-    if (streamer != nil) {
-        [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
-        self.state = PLAYERSTATESTOP;
-        [streamer stop];
-        streamer = nil;
-    }
+- (void)setSongs:(NSArray *)_songs withIndex:(NSUInteger)index {
+    [player pause];
 
     songs = _songs;
     
@@ -151,21 +164,15 @@
     } else {
         self.currentIndex = index;
     }
-
-    
 }
 
 #pragma mark - Player controls
 
 - (void)playPause {
-    if ([streamer isPaused]) {
-        self.state = PLAYERSTATEPLAY;
-        [streamer start];
-    } else if ([streamer isPlaying]) {
-        self.state = PLAYERSTATEPAUSE;
-        [streamer pause];
-    } else {
-        [self _playCurrentSong];
+    if (player.rate == AVPLAYERRATEPAUSE) {
+        [player play];
+    } else if (player.rate == AVPLAYERRATEPLAY) {
+        [player pause];
     }
     [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
 }
@@ -173,63 +180,45 @@
 - (void)next {
     switch (repeat) {
         case REPEATOFF:
-            [streamer stop];
-            self.state = PLAYERSTATESTOP;
-            if (self.currentIndex == ([[self currentPlaylist] count] - 1)) {
-                [streamer stop];
-                streamer = nil;
+        case REPEATONE:
+            if (self.currentIndex < ([[self currentPlaylist] count] - 1)) {
+                self.currentIndex = self.currentIndex + 1;
             } else {
-                self.currentIndex = self.currentIndex + 1;
-                [self playPause];
+                return;
             }
             break;
-        case REPEATONE:
-            [streamer stop];
-            [self playPause];
-            break;
         case REPEATALL:
             if (self.currentIndex == [[self currentPlaylist] count] - 1) {
                 self.currentIndex = 0;
             } else {
                 self.currentIndex = self.currentIndex + 1;
             }
-            self.state = PLAYERSTATESTOP;
-            [streamer stop];
-            [self playPause];
             break;
     }
-    [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
 }
 
 - (void)prev {
+    if (CMTimeGetSeconds(player.currentTime) > AVPLAYERPREVTHRESHOLD) {
+        /* If we're into the song already, just touch the currentIndex to restart it. */
+        self.currentIndex = self.currentIndex;
+        return;
+    }
+    
     switch (repeat) {
         case REPEATOFF:
-            [streamer stop];
-            self.state = PLAYERSTATESTOP;
-            if (self.currentIndex == 0) {
-                [streamer stop];
-                streamer = nil;
-            } else {
+        case REPEATONE:
+            if (self.currentIndex != 0) {
                 self.currentIndex = self.currentIndex - 1;
-                [self playPause];
             }
             break;
-        case REPEATONE:
-            [streamer stop];
-            [self playPause];
-            break;
         case REPEATALL:
             if (self.currentIndex == 0) {
                 self.currentIndex = [[self currentPlaylist] count] - 1;
             } else {
                 self.currentIndex = self.currentIndex - 1;
             }
-            self.state = PLAYERSTATESTOP;
-            [streamer stop];
-            [self playPause];
             break;
     }
-    [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
 }
 
 #pragma mark - Setters
@@ -255,32 +244,31 @@
 
 #pragma mark - Private methods
 
-- (void)_playCurrentSong {
-    if (streamer != nil) {
-        [streamer stop];
-        streamer = nil;
-    }
-    
-    seekTime = 0.0;
-    
-    Song *currentSong = [[self currentPlaylist] objectAtIndex:self.currentIndex];
-    
-    NSString *songPath = [[currentSong idPath] urlParameterEncodedString];
-    NSURL *localURL = [NSURL URLWithString:[NSString stringWithFormat:@"http://localhost:9990/%@", songPath]];
-    streamer = [[AudioStreamer alloc] initWithURL:localURL];
-    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(streamerStateChanged:) name:ASStatusChangedNotification object:streamer];
-    
-    [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
-    self.state = PLAYERSTATEPLAY;
-    [streamer start];
+- (void)currentIndexChange {
+    [self.downloadManager setPlaylist:[self currentPlaylist] andIndex:self.currentIndex];
+    
+    Song *song = [[self currentPlaylist] objectAtIndex:self.currentIndex];
+    AVPlayerItem *item = [[AVPlayerItem alloc] initWithURL:song.localURL];
+    [player replaceCurrentItemWithPlayerItem:item];
+    [player play];
     
     [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerSongChanged object:nil];
+    [[NSNotificationCenter defaultCenter] postNotificationName:kPlayerStateChanged object:nil];
 }
 
-- (void)streamerStateChanged:(NSNotification *)notification {
-    if ([streamer isIdle]) {
-        [self next];
+- (PlayerState)state {
+    if (player.currentItem == nil) {
+        return PLAYERSTATESTOP;
+    } else if (player.rate == AVPLAYERRATEPLAY) {
+        return PLAYERSTATEPLAY;
+    } else if (player.rate == AVPLAYERRATEPAUSE) {
+        return PLAYERSTATEPAUSE;
     }
+    return PLAYERSTATESTOP;
+}
+
+- (void)songComplete {
+    [self next];
 }
 
 @end

=== modified file 'Music/View Controllers/AlbumViewController.m'
--- Music/View Controllers/AlbumViewController.m	2013-02-11 03:55:13 +0000
+++ Music/View Controllers/AlbumViewController.m	2013-02-13 18:19:23 +0000
@@ -158,8 +158,7 @@
     NSUInteger index = [songs indexOfObject:song];
     
     UOPlayer *player = [UOPlayer player];
-    [player addSongs:songs withIndex:index];
-    [player playPause];
+    [player setSongs:songs withIndex:index];
 }
 
 @end

=== modified file 'Music/View Controllers/PlayerViewController.m'
--- Music/View Controllers/PlayerViewController.m	2013-02-11 04:18:27 +0000
+++ Music/View Controllers/PlayerViewController.m	2013-02-13 18:19:23 +0000
@@ -188,9 +188,9 @@
 }
 
 - (void)heartbeat:(NSTimer*)timer {
-    double progress = [[UOPlayer player] streamerProgress];
-    self.elapsedTime.text = [NSString clockStringFromSeconds:(int)progress];
-    self.progressView.value = progress;
+    CMTime time = [[UOPlayer player] streamerProgress];
+    self.elapsedTime.text = [NSString clockStringFromSeconds:CMTimeGetSeconds(time)];
+    self.progressView.value = (double)CMTimeGetSeconds(time);
 }
 
 @end

=== modified file 'Music/View Controllers/SongsViewController.m'
--- Music/View Controllers/SongsViewController.m	2013-02-11 03:55:13 +0000
+++ Music/View Controllers/SongsViewController.m	2013-02-13 18:19:23 +0000
@@ -73,8 +73,7 @@
     NSUInteger index = [songs indexOfObject:song];
     
     UOPlayer *player = [UOPlayer player];
-    [player addSongs:songs withIndex:index];
-    [player playPause];
+    [player setSongs:songs withIndex:index];
 }
 
 @end

=== modified file 'U1Music.xcodeproj/project.pbxproj'
--- U1Music.xcodeproj/project.pbxproj	2013-02-11 04:11:56 +0000
+++ U1Music.xcodeproj/project.pbxproj	2013-02-13 18:19:23 +0000
@@ -98,6 +98,8 @@
 		52AC3D811604513E00B4785D /* uncached.png in Resources */ = {isa = PBXBuildFile; fileRef = 52AC3D651604513E00B4785D /* uncached.png */; };
 		52AC3D821604513E00B4785D /* [e-mail] in Resources */ = {isa = PBXBuildFile; fileRef = 52AC3D661604513E00B4785D /* [e-mail] */; };
 		52AC3D841604539000B4785D /* [e-mail] in Resources */ = {isa = PBXBuildFile; fileRef = 52AC3D831604539000B4785D /* [e-mail] */; };
+		52BC20D516CB18A100E22294 /* AVFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 52BC20D416CB18A100E22294 /* AVFoundation.framework */; };
+		52BC20DC16CB417700E22294 /* CoreMedia.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 52BC20DB16CB417700E22294 /* CoreMedia.framework */; };
 		52E7F4A316AF1522003A46DA /* UbuntuOneAuthKit.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 528515941604F16D004A1F7C /* UbuntuOneAuthKit.a */; };
 		536D620B1144495400DFCE56 /* SystemConfiguration.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 536D620A1144495400DFCE56 /* SystemConfiguration.framework */; };
 		537DE2D9113F008C00875852 /* CoreFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 537DE2D8113F008C00875852 /* CoreFoundation.framework */; };
@@ -380,6 +382,8 @@
 		52AC3D651604513E00B4785D /* uncached.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = uncached.png; sourceTree = "<group>"; };
 		52AC3D661604513E00B4785D /* [e-mail] */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "[e-mail]"; sourceTree = "<group>"; };
 		52AC3D831604539000B4785D /* [e-mail] */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "[e-mail]"; sourceTree = "<group>"; };
+		52BC20D416CB18A100E22294 /* AVFoundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = AVFoundation.framework; path = System/Library/Frameworks/AVFoundation.framework; sourceTree = SDKROOT; };
+		52BC20DB16CB417700E22294 /* CoreMedia.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreMedia.framework; path = System/Library/Frameworks/CoreMedia.framework; sourceTree = SDKROOT; };
 		536D620A1144495400DFCE56 /* SystemConfiguration.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SystemConfiguration.framework; path = System/Library/Frameworks/SystemConfiguration.framework; sourceTree = SDKROOT; };
 		537DE2D8113F008C00875852 /* CoreFoundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreFoundation.framework; path = System/Library/Frameworks/CoreFoundation.framework; sourceTree = SDKROOT; };
 		53F675D7113B092C00822059 /* MediaPlayer.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = MediaPlayer.framework; path = System/Library/Frameworks/MediaPlayer.framework; sourceTree = SDKROOT; };
@@ -626,6 +630,8 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				52BC20DC16CB417700E22294 /* CoreMedia.framework in Frameworks */,
+				52BC20D516CB18A100E22294 /* AVFoundation.framework in Frameworks */,
 				53F675E8113B096400822059 /* AudioToolbox.framework in Frameworks */,
 				53F675DC113B093900822059 /* CFNetwork.framework in Frameworks */,
 				93DFFE3F135D70B60061F29F /* CoreData.framework in Frameworks */,
@@ -661,6 +667,7 @@
 		29B97314FDCFA39411CA2CEA /* CustomTemplate */ = {
 			isa = PBXGroup;
 			children = (
+				52BC20DB16CB417700E22294 /* CoreMedia.framework */,
 				5268508516AE516B001F65A6 /* RestKit.xcodeproj */,
 				5285158E1604F16B004A1F7C /* UbuntuOneAuthKit.xcodeproj */,
 				93F3346C1247FB78006C6707 /* Music */,
@@ -693,6 +700,7 @@
 		29B97323FDCFA39411CA2CEA /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
+				52BC20D416CB18A100E22294 /* AVFoundation.framework */,
 				5279764815F00B2600F8435F /* libz.dylib */,
 				5257416C16C5653100530CCC /* Crashlytics.framework */,
 				5268510716AEFD20001F65A6 /* MobileCoreServices.framework */,