I would also mention a creature feature to help eliminate mouse clicking and typing would be for the .xcf file and exported png/jpg to pickup/use the folder name...in which....should already be named movie/tv show (date) and construct filenames based on that with the proper index concatenated.

So if I was building a clearart file located in a proper movie name like: After Earth (2013)

When the export is ready, it would generate the files:

After Earth (2013).xcf
After Earth (2013)-clearart.png

I was also thinking about the index 4, makes sense in this stage, a bonus would be when the save/export is called, that all of the art types are represented with checkboxes defaulted to FALSE and when you select a single only checkmark, it uses that checkmarks index to output the appropriate file naming convention.

I am looking at everything here and its a pretty sweet so far, thanks for the assist on this, it would have been very difficult to even get to where this is at now as I'm learning this from scratch. So thank you for your efforts.

Chris

I'm getting this error:

> (KodiSkinPath (gimp-image-get-id) (ReadKodiSaveArtType))
Error: eval: unbound variable: read-line

Using Windows 10.

TY.

KodiSave 1.1 + I/O read-line

I forgot read-line from the I/O library powered by Richard O'Keefe in the Indiana University Bloomington repository.
Because this library is included with credits in my GimpLambdaLib 0ts-stdio.scm

So I removed my entire GimpLambdaLib to keep only KodiSave.scm version 1.1 pusblished in GimpChat page 1.
read-line has been added at the end of this script. So you do not need to install the GimpLambdaLib.

I found that the Gimp status bar is very volatile.
The KodiSave message is often overwritten by any other messages if the user moves the mouse pointer.


So, in 1.1, the KodiSave message is also displayed in the Error console even if it is not an error.
To open the Gimp Error console, click Gimp menu "Windows" > "Dockable Dialogs" > "Error Console".
KodiSave will display its message of export in a persistent way until you clear the Error Console.

I will analyse your detailed requirements #10 and #11 soon.

KodiSave 1.5 with dialog box for art type = clearart

KodiSave 1.5 with dialog box strongly simplifies the Scheme code since the text file KodiSaveArtType.txt is no longer required.
Hence the I/O library for Script-Fu has been removed.
However you would select the art type in the dlgbox if you wish to change it.




Checkboxes in Gimp Script-Fu are defined by SF-TOGGLE. However the user could check more than one art type.
I prefer a listbox more easier to be coded in only one line since the vector of art type already exists since version 1.0

1. In File Explorer, navigate in Movies\Aliens (1986)
   Drag & drop for example iconAlien.png in the Gimp empty editor.
   This icon has been generated by AI-based Bing Image Creator from a textual description then modified in Gimp.
2. Click menu KodiSave
3. The Script-Fu:KodiSave dlgbox pop-ups. Click the listbox down arrow.
4. Select your art type such as "clearart"
5. Click OK

_____

Once you confirmed the saving of .xcf and the export to .png:

1. A message is displayed in the Error Console as a Warning.
   It is the only way that I know to display a persistent message.
2. The Movies\Aliens (1986) folder is populated with the .xcf and .png
   Note that the basename includes the name of the movie.
3. Close the current image with the shortcut Ctrl+W

Next movie

1. In the File Explorer, go up to the parent folder: Movies
2. Click the next movie

____________
art type = poster

1. From the File Explorer, drag your media.
2. And drop it on the Wilber icon in the Gimp Toolbox.
3. Click menu KodiSave
4. The Script-Fu:KodiSave dlgbox pop-ups. Click the listbox down arrow.
5. Select another art type such as "poster"
6. Click OK

____________
poster => .jpg

1. The Kodi menu has been clicked in the previous step.
2. A message is displayed in the Error Console as a Warning.
   Pay attention that for this art type, the file extension is .jpg instead of .png
3. The Movies\Avatar (2009) folder is populated with the .xcf and .jpg

Note: saving a picture in .jpg destroys a little bit its quality at each saving.

