RemoteMediaDataDecoder.h

Enable keyboard shortcuts

/* 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 http://mozilla.org/MPL/2.0/. */

#ifndef include_dom_media_ipc_RemoteMediaDataDecoder_h

#define include_dom_media_ipc_RemoteMediaDataDecoder_h

#include "MediaData.h"

#include "PlatformDecoderModule.h"

#include "mozilla/EnumeratedArray.h"

namespace mozilla {

class RemoteDecoderChild;

class RemoteDecoderManagerChild;

class RemoteMediaDataDecoder;

DDLoggedTypeCustomNameAndBase(RemoteMediaDataDecoder, RemoteMediaDataDecoder,

                              MediaDataDecoder);

// A MediaDataDecoder implementation that proxies through IPDL

// to a 'real' decoder in the GPU or RDD process.

// All requests get forwarded to a *DecoderChild instance that

// operates solely on the provided manager and abstract manager threads.

class RemoteMediaDataDecoder final

    : public MediaDataDecoder,

      public DecoderDoctorLifeLogger<RemoteMediaDataDecoder> {

 public:

  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(RemoteMediaDataDecoder, final);

  explicit RemoteMediaDataDecoder(RemoteDecoderChild* aChild);

  // MediaDataDecoder

  RefPtr<InitPromise> Init() override;

  RefPtr<DecodePromise> Decode(MediaRawData* aSample) override;

  bool CanDecodeBatch() const override { return true; }

  RefPtr<DecodePromise> DecodeBatch(

      nsTArray<RefPtr<MediaRawData>>&& aSamples) override;

  RefPtr<DecodePromise> Drain() override;

  RefPtr<FlushPromise> Flush() override;

  RefPtr<ShutdownPromise> Shutdown() override;

  bool IsHardwareAccelerated(nsACString& aFailureReason) const override;

  void SetSeekThreshold(const media::TimeUnit& aTime) override;

  nsCString GetDescriptionName() const override;

  nsCString GetProcessName() const override;

  nsCString GetCodecName() const override;

  ConversionRequired NeedsConversion() const override;

  Maybe<PropertyValue> GetDecodeProperty(PropertyName aName) const override;

  bool ShouldDecoderAlwaysBeRecycled() const override;

 private:

  ~RemoteMediaDataDecoder();

  // Only ever written to from the reader task queue (during the constructor and

  // destructor when we can guarantee no other threads are accessing it). Only

  // read from the manager thread.

  RefPtr<RemoteDecoderChild> mChild;

  mutable Mutex mMutex{"RemoteMediaDataDecoder"};

  // Only ever written/modified during decoder initialisation.

  nsCString mDescription MOZ_GUARDED_BY(mMutex);

  nsCString mProcessName MOZ_GUARDED_BY(mMutex);

  nsCString mCodecName MOZ_GUARDED_BY(mMutex);

  bool mIsHardwareAccelerated MOZ_GUARDED_BY(mMutex);

  nsCString mHardwareAcceleratedReason MOZ_GUARDED_BY(mMutex);

  ConversionRequired mConversion MOZ_GUARDED_BY(mMutex);

  bool mShouldDecoderAlwaysBeRecycled MOZ_GUARDED_BY(mMutex);

  EnumeratedArray<PropertyName, Maybe<PropertyValue>, sPropertyNameCount>

      mDecodeProperties MOZ_GUARDED_BY(mMutex);

};

}  // namespace mozilla

#endif  // include_dom_media_ipc_RemoteMediaDataDecoder_h