cinesync 0.9.6

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jonathon Mah
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,53 @@
+# cineSync RubyGem
+
+## Quick Start
+### Installing the Gem
+
+    gem install cinesync
+
+### Creating a session file
+
+    #!/usr/bin/ruby
+    require 'rubygems'
+    require 'cinesync'
+
+    s = CineSync::Session.new
+    s.media << CineSync::MediaFile.new("http://cinesync.com/files/sample_qt.mov")
+    s.media << CineSync::MediaFile.new("/System/Library/Compositions/Fish.mov")
+    File.open("/tmp/session.csc", "w") {|f| f << s.to_xml }
+
+
+### Running in response to an event
+
+    #!/usr/bin/ruby
+    require 'rubygems'
+    require 'cinesync'
+
+    CineSync.event_handler do |evt|
+      puts "cineSync online with key #{evt.session_key}" unless evt.offline?
+      puts "Playlist has #{evt.session.media.length} files"
+      active_file = evt.session.media.find {|m| m.active? }
+      puts "Currently viewing #{active_file.name}" if active_file
+    end
+
+
+## Scripting Overview
+
+cineSync 3.0 has new support for calling user-defined scripts. (Scripting requires a cineSync Pro account.) These are configured in cineSync's preferences. Scripts can be run from the Session &gt; Run Script menu, and can also be set to automatically trigger on certain events. When triggered, the script will be passed some arguments about the current environment (the current session key, where frames are being saved, and the save frame format), and the current session will be serialized and sent to it through standard I/O.
+
+Additionally, a script can be run from a different application, set up a session, and send it to cineSync.
+
+(More info to come: URLs etc)
+
+
+## Links
+
+ * [cineSync homepage](http://cinesync.com/)
+
+## Files
+
+ * `cineSync Session v3 Schema.rnc`: Session XML schema in [RELAX NG](http://relaxng.org/) Compact syntax
+
+## Copyright
+
+Copyright (c) 2010 Rising Sun Research Pty Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cinesync"
+    gem.summary = %Q{Library for scripting the cineSync collaborative video review tool}
+    gem.description = <<-EOF
+      This gem provides a Ruby interface to the cineSync session file format,
+      which is used by cineSync's scripting system. Use it to integrate
+      cineSync into your workflow.
+    EOF
+    gem.email = ["jmah@cinesync.com", "info@cinesync.com"]
+    gem.homepage = "http://github.com/jmah/cinesync"
+    gem.authors = ["Jonathon Mah", "Rising Sun Research"]
+    gem.add_dependency "activesupport", ">= 2.3"
+    gem.add_dependency "andand", ">= 1.3.1"
+    gem.add_dependency "builder", ">= 2.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cinesync #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Samples/Export Notes to CSV.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby
+#
+# This script reads the current session from cineSync and converts all notes
+# made on the session, each media file, and each frame to a CSV file. This file
+# can then be processed by other scripts or opened in a spreadsheet program
+# (Microsoft Excel, OpenOffice.org Calc, Apple Numbers).
+#
+
+require 'rubygems'
+require 'cinesync'
+require 'csv'
+
+
+CineSync.event_handler do |evt|
+  name = "Notes from #{evt.offline? ? "offline session" : evt.session_key}.csv"
+  path = CineSync::UI.prompt_to_save("Save CSV file as:", name)
+  exit if path.nil? # User cancelled
+
+  CSV.open(path, "w") do |csv|
+    csv << ["Media File", "Frame", "Notes"] # Header row
+
+    csv << ["", "[Session]", evt.session.notes] unless evt.session.notes.empty?
+
+    evt.session.media.each do |media|
+      csv << [media.name, "[Media File]", media.notes] unless media.notes.empty?
+      media.annotations.keys.sort.each do |frame|
+        ann = media.annotations[frame]
+        next if ann.notes.empty?
+        csv << [media.name, frame, ann.notes]
+      end
+    end
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.6

data/cineSync Session v3 Schema.rnc

@@ -0,0 +1,164 @@
+# ==== Namespace ====
+default namespace csc = "http://www.cinesync.com/ns/session/3.0"
+
+# ==== Data types ====
+tBool           = "true" | "false"
+tPositiveFloat  = xsd:float { minExclusive = "0" }
+tFrameNumber    = xsd:integer { minInclusive = "1" }
+tAlpha          = xsd:float { minInclusive = "0" maxInclusive = "1" }
+tColorOff       = xsd:float { minInclusive = "-0.2" maxInclusive = "0.2" }
+tColorExp       = xsd:float { minInclusive = "0.367879" maxInclusive = "2.718282" } # exp(-1) .. exp(1)
+tUnitFloat      = xsd:float { minInclusive = "-1" maxInclusive = "1" }
+tColor          = xsd:string { pattern = "#[0-9a-fA-F]{6}" }
+tShortHash      = xsd:string { length = "40" }
+tFilePath       = xsd:string { minLength = "1" }
+tURL            = xsd:string { minLength = "1" }
+tStereoType     = "side-by-side" | "composite" | "interlaced"
+tPoint          = xsd:float
+
+
+# ==== Session format ====
+start = eSession
+
+eSession = element session {
+  attribute version { xsd:integer { minInclusive = "3" } } &
+  attribute sessionFeatures { "standard" | "pro" } &
+  attribute hashToken { string }? &
+  aUserData? &
+  eGroup* &
+  eNotes? &
+  eChat? &
+  eStereo? &
+  eMedia* }
+
+MediaBase =
+  aUserData? &
+  attribute active { tBool }? &
+  attribute currentFrame { tFrameNumber }? &
+  eGroup* &
+  ePlayRange?
+
+eMedia |= element media {
+  # Normal media file
+  MediaBase &
+  element name { xsd:string { minLength = "1" } } &
+  element locators { eLocator+ } &
+  eNotes? &
+  eZoomState? &
+  ePixelRatio? &
+  eMask? &
+  eColorGrading? &
+  eFrameAnnotation* }
+
+eMedia |= element media {
+  # Group movie
+  MediaBase &
+  element groupMovie { eGroup } }
+
+eLocator |= element path       { tFilePath }
+eLocator |= element shortHash  { tShortHash }
+eLocator |= element url        { tURL }
+
+ePlayRange = element playRange {
+  element inFrame       { attribute value { tFrameNumber } } &
+  element outFrame      { attribute value { tFrameNumber } } &
+  element playOnlyRange { aBoolValue } }
+
+eZoomState = element zoomState {
+  element center { aXY } &
+  eScaleFactor }
+
+ePixelRatio = element pixelRatio {
+  element source { aRatio } &
+  element target { aRatio } }
+
+eMask = element mask {
+  aAlpha &
+  element center { aXY } &
+  element ratio { aRatio } &
+  eScaleFactor }
+
+eNotes = element notes { text }
+
+eChat = element chat { text }
+
+eStereo = element stereo {
+  attribute enabled { tBool } &
+  attribute type    { tStereoType } &
+  element anamorphic    { aBoolValue }? &
+  element anaglyph      { aBoolValue }? &
+  element grayscale     { aBoolValue }? &
+  element separation {
+    attribute annotation  { tUnitFloat } &
+    attribute image       { tUnitFloat } }? }
+
+eColorGrading = element colorGrading {
+  element offset {
+    attribute red       { tColorOff } &
+    attribute green     { tColorOff } &
+    attribute blue      { tColorOff } }? &
+
+  element brightness {
+    attribute rgb       { tColorExp } &
+    attribute red       { tColorExp } &
+    attribute green     { tColorExp } &
+    attribute blue      { tColorExp } }? &
+
+  element saturation  { attribute value { tColorExp } }? &
+  element gamma       { attribute value { tColorExp } }? &
+  element contrast    { attribute value { tColorExp } }? &
+
+  element linearToLog { aBoolValue }? &
+  element lutPath     { attribute value { tFilePath } }? }
+
+
+# ==== Frame annotations ====
+eFrameAnnotation = element annotation {
+  attribute frame { tFrameNumber } &
+  eNotes? &
+  eObject* }
+
+eObject |= element line    { aObjectID? & aAlphaColor & LinePath }
+eObject |= element erase   { aObjectID? & ErasePath }
+eObject |= element circle  { aObjectID? & aAlphaColor & Rect }
+eObject |= element arrow {
+  aObjectID? &
+  aAlphaColor &
+  Rect &
+  element special   { aBoolValue }? &
+  element flipSide  { aBoolValue }? &
+  element reverse   { aBoolValue }? }
+
+eObject |= element text {
+  aObjectID? &
+  Rect &
+  element background  { aAlphaColor } &
+  element foreground  { aAlphaColor } &
+  element p { text } }
+
+
+# ==== Components ====
+aAlpha       = attribute alpha    { tAlpha }
+aAlphaColor  = attribute color    { tColor } & aAlpha
+aBoolValue   = attribute value    { tBool }
+aObjectID    = attribute id       { xsd:string { minLength = "1" } }
+aUserData    = attribute userData { text }
+eGroup       = element group      { xsd:string { minLength = "1" } }
+eScaleFactor = element scaleFactor { attribute value { tPositiveFloat } }
+
+aRatio  &= attribute width  { tPositiveFloat }
+aRatio  &= attribute height { tPositiveFloat }
+
+aXY &= attribute x  { tPoint }
+aXY &= attribute y  { tPoint }
+
+
+# ==== Object components ====
+LinePath  &= attribute thickness { tPositiveFloat }
+LinePath  &= element point { aXY & aAlpha? }+
+
+ErasePath &= attribute thickness { tPositiveFloat }
+ErasePath &= element point { aXY }+
+
+Rect  &= element startPoint { aXY }
+Rect  &= element endPoint   { aXY }

data/cinesync.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cinesync}
+  s.version = "0.9.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jonathon Mah", "Rising Sun Research"]
+  s.date = %q{2010-05-08}
+  s.description = %q{      This gem provides a Ruby interface to the cineSync session file format,
+      which is used by cineSync's scripting system. Use it to integrate
+      cineSync into your workflow.
+}
+  s.email = ["jmah@cinesync.com", "info@cinesync.com"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "Samples/Export Notes to CSV.rb",
+     "VERSION",
+     "cineSync Session v3 Schema.rnc",
+     "cinesync.gemspec",
+     "lib/cinesync.rb",
+     "lib/cinesync/color_grading.rb",
+     "lib/cinesync/event_handler.rb",
+     "lib/cinesync/frame_annotation.rb",
+     "lib/cinesync/mask.rb",
+     "lib/cinesync/media_file.rb",
+     "lib/cinesync/pixel_ratio.rb",
+     "lib/cinesync/play_range.rb",
+     "lib/cinesync/session.rb",
+     "lib/cinesync/ui.rb",
+     "lib/cinesync/ui/standard_additions.rb",
+     "lib/cinesync/ui/win32_save_file_dialog.rb",
+     "lib/cinesync/xml.rb",
+     "lib/cinesync/zoom_state.rb",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jmah/cinesync}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Library for scripting the cineSync collaborative video review tool}
+  s.test_files = [
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3"])
+      s.add_runtime_dependency(%q<andand>, [">= 1.3.1"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3"])
+      s.add_dependency(%q<andand>, [">= 1.3.1"])
+      s.add_dependency(%q<builder>, [">= 2.1"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3"])
+    s.add_dependency(%q<andand>, [">= 1.3.1"])
+    s.add_dependency(%q<builder>, [">= 2.1"])
+  end
+end
+

data/lib/cinesync/color_grading.rb

@@ -0,0 +1,70 @@
+module CineSync
+  class ColorGrading
+    attr_reader :offset, :brightness
+    attr_accessor :saturation, :gamma, :contrast, :linear_to_log, :lut_path
+
+    alias_method :linear_to_log?, :linear_to_log
+
+    def initialize
+      @offset = RGBArray.new([0.0] * 3)
+      @brightness = BrightnessArray.new([1.0] * 4)
+      @saturation = 1.0
+      @gamma = 1.0
+      @contrast = 1.0
+      @linear_to_log = false
+      @lut_path = nil
+    end
+
+    def default?
+      offset == [0.0]*3 and brightness == [1.0]*4 and
+      [saturation, gamma, contrast].all? {|f| f == 1.0 } and
+      not linear_to_log? and lut_path.nil?
+    end
+
+    def valid?
+      exp_range = Math.exp(-1)..Math.exp(1)
+      default? or (offset.length == 3 and brightness.length == 4 and
+      offset.all? {|o| (-0.2..0.2) === o } and
+      [saturation, gamma, contrast, *brightness].all? {|b| exp_range === b }) rescue false
+    end
+  end
+
+
+  class RGBArray < Array
+    # Implements an array of three values (corresponding to red, green, and
+    # blue) that can be indexed by position or string-convertible object:
+    #  r,g,b = rgbary[0], rgbary[1], rgbary[2]
+    #  r,g,b = rgbary['red'], rgbary[:green], rgbary[:b]
+
+    def [](key)
+      index = index_for_key(key)
+      fail "Unknown key used to index #{self.class}: #{key.inspect}" unless index
+      self.at(index)
+    end
+
+    def []=(key, value)
+      index = index_for_key(key)
+      fail "Unknown key used to index #{self.class}: #{key.inspect}" unless index
+      super(index, value)
+    end
+
+    protected
+    def index_for_key(key)
+      if Fixnum === key then key
+      elsif %w[red   r].include?(key.to_s.downcase) then 0
+      elsif %w[green g].include?(key.to_s.downcase) then 1
+      elsif %w[blue  b].include?(key.to_s.downcase) then 2
+      end
+    end
+  end
+
+
+  class BrightnessArray < RGBArray
+    protected
+    def index_for_key(key)
+      if %w[all rgb].include?(key.to_s.downcase) then 3
+      else super
+      end
+    end
+  end
+end

data/lib/cinesync/event_handler.rb

@@ -0,0 +1,67 @@
+require 'pathname'
+
+
+module CineSync
+  class EventHandler
+    attr_reader :save_format, :save_ext, :save_parent, :url, :session_key, :session
+
+    def initialize(argv, session)
+      @save_format = arg_value(argv, :save_fmt).downcase.to_sym
+      @save_ext = { :jpeg => 'jpg', :png => 'png' }[@save_format]
+      sp = arg_value(argv, :save_path, false)
+      @save_parent = Pathname.new(sp) if sp
+
+      @url = arg_value(argv, :url, false)
+
+      key_val = arg_value(argv, :key)
+      @session_key = key_val if key_val != OfflineKey
+
+      @session = session
+    end
+
+    def offline?
+      @session_key.nil?
+    end
+
+    def saved_frame_path(media_file, frame)
+      return nil unless save_parent
+
+      # This algorithm is ugly and will be improved before release
+      base = ('%s-%05d' % [media_file.name, frame])
+      i = 1; p2 = nil
+      begin
+        p = p2
+        p2, i = saved_frame_ver_path(base, i)
+      end while p2.exist?
+      p
+    end
+
+
+    private
+
+    ArgMatchers = { :key          => /^--key=(\w+)$/,
+                    :save_fmt     => /^--save-format=(.+)$/,
+                    :save_path    => /^--save-dir=(.+)$/,
+                    :url          => /^--url=(.+)$/ }
+
+    def arg_value(argv, arg_key, required = true)
+      re = ArgMatchers[arg_key]
+      fail "Unknown symbolic argument key: #{arg_key.inspect}" unless re
+      args = argv.select {|a| a =~ re }
+      if args.empty?
+        if required
+          fail "Unable to find argument matching #{re.inspect} (argument key: #{arg_key.inspect})"
+        else
+          return nil
+        end
+      end
+      fail "Found multiple arguments matching #{re.inspect}: #{args.inspect}" if args.size > 1
+      args[0].match(re)[1]
+    end
+
+    def saved_frame_ver_path(base, version)
+      basename = base + (version == 1 ? '' : " (#{version})") + '.' + save_ext
+      [save_parent + basename, version + 1]
+    end
+  end
+end

data/lib/cinesync/frame_annotation.rb

@@ -0,0 +1,19 @@
+module CineSync
+  class FrameAnnotation
+    attr_accessor :frame, :notes, :drawing_objects
+
+    def initialize(frame_num)
+      @frame = frame_num
+      @notes = ''
+      @drawing_objects = []
+    end
+
+    def default?
+      notes.empty? and drawing_objects.empty?
+    end
+
+    def valid?
+      frame >= 1
+    end
+  end
+end

data/lib/cinesync/mask.rb

@@ -0,0 +1,41 @@
+module CineSync
+  class Mask
+    attr_accessor :alpha, :center, :scale_factor
+    attr_accessor :width, :height
+
+    def initialize(ratio_or_width = nil, height = nil)
+      @alpha = 1.0
+      @center = [0.5, 0.5]
+      @scale_factor = 1.0
+      if ratio_or_width and height.nil?
+        self.ratio = ratio_or_width
+      elsif ratio_or_width and height
+        @width = Float(ratio_or_width)
+        @height = Float(height)
+      else
+        @width = 1
+        @height = 1
+      end
+    end
+
+    def ratio
+      wh = [width, height]
+      # Convert to ints if the float represents an int
+      wh.map {|f| (f == f.floor) ? f.to_i : f }.map {|num| num.to_s }.join(':')
+    end
+
+    def ratio=(rat)
+      @width, @height = rat.split(':', 2).map(&:to_f)
+    end
+
+    def default?
+      alpha == 1.0 and center == [0.5, 0.5] and scale_factor == 1.0 and
+      width > 0.0 and width == height
+    end
+
+    def valid?
+      default? or (width > 0.0 and height > 0.0 and center.length == 2 and
+      [alpha, scale_factor, *center].all? {|f| (0.0..1.0) === f }) rescue false
+    end
+  end
+end