rtcp 0.1.0

data/lib/rtcp/sdes.rb

@@ -0,0 +1,77 @@
+# SDES: Source Description RTCP Packet
+# Documentation: RFC 3550, 6.5
+#
+#         0                   1                   2                   3
+#         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# header |V=2|P|    SC   |  PT=SDES=202  |             length            |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# chunk  |                          SSRC/CSRC_1                          |
+#   1    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                           SDES items                          |
+#        |                              ...                              |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# chunk  |                          SSRC/CSRC_2                          |
+#   2    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                           SDES items                          |
+#        |                              ...                              |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+
+class RTCP::SDES < RTCP
+
+  PT_ID = 202
+
+  SDES_CHUNK_TYPES = {
+    1 => :cname,
+    2 => :name,
+    3 => :email,
+    4 => :phone,
+    5 => :loc,
+    6 => :tool,
+    7 => :note,
+    8 => :priv
+  }
+
+  attr_reader :version, :chunks
+
+  def decode(packet_data)
+    vprc, packet_type, length = packet_data.unpack('CCn')
+    ensure_packet_type(packet_type)
+
+    @length  = 4 * (length + 1)
+    @version = vprc >> 6
+    count    = vprc & 15
+    loop_length = @length
+    sdes_data = payload_data(packet_data, @length, 4)
+    loop_length -= 4
+    chunks = []
+    for i in 0..count-1
+      ssrc, payload = sdes_data.unpack('Na*')
+      loop_length -= 4
+      sdes_items = []
+      while loop_length > 0
+        type_id, payload = payload.unpack('Ca*')
+        loop_length -= 1
+        break if type_id == 0
+
+        len, payload = payload.unpack("Ca*")
+        val, payload = payload.unpack("a#{len}a*")
+        type = SDES_CHUNK_TYPES[type_id] || type_id
+        sdes_items.push({
+              type: type,
+              data: val,
+              length: len
+        })
+        loop_length -= (2 + len)
+      end
+      chunks.push(
+      {
+        ssrc: ssrc,
+        sdes_items: sdes_items
+      })
+    end
+    @chunks = chunks
+    self
+  end
+
+end

data/lib/rtcp/sr.rb

@@ -0,0 +1,86 @@
+# SR: Sender Report RTCP Packet
+# Documentation: RFC 3550, 6.4.1
+#
+#         0                   1                   2                   3
+#         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# header |V=2|P|    RC   |   PT=SR=200   |             length            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         SSRC of sender                        |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# sender |              NTP timestamp, most significant word             |
+# info   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |             NTP timestamp, least significant word             |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         RTP timestamp                         |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                     sender's packet count                     |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                      sender's octet count                     |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# report |                 SSRC_1 (SSRC of first source)                 |
+# block  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#   1    | fraction lost |       cumulative number of packets lost       |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |           extended highest sequence number received           |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                      interarrival jitter                      |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         last SR (LSR)                         |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                   delay since last SR (DLSR)                  |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# report |                 SSRC_2 (SSRC of second source)                |
+# block  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#   2    :                               ...                             :
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+#        |                  profile-specific extensions                  |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+class RTCP::SR < RTCP
+
+  PT_ID = 200
+
+  attr_reader :version, :ssrc, :rtp_timestamp, :ntp_timestamp,
+    :packet_count, :octet_count, :report_blocks, :padding
+
+  def decode(packet_data)
+    vprc, packet_type, length, @ssrc, ntp_h, ntp_l, @rtp_timestamp,
+      @packet_count, @octet_count = packet_data.unpack('CCnN6')
+    ensure_packet_type(packet_type)
+    @length  = 4 * (length + 1)
+    @version, @padding, rc = decode_vprc(vprc, @length - 28)
+    @ntp_timestamp = Time.at(ntp_h - 2208988800 + (ntp_l.to_f / 0x100000000))
+    @report_blocks = decode_reports(payload_data(packet_data, @length, 28), rc)
+    self
+  end
+
+  protected
+
+  def decode_reports(data, count)
+    (1..count).collect do
+      *values, data = data.unpack('NCa3N4a*')
+      values[2] = (0.chr + values[2]).unpack('l>')[0]
+
+      Hash[[
+        :ssrc,
+        :fraction_lost,
+        :absolute_lost,
+        :highest_sequence_number,
+        :jitter,
+        :last_sr,
+        :delay_since_last_sr,
+      ].zip(values)]
+    end
+  end
+
+  def decode_vprc(vprc, payload_length)
+    rc = vprc & 0x1f
+    padding = vprc & 0x20 == 0x20
+    if !padding && (payload_length > rc * 24)
+      raise(RTCP::DecodeError, "Packet has undeclared padding")
+    end
+    [ (vprc >> 6), padding, rc ]
+  end
+
+end

