sdk/android/api/org/webrtc/RtpReceiver.java

/*
 *  Copyright 2015 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.
 */

package org.webrtc;

import androidx.annotation.Nullable;
import org.jni_zero.NativeMethods;

/** Java wrapper for a C++ RtpReceiverInterface. */
public class RtpReceiver {
  /** Java wrapper for a C++ RtpReceiverObserverInterface*/
  public static interface Observer {
    // Called when the first audio or video packet is received.
    @CalledByNative
    public void onFirstPacketReceived(MediaStreamTrack.MediaType media_type);
    // Called when the first audio or video packet is received after
    // receptiveness changed.
    // TODO: crbug.com/40821064 - remove default implementation.
    @CalledByNative
    public default void onFirstPacketReceivedAfterReceptiveChange(
      MediaStreamTrack.MediaType media_type) {}
  }

  private long nativeRtpReceiver;
  private long nativeObserver;

  @Nullable private final MediaStreamTrack cachedTrack;

  @CalledByNative
  public RtpReceiver(long nativeRtpReceiver) {
    this.nativeRtpReceiver = nativeRtpReceiver;
    long nativeTrack = RtpReceiverJni.get().getTrack(nativeRtpReceiver);
    cachedTrack = MediaStreamTrack.createMediaStreamTrack(nativeTrack);
  }

  @Nullable
  public MediaStreamTrack track() {
    return cachedTrack;
  }

  public RtpParameters getParameters() {
    checkRtpReceiverExists();
    return RtpReceiverJni.get().getParameters(nativeRtpReceiver);
  }

  public String id() {
    checkRtpReceiverExists();
    return RtpReceiverJni.get().getId(nativeRtpReceiver);
  }

  /** Returns a pointer to webrtc::RtpReceiverInterface. */
  long getNativeRtpReceiver() {
    checkRtpReceiverExists();
    return nativeRtpReceiver;
  }

  @CalledByNative
  public void dispose() {
    checkRtpReceiverExists();
    cachedTrack.dispose();
    if (nativeObserver != 0) {
      RtpReceiverJni.get().unsetObserver(nativeRtpReceiver, nativeObserver);
      nativeObserver = 0;
    }
    JniCommon.nativeReleaseRef(nativeRtpReceiver);
    nativeRtpReceiver = 0;
  }

  public void SetObserver(Observer observer) {
    checkRtpReceiverExists();
    // Unset the existing one before setting a new one.
    if (nativeObserver != 0) {
      RtpReceiverJni.get().unsetObserver(nativeRtpReceiver, nativeObserver);
    }
    nativeObserver = RtpReceiverJni.get().setObserver(nativeRtpReceiver, observer);
  }

  public void setFrameDecryptor(FrameDecryptor frameDecryptor) {
    checkRtpReceiverExists();
    RtpReceiverJni.get()
        .setFrameDecryptor(nativeRtpReceiver, frameDecryptor.getNativeFrameDecryptor());
  }

  private void checkRtpReceiverExists() {
    if (nativeRtpReceiver == 0) {
      throw new IllegalStateException("RtpReceiver has been disposed.");
    }
  }

  @NativeMethods
  interface Natives {
    long getTrack(long rtpReceiver);

    RtpParameters getParameters(long rtpReceiver);

    String getId(long rtpReceiver);

    long setObserver(long rtpReceiver, Observer observer);

    void unsetObserver(long rtpReceiver, long nativeObserver);

    void setFrameDecryptor(long rtpReceiver, long nativeFrameDecryptor);
  }
}