Subversion Repositories filter_foundry

Rev

Rev 510 | Rev 532 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
259 daniel-mar 1
/*
268 daniel-mar 2
    This file is part of "Filter Foundry", a filter plugin for Adobe Photoshop
312 daniel-mar 3
    Copyright (C) 2003-2009 Toby Thain, toby@telegraphics.com.au
503 daniel-mar 4
    Copyright (C) 2018-2022 Daniel Marschall, ViaThinkSoft
259 daniel-mar 5
 
312 daniel-mar 6
    This program is free software; you can redistribute it and/or modify
7
    it under the terms of the GNU General Public License as published by
8
    the Free Software Foundation; either version 2 of the License, or
9
    (at your option) any later version.
259 daniel-mar 10
 
312 daniel-mar 11
    This program is distributed in the hope that it will be useful,
12
    but WITHOUT ANY WARRANTY; without even the implied warranty of
13
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
    GNU General Public License for more details.
259 daniel-mar 15
 
312 daniel-mar 16
    You should have received a copy of the GNU General Public License
17
    along with this program; if not, write to the Free Software
18
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
259 daniel-mar 19
*/
20
 
21
//#include <stdio.h>
22
//#include <sound.h>
23
 
24
#include "ff.h"
25
 
444 daniel-mar 26
#include "str.h"
259 daniel-mar 27
#include "node.h"
28
#include "funcs.h"
29
#include "y.tab.h"
30
#include "scripting.h"
31
#include <math.h>
32
#include "PIBufferSuite.h"
33
 
34
// GIMP (PSPI) and IrfanView preserve neither *data(gdata), nor pb->parameters between invocations!
35
// For debugging, we can simulate it here
36
//#define DEBUG_SIMULATE_GIMP
37
 
264 daniel-mar 38
// Used to find out which host signatures and memory settings a plugin host has
39
//#define SHOW_HOST_DEBUG
40
 
480 daniel-mar 41
// Here are working variables:
259 daniel-mar 42
struct node *tree[4];
492 daniel-mar 43
TCHAR *err[4];
259 daniel-mar 44
int errpos[4],errstart[4],nplanes,cnvused,chunksize,toprow;
381 daniel-mar 45
uint8_t slider[8]; // this is the "working data". We cannot always use gdata->parm, because parm will not be loaded if a AFS file is read
46
char* expr[4]; // this is the "working data". We cannot always use gdata->parm, because parm will not be loaded if a AFS file is read
301 daniel-mar 47
value_type cell[NUM_CELLS];
480 daniel-mar 48
 
49
// this is the only memory area that keeps preserved by Photoshop:
259 daniel-mar 50
globals_t *gdata;
51
FilterRecordPtr gpb;
52
 
53
#ifdef MAC_ENV
483 daniel-mar 54
#define HINSTANCE HANDLE
55
#define hDllInstance NULL /* fake this Windows-only global */
259 daniel-mar 56
#endif
57
 
58
#ifdef WIN_ENV
59
#include "manifest.h"
60
#endif
61
 
62
extern struct sym_rec predefs[];
63
extern int nplanes,varused[];
64
 
65
int checkandinitparams(Handle params);
66
 
67
// MPW MrC requires prototype
68
DLLEXPORT MACPASCAL
69
void ENTRYPOINT(short selector,FilterRecordPtr pb,intptr_t *data,short *result);
70
 
276 daniel-mar 71
unsigned long get_parm_hash(PARM_T *parm) {
259 daniel-mar 72
        unsigned long hash;
73
        int i;
74
 
393 daniel-mar 75
        hash = djb2(parm->szCategory);
76
        hash += djb2(parm->szTitle);
77
        hash += djb2(parm->szCopyright);
78
        hash += djb2(parm->szAuthor);
79
        for (i = 0; i < 4; i++) hash += djb2(parm->szMap[i]);
80
        for (i = 0; i < 8; i++) hash += djb2(parm->szCtl[i]);
81
        for (i = 0; i < 4; i++) hash += djb2(parm->szFormula[i]);
259 daniel-mar 82
 
83
        return hash;
84
}
85
 
444 daniel-mar 86
size_t get_temp_afs(LPTSTR outfilename, Boolean isStandalone, PARM_T *parm) {
87
        char* atempdir;
373 daniel-mar 88
        int hash;
444 daniel-mar 89
        size_t i, j;
90
        TCHAR out[MAX_PATH + 1];
91
        char ahash[20];
373 daniel-mar 92
 
444 daniel-mar 93
        // out = getenv("TMP")
94
        atempdir = getenv("TMP");
95
        for (i = 0; i < strlen(atempdir); i++) {
96
                out[i] = (TCHAR)atempdir[i];
97
                out[i + 1] = 0;
98
        }
99
 
373 daniel-mar 100
        #ifdef WIN_ENV
444 daniel-mar 101
        if (xstrlen(out) > 0) xstrcat(out, TEXT("\\"));
373 daniel-mar 102
        #else
444 daniel-mar 103
        if (xstrlen(out) > 0) xstrcat(out, TEXT("/"));
373 daniel-mar 104
        #endif
105
 
106
        hash = (isStandalone) ? get_parm_hash(parm) : 0;
444 daniel-mar 107
 
108
        // sprintf(outfilename, "%sFilterFoundry%d.afs", atempdir, hash);
109
        xstrcat(out, TEXT("FilterFoundry"));
110
        _itoa(hash, &ahash[0], 10);
111
        for (i = 0; i < strlen(ahash); i++) {
112
                j = xstrlen(out);
113
                out[j] = (TCHAR)ahash[i];
114
                out[j + 1] = 0;
115
        }
116
        xstrcat(out, TEXT(".afs"));
117
        if (outfilename != NULL) {
118
                xstrcpy(outfilename, out);
119
        }
120
        return xstrlen(out);
373 daniel-mar 121
}
122
 
