/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

#include "jsapi/RTCEncodedAudioFrame.h"

#include <stdint.h>

#include <memory>
#include <utility>

#include "api/frame_transformer_factory.h"
#include "api/frame_transformer_interface.h"
#include "js/RootingAPI.h"
#include "jsapi/RTCEncodedFrameBase.h"
#include "jsapi/RTCRtpScriptTransform.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/RTCEncodedAudioFrameBinding.h"
#include "mozilla/dom/RTCRtpScriptTransformer.h"
#include "mozilla/dom/StructuredCloneHolder.h"
#include "mozilla/dom/StructuredCloneTags.h"
#include "mozilla/fallible.h"
#include "nsContentUtils.h"
#include "nsIGlobalObject.h"
#include "nsISupports.h"
#include "nsWrapperCache.h"

namespace mozilla::dom {

RTCEncodedAudioFrame::RTCEncodedAudioFrame(
    nsIGlobalObject* aGlobal,
    std::unique_ptr<webrtc::TransformableFrameInterface> aFrame,
    uint64_t aCounter, RTCRtpScriptTransformer* aOwner)
    : RTCEncodedAudioFrameData{RTCEncodedFrameState{std::move(aFrame), aCounter,
                                                    /*timestamp*/ 0}},
      RTCEncodedFrameBase(aGlobal, static_cast<RTCEncodedFrameState&>(*this),
                          aOwner) {
  mMetadata.mSynchronizationSource.Construct(mFrame->GetSsrc());
  mMetadata.mPayloadType.Construct(mFrame->GetPayloadType());
  mMetadata.mMimeType.Construct(NS_ConvertASCIItoUTF16(mFrame->GetMimeType()));
  mMetadata.mRtpTimestamp.Construct(mFrame->GetTimestamp());
  const auto& audioFrame(
      static_cast<webrtc::TransformableAudioFrameInterface&>(*mFrame));
  mMetadata.mContributingSources.Construct();
  for (const auto csrc : audioFrame.GetContributingSources()) {
    (void)mMetadata.mContributingSources.Value().AppendElement(csrc, fallible);
  }
  if (const auto optionalSeqNum = audioFrame.SequenceNumber()) {
    mMetadata.mSequenceNumber.Construct(*optionalSeqNum);
  }
}

RTCEncodedAudioFrame::RTCEncodedAudioFrame(nsIGlobalObject* aGlobal,
                                           RTCEncodedAudioFrameData&& aData)
    : RTCEncodedAudioFrameData{RTCEncodedFrameState{std::move(aData.mFrame),
                                                    aData.mCounter,
                                                    aData.mTimestamp},
                               std::move(aData.mMetadata)},
      RTCEncodedFrameBase(aGlobal, static_cast<RTCEncodedFrameState&>(*this),
                          nullptr) {}

JSObject* RTCEncodedAudioFrame::WrapObject(JSContext* aCx,
                                           JS::Handle<JSObject*> aGivenProto) {
  return RTCEncodedAudioFrame_Binding::Wrap(aCx, this, aGivenProto);
}

// https://w3c.github.io/webrtc-encoded-transform/#RTCEncodedAudioFrame-constructor
/* static */
already_AddRefed<RTCEncodedAudioFrame> RTCEncodedAudioFrame::Constructor(
    const GlobalObject& aGlobal, const RTCEncodedAudioFrame& aOriginalFrame,
    const RTCEncodedAudioFrameOptions& aOptions, ErrorResult& aRv) {
  nsCOMPtr<nsIGlobalObject> global = do_QueryInterface(aGlobal.GetAsSupports());
  if (!global) {
    aRv.Throw(NS_ERROR_FAILURE);
    return nullptr;
  }
  auto frame = MakeRefPtr<RTCEncodedAudioFrame>(global, aOriginalFrame.Clone());

  if (aOptions.mMetadata.WasPassed()) {
    const auto& src = aOptions.mMetadata.Value();
    auto& dst = frame->mMetadata;

    auto set_if = [](auto& dst, const auto& src) {
      if (src.WasPassed()) dst.Value() = src.Value();
    };
    set_if(dst.mSynchronizationSource, src.mSynchronizationSource);
    set_if(dst.mPayloadType, src.mPayloadType);
    set_if(dst.mMimeType, src.mMimeType);
    set_if(dst.mRtpTimestamp, src.mRtpTimestamp);
    set_if(dst.mContributingSources, src.mContributingSources);
    set_if(dst.mSequenceNumber, src.mSequenceNumber);
  }
  return frame.forget();
}

RTCEncodedAudioFrameData RTCEncodedAudioFrameData::Clone() const {
  return RTCEncodedAudioFrameData{
      RTCEncodedFrameState{webrtc::CloneAudioFrame(
          static_cast<webrtc::TransformableAudioFrameInterface*>(
              mFrame.get()))},
      RTCEncodedAudioFrameMetadata(mMetadata)};
}

void RTCEncodedAudioFrame::GetMetadata(
    RTCEncodedAudioFrameMetadata& aMetadata) const {
  aMetadata = mMetadata;
}

bool RTCEncodedAudioFrame::CheckOwner(RTCRtpScriptTransformer* aOwner) const {
  return aOwner == mOwner;
}

// https://www.w3.org/TR/webrtc-encoded-transform/#RTCEncodedAudioFrame-serialization
/* static */
JSObject* RTCEncodedAudioFrame::ReadStructuredClone(
    JSContext* aCx, nsIGlobalObject* aGlobal, JSStructuredCloneReader* aReader,
    RTCEncodedAudioFrameData& aData) {
  JS::Rooted<JS::Value> value(aCx, JS::NullValue());
  // To avoid a rooting hazard error from returning a raw JSObject* before
  // running the RefPtr destructor, RefPtr needs to be destructed before
  // returning the raw JSObject*, which is why the RefPtr<RTCEncodedAudioFrame>
  // is created in the scope below. Otherwise, the static analysis infers the
  // RefPtr cannot be safely destructed while the unrooted return JSObject* is
  // on the stack.
  {
    auto frame = MakeRefPtr<RTCEncodedAudioFrame>(aGlobal, std::move(aData));
    if (!GetOrCreateDOMReflector(aCx, frame, &value) || !value.isObject()) {
      return nullptr;
    }
  }
  return value.toObjectOrNull();
}

bool RTCEncodedAudioFrame::WriteStructuredClone(
    JSStructuredCloneWriter* aWriter, StructuredCloneHolder* aHolder) const {
  AssertIsOnOwningThread();

  // Indexing the chunk and send the index to the receiver.
  const uint32_t index =
      static_cast<uint32_t>(aHolder->RtcEncodedAudioFrames().Length());
  // The serialization is limited to the same process scope so it's ok to
  // hand over a (copy of a) webrtc internal object here.
  //
  // TODO: optimize later once encoded source API materializes
  // .AppendElement(aHolder->IsTransferred(mData) ? Take() : Clone())
  aHolder->RtcEncodedAudioFrames().AppendElement(Clone());
  return !NS_WARN_IF(
      !JS_WriteUint32Pair(aWriter, SCTAG_DOM_RTCENCODEDAUDIOFRAME, index));
}

}  // namespace mozilla::dom