Merge pull request #1415 from wutschel/rework_torch

Maintenance: Implement KVO for torch properties and move torch methods to RemoteController

Author: kambala-decapitator

XBMC Remote/RemoteController.h

@@ -10,6 +10,8 @@
 #import "DSJSONRPC.h"
 #import "VolumeSliderView.h"
 
+@import AVFoundation;
+
 typedef NS_ENUM(NSInteger, RemotePositionType) {
     RemoteAtTop,
     RemoteAtBottom,
@@ -56,5 +58,6 @@ typedef NS_ENUM(NSInteger, RemotePositionType) {
 
 @property (strong, nonatomic) id detailItem;
 @property (nonatomic, strong) NSTimer *holdKeyTimer;
+@property (nonatomic, strong) AVCaptureDevice *avCaptureDevice;
 
 @end

XBMC Remote/RemoteController.m

@@ -48,6 +48,10 @@
 #define KEY_REPEAT_TIMEOUT 0.1
 #define GESTUREZONE_RADIUS 20.0
 #define GESTUREZONE_BORDERWIDTH 1.0
+#define KEYPATH_TORCHACTIVE @"torchActive"
+#define KEYPATH_TORCHAVAILABLE @"torchAvailable"
+
+static void *TorchRemoteContext = &TorchRemoteContext;
 
 @interface RemoteController ()
 
@@ -1037,12 +1041,43 @@ - (void)viewWillAppear:(BOOL)animated {
                                              selector:@selector(handleDidBecomeActive)
                                                  name:UIApplicationDidBecomeActiveNotification
                                                object:nil];
+    
+    [self.avCaptureDevice addObserver:self
+                           forKeyPath:KEYPATH_TORCHACTIVE
+                              options:NSKeyValueObservingOptionNew
+                              context:TorchRemoteContext];
+    
+    [self.avCaptureDevice addObserver:self
+                           forKeyPath:KEYPATH_TORCHAVAILABLE
+                              options:NSKeyValueObservingOptionNew
+                              context:TorchRemoteContext];
+}
+
+- (void)observeValueForKeyPath:(NSString*)keyPath
+                      ofObject:(id)object
+                        change:(NSDictionary*)change
+                       context:(void*)context {
+    if (context == TorchRemoteContext) {
+        if ([keyPath isEqualToString:KEYPATH_TORCHACTIVE]) {
+            torchIsOn = [change[NSKeyValueChangeNewKey] boolValue];
+            [self setTorchIcon:torchIsOn];
+        }
+        else if ([keyPath isEqualToString:KEYPATH_TORCHAVAILABLE]) {
+            torchButton.enabled = [change[NSKeyValueChangeNewKey] boolValue];
+        }
+    }
+    else {
+        [super observeValueForKeyPath:keyPath
+                             ofObject:object
+                               change:change
+                              context:context];
+    }
 }
 
 - (void)handleDidBecomeActive {
     // Update torch mode
-    torchIsOn = [Utilities isTorchOn];
-    [Utilities turnTorchOn:torchButton on:torchIsOn];
+    torchIsOn = self.avCaptureDevice.torchActive;
+    [self setTorchIcon:torchIsOn];
 }
 
 - (void)enablePopGestureRecognizer {
@@ -1074,9 +1109,19 @@ - (void)viewWillDisappear:(BOOL)animated {
     self.slidingViewController.panGesture.delegate = nil;
 }
 
-- (void)turnTorchOn:(id)sender {
+- (void)toggleTorch {
     torchIsOn = !torchIsOn;
-    [Utilities turnTorchOn:sender on:torchIsOn];
+    
+    AVCaptureDevice *device = self.avCaptureDevice;
+    [device lockForConfiguration:nil];
+    device.torchMode = torchIsOn ? AVCaptureTorchModeOn : AVCaptureTorchModeOff;
+    [device unlockForConfiguration];
+}
+
+- (void)setTorchIcon:(BOOL)torchActive {
+    UIImage *buttonImage = [UIImage imageNamed:torchActive ? @"torch_on" : @"torch"];
+    buttonImage = [Utilities colorizeImage:buttonImage withColor:ICON_TINT_COLOR];
+    [torchButton setImage:buttonImage forState:UIControlStateNormal];
 }
 
 - (void)dismissModal {
@@ -1102,7 +1147,7 @@ - (void)setRemoteToPosition {
 }
 
 - (void)createRemoteToolbarWidth:(CGFloat)width xMin:(CGFloat)xMin yMax:(CGFloat)yMax {
-    torchIsOn = [Utilities isTorchOn];
+    torchIsOn = self.avCaptureDevice.torchActive;
     // iPhone layout has 5 buttons (Gesture > Keyboard > Info > Torch > Additional) with flex spaces around buttons.
     // iPad layout has 6 buttons (Settings > Gesture > Keyboard > Info > Torch > Additional) with flex spaces around buttons.
     // iPhone has an addtional button to toggle the remote's vertical position
@@ -1170,11 +1215,9 @@ - (void)createRemoteToolbarWidth:(CGFloat)width xMin:(CGFloat)xMin yMax:(CGFloat
     frame.origin.x += ToolbarPadding;
     torchButton.frame = frame;
     torchButton.showsTouchWhenHighlighted = YES;
-    buttonImage = [UIImage imageNamed:torchIsOn ? @"torch_on" : @"torch"];
-    buttonImage = [Utilities colorizeImage:buttonImage withColor:ICON_TINT_COLOR];
-    [torchButton setImage:buttonImage forState:UIControlStateNormal];
-    [torchButton addTarget:self action:@selector(turnTorchOn:) forControlEvents:UIControlEventTouchUpInside];
-    torchButton.enabled = [Utilities hasTorch];
+    torchButton.enabled = self.avCaptureDevice.torchAvailable;
+    [self setTorchIcon:torchIsOn];
+    [torchButton addTarget:self action:@selector(toggleTorch) forControlEvents:UIControlEventTouchUpInside];
     [remoteToolbar addSubview:torchButton];
 
     if (IS_IPHONE) {
@@ -1208,6 +1251,7 @@ - (void)viewDidLoad {
     [super viewDidLoad];
 
     self.edgesForExtendedLayout = UIRectEdgeNone;
+    self.avCaptureDevice = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
 
     [self loadRemoteMode];
     [self configureView];

XBMC Remote/Utilities.h

@@ -86,9 +86,6 @@ typedef NS_ENUM(NSInteger, LogoBackgroundType) {
 + (CGSize)getSizeOfLabel:(UILabel*)label;
 + (UIImage*)applyRoundedEdgesImage:(UIImage*)image;
 + (void)applyRoundedEdgesView:(UIView*)view;
-+ (void)turnTorchOn:(UIButton*)button on:(BOOL)torchOn;
-+ (BOOL)hasTorch;
-+ (BOOL)isTorchOn;
 + (CGFloat)getBottomPadding;
 + (CGFloat)getTopPadding;
 + (CGFloat)getTopPaddingWithNavBar:(UINavigationController*)navCtrl;

XBMC Remote/Utilities.m

@@ -6,7 +6,6 @@
 //  Copyright (c) 2013 joethefox inc. All rights reserved.
 //
 
-#import <AVFoundation/AVFoundation.h>
 #import <StoreKit/StoreKit.h>
 #import <arpa/inet.h>
 #import <mach/mach.h>
@@ -951,45 +950,6 @@ + (void)applyRoundedEdgesView:(UIView*)view {
     }
 }
 
-+ (void)turnTorchOn:(UIButton*)button on:(BOOL)torchOn {
-    AVCaptureDevice *device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
-    if (!(device.hasTorch && device.hasFlash)) {
-        return;
-    }
-    
-    AVCapturePhotoSettings *settings = [AVCapturePhotoSettings photoSettings];
-    UIImage *img;
-    [device lockForConfiguration:nil];
-    // Set torch and select button image
-    if (torchOn) {
-        device.torchMode = AVCaptureTorchModeOn;
-        settings.flashMode = AVCaptureFlashModeOn;
-        img = [UIImage imageNamed:@"torch_on"];
-    }
-    else {
-        device.torchMode = AVCaptureTorchModeOff;
-        settings.flashMode = AVCaptureFlashModeOff;
-        img = [UIImage imageNamed:@"torch"];
-    }
-    [button setImage:img forState:UIControlStateNormal];
-        
-    [device unlockForConfiguration];
-}
-
-+ (BOOL)hasTorch {
-    AVCaptureDevice *device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
-    return device.hasTorch && device.hasFlash;
-}
-
-+ (BOOL)isTorchOn {
-    BOOL torchIsOn = NO;
-    AVCaptureDevice *device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
-    if (device.hasTorch && device.hasFlash) {
-        torchIsOn = device.torchActive;
-    }
-    return torchIsOn;
-}
-
 + (CGFloat)getBottomPadding {
     CGFloat bottomPadding = UIApplication.sharedApplication.keyWindow.safeAreaInsets.bottom;
     return bottomPadding;