461 daniel-mar 123
void CALLBACK FakeRundll32(HWND hwnd, HINSTANCE hinst, LPSTR lpszCmdLine, int nCmdShow) {
463 daniel-mar 124
        UNREFERENCED_PARAMETER(hwnd);
125
        UNREFERENCED_PARAMETER(hinst);
126
        UNREFERENCED_PARAMETER(lpszCmdLine);
127
        UNREFERENCED_PARAMETER(nCmdShow);
461 daniel-mar 128
 
462 daniel-mar 129
        /*
463 daniel-mar 130
        char* tmp = (char*)malloc(512);
461 daniel-mar 131
        if (tmp != 0) {
132
                sprintf(tmp, "hwnd: %p\nhinst: %p\nlpszCmdLine: %s\nCmdShow: %d", (void*)(hwnd), (void*)(hinst), lpszCmdLine, nCmdShow);
133
                MessageBoxA(0, tmp, 0, 0);
134
                free(tmp);
135
        }
462 daniel-mar 136
        */
461 daniel-mar 137
 
492 daniel-mar 138
        simplealert_id(MSG_RUNDLL_ERR_ID);
139
 
461 daniel-mar 140
        return;
141
}
142
 
479 daniel-mar 143
void CreateDataPointer(intptr_t* data) {
144
        // Register "gdata" that contains the PARM information and other things which need to be persistant
145
        // and preserve them in *data
146
        // This memory allocation is never freed, because the filter can always be invoked again.
147
        // The memory allocation will be kept for the lifetime of the Photoshop process and
148
        // freed together with the application termination.
149
 
150
        // We have at least 5 options to allocate memory:
480 daniel-mar 151
 
152
        // (Method 1)
481 daniel-mar 153
        // 1. The deprecated Standard Buffer Suite (pb->bufferProcs) - works fine!
486 daniel-mar 154
        /*
155
        BufferID tempId;
156
        if (gpb->bufferProcs->allocateProc(sizeof(globals_t), &tempId) != noErr) {
157
                *data = NULL;
158
        }
159
        else {
160
                *data = (void*)gpb->bufferProcs->lockProc(tempId, true);
161
                if (*data) memset((void*)*data, 0, sizeof(globals_t));
162
        }
163
        */
480 daniel-mar 164
 
165
        // (Method 2) *DOES NOT WORK*
166
        // 2. The recommended buffer suite (kPSBufferSuite),
167
        //    It does not work, since it causes memory corruption when the filter is invoked a second time.
168
        //    Probably the BufferSuite cannot be used to share data between filter invocations?
529 daniel-mar 169
        //    Also, the buffer suite is only available on the Adobe Photoshop host application.
486 daniel-mar 170
        /*
171
        FFBuffer buf;
172
        newBuffer(&buf, sizeof(globals_t));
173
        *data = (intptr_t)lockBuffer(&buf);
174
        if (*data) memset((void*)*data, 0, sizeof(globals_t));
175
        */
480 daniel-mar 176
 
177
        // (Method 3)
479 daniel-mar 178
        // 3. Using malloc(), which works also fine and is more independent from the host. It is also easier.
179
        //    However, we do not know how malloc() is implemented, and it might cause problems if the
180
        //    DLL is unloaded between invocations.
486 daniel-mar 181
        /*
182
        *data = (intptr_t)malloc(sizeof(globals_t));
183
        if (*data) memset((void*)*data, 0, sizeof(globals_t));
184
        */
480 daniel-mar 185
 
186
        // (Method 4)
479 daniel-mar 187
        // 4. Using PLUGIN.DLL:NewPtr(). This does FilterFactory 3.0.4, but requires an Adobe host.
480 daniel-mar 188
        //    In Plugin.dll, the function NewPtr() and NewPtrClear() are implemented as GlobalAlloc/GlobalLock.
189
        //    Nothing special.
190
 
191
        // (Method 5)
479 daniel-mar 192
        // 5. Using GlobalAlloc/GlobalLock. This does FilterFactory 3.00 (Flags GHND = GMEM_MOVEABLE and GMEM_ZEROINIT).
193
        //    This is Windows dependant. (However, on Mac we will just call NewPtr.)
194
        //    GlobalAlloc and LocalAlloc are equal in 32-bit windows. The memory allocation is NOT global anymore,
195
        //    instead it is on the private heap of the application. (Therefore we do not cause a leak when
196
        //    Photoshop is closed).
480 daniel-mar 197
        // In Filter Foundry 1.7.0.17 we define a function called NewPtrClear, which is natively supported by Mac,
198
        // and in Windows it will be implemented using GlobalAlloc/GlobalLock.
479 daniel-mar 199
        *data = (intptr_t)NewPtrClear(sizeof(globals_t));
200
}
201
 
