rtsp 0.3.0 → 0.4.0

data/ChangeLog.rdoc

@@ -1,3 +1,22 @@
+=== 0.4.0 / 2012-03-08
+
+* gh-11: 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
+	  "destination=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
+		* ssrc
+		* channel
+		* address
+		* mode
+* gh-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.
+
 === 0.3.0 / 2012-03-02
 
 * Extracted RTP-esque functionality to an +rtp+ gem, on which this gem is now

data/README.rdoc

@@ -10,7 +10,7 @@ call, but we'll get there.  ...eventually.
 
 For more information
 
-RTSP: http://www.ietf.org/rfc/rfc2326.txt
+RTSP: http://tools.ietf.org/html/rfc2326
 
 SDP: http://tools.ietf.org/html/rfc4566
 
@@ -61,10 +61,10 @@ gets implemented.
   client.cseq                     # => 3
   
   response = client.setup(client.media_control_tracks.first)
-  response.session          # => 7098486223178290313
-  client.session            # => 7098486223178290313
-  client.cseq               # => 4
-  client.session_state      # => :ready
+  response.session[:session_id]   # => 7098486223178290313
+  client.session[:session_id]     # => 7098486223178290313
+  client.cseq                     # => 4
+  client.session_state            # => :ready
 
 
   response = client.play(client.aggregate_control_track)
@@ -82,8 +82,8 @@ gets implemented.
   sleep 2
 
   client.teardown(client.aggregate_control_track)
-  client.session            # => 0
-  client.session_state      # => :init
+  client.session[:session_id]   # => 0
+  client.session_state          # => :init
 
   # Check the streamed file's contents
   puts client.capturer.rtp_file     # => (Lots of data)

data/features/control_streams_as_client.feature

@@ -2,7 +2,7 @@ Feature: Control stream from an RTSP server
   As an RTSP consumer
   I want to be able to control RTSP streams from a server
   So that I can view its contents as I desire
-  
+
   @wip
   Scenario: Play single stream
     Given an RTSP server at "10.221.222.235" and port 9010 and URL ""

data/features/step_definitions/client_changes_state_steps.rb

@@ -25,6 +25,7 @@ end
 When /^I issue an "([^"]*)" request with "([^"]*)"$/ do |request_type, params|
   unless @client
     url = "rtsp://fake-rtsp-server/some_path"
+
     @client = RTSP::Client.new(url) do |connection|
       connection.socket = @fake_server
       connection.timeout = 3
@@ -34,7 +35,12 @@ When /^I issue an "([^"]*)" request with "([^"]*)"$/ do |request_type, params|
   @initial_state = @client.session_state
   params = params.empty? ? {} : params
 
-  @client.send(request_type.to_sym, params)
+  if request_type == 'play'
+    @client.setup(url)
+    @client.play(params)
+  else
+    @client.send(request_type.to_sym, params)
+  end
 end
 
 Then /^the state stays the same$/ do

data/features/step_definitions/client_requests_steps.rb

@@ -1,5 +1,6 @@
 Given /^a known RTSP server$/ do
   @server_url = "rtsp://64.202.98.91:554/sa.sdp"
+
   @client = RTSP::Client.new(@server_url) do |connection|
     connection.socket = @fake_server
     connection.timeout = 3
@@ -7,13 +8,12 @@ Given /^a known RTSP server$/ do
 end
 
 When /^I make a "([^"]*)" request$/ do |method|
-=begin
-  @response = RTSP::Request.execute({
-      :method => method.to_sym,
-      :resource_url => @server_url }
-  )
-=end
-  @response = @client.send(method.to_sym)
+  @response = if method == 'announce'
+    @client.setup(@server_url)
+    @client.announce(@server_url, @client.describe)
+  else
+    @client.send(method.to_sym)
+  end
 end
 
 When /^I make a "([^"]*)" request with headers:$/ do |method, headers_table|
@@ -25,18 +25,15 @@ When /^I make a "([^"]*)" request with headers:$/ do |method, headers_table|
     headers[header_type] = hash["value"]
   end
 