data/lib/rtcp/version.rb

@@ -0,0 +1,4 @@
+class RTCP
+  VERSION = "0.1.0"
+end
+

data/lib/rtcp/xr.rb

@@ -0,0 +1,170 @@
+# XR: Extended Report RTCP Packet
+# Documentation: RFC 3611, 2.
+#
+#         0                   1                   2                   3
+#         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |V=2|P|reserved |   PT=XR=207   |             length            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                              SSRC                             |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        :                         report blocks                         :
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#
+# An extended report block has the following format:
+#
+#         0                   1                   2                   3
+#         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |      BT       | type-specific |         block length          |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        :             type-specific block contents                      :
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#
+# The Statistics Summary Report Block has the following format:
+#
+#         0                   1                   2                   3
+#         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |     BT=6      |L|D|J|ToH|rsvd.|       block length = 9        |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                        SSRC of source                         |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |          begin_seq            |             end_seq           |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                        lost_packets                           |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                        dup_packets                            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         min_jitter                            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         max_jitter                            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         mean_jitter                           |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         dev_jitter                            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        | min_ttl_or_hl | max_ttl_or_hl |mean_ttl_or_hl | dev_ttl_or_hl |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+class RTCP::XR < RTCP
+
+  PT_ID = 207
+
+  attr_reader :version, :ssrc, :report_blocks, :padding
+
+  def decode(packet_data)
+    vprc, packet_type, length, @ssrc = packet_data.unpack('CCnN')
+    ensure_packet_type(packet_type)
+
+    @version = vprc >> 6
+    @length  = 4 * (length + 1)
+    @report_blocks = []
+
+    report_block_data = payload_data(packet_data, @length, 8)
+
+    while report_block_data && report_block_data.length >= 4
+      bt, length = report_block_data.unpack('Cxn')
+      length = 4 * (length + 1)
+      @report_blocks.push case bt
+      when 1 # Loss RLE Report Block
+        decode_loss_rle(report_block_data)
+      when 6 # Statistics Summary Report
+        decode_ssr(report_block_data)
+      else
+        {
+          type:   bt,
+          length: length,
+          data:   report_block_data.slice(4..(length-1))
+        }
+      end
+
+      report_block_data = report_block_data.slice(length..-1)
+    end
+
+    # Padding
+    if (vprc & 16 == 16)
+      @padding = report_block_data
+    elsif (report_block_data != '')
+      raise(RTCP::DecodeError, "Packet has undeclared padding")
+    end
+
+    self
+  end
+
+  private
+
+  def decode_loss_rle(report_block_data)
+    thinning, length, ssrc, begin_seq, end_seq, *values =
+      report_block_data.unpack("xCnNn*")
+
+    thinnig = thinning & 15
+    length  = 4 * (length + 1)
+
+    chunks = values.collect do |val|
+      if (val && 32768) == 32768
+        {
+          chunk_type: :run_length,
+          run_type:   (val >> 14) & 1,
+          run_length: val & 16383,
+        }
+      else
+        {
+          chunk_type: :bit_vector,
+          run_length: val & 32767,
+        }
+      end
+    end
+
+    return {
+      type:      :loss_rle,
+      thinning:  thinning,
+      begin_seq: begin_seq,
+      end_seq:   end_seq,
+      chunks:    chunks,
+    }
+  end
+
+  def decode_ssr(report_block_data)
+    x, ssrc, begin_seq, end_seq, lost_packets, dup_packets, *values =
+      report_block_data.unpack("xCx2NnnN6C4")
+
+    report_block = {
+      ssrc:      ssrc,
+      type:      :statistics_summary,
+      begin_seq: begin_seq,
+      end_seq:   end_seq,
+    }
+    @report_blocks.push(report_block)
+
+    if (x & 128 == 128)
+      report_block[:lost_packets] = lost_packets
+    end
+
+    if (x & 64 == 64)
+      report_block[:dup_packets] = dup_packets
+    end
+
+    if (x &  32 == 32)
+      report_block[:min_jitter] = values[0]
+      report_block[:max_jitter] = values[1]
+      report_block[:mean_jitter] = values[2]
+      report_block[:dev_jitter] = values[3]
+    end
+
+    case ((x >> 3) & 3)
+    when 1 # IPv4 TTL values
+      report_block[:min_ttl]  = values[4]
+      report_block[:max_ttl]  = values[5]
+      report_block[:mean_ttl] = values[6]
+      report_block[:dev_ttl]  = values[7]
+    when 2 # IPv6 Hop Limit values
+      report_block[:min_hl]  = values[4]
+      report_block[:max_hl]  = values[5]
+      report_block[:mean_hl] = values[6]
+      report_block[:dev_hl]  = values[7]
+    end
+    report_block
+  end
+
+end

