electric_eye 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2affb0dc95af7bf5563442e3d984bad0011a6e2
-  data.tar.gz: 71cb8b06d07557218df843b86121cd3e3685a124
+  metadata.gz: 33c71e7271287c8eefaed7c21b11e5dbfa8f2e8e
+  data.tar.gz: d95da73de1f27d44012389bc7d6b18516ef0f15a
 SHA512:
-  metadata.gz: b6eef4c40c21ddfcb1f66428e60a9cba2388718d65bbd25d09fb579aebe64500266d795c26cb5dd196fa186372838215d754d9d737f219e631c45d20ea312851
-  data.tar.gz: 258b468cef8ce9839000b1be4b38dab26f4f8345230b76cac884b714ba41ffd3f12c02233b8ef8c1e371e1c34018cb81bc969679f7aa4c91bcbf88a0f47b6bd9
+  metadata.gz: da2bfd5d2e5366b3e8a3929613207aa2ae489577baea1d99abc85a2626e6843b2b4ee4d8e85f69ba53a36e2147c1649f1ccde2054fed9ecad4c851d80c86dc86
+  data.tar.gz: 7c9e5f484dfc4e6dd4d179fa2982a2c2dced25645bc2e51a418ffebcd08415bb0c94aff473e4ca92702550fabd47d62f9b6cb1f71120ad795c7c161efcf1aba3

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    electric_eye (0.0.4)
+    electric_eye (0.1.0)
       construct
+      filewatcher
       methadone (~> 1.9.0)
       open4
       table_print
@@ -30,12 +31,14 @@ GEM
     diff-lcs (1.2.5)
     fakefs (0.6.7)
     ffi (1.9.8)
+    filewatcher (0.5.3)
+      trollop (~> 2.0)
     gem-man (0.3.0)
     gherkin (2.12.2)
       multi_json (~> 1.3)
     hpricot (0.8.6)
     json (1.8.2)
-    methadone (1.9.1)
+    methadone (1.9.2)
       bundler
     multi_json (1.11.0)
     multi_test (0.1.2)
@@ -57,8 +60,9 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.3)
-    table_print (1.5.3)
+    table_print (1.5.6)
     timecop (0.3.5)
+    trollop (2.1.2)
 
 PLATFORMS
   ruby
@@ -74,3 +78,6 @@ DEPENDENCIES
   ronn
   rspec (~> 2.99)
   timecop
+
+BUNDLED WITH
+   1.11.2

data/README.org

@@ -6,19 +6,22 @@ A network video recorder for multiple IP cameras using VLC.
 
 ** History
 
-I've been using Zoneminder & motion and these programs are either too large for my requirements (zoneminder) or don't work with the cameras I own (motion). What I did notice is all my cameras work through VLC with high resolution and VLC can record. 
+I've been using Zoneminder & motion and these programs are either too large for my requirements (zoneminder) or don't work with the cameras I own (motion). What I did notice is all my cameras work through VLC with high resolution and VLC can record.
 
-The problem was though VLC doesn't automate the recordings or handle the file structure nicely. This is where I started to think about creating an application which records from VLC and nicely sorts those recordings in directories by date & time.
+I started with VLC doing the recording up to 0.1.0 where I changed over to using ffmpeg instead.
 
 ** Requirements
 
-- VLC  - recording & motion detection
-- xvfb - Running virtual frame buffers (ie: desktops)
+- ffmpeg  - recording & motion detection
 - ruby
-- Linux (Tested on Debian 7)
+- Linux (Tested on Debian 7, Xubuntu 14.04)
 
 ** Installation
 
+Under linux install vlc xvfb & ruby
+
+: sudo apt-get install ffmpeg ruby
+
 Add this line to your application's Gemfile:
 
 : gem 'electric_eye'
@@ -37,7 +40,8 @@ Enter your cameras into the JSON config file like so
 
 : ---
 : duration: 60
-: path: "/media/data/recordings/temp"
+: path: "/media/data/recordings"
+: threshold: 2
 : cameras:
 : - :name: Reception
 :   :url: rtsp://<user>:<passwd>@<camera's ip>/live2.sdp
@@ -50,14 +54,15 @@ You should be able to view the URL through vlc before using this program.
 
 The recordings directory will end up with these directories
 
-: /media/data/recordings/reception/20150527
-: /media/data/recordings/kitchen/20150527
+: /media/data/recordings/reception
+: /media/data/recordings/kitchen
 