-=begin
-  @response = RTSP::Request.execute({
-      :method => method.to_sym,
-      :headers => headers,
-      :resource_url => @server_url }
-  )
-=end
-  @response = @client.send(method.to_sym, headers)
+  @response = if method == 'setup'
+    @client.setup(@server_url, headers)
+  else
+    @client.send(method.to_sym, headers)
+  end
 end
 
 Then /^I should receive an RTSP response to that OPTIONS request$/ do
-  @response.is_a?(RTSP::Response).should be_true
+  @response.should be_a RTSP::Response
   @response.code.should == 200
   @response.message.should == "OK"
   @response.cseq.should == 1
@@ -45,30 +42,27 @@ Then /^I should receive an RTSP response to that OPTIONS request$/ do
 end
 
 Then /^I should receive an RTSP response to that DESCRIBE request$/ do
-  @response.is_a?(RTSP::Response).should be_true
+  @response.should be_a RTSP::Response
   @response.code.should == 200
   @response.message.should == "OK"
   @response.server.should == "DSS/5.5 (Build/489.7; Platform/Linux; Release/Darwin; )"
   @response.cseq.should == 1
-  @response.body.is_a?(SDP::Description).should be_true
-  @response.body.protocol_version.should == "0"
+  @response.body.should be_a SDP::Description
   @response.body.username.should == "-"
 end
 
 Then /^I should receive an RTSP response to that ANNOUNCE request$/ do
-  @response.is_a?(RTSP::Response).should be_true
+  @response.should be_a RTSP::Response
   @response.code.should == 200
   @response.message.should == "OK"
-  @response.server.should == "DSS/5.5 (Build/489.7; Platform/Linux; Release/Darwin; )"
-  @response.cseq.should == 1
+  @response.cseq.should == 2
 end
 
 Then /^I should receive an RTSP response to that SETUP request$/ do
-  @response.is_a?(RTSP::Response).should be_true
+  @response.should be_a RTSP::Response
   @response.code.should == 200
   @response.message.should == "OK"
-  @response.server.should == "DSS/5.5 (Build/489.7; Platform/Linux; Release/Darwin; )"
   @response.cseq.should == 1
-  @response.transport.should == ""
+  @response.transport.should match(/RTP\/AVP;unicast;destination=\S+;source=\S+;client_port=\d+-\d+;server_port=\d+-\d+/)
 end
 

data/features/support/env.rb

@@ -37,3 +37,14 @@ a=rtpmap:96 MP4A-LATM/44100/2\r
 a=fmtp:96 cpresent=0;config=400027200000\r
 a=control:trackID=1\r
 \r\n}
+
+
+# Define #describe so when RTSP::Message calls #method_missing, RSpec doesn't
+# get in the way (and cause tests to fail).
+module RTSP
+  class Message
+    def self.describe request_uri
+      self.new(:describe, request_uri)
+    end
+  end
+end

data/lib/rtsp/client.rb

@@ -283,7 +283,7 @@ module RTSP
     # @see http://tools.ietf.org/html/rfc2326#page-34 RFC 2326, Section 10.5.
     def play(track, additional_headers={})
       message = RTSP::Message.play(track).with_headers({
-          cseq: @cseq, session: @session })
+          cseq: @cseq, session: @session[:session_id] })
       message.add_headers additional_headers
 
       request(message) do
@@ -313,7 +313,7 @@ module RTSP
     # @see http://tools.ietf.org/html/rfc2326#page-36 RFC 2326, Section 10.6.
     def pause(track, additional_headers={})
       message = RTSP::Message.pause(track).with_headers({
-          cseq: @cseq, session: @session })
+          cseq: @cseq, session: @session[:session_id] })
       message.add_headers additional_headers
 
       request(message) do
@@ -332,7 +332,7 @@ module RTSP
     # @see http://tools.ietf.org/html/rfc2326#page-37 RFC 2326, Section 10.7.
     def teardown(track, additional_headers={})
       message = RTSP::Message.teardown(track).with_headers({
-          cseq: @cseq, session: @session })
+          cseq: @cseq, session: @session[:session_id] })
       message.add_headers additional_headers
 
       request(message) do
@@ -350,7 +350,7 @@ module RTSP
     # +@session_state+ is set to +:init+; +@session+ is set to 0.
     def reset_state
       @session_state = :init
-      @session       = 0
+      @session = {}
     end
 
     # Sends the GET_PARAMETERS request.
