rts_stats.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <optional>
#include <string>
#include <vector>
 
#include "millicast-sdk/exports.h"
 
namespace millicast {
 
struct MILLICAST_API RtsTrackStats {
  enum class Type { AUDIO = 0, VIDEO };
  Type type;
 
  int64_t timestamp;
 
  // Service information
  std::optional<std::string> source_id;
 
  // WebRTC identification information
  std::string mid;
  std::string track_identifier;
 
  // packet/retransmission information
  std::optional<uint64_t> bytes_received;
  std::optional<uint64_t> retransmitted_bytes_received;
  std::optional<uint64_t> packets_received;
  std::optional<uint64_t> retransmitted_packets_received;
  std::optional<uint64_t> packets_lost;
  std::optional<uint32_t> nack_count;
  std::optional<uint64_t> bitrate_bps;
 
  // jitter information
  std::optional<double> jitter;
  // Those are already normalized based on the emitted count.
  std::optional<double> jitter_buffer_delay;
  std::optional<double> jitter_buffer_minimum_delay;
 
  // This is normalized against the number of frames decoded.
  std::optional<double> processing_delay;
 
  std::string mime_type;
  uint32_t payload_type;
 
  // The rest is video information (not available when it's an audio track)
  std::optional<std::string> decoder_implementation;
  std::optional<uint32_t> frame_width;
  std::optional<uint32_t> frame_height;
  std::optional<uint32_t> frames_per_second;
 
  std::optional<uint32_t> frames_received;
  std::optional<uint32_t> frames_decoded;
  std::optional<uint32_t> key_frames_decoded;
  std::optional<uint32_t> frames_dropped;
 
  // This is normalized against the number of frames decoded (video only).
  std::optional<double> decode_time;
 
  std::optional<uint32_t> pause_count;
  std::optional<uint32_t> freeze_count;
 
  std::optional<double> total_pauses_duration;
  std::optional<double> total_freezes_duration;
 
  std::optional<uint32_t> fir_count;
  std::optional<uint32_t> pli_count;
};
 
class MILLICAST_API RtsViewerStats {
 public:
  enum class Level { FULL, SIMPLIFIED };
 
  std::string cluster_id;
  std::string stream_view_id;
  std::string subscriber_id;
  std::string stream_id;
 
  int64_t timestamp;
  std::optional<double> total_round_trip_time;
  std::optional<double> current_round_trip_time;
 
  /*
   * @brief statistics of all the enabled tracks.
   * */
  std::vector<std::shared_ptr<const RtsTrackStats>> track_stats;
 
  RtsViewerStats() = default;
 
  [[nodiscard]] virtual std::string to_json(Level level) const = 0;
 
  virtual ~RtsViewerStats() = default;
 
 protected:
  RtsViewerStats(const RtsViewerStats&) noexcept = default;
  RtsViewerStats(RtsViewerStats&&) noexcept = default;
  RtsViewerStats& operator=(RtsViewerStats&&) noexcept = default;
  RtsViewerStats& operator=(const RtsViewerStats&) noexcept = default;
};
}  // namespace millicast