461 daniel-mar 202
DLLEXPORT MACPASCAL
259 daniel-mar 203
void ENTRYPOINT(short selector, FilterRecordPtr pb, intptr_t *data, short *result){
204
        static Boolean wantdialog = false;
205
        static Boolean premiereWarnedOnce = false;
393 daniel-mar 206
 
284 daniel-mar 207
        #ifdef SHOW_HOST_DEBUG
208
        char* tmp;
209
        #endif
268 daniel-mar 210
 
211
        #ifdef WIN_ENV
259 daniel-mar 212
        // For Windows, we use an activation context to enforce that our Manifest resource will
213
        // be used. This allows us to use Visual Styles, even if the host application does not
214
        // support it.
215
        ManifestActivationCtx manifestVars;
216
        BOOL activationContextUsed;
268 daniel-mar 217
        #endif
259 daniel-mar 218
 
284 daniel-mar 219
        // ---------------------------------------------------------------------
220
 
221
        EnterCodeResource();
222
 
283 daniel-mar 223
        #ifdef WIN_ENV
483 daniel-mar 224
        activationContextUsed = ActivateManifest((HMODULE)hDllInstance, 1, &manifestVars);
225
        #endif
226
 
227
        #ifdef WIN_ENV
461 daniel-mar 228
        if ((intptr_t)result == SW_SHOWDEFAULT) {
283 daniel-mar 229
                // When the 8BF file is analyzed with VirusTotal.com, it will invoke each
230
                // exported function by calling
461 daniel-mar 231
                // loaddll64.exe 'C:\Users\user\Desktop\attachment.dll'
232
                //        ==>  rundll32.exe C:\Users\user\Desktop\attachment.dll,PluginMain
233
                //           ==> C:\Windows\system32\WerFault.exe -u -p 6612 -s 480
234
                //
283 daniel-mar 235
                // But RunDLL32 requires following signature:
461 daniel-mar 236
                //    void __stdcall EntryPoint(HWND hwnd,      HINSTANCE hinst,    LPSTR lpszCmdLine, int nCmdShow);
237
                // Our signature is:
238
                //    void           PluginMain(short selector, FilterRecordPtr pb, intptr_t *data,    short *result);
239
                // 
283 daniel-mar 240
                // Obviously, this will cause an Exception. (It crashes at *result=e because result is 0xA)
241
                // Here is the problem: The crash will be handled by WerFault.exe inside the
242
                // VirusTotal virtual machine. WerFault connects to various servers (9 DNS resolutions!) and does
243
                // a lot of weird things, but VirusTotal thinks that our plugin does all that stuff,
244
                // and so they mark our plugin as "malware"!
245
                // This is a problem with VirusTotal! It shall not assume that WerFault.exe actions are our actions!
246
                // Even processes like "MicrosoftEdgeUpdate.exe" and "SpeechRuntime.exe" are reported to be our
247
                // actions, although they have nothing to do with us!
248
                // See https://www.virustotal.com/gui/file/1f1012c567208186be455b81afc1ee407ae6476c197d633c70cc70929113223a/behavior
393 daniel-mar 249
                //
461 daniel-mar 250
                // TODO: Usually, The first 64KB of address space are always invalid. However, in Win32s (Windows 3.11), the
251
                //       variable "result" is <=0xFFFF ! Let's just hope that it is never 0x000A (SW_SHOWDEFAULT),
252
                //       otherwise we have a problem here!
253
                // I don't understand why this works! Aren't we __cdecl and rundll expected __stdcall? But why is the parameter order correct and not reversed?
463 daniel-mar 254
                FakeRundll32((HWND)(intptr_t)selector, (HINSTANCE)pb, (LPSTR)data, (int)(intptr_t)result);
483 daniel-mar 255
                goto endmain;
283 daniel-mar 256
        }
483 daniel-mar 257
        else {
258
                // will be changed if an error happens
259
                *result = noErr;
260
        }
283 daniel-mar 261
        #endif
393 daniel-mar 262
 
264 daniel-mar 263
        #ifdef SHOW_HOST_DEBUG
284 daniel-mar 264
        tmp = (char*)malloc(512);
459 daniel-mar 265
        sprintf(tmp, "Host signature: '%c%c%c%c' (%d)\nMaxSpace32 = %d\nMaxSpace64 = %lld\nNum buffer procs: %d", (pb->hostSig >> 24) & 0xFF, (pb->hostSig >> 16) & 0xFF, (pb->hostSig >> 8) & 0xFF, pb->hostSig & 0xFF, pb->hostSig, pb->maxSpace, pb->maxSpace64, pb->bufferProcs == 0 ? -999/*About has no BufferProcs*/ : pb->bufferProcs->numBufferProcs);
284 daniel-mar 266
        simplealert(tmp);
424 daniel-mar 267
        free(tmp);
264 daniel-mar 268
        #endif
259 daniel-mar 269
 
270
        if (pb->hostSig == HOSTSIG_ADOBE_PREMIERE) {
529 daniel-mar 271
                // DM 19.07.2021 : Tried running the 8BF file in Adobe Premiere 5 + Win98
272
                // (yes, that's possible, and there is even a FilterFactory for Premiere!),
259 daniel-mar 273
                // but it crashes in evalpixel() where there is write-access to the "outp".
491 daniel-mar 274
                // DM 24.04.2022 : On Adobe Premiere 6 + Win10, the filter opens sometimes (and sometimes crashes inside DialogBoxParam),
275
                // but the filter is not applied when you click "OK" (because it crashes internally; only the debugger sees it)...
529 daniel-mar 276
                // Maybe the canvas structure is different (maybe it contains frames to achieve transitions?)
277
                // TODO: make Filter Foundry compatible with Premiere!
259 daniel-mar 278
                if (!premiereWarnedOnce) {
492 daniel-mar 279
                        simplealert_id(MSG_PREMIERE_COMPAT_ID);
259 daniel-mar 280
                }
281
                premiereWarnedOnce = true;
282
                *result = errPlugInHostInsufficient;
483 daniel-mar 283
                goto endmain;
259 daniel-mar 284
        }
285
 
286
        #ifdef DEBUG_SIMULATE_GIMP
287
        *data = 0;
288
        pb->parameters = pb->handleProcs->newProc(1);
289
        #endif
290
 
483 daniel-mar 291
        gpb = pb; // required for CreateDataPointer()
480 daniel-mar 292
 
259 daniel-mar 293
        if (selector != filterSelectorAbout && !*data) {
479 daniel-mar 294
                // The filter was never called before. We allocate (zeroed) memory now.
295
                // Note: gdata->standalone and gdata->parmloaded will be set later
296
                CreateDataPointer(data);
297
                if (!*data) {
298
                        *result = memFullErr;
483 daniel-mar 299
                        goto endmain;
259 daniel-mar 300
                }
301
        }
302
 
479 daniel-mar 303
        gdata = (globals_t*)*data;
304
 
259 daniel-mar 305
        nplanes = MIN(pb->planes,4);
306
 
307
        switch (selector){
308
        case filterSelectorAbout:
309
                if (!gdata) {
479 daniel-mar 310
                        // This is a temporary gdata structure just for the About dialog!
311
                        // Not to be confused with the "real" gdata during the filter invocation (containing more data).
259 daniel-mar 312
                        gdata = (globals_t*)malloc(sizeof(globals_t));
313
                        if (!gdata) break;
411 daniel-mar 314
                        gdata->hWndMainDlg = (HWND)((PlatformData*)((AboutRecordPtr)pb)->platformData)->hwnd; // so that simplealert() works
498 daniel-mar 315
                        gdata->standalone = gdata->parmloaded = readPARMresource((HMODULE)hDllInstance, NULL);
309 daniel-mar 316
                        if (gdata->parmloaded && (gdata->parm.cbSize != PARM_SIZE) && (gdata->parm.cbSize != PARM_SIZE_PREMIERE) && (gdata->parm.cbSize != PARM_SIG_MAC)) {
317
                                if (gdata->obfusc) {
492 daniel-mar 318
                                        simplealert_id(MSG_INCOMPATIBLE_OBFUSCATION_ID);
309 daniel-mar 319
                                }
320
                                else {
492 daniel-mar 321
                                        simplealert_id(MSG_INVALID_PARAMETER_DATA_ID);
309 daniel-mar 322
                                }
323
                        }
324
                        else {
325
                                DoAbout((AboutRecordPtr)pb);
326
                        }
259 daniel-mar 327
                        free(gdata);
328
                        gdata = NULL;
329
                } else {
330
                        DoAbout((AboutRecordPtr)pb);
331
                }
332
                break;
333
        case filterSelectorParameters:
334
                wantdialog = true;
335
                break;
336
        case filterSelectorPrepare:
410 daniel-mar 337
                gdata->hWndMainDlg = 0;
259 daniel-mar 338
                DoPrepare(pb);
339
                init_symtab(predefs); // ready for parser calls
340
                init_trigtab();
341
                break;
342
        case filterSelectorStart:
343
                if (HAS_BIG_DOC(pb)) {
344
                        // The BigDocument structure is required if the document is larger than 30,000 pixels
345
                        // It deprecates imageSize, filterRect, inRect, outRect, maskRect, floatCoord, and wholeSize.
346
                        // By setting it to nonzero, we communicate to Photoshop that we support the BigDocument structure.
347
                        pb->bigDocumentData->PluginUsing32BitCoordinates = true;
348
                }
349
 
350
                /* initialise the parameter handle that Photoshop keeps for us */
351
                if(!pb->parameters)
352
                        pb->parameters = PINEWHANDLE(1); // don't set initial size to 0, since some hosts (e.g. GIMP/PSPI) are incompatible with that.
353
 
482 daniel-mar 354
                if (!pb->parameters) {
483 daniel-mar 355
                        *result = memFullErr;
482 daniel-mar 356
                }
357
                else
358
                {
359
                        wantdialog |= checkandinitparams(pb->parameters);
259 daniel-mar 360
 
482 daniel-mar 361
                        /* wantdialog = false means that we never got a Parameters call, so we're not supposed to ask user */
362
                        if (wantdialog && (!gdata->standalone || gdata->parm.popDialog)) {
363
                                if (maindialog(pb)) {
364
                                        if (!host_preserves_parameters()) {
365
                                                /* Workaround for GIMP/PSPI, to avoid that formulas vanish when you re-open the main window.
366
                                                   The reason is a bug in PSPI: The host should preserve the value of pb->parameters, which PSPI does not do.
367
                                                   Also, all global variables are unloaded, so the plugin cannot preserve any data.
368
                                                   Workaround in FF 1.7: If the host GIMP is detected, then a special mode will be activated.
369
                                                   This mode saves the filter data into a temporary file "FilterFoundryXX.afs" and loads it
370
                                                   when the window is opened again. */
371
                                                   // Workaround: Save settings in "FilterFoundryXX.afs" if the host does not preserve pb->parameters
372
                                                TCHAR outfilename[MAX_PATH + 1];
373
                                                StandardFileReply sfr;
374
                                                char* bakexpr[4];
375
                                                int i;
259 daniel-mar 376
 
482 daniel-mar 377
                                                sfr.sfGood = true;
378
                                                sfr.sfReplacing = true;
379
                                                sfr.sfType = PS_FILTER_FILETYPE;
259 daniel-mar 380
 
482 daniel-mar 381
                                                get_temp_afs(&outfilename[0], gdata->standalone, &gdata->parm);
259 daniel-mar 382
 
482 daniel-mar 383
                                                xstrcpy(sfr.sfFile.szName, outfilename);
384
                                                #ifdef WIN_ENV
385
                                                sfr.nFileExtension = (WORD)(xstrlen(outfilename) - strlen(".afs") + 1);
386
                                                #endif
387
                                                sfr.sfScript = 0; // FIXME: is that ok?
264 daniel-mar 388
 
482 daniel-mar 389
                                                // We only want the parameters (ctl,map) in the temporary .afs file
390
                                                // It is important to remove the expressions, otherwise they would be
391
                                                // revealed in the temporary files.
392
                                                for (i = 0; i < 4; i++) {
393
                                                        bakexpr[i] = expr[i]; // moved out of the if-definition to make the compiler happy
394
                                                }
395
                                                if (gdata->standalone) {
396
                                                        expr[0] = _strdup("r");
397
                                                        expr[1] = _strdup("g");
398
                                                        expr[2] = _strdup("b");
399
                                                        expr[3] = _strdup("a");
400
                                                }
264 daniel-mar 401
 
482 daniel-mar 402
                                                savefile_afs_pff_picotxt(&sfr);
264 daniel-mar 403
 
482 daniel-mar 404
                                                if (gdata->standalone) {
405
                                                        for (i = 0; i < 4; i++) {
406
                                                                if (expr[i]) free(expr[i]);
407
                                                                expr[i] = bakexpr[i];
408
                                                        }
377 daniel-mar 409
                                                }
264 daniel-mar 410
                                        }
482 daniel-mar 411
                                        else {
412
                                                /* update stored parameters from new user settings */
413
                                                if (pb->parameters)
414
                                                        saveparams_afs_pff(pb->parameters);
415
                                        }
259 daniel-mar 416
                                }
482 daniel-mar 417
                                else
483 daniel-mar 418
                                        *result = userCanceledErr;
482 daniel-mar 419
                        }
420
                        wantdialog = false;
259 daniel-mar 421
                }
422
 
483 daniel-mar 423
                if(*result == noErr){
259 daniel-mar 424
                        if(setup(pb)){
425
                                DoStart(pb);
426
                        }else{
510 daniel-mar 427
                                simplealert_id(MSG_SAVED_EXPR_ERR_ID);
483 daniel-mar 428
                                *result = filterBadParameters;
259 daniel-mar 429
                        }
430
                }
431
                break;
432
        case filterSelectorContinue:
483 daniel-mar 433
                *result = DoContinue(pb);
259 daniel-mar 434
                break;
435
        case filterSelectorFinish:
436
                DoFinish(pb);
437
                break;
438
        default:
483 daniel-mar 439
                *result = filterBadParameters;
259 daniel-mar 440
        }
441
 
483 daniel-mar 442
endmain:
259 daniel-mar 443
 
476 daniel-mar 444
        // TODO: Question: Is that OK to call this every invocation, or should it be only around UI stuff?
259 daniel-mar 445
        #ifdef WIN_ENV
446
        if (activationContextUsed) DeactivateManifest(&manifestVars);
447
        #endif
448
 
449
        ExitCodeResource();
450
}
451
 
