rtsp 0.0.1.alpha → 0.1.0

data/bin/rtsp_client

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'tempfile'
+require 'optparse'
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+require 'rtsp/client'
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [options] url"
+
+  #----------------------------------------------------------------------------
+  # Turn on logging
+  RTSP::Client.configure { |c| c.log = false }
+  opts.on('-d', '--debug', "Turn on RTSP::Client logging.") do
+    RTSP::Client.configure { |c| c.log = true }
+  end
+
+  #----------------------------------------------------------------------------
+  # Get description
+  opts.on('--describe [URL]', "Get description from the given URL.") do |url|
+    if url.nil?
+      puts "Must pass in a URL."
+      exit
+    end
+
+    rtsp_client = RTSP::Client.new(url)
+    p rtsp_client.describe.body.inspect
+    exit
+  end
+
+  #----------------------------------------------------------------------------
+  # Show available tracks
+  opts.on('--show-tracks [URL]', "Show available tracks from the given URL.") do |url|
+    if url.nil?
+      puts "Must pass in a URL."
+      exit
+    end
+
+    rtsp_client = RTSP::Client.new(url)
+    rtsp_client.describe
+    puts "Aggregate control track: #{rtsp_client.aggregate_control_track}"
+    puts "Media control tracks: #{rtsp_client.media_control_tracks}"
+    exit
+  end
+
+  #----------------------------------------------------------------------------
+  # Stream
+  opts.on('--stream [URL]', "Show available tracks from the given URL.") do |url|
+    if url.nil?
+      puts "Must pass in a URL."
+      exit
+    end
+
+    rtsp_client = RTSP::Client.new(url) do |connection, capturer|
+      capturer.rtp_file = File.open("#{Dir.pwd}/rtsp_client_stream.rtp", "wb")
+    end
+
+    begin
+      puts "Getting server options..."
+      response = rtsp_client.options
+      puts "\tServer:             #{response.server}"
+      puts "\tSupported methods:  #{response.public}"
+      puts ""
+
+      puts "Getting description..."
+      response = rtsp_client.describe
+      puts "\tcache_control:  #{response.cache_control}" if response.respond_to? "cache_control"
+      puts "\tdate:           #{response.date}"
+      puts "\texpires:        #{response.expires}" if response.respond_to? "expires"
+      puts "\tcontent_type:   #{response.content_type}"
+      puts "\tcontent_base:   #{response.content_base}"
+      puts "\tAggregate control track: #{rtsp_client.aggregate_control_track}"
+      puts "\tMedia control tracks: #{rtsp_client.media_control_tracks}"
+      puts ""
+
+      puts "Setting up #{rtsp_client.media_control_tracks.first}"
+      response = rtsp_client.setup rtsp_client.media_control_tracks.first
+      puts "\ttransport:      #{response.transport}"
+      puts ""
+
+      if response.message == "OK"
+        puts "Playing #{rtsp_client.aggregate_control_track}"
+        r = rtsp_client.play rtsp_client.aggregate_control_track
+        puts "\trange:          #{r.range}"
+        puts "\trtp_info:       #{r.rtp_info}"
+        puts ""
+
+
+        1...5.times do
+          print "."
+          sleep 1
+        end
+        puts ""
+
+        if rtsp_client.capturer.rtp_file.size.zero?
+          puts "Captured 0 bytes.  Your firewall might be blocking the RTP traffic on port #{rtsp_client.capturer.rtp_port}."
+        else
+          puts "RTP data captured to file: #{rtsp_client.capturer.rtp_file}"
+        end
+
+        puts "Tearing down..."
+        r2 = rtsp_client.teardown(rtsp_client.aggregate_control_track)
+        puts "\tconnection:     #{r2.connection}" if r2.respond_to? "connection"
+      else
+        puts "Play call returned: #{response.message}.  Exiting."
+        exit
+      end
+    rescue RTSP::Error => ex
+      puts ex.backtrace
+      puts ex.message
+    end
+  end
+
+  #----------------------------------------------------------------------------
+  # Help
+  opts.on('-h', '--help', "You're looking at it.") do
+    puts opts
+    exit
+  end
+end
+
+if ARGV.size.zero?
+  puts optparse.help if ARGV.size.zero?
+  exit
+end
+optparse.parse!
+

data/features/client_changes_state.feature