@@ -393,7 +393,7 @@ module RTSP
     # @see http://tools.ietf.org/html/rfc2326#page-39 RFC 2326, Section 10.11.
     def record(track, additional_headers={})
       message = RTSP::Message.record(track).with_headers({
-          cseq: @cseq, session: @session })
+          cseq: @cseq, session: @session[:session_id] })
       message.add_headers additional_headers
 
       request(message) { @session_state = :recording }
@@ -438,7 +438,7 @@ module RTSP
     #
     # @raise [RTSP::Error] Raises if @session isn't set.
     def ensure_session
-      unless @session > 0
+      if @session.empty? || @session[:session_id] <= 0
         raise RTSP::Error, "Session number not retrieved from server yet.  Run SETUP first."
       end
     end
@@ -500,8 +500,8 @@ module RTSP
     # @raise [RTSP::Error] If the server returns a Session value that's different
     #   from what the client sent.
     def compare_session_number server_session
-      if @session != server_session
-        message = "Session number mismatch.  Client: #{@session}, Server: #{server_session}"
+      if @session[:session_id] != server_session
+        message = "Session number mismatch.  Client: #{@session[:session_id]}, Server: #{server_session}"
         raise RTSP::Error, message
       end
     end

data/lib/rtsp/message.rb

@@ -26,17 +26,17 @@ module RTSP
         "RubyRTSP/#{RTSP::VERSION} (Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
 
     @message_types = [
-        :announce,
-            :describe,
-            :get_parameter,
-            :options,
-            :play,
-            :pause,
-            :record,
-            :redirect,
-            :set_parameter,
-            :setup,
-            :teardown
+      :announce,
+      :describe,
+      :get_parameter,
+      :options,
+      :play,
+      :pause,
+      :record,
+      :redirect,
+      :set_parameter,
+      :setup,
+      :teardown
     ]
 
     # TODO: define #describe somewhere so I can actually test that method.

data/lib/rtsp/response.rb

@@ -92,7 +92,17 @@ module RTSP
           next
         end
 
-        if line.include? ": "
+        if line.include? "Session: "
+          value = {}
+          line =~ /Session: (\d+)/
+          value[:session_id] = $1.to_i
+
+          if line =~ /timeout=(.+)/
+            value[:timeout] = $1.to_i
+          end
+
+          create_reader("session", value)
+        elsif line.include? ": "
           header_and_value = line.strip.split(":", 2)
           header_name = header_and_value.first.downcase.gsub(/-/, "_")
           create_reader(header_name, header_and_value[1].strip)
@@ -124,10 +134,12 @@ module RTSP
     # that's given.
     #
     # @param [String] name
-    # @param [String] value
+    # @param [String,Hash] value
     def create_reader(name, value)
       unless value.empty?
-        value = value =~ /^[0-9]*$/ ? value.to_i : value
+        if value.is_a? String
+          value = value =~ /^[0-9]*$/ ? value.to_i : value
+        end
       end
 
       instance_variable_set("@#{name}", value)

data/lib/rtsp/transport_parser.rb

@@ -7,20 +7,21 @@ module RTSP
   # other requests.
   class TransportParser < Parslet::Parser
     rule(:transport_specifier) do
-      match('[A-Z]').repeat(3).as(:streaming_protocol) >> forward_slash >>
-          match('[A-Z]').repeat(3).as(:profile) >>
-          (forward_slash >> match('[A-Z]').repeat(3).as(:transport_protocol)).maybe
+      match('[A-Za-z]').repeat(3).as(:streaming_protocol) >> forward_slash >>
+        match('[A-Za-z]').repeat(3).as(:profile) >>
+        (forward_slash >> match('[A-Za-z]').repeat(3).as(:transport_protocol)).maybe
     end
 
     rule(:broadcast_type) do
-      str('unicast')
+      str('unicast') | str('multicast')
     end
 
     rule(:destination) do
-      str('destination=') >> ip_address
+      str('destination=') >> ip_address.as(:destination)
     end
+
     rule(:source) do
-      str('source=') >> ip_address
+      str('source=') >> ip_address.as(:source)
     end
 
     rule(:client_port) do
