screencaster-gtk 0.0.5.alpha1 → 0.0.6.alpha1

data/lib/screencaster-gtk.rb

@@ -174,17 +174,15 @@ class ScreencasterGtk
   #### Done Status Icon
   
   def quit
-    @@logger.debug "Quitting"
-    # self.status_icon.destroy
-    # @@logger.debug "After status icon destroy."
-    # @window.destroy
-    # @@logger.debug "After window destroy."
-    # We don't want to destroy here because the object continues to exist
-    # Just hide everything
-    self.hide_all_including_status
-    # self.status_icon.hide doesn't work/exist
-    Gtk.main_quit 
-    @@logger.debug "After main_quit."
+    if 0 < @capture_window.raw_files.size && SaveFile.are_you_sure?(@window)
+      @@logger.debug "Quitting"
+      # We don't want to destroy here because the object continues to exist
+      # Just hide everything
+      self.hide_all_including_status
+      # self.status_icon.hide doesn't work/exist
+      Gtk.main_quit 
+      @@logger.debug "After main_quit."
+    end
   end
   
   public

data/lib/screencaster-gtk/capture.rb

@@ -11,7 +11,7 @@ class Capture
   attr_writer :left, :top, :right, :bottom
   attr_reader :state
   attr_accessor :pid
-  attr_accessor :tmp_files
+  attr_accessor :raw_files
 
   attr_accessor :capture_fps
   attr_accessor :encode_fps
@@ -24,13 +24,14 @@ class Capture
   
   
   def initialize
-    @tmp_files = []
     @exit_chain = Signal.trap("EXIT") { 
       self.cleanup
       $logger.debug "In capture about to chain to trap @exit_chain: #{@exit_chain}"
       @exit_chain.call unless @exit_chain.nil? 
     }
     #$logger.debug "@exit_chain: #{@exit_chain.to_s}"
+
+    self.reset_without_cleanup
     
     @state = :stopped
     @coprocess = nil
@@ -57,11 +58,11 @@ class Capture
   end
   
   def current_tmp_file
-    @tmp_files.last
+    @raw_files.last
   end
   
   def new_tmp_file
-    @tmp_files << Capture.tmp_file_name(@tmp_files.size)
+    @raw_files << Capture.tmp_file_name(@raw_files.size)
     self.current_tmp_file
   end
   
@@ -72,6 +73,10 @@ class Capture
   def self.format_input_files_for_mkvmerge(files)
     files.drop(1).inject("\"#{files.first}\"") {|a, b| "#{a} + \"#{b}\"" }
   end
+  
+  def video_segments_size
+    @raw_files.size
+  end
     
   def width
     @right - @left
@@ -121,32 +126,16 @@ class Capture
   end
   
   def record
-    if @state != :paused
-      @tmp_files = [] 
-      self.total_amount = 0.0
-    end
-
     output_file = self.new_tmp_file
 
     @state = :recording
-    audio_options="-f alsa -ac 1 -ab #{@audio_sample_frequency} -i #{@audio_input} -acodec #{@acodec}"
     
     # And i should probably popen here, save the pid, then fork and start
     # reading the input, updating the number of frames saved, or the time
     # recorded.
     $logger.debug "Capturing...\n"
 
-    cmd_line = "avconv \
-      #{audio_options} \
-      -f x11grab \
-      -show_region 1 \
-      -r #{@capture_fps} \
-      -s #{@width}x#{@height} \
-      -i :0.0+#{@left},#{@top} \
-      -qscale #{@qscale} \
-      -vcodec #{@capture_vcodec} \
-      -y \
-      #{output_file}"
+    cmd_line = record_command_line(output_file)
     
     $logger.debug cmd_line
 
@@ -199,29 +188,19 @@ class Capture
     state = :encoding
     output_file =~ /.mp4$/ || output_file += ".mp4"
     
-    $logger.debug "Encoding #{Capture.format_input_files_for_mkvmerge(@tmp_files)}...\n"
+    $logger.debug "Encoding #{Capture.format_input_files_for_mkvmerge(@raw_files)}...\n"
     $logger.debug("Total duration #{self.total_amount.to_s}")
 