@@ -0,0 +1,58 @@
+Feature: Client changes state
+  As an RTSP client user
+  I want to monitor the state of my client
+  So that I can be sure of what my client is doing at any time
+
+  Scenario Outline: State doesn't change after certain requests
+    Given I haven't made any RTSP requests
+    When I issue an "<request_type>" request with "<parameters>"
+    Then the state stays the same
+  Examples:
+    | request_type | parameters |
+    | options      |            |
+    | describe     |            |
+
+  Scenario Outline: State changes from Init
+    Given I haven't made any RTSP requests
+    When I issue an "<request_type>" request with "<parameters>"
+    Then the state changes to "<state_result>"
+  Examples:
+    | request_type | parameters | state_result |
+    | setup        | url        | ready        |
+    | teardown     | url        | init         |
+
+  Scenario Outline: State changes from Ready
+    Given I have set up a stream
+    When I issue an "<request_type>" request with "<parameters>"
+    Then the state changes to "<state_result>"
+  Examples:
+    | request_type | parameters | state_result |
+    | play         | url        | playing      |
+    | record       | url        | recording    |
+    | teardown     | url        | init         |
+    | setup        | url        | ready        |
+
+  Scenario Outline: State changes from Playing
+    Given I have set up a stream
+    And I have started playing a stream
+    When I issue an "<request_type>" request with "<parameters>"
+    Then the state changes to "<state_result>"
+  Examples:
+    | request_type | parameters | state_result |
+    | pause        | url        | ready        |
+    | teardown     | url        | init         |
+    | play         | url        | playing      |
+    | setup        | url        | playing      |
+
+  Scenario Outline: State changes from Recording
+    Given I have set up a stream
+    And I have started recording a stream
+    When I issue an "<request_type>" request with "<parameters>"
+    Then the state changes to "<state_result>"
+  Examples:
+    | request_type | parameters | state_result |
+    | pause        | url        | ready        |
+    | teardown     | url        | init         |
+    | record       | url        | recording    |
+    | setup        | url        | recording    |
+

data/features/client_requests.feature

@@ -0,0 +1,27 @@
+Feature: Client request messages
+  As an RTSP client API user
+  I want to make RTSP requests
+  So that I can build a client using these request messages
+
+  Scenario: OPTIONS
+    Given a known RTSP server
+    When I make a "options" request
+    Then I should receive an RTSP response to that OPTIONS request
+
+  Scenario: DESCRIBE
+    Given a known RTSP server
+    When I make a "describe" request
+    Then I should receive an RTSP response to that DESCRIBE request
+
+  Scenario: ANNOUNCE
+    Given a known RTSP server
+    When I make a "announce" request
+    Then I should receive an RTSP response to that ANNOUNCE request
+
+  Scenario: SETUP
+    Given a known RTSP server
+    When I make a "setup" request with headers:
+      | header | value |
+      | transport | RTP/AVP |
+    Then I should receive an RTSP response to that SETUP request
+

data/features/control_streams_as_client.feature

@@ -0,0 +1,26 @@
+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 ""
+    When I play a stream from that server
+    Then I should not receive any errors
+    And I should receive data on the same port
+
+  Scenario: Play then pause single stream
+    Given an RTSP server at "10.221.222.235" and port 9010 and URL ""
+    When I play a stream from that server for 10 seconds
+    And I pause that stream
+    Then I should not receive data on the same port
+
+  Scenario: Play two streams individually and simultaneously
+
+  Scenario: Play then pause two streams individually and simultaneously
+
+  Scenario: Play two streams using the aggregate control URL
+
+  Scenario: Play then pause two streams using the aggregate control URL
+

data/features/step_definitions/client_changes_state_steps.rb

@@ -0,0 +1,46 @@
+Given /^I haven't made any RTSP requests$/ do
+  RTSP::Client.configure { |config| config.log = false }
+end
+
+Given /^I have set up a stream$/ do
+  @url = "rtsp://fake-rtsp-server/some_path"
+  @client = RTSP::Client.new(@url) do |connection|
+    connection.socket = @fake_server
+    connection.timeout = 3
+  end
+  @client.setup @url
+  @client.session_state.should == :ready
+end
+
+Given /^I have started (playing|recording) a stream$/ do |method|
+  if method == "playing"
+    @client.setup @url
+    @client.play @url
+  elsif method == "recording"
+    @client.record @url
+  end
+  @client.session_state.should == method.to_sym
+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
+    end
+  end
+
+  @initial_state = @client.session_state
+  params = params.empty? ? {} : params
+
+  @client.send(request_type.to_sym, params)
+end
+
+Then /^the state stays the same$/ do
+  @client.session_state.should == @initial_state
+end
+
+Then /^the state changes to "([^"]*)"$/ do |new_state|
+  @client.session_state.should == new_state.to_sym
+end

data/features/step_definitions/client_requests_steps.rb

@@ -0,0 +1,74 @@
+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
+  end
+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)
+end
+
+When /^I make a "([^"]*)" request with headers:$/ do |method, headers_table|
+  # table is a Cucumber::Ast::Table
+  headers = {}
+
+  headers_table.hashes.each do |hash|
+    header_type = hash["header"].to_sym
+    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)
+end
+
+Then /^I should receive an RTSP response to that OPTIONS request$/ do
+  @response.is_a?(RTSP::Response).should be_true
+  @response.code.should == 200
+  @response.message.should == "OK"
+  @response.cseq.should == 1
+  @response.public.should == "DESCRIBE, SETUP, TEARDOWN, PLAY, PAUSE"
+  @response.body.should be_nil
+end
+
+Then /^I should receive an RTSP response to that DESCRIBE request$/ do
+  @response.is_a?(RTSP::Response).should be_true
+  @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.username.should == "-"
+end
+
+Then /^I should receive an RTSP response to that ANNOUNCE request$/ do
+  @response.is_a?(RTSP::Response).should be_true
+  @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
+end
+
+Then /^I should receive an RTSP response to that SETUP request$/ do
+  @response.is_a?(RTSP::Response).should be_true
+  @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 == ""
+end
+