@@ -33,14 +34,40 @@ module RTSP
 
     rule(:interleaved) do
       str('interleaved=') >> number.as(:rtp_channel) >> dash >>
-          number.as(:rtcp_channel)
+        number.as(:rtcp_channel)
+    end
+
+    rule(:ttl) do
+      str('ttl=') >> match('[\d]').repeat(1,3).as(:ttl)
+    end
+
+    rule(:port) do
+      str('port=') >> match('[\d]').repeat(1,5).as(:rtp) >>
+      dash.maybe >> match('[\d]').repeat(1,5).as(:rtcp).maybe
+    end
+
+    rule(:ssrc) do
+      str('ssrc=') >> match('[0-9A-Fa-f]').repeat(8).as(:ssrc)
+    end
+
+    rule(:channel) do
+      str('channel=') >> match('[\w]').repeat(1,3).as(:channel)
+    end
+
+    rule(:address) do
+      str('address=') >> match('[\S]').repeat.as(:address)
+    end
+
+    rule(:mode) do
+      str('mode=') >> str('"').maybe >> match('[A-Za-z]').repeat.as(:mode) >>
+      str('"').maybe
     end
 
     rule(:ip_address) do
       match('[\d]').repeat(1,3) >> str('.') >>
-          match('[\d]').repeat(1,3) >> str('.') >>
-          match('[\d]').repeat(1,3) >> str('.') >>
-          match('[\d]').repeat(1,3)
+        match('[\d]').repeat(1,3) >> str('.') >>
+        match('[\d]').repeat(1,3) >> str('.') >>
+        match('[\d]').repeat(1,3)
     end
 
     rule(:number)         { match('[\d]').repeat }
@@ -50,13 +77,18 @@ module RTSP
 
     rule(:header_field) do
       transport_specifier >>
-          (semi_colon >> broadcast_type.as(:broadcast_type)).maybe >>
-          (semi_colon >> destination.as(:destination)).maybe >>
-          (semi_colon >> source.as(:source)).maybe >>
-          (semi_colon >> client_port.as(:client_port)).maybe >>
-          (semi_colon >> server_port.as(:server_port)).maybe >>
-          (semi_colon >> interleaved.as(:interleaved)).maybe
-
+        (semi_colon >> broadcast_type.as(:broadcast_type)).maybe >>
+        (semi_colon >> destination).maybe >>
+        (semi_colon >> source).maybe >>
+        (semi_colon >> client_port.as(:client_port)).maybe >>
+        (semi_colon >> server_port.as(:server_port)).maybe >>
+        (semi_colon >> interleaved.as(:interleaved)).maybe >>
+        (semi_colon >> ttl).maybe >>
+        (semi_colon >> port.as(:port)).maybe >>
+        (semi_colon >> ssrc).maybe >>
+        (semi_colon >> channel).maybe >>
+        (semi_colon >> address).maybe >>
+        (semi_colon >> mode).maybe
     end
 
     root :header_field

data/lib/rtsp/version.rb

@@ -1,4 +1,4 @@
 module RTSP
   # rtsp version
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/rtsp.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.name = "rtsp"
   s.version = RTSP::VERSION
 
-  s.homepage = %q{http://rubygems.org/gems/rtsp}
+  s.homepage = %q{https://github.com/turboladen/rtsp}
   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)

data/spec/rtsp/client_spec.rb

@@ -181,9 +181,9 @@ describe RTSP::Client do
     end
 
     it "extracts the session number" do
-      @client.session.should be_zero
+      @client.session.should be_empty
       @client.setup("rtsp://localhost/some_track")
-      @client.session.should == 1234567890
+      @client.session[:session_id].should == 1234567890
     end
 
     it "changes the session_state to :ready" do
@@ -265,12 +265,12 @@ describe RTSP::Client do
       @client.session_state.should == :init
     end
 
-    it "changes the session back to 0" do
-      @client.session.should_not be_zero
+    it "changes the session_id back to 0" do
+      @client.session.should_not be_empty
       @client.teardown("rtsp://localhost/some_track")
-      @client.session.should be_zero
+      @client.session.should be_empty
     end
-    
+
     it "returns a Response" do
       response = @client.teardown("rtsp://localhost/some_track")
       response.is_a?(RTSP::Response).should be_true