OurPaint/ourpaint.h

/*
* Our Paint: A light weight GPU powered painting program.
* Copyright (C) 2022-2023 Wu Yiming
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "la_5.h"

#ifndef OURPAINT_GIT_BRANCH
#define OURPAINT_GIT_BRANCH "Release 1"
#endif

// No need to show hash when not compiled from git repo.
//#ifndef OURPAINT_GIT_HASH
//#define OURPAINT_GIT_HASH "?"
//#endif

extern unsigned char DATA_SPLASH[];
extern unsigned char DATA_SPLASH_HIGHDPI[];

#ifdef __cplusplus
extern "C" {
#endif
extern const char OUR_SHADER_VERSION_430[];
extern const char OUR_SHADER_VERSION_320ES[];
extern const char OUR_CANVAS_SHADER[];
extern const char OUR_COMPOSITION_SHADER[];
extern const char OUR_SHADER_COMMON[];
extern const char OUR_MIME[];
extern const char OUR_THUMBNAILER[];
extern const char OUR_DESKTOP[];
extern const char OUR_PIGMENT_TEXTURE_MIX_SHADER[];
extern const char OUR_PIGMENT_COMPOSITION_SHADER[];
extern const char OUR_PIGMENT_TEXTURE_DISPLAY_SHADER[];
extern const char OUR_PIGMENT_COMMON[];
#ifdef __cplusplus
} // extern "C"
#endif

#define OUR_AT_CROP_CENTER 0
#define OUR_AT_CROP_L 1
#define OUR_AT_CROP_R 2
#define OUR_AT_CROP_U 3
#define OUR_AT_CROP_B 4
#define OUR_AT_CROP_UL 5
#define OUR_AT_CROP_UR 6
#define OUR_AT_CROP_BL 7
#define OUR_AT_CROP_BR 8

#define OUR_VERSION_MAJOR 0
#define OUR_VERSION_MINOR 5
#define OUR_VERSION_SUB 0

#define OUR_PAINT_NAME_STRING "Our Paint v0.5"

#define OUR_SIGNAL_PICK 1
#define OUR_SIGNAL_MOVE 2
#define OUR_SIGNAL_PICK 3
#define OUR_SIGNAL_TOGGLE_ERASING 4
#define OUR_SIGNAL_ZOOM_IN 5
#define OUR_SIGNAL_ZOOM_OUT 6
#define OUR_SIGNAL_BRUSH_BIGGER 7
#define OUR_SIGNAL_BRUSH_SMALLER 8
#define OUR_SIGNAL_TOGGLE_SKETCH 9
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_0 10
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_1 11
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_2 12
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_3 13
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_4 14
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_5 15
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_6 16
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_7 17
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_8 18
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_9 19
#define OUR_SIGNAL_SELECT_BRUSH_SIZE_FREE 20
#define OUR_SIGNAL_ADJUST 21
#define OUR_SIGNAL_SELECT_BRUSH_ID_0 22
#define OUR_SIGNAL_SELECT_BRUSH_ID_1 23
#define OUR_SIGNAL_SELECT_BRUSH_ID_2 24
#define OUR_SIGNAL_SELECT_BRUSH_ID_3 25
#define OUR_SIGNAL_SELECT_BRUSH_ID_4 26
#define OUR_SIGNAL_SELECT_BRUSH_ID_5 27
#define OUR_SIGNAL_SELECT_BRUSH_ID_6 28
#define OUR_SIGNAL_SELECT_BRUSH_ID_7 29
#define OUR_SIGNAL_SELECT_BRUSH_ID_8 30
#define OUR_SIGNAL_SELECT_BRUSH_ID_9 31

extern laWidget* OUR_WIDGET_PIGMENT;
extern laUiType* _OUR_UI_PIGMENT;

#define OUR_COLOR_PAD_PIGMENT_DATA LA_UI_FLAGS_KNOB

#define OURU Our->u

STRUCTURE(OurCanvasDraw){
    laCanvasExtra Base;
    tnsOffscreen *OffScrSave;
    int HideBrushCircle;
    int AtCrop;
    real CanvasLastX,CanvasLastY;
    real CanvasDownX,CanvasDownY;
    real PointerX,PointerY,DownTilt;
    real LastPressure;
    real LastTilt[2];
    real LastTwist;
    real LastSize;
    int LastNumber;
    int MovedX,MovedY;
};

#define OUR_DPC (600*0.3937007874)

#define OUR_SPECTRAL_SLICES 14

#define OUR_MIXING_SPEED (Our->MixingSpeed/10.0f)

#define OUR_TILE_W 1024
#define OUR_TILES_PER_ROW 100
#define OUR_TILE_CTR (OUR_TILES_PER_ROW/2)
#define OUR_TILE_SEAM 12
#define OUR_TILE_W_USE (OUR_TILE_W-OUR_TILE_SEAM*2)

#define OUR_BRUSH_ACTUAL_SIZE(b) (Our->BrushNumber?Our->BrushBaseSize*pow(2,(real)Our->BrushNumber/2+(b?b->SizeOffset:0)):pow(2,Our->BrushSize+(b?b->SizeOffset:0)))

#ifdef LA_USE_GLES
#define OUR_PIX_COMPACT uint8_t
#define OUR_PIX_MAX 255
#else
#define OUR_PIX_COMPACT uint16_t
#define OUR_PIX_MAX 65535
#endif

STRUCTURE(OurTexTile){
    tnsTexture* Texture;
    OUR_PIX_COMPACT* Data;
    int l,r,u,b;
    OUR_PIX_COMPACT* FullData;
    OUR_PIX_COMPACT* CopyBuffer;
    int cl,cr,cu,cb;
};

#define OUR_BLEND_NORMAL 0
#define OUR_BLEND_ADD 1

typedef struct OurLayerImageSegmented{
    uint32_t Sizes[32];
    int H[32];
    int Count; int Width,Height;
}OurLayerImageSegmented;

STRUCTURE(OurLayer){
    laListItem Item;
    laSafeString* Name;
    int OffsetX,OffsetY;
    real Transparency;
    int Lock;
    int Hide;
    int BlendMode;
    int AsSketch;
    OurTexTile** TexTiles[OUR_TILES_PER_ROW];
    OurLayerImageSegmented ReadSegmented;
};

STRUCTURE(OurLayerWrite){
    unsigned char* data;
    size_t NextData, MaxData;
};

STRUCTURE(OurLayerRead){
    unsigned char* data;
    size_t NextData;
};

STRUCTURE(OurBrushSettingsNode){
    laBaseNode Base;
    laNodeOutSocket* CanvasScale;  real rCanvasScale;
    laNodeOutSocket* Size;         real rSize;
    laNodeOutSocket* Transparency; real rTransparency;
    laNodeOutSocket* Hardness;     real rHardness;
    laNodeOutSocket* Smudge;       real rSmudge;
    laNodeOutSocket* DabsPerSize;  real rDabsPerSize;
    laNodeOutSocket* SmudgeLength; real rSmudgeLength;
    laNodeOutSocket* SmudgeLifting;real rSmudgeLifting;
    laNodeOutSocket* Slender;      real rSlender;
    laNodeOutSocket* Angle;        real rAngle;
    laNodeOutSocket* Gunkyness;    real rGunkyness;
    laNodeOutSocket* Accumulation; real rAccumulation;
    laNodeOutSocket* DepletionSpeed;real rDepletionSpeed;
    laNodeOutSocket* Force;        real rForce;
    laNodeOutSocket* Color;
    laNodeOutSocket* Iteration;    int  rIteration;
    laNodeOutSocket* Custom1;      real rCustom1;
    laNodeOutSocket* Custom2;      real rCustom2;
};
STRUCTURE(OurBrushOutputsNode){
    laBaseNode Base;
    laNodeInSocket* Offset;
    laNodeInSocket* Size;
    laNodeInSocket* Transparency;
    laNodeInSocket* Hardness;
    laNodeInSocket* Smudge;
    laNodeInSocket* DabsPerSize;
    laNodeInSocket* SmudgeLength;
    laNodeInSocket* SmudgeLifting;
    laNodeInSocket* Slender;
    laNodeInSocket* Angle;
    laNodeInSocket* Color;
    laNodeInSocket* Gunkyness;
    laNodeInSocket* Accumulation;
    laNodeInSocket* DepletionSpeed;
    laNodeInSocket* Force;
    laNodeInSocket* Repeats;
    laNodeInSocket* Discard;
};
STRUCTURE(OurBrushDeviceNode){
    laBaseNode Base;
    laNodeOutSocket* Pressure; real rPressure;
    laNodeOutSocket* Position; real rPosition[2];
    laNodeOutSocket* Tilt;     real rTilt[2];
    laNodeOutSocket* Twist;    real rTwist;
    laNodeOutSocket* IsEraser; int  rIsEraser;
    laNodeOutSocket* Speed;    real rSpeed;
    laNodeOutSocket* Angle;    real rAngle;
    laNodeOutSocket* Length;   real rLength;
    laNodeOutSocket* LengthAccum; real rLengthAccum;
    laNodeOutSocket* PigmentLoading; real rPigmentLoading;
};

STRUCTURE(OurBrush){
    laListItem Item;
    laSafeString* Name; int Version;
    real SizeOffset;
    real DabsPerSize;
    real Hardness;
    real Transparency;
    real Smudge,SmudgeLifting;
    real SmudgeResampleLength; real SmudgeAccum; int SmudgeRestart; real BrushRemainingDist;
    real Slender;
    real Angle;
    real Force, Gunkyness;
    real Smoothness;
    real MaxStrokeLength;
    real Custom1,Custom2; laSafeString *Custom1Name,*Custom2Name;
    real Accumulation;
    real DepletionSpeed;
    int Iteration;
    int PressureSize,PressureHardness,PressureTransparency,PressureSmudge,PressureForce,
        TwistAngle,PressureDepletion,PressureAccumulation; // the simple way

    int Binding,DefaultAsEraser;
    int ShowInPages;

    real VisualOffset;
    real VisualOffsetAngle;

    int16_t OffsetFollowPenTilt;
    int16_t UseNodes; // the flexible way
    laRackPage* Rack;

    real LastX,LastY,LastAngle;
    
    real EvalColor[3];
    real EvalOffset[2];
    real EvalSize;
    real EvalDabsPerSize;
    real EvalHardness;
    real EvalTransparency;
    real EvalSmudge;
    real EvalSmudgeLength;
    real EvalSmudgeLifting;
    real EvalSlender;
    real EvalAngle;
    real EvalForce, EvalGunkyness;
    real EvalAccumulation;
    real EvalDepletionSpeed, PigmentLoading;

    real EvalSpeed;
    real EvalStrokeLength;
    real EvalStrokeLengthAccum;
    real EvalPressure;
    real EvalPosition[2];
    real EvalTilt[2];
    real EvalTwist;
    real EvalStrokeAngle;
    int  EvalIsEraser;

    int EvalRepeats;
    int EvalDiscard;
};
STRUCTURE(OurDab){
    float X,Y;
    float Size;
    float Hardness;
    float Smudge, SmudgeLifting; int ResampleSmudge;
    float Color[4];
    float Slender;
    float Angle;
    float Direction[2];
    float Force;
    float Gunkyness;
    float Recentness;
    float Accumulation;
};
STRUCTURE(OurPigmentData){
    real Reflectance[16];
    real Absorption[16];
    real PreviewColor[3][4];
};
STRUCTURE(OurBrushData140){
    float Reflectance[64];
    float Absorption[64];
};
STRUCTURE(OurPigmentData140){
    float Reflectance[64];
    float Absorption[64];
    float PaperReflectance[64];
    float PaperAbsorption[64];
};
STRUCTURE(OurPigment){
    laListItem Item;
    laSafeString* Name;
    OurPigmentData Pigment;
};
STRUCTURE(OurLight){
    laListItem Item;
    laSafeString* Name;
    OurPigmentData Emission;
};
STRUCTURE(OurCanvasSurface){
    laListItem Item;
    laSafeString* Name;
    OurPigmentData Reflectance;
};

NEED_STRUCTURE(OurColorPalette);
STRUCTURE(OurColorItem){
    laListItem Item;
    OurPigmentData Pigment;
    int IsPigment;
    OurColorPalette* Parent;
};
STRUCTURE(OurColorPalette){
    laListItem Item;
    laSafeString* Name;
    laListHandle Colors;
};

STRUCTURE(OurUndoTile){
    laListItem Item;
    int col,row;
    OUR_PIX_COMPACT* CopyData;
    int l,r,u,b;
};
STRUCTURE(OurUndo){
    OurLayer* Layer;
    laListHandle Tiles;
};
STRUCTURE(OurMoveUndo){
    OurLayer* Layer;
    int dx,dy;
};

#define OUR_TOOL_PAINT 0
#define OUR_TOOL_CROP 1
#define OUR_TOOL_MOVE 2

#define OUR_PNG_READ_INPUT_FLAT 0
#define OUR_PNG_READ_INPUT_ICC  1
#define OUR_PNG_READ_INPUT_SRGB 2
#define OUR_PNG_READ_INPUT_LINEAR_SRGB 3
#define OUR_PNG_READ_INPUT_CLAY 4
#define OUR_PNG_READ_INPUT_LINEAR_CLAY 5
#define OUR_PNG_READ_INPUT_D65_P3 6
#define OUR_PNG_READ_INPUT_LINEAR_D65_P3 7

#define OUR_PNG_READ_OUTPUT_CANVAS 0
#define OUR_PNG_READ_OUTPUT_LINEAR_SRGB OUR_PNG_READ_INPUT_LINEAR_SRGB
#define OUR_PNG_READ_OUTPUT_LINEAR_CLAY OUR_PNG_READ_INPUT_LINEAR_CLAY
#define OUR_PNG_READ_OUTPUT_LINEAR_D65_P3 OUR_PNG_READ_INPUT_LINEAR_D65_P3

#define OUR_CANVAS_INTERPRETATION_SRGB 0
#define OUR_CANVAS_INTERPRETATION_CLAY 1
#define OUR_CANVAS_INTERPRETATION_D65_P3 2

#define OUR_EXPORT_BIT_DEPTH_8  0
#define OUR_EXPORT_BIT_DEPTH_16 1

#define OUR_EXPORT_COLOR_MODE_SRGB OUR_CANVAS_INTERPRETATION_SRGB
#define OUR_EXPORT_COLOR_MODE_CLAY OUR_CANVAS_INTERPRETATION_CLAY
#define OUR_EXPORT_COLOR_MODE_D65_P3 OUR_CANVAS_INTERPRETATION_D65_P3
#define OUR_EXPORT_COLOR_MODE_FLAT (OUR_CANVAS_INTERPRETATION_D65_P3+1)

#define OUR_BRUSH_PAGE_LIST 128

STRUCTURE(OurPNGReadExtra){
    int Confirming;
    laSafeString* FilePath;
    laSafeString* iccName;
    int HassRGB;
    int HasProfile;
    int InputMode;
    int OutputMode;
    int Offsets[2];
};
STRUCTURE(OurPNGWriteExtra){
    int Confirming;
    laSafeString* FilePath;
    int BitDepth;
    int ColorProfile;
    int Transparent;
    
    int PigmentConversionMethod;
    int CropX,CropY,CropW,CropH;
};
STRUCTURE(OurThreadExportPNGData){
    uint32_t* r_sizes;
    void** pointers;
    int i;
    int segy,h;
    int fail;
};
typedef void (*our_XYZ2RGBFunc)(tnsVector3d xyz, tnsVector3d rgb);
typedef void (*our_2LogRGBFunc)(tnsVector3d rgb);
typedef real (*our_Pigment2FinalFunc)(real* rgb, OurPigmentData* pd, void* buffer, int64_t index);
STRUCTURE(OurPigmentConversionData){
    int RowStart,RowCount;
    int cols;
    uint16_t *ImageConversionBuffer;
    uint16_t *TextureTileData;
    our_XYZ2RGBFunc XYZ2RGB;
    our_Pigment2FinalFunc Pigment2Final;
    OurPigmentData* canvas;
    real** coeff;
    int SX,SY;
    real alpha;
};
NEED_STRUCTURE(OurThreadImportPNGDataMain);
STRUCTURE(OurThreadImportPNGData){
    OurThreadImportPNGDataMain* main;
    void* data;
    OurLayer* l;
    int starty;
};
STRUCTURE(OurThreadImportPNGDataMain){
    OurThreadImportPNGData* data;
    int next,max;
    SYSLOCK lock;
};

STRUCTURE(OurUsePigment){
    laListItem Item;
    OurPigment* pigment;
};

STRUCTURE(BrushUniforms){
    GLint uCanvasType;
    GLint uCanvasRandom;
    GLint uCanvasFactor;
    GLint uImageOffset;
    GLint uBrushCorner;
    GLint uBrushCenter;
    GLint uBrushSize;
    GLint uBrushHardness;
    GLint uBrushSmudge;
    GLint uBrushRecentness;
    GLint uBrushColor;
    GLint uBrushSlender;
    GLint uBrushAngle;
    GLint uBrushDirection;
    GLint uBrushForce;
    GLint uBrushGunkyness;
    GLint uBrushRoutineSelection;
    GLint uBrushRoutineSelectionES;
    GLint uMixRoutineSelection;
    GLint uMixRoutineSelectionES;
    GLint uBrushErasing;
    GLint uBrushMix;
    GLint uBrushSmudgeLifting;
    GLint RoutineDoDabs;
    GLint RoutineDoSample;
    GLint RoutineDoMixNormal;
    GLint RoutineDoMixSpectral;
    GLint uBlendMode;
    GLint uAlphaTop;
    GLint uAlphaBottom;
    GLsizei SubroutineUniformLocations;
    GLint uMixingTop;
};

STRUCTURE(OurRecentFile){
    laListItem Item;
    laSafeString* Name;
    laSafeString* Path;
};

STRUCTURE(OurPaint){
    real pad;

    laListHandle CanvasSaverDummyList;
    laProp*      CanvasSaverDummyProp;

    laListHandle RecentFiles;
    OurRecentFile* PendingRecentFile;

    laListHandle BadEvents;

    tnsImage* SplashImage;
    tnsImage* SplashImageHigh;

    laListHandle Palettes;
    OurColorPalette* CurrentPalette;

    laListHandle Layers;
    OurLayer*    CurrentLayer;
    laListHandle Brushes;
    OurBrush*    CurrentBrush;
    laListHandle Pigments;
    OurPigment*  CurrentPigment;
    laListHandle Lights;
    laListHandle CanvasSurfaces;
    real SaveBrushSize,SaveEraserSize;
    OurDab* Dabs; int NextDab,MaxDab;
    float LastBrushCenter[2];
    int CanvasVersion;
    int MaxRecentFiles;

    laSafeString* Notes;

    real Smoothness,Hardness;
    real MixingSpeed;
    real LastX, LastY;

    real CurrentScale;
    real DefaultScale;

    int BrushNumber;
    real BrushBaseSize;
    real BrushSize;
    int BrushPage;
    int Tool,ActiveTool,Erasing,EventErasing,BrushMix;
    int LockBackground;
    int BackgroundType;
    int BackgroundRandom;
    real BackgroundFactor;
    OurBrush* PenBrush,*EraserBrush; real LastPigmentLoading;
    int X,Y,W,H; //border
    real BorderFadeWidth;
    int ColorInterpretation;
    int ShowBorder,UseBorder;
    int ShowTiles;
    int BrushCircleTiltMode;
    int AllowNonPressure,PaintProcessedEvents;
    int BadEventsLimit,BadEventCount,BadEventsGiveUp;

    int EnableBrushCircle,ShowBrushName,ShowBrushNumber;
    int EventHasTwist; real EventTwistAngle; real EventTiltOrientation;
    int DefaultBitDepth;
    int DefaultColorProfile;
    int PaintUndoLimit;
    int SpectralMode;
    int PigmentMode;
    int BrushNumbersOnHeader;
    int MixModeOnHeader;
    int ToolsOnHeader;
    int UndoOnHeader;
    int LightsOnHeader;
    int SketchMode;
    int SegmentedWrite;
    int PigmentDisplayMethod;
    int PaletteInColorsPanel;
    int DefaultCanvasType;
    int ToolUndo;

    tnsTexture* SmudgeTexture;
    GLuint CanvasShader;         GLuint CanvasProgram;
    GLuint CanvasStraightShader; GLuint CanvasStraightProgram;
    GLuint CanvasPigmentShader;  GLuint CanvasPigmentProgram;
    GLuint CompositionShader;    GLuint CompositionProgram;
    GLuint CompositionStraightShader; GLuint CompositionStraightProgram;
    GLuint LayerShader;          GLuint LayerProgram;
    GLuint DisplayShader;        GLuint DisplayProgram;
    GLuint PigmentCompositionShader; GLuint PigmentCompositionProgram;
    GLuint PigmentLayeringShader; tnsShader* PigmentLayeringProgramT;
    GLuint PigmentDisplayShader; tnsShader* PigmentDisplayProgramT;
    GLuint uPigmentFragOffset,uPigmentTextureScale,uPigmentDisplayMode;
    GLint uboBrushPigment,uboBrushPigmentLocation;
    GLint uboCanvasPigment,uboCanvasPigmentLocation;

    BrushUniforms *u,uRGBA,uRGBStraightA,uPigment;
    int AlphaMode;
    int ReorderPigmnets;

    OurCanvasSurface *CanvasSurface; // not ptr to list
    OurLight         *CanvasLight;
    OurPigmentData   PickedPigment;
    OurPigmentData   MixedPigment;
    laListHandle     UsePigments;
    OurPigment*   UseWhite;
    OurPigment*   UseBlack;
    int ExposureCompensation;

    real CurrentColor[3];
    real BackgroundColor[3];
    uint16_t BColorU16[4];
    uint8_t  BColorU8[4];
    real BorderAlpha;

    int ShowStripes;
    int ShowGrid;
    int ShowRef;
    int RefSize;
    int RefCategory;
    int RefOrientation;
    int RefCutHalf;
    real RefMargins[3],RefPaddings[2];
    int RefBiases[2];
    real RefAlpha;

    real xmin,xmax,ymin,ymax; // stroke bbox for undo region
    int ResetBrush;
    
    int SaveFailed;
    int FileRegistered;

    uint16_t *ImageBuffer;
    int ImageW,ImageH,ImageX,ImageY,LoadX,LoadY,TempLoadX,TempLoadY;

    uint8_t* ThumbnailBuffer;

    void* icc_LinearsRGB; int iccsize_LinearsRGB;
    void* icc_LinearClay; int iccsize_LinearClay;
    void* icc_LinearD65P3; int iccsize_LinearD65P3;
    void* icc_sRGB; int iccsize_sRGB;
    void* icc_Clay; int iccsize_Clay;
    void* icc_D65P3; int iccsize_D65P3;
    void* ProofTablesRGB, *ProofTableClay, *ProofTableD65;
};

void ourreset_Canvas(OurPaint* op);

int ourProcessInitArgs(int argc, char* argv[]);

int ourInit();
void ourFinalize(int anyload);
void ourRegisterNodes();
int ourRebuildBrushEval();
int ourEvalBrush();
void ourMakeTranslations_zh_hans();
void ourMakeTranslations_es_ES();
void our_EnableSplashPanel();