vid-skim 0.0.1

data/parsers/edl_parser.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'json'
+gem 'vid-skim'
+gem 'edl'
+
+class EdlParser < VidSkim::Parser
+  # Build a VidSkim collection of files from an EDL file.
+  def load(file)
+    list = EDL::Parser.new(fps=30).parse(File.open(file))
+    @transcript = VidSkim::Transcript.new({})
+    @transcript.title = File.basename(file)
+    @transcript.divisions["Transcript"] = VidSkim::Transcript::Division.new("Transcript")
+    
+    list.each do |evt|
+      entry = VidSkim::Transcript::Entry.new
+      entry.title = evt.clip_name
+      clip_start = evt.rec_start_tc
+      clip_end = evt.rec_end_tc
+      entry.range = ["#{clip_start.hours}:#{clip_start.minutes}:#{clip_start.seconds}", 
+                      "#{clip_end.hours}:#{clip_end.minutes}:#{clip_end.seconds}"]
+      @transcript.divisions["Transcript"].entries << entry
+    end 
+  end
+  
+  
+end

data/parsers/json_parser.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gem "vid-skim"
+gem "json"
+
+class JsonParser < VidSkim::Parser
+  # Build an expanded collection of files from a VidSkim JSON file.
+  def load(file)
+    @transcript = VidSkim::Transcript.find(file)
+  end
+end

data/template/html/javascripts/vid_skim.js

