Subversion Repositories filter_foundry

/*

    This file is part of "Filter Foundry", a filter plugin for Adobe Photoshop

    Copyright (C) 2003-2009 Toby Thain, toby@telegraphics.com.au

    Copyright (C) 2018-2021 Daniel Marschall, ViaThinkSoft

    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 2 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, write to the Free Software

    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/

//#include <stdio.h>

//#include <sound.h>

#include "ff.h"

#include "node.h"

#include "funcs.h"

#include "y.tab.h"

#include "scripting.h"

#include <math.h>

struct node *tree[4];

char *err[4];

int errpos[4],errstart[4],nplanes,cnvused,chunksize,toprow;

value_type slider[8],cell[NUM_CELLS],map[4][0x100];

char *expr[4];

// long maxSpace;

globals_t *gdata;

FilterRecordPtr gpb;

#ifdef MAC_ENV

        #define HINSTANCE HANDLE

        #define hDllInstance NULL /* fake this Windows-only global */

#endif

#ifdef WIN_ENV

#include "manifest.h"

#endif

extern struct sym_rec predefs[];

extern int nplanes,varused[];

int checkandinitparams(Handle params);

// MPW MrC requires prototype

DLLEXPORT MACPASCAL

void ENTRYPOINT(short selector,FilterRecordPtr pb,intptr_t *data,short *result);

DLLEXPORT MACPASCAL

