//========================================================================

//

// Splash.h

//

//========================================================================

//========================================================================

//

// Modified under the Poppler project - http://poppler.freedesktop.org

//

// All changes made under the Poppler project to this file are licensed

// under GPL version 2 or later

//

// Copyright (C) 2005 Marco Pesenti Gritti <mpg@redhat.com>

// Copyright (C) 2007, 2011, 2018, 2019, 2021, 2022, 2025, 2026 Albert Astals Cid <aacid@kde.org>

// Copyright (C) 2010-2013, 2015 Thomas Freitag <Thomas.Freitag@alfa.de>

// Copyright (C) 2010 Christian Feuersänger <cfeuersaenger@googlemail.com>

// Copyright (C) 2012, 2017 Adrian Johnson <ajohnson@redneon.com>

// Copyright (C) 2020 Oliver Sander <oliver.sander@tu-dresden.de>

// Copyright (C) 2020 Tobias Deiminger <haxtibal@posteo.de>

// Copyright (C) 2026 Taufeeque Sifat <entity069@protonmail.com>

// Copyright (C) 2026 Stefan Brüns <stefan.bruens@rwth-aachen.de>

//

// To see a description of the changes please see the Changelog file that

// came with your tarball or type make ChangeLog if you are building from git

//

//========================================================================

#ifndef SPLASH_H

#define SPLASH_H

#include "SplashTypes.h"

#include "SplashClip.h"

#include "SplashPattern.h"

#include "poppler_private_export.h"

class SplashBitmap;

struct SplashGlyphBitmap;

class SplashState;

class SplashScreen;

class SplashPath;

class SplashXPath;

class SplashFont;

struct SplashPipe;

//------------------------------------------------------------------------

// Retrieves the next line of pixels in an image mask.  Normally,

// fills in *<line> and returns true.  If the image stream is

// exhausted, returns false.

using SplashImageMaskSource = bool (*)(void *data, SplashColorPtr pixel);

// Retrieves the next line of pixels in an image.  Normally, fills in

// *<line> and returns true.  If the image stream is exhausted,

// returns false.

using SplashImageSource = bool (*)(void *data, SplashColorPtr colorLine, unsigned char *alphaLine);

// Use ICCColorSpace to transform a bitmap

using SplashICCTransform = void (*)(void *data, SplashBitmap *bitmap);

//------------------------------------------------------------------------

enum SplashPipeResultColorCtrl

{

    splashPipeResultColorNoAlphaBlendCMYK,

    splashPipeResultColorNoAlphaBlendDeviceN,

    splashPipeResultColorNoAlphaBlendRGB,

    splashPipeResultColorNoAlphaBlendMono,

    splashPipeResultColorAlphaNoBlendMono,

    splashPipeResultColorAlphaNoBlendRGB,

    splashPipeResultColorAlphaNoBlendCMYK,

    splashPipeResultColorAlphaNoBlendDeviceN,

    splashPipeResultColorAlphaBlendMono,

    splashPipeResultColorAlphaBlendRGB,

    splashPipeResultColorAlphaBlendCMYK,

    splashPipeResultColorAlphaBlendDeviceN

};

//------------------------------------------------------------------------

// Splash

//------------------------------------------------------------------------

class POPPLER_PRIVATE_EXPORT Splash

{

public:

    // Create a new rasterizer object.

    Splash(SplashBitmap *bitmapA, bool vectorAntialiasA, SplashScreenParams *screenParams = nullptr);

    Splash(SplashBitmap *bitmapA, bool vectorAntialiasA, const SplashScreen &screenA);

    ~Splash();

    Splash(const Splash &) = delete;

    Splash &operator=(const Splash &) = delete;

    //----- state read

    const std::array<double, 6> &getMatrix() const;

    SplashPattern *getStrokePattern();

    SplashPattern *getFillPattern();

    const SplashScreen &getScreen() const;

    SplashBlendFunc getBlendFunc();

    double getStrokeAlpha();

    double getFillAlpha();

    double getLineWidth();

    SplashLineCap getLineCap();

    SplashLineJoin getLineJoin();

    double getMiterLimit();

    double getFlatness();

    double getLineDashPhase();

    bool getStrokeAdjust();

    const SplashClip &getClip() const;

    SplashBitmap *getSoftMask();