@@ -0,0 +1,319 @@
+/*
+###### Preloader
+*/
+$.preloadImages = function(){
+  $.each(arguments, function (){
+    $("<img>").attr("src", this);
+  });
+};
+
+/*
+###### Transcript
+*/
+function defineTranscript($) {
+  var transcript = function (timeline_id, trans_id, extra_id, nav_id, tab_id, rail_id, viewer_id, location) { /* TK params should be hasherized */
+    this.current_texts = [];
+    this.timeline_id = timeline_id;
+    this.trans_id = trans_id;
+    this.extra_id = extra_id;
+    this.rail_id = rail_id;
+    this.nav_id = nav_id;
+    this.tab_id = tab_id;
+    this.viewer_id = viewer_id;
+    this.max = 0;
+    this.hashSeconds = parseInt(location.hash.replace("#", ''), 10) || 0;
+    this.baseURL = location.href.replace(location.hash, '');
+    this.initted = false;
+  };
+  transcript.prototype = {
+    init: function(){    
+    },
+    
+    // central dispatch for data setting and view switching
+    setData: function(raw_data, key) {
+      this.raw_data = raw_data || this.raw_data;
+      var temp = {};
+      temp = this.raw_data.divisions[key];
+      this.mode = key;
+      this.parsed_data = temp;      
+      transcript = this;
+      $(this.tab_id + " a.tab-" + key).addClass('active');
+      $(this.rail_id + " div").hide();
+      $(this.rail_id + " div." + this.parameterize(key)).show();
+      $(this.rail_id + " div." + this.parameterize(key)).children().show();
+
+      if (this.initted){ /* for tabs */
+        this.buildTimeline();
+      } else {
+        $.each(this.raw_data.divisions, function(){
+          $.each(this.entries, function() {
+            
+            this.range[0] = transcript.timeCodeParse(this.range[0]);
+            this.range[1] = transcript.timeCodeParse(this.range[1]);
+          });
+        });
+      }
+    },
+    
+    //called after we know the length of the video
+    setBounds: function(max) {
+      if(this.max === 0){
+        this.max = max;
+  		  this.initTimeLine();
+        this.draw(0);
+      }
+    },
+    
+    //convienence method and hook for possible support of other players
+    setPlayer: function(player) {
+      this.player = player;
+    },
+    
+    //handles all construction of extra html elements, as well as initializing mouse listeners
+    initTimeLine: function(){
+      /* scrubber and timeline */
+      var scrubber_selector = this.timeline_id + " div.scrubber";
+      var timeline = this.timeline_id;
+      
+		  var max = this.max;
+		  var transcript = this;
+      $(scrubber_selector).hide();
+	    $(this.timeline_id).mouseover(function(){$(scrubber_selector).show();});
+	    $(this.timeline_id).mousemove(function(e) {
+		    var x_real = e.clientX - $(timeline).offset().left;
+		    var titles = transcript.lookup(Math.floor(x_real*max/$(timeline).width()));
+	      if (titles[0]) {
+	        $(scrubber_selector).html(titles[0].title);
+        } else {
+          $(scrubber_selector).html('');
+        }
+		    if (x_real < $(timeline).width()){
+		      $(scrubber_selector).css({'left': x_real});
+		    }
+		  });
+		  
+		  $(this.timeline_id).click(function(e){
+		    var x_real = e.clientX - $(timeline).offset().left;
+		    var seconds = Math.floor(x_real*max/$(timeline).width());
+		    seconds = transcript.lookup(seconds).length ?
+		              transcript.lookup(seconds)[0].range[0] : seconds;
+		    transcript.seek(seconds);
+		  });
+		  
+		  $(this.timeline_id).mouseleave(function(){
+		    $(scrubber_selector).hide();
+		  });
+		  
+		  /*navigation*/
+		  $.each(["Next", "Previous"], function() {
+		     $(transcript.nav_id + " a." + this.toLowerCase()).click(function (e){
+		       transcript[$(this).attr('class')]();
+		       return false;
+		     });
+		  });
+		  
+		  $("a.index").click(function (e){
+		    transcript.seek(parseInt($(this).attr('href').replace('#', ''), 10));
+		    return false;
+		  });
+		  $.each(this.raw_data.divisions, function(i, val){
+		    $(transcript.tab_id + ' a.tab-' + i).
+		      prepend("<span class=\"color\" style=\"border-color:" + 
+		              val.color + "; background-color:" +
+		              val.color +  "\">&nbsp;</span>&nbsp;"); 
+		  });
+		  $(this.tab_id + ' a').click(function (e){
+        if(transcript.current_tab !== $(this).attr('class').replace("tab-", '')){
+          transcript.current_tab = $(this).attr('class').replace("tab-", '');
+          $(transcript.tab_id + " a").removeClass('active');
+          transcript.setData(null, $(this).attr('class').replace("tab-", ''));
+        }
+        return false;
+      });
+      
+		  /*height calculations*/
+		  var height = $(this.rail_id).height()-45;
+		  $(this.viewer_id).css({'height':height+'px'});
+		  $(this.trans_id).css({'height':height-60+'px'});
+		  
+		  
+		  this.buildTimeline();  
+    },
+    // refreshes the timeline each time setData is called.
+    buildTimeline: function (){
+      /* boxes */
+      var timeline = this.timeline_id;
+      var max = this.max;
+		  var transcript = this;
+      $(this.timeline_id + " div.time_box").remove();
+      
+		  $.each(this.parsed_data.entries, function() {
+	      $(timeline).append('<div class="' + transcript.parameterize(this.title) + ' time_box" style="left:'+ Math.floor(this.range[0]*$(timeline).width()/max) + 'px; width:' + (Math.floor(this.range[1]*$(timeline).width()/max) - Math.floor(this.range[0]*$(timeline).width()/max)) + 'px">&nbsp;</span>');
+        
+	    });
+      
+      $(timeline + " .time_box").css({
+        'background-color': this.color
+      });
+      this.highlightSection();
+      
+      $(timeline + " .time_box").hover(function(){
+        transcript.highlightSection();
+        $(this).css({'background-color':transcript.parsed_data.hover});
+      }, function(){
+        $(this).css({'background-color':transcript.parsed_data.color});
+        transcript.highlightSection();
+      });
+    },
+	    
+    
+    //highlights the current section on the timeline
+    highlightSection: function(){
+      $(this.timeline_id + ' .time_box').css({
+        'background-color':
+        this.parsed_data.color  
+      });
+      if(this.current_texts[0]) {
+        
+        $(this.timeline_id + ' .'+
+         this.parameterize(this.current_texts[0].title)).css({
+          'background-color':
+           this.parsed_data.hover
+        });
+      }
+    },
+    
+    //convenience method for working with hash keys
+    parameterize: function (str) {
+      return str.toLowerCase().replace(/[^a-z0-9\-_\+]+/ig, '');
+    },
+    
+    testTexts: function(texts){
+      var test = !texts || !texts[0] || !this.current_texts || !this.current_texts[0] || 
+	        texts[0].range[0] !== 
+	        this.current_texts[0].range[0];
+      return test;
+    },
+    //rerenders the current view as needed
+    draw: function(time){
+      if(this.initted){
+        var texts = this.lookup(time);
+        if(this.testTexts(texts)){ /* transcript */
+              this.current_texts = texts;
+        		  this.highlightSection();
+              
+              var trans_all = "";
+            
+              if(this.current_texts[0]){
+                /* index highlighting */
+                $('a.index').removeClass('active');
+                $('a.index.' + this.parameterize(this.current_texts[0].title))
+                  .addClass('active');
+            
+            
+                /* transcript building */
+                $.each(this.current_texts, function(){
+                  trans_all = trans_all + '<div class="' + this.css_class + '">' + this.transcript + "</div>";
+             
+                });
+
+                $(this.trans_id).html(trans_all);
+              } else {
+            
+                $(this.trans_id).html('');
+              }
+          
+              if(this.current_texts[0] && Math.floor(this.current_texts[0].range[0]) > 0){
+                var new_seconds = Math.floor(this.current_texts[0].range[0]);
+                if(new_seconds !== this.hashSeconds){
+                  this.hashSeconds = Math.floor(this.current_texts[0].range[0]);
+                  window.location.href = trans.baseURL + "#" + this.hashSeconds;
+                }
+              }
+          
+            }
+            $(this.timeline_id + " div.position").css({'left':this.player.getCurrentTime()*$(this.timeline_id).width()/this.max});
+      }
+    },
+    
+    //convenience caller to seekToIndex
+    next: function(){
+      this.seekToIndex(1);
+    },
+    //convenience caller to seekToIndex
+    previous: function(){
+      this.seekToIndex(0);
+    },
+    
+    seekToIndex: function(offset) {
+      var time = this.player.getCurrentTime();
+      var entries = this.lookup(time, true);
+      if(entries[0][offset]){
+        this.seek(entries[0][offset].range[0]);
+      }
+    },
+    //the brains of the operation, a binary search that can handle arbitrary ranges of data, returns the next and previous items if asked nicely
+    lookup: function(time, nearest){
+      var ret = [];
+      nearest = nearest || false;
+      
+      var start = 0;
+      var end = this.parsed_data.entries.length;
+      while (start < end) {
+         var mid = Math.floor((start+end)/2);
+         if (this.parsed_data.entries[mid].range[1] < time) {
+           start = mid+1;
+         } else {
+           end = mid;
+         }
+       }
+       if (nearest){
+         var before = this.parsed_data.entries[start-1];
+         var after = this.parsed_data.entries[start+1];
+         var found = this.parsed_data.entries[start];
+         var first = this.parsed_data.entries[0];
+         var last = this.parsed_data.entries[this.parsed_data.entries.length-1];
+         
+         if(this.parsed_data.entries[start] && 
+            this.parsed_data.entries[start].range[0] <= time &&
+            this.parsed_data.entries[start].range[1] >= time){ // case 1: in a clip
+           ret.push([before, after]);
+         } else if(start === 0) { // case 3: before any clips
+           ret.push([first, first]);
+         } else if(this.parsed_data.entries[start] && 
+                    this.parsed_data.entries[start-1].range[1] < time &&
+                    this.parsed_data.entries[start].range[0] > time) { // case 2: in between clips
+           ret.push([before, found]);
+         } else if(start >= end){ // case 4: after any clips
+           ret.push([last,last]);
+         }
+       } else {
+         if (this.parsed_data.entries[start] && 
+             this.parsed_data.entries[start].range[0] <= time && 
+             this.parsed_data.entries[start].range[1] >= time) {
+               var find = this.parsed_data.entries[start];
+               find.css_class = this.mode;
+               ret.push(find);
+         }
+      }
+
+      return ret;
+    },
+    //parsing into integers from "hh:mm:ss" format
+    timeCodeParse: function(timeCode){
+      var times = timeCode.split(':');
+      var hours = parseInt(times[0], 10);
+      var minutes = parseInt(times[1], 10);
+      var seconds = parseInt(times[2], 10);
+      return hours*60*60 + minutes*60 + seconds;
+    },
+    
+    //wrapper function
+    seek: function(time) { 
+      this.player.seekTo(time+1, true); 
+    }
+  };
+  return transcript;
+}
+// all that for this.
+var Transcript = defineTranscript($);

