screen_recorder 0.1.2

data/.yardopts

@@ -0,0 +1,9 @@
+--no-cache
+--no-output
+--verbose
+--markup markdown
+--markup-provider kramdown
+--readme README.markdown
+--hide-void-return
+lib/**/*.rb
+ext/**/*{.m,.c}

data/History.markdown

@@ -0,0 +1,19 @@
+# 0.1.2 - MacRuby Release
+
+  * Appease GC era compiler used by MacRuby
+
+# 0.1.1 - Derp Release
+
+  * Fixed `ScreenRecorder#stop` return value
+
+# 0.1.0 - Initial Release
+
+  * CRuby and MacRuby compatible
+
+  * Added `ScreenRecorder` class
+  * Added `ScreenRecorder#start` method
+  * Added `ScreenRecorder#started?` method
+  * Added `ScreenRecorder#stop` method
+  * Added `ScreenRecorder#length` method
+  * Added `ScreenRecorder#size` method
+  * Added `ScreenRecorder.record` method

data/README.markdown

@@ -0,0 +1,63 @@
+# Screen Recorder
+
+A port of `screen_recorder.rb` from from [AXElements](http://github.com/Marketcircle/AXElements),
+but cleaned up and rewritten in C to be more portable across languages and
+runtimes.
+
+[Documentation](http://rdoc.info/gems/screen_recorder/frames)
+
+
+## Examples
+
+    require 'screen_recorder'
+
+    # in block form
+    ScreenRecorder.record do
+        sleep 10 # go and do stuff
+    end
+    # now go check ~/Movies
+
+    # in "classic" form
+    recorder = ScreenRecorder.new
+    recorder.start
+    # go do stuff
+    recorder.stop
+    # now go check ~/Movies
+
+Both block and non-block forms take an optional string, which should
+be a path to save the recording (the default saves to `~/Movies`).
+
+
+## TODO
+
+* Expose recorder options at initialization (e.g. turn off mouse clicks)
+
+
+## Copyright
+
+Copyright (c) 2012, Mark Rada
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of Mark Rada nor the names of its
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Mark Rada BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,33 @@
+task :default => :test
+
+require 'rake/clean'
+CLEAN.include '*.plist', '*.gch'
+
+desc 'Startup an IRb console with screen_recorder loaded'
+task :console => [:compile] do
+  sh 'irb -Ilib -rscreen_recorder'
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << '.'
+  t.pattern = 'test/*_test.rb'
+end
+task :test => :compile
+
+
+# Gem stuff
+
+require 'rubygems/package_task'
+SPEC = Gem::Specification.load('screen_recorder.gemspec')
+
+Gem::PackageTask.new(SPEC) { }
+
+desc 'Build and install gem (not including deps)'
+task :install => :gem do
+  require 'rubygems/installer'
+  Gem::Installer.new("pkg/#{SPEC.file_name}").install
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('screen_recorder', SPEC)

data/ext/screen_recorder/MCScreenRecorder.h

@@ -0,0 +1,42 @@
+//
+//  MCScreenRecorder.h
+//  ScreenRecorder
+//
+//  Created by Mark Rada on 12-04-07.
+//  Copyright (c) 2012 Marketcircle Incorporated. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import <AVFoundation/AVFoundation.h>
+
+@interface MCScreenRecorder : NSObject <AVCaptureFileOutputDelegate, AVCaptureFileOutputRecordingDelegate> {
+}
+
+@property (assign) AVCaptureSession* session;
+@property (assign) AVCaptureScreenInput* input;
+@property (assign) AVCaptureMovieFileOutput* output;
+
+// File that the recording will be saved to
+@property (assign) NSURL* file;
+
+// Used for pseudo run-loop synchronization
+@property (assign) dispatch_semaphore_t sema;
+
+- (BOOL)   start;
+- (BOOL)   start:(NSURL*)file_name;
+- (BOOL)   isStarted;
+- (double) length;
+- (size_t) size;
+- (BOOL)   stop;
+
+#pragma mark AVCaptureFileOutputDelegate
+- (void)captureOutput:(AVCaptureFileOutput *)captureOutput didOutputSampleBuffer:(CMSampleBufferRef)sampleBuffer fromConnection:(AVCaptureConnection *)connection;
+
+#pragma mark AVCaptureFileOutputRecordingDelegate
+- (void)captureOutput:(AVCaptureFileOutput *)captureOutput didFinishRecordingToOutputFileAtURL:(NSURL *)outputFileURL fromConnections:(NSArray *)connections error:(NSError *)error;
+- (void)captureOutput:(AVCaptureFileOutput *)captureOutput didPauseRecordingToOutputFileAtURL:(NSURL *)fileURL fromConnections:(NSArray *)connections;
+- (void)captureOutput:(AVCaptureFileOutput *)captureOutput didResumeRecordingToOutputFileAtURL:(NSURL *)fileURL fromConnections:(NSArray *)connections;
+- (void)captureOutput:(AVCaptureFileOutput *)captureOutput didStartRecordingToOutputFileAtURL:(NSURL *)fileURL fromConnections:(NSArray *)connections;
+- (void)captureOutput:(AVCaptureFileOutput *)captureOutput willFinishRecordingToOutputFileAtURL:(NSURL *)fileURL fromConnections:(NSArray *)connections error:(NSError *)error;
+
+@end

data/ext/screen_recorder/extconf.rb

@@ -0,0 +1,23 @@
+require 'mkmf'
+
+$CFLAGS << ' -std=c99 -Wall -Werror -pedantic -ObjC'
+$LIBS   << ' -framework AVFoundation -framework Cocoa'
+
+if RUBY_ENGINE == 'macruby'
+  $CFLAGS.gsub! /-Werror/, '' # due to GC era warning that doesn't apply
+  $CFLAGS << ' -fobjc-gc'
+else
+  unless RbConfig::CONFIG["CC"].match /clang/
+    clang = `which clang`.chomp
+    if clang.empty?
+      $stdout.puts "Clang not installed. Cannot build C extension"
+      raise "Clang not installed. Cannot build C extension"
+    else
+      RbConfig::MAKEFILE_CONFIG["CC"]  = clang
+      RbConfig::MAKEFILE_CONFIG["CXX"] = clang
+    end
+  end
+  $CFLAGS << ' -DNOT_MACRUBY'
+end
+
+create_makefile 'screen_recorder/screen_recorder'

data/ext/screen_recorder/screen_recorder.c

@@ -0,0 +1,217 @@
+#import <Cocoa/Cocoa.h>
+#import <AVFoundation/AVFoundation.h>
+
+#include "ruby.h"
+#include "MCScreenRecorder.h"
+
+static VALUE rb_cRecorder;
+static ID sel_new;
+
+static
+void
+rb_recorder_finalizer(id recorder)
+{
+#if NOT_MACRUBY
+  [recorder release];
+#else
+#endif
+}
+
+static
+VALUE
+rb_objc_wrap(id obj)
+{
+  return Data_Wrap_Struct(rb_cRecorder, 0, rb_recorder_finalizer, obj);
+}
+#define OBJC_WRAP(x) (rb_objc_wrap(x))
+
+static
+MCScreenRecorder*
+rb_objc_unwrap(VALUE obj)
+{
+  MCScreenRecorder* recorder;
+  Data_Get_Struct(obj, MCScreenRecorder, recorder);
+  return recorder;
+}
+#define OBJC_UNWRAP(x) (rb_objc_unwrap(x))
+
+static
+VALUE
+rb_recorder_alloc(VALUE klass)
+{
+  MCScreenRecorder* recorder = [[MCScreenRecorder alloc] init];
+  return OBJC_WRAP(recorder);
+}
+
+/*
+ * Synchrnously start recording
+ *
+ * You can optionally specify a file name for the recording; if you do
+ * not then a default name will be provided in the form
+ * `~/Movies/TestRecording-20121017123230.mov`
+ * (the timestamp will be different for you).
+ *
+ * @param file_name [String] (__optional__)
+ * @return [Boolean]
+ */
+static
+VALUE
+rb_recorder_start(int argc, VALUE* argv, VALUE self)
+{
+  BOOL     result = NO;
+  NSString*  path = nil;
+  NSURL* path_url = nil;
+
+  switch (argc)
+    {
+    case 0:
+      result = ([OBJC_UNWRAP(self) start]);
+      break;
+    case 1:
+    default:
+      path = [NSString stringWithCString:StringValueCStr(argv[0])
+	                        encoding:NSUTF8StringEncoding];
+      path_url = [NSURL fileURLWithPath:path];
+      result = [OBJC_UNWRAP(self) start:path_url];
+      [path release];
+      [path_url release];
+    }
+
+  return (result ? Qtrue : Qfalse);
+}
+
+/*
+ * Whether or not the recording has begun
+ *
+ * This will be `true`  after calling {#start} until {#stop} is called.
+ */
+static
+VALUE
+rb_recorder_started(VALUE self)
+{
+  return ([OBJC_UNWRAP(self) isStarted] ? Qtrue : Qfalse);
+}
+
+/*
+ * Duration of the recording, in seconds
+ *
+ * @return [Float]
+ */
+static
+VALUE
+rb_recorder_length(VALUE self)
+{
+  return DBL2NUM([OBJC_UNWRAP(self) length]);
+}
+
+/*
+ * Size of the recording on disk, in bytes
+ *
+ * @return [Fixnum]
+ */
+static
+VALUE
+rb_recorder_size(VALUE self)
+{
+  return SIZET2NUM([OBJC_UNWRAP(self) size]);
+}
+
+/*
+ * Synchronously stop recording and finish up commiting any data to disk
+ *
+ * A recording cannot be {#start}ed again after it has been stopped. You
+ * will need to start a new recording.
+ *
+ * @return [Boolean]
+ */
+static
+VALUE
+rb_recorder_stop(VALUE self)
+{
+  return ([OBJC_UNWRAP(self) stop] ? Qtrue : Qfalse);
+}
+
+/*
+ * Path to the screen recording on disk
+ *
+ * This is `nil` until the screen recording begins.
+ *
+ * @return [String,nil]
+ */
+static
+VALUE
+rb_recorder_file(VALUE self)
+{
+  NSString* name = [[OBJC_UNWRAP(self) file] path];
+  if (name)
+    return rb_str_new_cstr([name cStringUsingEncoding:NSUTF8StringEncoding]);
+  else
+    return Qnil;
+}
+
+static
+VALUE
+rb_recorder_yielder(VALUE self)
+{
+  rb_yield(self);
+  return rb_recorder_file(self);
+}
+
+/*
+ * Record the screen while executing the given block
+ *
+ * You may optionally specify the path to save the recording to, just
+ * as when calling {#start}.
+ *
+ * The path to the recording will be returned. The recorder object is yielded.
+ *
+ * @yield
+ * @yieldparam recorder [ScreenRecorder]
+ * @param file_name [String] (__optional__)
+ * @return [String]
+ */
+static
+VALUE
+rb_recorder_record(int argc, VALUE* argv, VALUE self)
+{
+  VALUE recorder = rb_funcall(rb_cRecorder, sel_new, 0);
+  rb_recorder_start(argc, argv, recorder);
+  return rb_ensure(rb_recorder_yielder, recorder, rb_recorder_stop, recorder);
+}
+
+
+void
+Init_screen_recorder()
+{
+  sel_new = rb_intern("new");
+
+  /*
+   * Document-class: ScreenRecorder
+   *
+   * Screen recordings, easy as pi.
+   *
+   * Things that you need to be concerned about:
+   *   - screen going to sleep (we can resolve this issue later)
+   *   - short recordings (~1 second) don't work too well; it looks like
+   *     the last bit of the buffer does not get saved so the last ~0.5
+   *     seconds are not saved to disk (we could add a 0.5 second sleep)
+   *   - small memory leak when a recording starts on Mountain Lion (GC)
+   *   - constantly leaking memory during recording on Lion (GC)
+   *   - run loop hack is not needed if code is already being called from
+   *     in a run loop
+   *   - pausing is not working...not sure why; so it is not exposed for now
+   *
+   */
+  rb_cRecorder = rb_define_class("ScreenRecorder", rb_cObject);
+
+  rb_define_alloc_func(rb_cRecorder, rb_recorder_alloc);
+
+  rb_define_method(rb_cRecorder, "start",      rb_recorder_start,   -1);
+  rb_define_method(rb_cRecorder, "started?",   rb_recorder_started,  0);
+  rb_define_method(rb_cRecorder, "length",     rb_recorder_length,   0);
+  rb_define_method(rb_cRecorder, "size",       rb_recorder_size,     0);
+  rb_define_method(rb_cRecorder, "stop",       rb_recorder_stop,     0);
+  rb_define_method(rb_cRecorder, "file",       rb_recorder_file,     0);
+
+  rb_define_singleton_method(rb_cRecorder, "record", rb_recorder_record, -1);
+}

data/lib/screen_recorder/version.rb

@@ -0,0 +1,4 @@
+class ScreenRecorder
+  # @return [String]
+  VERSION = '0.1.2'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: screen_recorder
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Mark Rada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: ! 'screen_recorder is a wrapper around some of the OS X AVFoundation
+  framework.
+
+
+  Originally extracted from the AXElements project.
+
+'
+email: markrada26@gmail.com
+executables: []
+extensions:
+- ext/screen_recorder/extconf.rb
+extra_rdoc_files: []
+files:
+- lib/screen_recorder/version.rb
+- ext/screen_recorder/screen_recorder.c
+- ext/screen_recorder/MCScreenRecorder.h
+- ext/screen_recorder/extconf.rb
+- Rakefile
+- README.markdown
+- History.markdown
+- .yardopts
+homepage: http://github.com/ferrous26/screen_recorder
+licenses:
+- BSD 3-clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 127306656123456593
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 127306656123456593
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A class that allows recording your screen in OS X
+test_files: []