    bool getInNonIsolatedGroup();

    bool getInKnockoutGroup();

    //----- state write

    void setMatrix(const std::array<double, 6> &matrix);

    void setStrokePattern(SplashPattern *strokePattern);

    void setFillPattern(SplashPattern *fillPattern);

    void setBlendFunc(SplashBlendFunc func);

    void setStrokeAlpha(double alpha);

    void setFillAlpha(double alpha);

    void setPatternAlpha(double strokeAlpha, double fillAlpha);

    void clearPatternAlpha();

    void setFillOverprint(bool fop);

    void setStrokeOverprint(bool sop);

    void setOverprintMode(int opm);

    void setLineWidth(double lineWidth);

    void setLineCap(SplashLineCap lineCap);

    void setLineJoin(SplashLineJoin lineJoin);

    void setMiterLimit(double miterLimit);

    void setFlatness(double flatness);

    // the <lineDash> array will be copied

    void setLineDash(std::vector<double> &&lineDash, double lineDashPhase);

    void setStrokeAdjust(bool strokeAdjust);

    // NB: uses transformed coordinates.

    void clipResetToRect(double x0, double y0, double x1, double y1);

    // NB: uses transformed coordinates.

    SplashError clipToRect(double x0, double y0, double x1, double y1);

    // NB: uses untransformed coordinates.

    SplashError clipToPath(const SplashPath &path, bool eo);

    void setSoftMask(SplashBitmap *softMask);

    void setInTransparencyGroup(SplashBitmap *groupBackBitmapA, int groupBackXA, int groupBackYA, bool nonIsolated, bool knockout);

    void setTransfer(unsigned char *red, unsigned char *green, unsigned char *blue, unsigned char *gray);

    void setOverprintMask(unsigned int overprintMask, bool additive);

    //----- state save/restore

    void saveState();

    SplashError restoreState();

    //----- drawing operations

    // Fill the bitmap with <color>.  This is not subject to clipping.

    void clear(SplashColorPtr color, unsigned char alpha = 0x00);

    // Stroke a path using the current stroke pattern.

    SplashError stroke(const SplashPath &path);

    // Fill a path using the current fill pattern.

    SplashError fill(SplashPath *path, bool eo);

    // Draw a character, using the current fill pattern.

    SplashError fillChar(double x, double y, int c, SplashFont *font);

    // Draw a glyph, using the current fill pattern.  This function does

    // not free any data, i.e., it ignores glyph->freeData.

    void fillGlyph(double x, double y, SplashGlyphBitmap *glyph);

    // Draws an image mask using the fill color.  This will read <h>

    // lines of <w> pixels from <src>, starting with the top line.  "1"

    // pixels will be drawn with the current fill color; "0" pixels are

    // transparent.  The matrix:

    //    [ mat[0] mat[1] 0 ]

    //    [ mat[2] mat[3] 0 ]

    //    [ mat[4] mat[5] 1 ]

    // maps a unit square to the desired destination for the image, in

    // PostScript style:

    //    [x' y' 1] = [x y 1] * mat

    // Note that the Splash y axis points downward, and the image source

    // is assumed to produce pixels in raster order, starting from the

    // top line.

    SplashError fillImageMask(SplashImageMaskSource src, void *srcData, int w, int h, const std::array<double, 6> &mat, bool glyphMode);

    // Draw an image.  This will read <h> lines of <w> pixels from

    // <src>, starting with the top line.  These pixels are assumed to

    // be in the source mode, <srcMode>.  If <srcAlpha> is true, the

    // alpha values returned by <src> are used; otherwise they are

    // ignored.  The following combinations of source and target modes

    // are supported:

    //    source       target

    //    ------       ------

    //    Mono1        Mono1

    //    Mono8        Mono1   -- with dithering

    //    Mono8        Mono8

    //    RGB8         RGB8

    //    BGR8         BGR8

    //    CMYK8        CMYK8

    // The matrix behaves as for fillImageMask.

    SplashError drawImage(SplashImageSource src, SplashICCTransform tf, void *srcData, SplashColorMode srcMode, bool srcAlpha, int w, int h, const std::array<double, 6> &mat, bool interpolate, bool tilingPattern = false);

    // Composite a rectangular region from <src> onto this Splash