-    merge(Capture.tmp_file_name, @tmp_files, feedback)
+    merge(Capture.tmp_file_name, @raw_files, feedback)
     final_encode(output_file, Capture.tmp_file_name, feedback)
   end 
   
-  # This is ugly.
-  # When you open co-processes, they do get stuck together.
-  # It seems the if I don't read what's coming out of the co-process, it waits.
-  # But if I read it, then it goes right to the end until it returns.
-  
   def merge(output_file, input_files, feedback = proc {} )
     $logger.debug("Merging #{input_files.size.to_s} files: #{Capture.format_input_files_for_mkvmerge(input_files)}")
     $logger.debug("Feedback #{feedback}")
     
-    # TODO: cp doesn't give feedback like mkvmerge does...
-    if input_files.size == 1
-      cmd_line = "cp -v #{input_files[0]} #{output_file}"
-      #cmd_line = "sleep 5"
-    else
-      cmd_line = "mkvmerge -v -o #{output_file} #{Capture.format_input_files_for_mkvmerge(input_files)}"
-    end
+    cmd_line = merge_command_line(output_file, input_files)
+    
     $logger.debug "merge: command line: #{cmd_line}"
     i, oe, @coprocess = Open3.popen2e(cmd_line)
     $logger.debug "merge: Thread from popen2e: #{@coprocess}"
@@ -248,11 +227,7 @@ class Capture
     # updating progress based on what I read, while the main body
     # returns and carries on.
     
-    cmd_line = "avconv \
-      -i #{input_file} \
-      -vcodec #{@encode_vcodec} \
-      -y \
-      '#{output_file}'"
+    cmd_line = encode_command_line(output_file, input_file)
       
     $logger.debug cmd_line
     
@@ -271,7 +246,8 @@ class Capture
     $logger.debug "reached end of file"
     @state = :stopped
     self.fraction_complete = 1
-    feedback.call self.fraction_complete, self.time_remaining_s
+    feedback.call self.fraction_complete, "Done"
+    reset
     @coprocess.value # A little bit of a head game here. Either return this, or maybe have to do t.value.value in caller
   end
   
@@ -282,10 +258,53 @@ class Capture
       $logger.error("No encoding to stop.")
     end
   end
+  
+  def reset
+    cleanup
+    reset_without_cleanup
+  end
+  
+  def reset_without_cleanup
+    @raw_files = [] 
+    self.total_amount = 0.0
+  end
 
   def cleanup
-    @tmp_files.each { |f| File.delete(f) if File.exists?(f) }
+    @raw_files.each { |f| File.delete(f) if File.exists?(f) }
     File.delete(Capture.tmp_file_name) if File.exists?(Capture.tmp_file_name)
   end
+  
+  def record_command_line(output_file)
+    audio_options="-f alsa -ac 1 -ab #{@audio_sample_frequency} -i #{@audio_input} -acodec #{@acodec}"
+    "avconv \
+      #{audio_options} \
+      -f x11grab \
+      -show_region 1 \
+      -r #{@capture_fps} \
+      -s #{@width}x#{@height} \
+      -i :0.0+#{@left},#{@top} \
+      -qscale #{@qscale} \
+      -vcodec #{@capture_vcodec} \
+      -y \
+      #{output_file}"
+  end
+  
+  def merge_command_line(output_file, input_files)
+    # TODO: cp doesn't give feedback like mkvmerge does...
+    if input_files.size == 1
+      "cp -v #{input_files[0]} #{output_file}"
+      #cmd_line = "sleep 5"
+    else
+      "mkvmerge -v -o #{output_file} #{Capture.format_input_files_for_mkvmerge(input_files)}"
+    end
+  end
+  
+  def encode_command_line(output_file, input_file)
+    "avconv \
+      -i '#{input_file}' \
+      -vcodec #{@encode_vcodec} \
+      -y \
+      '#{output_file}'"
+  end
 end
 

data/lib/screencaster-gtk/progresstracker.rb

@@ -10,6 +10,7 @@ module ProgressTracker
   end
   
   def fraction_complete
+    raise ZeroDivisionError if self.total_amount == 0
     [ self.current_amount.to_f / self.total_amount.to_f, 1.0 ].min
   end
     
