marcandre-flvedit 0.6.1

data/lib/flv/util/double_check.rb

@@ -0,0 +1,22 @@
+module FLV
+  class IOError < ::IOError  # :nodoc:
+  end
+  
+  module Util # :nodoc:
+    def self.double_check(event, expected, actual)
+      Checking.fail_check(event, expected, actual) unless [*expected].include? actual
+    end
+  
+    class Checking # :nodoc:
+      class << self
+        attr_accessor :strict
+        def fail_check(event, expected, actual)
+          err = "Mismatch on #{event}: expected #{expected} vs #{actual}"
+          raise IOError, err if strict
+          #STDERR << "Caution: "+ err
+        end
+      end
+    end
+  
+  end
+end

data/lib/flv/video.rb

@@ -0,0 +1,73 @@
+module FLV
+  # The body of a video tag.
+  # The data is quite complex stuff. We make no attempt to understand it all
+  # or to be able to modify any of it. We simply consider it a complex string
+  # and read the interesting bits to give more info.
+  class Video < String
+    include Body
+    CODECS = Hash.new(:unknown).merge!(
+      1 => :JPEG,
+      2 => :h263,
+      3 => :screen,
+      4 => :on2_vp6,
+      5 => :on2_vp6_alpha,
+      6 => :screen_v2,
+      7 => :AVC
+    ).freeze
+    
+    FRAMES = Hash.new(:unknown).merge!(
+      1 => :keyframe  ,
+      2 => :interframe,
+      3 => :disposable_interframe
+    ).freeze
+    
+    def frame_type
+      FRAMES[read_bits(0...4)]
+    end
+
+    def codec_id
+      read_bits(4...8)
+    end
+    
+    def codec
+      CODECS[codec_id]
+    end
+
+    # Dimensions for h263 encoding; either as a bit range or the final value
+    H263_DIMENSIONS = {
+      0 => [41...49, 49...57],
+      1 => [41...57, 57...73],
+      2 => [352, 288],
+      3 => [176, 144],
+      4 => [128, 96] ,
+      5 => [320, 240],
+      6 => [160, 120]
+    }.freeze
+
+    # Returns dimensions as {:width => w, :height => h}, for Sorensen H.263 and screen video codecs only (otherwise returns nil)
+    def dimensions
+      w, h = case codec
+        when :h263
+          H263_DIMENSIONS[read_bits(38...41)]
+        when :screen
+          [12...24, 24...32]
+      end
+      return nil unless w
+      w, h = [w, h].map{ |r| read_bits(r) } if w.is_a?(Range)
+      {:width => w, :height => h}
+    end
+    
+    def is?(what)
+      frame_type.to_s.downcase == what.to_s.downcase || super
+    end
+    
+    def getters
+      super - [:frame_type, :frame_type.to_s]  # Let's exclude the frame_type from the normal attributes... (string vs symbol: ruby 1.8 vs 1.9)
+    end
+    
+    def title
+      super + " (#{frame_type})"  # ...and include it in the title instead.
+    end
+    
+  end
+end

data/test/fixtures/tags.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<tags>
+  <!-- an event cue point -->
+  <metatag event="onCuePoint">
+    <name>TestEvent1</name>
+    <timestamp>333</timestamp>
+    <parameters>
+      <speaker>Peter</speaker>
+      <says>Hello my Name is Peter.</says>
+    </parameters>
+    <type>event</type>
+  </metatag>
+
+  <!-- a navigation cue point -->
+  <metatag event="onCuePoint">
+    <name>TestEvent2</name>
+    <timestamp>1000</timestamp>
+    <parameters>
+      <index>1</index>
+      <title>Chapter 1</title>
+    </parameters>
+    <type>navigation</type>
+  </metatag>
+  
+  <!-- this cuepoint overwrites the previous cue point, because of it's 
+  identical timestamps and the overwrite parameter was set -->
+   
+  <metatag event="onCuePoint" overwrite="true">
+    <name>TestEvent3</name>
+    <timestamp>1000</timestamp>
+    <parameters>
+      <index>1</index>
+      <title>Chapter 2</title>
+    </parameters>
+    <type>navigation</type>
+  </metatag>
+</tags>
+
+