    // object.

    SplashError composite(const SplashBitmap &src, int xSrc, int ySrc, int xDest, int yDest, int w, int h, bool noClip, bool nonIsolated, bool knockout = false, double knockoutOpacity = 1.0);

    // Composite this Splash object onto a background color.  The

    // background alpha is assumed to be 1.

    void compositeBackground(SplashColorConstPtr color);

    // Copy a rectangular region from <src> onto the bitmap belonging to

    // this Splash object.  On success, the destination alpha values are all set to

    // zero.

    SplashError blitTransparent(const SplashBitmap &src, int xSrc, int ySrc, int xDest, int yDest, int w, int h);

    void blitImage(const SplashBitmap &src, bool srcAlpha, int xDest, int yDest);

    // Copy a rectangular region from the current bitmap to <dest>,

    // correcting the alpha values for a non-isolated transparency group

    // nested inside another non-isolated group.

    SplashError blitCorrectedAlpha(SplashBitmap *dest, int xSrc, int ySrc, int xDest, int yDest, int w, int h);

    //----- misc

    // Construct a path for a stroke, given the path to be stroked and

    // the line width <w>.  All other stroke parameters are taken from

    // the current state.  If <flatten> is true, this function will

    // first flatten the path and handle the linedash.

    std::unique_ptr<SplashPath> makeStrokePath(const SplashPath &path, double w, bool flatten = true);

    // Return the associated bitmap.

    SplashBitmap *getBitmap() { return bitmap; }

    // Set the minimum line width.

    void setMinLineWidth(double w) { minLineWidth = w; }

    // Setter/Getter for thin line mode

    void setThinLineMode(SplashThinLineMode thinLineModeA) { thinLineMode = thinLineModeA; }

    SplashThinLineMode getThinLineMode() { return thinLineMode; }

    // Get clipping status for the last drawing operation subject to

    // clipping.

    SplashClipResult getClipRes() { return opClipRes; }

    // Toggle debug mode on or off.

    void setDebugMode(bool debugModeA) { debugMode = debugModeA; }

    void setInShading(bool sh) { inShading = sh; }

    bool getVectorAntialias() const { return vectorAntialias; }

    void setVectorAntialias(bool vaa) { vectorAntialias = vaa; }

    // Do shaded fills with dynamic patterns

    //

    // clipToStrokePath: Whether the current clip region is a stroke path.

    //   In that case, strokeAlpha is used rather than fillAlpha.

    SplashError shadedFill(const SplashPath &path, bool hasBBox, const SplashPattern &pattern, bool clipToStrokePath);

    // Draw a gouraud triangle shading.

    bool gouraudTriangleShadedFill(SplashGouraudColor *shading);

private:

    void pipeInit(SplashPipe *pipe, int x, int y, const SplashPattern *pattern, SplashColorPtr cSrc, unsigned char aInput, bool usesShape, bool nonIsolatedGroup, bool knockout = false, unsigned char knockoutOpacity = 255);

    void pipeRun(SplashPipe *pipe);

    void pipeRunSimpleMono1(SplashPipe *pipe);

    void pipeRunSimpleMono8(SplashPipe *pipe);

    void pipeRunSimpleRGB8(SplashPipe *pipe);

    void pipeRunSimpleXBGR8(SplashPipe *pipe);

    void pipeRunSimpleBGR8(SplashPipe *pipe);

    void pipeRunSimpleCMYK8(SplashPipe *pipe);

    void pipeRunSimpleDeviceN8(SplashPipe *pipe);

    void pipeRunAAMono1(SplashPipe *pipe);

    void pipeRunAAMono8(SplashPipe *pipe);

    void pipeRunAARGB8(SplashPipe *pipe);

    void pipeRunAAXBGR8(SplashPipe *pipe);

    void pipeRunAABGR8(SplashPipe *pipe);

    void pipeRunAACMYK8(SplashPipe *pipe);

    void pipeRunAADeviceN8(SplashPipe *pipe);

    void pipeSetXY(SplashPipe *pipe, int x, int y);

    void pipeIncX(SplashPipe *pipe);

    void drawPixel(SplashPipe *pipe, int x, int y, bool noClip);

    void drawAAPixelInit();

    void drawAAPixel(SplashPipe *pipe, int x, int y);