void ENTRYPOINT(short selector, FilterRecordPtr pb, intptr_t *data, short *result){

        static Boolean wantdialog = false;

        static Boolean premiereWarnedOnce = false;

        OSErr e = noErr;

        char *reason;

#ifdef WIN_ENV

        // For Windows, we use an activation context to enforce that our Manifest resource will

        // be used. This allows us to use Visual Styles, even if the host application does not

        // support it.

        ManifestActivationCtx manifestVars;

        BOOL activationContextUsed;

#endif

        /*

        char* s = (char*)malloc(512);

        sprintf(s, "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->numBufferProcs);

        simplealert(s);

        */

        if (pb->hostSig == HOSTSIG_ADOBE_PREMIERE) {

                // DM 19.07.2021 : Tried running the 8BF file in Adobe Premiere 5 (yes, that's possible,

                // and there is even a FilterFactory for Premeire!),

                // but it crashes in evalpixel() where there is write-access to the "outp".

                // Probably the canvas structure is different (maybe it contains frames to achieve transitions?)

                if (!premiereWarnedOnce) {

                        simplealert("This version of Filter Foundry is not compatible with Adobe Premiere!");

                }

                premiereWarnedOnce = true;

                *result = filterBadParameters;

                return;

        }

#ifdef WIN_ENV

        activationContextUsed = ActivateManifest((HMODULE)hDllInstance, 1, &manifestVars);

#endif

        if(selector != filterSelectorAbout && !*data){

                BufferID tempId;

                if( (*result = PS_BUFFER_ALLOC(sizeof(globals_t), &tempId)) ) {

#ifdef WIN_ENV

                        if (activationContextUsed) DeactivateManifest(&manifestVars);

#endif

                        return;

                }

                *data = (intptr_t)PS_BUFFER_LOCK(tempId, true);

                gdata = (globals_t*)*data;

                gdata->standalone = gdata->parmloaded = false;

        } else {

                gdata = (globals_t*)*data;

        }

        EnterCodeResource();

        gpb = pb;

        nplanes = MIN(pb->planes,4);

        switch (selector){

        case filterSelectorAbout:

                if (!gdata) {

                        gdata = (globals_t*)malloc(sizeof(globals_t));

                        if (!gdata) break;

                        gdata->standalone = gdata->parmloaded = readPARMresource((HMODULE)hDllInstance,&reason,READ_OBFUSC);

                        DoAbout((AboutRecordPtr)pb);

                        free(gdata);

                        gdata = NULL;

                } else {

                        DoAbout((AboutRecordPtr)pb);

                }

                break;

        case filterSelectorParameters:

                wantdialog = true;

                break;

        case filterSelectorPrepare:

                DoPrepare(pb);

                init_symtab(predefs); // ready for parser calls

                init_trigtab();

                break;

        case filterSelectorStart:

                /* initialise the parameter handle that Photoshop keeps for us */

                if(!pb->parameters)

                        pb->parameters = PINEWHANDLE(1); // don't set initial size to 0, since some hosts (e.g. GIMP/PSPI) are incompatible with that.

                wantdialog |= checkandinitparams(pb->parameters);

                /* wantdialog = false means that we never got a Parameters call, so we're not supposed to ask user */

                if( wantdialog && (!gdata->standalone || gdata->parm.popDialog) ){

                        if( maindialog(pb) ){

                                if (!host_preserves_parameters()) {

                                        /* Workaround for GIMP/PSPI, to avoid that formulas vanish when you re-open the main window.

                                           The reason is a bug in PSPI: The host should preserve the value of pb->parameters, which PSPI does not do.

                                           Also, all global variables are unloaded, so the plugin cannot preserve any data.

                                           Workaround in FF 1.7: If the host GIMP is detected, then a special mode will be activated.

                                           This mode saves the filter data into a temporary file "FilterFoundry.afs" and loads it

                                           when the window is opened again. */

                                        // Workaround: Save settings in "FilterFoundry.afs" if the host does not preserve pb->parameters

                                        char outfilename[255];

                                        char* tempdir;

                                        StandardFileReply sfr;

                                        sfr.sfGood = true;

                                        sfr.sfReplacing = true;

                                        sfr.sfType = PS_FILTER_FILETYPE;

                                        tempdir = getenv("TMP");

                                        #ifdef WIN_ENV

                                        if (strlen(tempdir) > 0) strcat(tempdir, "\\");

                                        #else

                                        if (strlen(tempdir) > 0) strcat(tempdir, "/");

                                        #endif

                                        sprintf(outfilename, "%sFilterFoundry.afs", tempdir);

                                        myc2pstrcpy(sfr.sfFile.name, outfilename);

                                        #ifdef WIN_ENV

                                        sfr.nFileExtension = (WORD)(strlen(outfilename) - strlen(".afs"));

                                        #endif

                                        sfr.sfScript = 0; // FIXME: is that ok?

                                        savefile(&sfr);

                                }

                                /* update stored parameters from new user settings */

                                saveparams(pb->parameters);

                        }else

                                e = userCanceledErr;

                }

                wantdialog = false;

                if(!e){

                        if(setup(pb)){

                                DoStart(pb);

                        }else{

                                SYSBEEP(1);

                                e = filterBadParameters;

                        }

                }

                break;

        case filterSelectorContinue:

                e = DoContinue(pb);

                break;

        case filterSelectorFinish:

                DoFinish(pb);

                break;

        default:

                e = filterBadParameters;

        }

        *result = e;

#ifdef WIN_ENV

        if (activationContextUsed) DeactivateManifest(&manifestVars);

#endif

        ExitCodeResource();

}

