ipc/glue/UtilityAudioDecoderChild.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6 #ifndef _include_ipc_glue_UtilityAudioDecoderChild_h__
   7 #define _include_ipc_glue_UtilityAudioDecoderChild_h__
   8
   9 #include "mozilla/ProcInfo.h"
  10 #include "mozilla/ProfilerMarkers.h"
  11 #include "mozilla/RefPtr.h"
  12
  13 #include "mozilla/ipc/Endpoint.h"
  14 #include "mozilla/ipc/UtilityProcessParent.h"
  15 #include "mozilla/ipc/UtilityProcessSandboxing.h"
  16 #include "mozilla/ipc/UtilityAudioDecoder.h"
  17 #include "mozilla/ipc/PUtilityAudioDecoderChild.h"
  18
  19 #ifdef MOZ_WMF_MEDIA_ENGINE
  20 #  include "mozilla/gfx/GPUProcessListener.h"
  21 #  include "mozilla/gfx/gfxVarReceiver.h"
  22 #endif
  23
  24 #include "PDMFactory.h"
  25
  26 namespace mozilla::ipc {
  27
  28 class UtilityAudioDecoderChildShutdownObserver : public nsIObserver {
  29  public:
  30   explicit UtilityAudioDecoderChildShutdownObserver(SandboxingKind aKind)
  31       : mSandbox(aKind){};
  32
  33   NS_DECL_ISUPPORTS
  34
  35   NS_IMETHOD Observe(nsISupports* aSubject, const char* aTopic,
  36                      const char16_t* aData) override;
  37
  38  private:
  39   virtual ~UtilityAudioDecoderChildShutdownObserver() = default;
  40
  41   const SandboxingKind mSandbox;
  42 };
  43
  44 // This controls performing audio decoding on the utility process and it is
  45 // intended to live on the main process side
  46 class UtilityAudioDecoderChild final : public PUtilityAudioDecoderChild
  47 #ifdef MOZ_WMF_MEDIA_ENGINE
  48     ,
  49                                        public gfx::gfxVarReceiver,
  50                                        public gfx::GPUProcessListener
  51 #endif
  52 {
  53  public:
  54   NS_INLINE_DECL_THREADSAFE_REFCOUNTING(UtilityAudioDecoderChild, override);
  55   mozilla::ipc::IPCResult RecvUpdateMediaCodecsSupported(
  56       const RemoteDecodeIn& aLocation,
  57       const media::MediaCodecsSupported& aSupported);
  58
  59   UtilityActorName GetActorName() { return GetAudioActorName(mSandbox); }
  60
  61   nsresult BindToUtilityProcess(RefPtr<UtilityProcessParent> aUtilityParent) {
  62     Endpoint<PUtilityAudioDecoderChild> utilityAudioDecoderChildEnd;
  63     Endpoint<PUtilityAudioDecoderParent> utilityAudioDecoderParentEnd;
  64     nsresult rv = PUtilityAudioDecoder::CreateEndpoints(
  65         aUtilityParent->OtherPid(), base::GetCurrentProcId(),
  66         &utilityAudioDecoderParentEnd, &utilityAudioDecoderChildEnd);
  67
  68     if (NS_FAILED(rv)) {
  69       MOZ_ASSERT(false, "Protocol endpoints failure");
  70       return NS_ERROR_FAILURE;
  71     }
  72
  73     if (!aUtilityParent->SendStartUtilityAudioDecoderService(
  74             std::move(utilityAudioDecoderParentEnd))) {
  75       MOZ_ASSERT(false, "StartUtilityAudioDecoder service failure");
  76       return NS_ERROR_FAILURE;
  77     }
  78
  79     Bind(std::move(utilityAudioDecoderChildEnd));
  80
  81     PROFILER_MARKER_UNTYPED(
  82         "UtilityAudioDecoderChild::BindToUtilityProcess", IPC,
  83         MarkerOptions(
  84             MarkerTiming::IntervalUntilNowFrom(mAudioDecoderChildStart)));
  85     return NS_OK;
  86   }
  87
  88   void ActorDestroy(ActorDestroyReason aReason) override;
  89
  90   void Bind(Endpoint<PUtilityAudioDecoderChild>&& aEndpoint);
  91
  92   static void Shutdown(SandboxingKind aKind);
  93
  94   static RefPtr<UtilityAudioDecoderChild> GetSingleton(SandboxingKind aKind);
  95
  96 #ifdef MOZ_WMF_MEDIA_ENGINE
  97   mozilla::ipc::IPCResult RecvCompleteCreatedVideoBridge();
  98
  99   bool HasCreatedVideoBridge() const;
 100
 101   void OnVarChanged(const gfx::GfxVarUpdate& aVar) override;
 102
 103   void OnCompositorUnexpectedShutdown() override;
 104
 105   // True if creating a video bridge sucessfully. Currently only used for media
 106   // engine cdm.
 107   bool CreateVideoBridge();
 108 #endif
 109
 110  private:
 111   explicit UtilityAudioDecoderChild(SandboxingKind aKind);
 112   ~UtilityAudioDecoderChild() = default;
 113
 114   const SandboxingKind mSandbox;
 115
 116 #ifdef MOZ_WMF_MEDIA_ENGINE
 117   // True if the utility process has created a video bridge with the GPU prcess.
 118   // Currently only used for media egine cdm. Main thread only.
 119   bool mHasCreatedVideoBridge = false;
 120 #endif
 121
 122   TimeStamp mAudioDecoderChildStart;
 123 };
 124
 125 }  // namespace mozilla::ipc
 126
 127 #endif  // _include_ipc_glue_UtilityAudioDecoderChild_h__