add start/stop processing frames an timeout

Author: a31859

README.md

@@ -15,11 +15,22 @@ Work in progress...
 The plugin aims to be used with iOS version >= 7.
 
 ## Usage
-The plugin offers two functions `isDetecting` and `setPattern`.
+The plugin offers the functions `startProcessing`, `isDetecting` and `setPattern`.
+
+`startProcessing` - the plugin will process the video frames captured by the camera if the inputed argument is `true`, if the argument is `false` no frames will be processed. Calls on success if the argument is set and on error if no value set.
+**Note:** the plugins start with this option true.
+```javascript
+startProcessing(true or false, successCallback, errorCallback);
+```
+
 `isDetecting` - the plugin will callback on success function if detecting the pattern or on error function if it's not.
 ```javascript
 isDetecting(successCallback, errorCallback);
 ```
+`setDetectionTimeout` - this function will set a timeout (**in seconds**) in which the processing of the frames will not occur. Calls on success if the argument is set and on error if no value set.
+```javascript
+setDetectionTimeout(timeout, successCallback, errorCallback);
+```
 
 `setPattern` - sets the new pattern target to be detected. Calls on success if the pattern is set and on error if no pattern set. The input pattern must be a base64 image.
 ```javascript
@@ -28,6 +39,8 @@ setPattern(base64image, successCallback, errorCallback);
 
 ## Usage example
 ```javascript
+ImageDetectionPlugin.startProcessing(true, function(success){console.log(success);}, function(error){console.log(error);});
+
 ImageDetectionPlugin.isDetecting(function(success){console.log(success);}, function(error){console.log(error);});
 
 var img = new Image();
@@ -44,4 +57,6 @@ img.onload = function () {
   canvas = null;
 };
 img.src = "img/patterns/coke.jpg";