452
int checkandinitparams(Handle params){
456 daniel-mar 453
        int i;
454
        Boolean bUninitializedParams;
259 daniel-mar 455
        Boolean showdialog;
456
 
457
        if (!host_preserves_parameters()) {
458
                // Workaround: Load settings in "FilterFoundryXX.afs" if host does not preserve pb->parameters
444 daniel-mar 459
                TCHAR outfilename[MAX_PATH + 1];
259 daniel-mar 460
                Boolean isStandalone;
461
                StandardFileReply sfr;
264 daniel-mar 462
                char* bakexpr[4];
463
 
259 daniel-mar 464
                sfr.sfGood = true;
465
                sfr.sfReplacing = true;
466
                sfr.sfType = PS_FILTER_FILETYPE;
467
 
468
                // We need to set gdata->standalone after loadfile(), but we must call readPARMresource() before loadfile()
469
                // Reason: readPARMresource() reads parameters from the DLL while loadfile() reads parameters from the AFS file
470
                // But loadfile() will reset gdata->standalone ...
498 daniel-mar 471
                isStandalone = readPARMresource((HMODULE)hDllInstance, NULL);
309 daniel-mar 472
                if (isStandalone && (gdata->parm.cbSize != PARM_SIZE) && (gdata->parm.cbSize != PARM_SIZE_PREMIERE) && (gdata->parm.cbSize != PARM_SIG_MAC)) {
473
                        if (gdata->obfusc) {
492 daniel-mar 474
                                simplealert_id(MSG_INCOMPATIBLE_OBFUSCATION_ID);
309 daniel-mar 475
                        }
476
                        else {
492 daniel-mar 477
                                simplealert_id(MSG_INVALID_PARAMETER_DATA_ID);
309 daniel-mar 478
                        }
479
                        gdata->parmloaded = false;
480
                        return false;
481
                }
259 daniel-mar 482
 
373 daniel-mar 483
                get_temp_afs(&outfilename[0], isStandalone, &gdata->parm);
259 daniel-mar 484
 
444 daniel-mar 485
                xstrcpy(sfr.sfFile.szName, outfilename);
264 daniel-mar 486
                #ifdef WIN_ENV
444 daniel-mar 487
                sfr.nFileExtension = (WORD)(xstrlen(outfilename) - strlen(".afs") + 1);
264 daniel-mar 488
                #endif
489
                sfr.sfScript = 0; // FIXME: is that ok?
259 daniel-mar 490
 
264 daniel-mar 491
                // We only want the parameters (ctl,map) in the temporary .afs file
492
                if (isStandalone) {
377 daniel-mar 493
                        for (i = 0; i < 4; i++) {
494
                                bakexpr[i] = my_strdup(expr[i]);
495
                        }
264 daniel-mar 496
                }
497
 
498 daniel-mar 498
                if (loadfile(&sfr, NULL)) {
264 daniel-mar 499
                        gdata->standalone = gdata->parmloaded = isStandalone;
500
 
501
                        if (isStandalone) {
377 daniel-mar 502
                                for (i = 0; i < 4; i++) {
503
                                        if (expr[i]) free(expr[i]);
504
                                        expr[i] = bakexpr[i];
505
                                }
259 daniel-mar 506
                        }
264 daniel-mar 507
 
508
                        return true;
259 daniel-mar 509
                }
510
        }
511
 
498 daniel-mar 512
        if( (bUninitializedParams = !(params && readparams_afs_pff(params, NULL))) ){
259 daniel-mar 513
                /* either the parameter handle was uninitialised,
514
                   or the parameter data couldn't be read; set default values */
515
 
516
                // see if saved parameters exist
498 daniel-mar 517
                gdata->standalone = gdata->parmloaded = readPARMresource((HMODULE)hDllInstance, NULL);
309 daniel-mar 518
                if (gdata->parmloaded && (gdata->parm.cbSize != PARM_SIZE) && (gdata->parm.cbSize != PARM_SIZE_PREMIERE) && (gdata->parm.cbSize != PARM_SIG_MAC)) {
519
                        if (gdata->obfusc) {
492 daniel-mar 520
                                simplealert_id(MSG_INCOMPATIBLE_OBFUSCATION_ID);
309 daniel-mar 521
                        }
522
                        else {
492 daniel-mar 523
                                simplealert_id(MSG_INVALID_PARAMETER_DATA_ID);
309 daniel-mar 524
                        }
525
                        gdata->parmloaded = false;
526
                        return false;
527
                }
259 daniel-mar 528
 
529
                if(!gdata->standalone){
530
                        // no saved settings (not standalone)
531
                        for(i = 0; i < 8; ++i)
456 daniel-mar 532
                                slider[i] = (uint8_t)(i*10+100);
259 daniel-mar 533
                        for(i = 0; i < 4; ++i)
534
                                if(expr[i])
535
                                        free(expr[i]);
536
                        if(gpb->imageMode == plugInModeRGBColor){
537
                                expr[0] = _strdup("r");
538
                                expr[1] = _strdup("g");
539
                                expr[2] = _strdup("b");
540
                                expr[3] = _strdup("a");
541
                        }else{
542
                                expr[0] = _strdup("c");
543
                                expr[1] = _strdup("c");
544
                                expr[2] = _strdup("c");
545
                                expr[3] = _strdup("c");
546
                        }
547
                }
548
        }
549
 
550
        // let scripting system change parameters, if we're scripted;
551
        // user may want to force display of dialog during scripting playback
552
        switch (ReadScriptParamsOnRead()) {
553
        case SCR_SHOW_DIALOG:
554
                showdialog = true;
555
                break;
556
        case SCR_HIDE_DIALOG:
557
                showdialog = false;
558
                break;
559
        default:
560
        case SCR_NO_SCRIPT:
561
                showdialog = bUninitializedParams;
562
                break;
563
        }
564
 
482 daniel-mar 565
        if (params) saveparams_afs_pff(params);
259 daniel-mar 566
 
567
        return showdialog;
568
}
569
 