    void drawSpan(SplashPipe *pipe, int x0, int x1, int y, bool noClip);

    void drawAALine(SplashPipe *pipe, int x0, int x1, int y, bool adjustLine = false, unsigned char lineOpacity = 0);

    static void transform(const std::array<double, 6> &matrix, double xi, double yi, double *xo, double *yo);

    void strokeNarrow(const SplashPath &path);

    void strokeWide(const SplashPath &path, double w);

    static std::unique_ptr<SplashPath> flattenPath(const SplashPath &path, const std::array<double, 6> &matrix, double flatness);

    static void flattenCurve(double x0, double y0, double x1, double y1, double x2, double y2, double x3, double y3, const std::array<double, 6> &matrix, double flatness2, SplashPath *fPath);

    std::unique_ptr<SplashPath> makeDashedPath(const SplashPath &xPath);

    void getBBoxFP(const SplashPath &path, double *xMinA, double *yMinA, double *xMaxA, double *yMaxA);

    SplashError fillWithPattern(SplashPath *path, bool eo, SplashPattern *pattern, double alpha);

    bool pathAllOutside(const SplashPath &path);

    void fillGlyph2(int x0, int y0, SplashGlyphBitmap *glyph, bool noclip);

    void arbitraryTransformMask(SplashImageMaskSource src, void *srcData, int srcWidth, int srcHeight, const std::array<double, 6> &mat, bool glyphMode);

    static std::unique_ptr<SplashBitmap> scaleMask(SplashImageMaskSource src, void *srcData, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight);

    static void scaleMaskYdownXdown(SplashImageMaskSource src, void *srcData, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static void scaleMaskYdownXup(SplashImageMaskSource src, void *srcData, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static void scaleMaskYupXdown(SplashImageMaskSource src, void *srcData, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static void scaleMaskYupXup(SplashImageMaskSource src, void *srcData, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    void blitMask(const SplashBitmap &src, int xDest, int yDest, SplashClipResult clipRes);

    SplashError arbitraryTransformImage(SplashImageSource src, SplashICCTransform tf, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, const std::array<double, 6> &mat, bool interpolate,

                                        bool tilingPattern = false);

    std::unique_ptr<SplashBitmap> scaleImage(SplashImageSource src, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, bool interpolate,

                                             bool tilingPattern = false);

    static bool scaleImageYdownXdown(SplashImageSource src, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static bool scaleImageYdownXup(SplashImageSource src, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static bool scaleImageYupXdown(SplashImageSource src, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static bool scaleImageYupXup(SplashImageSource src, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static bool scaleImageYupXupBilinear(SplashImageSource src, void *srcData, SplashColorMode srcMode, int nComps, bool srcAlpha, int srcWidth, int srcHeight, int scaledWidth, int scaledHeight, SplashBitmap *dest);

    static void vertFlipImage(SplashBitmap *img, int width, int height, int nComps);

    void blitImage(const SplashBitmap &src, bool srcAlpha, int xDest, int yDest, SplashClipResult clipRes);

    void blitImageClipped(const SplashBitmap &src, bool srcAlpha, int xSrc, int ySrc, int xDest, int yDest, int w, int h);

    static void dumpPath(const SplashPath &path);

    static void dumpXPath(const SplashXPath &path);

    static SplashPipeResultColorCtrl pipeResultColorNoAlphaBlend[];

    static SplashPipeResultColorCtrl pipeResultColorAlphaNoBlend[];

    static SplashPipeResultColorCtrl pipeResultColorAlphaBlend[];

    static int pipeNonIsoGroupCorrection[];

    SplashBitmap *bitmap;

    SplashState *state;

    SplashBitmap *aaBuf;

    int aaBufY;

    SplashBitmap *alpha0Bitmap; // for non-isolated groups, this is the

                                //   bitmap containing the alpha0 values

    int alpha0X, alpha0Y; // offset within alpha0Bitmap

    double minLineWidth;

    SplashThinLineMode thinLineMode;

    SplashClipResult opClipRes;

    SplashBitmap *groupBackBitmap; // backdrop bitmap for knockout/non-isolated groups

    int groupBackX, groupBackY; // offset within groupBackBitmap

    bool vectorAntialias;

    bool inShading;

    bool debugMode;

};

#endif