int checkandinitparams(Handle params){

        char *reasonstr,*reason;

        int i,bUninitializedParams;

        Boolean showdialog;

        if (!host_preserves_parameters()) {

                // Workaround: Load settings in "FilterFoundry.afs" if host does not preserve pb->parameters

                char outfilename[255];

                char* tempdir;

                StandardFileReply sfr;

                sfr.sfGood = true;

                sfr.sfReplacing = true;

                sfr.sfType = PS_FILTER_FILETYPE;

                tempdir = getenv("TMP");

                #ifdef WIN_ENV

                if (strlen(tempdir) > 0) strcat(tempdir, "\\");

                #else

                if (strlen(tempdir) > 0) strcat(tempdir, "/");

                #endif

                sprintf(outfilename, "%sFilterFoundry.afs", tempdir);

                myc2pstrcpy(sfr.sfFile.name, outfilename);

                #ifdef WIN_ENV

                sfr.nFileExtension = (WORD)(strlen(outfilename) - strlen(".afs"));

                #endif

                sfr.sfScript = 0; // FIXME: is that ok?

                if (loadfile(&sfr, &reason)) return true;

        }

        if( (bUninitializedParams = !(params && readparams(params,false,&reasonstr))) ){

                /* either the parameter handle was uninitialised,

                   or the parameter data couldn't be read; set default values */

                // see if saved parameters exist

                gdata->standalone = gdata->parmloaded = readPARMresource((HMODULE)hDllInstance,&reason,READ_OBFUSC);

                if(!gdata->standalone){

                        // no saved settings (not standalone)

                        for(i = 0; i < 8; ++i)

                                slider[i] = i*10+100;

                        for(i = 0; i < 4; ++i)

                                if(expr[i])

                                        free(expr[i]);

                        if(gpb->imageMode == plugInModeRGBColor){

                                expr[0] = _strdup("r");

                                expr[1] = _strdup("g");

                                expr[2] = _strdup("b");

                                expr[3] = _strdup("a");

                        }else{

                                expr[0] = _strdup("c");

                                expr[1] = _strdup("c");

                                expr[2] = _strdup("c");

                                expr[3] = _strdup("c");

                        }

                }

        }

        // let scripting system change parameters, if we're scripted;

        // user may want to force display of dialog during scripting playback

        switch (ReadScriptParamsOnRead()) {

                case SCR_SHOW_DIALOG:

                        showdialog = true;

                        break;

                case SCR_HIDE_DIALOG:

                        showdialog = false;

                        break;

                default:

                case SCR_NO_SCRIPT:

                        showdialog = bUninitializedParams;

                        break;

        }

        saveparams(params);

        return showdialog;

}

Boolean host_preserves_parameters() {

        if (gpb->hostSig == HOSTSIG_GIMP) return false;

        if (gpb->hostSig == HOSTSIG_IRFANVIEW) return false;

        /*

        char x[100];

        sprintf(x, "Host Signature: %u", gpb->hostSig);

        simplealert(x);

        */

        // We just assume the other hosts preserve the parameters

        return true;

}

int64_t maxspace(){

        // Please see "Hosts.md" for details about the MaxSpace implementations of tested plugins

        // Plugins that don't support MaxSpace64 shall set the field to zero; then we will use MaxSpace instead.

        // Also check "gpb->bufferProcs->numBufferProcs" to see if 64 bit API is available

        if ((gpb->bufferProcs->numBufferProcs >= 8) && (gpb->maxSpace64 > 0)) {

                uint64_t maxSpace64 = gpb->maxSpace64;

                return maxSpace64;

        } else {

                // 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.

                unsigned int maxSpace32 = (unsigned int) gpb->maxSpace;

                uint64_t maxSpace64 = maxSpace32;

                if (gpb->hostSig == HOSTSIG_IRFANVIEW) maxSpace64 *= 1024; // IrfanView is giving Kilobytes instead of Bytes

                //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???

                return maxSpace64;

        }

}

Boolean maxspace_available() {

        // Please see "Hosts.md" for details about the MaxSpace implementations of tested plugins

        // GIMP PSPI sets MaxSpace to hardcoded 100 MB

        if (gpb->hostSig == HOSTSIG_GIMP) return false;

        // HOSTSIG_PAINT_NET sets MaxSpace to hardcoded 1 GB, see https://github.com/0xC0000054/PSFilterPdn/issues/5

        // Comment by the host author "This was done to avoid any compatibility issues with plugins handling 2 GB - 1"

        if (gpb->hostSig == HOSTSIG_PAINT_NET) return false;

        return true;

}

void DoPrepare(FilterRecordPtr pb){

        int i;

        for(i = 4; i--;){

                if(expr[i]||tree[i]) DBG("expr[] or tree[] non-NULL in Prepare!");

                expr[i] = NULL;

                tree[i] = NULL;

        }

        // Commented out by DM, 18 Dec 2018:

        // This code did not work on systems with 8 GB RAM:

        /*

        long space = (pb->maxSpace*9)/10; // don't ask for more than 90% of available memory

        maxSpace = 512L<<10; // this is a wild guess, actually

        if(maxSpace > space)

                maxSpace = space;

        pb->maxSpace = maxSpace;

        */

        // New variant:

        if (maxspace_available()) {

                pb->maxSpace = (int32)ceil((maxspace()/10.)*9); // don't ask for more than 90% of available memory

                // FIXME: Also maxSpace64

        }

}

void RequestNext(FilterRecordPtr pb,long toprow){

        /* Request next block of the image */

        pb->inLoPlane = pb->outLoPlane = 0;

        pb->inHiPlane = pb->outHiPlane = nplanes-1;

        // if any of the formulae involve random access to image pixels,

        // ask for the entire image

        if(needall){

                SETRECT(pb->inRect,0,0,pb->imageSize.h,pb->imageSize.v);

        }else{

                // TODO: This does not work with GIMP. So, if we are using GIMP, we should

                //       somehow always use "needall=true", and/or find out why this doesn't work

                //       with GIMP.

                // otherwise, process the filtered area, by chunksize parts

                pb->inRect.left = pb->filterRect.left;

                pb->inRect.right = pb->filterRect.right;

                pb->inRect.top = (int16)toprow;

                pb->inRect.bottom = (int16)MIN(toprow + chunksize,pb->filterRect.bottom);

                if(cnvused){

                        // cnv() needs one extra pixel in each direction

                        if(pb->inRect.left > 0)

                                --pb->inRect.left;

                        if(pb->inRect.right < pb->imageSize.h)

                                ++pb->inRect.right;

                        if(pb->inRect.top > 0)

                                --pb->inRect.top;

                        if(pb->inRect.bottom < pb->imageSize.v)

                                ++pb->inRect.bottom;

                }

        }

        pb->outRect = pb->filterRect;

/*

{char s[0x100];sprintf(s,"RequestNext needall=%d inRect=(%d,%d,%d,%d) filterRect=(%d,%d,%d,%d)",

        needall,

        pb->inRect.left,pb->inRect.top,pb->inRect.right,pb->inRect.bottom,

        pb->filterRect.left,pb->filterRect.top,pb->filterRect.right,pb->filterRect.bottom);dbg(s);}

*/

}

void DoStart(FilterRecordPtr pb){

//dbg("DoStart");

        /* if src() or rad() functions are used, random access to the image data is required,

           so we must request the entire image in a single chunk. */

        chunksize = needall ? (pb->filterRect.bottom - pb->filterRect.top) : CHUNK_ROWS;

        toprow = pb->filterRect.top;

        RequestNext(pb,toprow);

}

OSErr DoContinue(FilterRecordPtr pb){

        OSErr e = noErr;

        Rect fr;

        long outoffset;

        if(needall)

                fr = pb->filterRect;  // filter whole selection at once

        else if(cnvused){

                // we've requested one pixel extra all around

                // (see RequestNext()), just for access purposes. But filter

                // original selection only.

                fr.left = pb->filterRect.left;

                fr.right = pb->filterRect.right;

                fr.top = toprow;

                fr.bottom = MIN(toprow + chunksize,pb->filterRect.bottom);

        }else  // filter whatever portion we've been given

                fr = pb->inRect;

        outoffset = (long)pb->outRowBytes*(fr.top - pb->outRect.top)

                                + (long)nplanes*(fr.left - pb->outRect.left);

        if(!(e = process_scaled(pb, true, &fr, &fr,

                                (Ptr)pb->outData+outoffset, pb->outRowBytes, 1.)))

        {

                toprow += chunksize;

                if(toprow < pb->filterRect.bottom)

                        RequestNext(pb,toprow);

                else{

                        SETRECT(pb->inRect,0,0,0,0);

                        pb->outRect = pb->maskRect = pb->inRect;

                }

        }

        return e;

}

void DoFinish(FilterRecordPtr pb){

        int i;

        WriteScriptParamsOnRead();

        for(i = 4; i--;){

                freetree(tree[i]);

                if(expr[i]) free(expr[i]);

        }

}