dm/DMSrcSink.h - platform/external/skia - Gitiles

 /*
  * Copyright 2015 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */

 #ifndef DMSrcSink_DEFINED
 #define DMSrcSink_DEFINED

 #include "gm/gm.h"
 #include "include/core/SkBBHFactory.h"
 #include "include/core/SkBitmap.h"
 #include "include/core/SkCanvas.h"
 #include "include/core/SkData.h"
 #include "include/core/SkPicture.h"
 #include "src/utils/SkMultiPictureDocument.h"
 #include "tools/flags/CommonFlagsConfig.h"
 #include "tools/gpu/MemoryCache.h"

 #include <functional>

 //#define TEST_VIA_SVG

 namespace skiagm {
 namespace verifiers {
 class VerifierList;
 }
 }

 namespace DM {

 // This is just convenience.  It lets you use either return "foo" or return SkStringPrintf(...).
 struct ImplicitString : public SkString {
     template <typename T>
     ImplicitString(const T& s) : SkString(s) {}
     ImplicitString() : SkString("") {}
 };
 typedef ImplicitString Name;
 typedef ImplicitString Path;

 class Result {
 public:
     enum class Status : int { Ok, Fatal, Skip };
     Result(Status status, const SkString& s) : fMsg(s), fStatus(status) {}
     Result(Status status, const char* s) : fMsg(s), fStatus(status) {}
     template <typename... Args> Result (Status status, const char* s, Args... args)
         : fMsg(SkStringPrintf(s, args...)), fStatus(status) {}

     Result(const Result&)            = default;
     Result& operator=(const Result&) = default;

     static Result Ok() { return Result(Status::Ok, nullptr); }

     static Result Fatal(const SkString& s) { return Result(Status::Fatal, s); }
     static Result Fatal(const char* s) { return Result(Status::Fatal, s); }
     template <typename... Args> static Result Fatal(const char* s, Args... args) {
         return Result(Status::Fatal, s, args...);
     }

     static Result Skip(const SkString& s) { return Result(Status::Skip, s); }
     static Result Skip(const char* s) { return Result(Status::Skip, s); }
     template <typename... Args> static Result Skip(const char* s, Args... args) {
         return Result(Status::Skip, s, args...);
     }

     bool isOk() { return fStatus == Status::Ok; }
     bool isFatal() { return fStatus == Status::Fatal; }
     bool isSkip() { return fStatus == Status::Skip; }

     const char* c_str() const { return fMsg.c_str(); }
     Status status() const { return fStatus; }

 private:
     SkString fMsg;
     Status   fStatus;
 };

 struct SinkFlags {
     enum Type { kNull, kGPU, kVector, kRaster } type;
     enum Approach { kDirect, kIndirect } approach;
     enum Multisampled { kNotMultisampled, kMultisampled } multisampled;
     SinkFlags(Type t, Approach a, Multisampled ms = kNotMultisampled)
             : type(t), approach(a), multisampled(ms) {}
 };

 struct Src {
     virtual ~Src() {}
     virtual Result SK_WARN_UNUSED_RESULT draw(GrDirectContext*, SkCanvas*) const = 0;
     virtual SkISize size() const = 0;
     virtual Name name() const = 0;
     virtual void modifyGrContextOptions(GrContextOptions* options) const {}
     virtual bool veto(SinkFlags) const { return false; }

     virtual int pageCount() const { return 1; }
     virtual Result SK_WARN_UNUSED_RESULT draw(int, GrDirectContext* context,
                                               SkCanvas* canvas) const {
         return this->draw(context, canvas);
     }
     virtual SkISize size(int) const { return this->size(); }
     // Force Tasks using this Src to run on the main thread?
     virtual bool serial() const { return false; }

     /** Return a list of verifiers for the src, or null if no verifiers should be run .*/
     virtual std::unique_ptr<skiagm::verifiers::VerifierList> getVerifiers() const {
         return nullptr;
     }
 };

 struct Sink {
     virtual ~Sink() {}
     // You may write to either the bitmap or stream.  If you write to log, we'll print that out.
     virtual Result SK_WARN_UNUSED_RESULT draw(const Src&, SkBitmap*, SkWStream*, SkString* log)
         const = 0;

     // Force Tasks using this Sink to run on the main thread?
     virtual bool serial() const { return false; }

     // File extension for the content draw() outputs, e.g. "png", "pdf".
     virtual const char* fileExtension() const  = 0;

     virtual SinkFlags flags() const = 0;

     /** Returns the color type and space used by the sink. */
     virtual SkColorInfo colorInfo() const { return SkColorInfo(); }
 };

 /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/

 class GMSrc : public Src {
 public:
     explicit GMSrc(skiagm::GMFactory);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     void modifyGrContextOptions(GrContextOptions* options) const override;

     std::unique_ptr<skiagm::verifiers::VerifierList> getVerifiers() const override;

 private:
     skiagm::GMFactory fFactory;
 };

 class CodecSrc : public Src {
 public:
     enum Mode {
         kCodec_Mode,
         // We choose to test only one mode with zero initialized memory.
         // This will exercise all of the interesting cases in SkSwizzler
         // without doubling the size of our test suite.
         kCodecZeroInit_Mode,
         kScanline_Mode,
         kStripe_Mode, // Tests the skipping of scanlines
         kCroppedScanline_Mode, // Tests (jpeg) cropped scanline optimization
         kSubset_Mode, // For codecs that support subsets directly.
         kAnimated_Mode, // For codecs that support animation.
     };
     enum DstColorType {
         kGetFromCanvas_DstColorType,
         kGrayscale_Always_DstColorType,
         kNonNative8888_Always_DstColorType,
     };
     CodecSrc(Path, Mode, DstColorType, SkAlphaType, float);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;
     bool serial() const override { return fRunSerially; }
 private:
     Path                    fPath;
     Mode                    fMode;
     DstColorType            fDstColorType;
     SkAlphaType             fDstAlphaType;
     float                   fScale;
     bool                    fRunSerially;
 };

 class AndroidCodecSrc : public Src {
 public:
     AndroidCodecSrc(Path, CodecSrc::DstColorType, SkAlphaType, int sampleSize);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;
     bool serial() const override { return fRunSerially; }
 private:
     Path                    fPath;
     CodecSrc::DstColorType  fDstColorType;
     SkAlphaType             fDstAlphaType;
     int                     fSampleSize;
     bool                    fRunSerially;
 };

 #ifdef SK_ENABLE_ANDROID_UTILS
 // Allows for testing of various implementations of Android's BitmapRegionDecoder
 class BRDSrc : public Src {
 public:
     enum Mode {
         // Decode the entire image as one region.
         kFullImage_Mode,
         // Splits the image into multiple regions using a divisor and decodes the regions
         // separately.  Also, this test adds a border of a few pixels to each of the regions
         // that it is decoding.  This tests the behavior when a client asks for a region that
         // does not fully fit in the image.
         kDivisor_Mode,
     };

     BRDSrc(Path, Mode, CodecSrc::DstColorType, uint32_t);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;
 private:
     Path                                     fPath;
     Mode                                     fMode;
     CodecSrc::DstColorType                   fDstColorType;
     uint32_t                                 fSampleSize;
 };
 #endif

 class ImageGenSrc : public Src {
 public:
     enum Mode {
         kCodec_Mode,    // Use CodecImageGenerator
         kPlatform_Mode, // Uses CG or WIC
     };
     ImageGenSrc(Path, Mode, SkAlphaType, bool);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;
     bool serial() const override { return fRunSerially; }
 private:
     Path        fPath;
     Mode        fMode;
     SkAlphaType fDstAlphaType;
     bool        fIsGpu;
     bool        fRunSerially;
 };

 class ColorCodecSrc : public Src {
 public:
     ColorCodecSrc(Path, bool decode_to_dst);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;
 private:
     Path fPath;
     bool fDecodeToDst;
 };

 class SKPSrc : public Src {
 public:
     explicit SKPSrc(Path path);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
 private:
     Path fPath;
 };

 // This class extracts all the paths from an SKP and then removes unwanted paths according to the
 // provided l/r trail. It then just draws the remaining paths. (Non-path draws are thrown out.) It
 // is useful for finding a reduced repo case for path drawing bugs.
 class BisectSrc : public SKPSrc {
 public:
     explicit BisectSrc(Path path, const char* trail);

     Result draw(GrDirectContext*, SkCanvas*) const override;

 private:
     SkString fTrail;

     typedef SKPSrc INHERITED;
 };

 #if defined(SK_ENABLE_SKOTTIE)
 class SkottieSrc final : public Src {
 public:
     explicit SkottieSrc(Path path);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;

 private:
     // Generates a kTileCount x kTileCount filmstrip with evenly distributed frames.
     static constexpr int      kTileCount = 5;

     // Fit kTileCount x kTileCount frames to a 1000x1000 film strip.
     static constexpr SkScalar kTargetSize = 1000;
     static constexpr SkScalar kTileSize = kTargetSize / kTileCount;

     Path                      fPath;
 };
 #endif

 #if defined(SK_ENABLE_SKRIVE)
 class SkRiveSrc final : public Src {
 public:
     explicit SkRiveSrc(Path path);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;

 private:
     // Generates a kTileCount x kTileCount filmstrip with evenly distributed frames.
     static constexpr int      kTileCount  = 5;

     // Fit kTileCount x kTileCount frames to a 1000x1000 film strip.
     static constexpr SkScalar kTargetSize = 1000;
     static constexpr SkScalar kTileSize   = kTargetSize / kTileCount;

     const Path fPath;
 };
 #endif

 #if defined(SK_XML)
 } // namespace DM

 class SkSVGDOM;

 namespace DM {

 class SVGSrc : public Src {
 public:
     explicit SVGSrc(Path path);

     Result draw(GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     Name name() const override;
     bool veto(SinkFlags) const override;

 private:
     Name            fName;
     sk_sp<SkSVGDOM> fDom;
     SkScalar        fScale;

     typedef Src INHERITED;
 };
 #endif // SK_XML
 /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/

 class MSKPSrc : public Src {
 public:
     explicit MSKPSrc(Path path);

     int pageCount() const override;
     Result draw(GrDirectContext*, SkCanvas* c) const override;
     Result draw(int, GrDirectContext*, SkCanvas*) const override;
     SkISize size() const override;
     SkISize size(int) const override;
     Name name() const override;

 private:
     Path fPath;
     mutable SkTArray<SkDocumentPage> fPages;
 };

 /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/

 class NullSink : public Sink {
 public:
     NullSink() {}

     Result draw(const Src& src, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return ""; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kNull, SinkFlags::kDirect }; }
 };

 class GPUSink : public Sink {
 public:
     GPUSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     Result onDraw(const Src&, SkBitmap*, SkWStream*, SkString*,
                   const GrContextOptions& baseOptions,
                   std::function<void(GrContext*)> initContext = nullptr) const;

     sk_gpu_test::GrContextFactory::ContextType contextType() const { return fContextType; }
     const sk_gpu_test::GrContextFactory::ContextOverrides& contextOverrides() const {
         return fContextOverrides;
     }
     SkCommandLineConfigGpu::SurfType surfType() const { return fSurfType; }
     bool useDIText() const { return fUseDIText; }
     bool serial() const override { return true; }
     const char* fileExtension() const override { return "png"; }
     SinkFlags flags() const override {
         SinkFlags::Multisampled ms = fSampleCount > 1 ? SinkFlags::kMultisampled
                                                       : SinkFlags::kNotMultisampled;
         return SinkFlags{ SinkFlags::kGPU, SinkFlags::kDirect, ms };
     }
     const GrContextOptions& baseContextOptions() const { return fBaseContextOptions; }
     SkColorInfo colorInfo() const override {
         return SkColorInfo(fColorType, fAlphaType, fColorSpace);
     }

 protected:
     sk_sp<SkSurface> createDstSurface(GrDirectContext*, SkISize size, GrBackendTexture*,
                                       GrBackendRenderTarget*) const;
     bool readBack(SkSurface*, SkBitmap* dst) const;

 private:
     sk_gpu_test::GrContextFactory::ContextType        fContextType;
     sk_gpu_test::GrContextFactory::ContextOverrides   fContextOverrides;
     SkCommandLineConfigGpu::SurfType                  fSurfType;
     int                                               fSampleCount;
     bool                                              fUseDIText;
     SkColorType                                       fColorType;
     SkAlphaType                                       fAlphaType;
     sk_sp<SkColorSpace>                               fColorSpace;
     GrContextOptions                                  fBaseContextOptions;
     sk_gpu_test::MemoryCache                          fMemoryCache;
 };

 class GPUThreadTestingSink : public GPUSink {
 public:
     GPUThreadTestingSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;

     const char* fileExtension() const override {
         // Suppress writing out results from this config - we just want to do our matching test
         return nullptr;
     }

 private:
     std::unique_ptr<SkExecutor> fExecutor;

     typedef GPUSink INHERITED;
 };

 class GPUPersistentCacheTestingSink : public GPUSink {
 public:
     GPUPersistentCacheTestingSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;

     const char* fileExtension() const override {
         // Suppress writing out results from this config - we just want to do our matching test
         return nullptr;
     }

 private:
     int fCacheType;

     typedef GPUSink INHERITED;
 };

 class GPUPrecompileTestingSink : public GPUSink {
 public:
     GPUPrecompileTestingSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;

     const char* fileExtension() const override {
         // Suppress writing out results from this config - we just want to do our matching test
         return nullptr;
     }

 private:
     typedef GPUSink INHERITED;
 };

 // This sink attempts to emulate Chrome's OOP-R behavior. It:
 //    doesn't use promise images
 //    uses only a single thread for both DDL creation & drawing
 class GPUOOPRSink : public GPUSink {
 public:
     GPUOOPRSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;

 private:
     Result ooprDraw(const Src&, sk_sp<SkSurface> dstSurface, GrDirectContext*) const;

     typedef GPUSink INHERITED;
 };

 // This sink attempts to better simulate the Chrome DDL use-case. It:
 //    creates the DDLs on separate recording threads
 //    performs all the GPU work on a separate GPU thread
 // In the future this should be expanded to:
 //    upload on a utility thread w/ access to a shared context
 //    compile the programs on the utility thread
 //    perform fine grained scheduling of gpu tasks based on their image and program prerequisites
 //    create a single "compositing" DDL that is replayed last
 class GPUDDLSink : public GPUSink {
 public:
     GPUDDLSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;

 private:
     Result ddlDraw(const Src&,
                    sk_sp<SkSurface> dstSurface,
                    SkTaskGroup* recordingTaskGroup,
                    SkTaskGroup* gpuTaskGroup,
                    sk_gpu_test::TestContext* gpuTestCtx,
                    GrDirectContext* gpuThreadCtx) const;

     std::unique_ptr<SkExecutor> fRecordingExecutor;
     std::unique_ptr<SkExecutor> fGPUExecutor;

     typedef GPUSink INHERITED;
 };

 class PDFSink : public Sink {
 public:
     PDFSink(bool pdfa, SkScalar rasterDpi) : fPDFA(pdfa), fRasterDpi(rasterDpi) {}
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return "pdf"; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
     bool fPDFA;
     SkScalar fRasterDpi;
 };

 class XPSSink : public Sink {
 public:
     XPSSink();

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return "xps"; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
 };

 class RasterSink : public Sink {
 public:
     explicit RasterSink(SkColorType, sk_sp<SkColorSpace> = nullptr);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return "png"; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kRaster, SinkFlags::kDirect }; }

 private:
     SkColorType         fColorType;
     sk_sp<SkColorSpace> fColorSpace;
 };

 class ThreadedSink : public RasterSink {
 public:
     explicit ThreadedSink(SkColorType, sk_sp<SkColorSpace> = nullptr);
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 };

 class SKPSink : public Sink {
 public:
     SKPSink();

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return "skp"; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
 };

 class DebugSink : public Sink {
 public:
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return "json"; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
 };

 class SVGSink : public Sink {
 public:
     SVGSink(int pageIndex = 0);

     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
     const char* fileExtension() const override { return "svg"; }
     SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }

 private:
     int fPageIndex;
 };


 /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/

 class Via : public Sink {
 public:
     explicit Via(Sink* sink) : fSink(sink) {}
     const char* fileExtension() const override { return fSink->fileExtension(); }
     bool               serial() const override { return fSink->serial(); }
     SinkFlags flags() const override {
         SinkFlags flags = fSink->flags();
         flags.approach = SinkFlags::kIndirect;
         return flags;
     }
 protected:
     std::unique_ptr<Sink> fSink;
 };

 class ViaMatrix : public Via {
 public:
     ViaMatrix(SkMatrix, Sink*);
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 private:
     const SkMatrix fMatrix;
 };

 class ViaUpright : public Via {
 public:
     ViaUpright(SkMatrix, Sink*);
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 private:
     const SkMatrix fMatrix;
 };

 class ViaSerialization : public Via {
 public:
     explicit ViaSerialization(Sink* sink) : Via(sink) {}
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 };

 class ViaPicture : public Via {
 public:
     explicit ViaPicture(Sink* sink) : Via(sink) {}
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 };

 class ViaDDL : public Via {
 public:
     ViaDDL(int numReplays, int numDivisions, Sink* sink);
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 private:
     const int fNumReplays;
     const int fNumDivisions;
 };

 class ViaSVG : public Via {
 public:
     explicit ViaSVG(Sink* sink) : Via(sink) {}
     Result draw(const Src&, SkBitmap*, SkWStream*, SkString*) const override;
 };

 }  // namespace DM

 #endif//DMSrcSink_DEFINED
	/*
	* Copyright 2015 Google Inc.
	*
	* Use of this source code is governed by a BSD-style license that can be
	* found in the LICENSE file.
	*/

	#ifndef DMSrcSink_DEFINED
	#define DMSrcSink_DEFINED

	#include "gm/gm.h"
	#include "include/core/SkBBHFactory.h"
	#include "include/core/SkBitmap.h"
	#include "include/core/SkCanvas.h"
	#include "include/core/SkData.h"
	#include "include/core/SkPicture.h"
	#include "src/utils/SkMultiPictureDocument.h"
	#include "tools/flags/CommonFlagsConfig.h"
	#include "tools/gpu/MemoryCache.h"

	#include <functional>

	//#define TEST_VIA_SVG

	namespace skiagm {
	namespace verifiers {
	class VerifierList;
	}
	}

	namespace DM {

	// This is just convenience. It lets you use either return "foo" or return SkStringPrintf(...).
	struct ImplicitString : public SkString {
	template <typename T>
	ImplicitString(const T& s) : SkString(s) {}
	ImplicitString() : SkString("") {}
	};
	typedef ImplicitString Name;
	typedef ImplicitString Path;

	class Result {
	public:
	enum class Status : int { Ok, Fatal, Skip };
	Result(Status status, const SkString& s) : fMsg(s), fStatus(status) {}
	Result(Status status, const char* s) : fMsg(s), fStatus(status) {}
	template <typename... Args> Result (Status status, const char* s, Args... args)
	: fMsg(SkStringPrintf(s, args...)), fStatus(status) {}

	Result(const Result&) = default;
	Result& operator=(const Result&) = default;

	static Result Ok() { return Result(Status::Ok, nullptr); }

	static Result Fatal(const SkString& s) { return Result(Status::Fatal, s); }
	static Result Fatal(const char* s) { return Result(Status::Fatal, s); }
	template <typename... Args> static Result Fatal(const char* s, Args... args) {
	return Result(Status::Fatal, s, args...);
	}

	static Result Skip(const SkString& s) { return Result(Status::Skip, s); }
	static Result Skip(const char* s) { return Result(Status::Skip, s); }
	template <typename... Args> static Result Skip(const char* s, Args... args) {
	return Result(Status::Skip, s, args...);
	}

	bool isOk() { return fStatus == Status::Ok; }
	bool isFatal() { return fStatus == Status::Fatal; }
	bool isSkip() { return fStatus == Status::Skip; }

	const char* c_str() const { return fMsg.c_str(); }
	Status status() const { return fStatus; }

	private:
	SkString fMsg;
	Status fStatus;
	};

	struct SinkFlags {
	enum Type { kNull, kGPU, kVector, kRaster } type;
	enum Approach { kDirect, kIndirect } approach;
	enum Multisampled { kNotMultisampled, kMultisampled } multisampled;
	SinkFlags(Type t, Approach a, Multisampled ms = kNotMultisampled)
	: type(t), approach(a), multisampled(ms) {}
	};

	struct Src {
	virtual ~Src() {}
	virtual Result SK_WARN_UNUSED_RESULT draw(GrDirectContext, SkCanvas) const = 0;
	virtual SkISize size() const = 0;
	virtual Name name() const = 0;
	virtual void modifyGrContextOptions(GrContextOptions* options) const {}
	virtual bool veto(SinkFlags) const { return false; }

	virtual int pageCount() const { return 1; }
	virtual Result SK_WARN_UNUSED_RESULT draw(int, GrDirectContext* context,
	SkCanvas* canvas) const {
	return this->draw(context, canvas);
	}
	virtual SkISize size(int) const { return this->size(); }
	// Force Tasks using this Src to run on the main thread?
	virtual bool serial() const { return false; }

	/** Return a list of verifiers for the src, or null if no verifiers should be run .*/
	virtual std::unique_ptr<skiagm::verifiers::VerifierList> getVerifiers() const {
	return nullptr;
	}
	};

	struct Sink {
	virtual ~Sink() {}
	// You may write to either the bitmap or stream. If you write to log, we'll print that out.
	virtual Result SK_WARN_UNUSED_RESULT draw(const Src&, SkBitmap, SkWStream, SkString* log)
	const = 0;

	// Force Tasks using this Sink to run on the main thread?
	virtual bool serial() const { return false; }

	// File extension for the content draw() outputs, e.g. "png", "pdf".
	virtual const char* fileExtension() const = 0;

	virtual SinkFlags flags() const = 0;

	/** Returns the color type and space used by the sink. */
	virtual SkColorInfo colorInfo() const { return SkColorInfo(); }
	};

	/~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/

	class GMSrc : public Src {
	public:
	explicit GMSrc(skiagm::GMFactory);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	void modifyGrContextOptions(GrContextOptions* options) const override;

	std::unique_ptr<skiagm::verifiers::VerifierList> getVerifiers() const override;

	private:
	skiagm::GMFactory fFactory;
	};

	class CodecSrc : public Src {
	public:
	enum Mode {
	kCodec_Mode,
	// We choose to test only one mode with zero initialized memory.
	// This will exercise all of the interesting cases in SkSwizzler
	// without doubling the size of our test suite.
	kCodecZeroInit_Mode,
	kScanline_Mode,
	kStripe_Mode, // Tests the skipping of scanlines
	kCroppedScanline_Mode, // Tests (jpeg) cropped scanline optimization
	kSubset_Mode, // For codecs that support subsets directly.
	kAnimated_Mode, // For codecs that support animation.
	};
	enum DstColorType {
	kGetFromCanvas_DstColorType,
	kGrayscale_Always_DstColorType,
	kNonNative8888_Always_DstColorType,
	};
	CodecSrc(Path, Mode, DstColorType, SkAlphaType, float);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;
	bool serial() const override { return fRunSerially; }
	private:
	Path fPath;
	Mode fMode;
	DstColorType fDstColorType;
	SkAlphaType fDstAlphaType;
	float fScale;
	bool fRunSerially;
	};

	class AndroidCodecSrc : public Src {
	public:
	AndroidCodecSrc(Path, CodecSrc::DstColorType, SkAlphaType, int sampleSize);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;
	bool serial() const override { return fRunSerially; }
	private:
	Path fPath;
	CodecSrc::DstColorType fDstColorType;
	SkAlphaType fDstAlphaType;
	int fSampleSize;
	bool fRunSerially;
	};

	#ifdef SK_ENABLE_ANDROID_UTILS
	// Allows for testing of various implementations of Android's BitmapRegionDecoder
	class BRDSrc : public Src {
	public:
	enum Mode {
	// Decode the entire image as one region.
	kFullImage_Mode,
	// Splits the image into multiple regions using a divisor and decodes the regions
	// separately. Also, this test adds a border of a few pixels to each of the regions
	// that it is decoding. This tests the behavior when a client asks for a region that
	// does not fully fit in the image.
	kDivisor_Mode,
	};

	BRDSrc(Path, Mode, CodecSrc::DstColorType, uint32_t);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;
	private:
	Path fPath;
	Mode fMode;
	CodecSrc::DstColorType fDstColorType;
	uint32_t fSampleSize;
	};
	#endif

	class ImageGenSrc : public Src {
	public:
	enum Mode {
	kCodec_Mode, // Use CodecImageGenerator
	kPlatform_Mode, // Uses CG or WIC
	};
	ImageGenSrc(Path, Mode, SkAlphaType, bool);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;
	bool serial() const override { return fRunSerially; }
	private:
	Path fPath;
	Mode fMode;
	SkAlphaType fDstAlphaType;
	bool fIsGpu;
	bool fRunSerially;
	};

	class ColorCodecSrc : public Src {
	public:
	ColorCodecSrc(Path, bool decode_to_dst);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;
	private:
	Path fPath;
	bool fDecodeToDst;
	};

	class SKPSrc : public Src {
	public:
	explicit SKPSrc(Path path);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	private:
	Path fPath;
	};

	// This class extracts all the paths from an SKP and then removes unwanted paths according to the
	// provided l/r trail. It then just draws the remaining paths. (Non-path draws are thrown out.) It
	// is useful for finding a reduced repo case for path drawing bugs.
	class BisectSrc : public SKPSrc {
	public:
	explicit BisectSrc(Path path, const char* trail);

	Result draw(GrDirectContext, SkCanvas) const override;

	private:
	SkString fTrail;

	typedef SKPSrc INHERITED;
	};

	#if defined(SK_ENABLE_SKOTTIE)
	class SkottieSrc final : public Src {
	public:
	explicit SkottieSrc(Path path);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;

	private:
	// Generates a kTileCount x kTileCount filmstrip with evenly distributed frames.
	static constexpr int kTileCount = 5;

	// Fit kTileCount x kTileCount frames to a 1000x1000 film strip.
	static constexpr SkScalar kTargetSize = 1000;
	static constexpr SkScalar kTileSize = kTargetSize / kTileCount;

	Path fPath;
	};
	#endif

	#if defined(SK_ENABLE_SKRIVE)
	class SkRiveSrc final : public Src {
	public:
	explicit SkRiveSrc(Path path);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;

	private:
	// Generates a kTileCount x kTileCount filmstrip with evenly distributed frames.
	static constexpr int kTileCount = 5;

	// Fit kTileCount x kTileCount frames to a 1000x1000 film strip.
	static constexpr SkScalar kTargetSize = 1000;
	static constexpr SkScalar kTileSize = kTargetSize / kTileCount;

	const Path fPath;
	};
	#endif

	#if defined(SK_XML)
	} // namespace DM

	class SkSVGDOM;

	namespace DM {

	class SVGSrc : public Src {
	public:
	explicit SVGSrc(Path path);

	Result draw(GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	Name name() const override;
	bool veto(SinkFlags) const override;

	private:
	Name fName;
	sk_sp<SkSVGDOM> fDom;
	SkScalar fScale;

	typedef Src INHERITED;
	};
	#endif // SK_XML
	/~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/

	class MSKPSrc : public Src {
	public:
	explicit MSKPSrc(Path path);

	int pageCount() const override;
	Result draw(GrDirectContext, SkCanvas c) const override;
	Result draw(int, GrDirectContext, SkCanvas) const override;
	SkISize size() const override;
	SkISize size(int) const override;
	Name name() const override;

	private:
	Path fPath;
	mutable SkTArray<SkDocumentPage> fPages;
	};

	/~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/

	class NullSink : public Sink {
	public:
	NullSink() {}

	Result draw(const Src& src, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return ""; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kNull, SinkFlags::kDirect }; }
	};

	class GPUSink : public Sink {
	public:
	GPUSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	Result onDraw(const Src&, SkBitmap, SkWStream, SkString*,
	const GrContextOptions& baseOptions,
	std::function<void(GrContext*)> initContext = nullptr) const;

	sk_gpu_test::GrContextFactory::ContextType contextType() const { return fContextType; }
	const sk_gpu_test::GrContextFactory::ContextOverrides& contextOverrides() const {
	return fContextOverrides;
	}
	SkCommandLineConfigGpu::SurfType surfType() const { return fSurfType; }
	bool useDIText() const { return fUseDIText; }
	bool serial() const override { return true; }
	const char* fileExtension() const override { return "png"; }
	SinkFlags flags() const override {
	SinkFlags::Multisampled ms = fSampleCount > 1 ? SinkFlags::kMultisampled
	: SinkFlags::kNotMultisampled;
	return SinkFlags{ SinkFlags::kGPU, SinkFlags::kDirect, ms };
	}
	const GrContextOptions& baseContextOptions() const { return fBaseContextOptions; }
	SkColorInfo colorInfo() const override {
	return SkColorInfo(fColorType, fAlphaType, fColorSpace);
	}

	protected:
	sk_sp<SkSurface> createDstSurface(GrDirectContext, SkISize size, GrBackendTexture,
	GrBackendRenderTarget*) const;
	bool readBack(SkSurface, SkBitmap dst) const;

	private:
	sk_gpu_test::GrContextFactory::ContextType fContextType;
	sk_gpu_test::GrContextFactory::ContextOverrides fContextOverrides;
	SkCommandLineConfigGpu::SurfType fSurfType;
	int fSampleCount;
	bool fUseDIText;
	SkColorType fColorType;
	SkAlphaType fAlphaType;
	sk_sp<SkColorSpace> fColorSpace;
	GrContextOptions fBaseContextOptions;
	sk_gpu_test::MemoryCache fMemoryCache;
	};

	class GPUThreadTestingSink : public GPUSink {
	public:
	GPUThreadTestingSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;

	const char* fileExtension() const override {
	// Suppress writing out results from this config - we just want to do our matching test
	return nullptr;
	}

	private:
	std::unique_ptr<SkExecutor> fExecutor;

	typedef GPUSink INHERITED;
	};

	class GPUPersistentCacheTestingSink : public GPUSink {
	public:
	GPUPersistentCacheTestingSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;

	const char* fileExtension() const override {
	// Suppress writing out results from this config - we just want to do our matching test
	return nullptr;
	}

	private:
	int fCacheType;

	typedef GPUSink INHERITED;
	};

	class GPUPrecompileTestingSink : public GPUSink {
	public:
	GPUPrecompileTestingSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;

	const char* fileExtension() const override {
	// Suppress writing out results from this config - we just want to do our matching test
	return nullptr;
	}

	private:
	typedef GPUSink INHERITED;
	};

	// This sink attempts to emulate Chrome's OOP-R behavior. It:
	// doesn't use promise images
	// uses only a single thread for both DDL creation & drawing
	class GPUOOPRSink : public GPUSink {
	public:
	GPUOOPRSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;

	private:
	Result ooprDraw(const Src&, sk_sp<SkSurface> dstSurface, GrDirectContext*) const;

	typedef GPUSink INHERITED;
	};

	// This sink attempts to better simulate the Chrome DDL use-case. It:
	// creates the DDLs on separate recording threads
	// performs all the GPU work on a separate GPU thread
	// In the future this should be expanded to:
	// upload on a utility thread w/ access to a shared context
	// compile the programs on the utility thread
	// perform fine grained scheduling of gpu tasks based on their image and program prerequisites
	// create a single "compositing" DDL that is replayed last
	class GPUDDLSink : public GPUSink {
	public:
	GPUDDLSink(const SkCommandLineConfigGpu*, const GrContextOptions&);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;

	private:
	Result ddlDraw(const Src&,
	sk_sp<SkSurface> dstSurface,
	SkTaskGroup* recordingTaskGroup,
	SkTaskGroup* gpuTaskGroup,
	sk_gpu_test::TestContext* gpuTestCtx,
	GrDirectContext* gpuThreadCtx) const;

	std::unique_ptr<SkExecutor> fRecordingExecutor;
	std::unique_ptr<SkExecutor> fGPUExecutor;

	typedef GPUSink INHERITED;
	};

	class PDFSink : public Sink {
	public:
	PDFSink(bool pdfa, SkScalar rasterDpi) : fPDFA(pdfa), fRasterDpi(rasterDpi) {}
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return "pdf"; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
	bool fPDFA;
	SkScalar fRasterDpi;
	};

	class XPSSink : public Sink {
	public:
	XPSSink();

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return "xps"; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
	};

	class RasterSink : public Sink {
	public:
	explicit RasterSink(SkColorType, sk_sp<SkColorSpace> = nullptr);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return "png"; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kRaster, SinkFlags::kDirect }; }

	private:
	SkColorType fColorType;
	sk_sp<SkColorSpace> fColorSpace;
	};

	class ThreadedSink : public RasterSink {
	public:
	explicit ThreadedSink(SkColorType, sk_sp<SkColorSpace> = nullptr);
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	};

	class SKPSink : public Sink {
	public:
	SKPSink();

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return "skp"; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
	};

	class DebugSink : public Sink {
	public:
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return "json"; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }
	};

	class SVGSink : public Sink {
	public:
	SVGSink(int pageIndex = 0);

	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	const char* fileExtension() const override { return "svg"; }
	SinkFlags flags() const override { return SinkFlags{ SinkFlags::kVector, SinkFlags::kDirect }; }

	private:
	int fPageIndex;
	};


	/~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/

	class Via : public Sink {
	public:
	explicit Via(Sink* sink) : fSink(sink) {}
	const char* fileExtension() const override { return fSink->fileExtension(); }
	bool serial() const override { return fSink->serial(); }
	SinkFlags flags() const override {
	SinkFlags flags = fSink->flags();
	flags.approach = SinkFlags::kIndirect;
	return flags;
	}
	protected:
	std::unique_ptr<Sink> fSink;
	};

	class ViaMatrix : public Via {
	public:
	ViaMatrix(SkMatrix, Sink*);
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	private:
	const SkMatrix fMatrix;
	};

	class ViaUpright : public Via {
	public:
	ViaUpright(SkMatrix, Sink*);
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	private:
	const SkMatrix fMatrix;
	};

	class ViaSerialization : public Via {
	public:
	explicit ViaSerialization(Sink* sink) : Via(sink) {}
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	};

	class ViaPicture : public Via {
	public:
	explicit ViaPicture(Sink* sink) : Via(sink) {}
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	};

	class ViaDDL : public Via {
	public:
	ViaDDL(int numReplays, int numDivisions, Sink* sink);
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	private:
	const int fNumReplays;
	const int fNumDivisions;
	};

	class ViaSVG : public Via {
	public:
	explicit ViaSVG(Sink* sink) : Via(sink) {}
	Result draw(const Src&, SkBitmap, SkWStream, SkString*) const override;
	};

	} // namespace DM

	#endif//DMSrcSink_DEFINED