-Notice the date at the end of these paths, there will be one for each day. The contents within will be recordings which are done by default every 10minutes, example;
+Files will be numbered up to your wrap figure. The wrap figure determines when the recording program should start from zero again. EG: If you select you duration as 3600 seconds and a wrap figure of 168 then you get a rolling recording over a 1 week period which would be divided up into 1hr files.
 
-: 20150527-1020-reception.mjpeg
-: 20150527-1030-reception.mjpeg
-: 20150527-1040-reception.mjpeg
+: reception000.mjpeg
+: motion-reception000.mjpeg
+: reception001.mjpeg
+: motion-reception001.mjpeg
 
 The default is going to be 10 minute blocks, this can be overridden with the duration variable above in minutes.
 
@@ -83,6 +88,9 @@ Usage in development mode
 
 : bundle exec bin/electric_eye -h
 
+Debug mode
+
+: bundle exec bin/electric_eye -s --log-level=debug
 
 ** Start on boot
 
@@ -133,6 +141,8 @@ Replace johnsmith with your user where you have setup your camera profiles. NOTE
 
 ** Cleanup
 
+Optional - This was needed for versions prior to 0.1.0, now it is only a precaution as ffmpeg does clean up after itself.
+
 Cleaning up recordings. Put the following into your /etc/crontab per recording directory.
 
 : 00 19	* * *	root	/usr/bin/find <directory to recordings> -type f -mtime +<days> -exec rm {} \;
@@ -162,11 +172,17 @@ Example for cleaning up reception after 60days at 7pm everynight.
 
 - [X] Create threshold as a variable
 
-- [ ] Add a feature to clean up old recordings using a "period" setting
+- [X] Swap over to using ffmpeg
+
+- [X] Do post motion detection (using fmmpeg)
+
+- [X] Add a feature to clean up old recordings using a "period" setting (ffmpeg handles this)
   EG: 60 day period which could be set in the config file how many days you want to keep
   Then just call 'electric_eye --remove-recordings' within crontab
   This would iterate over all my cameras and remove old recordings to keep a rolling set of days.
 
-- [ ] Allow different recording programs like raspicam
+- [ ] Allow motion detection to be turned on/off (default: off)
 
-- [ ] Do inline motion detection (using activevlc)
+- [ ] Threshold should be per camera or have inside & outside thresholds
+  There is a large difference in movement between indoor office cameras
+  and outdoor cameras. With wind and rain comes a lot of motion!

data/bin/electric_eye

@@ -22,12 +22,18 @@ class App
       @configEye.list_cameras
     elsif options[:d]           # Set duration
       @configEye.set_duration(options[:duration]) 
+    elsif options[:w]           # Set wrap
+      @configEye.set_wrap(options[:wrap]) 
     elsif options[:p]           # Set path
       @configEye.set_path(options[:path]) 
     elsif options[:s]           # Start recording
       @record.start
     elsif options[:k]           # Stop recordings
       @record.stop
+    # elsif options[:m]           # Perform post motion detection
+    #   # NOTE: This happens automatically during recording so this option is only here for admins
+    #   # to perform the operation manually.
+    #   @record.start_motion_detection(options[:listfile])
     elsif options[:t]
       @configEye.set_threshold(options[:threshold])
     else
@@ -46,9 +52,11 @@ class App
   on("-r", "--remove", "Remove a camera")
   on("-l", "--list", "List cameras")
   on("-d", "--duration SECONDS", "Set recording duration in seconds (default: 600)")
+  on("-w", "--wrap FILES", "Set how many files to keep before wrapping (default: 168 at 1hr = 1week)")
   on("-p", "--path DIR", "Set recordings path")
   on("-s", "--start", "Start recordings")
   on("-k", "--stop", "Stop recordings")
+  # on("-m", "--motion LISTFILE", "Post motion detection, pass in a list of video and it will process")
   on("-t", "--threshold LEVEL", "Set threshold for motion detection (default: 2)")
 
   # Arguments

data/electric_eye.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "construct"
   spec.add_runtime_dependency "table_print"
   spec.add_runtime_dependency "open4"
+  spec.add_runtime_dependency "filewatcher"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/features/step_definitions/config_steps.rb

@@ -2,7 +2,7 @@ require 'construct'
 require 'fileutils'
 
 Given(/^I have a camera called "([^"]*)"$/) do |arg1|
-  @config = Construct.new
+  @config = Construct.new({path: "/tmp/temp", duration: 600, wrap: 168})
   @config.cameras = [{name: "Reception", url: "http://thecamera.org"}]
   dir="#{ENV['HOME']}/.electric_eye"
   FileUtils.rm_r(dir) if Dir.exist?(dir)