570
Boolean host_preserves_parameters() {
571
        #ifdef DEBUG_SIMULATE_GIMP
572
        return false;
573
        #endif
574
 
575
        if (gpb->hostSig == HOSTSIG_GIMP) return false;
576
        if (gpb->hostSig == HOSTSIG_IRFANVIEW) return false;
577
 
578
        // We just assume the other hosts preserve the parameters
579
        return true;
580
}
581
 
582
int64_t maxspace(){
583
        // Please see "Hosts.md" for details about the MaxSpace implementations of tested plugins
584
 
585
        // Plugins that don't support MaxSpace64 shall set the field to zero; then we will use MaxSpace instead.
586
        // Also check "gpb->bufferProcs->numBufferProcs" to see if 64 bit API is available
587
        if ((gpb->bufferProcs->numBufferProcs >= 8) && (gpb->maxSpace64 > 0)) {
588
                uint64_t maxSpace64 = gpb->maxSpace64;
589
 
590
                return maxSpace64;
591
        } else {
592
                // Note: If maxSpace gets converted from Int32 to unsigned int, we can reach up to 4 GB RAM. However, after this, there will be a wrap to 0 GB again.
593
                unsigned int maxSpace32 = (unsigned int) gpb->maxSpace;
594
                uint64_t maxSpace64 = maxSpace32;
595
 
596
                if (gpb->hostSig == HOSTSIG_IRFANVIEW) maxSpace64 *= 1024; // IrfanView is giving Kilobytes instead of Bytes
597
                //if (gpb->hostSig == HOSTSIG_SERIF_PHOTOPLUS) maxSpace64 *= 1024; // TODO: Serif PhotoPlus also gives Kilobytes instead of bytes. But since it uses not a unique host signature, there is nothing we can do???
598
 
599
                return maxSpace64;
600
        }
601
}
602
 