+
+ImageDetectionPlugin.setDetectionTimeout(2, function(success){console.log(success);}, function(error){console.log(error);});
 ```

src/ios/ImageDetectionPlugin.h

@@ -7,7 +7,6 @@
 {
     UIImageView *img;
     CvVideoCamera *camera;
-    CDVInvokedUrlCommand *_command;
 }
 
 @property (nonatomic, retain) CvVideoCamera *camera;
@@ -19,4 +18,8 @@
 
 - (void)setPattern:(CDVInvokedUrlCommand*)command;
 
+- (void)startProcessing:(CDVInvokedUrlCommand*)command;
+
+- (void)setDetectionTimeout:(CDVInvokedUrlCommand*)command;
+
 @end

src/ios/ImageDetectionPlugin.mm

@@ -10,9 +10,11 @@ @interface ImageDetectionPlugin()
 {
     Mat patt, desc1;
     vector<KeyPoint> kp1;
-    bool debug, thread_over, called_success_detection, called_failed_detection;
+    bool processFrames, debug, thread_over, called_success_detection, called_failed_detection;
     NSMutableArray *detection;
     NSString *callbackID;
+    NSNumber *last_time;
+    float timeout;
 }
 
 @end
@@ -41,22 +43,22 @@ - (void)greet:(CDVInvokedUrlCommand*)command
 -(void)isDetecting:(CDVInvokedUrlCommand*)command
 {
     callbackID = command.callbackId;
-//    [self.commandDelegate runInBackground:^{
-//        CDVPluginResult* plugin_result = nil;
-//        NSString* msg;
-//
-//        if ([self getState]) {
-//            msg = @"pattern detected";
-//            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:msg];
-//            [plugin_result setKeepCallbackAsBool:YES];
-//        } else {
-//            msg = @"pattern not detected";
-//            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:msg];
-//            [plugin_result setKeepCallbackAsBool:YES];
-//        }
-//
-//        [self.commandDelegate sendPluginResult:plugin_result callbackId:command.callbackId];
-//    }];
+    //    [self.commandDelegate runInBackground:^{
+    //        CDVPluginResult* plugin_result = nil;
+    //        NSString* msg;
+    //
+    //        if ([self getState]) {
+    //            msg = @"pattern detected";
+    //            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:msg];
+    //            [plugin_result setKeepCallbackAsBool:YES];
+    //        } else {
+    //            msg = @"pattern not detected";
+    //            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:msg];
+    //            [plugin_result setKeepCallbackAsBool:YES];
+    //        }
+    //
+    //        [self.commandDelegate sendPluginResult:plugin_result callbackId:command.callbackId];
+    //    }];
 }
 
 - (void)setPattern:(CDVInvokedUrlCommand*)command;
@@ -79,6 +81,51 @@ - (void)setPattern:(CDVInvokedUrlCommand*)command;
     }];
 }
 
+- (void)startProcessing:(CDVInvokedUrlCommand*)command;
+{
+    [self.commandDelegate runInBackground:^{
+        CDVPluginResult* plugin_result = nil;
+        NSNumber* argVal = [command.arguments objectAtIndex:0];
+        NSString* msg;
+
+        if (argVal != nil) {
+            if ([argVal boolValue] == YES) {
+                processFrames = true;
+                msg = @"Frame processing set to 'true'";
+            } else {
+                processFrames = false;
+                msg = @"Frame processing set to 'false'";
+            }
+            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:msg];
+        } else {
+            msg = @"No value";
+            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:msg];
+        }
+
+        [self.commandDelegate sendPluginResult:plugin_result callbackId:command.callbackId];
+    }];
+}
+
+- (void)setDetectionTimeout:(CDVInvokedUrlCommand*)command;
+{
+    [self.commandDelegate runInBackground:^{
+        CDVPluginResult* plugin_result = nil;
+        NSNumber* argVal = [command.arguments objectAtIndex:0];
+        NSString* msg;
+
+        if (argVal != nil && argVal > 0) {
+            timeout = [argVal floatValue];
+            msg = [NSString stringWithFormat:@"Processing timeout set to %@", argVal];
+            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:msg];
+        } else {
+            msg = @"No value or timeout value negative.";
+            plugin_result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:msg];
+        }
+
+        [self.commandDelegate sendPluginResult:plugin_result callbackId:command.callbackId];
+    }];
+}
+
 -(void)setBase64Pattern:(NSString *)image_base64
 {
     if ([image_base64 rangeOfString:@"data:"].location == NSNotFound) {
@@ -128,11 +175,16 @@ - (void)pluginInitialize {
 
     self.camera.delegate = self;
 
+    processFrames = true;
     debug = false;
     thread_over = true;
     called_success_detection = false;
     called_failed_detection = true;
 
+    timeout = 0.0;
+    NSTimeInterval timeStamp = [[NSDate date] timeIntervalSince1970];
+    last_time = [NSNumber numberWithDouble: timeStamp];
+
     detection = [[NSMutableArray alloc] init];
 
     [self.camera start];
@@ -143,16 +195,28 @@ - (void)pluginInitialize {
 #ifdef __cplusplus
 - (void)processImage:(Mat &)image;
 {
-    // process each image in new thread
-    if(!image.empty() && thread_over){
-        thread_over = false;
-        Mat image_copy = image.clone();
-        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
-            [self backgroundImageProcessing: image_copy];
-            dispatch_sync(dispatch_get_main_queue(), ^{
-                thread_over = true;
+    //get current time and calculate time passed since last time update
+    NSTimeInterval timeStamp = [[NSDate date] timeIntervalSince1970];
+    NSNumber *current_time = [NSNumber numberWithDouble: timeStamp];
+    float time_passed = [current_time floatValue] - [last_time floatValue];
+    //NSLog(@"current_time - %@, last_time - %@", current_time, last_time);  && time_passed > timeout
+
+    //process frames if option is true and timeout passed
+    if (processFrames) {
+        // process each image in new thread
+        if(!image.empty() && thread_over){
+            thread_over = false;
+            Mat image_copy = image.clone();
+            dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+                [self backgroundImageProcessing: image_copy];
+                dispatch_sync(dispatch_get_main_queue(), ^{
+                    thread_over = true;
+                });
             });
-        });
+        }
+        //NSLog(@"time passed - %f, timeout - %f", time_passed, timeout);
+        //update time
+        last_time = current_time;
     }
 }
 #endif

www/ImageDetectionPlugin.js

@@ -2,12 +2,18 @@
 *
 **/
 var ImageDetectionPlugin = function () {
+  this.startProcessing = function (bool, successCallback, errorCallback) {
+    cordova.exec(successCallback, errorCallback, "ImageDetectionPlugin", "startProcessing", [bool]);
+  };
   this.setPattern = function (pattern, successCallback, errorCallback) {
     cordova.exec(successCallback, errorCallback, "ImageDetectionPlugin", "setPattern", [pattern]);
   };
   this.isDetecting = function (successCallback, errorCallback) {
     cordova.exec(successCallback, errorCallback, "ImageDetectionPlugin", "isDetecting", []);
   };
+  this.setDetectionTimeout = function (timeout, successCallback, errorCallback) {
+    cordova.exec(successCallback, errorCallback, "ImageDetectionPlugin", "setDetectionTimeout", [timeout]);
+  };
   this.greet = function (name, successCallback, errorCallback) {
     cordova.exec(successCallback, errorCallback, "ImageDetectionPlugin", "greet", [name]);
   };