data/test/test_flv.rb

@@ -0,0 +1,145 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestFlv < Test::Unit::TestCase
+  context "Timestamp" do
+    context "conversion" do
+      { 0 => "0.000"             ,
+        1 => "0.001"             ,
+        1000 => "1.000"          ,
+        12_345 => "12.345"       ,
+        61_000 => "1:01.000"     ,
+        601_000 => "10:01.000"     ,
+        3600_000 => "1:00:00.000"
+      }.each do |n, s|
+        should "convert between #{s} and #{n} ms" do
+          assert_equal s, FLV::Timestamp.in_milliseconds(n).to_s
+          assert_equal n, FLV::Timestamp.try_convert(s).in_milliseconds
+        end
+      end
+
+      { "0" => 0 ,
+        "1" => 1000,
+        "1.0" => 1000,
+        "1m" => 60_000,
+        "1h" => 60 * 60_000,
+        "1::" => 60 * 60_000,
+        "1h23m45.6789" => 60 * 60_000 + 23*60_000 + 45678
+      }.each do |s, n|
+        should "convert #{s} to #{n} ms" do
+          assert_equal n, FLV::Timestamp.try_convert(s).in_milliseconds
+        end
+      end
+    end
+  end
+
+  context "TimestampRange" do
+    context "conversion" do
+      { "1:02-" => 62..(1/0.0),
+        "-1.23" => 0..1.23,
+        "12345-1:02:03.456" => 12345..3723.456,
+        "2m.345-1h" => 120.345..3600
+      }.each do |s, r|
+        should "convert #{s} to #{r} ms" do
+          assert_equal r, FLV::TimestampRange.try_convert(s).in_seconds
+        end
+      end
+    end
+  end
+
+
+  BIT_TEST = "\x01\x02\xff"
+  context "Bit reading from #{BIT_TEST.inspect}" do
+    setup do
+      @body = BIT_TEST.clone
+      class <<@body
+        include FLV::Body
+      end
+    end
+    
+    [ [0..0,  0],
+      [0...7, 0],
+      [0..7,  1],
+      [6..7,  1],
+      [7..7,  1],
+      [14, 1],
+      [3..9,  0b100],
+      [3...15,0b1_0000_001],
+      [3..15, 0b1_0000_0010],
+      [3..16, 0b1_0000_0010_1]
+    ].each do |bits, val|
+      should "return #{val} for bits #{bits}" do
+        assert_equal val, @body.read_bits(bits)
+      end
+    end
+  end
+  
+  context "Packing" do
+    context "a header" do
+      setup do
+        @header = FLV::Header.new
+        @header.extra = "hello"
+        @header.has_audio = true
+      end
+    
+      should "work" do
+        assert_equal "FLV\001\004\000\000\000\016hello\000\000\000\000",
+                      @header.pack
+      end
+    end
+    
+    context "an audio tag" do
+      setup do
+        @tag = FLV::Tag.new(FLV::Timestamp.in_milliseconds(0x1234), FLV::Audio.new("bogus audio data!"))
+      end
+      
+      should "work" do
+        assert_equal "\b\000\000\021\000\x12\x34\000\000\000\000bogus audio data!\000\000\000\034",
+                      @tag.pack
+      end
+    end
+  end
+
+  context "Unpacking" do
+    setup do
+      @io = StringIO.new("FLV\001\004\000\000\000\016hello\000\000\000\000!!")
+      @header = @io.packed.read(FLV::Header)
+    end
+    
+    should "read the header correctly" do
+      assert_equal "hello", @header.extra
+      assert_equal true,    @header.has_audio
+      assert_equal false,   @header.has_video
+    end
+    
+    should "read just what's required" do
+      assert_equal "!!",    @io.read
+    end
+  end
+  
+  context "Typematch" do
+    setup do
+      @chunks = FLV::File.open(SHORT_FLV).each.first(4)
+    end
+    
+    should "work" do
+      assert_equal false, @chunks[2].is?(:audio)
+    end
+    
+    {
+      :header       => [true , false, false, false],
+      :tag          => [false, true , true , true ],
+      :audio        => [false, false, false, false],
+      :audio_tag    => [false, false, true , false],
+      :nellymoser   => [false, false, false, false],
+      :mP3          => [false, false, true , false],
+      :event_tag    => [false, true , false, false],
+      :onMetaData   => [false, true , false, false],
+      :onCuePoint   => [false, false, false, false],
+    }.each do |check, answers|
+      should "work for #{check}" do
+        assert_equal answers, @chunks.map{|t| t.is?(check) }, check
+      end
+    end
+  end
+  
+end