@@ -27,7 +28,7 @@ module ProgressTracker
   end
   
   def total_amount
-    @total_amount || 1.0
+    @total_amount || 0.0
   end
   
   def time_remaining

data/lib/screencaster-gtk/savefile.rb

@@ -23,7 +23,7 @@ Create the file chooser dialogue with a default file name.
   end
   
 =begin rdoc
-Do the workflow around saving a file, warning the user before allow
+Do the workflow around saving a file, warning the user before allowing
 them to abandon their capture.
 =end
   def self.get_file_to_save
@@ -38,11 +38,13 @@ them to abandon their capture.
         self.confirm_cancel(@dialog)
         @dialog.hide
       else
-        LOGGER.error("Can't happen #{__FILE__} line: #{__LINE__}")
+        $logger.error("Can't happen #{__FILE__} line: #{__LINE__}")
         @dialog.hide
     end
   end
   
+  # TODO: I think it's ugly that I have two different dialogues here.
+  
 =begin rdoc
 Confirm cancellation when the user has captured something but not
 saved it.
@@ -75,5 +77,19 @@ saved it.
       else
     end
   end
+  
+  def self.are_you_sure?(parent, verb = "quit")
+    d = Gtk::MessageDialog.new(parent, 
+      Gtk::Dialog::DESTROY_WITH_PARENT, 
+      Gtk::MessageDialog::QUESTION, 
+      Gtk::MessageDialog::BUTTONS_YES_NO, 
+      "You have unsaved work")
+    
+    d.secondary_text = "If you #{verb} now, you will lose some video that you have captured. Are you sure you want to #{verb}?"
+
+    response = d.run
+    d.destroy
+    response == Gtk::Dialog::RESPONSE_YES
+  end
 end
 

data/test/capture.rb

@@ -0,0 +1,21 @@
+# Redefine some methods in Capture for testing purposes.
+
+class Capture
+  def get_window_to_capture
+    @left   = 100
+    @top    = 100
+    @width  = 100
+    @height = 100
+    @height += @height % 2
+    @width  += @width % 2
+
+    $logger.debug "Capturing #{@left},#{@top} to #{@left+@width},#{@top+@height}. Dimensions #{@width},#{@height}.\n"
+  end
+  
+  def define_mock_capture_success
+    def self.record_command_line(output_file)
+      "touch '#{output_file}'"
+    end
+  end
+end
+

data/test/screencaster-gtk.rb

@@ -0,0 +1,6 @@
+class ScreencasterGtk  
+  def stop_recording
+    @@logger.debug "Stopped in test stub"
+    @capture_window.stop_recording
+  end
+end

data/test/test_capture.rb