603
Boolean maxspace_available() {
604
        // Please see "Hosts.md" for details about the MaxSpace implementations of tested plugins
605
 
606
        // GIMP PSPI sets MaxSpace to hardcoded 100 MB
607
        if (gpb->hostSig == HOSTSIG_GIMP) return false;
608
 
609
        // HOSTSIG_PAINT_NET sets MaxSpace to hardcoded 1 GB, see https://github.com/0xC0000054/PSFilterPdn/issues/5
610
        // Comment by the host author "This was done to avoid any compatibility issues with plugins handling 2 GB - 1"
611
        if (gpb->hostSig == HOSTSIG_PAINT_NET) return false;
612
 
613
        return true;
614
}
615
 
616
void DoPrepare(FilterRecordPtr pb){
617
        int i;
618
 
619
        for(i = 4; i--;){
620
                expr[i] = NULL;
621
                tree[i] = NULL;
482 daniel-mar 622
                err[i] = NULL;
259 daniel-mar 623
        }
624
 
625
        // Commented out by DM, 18 Dec 2018:
626
        // This code did not work on systems with 8 GB RAM:
627
        /*
628
        long space = (pb->maxSpace*9)/10; // don't ask for more than 90% of available memory
629
 
630
        maxSpace = 512L<<10; // this is a wild guess, actually
631
        if(maxSpace > space)
632
                        maxSpace = space;
633
        pb->maxSpace = maxSpace;
634
        */
635
 
636
        // New variant:
637
        if (maxspace_available()) {
481 daniel-mar 638
                // don't ask for more than 90% of available memory
639
                int64 ninetyPercent = (int64)ceil((maxspace() / 10.) * 9);
640
                if ((gpb->bufferProcs->numBufferProcs >= 8) && (gpb->maxSpace64 > 0)) {
641
                        pb->maxSpace64 = ninetyPercent;
642
                }
643
                if (ninetyPercent <= 0x7FFFFFFF) {
644
                        pb->maxSpace = (int32)ninetyPercent;
645
                }
259 daniel-mar 646
        }
647
}
648
 
456 daniel-mar 649
void RequestNext(FilterRecordPtr pb){
259 daniel-mar 650
        /* Request next block of the image */
651
 
652
        pb->inLoPlane = pb->outLoPlane = 0;
653
        pb->inHiPlane = pb->outHiPlane = nplanes-1;
654
 
655
        if (HAS_BIG_DOC(pb)) {
656
                // if any of the formulae involve random access to image pixels,
657
                // ask for the entire image
658
                if (needall) {
659
                        SETRECT(BIGDOC_IN_RECT(pb), 0, 0, BIGDOC_IMAGE_SIZE(pb).h, BIGDOC_IMAGE_SIZE(pb).v);
660
                } else {
661
                        // TODO: This does not work with GIMP. So, if we are using GIMP, we should
662
                        //       somehow always use "needall=true", and/or find out why this doesn't work
663
                        //       with GIMP.
664
 
665
                        // otherwise, process the filtered area, by chunksize parts
666
                        BIGDOC_IN_RECT(pb).left = BIGDOC_FILTER_RECT(pb).left;
667
                        BIGDOC_IN_RECT(pb).right = BIGDOC_FILTER_RECT(pb).right;
668
                        BIGDOC_IN_RECT(pb).top = (int32)toprow;
669
                        BIGDOC_IN_RECT(pb).bottom = (int32)MIN(toprow + chunksize, BIGDOC_FILTER_RECT(pb).bottom);
670
 
671
                        if (cnvused) {
672
                                // cnv() needs one extra pixel in each direction
673
                                if (BIGDOC_IN_RECT(pb).left > 0)
674
                                        --BIGDOC_IN_RECT(pb).left;
675
                                if (BIGDOC_IN_RECT(pb).right < BIGDOC_IMAGE_SIZE(pb).h)
676
                                        ++BIGDOC_IN_RECT(pb).right;
677
                                if (BIGDOC_IN_RECT(pb).top > 0)
678
                                        --BIGDOC_IN_RECT(pb).top;
679
                                if (BIGDOC_IN_RECT(pb).bottom < BIGDOC_IMAGE_SIZE(pb).v)
680
                                        ++BIGDOC_IN_RECT(pb).bottom;
681
                        }
682
                }
683
                BIGDOC_OUT_RECT(pb) = BIGDOC_FILTER_RECT(pb);
684
                /*
685
                {char s[0x100];sprintf(s,"RequestNext needall=%d inRect=(%d,%d,%d,%d) filterRect=(%d,%d,%d,%d)",
686
                                needall,
687
                                BIGDOC_IN_RECT(pb).left,BIGDOC_IN_RECT(pb).top,BIGDOC_IN_RECT(pb).right,BIGDOC_IN_RECT(pb).bottom,
688
                                BIGDOC_FILTER_RECT(pb).left,BIGDOC_FILTER_RECT(pb).top,BIGDOC_FILTER_RECT(pb).right,BIGDOC_FILTER_RECT(pb).bottom);dbg(s);}
689
                */
690
        } else {
691
                // if any of the formulae involve random access to image pixels,
692
                // ask for the entire image
693
                if (needall) {
694
                        SETRECT(IN_RECT(pb), 0, 0, IMAGE_SIZE(pb).h, IMAGE_SIZE(pb).v);
695
                }
696
                else {
697
                        // TODO: This does not work with GIMP. So, if we are using GIMP, we should
698
                        //       somehow always use "needall=true", and/or find out why this doesn't work
699
                        //       with GIMP.
700
 
701
                        // otherwise, process the filtered area, by chunksize parts
702
                        IN_RECT(pb).left = FILTER_RECT(pb).left;
703
                        IN_RECT(pb).right = FILTER_RECT(pb).right;
704
                        IN_RECT(pb).top = (int16)toprow;
705
                        IN_RECT(pb).bottom = (int16)MIN(toprow + chunksize, FILTER_RECT(pb).bottom);
706
 
707
                        if (cnvused) {
708
                                // cnv() needs one extra pixel in each direction
709
                                if (IN_RECT(pb).left > 0)
710
                                        --IN_RECT(pb).left;
711
                                if (IN_RECT(pb).right < IMAGE_SIZE(pb).h)
712
                                        ++IN_RECT(pb).right;
713
                                if (IN_RECT(pb).top > 0)
714
                                        --IN_RECT(pb).top;
715
                                if (IN_RECT(pb).bottom < IMAGE_SIZE(pb).v)
716
                                        ++IN_RECT(pb).bottom;
717
                        }
718
                }
719
                OUT_RECT(pb) = FILTER_RECT(pb);
720
                /*
721
                {char s[0x100];sprintf(s,"RequestNext needall=%d inRect=(%d,%d,%d,%d) filterRect=(%d,%d,%d,%d)",
722
                                needall,
723
                                IN_RECT(pb).left,IN_RECT(pb).top,IN_RECT(pb).right,IN_RECT(pb).bottom,
724
                                FILTER_RECT(pb).left,FILTER_RECT(pb).top,FILTER_RECT(pb).right,FILTER_RECT(pb).bottom);dbg(s);}
725
                */
726
        }
727
}
728
 
729
void DoStart(FilterRecordPtr pb){
264 daniel-mar 730
        /* Global variable "needall": if src() or rad() functions are used, random access to the image data is required,
731
           so we must request the entire image in a single chunk, otherwise we will use chunksize "CHUNK_ROWS". */
259 daniel-mar 732
        if (HAS_BIG_DOC(pb)) {
733
                chunksize = needall ? (BIGDOC_FILTER_RECT(pb).bottom - BIGDOC_FILTER_RECT(pb).top) : CHUNK_ROWS;
734
                toprow = BIGDOC_FILTER_RECT(pb).top;
735
        } else {
736
                chunksize = needall ? (FILTER_RECT(pb).bottom - FILTER_RECT(pb).top) : CHUNK_ROWS;
737
                toprow = FILTER_RECT(pb).top;
738
        }
456 daniel-mar 739
        RequestNext(pb);
259 daniel-mar 740
}
741
 
742
OSErr DoContinue(FilterRecordPtr pb){
743
        OSErr e = noErr;
744
        long outoffset;
745
 
746
        if (HAS_BIG_DOC(pb)) {
747
                VRect fr;
748
                if (needall) {
749
                        fr = BIGDOC_FILTER_RECT(pb);  // filter whole selection at once
750
                } else if (cnvused) {
751
                        // we've requested one pixel extra all around
752
                        // (see RequestNext()), just for access purposes. But filter
753
                        // original selection only.
754
                        fr.left = BIGDOC_FILTER_RECT(pb).left;
755
                        fr.right = BIGDOC_FILTER_RECT(pb).right;
756
                        fr.top = toprow;
757
                        fr.bottom = MIN(toprow + chunksize, BIGDOC_FILTER_RECT(pb).bottom);
758
                } else {  // filter whatever portion we've been given
759
                        fr = BIGDOC_IN_RECT(pb);
760
                }
761
 
762
                outoffset = (long)pb->outRowBytes * (fr.top - BIGDOC_OUT_RECT(pb).top)
763
                        + (long)nplanes * (fr.left - BIGDOC_OUT_RECT(pb).left);
764
 
765
                if (!(e = process_scaled_bigdoc(pb, true, fr, fr,
766
                        (Ptr)pb->outData + outoffset, pb->outRowBytes, 1.)))
767
                {
768
                        toprow += chunksize;
769
                        if (toprow < BIGDOC_FILTER_RECT(pb).bottom)
456 daniel-mar 770
                                RequestNext(pb);
259 daniel-mar 771
                        else {
772
                                SETRECT(BIGDOC_IN_RECT(pb), 0, 0, 0, 0);
773
                                BIGDOC_OUT_RECT(pb) = BIGDOC_MASK_RECT(pb) = BIGDOC_IN_RECT(pb);
774
                        }
775
                }
776
        } else {
777
                Rect fr;
778
                if (needall) {
779
                        fr = FILTER_RECT(pb);  // filter whole selection at once
780
                } else if (cnvused) {
781
                        // we've requested one pixel extra all around
782
                        // (see RequestNext()), just for access purposes. But filter
783
                        // original selection only.
784
                        fr.left = FILTER_RECT(pb).left;
785
                        fr.right = FILTER_RECT(pb).right;
786
                        fr.top = toprow;
787
                        fr.bottom = MIN(toprow + chunksize, FILTER_RECT(pb).bottom);
788
                } else {  // filter whatever portion we've been given
789
                        fr = IN_RECT(pb);
790
                }
791
 
792
                outoffset = (long)pb->outRowBytes*(fr.top - OUT_RECT(pb).top)
793
                        + (long)nplanes*(fr.left - OUT_RECT(pb).left);
794
 
795
                if(!(e = process_scaled_olddoc(pb, true, fr, fr,
796
                        (Ptr)pb->outData+outoffset, pb->outRowBytes, 1.)))
797
                {
798
                        toprow += chunksize;
799
                        if(toprow < FILTER_RECT(pb).bottom)
456 daniel-mar 800
                                RequestNext(pb);
259 daniel-mar 801
                        else{
802
                                SETRECT(IN_RECT(pb),0,0,0,0);
803
                                OUT_RECT(pb) = MASK_RECT(pb) = IN_RECT(pb);
804
                        }
805
                }
806
        }
807
        return e;
808
}
809
 
810
void DoFinish(FilterRecordPtr pb){
811
        int i;
812
 
433 daniel-mar 813
        UNREFERENCED_PARAMETER(pb);
814
 
259 daniel-mar 815
        WriteScriptParamsOnRead();
816
 
817
        for(i = 4; i--;){
818
                freetree(tree[i]);
819
                if(expr[i]) free(expr[i]);
820
        }
821
}
379 daniel-mar 822
 
430 daniel-mar 823
InternalState saveInternalState() {
824
        InternalState ret;
379 daniel-mar 825
        int i;
826
 
827
        ret.bak_obfusc = gdata->obfusc;
828
        ret.bak_standalone = gdata->standalone;
829
        ret.bak_parmloaded = gdata->parmloaded;
830
        memcpy(&ret.bak_parm, &gdata->parm, sizeof(PARM_T));
831
        for (i = 0; i < 4; i++) ret.bak_expr[i] = my_strdup(expr[i]);
832
        for (i = 0; i < 8; i++) ret.bak_slider[i] = slider[i];
833
 
834
        return ret;
835
}
836
 
430 daniel-mar 837
void restoreInternalState(InternalState state) {
379 daniel-mar 838
        int i;
839
        gdata->obfusc = state.bak_obfusc;
840
        gdata->standalone = state.bak_standalone;
841
        gdata->parmloaded = state.bak_parmloaded;
842
        memcpy(&gdata->parm, &state.bak_parm, sizeof(PARM_T));
843
        for (i = 0; i < 4; i++) {
844
                if (expr[i]) free(expr[i]);
845
                expr[i] = state.bak_expr[i];
846
        }
847
        for (i = 0; i < 8; i++) {
848
                slider[i] = state.bak_slider[i];
849
        }
850
}