track_media_info_map.h

/*

 *  Copyright 2016 The WebRTC Project Authors. All rights reserved.

 *  Use of this source code is governed by a BSD-style license

 *  that can be found in the LICENSE file in the root of the source

 *  tree. An additional intellectual property rights grant can be found

 *  in the file PATENTS.  All contributing project authors may

 *  be found in the AUTHORS file in the root of the source tree.

*/

#ifndef PC_TRACK_MEDIA_INFO_MAP_H_

#define PC_TRACK_MEDIA_INFO_MAP_H_

#include <stdint.h>

#include <map>

#include <memory>

#include <string>

#include <vector>

#include "absl/types/optional.h"

#include "api/array_view.h"

#include "api/media_stream_interface.h"

#include "api/scoped_refptr.h"

#include "media/base/media_channel.h"

#include "pc/rtp_receiver.h"

#include "pc/rtp_sender.h"

#include "rtc_base/ref_count.h"

namespace webrtc {

// Audio/video tracks and sender/receiver statistical information are associated

// with each other based on attachments to RTP senders/receivers. This class

// maps that relationship so that "infos" can be obtained from SSRCs and tracks

// can be obtained from "infos".

class TrackMediaInfoMap {

 public:

  TrackMediaInfoMap();

  // Takes ownership of the "infos". Does not affect the lifetime of the senders

  // or receivers, but TrackMediaInfoMap will keep their associated tracks alive

  // through reference counting until the map is destroyed.

  void Initialize(

      absl::optional<cricket::VoiceMediaInfo> voice_media_info,

      absl::optional<cricket::VideoMediaInfo> video_media_info,

      rtc::ArrayView<rtc::scoped_refptr<RtpSenderInternal>> rtp_senders,

      rtc::ArrayView<rtc::scoped_refptr<RtpReceiverInternal>> rtp_receivers);

  const absl::optional<cricket::VoiceMediaInfo>& voice_media_info() const {

    RTC_DCHECK(is_initialized_);

    return voice_media_info_;

  const absl::optional<cricket::VideoMediaInfo>& video_media_info() const {

    RTC_DCHECK(is_initialized_);

    return video_media_info_;

  const cricket::VoiceSenderInfo* GetVoiceSenderInfoBySsrc(uint32_t ssrc) const;

  const cricket::VoiceReceiverInfo* GetVoiceReceiverInfoBySsrc(

      uint32_t ssrc) const;

  const cricket::VideoSenderInfo* GetVideoSenderInfoBySsrc(uint32_t ssrc) const;

  const cricket::VideoReceiverInfo* GetVideoReceiverInfoBySsrc(

      uint32_t ssrc) const;

  rtc::scoped_refptr<AudioTrackInterface> GetAudioTrack(

      const cricket::VoiceSenderInfo& voice_sender_info) const;

  rtc::scoped_refptr<AudioTrackInterface> GetAudioTrack(

      const cricket::VoiceReceiverInfo& voice_receiver_info) const;

  rtc::scoped_refptr<VideoTrackInterface> GetVideoTrack(

      const cricket::VideoSenderInfo& video_sender_info) const;

  rtc::scoped_refptr<VideoTrackInterface> GetVideoTrack(

      const cricket::VideoReceiverInfo& video_receiver_info) const;

  // TODO(hta): Remove this function, and redesign the callers not to need it.

  // It is not going to work if a track is attached multiple times, and

  // it is not going to work if a received track is attached as a sending

  // track (loopback).

  absl::optional<int> GetAttachmentIdByTrack(

      const MediaStreamTrackInterface* track) const;

 private:

  bool is_initialized_ = false;

  absl::optional<cricket::VoiceMediaInfo> voice_media_info_;

  absl::optional<cricket::VideoMediaInfo> video_media_info_;

  // These maps map info objects to their corresponding tracks. They are always

  // the inverse of the maps above. One info object always maps to only one

  // track. The use of scoped_refptr<> here ensures the tracks outlive

  // TrackMediaInfoMap.

  std::map<const cricket::VoiceSenderInfo*,

           rtc::scoped_refptr<AudioTrackInterface>>

      audio_track_by_sender_info_;

  std::map<const cricket::VoiceReceiverInfo*,

           rtc::scoped_refptr<AudioTrackInterface>>

      audio_track_by_receiver_info_;

  std::map<const cricket::VideoSenderInfo*,

           rtc::scoped_refptr<VideoTrackInterface>>

      video_track_by_sender_info_;

  std::map<const cricket::VideoReceiverInfo*,

           rtc::scoped_refptr<VideoTrackInterface>>

      video_track_by_receiver_info_;

  // Map of tracks to attachment IDs.

  // Necessary because senders and receivers live on the signaling thread,

  // but the attachment IDs are needed while building stats on the networking

  // thread, so we can't look them up in the senders/receivers without

  // thread jumping.

  std::map<const MediaStreamTrackInterface*, int> attachment_id_by_track_;

  // These maps map SSRCs to the corresponding voice or video info objects.

  std::map<uint32_t, cricket::VoiceSenderInfo*> voice_info_by_sender_ssrc_;

  std::map<uint32_t, cricket::VoiceReceiverInfo*> voice_info_by_receiver_ssrc_;

  std::map<uint32_t, cricket::VideoSenderInfo*> video_info_by_sender_ssrc_;

  std::map<uint32_t, cricket::VideoReceiverInfo*> video_info_by_receiver_ssrc_;

};

}  // namespace webrtc

#endif  // PC_TRACK_MEDIA_INFO_MAP_H_