data/lib/electric_eye/config_eye.rb

@@ -19,7 +19,8 @@ module ElectricEye
       if File.exist?(CONFIG_FILE)
         Construct.load File.read(CONFIG_FILE)
       else
-        Construct.new({duration: 600, path: '~/recordings', threshold: 2, cameras: []})
+        # Create a new file with defaults
+        Construct.new({duration: 600, wrap: 168, path: '~/recordings', threshold: 2, cameras: []})
       end
     end
 
@@ -57,6 +58,13 @@ module ElectricEye
       tp @config.cameras, :name, :url => {width: 120}
     end
 
+    # Set wrap
+    def set_wrap(wrap)
+      @config.wrap = wrap.to_i
+      save
+      info "Wrap set to #{wrap} files"
+    end
+
     # Set duration
     def set_duration(seconds)
       @config.duration = seconds.to_i

data/lib/electric_eye/record.rb

@@ -1,6 +1,7 @@
 require 'methadone'
 require 'open4'
 require 'fileutils'
+require 'filewatcher'
 
 module ElectricEye
   class Record
@@ -15,52 +16,69 @@ module ElectricEye
       @motion = Motion.new      # Create a new instance method to our motion library
       
       pids = []
+      # Start the recording for each camera
       # Step through each camera
       @configEye.config.cameras.each do |camera|
-        # Let's first record two 1minute videos of each camera.
-        # This will turn into a never ending loop until we stop the process.
-        pids << fork do
-          stop_recording = false
-          Signal.trap('INT') { stop_recording = true }
-          until stop_recording
-            path = "#{path(camera)}"
-            debug "Recording #{camera[:name]} to #{path}.mjpeg..."
-            
-            # Set a recording going using vlc, hold onto the process till it's finished.
-            cmd="cvlc #{camera[:url]} --sout file/ts:#{path}.mjpeg"
-            pid,stdin,stdout,stderr=Open4::popen4(cmd)
-
-            # Wait for a defined duration from the config file.
-            seconds = @configEye.config.duration
-            while(seconds > 0)
-              sleep 1
-              seconds -= 1
-              break if stop_recording
-            end
-            
-            Process.kill 9, pid # Stop current recording.
-            Process.wait pid    # Wait around so we don't get Zombies
-
-            # Look for any motion
-            Thread.new(path) do |threadPath| 
-              @motion.create_log(threadPath) # Create the motion detection log file.
-
-              # Remove the log & recording if there is no motion
-              if @motion.detect("#{threadPath}.log", @configEye.config.threshold)
-                debug "KEEP #{threadPath}.mjpeg (motion)"
-              else
-                remove(threadPath)
-              end
-            end
-          end
-        end
+
+        # until stop_recording
+        path = "#{path(camera)}"
+        listfile = "#{path}.list"
+        debug "Recording #{camera[:name]} to #{path}.mjpeg..."
         
+        # Set a recording going using vlc, hold onto the process till it's finished.
+        # segment_time = how much time to record in each segment in seconds, ie: 3600 = 1hr
+        # sgement_wrap = how many copies
+        loglevel = "-loglevel panic" if logger.level >= 1
+        cmd="ffmpeg -f mjpeg -i #{camera[:url]} #{loglevel} -acodec copy -vcodec copy -y -f segment -segment_list #{listfile} -segment_time #{@configEye.config.duration} -segment_wrap #{@configEye.config.wrap}  #{path}%03d.mjpeg"
+
+        # Run command and add to our pids to make it easy for electric_eye to clean up.
+        info "Starting to record #{camera[:name]}"
+        pids << Process.spawn(cmd)
+
+        # Start the motion detection for this camera
+        puts "before thread: #{path}"
+
+        pids << fork do 
+          `echo "path: #{dir(camera)}" >> #{listfile}.log`
+          start_motion_detection(camera)
+        end
       end
 
       store_pids(pids)
       info "Cameras recording"
     end
 
