reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef GrYUVProvider_DEFINED |
| 9 | #define GrYUVProvider_DEFINED |
| 10 | |
| 11 | #include "GrTypes.h" |
| 12 | #include "SkImageInfo.h" |
Jim Van Verth | e24b587 | 2018-10-29 16:26:02 -0400 | [diff] [blame] | 13 | #include "SkYUVAIndex.h" |
| 14 | #include "SkYUVASizeInfo.h" |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 15 | |
| 16 | class GrContext; |
Greg Daniel | 4065d45 | 2018-11-16 15:43:41 -0500 | [diff] [blame] | 17 | class GrBackendFormat; |
Brian Salomon | f4a00e4 | 2018-03-23 15:15:03 -0400 | [diff] [blame] | 18 | struct GrSurfaceDesc; |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 19 | class GrTexture; |
Brian Salomon | c65aec9 | 2017-03-09 09:03:58 -0500 | [diff] [blame] | 20 | class GrTextureProxy; |
Robert Phillips | b4a8eac | 2018-09-21 08:26:33 -0400 | [diff] [blame] | 21 | class SkCachedData; |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * There are at least 2 different ways to extract/retrieve YUV planar data... |
| 25 | * - SkPixelRef |
Brian Osman | ef90ae4 | 2017-04-24 09:30:24 -0400 | [diff] [blame] | 26 | * - SkImageGenerator |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 27 | * |
| 28 | * To share common functionality around using the planar data, we use this abstract base-class |
| 29 | * to represent accessing that data. |
| 30 | */ |
| 31 | class GrYUVProvider { |
| 32 | public: |
| 33 | virtual ~GrYUVProvider() {} |
| 34 | |
| 35 | /** |
Robert Phillips | 538f1a3 | 2017-03-08 14:32:55 -0500 | [diff] [blame] | 36 | * On success, this returns a texture proxy that has converted the YUV data from the provider |
Greg Daniel | 1445da6 | 2018-01-04 10:27:29 -0500 | [diff] [blame] | 37 | * into a form that is supported by the GPU (typically transformed into RGB). The texture will |
| 38 | * automatically have a key added, so it can be retrieved from the cache (assuming it is |
| 39 | * requested by a provider w/ the same genID). If srcColorSpace and dstColorSpace are |
| 40 | * specified, then a color conversion from src to dst will be applied to the pixels. |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 41 | * |
| 42 | * On failure (e.g. the provider had no data), this returns NULL. |
| 43 | */ |
Greg Daniel | 4065d45 | 2018-11-16 15:43:41 -0500 | [diff] [blame] | 44 | sk_sp<GrTextureProxy> refAsTextureProxy(GrContext*, |
| 45 | const GrBackendFormat&, |
| 46 | const GrSurfaceDesc&, |
Brian Osman | 861ea5b | 2018-06-14 09:14:03 -0400 | [diff] [blame] | 47 | SkColorSpace* srcColorSpace, |
| 48 | SkColorSpace* dstColorSpace); |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 49 | |
Jim Van Verth | e24b587 | 2018-10-29 16:26:02 -0400 | [diff] [blame] | 50 | sk_sp<SkCachedData> getPlanes(SkYUVASizeInfo*, SkYUVAIndex[SkYUVAIndex::kIndexCount], |
| 51 | SkYUVColorSpace*, const void* planes[SkYUVASizeInfo::kMaxCount]); |
Robert Phillips | b4a8eac | 2018-09-21 08:26:33 -0400 | [diff] [blame] | 52 | |
| 53 | private: |
| 54 | virtual uint32_t onGetID() const = 0; |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 55 | |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 56 | // These are not meant to be called by a client, only by the implementation |
| 57 | |
| 58 | /** |
msarett | 4984c3c | 2016-03-10 05:44:43 -0800 | [diff] [blame] | 59 | * If decoding to YUV is supported, this returns true. Otherwise, this |
| 60 | * returns false and does not modify any of the parameters. |
| 61 | * |
Jim Van Verth | 8f11e43 | 2018-10-18 14:36:59 -0400 | [diff] [blame] | 62 | * @param sizeInfo Output parameter indicating the sizes and required |
| 63 | * allocation widths of the Y, U, V, and A planes. |
| 64 | * @param yuvaIndices How the YUVA planes are used/organized |
| 65 | * @param colorSpace Output parameter. |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 66 | */ |
Jim Van Verth | e24b587 | 2018-10-29 16:26:02 -0400 | [diff] [blame] | 67 | virtual bool onQueryYUVA8(SkYUVASizeInfo* sizeInfo, |
Jim Van Verth | 8f11e43 | 2018-10-18 14:36:59 -0400 | [diff] [blame] | 68 | SkYUVAIndex yuvaIndices[SkYUVAIndex::kIndexCount], |
| 69 | SkYUVColorSpace* colorSpace) const = 0; |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 70 | |
| 71 | /** |
msarett | 4984c3c | 2016-03-10 05:44:43 -0800 | [diff] [blame] | 72 | * Returns true on success and false on failure. |
| 73 | * This always attempts to perform a full decode. If the client only |
Jim Van Verth | 8f11e43 | 2018-10-18 14:36:59 -0400 | [diff] [blame] | 74 | * wants size, it should call onQueryYUVA8(). |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 75 | * |
Jim Van Verth | 8f11e43 | 2018-10-18 14:36:59 -0400 | [diff] [blame] | 76 | * @param sizeInfo Needs to exactly match the values returned by the |
| 77 | * query, except the WidthBytes may be larger than the |
| 78 | * recommendation (but not smaller). |
| 79 | * @param yuvaIndices How the YUVA planes are used/organized |
| 80 | * @param planes Memory for each of the Y, U, V, and A planes. |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 81 | */ |
Jim Van Verth | e24b587 | 2018-10-29 16:26:02 -0400 | [diff] [blame] | 82 | virtual bool onGetYUVA8Planes(const SkYUVASizeInfo& sizeInfo, |
Jim Van Verth | 8f11e43 | 2018-10-18 14:36:59 -0400 | [diff] [blame] | 83 | const SkYUVAIndex yuvaIndices[SkYUVAIndex::kIndexCount], |
| 84 | void* planes[]) = 0; |
Greg Daniel | fb3abcd | 2018-02-02 15:48:33 -0500 | [diff] [blame] | 85 | |
Greg Daniel | fb3abcd | 2018-02-02 15:48:33 -0500 | [diff] [blame] | 86 | // This is used as release callback for the YUV data that we capture in an SkImage when |
| 87 | // uploading to a gpu. When the upload is complete and we release the SkImage this callback will |
| 88 | // release the underlying data. |
| 89 | static void YUVGen_DataReleaseProc(const void*, void* data); |
reed | 43fe618 | 2015-09-08 08:37:36 -0700 | [diff] [blame] | 90 | }; |
| 91 | |
| 92 | #endif |