@@ -0,0 +1,180 @@
+require 'test/unit'
+require 'screencaster-gtk/capture'
+require 'logger'
+require 'fileutils'
+require File.join(File.expand_path(File.dirname(__FILE__)), 'test_utils')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'capture')
+
+# TODO: How to test the actual capture?
+# There's non-trivial stuff in there, like getting the overall duration.
+
+class TestCapture < Test::Unit::TestCase
+  include TestUtils
+
+  def test_merge_two_files
+    output = file_name("c-from-two.mkv")
+    File.delete(output) if File.exists?(output)
+    input = [ file_name("a.mkv"), file_name("b.mkv") ]
+    
+    c = Capture.new
+    $logger.debug "test_merge_two_files: before merge"
+    assert_equal 0, c.merge(output, input)
+    assert File.exists?(output), "Output file #{output} not found."
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_merge_one_file
+    output = file_name("c-from-one.mkv")
+    File.delete(output) if File.exists?(output)
+    input = [ file_name("a.mkv") ]
+    
+    c = Capture.new
+    assert_equal 0, c.merge(output, input)
+    assert File.exists?(output), "Output file #{output} not found."
+    assert File.exists?(input[0]), "Input file #{input[0]} gone."
+    # Process should be gone by now
+    Thread.list.each { |t| puts t }
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_block_merge
+    output = file_name("c-from-one.mkv")
+    File.delete(output) if File.exists?(output)
+    input = [ file_name("a.mkv") ]
+    
+    amount_done = 0.0
+    c = Capture.new
+    r = c.merge(output, input) do | fraction, message |
+        puts "+++++++++++++++++ #{fraction}, #{message}"
+      amount_done = fraction
+    end
+    assert_equal 0, r
+    assert_equal 1.0, amount_done
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_final_encode
+    o = "test-final-encode.mp4"
+    i = "c-from-two.mkv"
+    baseline = file_name(File.join("baseline", o))
+    output = file_name(o)
+    File.delete(output) if File.exists?(output)
+    input = file_name(i)
+    FileUtils.cp(file_name(File.join("baseline", i)), input)
+    
+    c = Capture.new
+    c.total_amount = 1.0
+    assert_equal 0, c.final_encode(output, input)
+    assert File.exists?(output), "Output file #{output} not found."
+    `diff #{baseline} #{output}`
+    assert_equal 0, $?.exitstatus, "Output file different from baseline"
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_record_failure
+    # This will fail since the capture area isn't set up
+    c = Capture.new
+    assert_not_equal 0, c.record
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_merge_failure
+    output = file_name("c-from-one.mkv")
+    File.delete(output) if File.exists?(output)
+    input = [ file_name("file-does-not-exist.mkv") ]
+    
+    c = Capture.new
+    assert_not_equal 0, c.merge(output, input)
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_final_encode_failure
+    o = "test-final-encode.mp4"
+    i = "file-does-not-exist.mkv"
+    baseline = file_name(File.join("baseline", o))
+    output = file_name(o)
+    File.delete(output) if File.exists?(output)
+    input = file_name(i)
+    
+    c = Capture.new
+    c.total_amount = 1.0
+    assert_not_equal 0, c.final_encode(output, input)
+    assert_equal 1, Thread.list.size
+  end
+  
+  def test_default_total
+    c = Capture.new
+    assert_equal 0.0, c.total_amount
+  end
+  
+  def test_total
+    c = Capture.new
+    c.total_amount = 2.0
+    assert_equal 2.0, c.total_amount
+  end
+  
+  def test_current
+    c = Capture.new
+    c.total_amount = 1.0
+    c.current_amount = 0.25
+    assert_equal 0.25, c.current_amount
+    assert_equal 0.25, c.fraction_complete
+    assert_equal 25, c.percent_complete
+    
+    c.total_amount = 0.5
+    assert_equal 0.5, c.fraction_complete
+  end
+  
+  def test_time_remaining
+    c = Capture.new
+    c.total_amount = 1.0
+    c.start_time = Time.new
+    c.current_amount = 0.25
+    assert_in_delta(0.1, 0.1, c.time_remaining)
+    sleep 1
+    assert_in_delta(3, 0.1, c.time_remaining)
+  end
+  
+  def test_time_remaining_none_done_yet
+    c = Capture.new
+    c.total_amount = 1.0
+    c.start_time = Time.new
+    assert_in_delta(0.1, 0.1, c.time_remaining)
+  end
+  
+  def test_time_remaining_s
+    c = Capture.new
+    c.total_amount = 1.0
+    c.current_amount = 0.5
+    c.start_time = Time.new - 3661
+    assert_equal("1h 01m 01s remaining", c.time_remaining_s)
+  end
+  
+  def test_set_fraction_complete
+    c = Capture.new
+    c.total_amount = 4
+    c.fraction_complete = 1
+    assert_not_nil c.current_amount
+    assert_equal 4, c.current_amount
+  end
+  
+  def test_format_seconds
+    assert_equal "1h 01m 01s", Capture::ProgressTracker.format_seconds(3661) 
+  end
+  
+  def test_record_with_mock
+    c = Capture.new
+    c.get_window_to_capture
+    c.define_mock_capture_success
+    assert_equal 0, c.record.exitstatus
+    assert File.exists?("/tmp/screencaster_#{$$}_#{"%04d" % 0}.mkv"), "Record didn't create output file"
+    assert_equal 1, c.video_segments_size
+    assert_equal 0, c.record.exitstatus
+    assert File.exists?("/tmp/screencaster_#{$$}_#{"%04d" % 1}.mkv"), "Record didn't create output file"
+    assert_equal 2, c.video_segments_size
+    c.reset
+    assert_equal 0, c.video_segments_size
+    assert_equal 0, Dir.glob("/tmp/screencaster_#{$$}*").size
+  end
+end
+