data/rtcp.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'rtcp/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{rtcp}
+  s.version = RTCP::VERSION
+  s.author = "Christian Rusch"
+
+  s.description = %q{Parse RTCP data into Ruby objects}
+
+  s.email = %{git@rusch.asia}
+  s.extra_rdoc_files = Dir.glob("*.rdoc")
+  s.files = Dir.glob("{lib,spec}/**/*") + Dir.glob("*.rdoc") +
+    %w(Gemfile Rakefile rtcp.gemspec)
+  s.homepage = %{http://github.com/rusch/rtcp}
+  s.licenses = %w(MIT)
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %{Parse RTCP data into Ruby objects}
+  s.test_files = Dir.glob("spec/**/*")
+
+  s.add_development_dependency 'bundler', "> 1.0.0"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', ">= 2.6.0"
+  s.add_development_dependency 'simplecov', ">= 0.5.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+def to_binary(data)
+  [ data.gsub(/\s+/,'').split(':').join ].pack('H*')
+end
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
+include TestDescriptions

data/spec/support/test_descriptions.rb

@@ -0,0 +1,124 @@
+module TestDescriptions
+
+  ##### 200: SR - Sender Report (RFC 3550)
+
+  # Extracted from example capture file available at:
+  # http://wiki.wireshark.org/RTCP
+  # Real-time Transport Control Protocol (Sender Report)
+  #
+  # Sender SSRC: 0xf3cb2001 (4090175489)
+  # MSW and LSW as NTP timestamp: Jan  1, 1970 09:28:01.917999000 UTC
+  # RTP timestamp: 37920
+  # Sender's packet count: 158
+  # Sender's octet count: 39816
+  SR_PACKET_1 = to_binary %q{
+    80:c8:00:06:f3:cb:20:01:83:ab:03:a1:eb:02:0b:3a:
+    00:00:94:20:00:00:00:9e:00:00:9b:88
+  }
+
+  # Extracted from example capture file available at:
+  # https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=4589
+  # MSW and LSW as NTP timestamp: Mar 17, 2010 07:49:41.844999000 UTC
+  # RTP timestamp: 342440
+  # Sender's packet count: 150
+  # Sender's octet count: 25800
+  # Source 1:
+  #   Identifier: 0xecec92a6 (3974927014)
+  SR_PACKET_2 = to_binary %q{
+    81:c8:00:0c:d9:de:03:4d:cf:4b:08:15:d8:51:eb:85:
+    00:05:39:a8:00:00:00:96:00:00:64:c8:ec:ec:92:a6:
+    00:00:00:00:00:00:e5:97:00:00:00:02:00:00:00:00:
+    00:00:00:00
+  }
+
+  ##### 201: RR - Receiver Report (RFC 3550)
+
+  RR_PACKET_1 = to_binary %q{
+    81:C9:00:07:3D:43:3B:B7:82:7A:AC:3D:00:00:00:00:
+    00:CB:34:3C:00:00:00:06:10:91:6C:D3:00:00:00:00
+  }
+
+  ##### 202: SDES - Source Description (RFC 3550)
+
+  SDES_PACKET_1 = to_binary %q{
+    81:CA:00:06:3D:43:3B:B7:01:10:72:74:63:70:2E:65:
+    78:61:6D:70:6C:65:2E:63:6F:6D:00:00
+  }
+
+  # Extracted from example capture file available at:
+  # http://wiki.wireshark.org/RTCP
+  # Real-time Transport Control Protocol (Sender Report)
+  #
+  # Chunk 1:
+  #   Identifier: 0xf3cb2001 (4090175489)
+  #   Type: CNAME (user and domain) (1)
+  #   Text: outChannel
+  SDES_PACKET_2 = to_binary %q{
+    81:ca:00:05:f3:cb:20:01:01:0a:6f:75:74:43:68:61:
+    6e:6e:65:6c:00:00:00:00
+  }
+
+  ##### 203: BYE - Goodbye (RFC 3550)
+
+  # Extracted from example capture file available at:
+  # http://www.wireshark.org/lists/wireshark-dev/200808/msg00050.html
+  #
+  # Identifier: 0x54857995 (1418033557)
+  # Text: mmptest
+  BYE_PACKET_1 = to_binary %q{
+    81:cb:00:03:54:85:79:95:07:6d:6d:70:74:65:73:74
+  }
+
+  ##### 204: APP - Application Defined (RFC 3550)
+
+  # Capture from communication between Set-Top Box and VQE-S
+  APP_PACKET = to_binary %q{
+    81:CC:00:0B:EB:31:1D:FF:50:4C:49:49:06:00:04:00:
+    00:00:C8:07:00:04:00:00:0D:2E:0D:00:04:00:00:00:
+    01:0F:00:04:00:00:00:00:10:00:04:00:00:00:00:00
+  }
+
+  ##### 206: PSFB - Payload-specific feedback (RFC 5760)
+
+  # Capture from communication between Set-Top Box and VQE-S
+  PSFB_PACKET = to_binary %q{
+    81:CE:00:02:EB:31:1D:FF:00:00:00:00
+  }
+
+  ##### 207: XR - Extended Report (RFC 3611)
+
+  XR_PACKET_1 = to_binary %q{
+    81:CF:00:0F:3D:43:3B:B7:06:E0:00:09:82:7A:AC:3D:
+    1E:6F:34:3D:00:00:00:00:00:00:00:00:00:00:00:00:
+    00:00:00:15:00:00:00:06:00:00:00:05:00:00:00:00:
+    01:00:00:03:82:7A:AC:3D:1E:6F:34:3D:55:CC:E0:00
+  }
+
+  # Extracted from example capture file available at:
+  # https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=4589
+  XR_PACKET_2 = to_binary %q{
+    80:cf:00:1e:ec:ec:92:a6:06:e8:00:09:ec:ec:92:a6:
+    1b:49:1c:9d:00:00:00:00:00:00:00:00:00:00:00:00:
+    00:00:00:50:00:00:00:04:00:00:00:df:01:02:03:04:
+    07:00:00:08:ec:ec:92:a6:00:00:00:00:00:00:1a:90:
+    00:00:00:41:2e:33:11:10:7f:7f:7f:7f:0a:00:00:14:
+    00:c8:01:f4:08:00:00:09:ec:ec:92:a6:1b:49:1c:9d:
+    00:0b:00:0b:00:00:00:0b:00:01:00:0f:00:00:00:00:
+    00:00:00:14:00:00:00:14:00:00:00:00
+  }
+
+  ##### 208: AVB - Audio Video Bridging
+
+  AVB_PACKET = to_binary %q{
+    80:D0:00:06:3D:43:3B:B7:3D:43:3B:B7:D5:1C:10:91:
+    6C:D4:02:4B:0C:02:00:B2:00:00:00:02
+  }
+
+  ##### 209: RSI - Receiver Summary Information (RFC 5760)
+
+  # Capture from communication between Set-Top Box and VQE-S
+  RSI_PACKET = to_binary %q{
+    81:D1:00:03:EB:31:1D:FF:00:00:00:00:93:61:A0:50
+  }
+
+end