data/test/test_flv_edit.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestFlvEdit < Test::Unit::TestCase
+  context "Options parsing" do
+    setup do
+      @options = FLV::Edit::Options.new([SHORT_FLV, "--Debug"])
+    end
+    
+    should "detect files" do
+      assert_equal [SHORT_FLV], @options.options[:files]
+    end
+    
+  end
+  
+  context "Command line tool" do
+    setup do
+      File.delete(TEMP_FLV) if File.exist?(TEMP_FLV)
+    end
+    
+    should "save" do
+      assert !File.exist?(TEMP_FLV)
+      runner = FLV::Edit::Runner.new([SHORT_FLV, "--Update", "--Save", TEMP_FLV])
+      runner.options[:dont_catch_errors] = true
+      runner.run
+      assert File.exist?(TEMP_FLV)
+    end
+    
+    teardown do
+      File.delete(TEMP_FLV) if File.exist?(TEMP_FLV)
+    end
+  end
+end

data/test/test_flv_edit_results.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestFlvEdit < Test::Unit::TestCase
+  context "Command line results" do
+    Dir.glob(File.dirname(__FILE__)+"/text_flv_edit_results/*.txt").each do |fn|
+      sep, args, sep, *expect = File.readlines(fn).map!(&:chomp)
+      args = args.split(' ')
+      args.unshift SHORT_FLV unless args.first.start_with?(".")
+      
+      context "for 'flvedit #{args.join(' ')}'" do
+        setup do
+          Time.stubs(:now).returns(Time.utc(2008,"dec",20))
+          @result = ""
+          runner = FLV::Edit::Runner.new(args)
+          runner.options[:dont_catch_errors] = true
+          runner.options[:out] = StringIO.new(@result)
+          runner.run
+        end
+        should "match #{fn}" do
+          @result = @result.split("\n")
+          same = @result & expect
+          assert_equal expect-same, @result-same
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit' 
+require 'rubygems'
+require 'backports'
+require_relative '../lib/flv/edit'
+require 'shoulda'
+require 'mocha'
+
+SHORT_FLV = File.dirname(__FILE__) + "/fixtures/short.flv"
+TEMP_FLV = File.dirname(__FILE__) + "/fixtures/short_temp.flv"

data/test/text_flv_edit_results/add_tags.txt

