rtcp 0.1.0

data/spec/unit/rtcp/app_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP::APP do
+  subject do
+    RTCP::APP.new
+  end
+
+  context '.decode' do
+    it 'decodes "Application-Defined" packet' do
+      packet = subject.decode(APP_PACKET)
+      packet.version.should == 2
+      packet.length.should == 48
+      packet.subtype.should == 1
+      packet.ssrc.should == 3945864703
+      packet.name.should == 'PLII'
+      packet.app_data.should be_kind_of(String)
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "Application-Defined"' do
+      expect { subject.decode(RR_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/bye_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'rtcp/bye'
+
+describe RTCP::BYE do
+  subject do
+    RTCP::BYE.new
+  end
+
+  context '.decode' do
+    it 'decodes "Goodbye" packet' do
+      packet = subject.decode(BYE_PACKET_1)
+      packet.version.should == 2
+      packet.length.should == 16
+      packet.reason.should == 'mmptest'
+      packet.ssrcs.should == [ 1418033557 ]
+      packet.padding.should == nil
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "Goodbye"' do
+      expect { subject.decode(RR_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/psfb_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'rtcp/psfb'
+
+describe RTCP::PSFB do
+  subject do
+    RTCP::PSFB.new
+  end
+
+  context '.decode' do
+    it 'decodes "Payload-specific FB message" packet' do
+      packet = subject.decode(PSFB_PACKET)
+      packet.version.should == 2
+      packet.length.should == 12
+      packet.sender_ssrc.should == 3945864703
+      packet.source_ssrc.should == 0
+      packet.format.should == :pli
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "PSFB"' do
+      expect { subject.decode(RR_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/rr_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP::RR do
+  subject do
+    RTCP::RR.new
+  end
+
+  context '.decode' do
+    it 'decodes "Receiver Record" packets' do
+      rr = subject.decode(RR_PACKET_1)
+
+      rr.version.should == 2
+      rr.length.should == 32
+      rr.ssrc.should == 1027816375
+      rr.padding.should == false
+      rr.report_blocks.should be_kind_of(Array)
+      rr.report_blocks.length.should == 1
+
+      report_block = rr.report_blocks.first
+      report_block.should be_kind_of(Hash)
+      report_block.keys.sort.should == [
+        :absolute_lost,
+        :delay_since_last_sr,
+        :fraction_lost,
+        :highest_sequence_number,
+        :jitter,
+        :last_sr,
+        :ssrc,
+      ]
+      report_block[:absolute_lost].should == 0
+      report_block[:delay_since_last_sr].should == 0
+      report_block[:fraction_lost].should == 0
+      report_block[:highest_sequence_number].should == 13317180
+      report_block[:jitter].should == 6
+      report_block[:last_sr].should == 277966035
+      report_block[:ssrc].should == 2189077565
+    end
+
+    it 'does not consider the follwing packet to be padding' do
+      expect { subject.decode(RR_PACKET_1) }
+        .not_to raise_error
+    end
+
+    it 'raises an RTCP::DecodeError when there is undeclared padding' do
+      corrupt_packet = RR_PACKET_1.clone + "xxxx"
+      corrupt_packet[2] = 0.chr
+      corrupt_packet[3] = 8.chr
+      expect { subject.decode(corrupt_packet) }
+        .to raise_error(RTCP::DecodeError, "Packet has undeclared padding")
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "Receiver Record"' do
+      expect { subject.decode(SDES_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/rsi_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP::RSI do
+  subject do
+    RTCP::RSI.new
+  end
+
+  context '.decode' do
+    it 'decodes "Receiver Summary Information" packet' do
+      packet = subject.decode(RSI_PACKET)
+      packet.version.should == 2
+      packet.length.should == 16
+      packet.ssrc.should == 3945864703
+      packet.summarized_ssrc.should == 0
+      packet.ntp_timestamp.should be_kind_of(Time)
+      packet.ntp_timestamp.to_f.should == 263659984.0
+      packet.report_blocks.should be_kind_of(Array)
+      packet.report_blocks.length.should == 0
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "Application-Defined"' do
+      expect { subject.decode(RR_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/sdes_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP::SDES do
+  subject do
+    RTCP::SDES.new
+  end
+
+  context '.decode' do
+    it 'decodes "Source Description" packet #1' do
+      packet = subject.decode(SDES_PACKET_1)
+      packet.version.should == 2
+      packet.length.should == 28
+      packet.chunks.should be_kind_of(Array)
+      packet.chunks.length.should == 1
+
+      sdes_chunk = packet.chunks.first
+      sdes_chunk.keys.sort.should == [ :data, :ssrc, :type ]
+      sdes_chunk[:ssrc].should == 1027816375
+      sdes_chunk[:type].should == :cname
+      sdes_chunk[:data].should == 'rtcp.example.com'
+    end
+
+    it 'decodes "Source Description" packet #2' do
+      packet = subject.decode(SDES_PACKET_2)
+      packet.version.should == 2
+      packet.length.should == 24
+      packet.chunks.should be_kind_of(Array)
+      packet.chunks.length.should == 1
+
+      sdes_chunk = packet.chunks.first
+      sdes_chunk.keys.sort.should == [ :data, :ssrc, :type ]
+      sdes_chunk[:ssrc].should == 4090175489
+      sdes_chunk[:type].should == :cname
+      sdes_chunk[:data].should == 'outChannel'
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "Source Description"' do
+      expect { subject.decode(RR_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/sr_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP::SR do
+  subject do
+    RTCP::SR.new
+  end
+
+  context '.decode' do
+    it 'decodes "Sender Record" packets' do
+      sr = subject.decode(SR_PACKET_1)
+
+      sr.version.should == 2
+      sr.length.should == 28
+      sr.ssrc.should == 4090175489
+      sr.padding.should == false
+      sr.report_blocks.should be_kind_of(Array)
+      sr.report_blocks.length.should == 0
+      sr.rtp_timestamp.should == 37920
+      sr.ntp_timestamp.should be_kind_of(Time)
+      sr.ntp_timestamp.to_f.round(5).should == 34081.918
+      sr.packet_count.should == 158
+      sr.octet_count.should == 39816
+    end
+
+    it 'decodes "Sender Record" packets wit report blocks' do
+      sr = subject.decode(SR_PACKET_2)
+
+      sr.ssrc.should == 3655205709
+      sr.report_blocks.should be_kind_of(Array)
+      sr.report_blocks.length.should == 1
+      sr.report_blocks.first.should == {
+        ssrc:                    3974927014,
+        fraction_lost:           0,
+        absolute_lost:           0,
+        highest_sequence_number: 58775,
+        jitter:                  2,
+        last_sr:                 0,
+        delay_since_last_sr:     0,
+      }
+    end
+
+    it 'does not consider the follwing packet to be padding' do
+      expect { subject.decode(SR_PACKET_1) }
+        .not_to raise_error
+    end
+
+    it 'raises an RTCP::DecodeError when there is undeclared padding' do
+      corrupt_packet = SR_PACKET_1.clone + "xxxx"
+      corrupt_packet[2] = 0.chr
+      corrupt_packet[3] = 7.chr
+      expect { subject.decode(corrupt_packet) }
+        .to raise_error(RTCP::DecodeError, "Packet has undeclared padding")
+    end
+
+    it 'raises an RTCP::DecodeError when paket type is not "Sender Record"' do
+      expect { subject.decode(RR_PACKET_1) }
+        .to raise_error(RTCP::DecodeError, /Wrong Packet Type/)
+    end
+
+  end
+end

data/spec/unit/rtcp/xr_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP::XR do
+  subject do
+    RTCP::XR.new
+  end
+
+  context '.decode' do
+    it 'decodes "Extended Record" packets' do
+      xr = subject.decode(XR_PACKET_1)
+
+      xr.version.should == 2
+      xr.length.should == 64
+      xr.ssrc.should == 1027816375
+      xr.report_blocks.should be_kind_of(Array)
+      xr.report_blocks.length.should == 3
+
+      xr.report_blocks[0].should == {
+        ssrc:         2189077565,
+        type:         :statistics_summary,
+        begin_seq:    7791,
+        end_seq:      13373,
+        lost_packets: 0,
+        dup_packets:  0,
+        min_jitter:   0,
+        max_jitter:   21,
+        mean_jitter:  6,
+        dev_jitter:   5,
+      }
+
+      xr.report_blocks[1].should == {
+        ssrc:         2189077565,
+        type:         :statistics_summary,
+        begin_seq:    7791,
+        end_seq:      13373,
+        lost_packets: 0,
+        dup_packets:  0,
+        min_jitter:   0,
+        max_jitter:   21,
+        mean_jitter:  6,
+        dev_jitter:   5,
+      }
+
+      xr.report_blocks[2].should == {
+        type:      :loss_rle,
+        thinning:  0,
+        begin_seq: 7791,
+        end_seq:   13373,
+        chunks:    [
+          {
+            chunk_type: :run_length,
+            run_type:   1,
+            run_length: 5580
+          }, {
+            chunk_type: :run_length,
+            run_type:   1,
+            run_length: 8192
+          }
+        ]
+      }
+    end
+
+    it 'decodes "Extended Record" packets with IPv4 TTL values' do
+      xr = subject.decode(XR_PACKET_2)
+
+      xr.version.should == 2
+      xr.length.should == 124
+      xr.ssrc.should == 3974927014
+      xr.report_blocks.should be_kind_of(Array)
+      xr.report_blocks.length.should == 4
+
+      # The first report block is of type :statistics_summary and contains
+      # the IPv4 TTL values
+      xr.report_blocks[0].should == {
+        ssrc:         3974927014,
+        type:         :statistics_summary,
+        begin_seq:    6985,
+        end_seq:      7325,
+        lost_packets: 0,
+        dup_packets:  0,
+        max_jitter:   80,
+        mean_jitter:  4,
+        min_jitter:   0,
+        dev_jitter:   223,
+        min_ttl:      1,
+        max_ttl:      2,
+        mean_ttl:     3,
+        dev_ttl:      4,
+
+      }
+    end
+
+  end
+end

data/spec/unit/rtcp_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'rtcp'
+
+describe RTCP do
+  context "Detect malformed data" do
+    it "raises exception when packet is shorter than a property header" do
+      expect { RTCP.decode("Hello") }
+        .to raise_error RTCP::DecodeError
+    end
+  end
+
+  context ".decode_all" do
+
+    it "returns an empty array when there is nothing to decode" do
+      rtcps = RTCP.decode_all("")
+
+      rtcps.should == []
+    end
+
+    it "returns an array of RTCP:: objects" do
+      rtcps = RTCP.decode_all(RR_PACKET_1 +
+                              SDES_PACKET_1 +
+                              AVB_PACKET +
+                              XR_PACKET_1
+                              )
+
+      rtcps.should be_kind_of(Array)
+      rtcps.length.should == 4 # TEST_DATA contains 4 RTCP packets
+      rtcps[0].class.should == RTCP::RR
+      rtcps[1].class.should == RTCP::SDES
+      rtcps[2].class.should == RTCP
+      rtcps[3].class.should == RTCP::XR
+    end
+  end
+
+  context ".decode" do
+    it "decodes the first packet and returns it as an RTCP:: object" do
+      rtcp = RTCP.decode(RR_PACKET_1 + SDES_PACKET_1)
+
+      rtcp.should be_kind_of(RTCP::RR)
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: rtcp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Rusch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  name: simplecov
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Parse RTCP data into Ruby objects
+email: git@rusch.asia
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/rtcp.rb
+- lib/rtcp/app.rb
+- lib/rtcp/bye.rb
+- lib/rtcp/decode_error.rb
+- lib/rtcp/psfb.rb
+- lib/rtcp/rr.rb
+- lib/rtcp/rsi.rb
+- lib/rtcp/sdes.rb
+- lib/rtcp/sr.rb
+- lib/rtcp/version.rb
+- lib/rtcp/xr.rb
+- rtcp.gemspec
+- spec/spec_helper.rb
+- spec/support/test_descriptions.rb
+- spec/unit/rtcp/app_spec.rb
+- spec/unit/rtcp/bye_spec.rb
+- spec/unit/rtcp/psfb_spec.rb
+- spec/unit/rtcp/rr_spec.rb
+- spec/unit/rtcp/rsi_spec.rb
+- spec/unit/rtcp/sdes_spec.rb
+- spec/unit/rtcp/sr_spec.rb
+- spec/unit/rtcp/xr_spec.rb
+- spec/unit/rtcp_spec.rb
+homepage: http://github.com/rusch/rtcp
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: Parse RTCP data into Ruby objects
+test_files:
+- spec/spec_helper.rb
+- spec/unit/rtcp_spec.rb
+- spec/unit/rtcp/sdes_spec.rb
+- spec/unit/rtcp/psfb_spec.rb
+- spec/unit/rtcp/bye_spec.rb
+- spec/unit/rtcp/rsi_spec.rb
+- spec/unit/rtcp/app_spec.rb
+- spec/unit/rtcp/sr_spec.rb
+- spec/unit/rtcp/rr_spec.rb
+- spec/unit/rtcp/xr_spec.rb
+- spec/support/test_descriptions.rb