Initial commit of node-openalpr

Author: KJ Lawrence

.gitignore

@@ -0,0 +1,6 @@
+openalpr
+node_modules
+build
+!lib/*
+!release/**
+!openalpr_runtime/**

.npmignore

@@ -0,0 +1,4 @@
+.gitignore
+*~
+.settings
+.c9*

ChangeLog

@@ -0,0 +1,75 @@
+module.exports = function(grunt) {
+    grunt.initConfig({
+        gyp: {
+            ia32: {
+                command: 'rebuild',
+                options: {
+                    arch: 'ia32'
+                }
+            },
+            x64: {
+                command: 'rebuild',
+                options: {
+                    arch: 'x64'
+                }
+            }
+        },
+        "nw-gyp": {
+            ia32: {
+                command: 'rebuild',
+                options: {
+                    arch: 'ia32'
+                }
+            },
+            x64: {
+                command: 'rebuild',
+                options: {
+                    arch: 'x64'
+                }
+            }
+        },
+        copy: {
+            ia32: {
+                files: [{src: 'build/Release/node_printer.node', dest: 'lib/node_printer_' + process.platform + '_ia32.node'}]
+            },
+            x64: {
+                files: [{src: 'build/Release/node_printer.node', dest: 'lib/node_printer_' + process.platform + '_x64.node'}]
+            }
+        }
+    });
+
+    grunt.loadNpmTasks('grunt-contrib-jshint');
+    grunt.loadNpmTasks('grunt-node-gyp');
+    grunt.loadNpmTasks('grunt-nw-gyp');
+    grunt.loadNpmTasks('grunt-contrib-copy');
+
+    grunt.registerTask('build-nw-ia32', [
+            'nw-gyp:ia32',
+            'copy:ia32'
+    ]);
+
+    grunt.registerTask('build-ia32', [
+            'gyp:ia32',
+            'copy:ia32'
+    ]);
+
+    grunt.registerTask('build-x64', [
+            'gyp:x64',
+            'copy:x64'
+    ]);
+
+    grunt.registerTask('build-nw-x64', [
+            'nw-gyp:x64',
+            'copy:x64'
+    ]);
+
+    grunt.registerTask('build', [
+            'build-ia32',
+            'build-x64'
+    ]);
+
+    grunt.registerTask('build-nw', [
+            'build-nw-ia32',
+            'build-nw-x64'
+    ]);
+}

Gruntfile.js

@@ -0,0 +1,74 @@
+node-openalpr
+============
+
+This package binds OpenALPR with Node.js
+
+# Installation and Example
+
+Use npm to get the node-openalpr package. We'll attempt to use node-pre-gyp to compile from source, but if
+that's not possible we'll fallback to precompiled binaries.
+
+```npm install node-openalpr```
+
+### Example
+
+```javascript
+var openalpr = require ("node-openalpr");
+
+function identify (id, path) {
+	console.log (openalpr.IdentifyLicense (path, function (error, output) {
+		console.log (id +" "+ output.processing_time_ms);
+	
+		if (id == 349) {
+			console.log (openalpr.Stop ());
+		}
+	}));
+}
+
+openalpr.Start ();
+openalpr.GetVersion ();
+
+for (var i = 0; i < 350; i++) {
+	identify (i, "lp.jpg");
+}
+```
+
+### Methods
+
+This is a breakdown of all of the methods available for node-openalpr. Start needs to be called before any other method.
+
+* `openalpr.Start ([config, [runtime, [count, [start_queue]]]])` - Initializes OpenALPR with default settings
+  * config - Path to configuration file. On Windows defaults to the config file in node-openalpr directory, on Linux defaults to openalpr installation
+  * runtime - Path to runtime data. On Windows defaults to "openalpr_runtime" folder in node-openalpr directory, on Linux defaults to openalpr installation
+  * count - Number of concurrent OpenALPR processes to run - defaults to CPU core count
+  * start_queue - Auto start queue monitoring thread - defaults to true
+* `openalpr.Stop ()` - Stops the OpenALPR processes and clears out any queued images
+* `openalpr.StartQueue ()` - Starts the OpenALPR queue monitoring thread (normally started automatically after calling Start ())
+* `openalpr.StopQueue ()` - Stops the OpenALPR queue monitoring thread
+* `openalpr.queueLoop ()` - Method used in checking queue - can be called manually if start_queue is false for finer control
+* `openalpr.IdentifyLicense (path, options/callback[, callback])` - Begins the process of identifying a license from the given image
+  * path - Path to image - if image does not exist an exception will be thrown
+  * callback/options - Additional options for the image or a callback
+    * options.state         (string) - State ("oh") license plates are in for additional validation
+    * options.prewarp       (string) - Prewarp configuration information
+    * options.detectRegion  (boolean) - Use detect region functionality of OpenALPR? (slower)
+  * callback - Callback with results: function (errors, output)
+* `openalpr.GetVersion ()` - Get the version of OpenALPR currently being run against
+
+# How to Compile
+
+0. [Download and install io.js v3.0.0+](https://iojs.org/en/index.html)
+0. [Download and install git](https://git-scm.com/downloads)
+
+#### Windows
+
+0. [Download and install Visual Studio 2013/2015](https://www.visualstudio.com/)
+0. Run PowerShell ISE as an administrator and execute: Set-ExecutionPolicy RemoteSigned
+0. Run openalpr-install.ps1
+0. Take output from openalpr/windows/build/dist and put into "lib" and "release/win32" folder in node-openalpr
+0. Run npm install
+
+#### Linux
+
+0. Run openalpr-install.sh
+0. Run npm install

README.md

@@ -0,0 +1,44 @@
+{
+  'targets': [
+    {
+      'target_name': '<(module_name)',
+      'sources': [
+            "src/node_openalpr.cc"
+      ],
+	  'include_dirs': [
+			"<!(node -e \"require('nan')\")",
+			"includes/",
+			"lib/"
+	  ],
+      'conditions': [
+			['OS=="win"', {
+				'libraries': [ '<!@(["python", "tools/getSourceFiles.py", "lib", "lib"])' ],
+				'dll_files': [ '<!@(["python", "tools/getSourceFiles.py", "lib", "dll"])' ],
+				'msvs_settings': {
+					'VCCLCompilerTool': {
+						'AdditionalOptions': [
+							'/GR',
+							'/MD',
+							'/EHsc'
+						]
+					}
+				}
+			}],
+			['OS!="win"', {
+				'libraries': [ "/usr/lib/libopenalpr.so" ]
+			}]
+      ]
+    },
+	{
+	  "target_name": "action_after_build",
+	  "type": "none",
+	  "dependencies": [ "<(module_name)" ],
+	  "copies": [
+		{
+		  "files": [ "<(PRODUCT_DIR)/<(module_name).node" ],
+		  "destination": "<(module_path)"
+		}
+	  ]
+	}
+  ]
+}

binding.gyp

@@ -0,0 +1,97 @@
+#ifndef _TREXPP_H_
+#define _TREXPP_H_
+/***************************************************************
+	T-Rex a tiny regular expression library
+
+	Copyright (C) 2003-2004 Alberto Demichelis
+
+	This software is provided 'as-is', without any express
+	or implied warranty. In no event will the authors be held
+	liable for any damages arising from the use of this software.
+
+	Permission is granted to anyone to use this software for
+	any purpose, including commercial applications, and to alter
+	it and redistribute it freely, subject to the following restrictions:
+
+		1. The origin of this software must not be misrepresented;
+		you must not claim that you wrote the original software.
+		If you use this software in a product, an acknowledgment
+		in the product documentation would be appreciated but
+		is not required.
+
+		2. Altered source versions must be plainly marked as such,
+		and must not be misrepresented as being the original software.
+
+		3. This notice may not be removed or altered from any
+		source distribution.
+
+****************************************************************/
+
+extern "C" {
+#include "trex.h"
+}
+
+struct TRexParseException
+{
+  TRexParseException(const TRexChar *c):desc(c) {} const TRexChar *desc;
+};
+
+class TRexpp
+{
+  public:
+    TRexpp()
+    {
+      _exp = (TRex *)0;
+    }
+    ~TRexpp()
+    {
+      CleanUp();
+    }
+    // compiles a regular expression
+    void Compile(const TRexChar *pattern)
+    {
+      const TRexChar *error;
+      CleanUp();
+      if(!(_exp = trex_compile(pattern,&error)))
+        throw TRexParseException(error);
+    }
+    // return true if the given text match the expression
+    bool Match(const TRexChar* text)
+    {
+      return _exp?(trex_match(_exp,text) != 0):false;
+    }
+    // Searches for the first match of the expression in a zero terminated string
+    bool Search(const TRexChar* text, const TRexChar** out_begin, const TRexChar** out_end)
+    {
+      return _exp?(trex_search(_exp,text,out_begin,out_end) != 0):false;
+    }
+    // Searches for the first match of the expression in a string sarting at text_begin and ending at text_end
+    bool SearchRange(const TRexChar* text_begin,const TRexChar* text_end,const TRexChar** out_begin, const TRexChar** out_end)
+    {
+      return _exp?(trex_searchrange(_exp,text_begin,text_end,out_begin,out_end) != 0):false;
+    }
+    bool GetSubExp(int n, const TRexChar** out_begin, int *out_len)
+    {
+      TRexMatch match;
+      TRexBool res = _exp?(trex_getsubexp(_exp,n,&match)):TRex_False;
+      if(res)
+      {
+        *out_begin = match.begin;
+        *out_len = match.len;
+        return true;
+      }
+      return false;
+    }
+    int GetSubExpCount()
+    {
+      return _exp?trex_getsubexpcount(_exp):0;
+    }
+  private:
+    void CleanUp()
+    {
+      if(_exp) trex_free(_exp);
+      _exp = (TRex *)0;
+    }
+    TRex *_exp;
+};
+#endif //_TREXPP_H_