data/features/step_definitions/control_streams_as_client_steps.rb

@@ -0,0 +1,34 @@
+Given /^an RTSP server at "([^"]*)" and port (\d+)$/ do |ip_address, port|
+  @rtp_port = port.to_i
+  @client = RTSP::Client.new(ip_address) do |connection, capturer|
+    capturer.rtp_port = @rtp_port
+  end
+end
+
+Given /^an RTSP server at "([^"]*)" and port (\d+) and URL "([^"]*)"$/ do |ip_address, port, path|
+  uri = "rtsp://#{ip_address}:#{port}#{path}"
+  @rtp_port = port
+  @client = RTSP::Client.new(uri) do |connection, capturer|
+    capturer.rtp_port = @rtp_port
+  end
+end
+
+When /^I play a stream from that server$/ do
+  @play_result = lambda { @client.play }
+end
+
+Then /^I should not receive any errors$/ do
+  @play_result.should_not raise_error
+end
+
+Then /^I should receive data on the same port$/ do
+  @client.capturer.rtp_file.should_not be_empty
+end
+
+Given /^I know what the describe response looks like$/ do
+  @response_text = @fake_server.describe
+end
+
+When /^I ask the server to describe$/ do
+  puts @client.describe
+end

data/features/support/env.rb

@@ -1,37 +1,39 @@
 require 'rubygems'
 require 'socket'
 require 'timeout'
+require 'cucumber/rspec/doubles'
 
 $:.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'rtsp/client'
 
+$:.unshift(File.dirname(__FILE__) + '/../../spec/support')
+require 'fake_rtsp_server'
 
-DESCRIBE_RESPONSE = <<-RESP
-RTSP/1.0 200 OK
-Server: DSS/5.5 (Build/489.7; Platform/Linux; Release/Darwin; )
-Cseq: 1
-Cache-Control: no-cache
-Content-length: 406
-Date: Sun, 23 Jan 2011 00:36:45 GMT
-Expires: Sun, 23 Jan 2011 00:36:45 GMT
-Content-Type: application/sdp
-x-Accept-Retransmit: our-retransmit
-x-Accept-Dynamic-Rate: 1
-Content-Base: rtsp://64.202.98.91:554/gs.sdp/
-
-v=0
-o=- 545877020 467920391 IN IP4 127.0.0.1
-s=Groove Salad from SomaFM [aacPlus]
-i=Downtempo Ambient Groove
-c=IN IP4 0.0.0.0
-t=0 0
-a=x-qt-text-cmt:Orban Opticodec-PC
-a=x-qt-text-nam:Groove Salad from SomaFM [aacPlus]
-a=x-qt-text-inf:Downtempo Ambient Groove
-a=control:*
-m=audio 0 RTP/AVP 96
-b=AS:48
-a=rtpmap:96 MP4A-LATM/44100/2
-a=fmtp:96 cpresent=0;config=400027200000
-a=control:trackID=1
-RESP
+DESCRIBE_RESPONSE = %Q{ RTSP/1.0 200 OK\r
+Server: DSS/5.5 (Build/489.7; Platform/Linux; Release/Darwin; )\r
+Cseq: 2\r
+Cache-Control: no-cache\r
+Content-length: 406\r
+Date: Sun, 23 Jan 2011 00:36:45 GMT\r
+Expires: Sun, 23 Jan 2011 00:36:45 GMT\r
+Content-Type: application/sdp\r
+x-Accept-Retransmit: our-retransmit\r
+x-Accept-Dynamic-Rate: 1\r
+Content-Base: rtsp://64.202.98.91:554/gs.sdp/\r
+\r\n\r
+v=0\r
+o=- 545877020 467920391 IN IP4 127.0.0.1\r
+s=Groove Salad from SomaFM [aacPlus]\r
+i=Downtempo Ambient Groove\r
+c=IN IP4 0.0.0.0\r
+t=0 0\r
+a=x-qt-text-cmt:Orban Opticodec-PC\r\n
+a=x-qt-text-nam:Groove Salad from SomaFM [aacPlus]\r
+a=x-qt-text-inf:Downtempo Ambient Groove\r
+a=control:*\r
+m=audio 0 RTP/AVP 96\r
+b=AS:48\r
+a=rtpmap:96 MP4A-LATM/44100/2\r
+a=fmtp:96 cpresent=0;config=400027200000\r
+a=control:trackID=1\r
+\r\n}