flvtool2 1.0.6

data/lib/flv/tag.rb

@@ -0,0 +1,120 @@
+# Copyright (c) 2005 Norman Timmler (inlet media e.K., Hamburg, Germany)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. 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.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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.
+
+require 'flv/core_extensions'
+require 'flv/stream'
+
+
+module FLV
+  
+  class FLVTag
+    
+    AUDIO = 8
+    VIDEO = 9
+    META = 18
+    UNDEFINED = 0
+    
+    attr_accessor :tag_type,
+                  :timestamp,
+                  :byte_offset
+    
+    def initialize(stream = nil)
+      @tag_type = UNDEFINED
+      @byte_offset = nil
+      
+      unless stream.nil?
+        data_size = stream.read__UI24
+        @timestamp = stream.read__UI24
+        stream.read__UI32
+        @data = stream.read(data_size)
+      else
+        @timestamp = 0
+        @data = ''
+      end
+      after_initialize(stream.nil?) if respond_to? :after_initialize
+    end
+    
+    def size
+      # header(11) + body(data_size)
+      11 + data_size
+    end
+
+    def name
+      'Unknown Tag'
+    end
+    
+    def data
+      @data
+    end
+    
+    def data_size
+      data.length
+    end
+    
+    def serialize(stream)
+      stream.write__UI8 tag_type
+      stream.write__UI24 data_size
+      stream.write__UI24 timestamp
+      stream.write__UI32 0
+      stream.write__STRING data
+    end
+
+    def info
+      "#{name}: timestamp #{timestamp}, size #{size}, data size #{data_size}"
+    end
+
+    def inspect
+      out = ["tag: #{self.class}"]
+      out << "timestamp: #{@timestamp}"
+      out << "size: #{size}"
+      out << "data_size: #{data_size}"
+      out
+    end
+
+    def self.type2name(type)
+      case type
+      when AUDIO
+        'audio'
+      when VIDEO
+        'video'
+      when META
+        'meta'
+      when UNDEFINED
+        'undefined'
+      else
+        "unknown(#{type})"
+      end
+    end
+    
+    private
+      def bit2uint(sequence)
+        int = 0
+        sequence.split(//).each_with_index do |character, i|
+          int += 2 ** (sequence.length - i - 1) if character == '1'
+        end
+        int
+      end
+  end
+end

data/lib/flv/video_tag.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2005 Norman Timmler (inlet media e.K., Hamburg, Germany)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. 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.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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.
+
+require 'flv/amf_string_buffer'
+
+module FLV
+  
+  class FLVVideoTag < FLVTag
+    
+    H263VIDEOPACKET = 2
+    SCREENVIDEOPACKET = 3
+    ON2VP6 = 4
+
+    KEYFRAME = 1
+    INTERFRAME = 2
+    DISPOSABLEINTERFRAME = 3
+
+    attr_reader :frame_type,
+                :codec_id,
+                :width,
+                :height
+    
+    def after_initialize(new_object)
+      @tag_type = VIDEO
+      read_header
+    end
+
+    def name
+      case frame_type
+      when KEYFRAME
+        'Video Tag (Keyframe)'
+      when INTERFRAME
+        'Video Tag (Interframe)'
+      when DISPOSABLEINTERFRAME
+        'Video Tag (disposable Interframe)'
+      else
+        'Video Tag'
+      end
+    end
+
+    def keyframe?
+      frame_type == KEYFRAME
+    end
+
+    def interframe?
+      frame_type == INTERFRAME || frame_type == DISPOSABLEINTERFRAME
+    end
+    
+    def read_header
+      data_stream = AMFStringBuffer.new(@data)
+
+      # the sequence is swaped in the swf-file-format description
+      # frame_type <-> codec_id (description: 1. codec_id, 2. frame_type)
+      codec_id_and_frame_type = data_stream.read__UI8
+      @frame_type = codec_id_and_frame_type >> 4
+      @codec_id = codec_id_and_frame_type & 0xf
+
+      bit_sequence = data_stream.read(9).unpack('B72').to_s
+      
+      if @codec_id == H263VIDEOPACKET
+        @width, @height = case bit2uint bit_sequence[30,3]
+        when 0
+          [bit2uint(bit_sequence[33,8]), bit2uint(bit_sequence[41,8])]
+        when 1
+          [bit2uint(bit_sequence[33,16]), bit2uint(bit_sequence[49,16])]
+        when 2
+          [352, 288]
+        when 3
+          [176, 144]
+        when 4
+          [128, 96]
+        when 5
+          [320, 240]
+        when 6
+          [160, 120]
+        end
+      elsif @codec_id == SCREENVIDEOPACKET
+        @width, @height = bit2uint(bit_sequence[4,12]), bit2uint(bit_sequence[16,12])
+      end
+    end
+
+    def inspect
+      out = super
+      out << "frame_type: #{%w{ Keyframe Interframe DisposableInterframe }[@frame_type]}"
+      out << "codec_id: #{@codec_id}"
+      out << "width: #{@width}"
+      out << "height: #{@height}"
+      out << "data_size: #{data_size}"
+      out
+    end
+  end
+end

data/lib/flvtool2.rb

@@ -0,0 +1,230 @@
+# Copyright (c) 2005 Norman Timmler (inlet media e.K., Hamburg, Germany)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. 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.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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.
+
+require 'flvtool2/version'
+require 'flvtool2/base'
+
+module FLVTool2
+  
+  SHELL_COMMAND_NAME = (RUBY_PLATFORM =~ /win32/) ? 'flvtool2.exe' : 'flvtool2'
+  SWITCHES = %w{ s v r p x c i o k t n l a }
+  COMMANDS = %w{ U C P D A V }
+  
+  def self.parse_arguments
+    options = {}
+    options[:commands] = []
+    options[:metadatacreator] = "inlet media FLVTool2 v#{PROGRAMM_VERSION.join('.')} - http://www.inlet-media.de/flvtool2"
+    options[:metadata] = {}
+    options[:in_path] = nil
+    options[:in_pipe] = false
+    options[:out_path] = nil
+    options[:out_pipe] = false
+    options[:simulate] = false
+    options[:verbose] = false
+    options[:recursive] = false
+    options[:preserve] = false
+    options[:xml] = false
+    options[:compatibility_mode] = false
+    options[:in_point] = nil
+    options[:out_point] = nil
+    options[:keyframe_mode] = false
+    options[:tag_file] = nil
+    options[:tag_number] = nil
+    options[:stream_log] = false
+    options[:collapse] = false
+
+    while (arg = ARGV.shift)
+      case arg
+      when /^-([a-zA-Z0-9]+?):(.+)$/
+        options[:metadata][$1] = $2
+      when /^-([a-zA-Z0-9]+?)#([0-9]+)$/
+        options[:metadata][$1] = $2.to_f
+      when /^-([a-zA-Z0-9]+?)@(\d{4,})-(\d{2,})-(\d{2,}) (\d{2,}):(\d{2,}):(\d{2,})$/
+        options[:metadata][$1] = Time.local($2, $3, $4, $5, $6, $7)
+      when /^-(.+)$/
+        $1.split(//).flatten.each do |switch|  
+          case switch
+          when 's'
+            options[:simulate] = true
+          when 'v'
+            options[:verbose] = true
+          when 'r'
+            options[:recursive] = true
+          when 'p'
+            options[:preserve] = true
+          when 'x'
+            options[:xml] = true
+          when 'c'
+            options[:compatibility_mode] = true
+          when 'i'
+            options[:in_point] = ARGV.shift.to_i
+          when 'o'
+            options[:out_point] = ARGV.shift.to_i
+          when 'k'
+            options[:keyframe_mode] = true
+          when 't'
+            options[:tag_file] = ARGV.shift
+          when 'n'
+            options[:tag_number] = ARGV.shift.to_i
+          when 'l'
+            options[:stream_log] = true
+          when 'a'
+            options[:collapse] = true
+          when 'U'
+            options[:commands] << :update
+          when 'P'
+            options[:commands] << :print
+          when 'C'
+            options[:commands] << :cut
+          when 'D'
+            options[:commands] << :debug
+          when 'A'
+            options[:commands] << :add
+          when 'H'
+            options[:commands] << :help
+          when 'V'
+            options[:commands] << :version
+          end
+        end
+      when /^([^-].*)$/
+        if options[:in_path].nil? 
+          options[:in_path] = $1
+          if options[:in_path].downcase =~ /stdin|pipe/
+            options[:in_pipe] = true
+            options[:in_path] = 'pipe'
+          else
+            options[:in_path] = File.expand_path( options[:in_path] )
+          end
+        else
+          options[:out_path] = $1
+          if options[:out_path].downcase =~ /stdout|pipe/
+            options[:out_pipe] = true
+            options[:out_path] = 'pipe'
+          else
+            options[:out_path] = File.expand_path( options[:out_path] )
+          end
+        end
+      end
+    end
+    
+    return options
+  end
+  
+  def self.validate_options( options )
+    if options[:commands].empty?
+      show_usage
+      exit 0
+    end
+    
+    options[:commands].each do |command|  
+      case command
+      when :print
+        if options[:out_pipe]
+          throw_error "Could not use print command in conjunction with output piping or redirection"
+          exit 1
+        end
+      when :debug
+        if options[:out_pipe]
+          throw_error "Could not use debug command in conjunction with output piping or redirection"
+          exit 1
+        end
+      when :help
+        show_usage
+        exit 0
+      when :version
+        show_version
+        exit 0
+      end
+    end
+    options
+  end
+  
+  def self.execute!(options)
+    if options[:commands].include? :help
+      show_usage
+    else
+      FLVTool2::Base::execute!( options )
+    end
+  end
+
+  def self.show_version
+    puts "FLVTool2 #{version}"
+  end
+  
+  def self.show_usage
+    self.show_version
+    puts "Copyright (c) 2005-2007 Norman Timmler (inlet media e.K., Hamburg, Germany)\n"
+    puts "Get the latest version from http://www.inlet-media.de/flvtool2\n"
+    puts "This program is published under the BSD license.\n"
+    puts "\n"
+    puts "Usage: #{SHELL_COMMAND_NAME} [-#{COMMANDS.sort.join}#{SWITCHES.sort.join}]... [-key:value]... in-path|stdin [out-path|stdout]\n"
+    puts "\n"
+    puts "If out-path is omitted, in-path will be overwritten.\n"
+    puts "In-path can be a single file, or a directory. If in-path is a directory,\n"
+    puts "out-path has to be likewise, or can be omitted. Directory recursion\n"
+    puts "is controlled by the -r switch. You can use stdin and stdout keywords\n"
+    puts "as in- and out-path for piping or redirecting.\n"
+    puts "\n"
+    puts "Chain commands like that: -UP (updates FLV file than prints out meta data)\n"
+    puts "\n"
+    puts "Commands:\n"
+    puts "  -A            Adds tags from -t tags-file\n"
+    puts "  -C            Cuts file using -i inpoint and -o outpoint\n"
+    puts "  -D            Debugs file (writes a lot to stdout)\n"
+    puts "  -H            Helpscreen will be shown\n"
+    puts "  -P            Prints out meta data to stdout\n"
+    puts "  -U            Updates FLV with an onMetaTag event\n"
+    puts "\n"
+    puts "Switches:\n"
+    puts "  -a            Collapse space between cutted regions\n"
+    puts "  -c            Compatibility mode calculates some onMetaTag values different\n"
+    puts "  -key:value    Key-value-pair for onMetaData tag (overwrites generated values)\n"
+    puts "  -i timestamp  Inpoint for cut command in miliseconds\n"
+    puts "  -k            Keyframe mode slides onCuePoint(navigation) tags added by the\n"
+    puts "                add command to nearest keyframe position\n"
+    puts "  -l            Logs FLV stream reading to stream.log in current directory\n"
+    puts "  -n            Number of tag to debug\n"
+    puts "  -o timestamp  Outpoint for cut command in miliseconds\n"
+    puts "  -p            Preserve mode only updates FLVs that have not been processed\n"
+    puts "                before\n"
+    puts "  -r            Recursion for directory processing\n"
+    puts "  -s            Simulation mode never writes FLV data to out-path\n"
+    puts "  -t path       Tagfile (MetaTags written in XML)\n"
+    puts "  -v            Verbose mode\n"
+    puts "  -x            XML mode instead of YAML mode\n"
+    puts "\n"
+    puts "REPORT BUGS at http://projects.inlet-media.de/flvtool2"
+    puts "Powered by Riva VX, http://rivavx.com\n"
+  end
+  
+  def self.throw_error(error)
+    puts "ERROR: #{error}"
+  end
+end
+
+
+FLVTool2::execute!( FLVTool2::validate_options( FLVTool2::parse_arguments ) )
+exit 0
+