data/test/test_screencaster_gtk.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+require 'screencaster-gtk'
+require File.join(File.expand_path(File.dirname(__FILE__)), 'test_utils')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'capture')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'screencaster-gtk')
+
+class TestScreencasterGtk < Test::Unit::TestCase
+  include TestUtils
+  
+  ScreencasterGtk.logger = STDOUT
+  ScreencasterGtk.logger.formatter = proc do |severity, datetime, progname, msg|
+    "#{msg}\n"
+  end
+  
+  def setup
+    @sc = ScreencasterGtk.new
+  end
+  
+  def test_record
+    ScreencasterGtk.logger.debug("Thread exception: #{Thread.abort_on_exception}")
+    ScreencasterGtk.logger.debug("test_record")
+    # Uses the test definition of select defined in the local version of capture.rb
+    @sc.select
+    ScreencasterGtk.logger.debug("selected")
+    @sc.spawn_record
+    ScreencasterGtk.logger.debug("about to sleep")
+    sleep 2
+    ScreencasterGtk.logger.debug("woke up")
+    assert @sc.check_background, "check_background 1 failed"
+    ScreencasterGtk.logger.debug("About to stop")
+    @sc.stop_recording
+    ScreencasterGtk.logger.debug("Stopped (in test_record)")
+    assert @sc.check_background, "check_background 2 failed"
+    assert @sc.background_exitstatus, "Unexpected background failure"
+    assert @sc.check_background, "check_background 3 failed"
+  end
+  
+  def test_encode
+    output = file_name("c.mkv")
+    File.delete output if File.exists? output
+    # Uses the test definition of select defined in the local version of capture.rb
+    @sc.select
+    @sc.capture_window.tmp_files = [file_name("a.mkv")]
+    @sc.capture_window.total_amount = 1
+    assert @sc.spawn_encode(output), "spawn_encode failed"
+    assert @sc.check_background, "check_background failed"
+    assert @sc.background_exitstatus, "Unexpected background failure"
+  end
+  
+  def test_no_background_process
+    assert @sc.check_background, "check_background failed when no background process"
+    assert @sc.background_exitstatus, "Unexpected background failure"
+  end
+  
+  def test_background_fails
+    # Uses the test definition of select defined in the local version of capture.rb
+    @sc.select
+    # Force a failure by giving a bogus sound device
+    @sc.capture_window.audio_input = 'bogus_audio'
+    @sc.spawn_record
+    sleep 1
+    assert ! @sc.check_background, "check_background should have returned false"
+    assert @sc.check_background, "check_background should not have returned false"
+  end
+end

data/test/test_utils.rb

@@ -0,0 +1,17 @@
+module TestUtils
+  Thread.abort_on_exception = true
+  TEST_FILE_PATH = File.dirname(__FILE__)
+  
+  $logger = Logger.new(STDOUT)
+  $logger.formatter = proc do |severity, datetime, progname, msg|
+    "#{msg}\n"
+  end
+  
+  def file_name(f)
+    File.join(TEST_FILE_PATH, f)
+  end
+
+  def baseline_file_name(f)
+    file_name(File.join('baseline', f))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screencaster-gtk
 version: !ruby/object:Gem::Version
-  version: 0.0.5.alpha1
+  version: 0.0.6.alpha1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gdk_pixbuf2
@@ -110,6 +110,11 @@ files:
 - lib/screencaster-gtk/savefile.rb
 - lib/screencaster-gtk/capture.rb
 - lib/screencaster-gtk/progresstracker.rb
+- test/test_screencaster_gtk.rb
+- test/capture.rb
+- test/screencaster-gtk.rb
+- test/test_utils.rb
+- test/test_capture.rb
 - bin/screencaster
 homepage: http://github.org/lcreid/screencaster
 licenses:
@@ -140,5 +145,10 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Screencaster
-test_files: []
+test_files:
+- test/test_screencaster_gtk.rb
+- test/capture.rb
+- test/screencaster-gtk.rb
+- test/test_utils.rb
+- test/test_capture.rb
 has_rdoc: