rtsp 0.4.3 → 0.4.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28131f72eddd446ae03db4520033ac3d4e4b4fb0
+  data.tar.gz: b272f509cd3dbb6380ade57c31821b56e892fb1b
+SHA512:
+  metadata.gz: 1b5fe820b9b15ceceed4663bc94248086591e017e1eadfb41fed47b2e5a12977975d7f0618ee07c8a71e5c7de9662aba9d52c92c4548805c391153f7aa792661
+  data.tar.gz: 27337607eb94371bb43b15bd5ad9521c4df9ecd58e70310f0cdcc93d6270f9b516b75da90f534f3dceb0388cef377d20b3a18f07aa7481a29dadc13fd6582d8f

data/ChangeLog.rdoc

@@ -1,3 +1,12 @@
+=== 0.4.4 / 2013-07-01
+
+* Improvements
+  * {gh-21}[htts://github.com/turboladen/rtsp/issues/21] Transport header
+    parser is now a little more flexible.  This functionality really needs a
+    rewrite, and should be done as part of
+    {gh-15}[htts://github.com/turboladen/rtsp/issues/15]. Thanks
+    {nmccready}[http:github.com/nmccready]!
+
 === 0.4.3 / 2012-11-20
 
 * Bug fixes
@@ -12,25 +21,29 @@
 * Other
   * Turned logging off by default.  To enable, simply do <tt>RTSP::Client.log = true</tt>
   * Updated to work with RTP 0.1.0.
-  * Can now inspect RTP packets during #play.
+  * Can now inspect RTP packets during {RTSP::Client#play}.
 
 === 0.4.1 / 2012-11-14
 
 * Bug fixes
-  * gh-16: Can now parse Session IDs to be alpha characters.  Thanks @greywolf-colorado!
+  * gh-16[https://github.com/turboladen/rtsp/issues/16]: Can now parse +Session+
+    IDs to be alpha characters.  Thanks
+    greywolf-colorado[http://github.com/greywolf-colorado]!
 
 * Improvements
-  * gh-17: Responses now handle HTTP responses.
+  * gh-17[https://github.com/turboladen/rtsp/issues/17]: Responses now handle
+    HTTP responses.
 
 === 0.4.0 / 2012-03-08
 
 * Improvements
-  * gh-11: Transport header parser bolstering:
+  * gh-11[https://github.com/turboladen/rtsp/issues/17]: Transport header
+    parser bolstering:
     * values that should be caps, will parse OK as lowercase now.
-      * :broadcast_type now parses 'multicast'.
-      * :destination now returns the value of the destination instead of
+      * +:broadcast_type+ now parses 'multicast'.
+      * +:destination+ now returns the value of the destination instead of
         "destination=x.x.x.x"
-      * :source now returns the value of the source instead of "source=x.x.x.x"
+      * +:source+ now returns the value of the source instead of "source=x.x.x.x"
       * Added parsing for fields:
         * ttl
         * port
@@ -38,9 +51,10 @@
         * channel
         * address
         * mode
-  * gh-10: Session header now detects timeout value.  This means that where use
+  * gh-10[https://github.com/turboladen/rtsp/issues/10]: +Session+ header now
+    detects timeout value.  This means that where use
     of the value extracted from this header used to be a simple Integer, now you
-    have a session Hash with :session_id and :timeout keys.
+    have a session Hash with +:session_id+ and +:timeout+ keys.
 
 === 0.3.0 / 2012-03-02
 
@@ -55,7 +69,8 @@
 === 0.2.2 / 2011-11-02
 
 * Bug fixes
-  * gh-6: .gemspec was missing +parslet+ dependency. Thanks [tindron[http://github.com/tindron]].
+  * gh-6[https://github.com/turboladen/rtsp/issues/6]: .gemspec was missing
+    +parslet+ dependency. Thanks tindron[http://github.com/tindron].
 
 * Improvements
   * Added a queue for listening and building the RTP file from the received data.
@@ -68,14 +83,16 @@
 === 0.2.0 / 2011-09-19
 
 * Bug fixes
-  * gh-5: Fixed 'Bad file descriptor' bug when capturing to file.
+  * gh-5[https://github.com/turboladen/rtsp/issues/5]: Fixed 'Bad file
+    descriptor' bug when capturing to file.
 
 * Improvements
-  * If RTSP::Capturer can't open port 9000, it increments by 1 and tries again,
+  * If {RTSP::Capturer} can't open port 9000, it increments by 1 and tries again,
     50 times, then raises.
-  * gh-4: Remove dependency on ore en lieu of standard gem commands.
+  * gh-4[https://github.com/turboladen/rtsp/issues/4]: Remove dependency on ore
+    en lieu of standard gem commands.
   * Participate in http://test.rubygems.org!
-  * Changed RTSP::Capturer init_*_server methods to take params in order to reduce
+  * Changed {RTSP::Capturer} init_*_server methods to take params in order to reduce
     dependency on state of the Capturer object.
 
 === 0.1.2 / 2011-04-14
@@ -86,16 +103,18 @@
 === 0.1.1 / 2011-04-14
 
 * Bug fixes
-  * gh-1: No longer use Socket::SO_REUSEADDR or Socket::SO_REUSEPORT.
-  * gh-2: rtsp_client now requires the installed rtsp/client.
+  * gh-1[https://github.com/turboladen/rtsp/issues/1]: No longer use
+    +Socket::SO_REUSEADDR+ or +Socket::SO_REUSEPORT+.
+  * gh-2[https://github.com/turboladen/rtsp/issues/2]: rtsp_client now requires
+    the installed rtsp/client.
 
 * Improvements
-  * Capturer#run's log message now says what it's logging.
+  * {RTSP::Capturer#run}'s log message now says what it's logging.
   * bin/rtsp_client:
     * Fixed bad description for --stream.
     * Added --version.
   * Updated README.rdoc:
-    * ...to clarify that REDIRECT isn't yet supported.
+    * ...to clarify that +REDIRECT+ isn't yet supported.
     * ...with brief usage on bin/rtsp_client.
 
 === 0.1.0 / 2011-04-12

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 gem 'thor'

data/Rakefile

@@ -6,12 +6,13 @@ RSpec::Core::RakeTask.new
 
 namespace :spec do
   RSpec::Core::RakeTask.new(:warnings) do |t|
-    t.ruby_opts = "-w"
+    t.ruby_opts = '-w'
   end
 end
 task :default => :spec
 task :test => :spec       # for `gem test`
 
 YARD::Rake::YardocTask.new do |t|
+  t.files = %w(lib/**/*.rb - ChangeLog.rdoc)
   t.options = %w[--verbose]
 end

data/bin/client_tester

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require './lib/rtsp/client'
+require 'bundler/setup'
+
+RTSP::Client.log = true
+
+class ClientTester < Thor
+  include Thor::Actions
+
+  desc "soma", "Pulls a stream from SomaFM"
+  method_options capture_file: :boolean, duration: :numeric
+  def soma
+    url = "rtsp://64.202.98.91/sa.sdp"
+    pull_stream url, options
+  end
+
+  desc "sarix", "Pulls a stream from a Sarix camera"
+  method_options capture_file: :boolean, duration: :numeric
+  def sarix
+    url = "rtsp://10.221.222.242/stream1"
+    pull_stream url, options
+  end
+
+  desc "nsm", "Pulls a stream from a NSM"
+  method_options capture_file: :boolean, duration: :numeric
+  def nsm
+    url = "rtsp://10.221.241.208/?deviceid=uuid:0f4b187e-d6dd-414d-9400-1b0d2ee225a1&starttime=2012-12-06T12:20:25&endtime=2012-12-07T01:39:09"
+    pull_stream url, options
+  end
+
+  no_tasks do
+    def pull_stream(url, options={})
+      capture_file = options[:capture_file] || false
+      duration = options[:duration] || 5
+      client = RTSP::Client.new(url)
+
+      client.options
+      client.describe
+
+      media_track = client.media_control_tracks.first
+      puts "media track: #{media_track}"
+
+      aggregate_track = client.aggregate_control_track
+      puts "aggregate track: #{aggregate_track}"
+
+      client.setup media_track
+
+      if capture_file
+        client.play(aggregate_track)
+      else
+        client.play(aggregate_track) do |packet|
+          this_packet = packet.sequence_number
+          puts "RTP sequence: #{this_packet}"
+          puts "payload type", packet.payload_type
+
+          if defined? last_packet
+            puts "last: #{last_packet}"
+            diff = this_packet - last_packet
+            if diff != 1
+              puts "ZOMG!!!!!!!! PACKET DIFF: #{diff}"
+            end
+          end
+
+          last_packet = packet.sequence_number
+        end
+      end
+
+      sleep duration
+      client.teardown aggregate_track
+      puts "Capture file path: #{client.capturer.capture_file.path}"
+      puts "Capture file size: #{client.capturer.capture_file.size}"
+    end
+  end
+end
+
+ClientTester.start

data/bin/rtsp_client

@@ -27,6 +27,19 @@ optparse = OptionParser.new do |opts|
     exit
   end
 
+  #----------------------------------------------------------------------------
+  # Get options
+  opts.on('--options [URL]', "Get options from the given URL.") do |url|
+    if url.nil?
+      puts "Must pass in a URL."
+      exit
+    end
+
+    rtsp_client = RTSP::Client.new(url)
+    puts rtsp_client.options.body.inspect
+    exit
+  end
+
   #----------------------------------------------------------------------------
   # Show available tracks
   opts.on('--show-tracks [URL]', "Show available tracks from the given URL.") do |url|

data/lib/rtsp.rb

@@ -3,4 +3,12 @@ require_relative 'rtsp/version'
 
 # This base module simply defines properties about the library.  See child
 # classes/modules for the meat.
-module RTSP; end
+module RTSP
+  def self.release_version?
+    !!RELEASE
+  end
+
+  def self.snapshot_version?
+    !!SNAPSHOT
+  end
+end

data/lib/rtsp/client.rb

@@ -2,6 +2,7 @@ require 'socket'
 require 'tempfile'
 require 'timeout'
 require 'rtp/receiver'
+require "base64"
 
 require_relative 'transport_parser'
 require_relative 'error'
@@ -60,7 +61,7 @@ module RTSP
 
     # @return [URI] The URI that points to the RTSP server's resource.
     attr_reader :server_uri
-
+    
     # @return [Fixnum] Also known as the "sequence" number, this starts at 1 and
     #   increments after every request to the server.  It is reset after
     #   calling #teardown.
@@ -121,6 +122,7 @@ module RTSP
       @connection.do_capture ||= true
       @connection.interleave ||= false
 
+      @max_authorization_tries = 3
       @cseq = 1
       reset_state
     end
@@ -134,6 +136,20 @@ module RTSP
       @server_uri = build_resource_uri_from new_url
     end
 
+    # The user to be used in Basic Authentication
+    #
+    # @param [String] user
+    def server_user=(user)
+      @server_uri.user = user
+    end
+
+    # The password to be used in Basic Authentication
+    #
+    # @param [String] password
+    def server_password=(password)
+      @server_uri.password = password
+    end
+    
     # Sends the message over the socket.
     #
     # @param [RTSP::Message] message
@@ -253,8 +269,10 @@ module RTSP
 
         @session   = response.session
         parser     = RTSP::TransportParser.new
+        #pass up raw transport for debug and/or logging
+        yield response.transport if block_given?
         @transport = parser.parse(response.transport)
-
+          
         unless @transport[:transport_protocol].nil?
           @capturer.transport_protocol = @transport[:transport_protocol]
         end
@@ -383,9 +401,10 @@ module RTSP
       response = send_message message
       #compare_sequence_number response.cseq
       @cseq += 1
-
       if response.code.to_s =~ /2../
         yield response if block_given?
+      elsif response.code == 401
+        send_authorization(message)
       elsif response.code.to_s =~ /(4|5)../
         if (defined? response.connection) && response.connection == 'Close'
           reset_state
@@ -441,7 +460,19 @@ module RTSP
     end
 
     private
-
+    
+    # Resends a message with an Authorization header when possible
+    # @param [RTSP:Message] message The message that must be repeated with Authorization
+    def send_authorization(message)
+      if @server_uri.user and @server_uri.password
+        credentials = Base64.strict_encode64("#{@server_uri.user}:#{@server_uri.password}")
+        headers = { :authorization => "Basic #{credentials}" }
+        new_message = RTSP::Message.send(message.method_type.to_sym,@server_uri.to_s).with_headers(headers)
+        new_message.add_headers message.headers
+        request(new_message)
+      end
+    end
+    
     # Sets state related variables back to their starting values;
     # +@session_state+ is set to +:init+; +@session+ is set to 0.
     def reset_state

data/lib/rtsp/message.rb

@@ -83,6 +83,7 @@ module RTSP
       @headers     = default_headers
       @body        = ""
       @version     = DEFAULT_VERSION
+      
     end
 
     # Adds the header and its value to the list of headers for the message.
@@ -172,6 +173,13 @@ module RTSP
     def default_headers
       headers = {}
 
+      if @request_uri.user and @request_uri.password
+        credentials = "#{@request_uri.user}:#{@request_uri.password}"
+        headers[:authorization] = "Basic #{Base64.strict_encode64(credentials)}"
+        @request_uri.user = nil
+        @request_uri.password = nil
+      end
+
       headers[:cseq] ||= RTSP_DEFAULT_SEQUENCE_NUMBER
       headers[:user_agent] ||= USER_AGENT
 

data/lib/rtsp/transport_parser.rb

@@ -79,10 +79,33 @@ module RTSP
       transport_specifier >>
         (semi_colon >> broadcast_type.as(:broadcast_type)).maybe >>
         (semi_colon >> destination).maybe >>
+        # server permutation
+      (semi_colon >> server_port.as(:server_port)).maybe >>
+        (semi_colon >> client_port.as(:client_port)).maybe >>
+        (semi_colon >> source).maybe >>
+        
+        (semi_colon >> server_port.as(:server_port)).maybe >>
         (semi_colon >> source).maybe >>
         (semi_colon >> client_port.as(:client_port)).maybe >>
+        # client permutation
+      (semi_colon >> client_port.as(:client_port)).maybe >>  
+        (semi_colon >> server_port.as(:server_port)).maybe >>
+        (semi_colon >> source).maybe >>
+        
+        (semi_colon >> client_port.as(:client_port)).maybe >>  
+        (semi_colon >> source).maybe >>
+        (semi_colon >> server_port.as(:server_port)).maybe >>
+        
+        # source permutation
+      (semi_colon >> source).maybe >>
+        (semi_colon >> client_port.as(:client_port)).maybe >>  
+        (semi_colon >> server_port.as(:server_port)).maybe >>
+
+        (semi_colon >> source).maybe >>
         (semi_colon >> server_port.as(:server_port)).maybe >>
-        (semi_colon >> interleaved.as(:interleaved)).maybe >>
+        (semi_colon >> client_port.as(:client_port)).maybe >>  
+        #end permutations for client_port,server_port, and source
+      (semi_colon >> interleaved.as(:interleaved)).maybe >>
         (semi_colon >> ttl).maybe >>
         (semi_colon >> port.as(:port)).maybe >>
         (semi_colon >> ssrc).maybe >>

data/lib/rtsp/version.rb

@@ -1,4 +1,13 @@
 module RTSP
-  # rtsp version
-  VERSION = "0.4.3"
+  SNAPSHOT = false
+  RELEASE = true
+  BASE_VERSION = '0.4.4'
+
+  VERSION = if RELEASE
+              BASE_VERSION
+            elsif SNAPSHOT
+              "#{BASE_VERSION}.SNAPSHOT"
+            else
+              "#{BASE_VERSION}.#{Time.now.strftime('%Y%m%d.%H%M%S')}"
+            end
 end

data/rtsp.gemspec

@@ -5,11 +5,11 @@ $:.unshift lib unless $:.include?(lib)
 require 'rtsp/version'
 
 Gem::Specification.new do |s|
-  s.name = "rtsp"
+  s.name = 'rtsp'
   s.version = RTSP::VERSION
 
   s.homepage = %q{https://github.com/turboladen/rtsp}
-  s.authors = ["Steve Loveless", "Mike Kirby", "Sujin Philip"]
+  s.authors = ['Steve Loveless', 'Mike Kirby', 'Sujin Philip']
   s.summary = %q{Library to allow RTSP streaming from RTSP-enabled devices.}
   s.description = %q{This library intends to follow the RTSP RFC document (2326)
 to allow for working with RTSP servers.  For more information see:
@@ -18,21 +18,21 @@ http://www.ietf.org/rfc/rfc2326.txt}
   s.licenses = %w{MIT}
 
   s.executables = %w{rtsp_client}
-  s.files = Dir.glob("{lib,bin,spec,tasks}/**/*") + Dir.glob("*.rdoc") +
+  s.files = Dir.glob('{lib,bin,spec,tasks}/**/*') + Dir.glob('*.rdoc') +
     %w(.gemtest rtsp.gemspec Gemfile Rakefile)
   s.extra_rdoc_files = %w{ChangeLog.rdoc LICENSE.rdoc README.rdoc}
   s.require_paths = %w{lib}
-  s.rubygems_version = "1.7.2"
-  s.test_files = Dir.glob("{spec,features}/**/*")
+  s.rubygems_version = '1.7.2'
+  s.test_files = Dir.glob('{spec,features}/**/*')
 
-  s.add_runtime_dependency "parslet", ">= 1.1.0"
-  s.add_runtime_dependency "rtp", ">= 0.1.2"
-  s.add_runtime_dependency "sdp", "~> 0.2.6"
+  s.add_runtime_dependency 'parslet', '>= 1.1.0'
+  s.add_runtime_dependency 'rtp', '>= 0.1.3'
+  s.add_runtime_dependency 'sdp', '~> 0.2.6'
 
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "cucumber", ">= 1.1.0"
-  s.add_development_dependency "rake", ">= 0.8.7"
-  s.add_development_dependency "rspec", ">= 2.5.0"
-  s.add_development_dependency "simplecov", ">= 0.4.0"
-  s.add_development_dependency "yard", ">= 0.6.0"
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'cucumber', '>= 1.1.0'
+  s.add_development_dependency 'rake', '>= 0.8.7'
+  s.add_development_dependency 'rspec', '>= 2.5.0'
+  s.add_development_dependency 'simplecov', '>= 0.4.0'
+  s.add_development_dependency 'yard', '>= 0.6.0'
 end