+    # Start motion detection
+    def start_motion_detection(camera)
+      # Watch the ffmpeg segment list output file which will trigger the block within
+      # where we can look at the last line in the file and perform post motion detection.
+
+      dir =dir(camera)
+      path = path(camera)
+
+      # Watch the directory & read from the list file
+      filewatcher = FileWatcher.new("#{path}*.mjpeg")
+      filewatcher.watch do |f|
+        file = read_listfile("#{path}.list")
+        if file
+          debug "Processing #{file}"
+          loglevel = "-loglevel panic" if logger.level >= 1
+
+          # Run motion detection on the file, make sure that we output to a different file.
+          cmd="ffmpeg -i #{dir}/#{file} #{loglevel} -y -vf \"select=gt(scene\\,0.003),setpts=N/(25*TB)\" #{dir}/motion-#{file}"
+
+          # Run command and add to our pids to make it easy for electric_eye to clean up.
+          Process.spawn(cmd)
+        end
+      end
+    end
+
+    # Read the last line from the list file.
+    def read_listfile(listfile)
+      lines = File.open(listfile).readlines
+      lines.last.chomp! unless lines.length == 0
+    end
+
     # Remove a recording
     def remove(path)
       debug "REMOVE #{path}.mjpeg (no motion)"
@@ -82,10 +100,14 @@ module ElectricEye
       File.open(PID_FILE, "r").gets # Get pids
     end
     
-    def path(camera)
+    def dir(camera)
       dir = "#{@configEye.config.path}/#{camera[:name]}"
       FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
-      "#{dir}/#{Time.now.strftime('%Y%m%d-%H%M')}-#{camera[:name]}"
+      dir
+    end
+
+    def path(camera)
+      "#{dir(camera)}/#{camera[:name]}"
     end
 
     def initialize(configEye)

data/lib/electric_eye/version.rb

@@ -1,3 +1,3 @@
 module ElectricEye
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/config_spec.rb

@@ -148,6 +148,32 @@ describe "remove camera" do
   end
 end
 
+describe "set_wrap" do
+  include FakeFS::SpecHelpers
+
+  before do
+    @configEye = ConfigEye.new
+  end
+
+  context "when no wrap has been set" do
+    it "returns the default of 168 times" do
+      expect(@configEye.config.wrap).to equal(168)
+    end
+  end
+
+  context "when calling with -w 24" do
+    it "returns 24" do
+      @configEye.set_wrap(24)
+      expect(@configEye.config.wrap).to equal(24)
+    end
+
+    it "calls save" do
+      expect(@configEye).to receive(:save).once
+      @configEye.set_wrap(24)
+    end
+  end
+end
+
 describe "set_duration" do
   include FakeFS::SpecHelpers
 

data/spec/record_spec.rb

@@ -27,6 +27,21 @@ describe "record" do
     end
   end
 
+  describe "#dir" do
+    before do
+      Timecop.freeze(Time.local(2015,06,30,10,05,0))
+    end
+
+    after do
+      Timecop.return
+    end
+    
+    it "returns a full dir" do
+      dir = @record.dir(@configEye.config.cameras.first)
+      expect(dir).to eq("~/recordings/Reception")
+    end
+  end
+
   describe "record_path" do
     before do
       Timecop.freeze(Time.local(2015,06,30,10,05,0))
@@ -36,9 +51,9 @@ describe "record" do
       Timecop.return
     end
     
-    it "returns a full path with todays date" do
+    it "returns a full path" do
       path = @record.path(@configEye.config.cameras.first)
-      expect(path).to include("~/recordings/Reception/20150630-1005-Reception")
+      expect(path).to eq("~/recordings/Reception/Reception")
     end
   end
 
@@ -60,8 +75,8 @@ describe "record" do
     end
     
     it "calls kill" do
-      open4 = mock(Open4)
-      open4.stub!(:exitstatus).and_return(0)
+      open4 = double(Open4)
+      open4.stub(:exitstatus).and_return(0)
       
       Open4.should_receive(:popen4).with('kill -INT 10000 10001 10002').and_return(open4)
 
@@ -75,6 +90,40 @@ describe "record" do
     end
   end
 
+  describe "#read_listfile" do
+    before do 
+      FakeFS.activate!
+    end
+
+    after do 
+      FakeFS.deactivate!
+    end
+
+    context "with a full file" do 
+      before do 
+        File.open("output.list", "w") do |file|
+          file.puts "file1.mjpeg"
+          file.puts "file2.mjpeg"
+        end
+      end
+
+      it "returns the last filename" do
+        @record.read_listfile("output.list").should eq("file2.mjpeg")
+      end    
+    end
+
+    context "with a empty file" do 
+      before do 
+        File.open("output.list", "w") do |file|
+        end
+      end
+
+      it "returns the last filename" do
+        @record.read_listfile("output.list").should eq(nil)
+      end    
+    end
+  end
+
   describe "#remove" do
     before do
       @path = "/tmp/electric_eye"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: electric_eye
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael Pope
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: construct
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +216,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -251,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Network Video Recorder