In the Script-Fu console if you click the Browse button for the function file-jpeg-save, you could read its help:

quality = 0.97 More the quality is close to 100% more the .jpg is big.
Tune other parameters since I never save in .jpg format. I prefer the Google format Web Photo: .webp

Once you saved .xcf and exported .png or .jpg according to the art type,
do you go to the next movie or you prefer to keep the current image in the Gimp editor for example to improve the .xcf
Give details how you switch between movies.

Do you wish to persist the shape of the last selection between two movies?
What kind of basic editing could be scripted?

I just gave it a whirl....very nice...easy to use.

I made some changes to the array image types, see code below.

I also moved the location to the file menu as that is where I would put it (I understand current location makes access easy)

For the FanartSharp, the # sign is actually used for a place holder to support multiple fanart images as there can be more than one. There is always fanart.jpg.... always, media companion (which I use) offers up to 10 additional.... so there should/could be up to 10 more images in the folder. So it would look like fanart1.jpg, fanart2.jpg, fanart3.jpg, fanart4.jpg......and so on.

So I think it would need a modification so if in the pulldown you select fanart for the output of the image, then it enables a spinner. If 0, then fanart.jpg, 1 fanart1.jpg, 2 fanart2.jpg......and so on.

Not sure how easy that is implemented, but that is how the naming was established via kodi. The link is working now:

https://kodi.wiki/view/Artwork_types#fanart#

https://kodi.wiki/images/7/7c/LocalTVShowArtwork01.jpg

When export is complete, switching to the next movie, I found myself closing all the files and starting a manual selection of the next movie.

Most of this is done in a sandbox before moving to a storage NAS because trying to do it live could cause errors and that would be a bad thing.

So once save/export is done, that is where it should stop. I will think about the workflow a bit more and update if it makes sense to modify or leave as is.

The only other thought would be, the "bar" that shows status...is there a way to have a text label that says something like "Save Status:" above it?

I was thinking having a message prior to saving "Waiting for User Selection"... after options are selected... then it updates as it does now.

If not, no issue, just thinking out loud.

Let me think about the basic editing inquiry, that requires a bit of A > B > C > D thinking before I can make a suggestion there.

Marvelous work!!

EDIT:

My modified code:

KodiSave 1.3 FanArt#

See above the updated source code 1.3.


You are no longer a rookie if you are able to move a menu and patch the vector vOverlay of booleans, which is an abstract structure.
Great learning!


It is too ambitious for Gimp 2.10 and the old-fashioned Script-Fu.
There is not any event fired between the click to the menu "Kodi" and the click to "OK" button that runs:






By defaut the FanArt only numerical suffix is zero:


it is not added after "-fanart".


If the user clicks on the upper arrow of the spinner or moves the cursor,
FanArt only numerical suffix is added after "-fanart" and before the file extensionn ".jpg"

Finally, pay attention to the underscore before the letter K of "KodiSave":

It enables the shortcut Alt+File > KodiSave.

The revision is exactly what I was looking for it to do...

I gave it some exercise, it did generate one unexpected result and I can't replicate it, but figure I post it so you can see what I ran into and if you may have an idea what might have caused it.

I took an image from my NAS collection. It was the landscape image of Aliens (1986). I renamed it to "Aliens Horizontal image.jpg" for the sake testing.

I created a folder on my desktop: Aliens (1986) ----> Just as it would be as expected from intent of this script.

The order I tried before I noticed the issue:

--- I loaded the image in GIMP
--- Exported Landscape -> OK
--- Exported Actor -> OK
--- Exported Fanart - Spinner set to 6 -> Failed, added suffix unexpectedly as fanart5.XXXXXXX -> continue
--- Exported Fanart - Spinner set to 5 -> OK
--- Exported Fanart - Spinner set to 6 -> OK

Deleted all images except starting image "Aliens Horizontal image.jpg"

Replicated steps above, no issue all exported OK.

