include/draw/surface.h

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef DRAWING_SURFACE_H
#define DRAWING_SURFACE_H

#include "impl_interface/surface_impl.h"

#include "draw/canvas.h"
#include "image/bitmap.h"
#include "image/image.h"
#include "utils/drawing_macros.h"

namespace OHOS {
namespace Rosen {
namespace Drawing {

#ifdef RS_ENABLE_GPU
struct FrameBuffer {
    int width;
    int height;
    int FBOID;
    int Format;
    ColorType colorType = Drawing::COLORTYPE_RGBA_8888;
    std::shared_ptr<GPUContext> gpuContext;
    std::shared_ptr<ColorSpace> colorSpace;
};
#endif

struct FlushInfo {
    bool backendSurfaceAccess = false;
    size_t numSemaphores = 0;
    void* backendSemaphore = nullptr;
    void (*finishedProc)(void* finishedContext) = nullptr;
    void* finishedContext = nullptr;
    void (*submittedProc)(void* finishedContext, bool success) = nullptr;
    void* submittedContext = nullptr;
};

enum class BackendAccess {
    FLUSH_READ,
    FLUSH_WRITE,
    DISCARD_WRITE
};

enum class SemaphoresSubmited {
    DRAWING_SUBMIT_NO, // Drawing flush callback not executd.
    DRAWING_SUBMIT_YES, // Drawing flush callback executed.
    DRAWING_ENGINE_SUBMIT_NO, // Engine flush has callback parameters and return values.
    DRAWING_ENGINE_SUBMIT_YES, // Engine flush has callback parameters and return values.
    DRAWING_ENGINE_YES // Engine flush has no callback parameters and return values.
};

class DRAWING_API Surface {
public:
    Surface();
    ~Surface() {}

    /**
     * @brief         Bind raster Surface.
     * @param bitmap  Raster pixel array.
     * @return        true if Bind success.
     */
    bool Bind(const Bitmap& bitmap);

#ifdef RS_ENABLE_GPU
    /**
     * @brief         Bind GPU texture Surface.
     * @param image   In GPU memory as a GPU texture.
     * @return        true if Bind success.
     */
    bool Bind(const Image& image);

    /**
     * @brief       Bind
     * @param info  FrameBuffer object info.
     * @return      true if Bind success.
     */
    bool Bind(const FrameBuffer& frameBuffer);

#ifdef RS_ENABLE_VK
    static std::shared_ptr<Surface> MakeFromBackendRenderTarget(GPUContext* gpuContext, const TextureInfo& info,
        TextureOrigin origin, ColorType colorType, std::shared_ptr<ColorSpace> colorSpace,
        void (*deleteVkImage)(void *), void* cleanHelper);
#endif
    static std::shared_ptr<Surface> MakeFromBackendTexture(GPUContext* gpuContext, const TextureInfo& info,
        TextureOrigin origin, int sampleCnt, ColorType colorType,
        std::shared_ptr<ColorSpace> colorSpace, void (*deleteVkImage)(void *), void* cleanHelper);

    /**
     * @brief              Create Surface from gpuContext and imageInfo.
     * @param gpuContext   GPU texture.
     * @param budgeted     Texture count.
     * @param imageInfo    image Info.
     * @return             A shared pointer to Surface.
     */
    static std::shared_ptr<Surface> MakeRenderTarget(GPUContext* gpuContext, bool budgeted, const ImageInfo& imageInfo);
#endif

    /**
     * @brief              Allocates raster Surface.
     * @param imageInfo    image info.
     * @return             A shared pointer to Surface.
     */
    static std::shared_ptr<Surface> MakeRaster(const ImageInfo& imageInfo);

    /**
     * @brief              Allocates raster direct Surface.
     * @param imageInfo    image info.
     * @param pixels       Pointer to destination pixels buffer.
     * @param rowBytes     Interval from one Surface row to the next.
     * @return             A shared pointer to Surface.
     */
    static std::shared_ptr<Surface> MakeRasterDirect(const ImageInfo& imageInfo, void* pixels, size_t rowBytes);

    /**
     * @brief          Create Surface using width and height.
     * @param width    Pixel column count.
     * @param height   Pixel row count.
     * @return         A shared pointer to Surface.
     */
    static std::shared_ptr<Surface> MakeRasterN32Premul(int32_t width, int32_t height);

    /**
     * @brief   Gets Canvas that draws into Surface.
     */
    std::shared_ptr<Canvas> GetCanvas();

    /**
     * @brief   Gets Image capturing Surface contents.
     * @return  A shared pointer to Image
     */
    std::shared_ptr<Image> GetImageSnapshot() const;

    /**
     * @brief         Gets Image capturing Surface contents.
     * @param bounds  Bounds.
     *                If bounds extends beyond the Surface, it will be trimmed to just the intersection of it
     *                and the Surface.
     *                If bounds does not intersect the surface, then this returns nullptr.
     *                If bounds == the surface, then this is the same as calling the no-parameter variant.
     * @param allowRefCache  Whether to use cache.
                             Use False, if you want to change the effect directly on this Snapshot
     * @return        A shared pointer to Image
     */
    std::shared_ptr<Image> GetImageSnapshot(const RectI& bounds, bool allowRefCache = true) const;

    /**
     * @brief         Returns a compatible Surface, with the specified width and height.
     * @param width   surface width
     * @param height  surface height
     * @return        A shared pointer to Surface
     */
    std::shared_ptr<Surface> MakeSurface(int width, int height) const;

    /**
     * @brief         Returns a compatible Surface, with the specified width and height.
     * @param imageinfo   surface imageinfo
     * @return        A shared pointer to Surface
     */
    std::shared_ptr<Surface> MakeSurface(const ImageInfo& imageinfo) const;

    /**
     * @brief   Gets ImageInfo of Surface.
     * @return  ImageInfo
     */
    ImageInfo GetImageInfo();

    /**
     * @brief         Gets BackendTexture of Surface.
     * @param access  backend access mode, default as FLUSH_READ
     * @return        BackendTexture
     */
    BackendTexture GetBackendTexture(BackendAccess access = BackendAccess::FLUSH_READ) const;

    /**
     * @brief   Call to ensure all reads/writes of surface have been issue to the underlying 3D API.
     */
    void FlushAndSubmit(bool syncCpu = false);

    /**
     * @brief   Call to ensure all reads/writes of surface have been issue to the underlying 3D API.
     */
    SemaphoresSubmited Flush(FlushInfo *drawingflushInfo = nullptr);

    int Width() const;
    int Height() const;

    template<typename T>
    T* GetImpl() const
    {
        return impl_->DowncastingTo<T>();
    }

#ifdef RS_ENABLE_GL
    void Wait(const std::vector<GrGLsync>& syncs);
#endif

#ifdef RS_ENABLE_VK
    void Wait(int32_t time, const VkSemaphore& semaphore);
    void SetDrawingArea(const std::vector<RectI>& rects);
    void ClearDrawingArea();
#endif

    /**
     * @brief         Set headroom for backendTexture of Surface.
     * @param headroom  headroom value
     */
    void SetHeadroom(float headroom);

    /**
     * @brief         Get headroom for backendTexture of Surface.
     * @return        headroom value
     */
    float GetHeadroom() const;

private:
    std::shared_ptr<SurfaceImpl> impl_;
    std::shared_ptr<Canvas> cachedCanvas_;
};
} // namespace Drawing
} // namespace Rosen
} // namespace OHOS
#endif