data/template/html/stylesheets/vid_skim.css

@@ -0,0 +1,167 @@
+#vid-skim, #vid-skim div, #vid-skim span,  #vid-skim p,
+#vid-skim a, #vid-skim strong {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	vertical-align: baseline;
+	background: transparent;
+	font-size: 11px;
+  font-family: Helvetica, Arial, Sans-serif;
+}
+
+#vid-skim p{
+  font-size: 12px;
+  margin-bottom: 12px;
+}
+
+#vid-skim a:link, #vid-skim a:visited {
+  background-color:transparent;
+  color:#143D8D;
+  text-decoration:none;
+}
+
+#vid-skim div.viewer {
+  padding: 20px;
+  border: 5px solid #e4e4e4;
+  width: 775px;
+  height: 360px;
+  overflow: hidden;
+  margin: 0;
+  margin-bottom: 10px;
+  position: relative;
+  float:left;
+}
+#vid-skim div.timeline {
+  width:82%; 
+  height:32px; 
+  background-color:#DCDED2; 
+  position:relative; 
+  margin-bottom: 1em;
+}
+
+#vid-skim div.timeline div.scrubber {
+  color: #222; 
+  font-family: sans-serif; 
+  padding:.2em .1em .1em .1em; 
+  font-size: 12px; 
+  width: 300px;
+  position:absolute; 
+  top:-16px; 
+  left: 0px;
+  display:none;
+  z-index:200;
+}
+#vid-skim div.timeline div.position {
+  border-left:3px solid #fff; 
+  height:100%; 
+  width:2px; 
+  position:absolute; 
+  top:0; 
+  left:0; 
+  z-index:100
+}
+#vid-skim div.timeline div.time_box{
+  height:100%; 
+  position:absolute;
+  display:block;
+  top:0; 
+  left:0;
+}
+#vid-skim div.vid-nav{
+  width: 18%;
+  height:32px;
+  margin-bottom: 5px;
+  position: absolute;
+  top:20px;
+  right:20px;
+}
+#vid-skim div.vid-nav a {
+  width: 65px;
+  height: 32px;
+  text-indent: -9999px;
+  display: block;
+  float: right;
+  padding: 3px 0 0 3px;
+}
+
+#vid-skim div.vid-nav a.previous{
+  background: transparent url('../images/prev.jpg') no-repeat;
+}
+#vid-skim div.vid-nav a.next{
+  background: transparent url('../images/next.jpg') no-repeat;
+}
+
+#vid-skim div.vid-nav a.previous:hover{
+  background: transparent url('../images/prev-hover.jpg') no-repeat;
+}
+#vid-skim div.vid-nav a.next:hover{
+  background: transparent url('../images/next-hover.jpg') no-repeat;
+}
+
+#vid-skim div.trans{
+  float: right;
+  width: 375px;
+  height: 300px;
+  margin: 0 5px 5px 5px;
+  padding: 5px;
+  overflow: auto;
+}
+
+
+#vid-skim div.player_container {
+  float:left;
+  padding-top:5px; 
+}
+#vid-skim div.rail {
+  float: left;
+  width: 143px;
+}
+#vid-skim div.rail a, #vid-skim div.rail strong, #vid-skim div.vid-tabs a {
+  font-size:11px;
+  display: block;
+  font-weight: bold;
+  padding: .5em;
+  line-height: 1.1em;
+}
+#vid-skim div.rail div a:hover, #vid-skim div.rail div a.active, #vid-skim div.vid-tabs div a:hover, #vid-skim div.vid-tabs div a.active {
+  background-color: #e4e4e4;
+}
+
+#vid-skim div.vid-tabs div{
+  display: inline;
+  margin: none;
+}
+
+#vid-skim div.vid-tabs div a {
+  display: inline;
+  padding-bottom: none;
+  border: 2px solid #e4e4e4;
+  padding: 5px;
+}
+#vid-skim div.vid-tabs div{
+  margin-bottom: 3px;
+}
+#vid-skim div.vid-tabs .color{
+  font-size: 1px;
+  border: 6px solid #000;
+  margin-right: .3em;
+  padding: .1em;
+  position:relative;
+  bottom: 4px;
+}
+#vid-skim div.rail p {
+  margin-bottom: 0;
+  padding-top:0;
+  padding-bottom: 0;
+}
+
+#vid-skim .clearfix:after {
+    content: ".";
+    display: block;
+    height: 0;
+    clear: both;
+    visibility: hidden;
+}
+