Not sure how to replicate this issue, only happened once thus far, so I'll try to track it, but figured I'd provide feedback incase you may have an idea what generated the issue.

It seems like an initialization variable may be needed set to 0?

I was going to take a look to see if I can manage that, but not sure as of this writing.

Other than that, this thing is excellent and amazed with the outcome, thank you again for the efforts, reading the code helps me a bit more to understand how scheme works. Never used this language before, so it is a good learning experience.



Chris

Also forgot to mention, it seems to be warning me every time it exports even though it works as expected. I did a normal export and it didn't flag any warnings.

Have no idea what would cause that, but noticed the behavior.

KodiSave 1.4 FanArt# as integer

See above the updated source code 1.4.


This behavior is by design. Since, the KodiSave message in the status bar could disappear,
we use the Error window to persist the message as a warning even if it is not a warning or an error.

If you do not wish any message in the Error window, put in comment adding ";" in the beginning of the line 154:

Alternatively, if you do not wish to put in comment gimp-message, you can delete this line.


Do you remember if you moved the cursor or clicked to upper arrow of the spinner?
For unknown reason , the FanArt only index was incremented from 5 to the float number 5.7073
To fix the issue:

1. We removed the cursor keeping only the spinner: type = 1 instead of 0 in the last parameter.
   
   Code: Select all

   SF-ADJUSTMENT  "FanArt only" '(0     0     30    1        10       0      1)

   
   