@@ -0,0 +1,132 @@
+*** command:
+--Add ./test/fixtures/tags.xml  --Debug
+*** result:
+Header| ./test/fixtures/short.flv
+      | extra          : 
+      | has_audio      : true
+      | has_video      : true
+      | version        : 1
+0.000 | FLV::Event tag
+      | event          : onMetaData
+      | audiocodecid   : 2
+      | audiodatarate  : 16
+      | audiodelay     : 0
+      | canSeekToEnd   : 1
+      | creationdate   : Fri Feb 03 122553 2006\n
+      | duration       : 16.9
+      | framerate      : 10
+      | height         : 154
+      | videocodecid   : 4
+      | videodatarate  : 40
+      | width          : 192
+0.000 | FLV::Audio tag
+      | channel        : mono
+      | codec_id       : 2
+      | format         : MP3
+      | rate           : 11000
+      | sample_size    : 16
+0.000 | FLV::Video tag (keyframe)
+      | codec          : on2_vp6
+      | codec_id       : 4
+      | dimensions     : nil
+0.052 | FLV::Audio tag
+0.100 | FLV::Video tag (interframe)
+0.104 | FLV::Audio tag
+0.156 | FLV::Audio tag
+0.200 | FLV::Video tag (keyframe)
+0.208 | FLV::Audio tag
+0.261 | FLV::Audio tag
+0.300 | FLV::Video tag (interframe)
+0.313 | FLV::Audio tag
+0.365 | FLV::Audio tag
+0.400 | FLV::Video tag (interframe)
+0.417 | FLV::Audio tag
+0.470 | FLV::Audio tag
+0.500 | FLV::Video tag (interframe)
+0.522 | FLV::Audio tag
+0.574 | FLV::Audio tag
+0.600 | FLV::Video tag (interframe)
+0.626 | FLV::Audio tag
+0.679 | FLV::Audio tag
+0.700 | FLV::Video tag (interframe)
+0.731 | FLV::Audio tag
+0.783 | FLV::Audio tag
+0.800 | FLV::Video tag (interframe)
+0.835 | FLV::Audio tag
+0.888 | FLV::Audio tag
+0.900 | FLV::Video tag (interframe)
+0.940 | FLV::Audio tag
+0.992 | FLV::Audio tag
+1.000 | FLV::Video tag (interframe)
+1.044 | FLV::Audio tag
+1.097 | FLV::Audio tag
+1.100 | FLV::Video tag (interframe)
+1.149 | FLV::Audio tag
+1.200 | FLV::Video tag (interframe)
+1.201 | FLV::Audio tag
+1.253 | FLV::Audio tag
+1.300 | FLV::Video tag (interframe)
+1.306 | FLV::Audio tag
+1.358 | FLV::Audio tag
+1.400 | FLV::Video tag (interframe)
+1.410 | FLV::Audio tag
+1.462 | FLV::Audio tag
+1.500 | FLV::Video tag (interframe)
+1.515 | FLV::Audio tag
+1.567 | FLV::Audio tag
+1.600 | FLV::Video tag (interframe)
+1.619 | FLV::Audio tag
+1.671 | FLV::Audio tag
+1.700 | FLV::Video tag (interframe)
+1.724 | FLV::Audio tag
+1.776 | FLV::Audio tag
+1.800 | FLV::Video tag (interframe)
+1.828 | FLV::Audio tag
+1.880 | FLV::Audio tag
+1.900 | FLV::Video tag (interframe)
+1.933 | FLV::Audio tag
+1.985 | FLV::Audio tag
+2.000 | FLV::Video tag (interframe)
+2.037 | FLV::Audio tag
+2.089 | FLV::Audio tag
+2.100 | FLV::Video tag (interframe)
+2.142 | FLV::Audio tag
+2.194 | FLV::Audio tag
+2.200 | FLV::Video tag (interframe)
+2.246 | FLV::Audio tag
+2.298 | FLV::Audio tag
+2.300 | FLV::Video tag (interframe)
+2.351 | FLV::Audio tag
+2.400 | FLV::Video tag (interframe)
+2.403 | FLV::Audio tag
+2.455 | FLV::Audio tag
+2.500 | FLV::Video tag (interframe)
+2.507 | FLV::Audio tag
+2.559 | FLV::Audio tag
+2.600 | FLV::Video tag (interframe)
+2.612 | FLV::Audio tag
+2.664 | FLV::Audio tag
+2.700 | FLV::Video tag (interframe)
+2.716 | FLV::Audio tag
+2.768 | FLV::Audio tag
+2.800 | FLV::Video tag (interframe)
+2.821 | FLV::Audio tag
+2.873 | FLV::Audio tag
+2.900 | FLV::Video tag (interframe)
+2.925 | FLV::Audio tag
+2.977 | FLV::Audio tag
+3.000 | FLV::Video tag (interframe)
+3.030 | FLV::Audio tag
+3.082 | FLV::Audio tag
+3.100 | FLV::Video tag (interframe)
+3.134 | FLV::Audio tag
+3.186 | FLV::Audio tag
+3.200 | FLV::Video tag (interframe)
+3.239 | FLV::Audio tag
+3.291 | FLV::Audio tag
+3.300 | FLV::Video tag (interframe)
+3.343 | FLV::Audio tag
+3.395 | FLV::Audio tag
+3.400 | FLV::Video tag (interframe)
+3.448 | FLV::Audio tag
+3.500 | FLV::Video tag (interframe)