rtcp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79f2f783d38dba6bdba307f5755c6132787b34589abae10722db511c4cd1c0c5
+  data.tar.gz: 3cd788f1b867909219ca14aeb97cdc791acce681fbcc1e806cb68436d82eaf5a
+SHA512:
+  metadata.gz: ce3a1522f2ff96cfc9b87ccc17317cd884609b09f87a55b59f28b1d816374f44fd666c0e212d85baf1af8fde844043061b6c51daba48869895518d6ba60aa70e
+  data.tar.gz: b932fec91523c05f1f5e157e0eb548545877c49fe0543bc8784160ba640916ec1e248989c769951d244f687885eab44a442edc607c6eea14a9618c36bd0382ef

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.rdoc

@@ -0,0 +1,79 @@
+= rtcp {<img src="https://codeclimate.com/github/rusch/rtcp.png" />}[https://codeclimate.com/github/rusch/rtcp] {<img src="https://travis-ci.org/rusch/rtcp.png?branch=master" alt="Build Status" />}[https://travis-ci.org/rusch/rtcp]
+
+
+* https://github.com/rusch/rtcp
+* http://www.ietf.org/rfc/rfc3550.txt
+* http://www.ietf.org/rfc/rfc4585.txt
+
+== Description
+
+The RTP Control Protocol (RTCP) gathers statistical data about RTP sessions,
+for example transmitted octet and packet counts, lost packet counts,
+round-trip delay time and interarrival jitter.
+
+This library parses RTCP data into ruby objects.
+
+== Features
+
+* Parse RTCP Packets into Ruby Objects
+* Supports the following RTCP Packet types:
+  * 200: Sender Report
+  * 201: Receiver Report
+  * 202: Source Description
+  * 203: Goodbye
+  * 204: Application-Defined (Does not decode application-dependent data)
+  * 206: Payload-Specific FB message (Does not decode FCI block)
+  * 207: Extended Report
+  * 209: Receiver Summary Information
+
+== Examples
+
+=== Parse an RTCP Packet
+
+  require 'rtcp'
+
+  rr = RTCP.decode(rtcp_rr_data)   # => [RTCP::RR Object]
+  rr.ssrc                          # => 3945864703
+  rr.length                        # => 8
+  rr.version                       # => 2
+  rr.report_blocks                 # => []
+
+=== Parse a sequence of RTCP Packets
+
+  require 'rtcp'
+
+  msgs = RTCP.decode(rtcp_data)    # => [Array of RTCP::* Objects]
+
+  msgs[0].class                    # => RTCP::RR
+  msgs[0].ssrc                     # => 3945864703
+
+  msgs[1].class                    # => RTCP::SDES
+  msgs[1].chunks                   # => [Array of Hashes]
+  msgs[1].chunks[0][:ssrc]         # => 3945864703
+  msgs[1].chunks[0][:type]         # => :cname
+  msgs[1].chunks[0][:data]         # => "00-09-df-1b-ec-0a"
+
+  msgs[2].class                    # => RTCP::RSI
+  msgs[2].ssrc                     # => 3945864703
+  msge[2].ntp_timestamp            # => [Time Object]
+
+  msgs[3].class                    # => RTCP::APP
+  msgs[3].name                     # => "PLII"
+  msgs[3].app_data                 # => [Binary Data -- The application data]
+
+  msgs[4].class                    # => RTCP
+  msgs[4].to_s                     # => [Binary Data -- The whole RTCP packet]
+
+== Requirements
+
+* Rubies (tested, at least):
+  * 1.9.3
+  * JRuby 1.7.3 (1.9 mode)
+
+== Install
+
+  $ gem install
+
+== Copyright
+
+Copyright (c) 2013 Christian Rusch

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task test: :spec
+task default: :test

data/lib/rtcp.rb

@@ -0,0 +1,99 @@
+require_relative 'rtcp/version'
+require_relative 'rtcp/decode_error'
+require_relative 'rtcp/sr'
+require_relative 'rtcp/rr'
+require_relative 'rtcp/sdes'
+require_relative 'rtcp/bye'
+require_relative 'rtcp/xr'
+require_relative 'rtcp/app'
+require_relative 'rtcp/rsi'
+require_relative 'rtcp/psfb'
+
+class RTCP
+
+  attr_reader :length, :type_id
+
+  @@packet_classes = {}
+  self.constants.each do |sym|
+    const = self.const_get(sym)
+    if const.is_a?(Class) && const <= self
+      @@packet_classes[const::PT_ID] = const
+    end
+  end
+
+  # Decodes the supplied RTCP packet and returns it
+  def self.decode(data)
+    raise(RTCP::DecodeError, "Truncated Packet") if (data.length < 4)
+
+    packet_type, length = data.unpack('xCn')
+    length = 4 * (length + 1)
+    raise(RTCP::DecodeError, "Truncated Packet") if (data.length < length)
+
+    self.packet_class(packet_type).new.decode(data.slice(0..(length - 1)))
+  end
+
+  # Decodes all RTCP packets in the supplied string returns them in an array
+  def self.decode_all(data)
+    packets = []
+    while data && data.length > 0
+      packet = self.decode(data)
+      packets.push(packet)
+      data = data.slice(packet.length..-1)
+    end
+    packets
+  end
+
+  def decode(packet_data)
+    @type_id, length = packet_data.unpack('xCn')
+    @length      = 4 * (length + 1)
+
+    @packet_data = packet_data
+    self
+  end
+
+  # Returns the packet as RTCP data string
+  def to_s
+    @packet_data
+  end
+
+  protected
+
+  # Ensures that the current RTCP Packet object is able to decode the RTCP
+  # packet with the given Packet Type ID.
+  #
+  # Raises an RTCP::DecodeError exception when this is not the case.
+  def ensure_packet_type(packet_type)
+    if packet_type != self.class::PT_ID
+      raise(RTCP::DecodeError, "Wrong Packet Type. packet_type=#{packet_type}")
+    end
+  end
+
+  # Extracts and returns the payload data from the given packet_data using the
+  # supplied packet length and header_length values.
+  #
+  # It also sets the @packet_data instance variable, which is currently used
+  # by the to_s method for returning the packet data.
+  #
+  # Raises an RTCP::DecodeError exception when the packet_data is shorter
+  # than packet_length.
+  def payload_data(packet_data, packet_length, header_length)
+    if packet_data.length > packet_length
+      @packet_data = packet_data[0..packet_length]
+    elsif packet_data.length == packet_length
+      @packet_data = packet_data
+    else
+      raise RTCP::DecodeError, "Truncated Packet"
+    end
+
+    @packet_data[header_length..-1]
+  end
+
+  private
+
+  # Returns the Class to use for handling RTCP packets of the given packet
+  # type.
+  def self.packet_class(packet_type)
+    @@packet_classes[packet_type] || self
+  end
+
+end

data/lib/rtcp/app.rb

@@ -0,0 +1,36 @@
+# APP: Application-Defined RTCP Packet
+# Documentation: RFC 3550, 6.7
+#
+#        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| subtype |   PT=APP=204  |             length            |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                           SSRC/CSRC                           |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                          name (ASCII)                         |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                   application-dependent data                ...
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        0                   1                   2                   3
+
+class RTCP::APP < RTCP
+
+  PT_ID = 204
+
+  attr_reader :version, :subtype, :ssrc, :name, :app_data
+
+  def decode(packet_data) 
+    vpst, packet_type, length, @ssrc, @name = packet_data.unpack('CCnNa4')
+    ensure_packet_type(packet_type)
+
+    @length  = 4 * (length + 1)
+    @version = vpst >> 6
+    @subtype = vpst & 31
+
+    @app_data = payload_data(packet_data, @length, 12)
+
+    self
+  end
+
+end

data/lib/rtcp/bye.rb

@@ -0,0 +1,48 @@
+# BYE: Goodbye RTCP Packet
+# Documentation: RFC 3550, 6.6
+#
+#        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|    SC   |   PT=BYE=203  |             length            |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                           SSRC/CSRC                           |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       :                              ...                              :
+#       +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# (opt) |     length    |               reason for leaving            ...
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+class RTCP::BYE < RTCP
+
+  PT_ID = 203
+
+  attr_reader :version, :ssrcs, :reason, :padding
+
+  def decode(packet_data) 
+    vpsc, packet_type, length = packet_data.unpack('CCn')
+    ensure_packet_type(packet_type)
+
+    @length  = 4 * (length + 1)
+    @version = vpsc >> 6
+    count    = vpsc & 15
+
+    bye_data = payload_data(packet_data, @length, 4)
+
+    @ssrcs = bye_data.unpack("N#{count}")
+
+    if (4 * count) < bye_data.length
+      rlen, data = bye_data.unpack("x#{4 * count}Ca*")
+      @reason = data[0..(rlen - 1)]
+
+      # If the string fills the packet to the next 32-bit boundary,
+      # the string is not null terminated.  If not, the BYE packet
+      # MUST be padded with null octets to the next 32- bit boundary.
+      # $TODO: Remove padding?
+
+      # $TODO: Check for/extract packet padding
+    end
+    self
+  end
+
+end

data/lib/rtcp/decode_error.rb

@@ -0,0 +1,4 @@
+class RTCP
+  class DecodeError < StandardError
+  end
+end

data/lib/rtcp/psfb.rb

@@ -0,0 +1,55 @@
+# PSFB: Payload-specific FB message
+# Documentation: RFC 4585, 6.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
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |V=2|P|   FMT   |       PT      |          length               |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                  SSRC of packet sender                        |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                  SSRC of media source                         |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       :            Feedback Control Information (FCI)                 :
+#       :                                                               :
+
+class RTCP::PSFB < RTCP
+
+  FORMATS = {
+    1 => :pli,  # Picture Loss Indication (PLI)
+    2 => :sli,  # Slice Loss Indication (SLI)
+    3 => :rpsi, # Reference Picture Selection Indication (RPSI)
+   15 => :afb,  # Application layer FB (AFB) message
+  }
+
+  PT_ID = 206
+
+  attr_reader :version, :format, :sender_ssrc, :source_ssrc, :fci,
+    :first_mb, :number, :picture_id
+
+  def decode(packet_data) 
+    vpfmt, packet_type, length, @sender_ssrc, @source_ssrc =
+      packet_data.unpack('CCnN2')
+    ensure_packet_type(packet_type)
+
+    @length  = 4 * (length + 1)
+    @version = vpfmt >> 6
+    format  = vpfmt & 31
+    @format = FORMATS[format] || format
+
+    @fci_data = payload_data(packet_data, @length, 12)
+
+    case @format
+    when :sli
+      pl  = @fci_data.unpack('L')
+      @first_mb   = pl >> 19
+      @number     = (pl >> 6) & 8191
+      @picture_id = pl & 63
+    # when :pli # No parameters
+    # when :rpsi
+    # when :afb
+    end
+    self
+  end
+
+end

data/lib/rtcp/rr.rb

@@ -0,0 +1,45 @@
+# RR: Receiver Report RTCP Packet
+# Documentation: RFC 3550, 6.4.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
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# header |V=2|P|    RC   |   PT=RR=201   |             length            |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                     SSRC of packet sender                     |
+#        +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+# 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::RR < RTCP::SR
+
+  PT_ID = 201
+
+  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)
+    @length  = 4 * (length + 1)
+    @version, @padding, rc = decode_vprc(vprc, @length - 8)
+    @report_blocks = decode_reports(payload_data(packet_data, @length, 8), rc)
+    self
+  end
+
+end

data/lib/rtcp/rsi.rb

@@ -0,0 +1,82 @@
+# RSI: Receiver Summary Information Packet
+# Documentation: RFC 5760, 7.1.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
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |V=2|P|reserved |   PT=RSI=209  |             length            |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                           SSRC                                |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                       Summarized SSRC                         |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |              NTP Timestamp (most significant word)            |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |              NTP Timestamp (least significant word)           |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       :                       Sub-report blocks                       :
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       0                   1                   2                   3
+#
+# Sub-Report-Block Type
+#
+#        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
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |     SRBT      |    Length     |                               |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+      SRBT-specific data       +
+#       |                                                               |
+#       :                                                               :
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#
+# Generic Sub-Report Block Fields
+#
+#        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
+#       +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+#       |     SRBT      |    Length     |        NDB            |   MF  |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                   Minimum Distribution Value                  |
+#       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#       |                   Maximum Distribution Value                  |
+#       +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+#       |                      Distribution Buckets                     |
+#       |                             ...                               |
+#       |                             ...                               |
+#       +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+
+class RTCP::RSI < RTCP
+
+  PT_ID = 209
+
+  attr_reader :version, :ssrc, :summarized_ssrc, :ntp_timestamp, :report_blocks
+
+  def decode(packet_data) 
+    vp, packet_type, length, @ssrc, @summarized_ssrc, ntp_h, ntp_l =
+      packet_data.unpack('CCnN4')
+    ensure_packet_type(packet_type)
+
+    @length  = 4 * (length + 1)
+    @version = vp >> 6
+    @ntp_timestamp = Time.at(ntp_h - 2208988800 + (ntp_l.to_f / 0x100000000))
+    @report_blocks = decode_reports(payload_data(packet_data, @length, 20))
+    self
+  end
+
+  private
+
+  def decode_reports(data)
+    blocks = []
+    while data && data.length >= 2
+      type, len = report_block_data.unpack('CC')
+      if data.length < len
+        raise DecodeError, "Truncated Packet"
+      end
+      blocks.push({
+        type: type,
+        data: data.slice!(0..(len-1))
+      })
+    end
+    blocks
+  end
+
+end