2. The procedure (define (KodiSkinPath path basename artTypeIdx fanArtNbr) has been improved to convert fanArtNbr from float to integer in case where the spinner would return a float number. Normally, the spinner should not return a float since the step is the integer 1 without any decimal dot.

How to convert a float to an integer in Script-Fu?
You can copy and paste the following code in the Script-Fu console.


6

The boundary is at the half of the interval between 5.0 and 6.0: 5.5

6


5

Into the bargain, if there is a decimal dot in the conversion from number to string, we split the string with the known function strbreakup used to split a filename into a root and a file extension:

"5"

You can try without the function car to get the list of the numbers before and after the decimal dot:

("5" "7073")

Finally, if the issue occurs too often, put in comment adding ";" in the beginning of the line "SF-ADJUSTMENT".
Then remove ";" in the line below starting with "SF-VALUE". The spinner will be replaced with an input box initialized with "0".

Before: with the spinner


After: without the spinner but a basic input box

In the free editor NotePad++, adding ";" in the beginning of the line renders the line as a green comment.

After the editing of a Script-Fu source code .scm such as KodiSave.scm, we recommend to close Gimp then restart Gimp even if there is the menu "Filter" > "Script-Fu" > "Refresh scripts".
So we are sure that the memory used by Script-Fu will be correctly released.

I was trying 1.4 out but not for fanart (other things to complete), I went to export as banner and ran into this output error:

Also, can you guide me to a scheme debugger so I can single step and try and learn the code sequence?

I found DrRacket, but it was not working as I expect with GIMP script. I do use Visual Studio for C++ and VB, so it isn't a stretch to learn, just knowing the right tool and getting it setup so I can learn and adapt to a different environment.

Thanks again for all your help, will continue to try and understand how scheme works.

Chris

I cannot reproduce the following issue with art type "Banner" index 2 in KodiSave 1.4
Try to indicate more context such as full path of picture, states of each element of the KodiSave dialog box.

Error: car: argument 1 must be: pair

Run the Script-Fu console by "Filters" > "Script-Fu" > "Console" (Alt+R S C).

The function car retrieves the first element of a given list such as '("root" "png")

"root"

Let us remove manually the first element. The list becomes '("png")

"png"

Let us remove again the first element. The list becomes empty '()

Error: car: argument 1 must be: pair
In other words, car does not like the empty list.

In KodiSave 1.4, I mainly introduced car in KodiSkinPath in the affection of the local variable strFanArt of type string.

You cannot directly run this affection.
But try to run the examples in comment starting with ";" above the define such as the last one:

Do not copy the ";" but after from the opening parenthesis until the corresponding closing parenthesis.

"C:\\Movies\\Aliens (1986)\\Aliens (1986)-fanart5.jpg"
It does not matter if the path exists or not.
The expected result is also supplied as a comment before the define.

Try to reproduce your own context about:

• your path of picture. Do not forget to double backslash in Windows;
• your art type banner has for index 2 instead of fanart at 7;
• fanArtNbr should be 0 but indicate the real number of the spinner.

Debugging Script-Fu

You can debug only in the Script-Fu console.
Close Gimp then restart it
You must reproduce the parameters during the call of (script-fu-kodi-save img layer artTypeIdx fanArtNbr)

• img should be 1 if it is the first picture in Gimp. To confirm, run: (gimp-image-get-id)
• layer, run: (car (gimp-image-get-active-drawable 1)) ; if img is 1, the layer could be 2 ;
  Alternatively, try: (car (gimp-image-get-active-drawable (gimp-image-get-id)))
• artTypeIdx: for banner, indicate the index 2
• fanArtNbr: should be 0

So clicking to the menu File > KodiSave is equivalent to the call in the console:

(#t)

If you do not want to manage the first two parameters,
replace img and layer by the call of their respective functions, but it is longer:

(#t)

In the console, you can enable tracing for debugging purpose by:

"Gives: 0" should be the Script-Fu's answer displaying the previous state of tracing.

tracing will trace all calls until the fatal error.

Disable the tracing by:

Eval: (tracing 0)
Eval: tracing
Eval: 0
Apply to: (0)1

Tracing is extremely verbose: 4 instructions are displayed to disable the tracing.
You could insert (tracing 1) inside any function to start tracing only on purpose.
But choose the function that could be the closest of the bug.
Otherwise, you could have a lot of traces and the performance is dramatically reduced.

When you call a function in the console, you can use:

text#t

and

return to the line
#t

display could be more useful than:

gimp-message displays a warning in the Error window.

Finally, try to run all the calls in comment and compare with each expected result.
Search the functions that call car.

You can remove the body of let* to check only if the local variables work.
See in post #6 "let* us introduce local variables:".

If all local variables work, reintroduce step by step the body of let* until the fatal error is found.

Environment of developement for Script-Fu

DrRacket is the best to learn the different dialects about Scheme.
However starting DrRacket is very long.
You cannot simulate the Gimp API: so all functions beginning with "gimp-" do not work.

Try DrRacket to learn the basic primitives of Scheme. DrRacket has a classical debugger
If you select for example "let*" then press F1, there is a contextual help online

Visual Studio or VScode could edit .scm source file: search "scheme" in the free extensions to color the keywords.

I prefer Notepad++ menu "Language" > "Scheme" because the loading of the editor is faster.
Ctrl+Alt+B on the closing parenthesis selects the entire Scheme expression until the corresponding open parenthesis.
It is very useful to copy and paste a call to a function and its parameters in the console.

In all cases, only the Script-Fu console must be used to run Script-Fu source code .scm

Running remotely Gimp as a Script-Fu server from the client NotePad++ or VScode is out of the scope of this post.
Gimp menu "Filter" > "Script-Fu" > "Start Server..."

I have found the reason but not sure the fix.

I open gimp, images located in "C:\Users\chris\Desktop\Kodi\1883 (2023)", load image file 1, load image file 2, merge 1 and 2 into template (banner > local template to me 1000x185)... click on KodiSave... "Error: car: argument 1 must be: pair"

Now, if I do a File > Save As > Whatever.xcf

Return and Click "KodiSave".... select banner > works as it did before......all good.

So something strange with the initial save aspect??

I am using your info about debugging in console to trace, some things I can see/understand, many of the things I try I get:

> PathInfoPic
#<CLOSURE>

I got how to reproduce error, using method I described above.

It works with a single layer, 2 layers, 3 layers > crash (I assume it will also crash on 5, 7, 9, 11 or any other odd number of layers)

Ok, so I open image 1 (Tab1)
Open image 2 (Tab 2)
Create new image (Tab 3 Blank > Dimensions I am using 1000x185 > Should not matter)

Tab 1, select all, Copy, Paste as new layer into Tab 3
Tab 2, select all, Copy, Paste as new layer into Tab 3

Kodisave with Tab 3 Active > Click > must be: Pair error

I have to do the method this way because in order to create a "banner" for Kodi, I need a Main background image of the movie/tv show itself, I use the "clearlogo.png" of the movie/tv show, those two items are combined in Tab 3 using predefined template dimensions of 1000x185 pixel requirements set by Kodi and I use for all banner creation so I don't have to think about it and reduces setup and keystroke entries etc.

So it seems the script is trying to do something in pairs vs the active tab layer when it is active.

I "think" that is were the issue is, but I can't seem to follow the scheme code to try and adjust it. I will continue to look at it.

As a note, 1.2 didn't have this issue. 1.3 is missing in this thread as it was over written by 1.4. So I can't verify 1.3, I am looking to see if I saved a backup copy somewhere so I can test that to see where the issue come in.

Hopefully this helps give some insight??

Best,
Chris

Great description, Chris!

KodiSave 1.5 untitled image

See in page 2 the updated source code 1.5.


So merge 1 and 2 should be in the same folder than the last loaded image 2.


This the new operating mode.
In all previous screen captures in page 1-2, the first step was a drag-and-drop: so the target picture had always a title.

When you create a new picture, the image has not yet been saved and its title is: "Untitled":



KodiSave 1.5 introduces the new function SearchFilename starting from the target image having merge 1 and 2.
If the filename is empty, SearchFilename searchs in the vector of all loaded images then choose the last loaded image having a non empty filename.


In our case, it is picture 2 with a green frame.

The SearchFilename code begins to be complex with three levels of let* including a loop in the vector of image id.

How to debug the car issue?


enabled the very very long trace of all functions ended by (car '()) ; first element of the empty list generated the fatal error.

After the error, never forget to restore the disabled trace by:


The bug was in PathInfoPic: the fullname of an untitled image was the empty string.
Spliting the empty fullname removing each DIR-SEPARATOR generated ("").
Removing the filename from lstPath generated the empty list ().
Rebuilding the path without the filename caused the fatal error in unbreakupstr.
This function is provided in C:\Program Files\GIMP 2\share\gimp\2.0\scripts\script-fu-compat.init
And, until now, I did not know that unbreakupstr could include the call of car.

The fun of the story is that, in 1.5, I instrumented KodiSave replacing all calls of car by a debug version named carDbg.
carDbg does exactly what car does but if the list is empty, carDbg displays the running context: the caller and one of its parameter.
In fact, carDbg never fired the fatal error since it was in unbreakupstr outside KodiSave.

Welcome to Lisp


#<CLOSURE>

The notion of closure is relative to an environment and the scope of variables.
Is the function PathInfoPic a closure?

#t

Is the function PathInfoPic a procedure?

#t

Retrieving the Lisp code of a closure as lambda expression:

(lambda (img) (let* ((fullname (SearchFilename img)) (lstPath (strbreakup fullname DIR-SEPARATOR)) (lstDir (reverse (cdr (reverse lstPath)))) (path (unbreakupstr lstDir DIR-SEPARATOR)) (filename (carDbg (last lstPath) 'PathInfoPic2 lstPath)) (lstFile (strbreakup filename ".")) (basename (carDbg lstFile 'PathInfoPic3 filename)) (filExt (carDbg (last lstFile) 'PathInfoPic4 filename))) (vector path basename filExt)))

Is the function car a procedure?

#t

However car is not a closure:

#f

One cannot retrieve the Lisp code of car since it is a basic primitive.

#f