dom/media/ipc/RemoteVideoDecoder.h
author Daniel Varga <dvarga@mozilla.com>
Fri, 09 Nov 2018 11:59:52 +0200
changeset 501796 5e7636ec12c5c4543b64428e15165031cff32dc4
parent 501782 dom/media/ipc/GpuDecoderModule.h@58c02c05d2dbebcdba362482f31469ac8908306c
parent 501680 dom/media/ipc/GpuDecoderModule.h@b9920862e1e44575f5524793f8dace7923592554
child 501826 981eb3885ff2d2edc9408d44dab9610594a930f7
permissions -rw-r--r--
Merge mozilla-inbound to mozilla-central. a=merge

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=99: */
/* 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_ipc_RemoteVideoDecoder_h
#define include_dom_ipc_RemoteVideoDecoder_h

#include "mozilla/RefPtr.h"
#include "mozilla/DebugOnly.h"
#include "MediaData.h"
#include "PlatformDecoderModule.h"

namespace mozilla {

namespace dom {
class RemoteVideoDecoder;
}
DDLoggedTypeCustomNameAndBase(dom::RemoteVideoDecoder,
                              RemoteVideoDecoder,
                              MediaDataDecoder);

namespace dom {

class VideoDecoderChild;
class RemoteDecoderModule;

// A MediaDataDecoder implementation that proxies through IPDL
// to a 'real' decoder in the GPU process.
// All requests get forwarded to a VideoDecoderChild instance that
// operates solely on the VideoDecoderManagerChild thread.
class RemoteVideoDecoder
  : public MediaDataDecoder
  , public DecoderDoctorLifeLogger<RemoteVideoDecoder>
{
public:
  friend class RemoteDecoderModule;

  // MediaDataDecoder
  RefPtr<InitPromise> Init() override;
  RefPtr<DecodePromise> Decode(MediaRawData* aSample) 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;
  ConversionRequired NeedsConversion() const override;

private:
  RemoteVideoDecoder();
  ~RemoteVideoDecoder();

  // 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<VideoDecoderChild> mActor;
  // Only ever written/modified during decoder initialisation.
  // As such can be accessed from any threads after that.
  nsCString mDescription;
  bool mIsHardwareAccelerated;
  nsCString mHardwareAcceleratedReason;
  MediaDataDecoder::ConversionRequired mConversion;
};

// A PDM implementation that creates RemoteVideoDecoders.
// We currently require a 'wrapped' PDM in order to be able to answer SupportsMimeType
// and DecoderNeedsConversion. Ideally we'd check these over IPDL using the manager
// protocol
class RemoteDecoderModule : public PlatformDecoderModule
{
public:
  explicit RemoteDecoderModule(PlatformDecoderModule* aWrapped)
    : mWrapped(aWrapped)
  {}

  nsresult Startup() override;

  bool SupportsMimeType(const nsACString& aMimeType,
                        DecoderDoctorDiagnostics* aDiagnostics) const override;
  bool Supports(const TrackInfo& aTrackInfo,
                DecoderDoctorDiagnostics* aDiagnostics) const override;

  already_AddRefed<MediaDataDecoder> CreateVideoDecoder(
    const CreateDecoderParams& aParams) override;

  already_AddRefed<MediaDataDecoder> CreateAudioDecoder(
    const CreateDecoderParams& aParams) override
  {
    return nullptr;
  }

private:
  RefPtr<PlatformDecoderModule> mWrapped;
};

} // namespace dom
} // namespace mozilla

#endif // include_dom_ipc_RemoteVideoDecoder_h