Forked from Github plus GPT 5 pair programming additions
This commit is contained in:
Wesley R. Elsberry
parent
0cab046537
commit
b17647d2fa
|
|
@ -1,4 +1,3 @@
|
|||
# ---> Python
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
|
|
@ -21,6 +20,7 @@ parts/
|
|||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
pip-wheel-metadata/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
|
|
@ -50,7 +50,6 @@ coverage.xml
|
|||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
cover/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
|
|
@ -73,7 +72,6 @@ instance/
|
|||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
.pybuilder/
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
|
|
@ -84,9 +82,7 @@ profile_default/
|
|||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
# For a library or package, you might want to ignore these files since the code is
|
||||
# intended to run in multiple environments; otherwise, check them in:
|
||||
# .python-version
|
||||
.python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
|
|
@ -95,22 +91,7 @@ ipython_config.py
|
|||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# poetry
|
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
||||
#poetry.lock
|
||||
|
||||
# pdm
|
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
||||
#pdm.lock
|
||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
||||
# in version control.
|
||||
# https://pdm.fming.dev/#use-with-ide
|
||||
.pdm.toml
|
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
|
|
@ -146,68 +127,3 @@ dmypy.json
|
|||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
|
||||
# PyCharm
|
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
|
||||
# ---> Emacs
|
||||
# -*- mode: gitignore; -*-
|
||||
*~
|
||||
\#*\#
|
||||
/.emacs.desktop
|
||||
/.emacs.desktop.lock
|
||||
*.elc
|
||||
auto-save-list
|
||||
tramp
|
||||
.\#*
|
||||
|
||||
# Org-mode
|
||||
.org-id-locations
|
||||
*_archive
|
||||
|
||||
# flymake-mode
|
||||
*_flymake.*
|
||||
|
||||
# eshell files
|
||||
/eshell/history
|
||||
/eshell/lastdir
|
||||
|
||||
# elpa packages
|
||||
/elpa/
|
||||
|
||||
# reftex files
|
||||
*.rel
|
||||
|
||||
# AUCTeX auto folder
|
||||
/auto/
|
||||
|
||||
# cask packages
|
||||
.cask/
|
||||
dist/
|
||||
|
||||
# Flycheck
|
||||
flycheck_*.el
|
||||
|
||||
# server auth directory
|
||||
/server/
|
||||
|
||||
# projectiles files
|
||||
.projectile
|
||||
|
||||
# directory configuration
|
||||
.dir-locals.el
|
||||
|
||||
# network security
|
||||
/network-security.data
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,226 @@
|
|||
# Image Editing
|
||||
|
||||
## Individual file editing
|
||||
|
||||
Certain digital images require individual attention in processing. The vast majority of cases can be served by an image editor of restricted capabilities. More advanced editing should be done with other tools (i.e., GIMP, PhotoShop, Luminar, etc.).
|
||||
|
||||
WImageEdit.py is a GUI implementation of a restricted individual image editor written in Python 3, using the Python Imaging Library (PIL) and the ImageMagick package (as an external program dependency).
|
||||
|
||||
## Image operations
|
||||
|
||||
The restricted capabilities in this editor include:
|
||||
|
||||
- Cropping
|
||||
- Rotation (90, 180, 270, and custom degrees clockwise)
|
||||
- Flip/Flop (mirroring)
|
||||
- Inversion/Negation
|
||||
- Brightness/Contrast adjustment
|
||||
- Linear
|
||||
- Sigmoidal
|
||||
- Color correction
|
||||
- Contrast stretch
|
||||
- Resize
|
||||
- Sharpen
|
||||
- Grayscale
|
||||
|
||||
These are all whole-image or regional operations. Ther e are no individual pixel-level modifications included here. I don't expect to add pixel-level operations. Cloning or 'healing' operations would be the most useful such operations, but the implementation burden and the fact that those are time-consuming tasks argues for leaving those to full-featured image editors.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Python 3 (PySimpleGui recommends Python 3.7)
|
||||
Python packages:
|
||||
- PySimpleGUI
|
||||
- docopt
|
||||
- pillow
|
||||
- simplejson
|
||||
- sqlite3
|
||||
- wand
|
||||
- itertools
|
||||
|
||||
(Some of those are not currently doing useful work.)
|
||||
|
||||
ImageMagick
|
||||
|
||||
## Installation
|
||||
|
||||
Install ImageMagick for your platform.
|
||||
|
||||
Install Python 3.
|
||||
|
||||
Install docopt, pillow, simplejson, sqlite3
|
||||
|
||||
pip install wand
|
||||
|
||||
|
||||
## Operation
|
||||
|
||||
In the ImageEditing directory, launch as:
|
||||
|
||||
python WImageEdit.py
|
||||
|
||||
The 'Browse' button launches the FileBrowser dialog. Navigate to the directory with copies of your digital files for processing, select an image (JPEG, PNG, or GIF images).
|
||||
|
||||
Press the 'Load Image' button. Two views of the selected image should appear. These are resized to fit in a 400x400 pixel space. The one on the laft represents the source image, and the one on the right represents the image as it will appear given currently selected image processing operations.
|
||||
|
||||
### Actions
|
||||
|
||||
There are options for color positive materials, color negative materials, black-and-white positive materials,
|
||||
and black-and-white negative materials. When selected, the common set of controls for processing such
|
||||
materials will be set.
|
||||
|
||||
### Cropping
|
||||
|
||||
There are two mechanisms for cropping.
|
||||
|
||||
#### Crop
|
||||
|
||||
Enable the 'Crop' checkbox.
|
||||
|
||||
Click the 'Crop' radio button in the 'Figure Ops' radio group (just to the right of the source image).
|
||||
|
||||
Within the source image, click and drag from upper left to bottom right to set the crop rectangle.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
#### Chop
|
||||
|
||||
There are four 'chop' chack boxes and geometry inputs. Set those as desired to slice off edges of the source image.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Rotation
|
||||
|
||||
Select from None, 90, 180, 270, and custom degrees clockwise rotation. If custom, set a non-zero number of decimal degrees.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Mirroring
|
||||
|
||||
Select the 'Flop' and/or 'Flip' checkboxes as indicated. If you can tell that an image is reversed from left to right, pick 'Flop' for a horizontal mirror. If you can tell that an image is reversed top to bottm, pick 'Flip' for a vertical mirror.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Linear Brightness/Contrast Control
|
||||
|
||||
Select the 'Brightness/Contrast' checkbox.
|
||||
|
||||
Choose the percent brightness and percent contrast change. (E.g., for a negative 10% brightness and positive 20% contrast change, enter '-10x20%'.
|
||||
|
||||
This brightnees/contrast change can push image values to the extremes. Most of the time you will want to use the Sigmoidal Contrast control instead.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Sigmoidal Contrast Control
|
||||
|
||||
Sigmoidal Contrast operations change the histograms of values based on a transform using the logistic equation applied to image values. The logistic equation application means that the extreme values in the image remain the same, but where the values in between the extremes lie can be altered.
|
||||
|
||||
Select 'Sigmoidal Contrast'. Select 'Increase' or 'Decrease' to either increase contrast or decrease it. The parameters control the amount of change and the value midpoint of change, where 1 is no change, 3 is a moderate amount of change, and 20 is an extreme change. 50% as a value midpoint is where 'neutral gray' would be.
|
||||
|
||||
Practically, I've found a '3,30%' parameter will darken images that seem to have lost contrast toward lighter values, and a '3,80%' parameter will lighten images where the subject is somewhat underexposed and dark. Some exploration may be needed to get a feel for this control.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Sharpen
|
||||
|
||||
The 'Sharpen' operation applies a sharpening operation to the image.
|
||||
|
||||
### Invert
|
||||
|
||||
Select the 'Invert' checkbox if the source image is either a black-and-white or color negative.
|
||||
|
||||
Each value in the source image is replaced by its complement.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Color Correction
|
||||
|
||||
Select the 'Color Correction' checkbox.
|
||||
|
||||
This does an automatic adjustment of each color histogram independently of the others. There are several circumstances where this is useful:
|
||||
|
||||
- Color negatives : This setting corrects for the orange 'masking' color and puts the processed image close to the normal color scheme.
|
||||
|
||||
- Black and white negatives : This setting can help correct for certain 'stain' type degradations in the original negative. It won't eliminate their effect, but it can be useful in reducing them.
|
||||
|
||||
- Color images : Color-shifted prints and slides can off be made better by using this adjustment.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Resize
|
||||
|
||||
If you are only processing one or a few images for a photo frame, you may want to resize images here. If you are doing many, I'd suggest leaving this off and applying a batch resize process to your collected set later.
|
||||
|
||||
Select the 'Resize' checkbox. Set the resize text to indicate the size of the image bounding box to resize to. That is, a '1024x768' setting will mean that a horizontal image likely ends up with a 1024 pixel width, and a vertical image ends up at a 768 pixel height.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Grayscale
|
||||
|
||||
If you are editing an image of a black-and-white negative or a black-and-white print, you probably want to check this checkbox. You might want to keep color for specifically sepia-toned prints.
|
||||
|
||||
Select the 'Grayscale' checkbox.
|
||||
|
||||
Press the 'Update Command' button. The ImageMagick command text ('Process:') will be updated.
|
||||
|
||||
Press the 'Process Image' button. It will remain highlighted while the ImageMagick command is applied to the source image to produce the processed image, which will update the image on the right.
|
||||
|
||||
### Figure Ops
|
||||
|
||||
The 'Crop' radio button enables display of a selected rectangle in the source image as a red outline on the image. In conjunction with the 'Crop' checkbox, the selected rectangle will be scaled to the dimensions of the original image and displayed in the 'Crop' parameters input.
|
||||
|
||||
Selecting the 'Erase All' radio button and left-clicking the mouse in the source image will erase any overlayed rectangles and re-display the source image.
|
||||
|
||||
### Update Command
|
||||
|
||||
Clicking the 'Update Command' button will update the 'Process:' text field from all the GUI controls.
|
||||
|
||||
### Process Image
|
||||
|
||||
Clicking the 'Process Image' button will apply the 'Process:' commmand text as a system call. If the ImageMagick 'magick' executable is available, it will result in the transformation of the source image to a temporary image, which is then displayed on the right in the GUI.
|
||||
|
||||
### Process to File
|
||||
|
||||
Clicking the 'Process to File' button will apply the 'Process:' command, but the destination file will have the name in 'New Name:' with the same extension as the source file. At present, there is no check to make sure the source file is not overwritten. It is strongly urged that you do not allow the 'New Name:' field to collide with the source file name.
|
||||
|
||||
### Previous Image and Next Image
|
||||
|
||||
Clicking the 'Previous Image' or 'Next Image' button is intended to select the previous or next file in an alphabetically sorted list of files.
|
||||
|
||||
### Load Image
|
||||
|
||||
Clicking 'Load Image' refreshes the UI and loads the source image from 'Image File' in both the left source and the right processed view images.
|
||||
|
||||
If this file was processed to a different file before, the settings are read from a JSON file in the directory and the settings are set back to the previous process settings used before. This saves time if you go back to refine a crop or some contrast setting for an image.
|
||||
|
||||
## Bugs
|
||||
|
||||
2023-01-04 Protecting source images
|
||||
|
||||
There needs to be a check so as not to overwrite the source image.
|
||||
|
||||
## Possible Future Features
|
||||
|
||||
While almost anything could be added, I am only looking for things that would be needed for a substantial fraction of use cases. That is, there is only so much room in a single page application, and any additional feature needs to offer greater convenience in general terms than simply launching a heavyweight editor to handle the job would impose. That said, there are some possibilities.
|
||||
|
||||
### Text annotation
|
||||
|
||||
Being able to add something like a caption to a photo would make all kinds of sense for the photo frame target. This is probably relatively easy to accomplish.
|
||||
|
||||
|
|
@ -0,0 +1,443 @@
|
|||
"""
|
||||
WExifEdit.py
|
||||
|
||||
Wesley R. Elsberry
|
||||
|
||||
I specified the capabilities of a program to edit EXIF data from JPEG
|
||||
files to ChatGPT (GPT-4) and got the basic program code from it.
|
||||
|
||||
|
||||
Write a Python PySimpleGUI program that displays thumbnails of JPEG files in a selected directory, retrieves and displays EXIF data from a selected thumbnail, permits editing of EXIF information, and will write back the edited EXIF information to the selected thumbnail's JPEG file. Start with the program using stubbed function declarations, and I will ask for the full functions in separate prompts. Put the layout definition in a function. Put the window invocation and event loop in a function.
|
||||
To create a PySimpleGUI program with the desired functionalities, first install the PySimpleGUI and Pillow libraries if you haven't already:
|
||||
|
||||
Copy code
|
||||
pip install PySimpleGUI Pillow
|
||||
|
||||
Here's the stubbed version of the program with the layout definition and the window invocation and event loop in separate functions:
|
||||
|
||||
python
|
||||
Copy code
|
||||
import PySimpleGUI as sg
|
||||
import os
|
||||
from typing import List
|
||||
|
||||
|
||||
def get_jpeg_files(directory: str) -> List[str]:
|
||||
# TODO: Implement this function to return a list of JPEG filenames in the specified directory.
|
||||
pass
|
||||
|
||||
|
||||
def get_thumbnail(filename: str) -> bytes:
|
||||
# TODO: Implement this function to return the thumbnail of the specified JPEG file as bytes.
|
||||
pass
|
||||
|
||||
|
||||
|
||||
def create_layout(jpeg_files: List[str]):
|
||||
# TODO: Implement this function to create the layout for the PySimpleGUI window.
|
||||
pass
|
||||
|
||||
|
||||
def main():
|
||||
# Get JPEG files from the selected directory
|
||||
directory = sg.popup_get_folder('Select a folder with JPEG files')
|
||||
if not directory:
|
||||
sg.popup_error('No folder selected. Exiting...')
|
||||
return
|
||||
|
||||
jpeg_files = get_jpeg_files(directory)
|
||||
layout = create_layout(jpeg_files)
|
||||
window = sg.Window('JPEG EXIF Viewer & Editor', layout)
|
||||
|
||||
# Event loop
|
||||
while True:
|
||||
event, values = window.read()
|
||||
if event in (sg.WIN_CLOSED, 'Exit'):
|
||||
break
|
||||
|
||||
|
||||
# TODO: Handle events and implement functionalities
|
||||
# such as displaying EXIF data, editing EXIF information,
|
||||
# and writing back the edited EXIF information.
|
||||
|
||||
window.close()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
You can now ask for the full functions in separate prompts.
|
||||
|
||||
|
||||
|
||||
|
||||
Wesley Elsberry
|
||||
Write the get_jpeg_files function.
|
||||
|
||||
Here's the get_jpeg_files function that returns a list of JPEG filenames in the specified directory:
|
||||
|
||||
python
|
||||
Copy code
|
||||
import os
|
||||
from typing import List
|
||||
|
||||
|
||||
def get_jpeg_files(directory: str) -> List[str]:
|
||||
jpeg_extensions = ('.jpg', '.jpeg', '.JPG', '.JPEG')
|
||||
jpeg_files = [os.path.join(directory, f) for f in os.listdir(directory)
|
||||
if f.endswith(jpeg_extensions)]
|
||||
return jpeg_files
|
||||
|
||||
|
||||
This function takes a directory as an argument and uses a list comprehension to generate a list of JPEG files in the specified directory. It checks if the file extension ends with any of the allowed JPEG extensions (both lower and upper case) and includes the file in the list if it does.
|
||||
|
||||
|
||||
|
||||
|
||||
Wesley Elsberry
|
||||
Write the get_thumbnail function.
|
||||
Here's the get_thumbnail function that returns the thumbnail of the specified JPEG file as bytes:
|
||||
|
||||
from PIL import Image
|
||||
from io import BytesIO
|
||||
|
||||
|
||||
def get_thumbnail(filename: str, thumbnail_size=(100, 100)) -> bytes:
|
||||
image = Image.open(filename)
|
||||
image.thumbnail(thumbnail_size)
|
||||
buffer = BytesIO()
|
||||
image.save(buffer, format="JPEG")
|
||||
thumbnail_bytes = buffer.getvalue()
|
||||
buffer.close()
|
||||
return thumbnail_bytes
|
||||
This function takes a filename and an optional thumbnail_size tuple as arguments. It opens the image using the PIL.Image.open() method and creates a thumbnail of the image with the specified size using the thumbnail() method. The thumbnail image is then saved into a BytesIO buffer, and the content of the buffer is returned as bytes.
|
||||
|
||||
Write the create_layout function.
|
||||
Here's the create_layout function that creates the layout for the PySimpleGUI window:
|
||||
|
||||
python
|
||||
Copy code
|
||||
import PySimpleGUI as sg
|
||||
from typing import List
|
||||
|
||||
|
||||
def create_layout(jpeg_files: List[str]):
|
||||
thumbnails = []
|
||||
for f in jpeg_files:
|
||||
thumbnail = get_thumbnail(f)
|
||||
thumbnails.append(sg.Button(image_data=thumbnail, key=f, size=(100, 100), pad=(2, 2)))
|
||||
|
||||
|
||||
|
||||
layout = [
|
||||
[sg.Column([[thumbnail] for thumbnail in thumbnails], scrollable=True, vertical_scroll_only=True, size=(400, 400))],
|
||||
[sg.Text('Selected File:'), sg.Text('', size=(30, 1), key='SelectedFile')],
|
||||
[sg.Multiline('', size=(50, 15), key='ExifData')],
|
||||
[sg.Button('Edit EXIF'), sg.Button('Save EXIF'), sg.Button('Exit')]
|
||||
]
|
||||
return layout
|
||||
This function takes a list of JPEG files as an argument. It iterates through the list of JPEG files, generates thumbnails using the get_thumbnail function, and creates buttons with those thumbnails as images. These buttons are then organized in a scrollable column.
|
||||
|
||||
|
||||
The layout consists of the following elements:
|
||||
|
||||
A scrollable column containing the thumbnail buttons.
|
||||
A text element to display the currently selected file.
|
||||
A multiline text element to display and edit the EXIF data.
|
||||
Buttons for editing and saving the EXIF data, and exiting the application.
|
||||
This layout is returned by the function to be used in the main PySimpleGUI window.
|
||||
|
||||
|
||||
|
||||
|
||||
Wesley Elsberry
|
||||
Write the 'main' function.
|
||||
Here's the complete main function that incorporates the previously defined functions and implements the event handling for displaying EXIF data, editing EXIF information, and writing back the edited EXIF information:
|
||||
|
||||
import PySimpleGUI as sg
|
||||
|
||||
def main():
|
||||
# Get JPEG files from the selected directory
|
||||
directory = sg.popup_get_folder('Select a folder with JPEG files')
|
||||
if not directory:
|
||||
sg.popup_error('No folder selected. Exiting...')
|
||||
return
|
||||
|
||||
jpeg_files = get_jpeg_files(directory)
|
||||
layout = create_layout(jpeg_files)
|
||||
window = sg.Window('JPEG EXIF Viewer & Editor', layout)
|
||||
|
||||
selected_file = None
|
||||
exif_data = None
|
||||
|
||||
|
||||
|
||||
# Event loop
|
||||
while True:
|
||||
event, values = window.read()
|
||||
if event in (sg.WIN_CLOSED, 'Exit'):
|
||||
break
|
||||
|
||||
if event in jpeg_files:
|
||||
selected_file = event
|
||||
window['SelectedFile'].update(selected_file)
|
||||
exif_data = extract_exif(selected_file)
|
||||
window['ExifData'].update('\n'.join(f'{k}: {v}' for k, v in exif_data.items()))
|
||||
|
||||
if event == 'Edit EXIF' and selected_file:
|
||||
edited_exif = sg.popup_get_text('Enter EXIF data to edit (format: key:value, one per line)', '\n'.join(f'{k}: {v}' for k, v in exif_data.items()))
|
||||
if edited_exif:
|
||||
updated_exif = {}
|
||||
for line in edited_exif.splitlines():
|
||||
key, value = line.split(':', 1)
|
||||
updated_exif[key.strip()] = value.strip()
|
||||
exif_data.update(updated_exif)
|
||||
window['ExifData'].update('\n'.join(f'{k}: {v}' for k, v in exif_data.items()))
|
||||
|
||||
css
|
||||
Copy code
|
||||
if event == 'Save EXIF' and selected_file and exif_data:
|
||||
modify_exif(selected_file, exif_data)
|
||||
sg.popup('EXIF data saved successfully.')
|
||||
|
||||
window.close()
|
||||
|
||||
f name == 'main':
|
||||
main()
|
||||
|
||||
vbnet
|
||||
Copy code
|
||||
|
||||
In the event loop, we first check if the `event` is in the list of `jpeg_files`. If it is, we update the selected file and display its EXIF data in the 'ExifData' multiline element. If the 'Edit EXIF' button is clicked and a file is selected, a popup is shown to edit the EXIF data. The user can modify the data in a key:value format, one per line. The modified data is then updated in the `exif_data` dictionary and displayed in the 'ExifData' element.
|
||||
|
||||
If the 'Save EXIF' button is clicked and a file is selected with modified EXIF data, the `modify_exif` function is called to save the changes to the selected file. Finally, a popup is shown to inform the user that the EXIF data was saved successfully.
|
||||
|
||||
Write a 'docopt' string to permit the user to provide an optional initial directory and indicate places where additional code is needed to incorporate that.
|
||||
To use docopt, you'll first need to install the docopt library if you haven't already:
|
||||
|
||||
Copy code
|
||||
pip install docopt
|
||||
Here's a docopt string for the program to allow the user to provide an optional initial directory:
|
||||
|
||||
|
||||
|
||||
'''JPEG EXIF Viewer & Editor
|
||||
|
||||
Usage:
|
||||
main.py [--initial-directory=<path>]
|
||||
|
||||
Options:
|
||||
-h --help Show this help message and exit.
|
||||
--initial-directory=<path> Directory to start browsing JPEG files from [default: .].
|
||||
'''
|
||||
|
||||
To incorporate the optional initial directory in your main function, you'll need to parse the command-line arguments using docopt and use the provided directory as the initial value in sg.popup_get_folder(). Here's how you can do that:
|
||||
|
||||
Import the docopt library at the beginning of your script:
|
||||
python
|
||||
Copy code
|
||||
from docopt import docopt
|
||||
|
||||
Update your main function to accept an optional initial_directory argument:
|
||||
python
|
||||
Copy code
|
||||
def main(initial_directory=None):
|
||||
Change the sg.popup_get_folder() call to include the initial_directory argument:
|
||||
python
|
||||
Copy code
|
||||
directory = sg.popup_get_folder('Select a folder with JPEG files', initial_folder=initial_directory)
|
||||
|
||||
Update the if __name__ == '__main__': block at the end of your script to parse the command-line arguments using docopt and pass the --initial-directory option to the main function:
|
||||
python
|
||||
Copy code
|
||||
if __name__ == '__main__':
|
||||
|
||||
|
||||
arguments = docopt(__doc__)
|
||||
initial_directory = arguments['--initial-directory']
|
||||
main(initial_directory)
|
||||
Now, when you run the script, you can provide an optional --initial-directory argument to specify the initial directory for browsing JPEG files:
|
||||
|
||||
python main.py --initial-directory=path/to/your/folder
|
||||
If you don't provide the --initial-directory argument, the default value ('.') will be used, which means the current working directory.
|
||||
|
||||
|
||||
"""
|
||||
|
||||
|
||||
import sys
|
||||
import traceback
|
||||
import docopt as doco
|
||||
from docopt import docopt
|
||||
import PySimpleGUI as sg
|
||||
import os
|
||||
from typing import List
|
||||
from PIL import Image
|
||||
from io import BytesIO
|
||||
from PIL.ExifTags import TAGS
|
||||
from typing import Dict
|
||||
|
||||
PROGDOCOPT = '''JPEG EXIF Viewer & Editor
|
||||
|
||||
Usage:
|
||||
main.py [--initial-directory=<path>]
|
||||
|
||||
Options:
|
||||
-h --help Show this help message and exit.
|
||||
--initial-directory=<path> Directory to start browsing JPEG files from [default: .].
|
||||
'''
|
||||
|
||||
|
||||
|
||||
def extract_exif(jpeg_filename: str) -> Dict[str, str]:
|
||||
exif_data = {}
|
||||
image = Image.open(jpeg_filename)
|
||||
info = image._getexif()
|
||||
|
||||
if info:
|
||||
for tag, value in info.items():
|
||||
decoded = TAGS.get(tag, tag)
|
||||
exif_data[decoded] = value
|
||||
|
||||
return exif_data
|
||||
|
||||
def modify_exif(jpeg_filename: str, updated_exif: Dict[str, str]):
|
||||
image = Image.open(jpeg_filename)
|
||||
info = image._getexif()
|
||||
exif = {TAGS[key]: value for key, value in info.items() if key in TAGS}
|
||||
|
||||
for key, value in updated_exif.items():
|
||||
if key in exif:
|
||||
exif[key] = value
|
||||
|
||||
exif_bytes = image.info['exif']
|
||||
|
||||
# Convert the updated exif dict back to bytes
|
||||
from PIL.ExifTags import GPSTAGS
|
||||
from io import BytesIO
|
||||
new_exif_bytes = BytesIO()
|
||||
new_exif = Image.Exif()
|
||||
for key, value in exif.items():
|
||||
new_exif[key] = value
|
||||
new_exif_bytes = new_exif.tobytes()
|
||||
|
||||
# Save the image with the updated EXIF data
|
||||
output_filename = 'modified_' + jpeg_filename
|
||||
image.save(output_filename, 'jpeg', exif)
|
||||
|
||||
|
||||
def get_jpeg_files(directory: str) -> List[str]:
|
||||
jpeg_extensions = ('.jpg', '.jpeg', '.JPG', '.JPEG')
|
||||
jpeg_files = [os.path.join(directory, f) for f in os.listdir(directory)
|
||||
if f.endswith(jpeg_extensions)]
|
||||
return jpeg_files
|
||||
|
||||
def create_missing_thumbnail(thumbnail_size=(100, 100)) -> bytes:
|
||||
image = Image.new('RGB', thumbnail_size, color='gray')
|
||||
buffer = BytesIO()
|
||||
image.save(buffer, format="PNG")
|
||||
thumbnail_bytes = buffer.getvalue()
|
||||
buffer.close()
|
||||
return thumbnail_bytes
|
||||
|
||||
def get_thumbnail(filename: str, thumbnail_size=(100, 100)) -> bytes:
|
||||
thumbnail_bytes = None
|
||||
try:
|
||||
image = Image.open(filename)
|
||||
image.thumbnail(thumbnail_size)
|
||||
buffer = BytesIO()
|
||||
image.save(buffer, format="PNG")
|
||||
thumbnail_bytes = buffer.getvalue()
|
||||
buffer.close()
|
||||
except:
|
||||
estr = "Error: {traceback.format_exc()}"
|
||||
print(estr)
|
||||
thumbnail_bytes = create_missing_thumbnail(thumbnail_size)
|
||||
# thumbnail_bytes = create_missing_thumbnail(thumbnail_size)
|
||||
return thumbnail_bytes
|
||||
|
||||
def create_layout(jpeg_files: List[str]):
|
||||
button_prefix='SELFILE_'
|
||||
thumbnail_elements = []
|
||||
for f in jpeg_files:
|
||||
thumbnail = get_thumbnail(f)
|
||||
file_name = os.path.basename(f)
|
||||
thumbnail_elements.append([sg.Column([
|
||||
[sg.Button(image_data=thumbnail, key=button_prefix + f, size=(100, 100), pad=(2, 2))],
|
||||
[sg.Text(file_name, size=(15, 1), justification='center')]
|
||||
])])
|
||||
|
||||
layout = [
|
||||
[sg.Column(thumbnail_elements, scrollable=True, vertical_scroll_only=False, size=(400, 400))],
|
||||
[sg.Text('Selected File:'), sg.Text('', size=(30, 1), key='SelectedFile')],
|
||||
[sg.Multiline('', size=(50, 15), key='ExifData')],
|
||||
[sg.Button('Edit EXIF'), sg.Button('Save EXIF'), sg.Button('Exit')]
|
||||
]
|
||||
return layout
|
||||
|
||||
"""
|
||||
def create_layout(jpeg_files: List[str]):
|
||||
thumbnails = []
|
||||
for f in jpeg_files:
|
||||
thumbnail = get_thumbnail(f)
|
||||
if not thumbnail in [None]:
|
||||
thumbnails.append(sg.Button(image_data=thumbnail, key=f, size=(100, 100), pad=(2, 2)))
|
||||
|
||||
layout = [
|
||||
[sg.Column([[thumbnail] for thumbnail in thumbnails], scrollable=True, vertical_scroll_only=True, size=(400, 400))],
|
||||
[sg.Text('Selected File:'), sg.Text('', size=(30, 1), key='SelectedFile')],
|
||||
[sg.Multiline('', size=(50, 15), key='ExifData')],
|
||||
[sg.Button('Edit EXIF'), sg.Button('Save EXIF'), sg.Button('Exit')]
|
||||
]
|
||||
return layout
|
||||
"""
|
||||
|
||||
def main(initial_directory=None):
|
||||
button_prefix='SELFILE_'
|
||||
# Get JPEG files from the selected directory
|
||||
directory = sg.popup_get_folder('Select a folder with JPEG files', initial_folder=initial_directory)
|
||||
|
||||
if not directory:
|
||||
sg.popup_error('No folder selected. Exiting...')
|
||||
return
|
||||
|
||||
jpeg_files = get_jpeg_files(directory)
|
||||
layout = create_layout(jpeg_files)
|
||||
window = sg.Window('JPEG EXIF Viewer & Editor', layout)
|
||||
|
||||
# Event loop
|
||||
while True:
|
||||
event, values = window.read()
|
||||
event8 = event[:8]
|
||||
if event in (sg.WIN_CLOSED, 'Exit'):
|
||||
break
|
||||
|
||||
if event in jpeg_files or event8 in ['SELFILE_']:
|
||||
selected_file = event[8:]
|
||||
window['SelectedFile'].update(selected_file)
|
||||
exif_data = extract_exif(selected_file)
|
||||
window['ExifData'].update('\n'.join(f'{k}: {v}' for k, v in exif_data.items()))
|
||||
for k, v in exif_data.items():
|
||||
print(k, v)
|
||||
|
||||
if event == 'Edit EXIF' and selected_file:
|
||||
edited_exif = sg.popup_get_text('Enter EXIF data to edit (format: key:value, one per line)', '\n'.join(f'{k}: {v}' for k, v in exif_data.items()))
|
||||
if edited_exif:
|
||||
updated_exif = {}
|
||||
for line in edited_exif.splitlines():
|
||||
key, value = line.split(':', 1)
|
||||
updated_exif[key.strip()] = value.strip()
|
||||
exif_data.update(updated_exif)
|
||||
window['ExifData'].update('\n'.join(f'{k}: {v}' for k, v in exif_data.items()))
|
||||
|
||||
if event == 'Save EXIF' and selected_file and exif_data:
|
||||
modify_exif(selected_file, exif_data)
|
||||
sg.popup('EXIF data saved successfully.')
|
||||
|
||||
window.close()
|
||||
|
||||
if __name__ == '__main__':
|
||||
arguments = docopt(PROGDOCOPT)
|
||||
initial_directory = '.'
|
||||
if not arguments['--initial-directory'] in [None]:
|
||||
initial_directory = arguments['--initial-directory']
|
||||
main(initial_directory)
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,257 @@
|
|||
#!/usr/bin/env python3
|
||||
"""
|
||||
Group files in a directory by "capture time" and move them into
|
||||
timestamped subdirectories.
|
||||
|
||||
"Capture time" is determined as:
|
||||
1. EXIF DateTimeOriginal (if available; for image files)
|
||||
2. Otherwise, filesystem modification time (mtime)
|
||||
|
||||
Subdirectory naming scheme:
|
||||
YYYY_mdd-hhmmss-[camera tag]-grouped
|
||||
|
||||
Where:
|
||||
- YYYY is the 4-digit year
|
||||
- m is month as a hexadecimal digit: 1..9,a,b,c (Jan..Dec)
|
||||
- dd is 2-digit day of month
|
||||
- hhmmss is the time of the earliest file in the group (24h)
|
||||
- [camera tag] is taken from the input directory name pattern:
|
||||
YYYY_mdd-[camera tag]-<text>
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import List, Tuple, Optional
|
||||
|
||||
from PIL import Image
|
||||
from PIL.ExifTags import TAGS
|
||||
|
||||
|
||||
def month_to_hex_digit(month: int) -> str:
|
||||
"""
|
||||
Convert month number (1-12) to hex-like digit:
|
||||
1..9, a, b, c
|
||||
"""
|
||||
if not (1 <= month <= 12):
|
||||
raise ValueError(f"Month out of range: {month}")
|
||||
if month <= 9:
|
||||
return str(month)
|
||||
return "abc"[month - 10]
|
||||
|
||||
|
||||
def parse_camera_tag_from_dirname(dirname: str) -> str:
|
||||
"""
|
||||
Extract camera tag from a directory name of the form:
|
||||
YYYY_mdd-[camera tag]-<text>
|
||||
|
||||
Returns 'unknown' if the pattern doesn't match.
|
||||
"""
|
||||
# Example: 2025_40f-d600-trip-to-park
|
||||
# Pattern: ^YYYY_mdd-[camera_tag]-...
|
||||
pattern = r"^\d{4}_[0-9a-cA-C]\d{2}-([^-]+)"
|
||||
m = re.match(pattern, dirname)
|
||||
if m:
|
||||
return m.group(1)
|
||||
return "unknown"
|
||||
|
||||
|
||||
def get_exif_datetime_original(path: Path) -> Optional[datetime]:
|
||||
"""
|
||||
Try to read EXIF DateTimeOriginal from an image.
|
||||
|
||||
Returns a datetime object if found and parsable, otherwise None.
|
||||
"""
|
||||
try:
|
||||
with Image.open(path) as img:
|
||||
exif = img._getexif()
|
||||
if not exif:
|
||||
return None
|
||||
|
||||
# Build tag-name -> value dict
|
||||
exif_data = {}
|
||||
for tag_id, value in exif.items():
|
||||
tag_name = TAGS.get(tag_id, tag_id)
|
||||
exif_data[tag_name] = value
|
||||
|
||||
dto = exif_data.get("DateTimeOriginal")
|
||||
if not dto:
|
||||
return None
|
||||
|
||||
# Typical format: "YYYY:MM:DD HH:MM:SS"
|
||||
try:
|
||||
return datetime.strptime(dto, "%Y:%m:%d %H:%M:%S")
|
||||
except (ValueError, TypeError):
|
||||
return None
|
||||
except Exception:
|
||||
# Any error (non-image, corrupt file, etc.) -> no EXIF time
|
||||
return None
|
||||
|
||||
|
||||
def get_logical_timestamp(path: Path) -> float:
|
||||
"""
|
||||
Get the best available "capture time" for the file as a POSIX timestamp.
|
||||
|
||||
Preference:
|
||||
1. EXIF DateTimeOriginal (if available)
|
||||
2. else filesystem modification time (mtime)
|
||||
"""
|
||||
exif_dt = get_exif_datetime_original(path)
|
||||
if exif_dt is not None:
|
||||
return exif_dt.timestamp()
|
||||
|
||||
# Fallback: mtime
|
||||
return os.path.getmtime(path)
|
||||
|
||||
|
||||
def group_files_by_logical_time(
|
||||
files: List[Path], threshold_minutes: float
|
||||
) -> List[List[Path]]:
|
||||
"""
|
||||
Given a list of file Paths, group them by "logical time"
|
||||
(EXIF DateTimeOriginal or mtime) so that consecutive files
|
||||
within a group are no more than threshold_minutes apart.
|
||||
A new group starts when the gap between successive files
|
||||
exceeds the threshold.
|
||||
"""
|
||||
if not files:
|
||||
return []
|
||||
|
||||
files_with_times: List[Tuple[Path, float]] = [
|
||||
(f, get_logical_timestamp(f)) for f in files
|
||||
]
|
||||
files_with_times.sort(key=lambda x: x[1])
|
||||
|
||||
groups: List[List[Path]] = []
|
||||
current_group: List[Path] = [files_with_times[0][0]]
|
||||
last_time = files_with_times[0][1]
|
||||
|
||||
for f, t in files_with_times[1:]:
|
||||
diff_minutes = (t - last_time) / 60.0
|
||||
if diff_minutes > threshold_minutes:
|
||||
# Start a new group
|
||||
groups.append(current_group)
|
||||
current_group = [f]
|
||||
else:
|
||||
current_group.append(f)
|
||||
last_time = t
|
||||
|
||||
if current_group:
|
||||
groups.append(current_group)
|
||||
|
||||
return groups
|
||||
|
||||
|
||||
def build_group_dir_name(
|
||||
earliest_ts: float,
|
||||
camera_tag: str,
|
||||
) -> str:
|
||||
"""
|
||||
Build directory name:
|
||||
YYYY_mdd-hhmmss-[camera tag]-grouped
|
||||
where m is hex month (1..9,a,b,c)
|
||||
"""
|
||||
dt = datetime.fromtimestamp(earliest_ts)
|
||||
year = dt.year
|
||||
month_hex = month_to_hex_digit(dt.month)
|
||||
day = dt.day
|
||||
date_code = f"{year}_{month_hex}{day:02d}"
|
||||
time_code = dt.strftime("%H%M%S")
|
||||
return f"{date_code}-{time_code}-{camera_tag}-grouped"
|
||||
|
||||
|
||||
def ensure_unique_dir(path: Path) -> Path:
|
||||
"""
|
||||
If 'path' exists, append _2, _3, ... until we find
|
||||
a non-existing path. Returns the chosen path.
|
||||
"""
|
||||
if not path.exists():
|
||||
return path
|
||||
base = path.stem
|
||||
suffix = path.suffix # usually empty for dirs
|
||||
parent = path.parent
|
||||
counter = 2
|
||||
while True:
|
||||
candidate = parent / f"{base}_{counter}{suffix}"
|
||||
if not candidate.exists():
|
||||
return candidate
|
||||
counter += 1
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
description=(
|
||||
"Group files in INPUT_DIR by capture time (EXIF DateTimeOriginal or "
|
||||
"mtime) and move each group into a new subdirectory in OUTPUT_DIR."
|
||||
)
|
||||
)
|
||||
parser.add_argument("input_dir", help="Input directory containing files")
|
||||
parser.add_argument("output_dir", help="Output directory for grouped subdirs")
|
||||
parser.add_argument(
|
||||
"--threshold-minutes",
|
||||
"-t",
|
||||
type=float,
|
||||
default=60.0,
|
||||
help="Time gap threshold in minutes between groups (default: 60)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--dry-run",
|
||||
action="store_true",
|
||||
help="Show what would be done without moving files",
|
||||
)
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
input_dir = Path(args.input_dir).expanduser().resolve()
|
||||
output_dir = Path(args.output_dir).expanduser().resolve()
|
||||
threshold_minutes = args.threshold_minutes
|
||||
dry_run = args.dry_run
|
||||
|
||||
if not input_dir.is_dir():
|
||||
raise SystemExit(f"Input directory does not exist or is not a directory: {input_dir}")
|
||||
|
||||
output_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Extract camera tag from input directory name
|
||||
camera_tag = parse_camera_tag_from_dirname(input_dir.name)
|
||||
|
||||
# Collect files (non-recursive; adjust if you want recursion)
|
||||
files = [p for p in input_dir.iterdir() if p.is_file()]
|
||||
|
||||
if not files:
|
||||
print(f"No files found in {input_dir}")
|
||||
return
|
||||
|
||||
groups = group_files_by_logical_time(files, threshold_minutes)
|
||||
|
||||
print(
|
||||
f"Found {len(files)} files in {input_dir}, "
|
||||
f"grouped into {len(groups)} group(s) using threshold "
|
||||
f"{threshold_minutes} minute(s)."
|
||||
)
|
||||
|
||||
for idx, group in enumerate(groups, start=1):
|
||||
# Earliest logical time in the group
|
||||
earliest_ts = min(get_logical_timestamp(f) for f in group)
|
||||
group_dir_name = build_group_dir_name(earliest_ts, camera_tag)
|
||||
group_dir = ensure_unique_dir(output_dir / group_dir_name)
|
||||
|
||||
print(f"\nGroup {idx}: {len(group)} file(s)")
|
||||
print(f" Target directory: {group_dir}")
|
||||
|
||||
if dry_run:
|
||||
for f in group:
|
||||
print(f" (dry-run) would move: {f.name}")
|
||||
else:
|
||||
group_dir.mkdir(parents=True, exist_ok=False)
|
||||
for f in group:
|
||||
dest = group_dir / f.name
|
||||
print(f" Moving: {f.name} -> {dest}")
|
||||
shutil.move(str(f), str(dest))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
|
@ -0,0 +1,446 @@
|
|||
#!/usr/bin/env python3
|
||||
"""
|
||||
mfr.py – MemorySharing Multi-File Renamer (Tkinter GUI)
|
||||
|
||||
This tool helps rename related media files (RAW, JPEG, thumbnails, websize
|
||||
variants, WAV, etc.) in groups.
|
||||
|
||||
Grouping logic:
|
||||
- Files in the selected directory are grouped by a common basename prefix.
|
||||
- Variant suffixes like "_tn", "_ws", etc. are stripped to find the
|
||||
"group key". All files with stems sharing that key are in one group.
|
||||
|
||||
Renaming logic:
|
||||
- For each group, compute the earliest "logical timestamp" among its
|
||||
members:
|
||||
EXIF DateTimeOriginal (if present) OR filesystem mtime.
|
||||
- Build a new base name:
|
||||
[optional date]_[camera_tag]_[extra_text]_[group_index]
|
||||
where:
|
||||
- date is formatted with Python's datetime.strftime()
|
||||
- camera_tag is chosen from a dropdown (or custom)
|
||||
- extra_text is the user-supplied string, spaces -> '-'
|
||||
- group_index is a 4-digit sequence (0001, 0002, ...)
|
||||
- Each file in the group gets renamed to:
|
||||
<new_base><original_variant_suffix><original_extension>
|
||||
|
||||
Example:
|
||||
Original files:
|
||||
IMG_1234.NEF
|
||||
IMG_1234.JPG
|
||||
IMG_1234_tn.jpg
|
||||
If group index is 1, camera tag "d600", date "2025_0401", text "family",
|
||||
they might be renamed to:
|
||||
2025_0401_d600_family_0001.NEF
|
||||
2025_0401_d600_family_0001.JPG
|
||||
2025_0401_d600_family_0001_tn.jpg
|
||||
"""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
import tkinter as tk
|
||||
from tkinter import filedialog, messagebox, ttk
|
||||
|
||||
from PIL import Image
|
||||
from PIL.ExifTags import TAGS
|
||||
|
||||
|
||||
# ------------------------- Group / timestamp logic --------------------------
|
||||
|
||||
|
||||
DEFAULT_VARIANT_MARKERS = ["_tn", "_ws"]
|
||||
|
||||
|
||||
def get_exif_datetime_original(path: Path):
|
||||
"""Return EXIF DateTimeOriginal as datetime, or None."""
|
||||
try:
|
||||
with Image.open(path) as img:
|
||||
exif = img._getexif()
|
||||
if not exif:
|
||||
return None
|
||||
|
||||
exif_data = {TAGS.get(tag_id, tag_id): value for tag_id, value in exif.items()}
|
||||
dto = exif_data.get("DateTimeOriginal")
|
||||
if not dto:
|
||||
return None
|
||||
|
||||
# Typical EXIF datetime format: "YYYY:MM:DD HH:MM:SS"
|
||||
try:
|
||||
return datetime.strptime(dto, "%Y:%m:%d %H:%M:%S")
|
||||
except (ValueError, TypeError):
|
||||
return None
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def get_logical_timestamp(path: Path) -> float:
|
||||
"""Best timestamp: EXIF DateTimeOriginal if available, else mtime."""
|
||||
exif_dt = get_exif_datetime_original(path)
|
||||
if exif_dt is not None:
|
||||
return exif_dt.timestamp()
|
||||
return os.path.getmtime(path)
|
||||
|
||||
|
||||
def derive_group_key(stem: str, variant_markers):
|
||||
"""
|
||||
Derive a "group key" from a stem by stripping known variant markers.
|
||||
|
||||
We look for the earliest occurrence of any marker like "_tn", "_ws",
|
||||
and take everything before that index as the group key.
|
||||
"""
|
||||
s_lower = stem.lower()
|
||||
positions = []
|
||||
for marker in variant_markers:
|
||||
m_lower = marker.lower()
|
||||
idx = s_lower.find(m_lower)
|
||||
if idx != -1:
|
||||
positions.append(idx)
|
||||
|
||||
if not positions:
|
||||
return stem
|
||||
|
||||
cutoff = min(positions)
|
||||
if cutoff <= 0:
|
||||
return stem
|
||||
return stem[:cutoff]
|
||||
|
||||
|
||||
def collect_groups_in_directory(directory: Path, variant_markers):
|
||||
"""
|
||||
Collect files into groups for a single directory (no recursion).
|
||||
|
||||
Returns a dict: {group_key: [Path, ...], ...}
|
||||
"""
|
||||
groups = {}
|
||||
for entry in sorted(directory.iterdir()):
|
||||
if not entry.is_file():
|
||||
continue
|
||||
# Skip dotfiles
|
||||
if entry.name.startswith("."):
|
||||
continue
|
||||
|
||||
stem = entry.stem
|
||||
key = derive_group_key(stem, variant_markers)
|
||||
groups.setdefault(key, []).append(entry)
|
||||
|
||||
return groups
|
||||
|
||||
|
||||
# ----------------------------- GUI application ------------------------------
|
||||
|
||||
|
||||
class MFRApp(tk.Tk):
|
||||
def __init__(self):
|
||||
super().__init__()
|
||||
self.title("MemorySharing Multi-File Renamer")
|
||||
self.geometry("900x600")
|
||||
|
||||
self.directory_var = tk.StringVar()
|
||||
self.date_format_var = tk.StringVar(value="%Y_%m%d")
|
||||
self.include_date_var = tk.BooleanVar(value=True)
|
||||
|
||||
# Camera tag dropdown, plus custom override
|
||||
self.camera_tags = ["d600", "z6", "em5", "other"]
|
||||
self.camera_tag_var = tk.StringVar(value=self.camera_tags[0])
|
||||
self.camera_custom_var = tk.StringVar()
|
||||
|
||||
self.extra_text_var = tk.StringVar()
|
||||
self.variant_markers_var = tk.StringVar(value=",".join(DEFAULT_VARIANT_MARKERS))
|
||||
|
||||
# Store preview mappings [(old_path, new_path), ...]
|
||||
self.preview_mappings = []
|
||||
|
||||
self._build_ui()
|
||||
|
||||
def _build_ui(self):
|
||||
# Top frame: directory selection
|
||||
top_frame = ttk.Frame(self, padding=8)
|
||||
top_frame.pack(fill=tk.X)
|
||||
|
||||
ttk.Label(top_frame, text="Directory:").grid(row=0, column=0, sticky=tk.W)
|
||||
dir_entry = ttk.Entry(top_frame, textvariable=self.directory_var, width=60)
|
||||
dir_entry.grid(row=0, column=1, sticky=tk.W, padx=4)
|
||||
ttk.Button(top_frame, text="Browse...", command=self.select_directory).grid(
|
||||
row=0, column=2, padx=4
|
||||
)
|
||||
|
||||
# Date options
|
||||
date_frame = ttk.LabelFrame(self, text="Date options", padding=8)
|
||||
date_frame.pack(fill=tk.X, padx=8, pady=4)
|
||||
|
||||
ttk.Checkbutton(
|
||||
date_frame, text="Include date in filename", variable=self.include_date_var
|
||||
).grid(row=0, column=0, sticky=tk.W)
|
||||
|
||||
ttk.Label(date_frame, text="Date format (strftime):").grid(
|
||||
row=1, column=0, sticky=tk.W, pady=(4, 0)
|
||||
)
|
||||
ttk.Entry(date_frame, textvariable=self.date_format_var, width=20).grid(
|
||||
row=1, column=1, sticky=tk.W, padx=4, pady=(4, 0)
|
||||
)
|
||||
ttk.Label(date_frame, text="Example: %Y_%m%d → 2025_0401").grid(
|
||||
row=1, column=2, sticky=tk.W, padx=8
|
||||
)
|
||||
|
||||
# Camera / text options
|
||||
name_frame = ttk.LabelFrame(self, text="Naming components", padding=8)
|
||||
name_frame.pack(fill=tk.X, padx=8, pady=4)
|
||||
|
||||
ttk.Label(name_frame, text="Camera tag:").grid(row=0, column=0, sticky=tk.W)
|
||||
camera_menu = ttk.OptionMenu(
|
||||
name_frame, self.camera_tag_var, self.camera_tags[0], *self.camera_tags
|
||||
)
|
||||
camera_menu.grid(row=0, column=1, sticky=tk.W, padx=4)
|
||||
|
||||
ttk.Label(name_frame, text="Custom tag (optional):").grid(
|
||||
row=1, column=0, sticky=tk.W, pady=(4, 0)
|
||||
)
|
||||
ttk.Entry(name_frame, textvariable=self.camera_custom_var, width=20).grid(
|
||||
row=1, column=1, sticky=tk.W, padx=4, pady=(4, 0)
|
||||
)
|
||||
|
||||
ttk.Label(name_frame, text="Extra text:").grid(
|
||||
row=2, column=0, sticky=tk.W, pady=(4, 0)
|
||||
)
|
||||
ttk.Entry(name_frame, textvariable=self.extra_text_var, width=40).grid(
|
||||
row=2, column=1, columnspan=2, sticky=tk.W, padx=4, pady=(4, 0)
|
||||
)
|
||||
ttk.Label(
|
||||
name_frame,
|
||||
text="(Spaces will be converted to '-' in the basename.)",
|
||||
).grid(row=3, column=1, columnspan=2, sticky=tk.W, padx=4, pady=(2, 0))
|
||||
|
||||
# Variant markers
|
||||
vm_frame = ttk.LabelFrame(self, text="Variant markers", padding=8)
|
||||
vm_frame.pack(fill=tk.X, padx=8, pady=4)
|
||||
|
||||
ttk.Label(vm_frame, text="Variant suffixes (comma separated):").grid(
|
||||
row=0, column=0, sticky=tk.W
|
||||
)
|
||||
ttk.Entry(vm_frame, textvariable=self.variant_markers_var, width=30).grid(
|
||||
row=0, column=1, sticky=tk.W, padx=4
|
||||
)
|
||||
ttk.Label(vm_frame, text="Example: _tn,_ws").grid(
|
||||
row=0, column=2, sticky=tk.W, padx=4
|
||||
)
|
||||
|
||||
# Buttons
|
||||
button_frame = ttk.Frame(self, padding=8)
|
||||
button_frame.pack(fill=tk.X)
|
||||
|
||||
ttk.Button(button_frame, text="Preview", command=self.preview).pack(
|
||||
side=tk.LEFT, padx=4
|
||||
)
|
||||
ttk.Button(button_frame, text="Rename", command=self.rename).pack(
|
||||
side=tk.LEFT, padx=4
|
||||
)
|
||||
|
||||
# Info about pattern
|
||||
pattern_label = ttk.Label(
|
||||
button_frame,
|
||||
text=(
|
||||
"Pattern: [date?]_[camera]_[extra]_[group-index] + variant + extension\n"
|
||||
"Example: 2025_0401_d600_family_0001_tn.jpg"
|
||||
),
|
||||
justify=tk.LEFT,
|
||||
)
|
||||
pattern_label.pack(side=tk.LEFT, padx=16)
|
||||
|
||||
# Preview text area
|
||||
text_frame = ttk.Frame(self, padding=8)
|
||||
text_frame.pack(fill=tk.BOTH, expand=True)
|
||||
|
||||
self.preview_text = tk.Text(text_frame, wrap=tk.NONE)
|
||||
self.preview_text.pack(side=tk.LEFT, fill=tk.BOTH, expand=True)
|
||||
|
||||
scrollbar_y = ttk.Scrollbar(text_frame, orient=tk.VERTICAL, command=self.preview_text.yview)
|
||||
scrollbar_y.pack(side=tk.RIGHT, fill=tk.Y)
|
||||
self.preview_text.configure(yscrollcommand=scrollbar_y.set)
|
||||
|
||||
# --------------------------- UI callbacks --------------------------------
|
||||
|
||||
def select_directory(self):
|
||||
dirname = filedialog.askdirectory(title="Select directory to rename")
|
||||
if dirname:
|
||||
self.directory_var.set(dirname)
|
||||
|
||||
def _get_variant_markers(self):
|
||||
raw = self.variant_markers_var.get().strip()
|
||||
if not raw:
|
||||
return DEFAULT_VARIANT_MARKERS
|
||||
return [s.strip() for s in raw.split(",") if s.strip()]
|
||||
|
||||
def _compute_preview_mappings(self):
|
||||
"""Compute the planned renames without performing them."""
|
||||
self.preview_mappings = []
|
||||
self.preview_text.delete("1.0", tk.END)
|
||||
|
||||
dir_str = self.directory_var.get().strip()
|
||||
if not dir_str:
|
||||
messagebox.showerror("Error", "Please select a directory.")
|
||||
return
|
||||
|
||||
directory = Path(dir_str)
|
||||
if not directory.is_dir():
|
||||
messagebox.showerror("Error", f"Not a directory: {directory}")
|
||||
return
|
||||
|
||||
try:
|
||||
variant_markers = self._get_variant_markers()
|
||||
except Exception as e:
|
||||
messagebox.showerror("Error", f"Invalid variant markers: {e}")
|
||||
return
|
||||
|
||||
groups = collect_groups_in_directory(directory, variant_markers)
|
||||
if not groups:
|
||||
self.preview_text.insert(tk.END, "No files found in directory.\n")
|
||||
return
|
||||
|
||||
include_date = self.include_date_var.get()
|
||||
date_format = self.date_format_var.get().strip()
|
||||
camera_tag = self.camera_custom_var.get().strip() or self.camera_tag_var.get().strip()
|
||||
extra_text = self.extra_text_var.get().strip().replace(" ", "-")
|
||||
|
||||
# Build name components that are static across groups
|
||||
name_components = []
|
||||
# date is per-group, so not included here
|
||||
if camera_tag:
|
||||
name_components.append(camera_tag)
|
||||
if extra_text:
|
||||
name_components.append(extra_text)
|
||||
|
||||
# Use a stable ordering of groups
|
||||
group_keys = sorted(groups.keys())
|
||||
seq_width = len(str(len(group_keys))) if len(group_keys) > 0 else 1
|
||||
if seq_width < 4:
|
||||
seq_width = 4
|
||||
|
||||
for idx, group_key in enumerate(group_keys, start=1):
|
||||
files = groups[group_key]
|
||||
# Find earliest logical timestamp in group
|
||||
ts_list = [get_logical_timestamp(p) for p in files]
|
||||
earliest_ts = min(ts_list)
|
||||
dt = datetime.fromtimestamp(earliest_ts)
|
||||
|
||||
# Build base name
|
||||
parts = []
|
||||
if include_date:
|
||||
try:
|
||||
date_part = dt.strftime(date_format)
|
||||
except Exception as e:
|
||||
messagebox.showerror(
|
||||
"Error",
|
||||
f"Invalid date format '{date_format}': {e}",
|
||||
)
|
||||
self.preview_mappings = []
|
||||
return
|
||||
if date_part:
|
||||
parts.append(date_part)
|
||||
|
||||
parts.extend(name_components)
|
||||
|
||||
seq_str = f"{idx:0{seq_width}d}"
|
||||
parts.append(seq_str)
|
||||
|
||||
base = "_".join(p for p in parts if p)
|
||||
|
||||
# For each file in group, preserve variant suffix
|
||||
for p in files:
|
||||
old_stem = p.stem
|
||||
suffix_part = ""
|
||||
if old_stem.startswith(group_key):
|
||||
suffix_part = old_stem[len(group_key) :]
|
||||
new_stem = base + suffix_part
|
||||
new_name = new_stem + p.suffix
|
||||
new_path = p.with_name(new_name)
|
||||
self.preview_mappings.append((p, new_path))
|
||||
|
||||
# Check for collisions (two different old paths yielding same new path)
|
||||
dest_counts = {}
|
||||
for old, new in self.preview_mappings:
|
||||
dest_counts[new] = dest_counts.get(new, 0) + 1
|
||||
collisions = [dst for dst, cnt in dest_counts.items() if cnt > 1]
|
||||
|
||||
if collisions:
|
||||
self.preview_text.insert(
|
||||
tk.END,
|
||||
"WARNING: Naming collisions detected. Some new filenames are not unique.\n",
|
||||
)
|
||||
for c in collisions:
|
||||
self.preview_text.insert(tk.END, f" -> {c}\n")
|
||||
self.preview_text.insert(
|
||||
tk.END,
|
||||
"Please adjust options (e.g., extra text) to avoid collisions.\n\n",
|
||||
)
|
||||
|
||||
# Print mapping
|
||||
for old, new in self.preview_mappings:
|
||||
if old == new:
|
||||
continue
|
||||
self.preview_text.insert(tk.END, f"{old.name} -> {new.name}\n")
|
||||
|
||||
if not self.preview_mappings:
|
||||
self.preview_text.insert(tk.END, "No renames planned.\n")
|
||||
|
||||
def preview(self):
|
||||
self._compute_preview_mappings()
|
||||
|
||||
def rename(self):
|
||||
self._compute_preview_mappings()
|
||||
if not self.preview_mappings:
|
||||
messagebox.showinfo("Info", "No renames to apply.")
|
||||
return
|
||||
|
||||
# Check for collisions again, and abort if any
|
||||
dest_map = {}
|
||||
for old, new in self.preview_mappings:
|
||||
if old == new:
|
||||
continue
|
||||
if new in dest_map and dest_map[new] != old:
|
||||
messagebox.showerror(
|
||||
"Error",
|
||||
f"Collision: multiple files would be renamed to {new.name}\n"
|
||||
"Renaming aborted.",
|
||||
)
|
||||
return
|
||||
dest_map[new] = old
|
||||
|
||||
if not messagebox.askyesno(
|
||||
"Confirm rename",
|
||||
"Apply the listed renames?\n\n"
|
||||
"This will rename files on disk. It is recommended to have a backup.",
|
||||
):
|
||||
return
|
||||
|
||||
# Perform renames
|
||||
errors = []
|
||||
for old, new in self.preview_mappings:
|
||||
if old == new:
|
||||
continue
|
||||
try:
|
||||
old.rename(new)
|
||||
except Exception as e:
|
||||
errors.append((old, new, e))
|
||||
|
||||
if errors:
|
||||
msg_lines = ["Some renames failed:"]
|
||||
for old, new, e in errors:
|
||||
msg_lines.append(f"{old} -> {new}: {e}")
|
||||
messagebox.showerror("Errors during rename", "\n".join(msg_lines))
|
||||
else:
|
||||
messagebox.showinfo("Done", "Renaming completed successfully.")
|
||||
|
||||
# Refresh preview with new names (optional)
|
||||
self.preview()
|
||||
|
||||
# ------------------------------ main ----------------------------------------
|
||||
|
||||
|
||||
def main():
|
||||
app = MFRApp()
|
||||
app.mainloop()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
|
@ -0,0 +1,220 @@
|
|||
#!/usr/bin/env python3
|
||||
"""
|
||||
Sync group modification times in a directory tree.
|
||||
|
||||
New Mode:
|
||||
--collect-suffixes
|
||||
Scans the tree and prints a list of possible variant suffixes
|
||||
extracted from filenames (thumbnail/websize indicators, etc.).
|
||||
|
||||
Normal Mode:
|
||||
- Recursively finds files with matching prefix names.
|
||||
- Uses EXIF DateTimeOriginal or mtime (fallback).
|
||||
- Sets all mtimes in a group to the earliest timestamp.
|
||||
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import os
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
from typing import Dict, List, Tuple, Optional, Set
|
||||
|
||||
from PIL import Image
|
||||
from PIL.ExifTags import TAGS
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# EXIF TIME
|
||||
# ------------------------------------------------------------
|
||||
|
||||
def get_exif_datetime_original(path: Path) -> Optional[datetime]:
|
||||
"""Try to read EXIF DateTimeOriginal."""
|
||||
try:
|
||||
with Image.open(path) as img:
|
||||
exif = img._getexif()
|
||||
if not exif:
|
||||
return None
|
||||
|
||||
exif_data = {TAGS.get(tag_id, tag_id): value for tag_id, value in exif.items()}
|
||||
dto = exif_data.get("DateTimeOriginal")
|
||||
if not dto:
|
||||
return None
|
||||
|
||||
return datetime.strptime(dto, "%Y:%m:%d %H:%M:%S")
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def get_logical_timestamp(path: Path) -> float:
|
||||
"""Return EXIF datetime if available, else mtime."""
|
||||
exif_dt = get_exif_datetime_original(path)
|
||||
if exif_dt is not None:
|
||||
return exif_dt.timestamp()
|
||||
return os.path.getmtime(path)
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# SUFFIX COLLECTION MODE
|
||||
# ------------------------------------------------------------
|
||||
|
||||
def extract_suffixes(stem: str) -> List[str]:
|
||||
"""
|
||||
Extract variant suffixes from a stem.
|
||||
|
||||
Rules:
|
||||
- If the stem has '_' or '-', the part *after* that segment may be a variant.
|
||||
- We collect suffixes such as:
|
||||
IMG_1234_tn -> _tn
|
||||
IMG_1234_ws-800 -> _ws-800
|
||||
dsc_0001-thumb -> -thumb
|
||||
- If multiple underscores/dashes exist, collect each trailing segment.
|
||||
"""
|
||||
suffixes = []
|
||||
|
||||
# Collect suffixes after last "_" and last "-"
|
||||
for sep in ["_", "-"]:
|
||||
if sep in stem:
|
||||
idx = stem.lower().find(sep)
|
||||
if idx > 0 and idx < len(stem) - 1:
|
||||
suffix = stem[idx:] # include the separator
|
||||
suffixes.append(suffix)
|
||||
|
||||
return suffixes
|
||||
|
||||
|
||||
def collect_possible_suffixes(root: Path) -> Dict[str, int]:
|
||||
"""
|
||||
Scan directory tree and collect all observed suffixes.
|
||||
Returns dict: suffix -> count
|
||||
"""
|
||||
counts: Dict[str, int] = {}
|
||||
|
||||
for path in root.rglob("*"):
|
||||
if not path.is_file():
|
||||
continue
|
||||
|
||||
stem = path.stem
|
||||
for s in extract_suffixes(stem):
|
||||
counts[s] = counts.get(s, 0) + 1
|
||||
|
||||
return counts
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# NORMAL GROUPING MODE
|
||||
# ------------------------------------------------------------
|
||||
|
||||
def derive_group_key(stem: str, variant_suffixes: List[str]) -> str:
|
||||
"""Strip known variant suffixes from the stem to find a grouping prefix."""
|
||||
s_lower = stem.lower()
|
||||
positions = []
|
||||
|
||||
for marker in variant_suffixes:
|
||||
marker_l = marker.lower()
|
||||
idx = s_lower.find(marker_l)
|
||||
if idx != -1:
|
||||
positions.append(idx)
|
||||
|
||||
if not positions:
|
||||
return stem
|
||||
|
||||
cutoff = min(positions)
|
||||
if cutoff <= 0:
|
||||
return stem
|
||||
|
||||
return stem[:cutoff]
|
||||
|
||||
|
||||
def collect_groups(root: Path, variant_suffixes: List[str]) -> Dict[str, List[Tuple[Path, float]]]:
|
||||
"""Walk tree and group files by derived key."""
|
||||
groups: Dict[str, List[Tuple[Path, float]]] = {}
|
||||
|
||||
for path in root.rglob("*"):
|
||||
if not path.is_file():
|
||||
continue
|
||||
|
||||
key = derive_group_key(path.stem, variant_suffixes)
|
||||
ts = get_logical_timestamp(path)
|
||||
|
||||
groups.setdefault(key, []).append((path, ts))
|
||||
|
||||
return groups
|
||||
|
||||
|
||||
def adjust_group_mtimes(groups: Dict[str, List[Tuple[Path, float]]], dry_run: bool = False) -> None:
|
||||
"""Set all mtimes in each group to the earliest timestamp."""
|
||||
for group_key, items in sorted(groups.items(), key=lambda kv: kv[0]):
|
||||
earliest_ts = min(ts for _, ts in items)
|
||||
earliest_iso = datetime.fromtimestamp(earliest_ts).isoformat(sep=" ")
|
||||
|
||||
print(f"\nGroup '{group_key}': {len(items)} file(s)")
|
||||
print(f" Earliest logical timestamp: {earliest_iso}")
|
||||
|
||||
for path, _ in items:
|
||||
st = os.stat(path)
|
||||
old_iso = datetime.fromtimestamp(st.st_mtime).isoformat(sep=" ")
|
||||
|
||||
if dry_run:
|
||||
print(f" [DRY-RUN] {path} mtime {old_iso} -> {earliest_iso}")
|
||||
else:
|
||||
os.utime(path, (st.st_atime, earliest_ts))
|
||||
print(f" Updated {path} mtime {old_iso} -> {earliest_iso}")
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# MAIN
|
||||
# ------------------------------------------------------------
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
description=(
|
||||
"Normalize mtimes of related photo/video/audio files by grouping them "
|
||||
"via basename prefixes.\n\n"
|
||||
"New: --collect-suffixes to scan for possible variant suffixes."
|
||||
)
|
||||
)
|
||||
parser.add_argument("root_dir", help="Root directory to scan recursively")
|
||||
parser.add_argument("--suffixes", nargs="*", default=["_tn", "_ws"],
|
||||
help="Known variant suffix markers")
|
||||
parser.add_argument("--dry-run", action="store_true",
|
||||
help="Show changes but do not modify file timestamps")
|
||||
parser.add_argument("--collect-suffixes", action="store_true",
|
||||
help="Scan and list all observed filename suffix variants")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
root = Path(args.root_dir).expanduser().resolve()
|
||||
if not root.is_dir():
|
||||
raise SystemExit(f"Not a directory: {root}")
|
||||
|
||||
if args.collect_suffixes:
|
||||
print(f"Collecting possible suffixes in: {root}")
|
||||
counts = collect_possible_suffixes(root)
|
||||
|
||||
if not counts:
|
||||
print("No suffixes detected.")
|
||||
return
|
||||
|
||||
print("\nSuffixes found (sorted by frequency):")
|
||||
for suf, cnt in sorted(counts.items(), key=lambda kv: -kv[1]):
|
||||
print(f" {suf:20} {cnt} files")
|
||||
|
||||
print("\nSuggested suffix list (deduplicated):")
|
||||
unique = sorted(counts.keys(), key=str.lower)
|
||||
print(" ", " ".join(unique))
|
||||
return
|
||||
|
||||
# Normal mode
|
||||
print(f"Grouping using suffixes: {args.suffixes}")
|
||||
groups = collect_groups(root, args.suffixes)
|
||||
|
||||
total_files = sum(len(v) for v in groups.values())
|
||||
print(f"Found {total_files} files across {len(groups)} groups.")
|
||||
|
||||
adjust_group_mtimes(groups, dry_run=args.dry_run)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
|
|
@ -0,0 +1,480 @@
|
|||
#!/usr/bin/env python3
|
||||
"""
|
||||
msauto_derivative.py
|
||||
|
||||
Across a directory tree, find groups of "related" files that share a common
|
||||
basename prefix (original + variants like _tn, _ws, etc.). For each group:
|
||||
|
||||
- Determine an "original" image file using:
|
||||
* File type priority (RAW > standard image > other),
|
||||
* EXIF DateTimeOriginal (if present) or filesystem mtime,
|
||||
* and a slight penalty for stems that look like variant names.
|
||||
|
||||
- Run an ImageMagick command on the original to produce a full-image
|
||||
derivative with color correction, sigmoidal contrast, and light sharpening.
|
||||
|
||||
- Save the result as:
|
||||
<group-base>-msauto.jpg
|
||||
in the same directory as the chosen original, unless that file already exists.
|
||||
|
||||
The "group base" is the stem with variant suffix markers removed
|
||||
(e.g., P1040123 from P1040123_ws-2048, P1040123_tn, etc.).
|
||||
|
||||
Requires:
|
||||
- Python 3.8+
|
||||
- Pillow (PIL)
|
||||
- ImageMagick ("magick" or "convert" on PATH)
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import subprocess
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Tuple, Optional
|
||||
|
||||
from PIL import Image
|
||||
from PIL.ExifTags import TAGS
|
||||
|
||||
# Multi-processing
|
||||
from functools import partial
|
||||
from concurrent.futures import ProcessPoolExecutor, as_completed
|
||||
|
||||
# Common extensions
|
||||
RAW_EXTS = {
|
||||
".nef", ".cr2", ".cr3", ".raf", ".arw", ".dng",
|
||||
".orf", ".rw2", ".pef", ".sr2", ".srf", ".kdc", ".erf", ".mrw",
|
||||
}
|
||||
IMAGE_EXTS = {
|
||||
".jpg", ".jpeg", ".tif", ".tiff", ".png", ".heic", ".heif",
|
||||
".webp", ".bmp",
|
||||
}
|
||||
# video/audio present in tree but we don't generate derivatives from them
|
||||
VIDEO_EXTS = {
|
||||
".mp4", ".mov", ".avi", ".mkv", ".mts", ".m2ts", ".wmv",
|
||||
}
|
||||
AUDIO_EXTS = {
|
||||
".wav", ".flac", ".mp3", ".aac", ".m4a",
|
||||
}
|
||||
|
||||
|
||||
# --------------------------- EXIF + mtime logic -----------------------------
|
||||
|
||||
def get_exif_datetime_original(path: Path) -> Optional[datetime]:
|
||||
"""
|
||||
Try to read EXIF DateTimeOriginal from an image.
|
||||
|
||||
Returns a datetime object if found and parsable; otherwise None.
|
||||
"""
|
||||
try:
|
||||
with Image.open(path) as img:
|
||||
exif = img._getexif()
|
||||
if not exif:
|
||||
return None
|
||||
|
||||
exif_data = {TAGS.get(tag_id, tag_id): value for tag_id, value in exif.items()}
|
||||
dto = exif_data.get("DateTimeOriginal")
|
||||
if not dto:
|
||||
return None
|
||||
|
||||
# Typical EXIF datetime format: "YYYY:MM:DD HH:MM:SS"
|
||||
try:
|
||||
return datetime.strptime(dto, "%Y:%m:%d %H:%M:%S")
|
||||
except (ValueError, TypeError):
|
||||
return None
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def get_logical_timestamp(path: Path) -> float:
|
||||
"""
|
||||
Get the best available "capture" timestamp for the file as a POSIX float.
|
||||
|
||||
Preference:
|
||||
1. EXIF DateTimeOriginal (if available);
|
||||
2. Else filesystem modification time (mtime).
|
||||
"""
|
||||
exif_dt = get_exif_datetime_original(path)
|
||||
if exif_dt is not None:
|
||||
return exif_dt.timestamp()
|
||||
return os.path.getmtime(path)
|
||||
|
||||
|
||||
# --------------------------- Grouping logic ---------------------------------
|
||||
|
||||
def derive_group_key(stem: str, variant_markers: List[str]) -> str:
|
||||
"""
|
||||
Given a stem (basename without extension) and a list of variant markers
|
||||
like ["_tn", "_ws"], derive a group key that is the shared "base" prefix.
|
||||
|
||||
We look for the earliest occurrence (by index) of any marker; everything
|
||||
BEFORE that index is considered the group base.
|
||||
|
||||
Examples:
|
||||
stem = "P1040123" -> "P1040123"
|
||||
stem = "P1040123_tn" -> "P1040123"
|
||||
stem = "P1040123_ws-2048" -> "P1040123"
|
||||
stem = "DSC0001-preview" -> "DSC0001" if "-preview" is in markers
|
||||
"""
|
||||
s_lower = stem.lower()
|
||||
positions = []
|
||||
|
||||
for marker in variant_markers:
|
||||
m_lower = marker.lower()
|
||||
idx = s_lower.find(m_lower)
|
||||
if idx != -1:
|
||||
positions.append(idx)
|
||||
|
||||
if not positions:
|
||||
return stem
|
||||
|
||||
cutoff = min(positions)
|
||||
if cutoff <= 0:
|
||||
return stem
|
||||
return stem[:cutoff]
|
||||
|
||||
|
||||
def collect_groups(
|
||||
root: Path,
|
||||
variant_markers: List[str],
|
||||
include_video: bool = False,
|
||||
include_audio: bool = False,
|
||||
) -> Dict[str, List[Path]]:
|
||||
"""
|
||||
Walk the directory tree under 'root', grouping files by derived group key.
|
||||
|
||||
Files whose stem ends with "-msauto" are ignored so that re-running the
|
||||
script won't treat existing derivatives as new inputs.
|
||||
|
||||
Returns:
|
||||
{group_key: [Path, Path, ...], ...}
|
||||
"""
|
||||
groups: Dict[str, List[Path]] = {}
|
||||
|
||||
for path in root.rglob("*"):
|
||||
if not path.is_file():
|
||||
continue
|
||||
|
||||
stem = path.stem
|
||||
|
||||
# Ignore any existing msauto derivatives
|
||||
if stem.lower().endswith("-msauto"):
|
||||
continue
|
||||
|
||||
ext = path.suffix.lower()
|
||||
# We allow all file types into groups, but you'll typically care about
|
||||
# RAW + image files as candidates for the "original".
|
||||
if (
|
||||
ext not in RAW_EXTS
|
||||
and ext not in IMAGE_EXTS
|
||||
and not (include_video and ext in VIDEO_EXTS)
|
||||
and not (include_audio and ext in AUDIO_EXTS)
|
||||
):
|
||||
# Non-media junk (txt, sidecar, etc.) — skip from grouping.
|
||||
# If you *do* want sidecars in a group, remove this filter.
|
||||
continue
|
||||
|
||||
key = derive_group_key(stem, variant_markers)
|
||||
groups.setdefault(key, []).append(path)
|
||||
|
||||
return groups
|
||||
|
||||
|
||||
# --------------------------- Original selection -----------------------------
|
||||
|
||||
def rank_candidate(
|
||||
path: Path,
|
||||
variant_markers: List[str],
|
||||
) -> Tuple[int, int, float]:
|
||||
"""
|
||||
Produce a sort key for selecting the "original" from a set of related files.
|
||||
|
||||
Rank tuple:
|
||||
(type_rank, variant_penalty, logical_timestamp)
|
||||
|
||||
where smaller is better:
|
||||
- type_rank: RAW (0) < other image (1) < everything else (2)
|
||||
- variant_penalty: 0 if stem doesn't look like a variant,
|
||||
1 if stem includes a variant marker
|
||||
- logical_timestamp: earlier capture time preferred
|
||||
"""
|
||||
ext = path.suffix.lower()
|
||||
if ext in RAW_EXTS:
|
||||
type_rank = 0
|
||||
elif ext in IMAGE_EXTS:
|
||||
type_rank = 1
|
||||
else:
|
||||
type_rank = 2
|
||||
|
||||
s_lower = path.stem.lower()
|
||||
variant_penalty = 0
|
||||
for marker in variant_markers:
|
||||
if marker.lower() in s_lower:
|
||||
variant_penalty = 1
|
||||
break
|
||||
|
||||
ts = get_logical_timestamp(path)
|
||||
return (type_rank, variant_penalty, ts)
|
||||
|
||||
|
||||
def choose_original(
|
||||
group_paths: List[Path],
|
||||
variant_markers: List[str],
|
||||
) -> Optional[Path]:
|
||||
"""
|
||||
Choose the most likely "original" in a group using rank_candidate.
|
||||
"""
|
||||
if not group_paths:
|
||||
return None
|
||||
return min(group_paths, key=lambda p: rank_candidate(p, variant_markers))
|
||||
|
||||
|
||||
# --------------------------- ImageMagick call -------------------------------
|
||||
|
||||
def build_imagemagick_cmd(
|
||||
magick_binary: str,
|
||||
input_path: Path,
|
||||
output_path: Path,
|
||||
) -> List[str]:
|
||||
"""
|
||||
Build the ImageMagick command to generate the msauto derivative.
|
||||
|
||||
This pipeline:
|
||||
- normalizes levels/gamma,
|
||||
- applies sigmoidal contrast,
|
||||
- adds light sharpening,
|
||||
- writes JPEG output.
|
||||
|
||||
You can tweak these flags as desired.
|
||||
"""
|
||||
return [
|
||||
magick_binary,
|
||||
str(input_path),
|
||||
# Basic color / tone normalization:
|
||||
"-auto-level",
|
||||
#"-auto-gamma",
|
||||
# Sigmoidal contrast (moderate):
|
||||
"-sigmoidal-contrast", "2.0,0.5",
|
||||
# Light sharpening:
|
||||
"-unsharp", "0x1+0.5+0.02",
|
||||
# Output JPEG:
|
||||
str(output_path),
|
||||
]
|
||||
|
||||
|
||||
def ensure_imagemagick_available(magick_binary: str) -> None:
|
||||
"""
|
||||
Quick check that the ImageMagick binary is runnable.
|
||||
"""
|
||||
try:
|
||||
subprocess.run(
|
||||
[magick_binary, "-version"],
|
||||
stdout=subprocess.DEVNULL,
|
||||
stderr=subprocess.DEVNULL,
|
||||
check=True,
|
||||
)
|
||||
except Exception as e:
|
||||
raise SystemExit(
|
||||
f"Error: Unable to run ImageMagick binary '{magick_binary}'. "
|
||||
f"Ensure it is installed and on PATH. Details: {e}"
|
||||
)
|
||||
|
||||
|
||||
# --------------------------- Main routine -----------------------------------
|
||||
|
||||
|
||||
def run_convert_job(cmd: List[str], dry_run: bool) -> Tuple[str, bool, str]:
|
||||
"""
|
||||
Worker function executed in parallel.
|
||||
Returns (job_id, success, message).
|
||||
"""
|
||||
job_id = cmd[-1] # output file path as an identifier
|
||||
|
||||
if dry_run:
|
||||
return (job_id, True, "[DRY-RUN] Skipped execution.")
|
||||
|
||||
try:
|
||||
subprocess.run(cmd, check=True)
|
||||
return (job_id, True, "OK")
|
||||
except subprocess.CalledProcessError as e:
|
||||
return (job_id, False, f"Convert failed: {e}")
|
||||
|
||||
|
||||
def process_tree(
|
||||
root: Path,
|
||||
magick_binary: str,
|
||||
variant_markers: List[str],
|
||||
dry_run: bool = False,
|
||||
overwrite: bool = False,
|
||||
threads: int = 2,
|
||||
) -> None:
|
||||
|
||||
groups = collect_groups(root, variant_markers)
|
||||
total_groups = len(groups)
|
||||
total_files = sum(len(v) for v in groups.values())
|
||||
|
||||
print(f"Found {total_files} files across {total_groups} groups under {root}")
|
||||
|
||||
# Build the job list (cmds only)
|
||||
jobs = []
|
||||
|
||||
for group_base, paths in sorted(groups.items(), key=lambda kv: kv[0]):
|
||||
original = choose_original(paths, variant_markers)
|
||||
if original is None:
|
||||
continue
|
||||
|
||||
out_name = f"{group_base}-msauto.jpg"
|
||||
output_path = original.parent / out_name
|
||||
|
||||
if output_path.exists() and not overwrite:
|
||||
print(f"[skip] {output_path} exists.")
|
||||
continue
|
||||
|
||||
cmd = build_imagemagick_cmd(magick_binary, original, output_path)
|
||||
jobs.append(cmd)
|
||||
|
||||
print(f"\nPrepared {len(jobs)} convert jobs.")
|
||||
if dry_run:
|
||||
print("Dry-run mode: jobs will not be executed.\n")
|
||||
|
||||
# Run a multi-worker pool
|
||||
print(f"Running with {threads} parallel workers.\n")
|
||||
|
||||
worker = partial(run_convert_job, dry_run=dry_run)
|
||||
|
||||
with ProcessPoolExecutor(max_workers=threads) as exe:
|
||||
futures = {exe.submit(worker, cmd): cmd for cmd in jobs}
|
||||
|
||||
for fut in as_completed(futures):
|
||||
cmd = futures[fut]
|
||||
out_file = cmd[-1]
|
||||
|
||||
try:
|
||||
job_id, ok, msg = fut.result()
|
||||
except Exception as e:
|
||||
print(f"[ERROR] Job for {out_file} crashed: {e}")
|
||||
continue
|
||||
|
||||
if ok:
|
||||
print(f"[OK] {out_file}: {msg}")
|
||||
else:
|
||||
print(f"[FAIL] {out_file}: {msg}")
|
||||
|
||||
|
||||
def process_tree_1(
|
||||
root: Path,
|
||||
magick_binary: str,
|
||||
variant_markers: List[str],
|
||||
dry_run: bool = False,
|
||||
overwrite: bool = False,
|
||||
) -> None:
|
||||
groups = collect_groups(root, variant_markers)
|
||||
total_groups = len(groups)
|
||||
total_files = sum(len(v) for v in groups.values())
|
||||
|
||||
print(f"Found {total_files} files across {total_groups} groups under {root}")
|
||||
|
||||
for group_base, paths in sorted(groups.items(), key=lambda kv: kv[0]):
|
||||
original = choose_original(paths, variant_markers)
|
||||
if original is None:
|
||||
continue
|
||||
|
||||
original_ts = datetime.fromtimestamp(get_logical_timestamp(original)).isoformat(sep=" ")
|
||||
print(f"\nGroup '{group_base}': {len(paths)} file(s)")
|
||||
print(f" Original: {original} (logical time: {original_ts})")
|
||||
|
||||
# Derivative name: <group-base>-msauto.jpg, in original's directory
|
||||
out_name = f"{group_base}-msauto.jpg"
|
||||
output_path = original.parent / out_name
|
||||
|
||||
if output_path.exists() and not overwrite:
|
||||
print(f" Skipping: {output_path} already exists (use --overwrite to replace).")
|
||||
continue
|
||||
|
||||
cmd = build_imagemagick_cmd(magick_binary, original, output_path)
|
||||
print(f" Command: {' '.join(cmd)}")
|
||||
|
||||
if dry_run:
|
||||
print(" [DRY-RUN] Not executing ImageMagick.")
|
||||
continue
|
||||
|
||||
try:
|
||||
subprocess.run(cmd, check=True)
|
||||
print(f" Created: {output_path}")
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f" ERROR running ImageMagick for {original}: {e}")
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
description=(
|
||||
"Across a directory tree, identify groups of related image files by "
|
||||
"basename (original + variants like _tn, _ws, etc.), determine the "
|
||||
"most likely 'original' using EXIF DateTimeOriginal + mtime logic, "
|
||||
"then create a full-image ImageMagick-derived JPEG named "
|
||||
"<basename>-msauto.jpg for each group."
|
||||
)
|
||||
)
|
||||
parser.add_argument(
|
||||
"root_dir",
|
||||
help="Root directory to scan recursively for image groups.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--magick-binary",
|
||||
default="magick",
|
||||
help="ImageMagick executable to use (default: 'magick'; e.g. 'convert' on older installs).",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--variant-markers",
|
||||
nargs="*",
|
||||
default=["_tn", "_ws"],
|
||||
help=(
|
||||
"Variant markers used to detect thumbnails/websize variants in stems. "
|
||||
"Default: _tn _ws"
|
||||
),
|
||||
)
|
||||
parser.add_argument(
|
||||
"--dry-run",
|
||||
action="store_true",
|
||||
help="Show what would be done without running ImageMagick.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--overwrite",
|
||||
action="store_true",
|
||||
help="Overwrite existing <basename>-msauto.jpg files if they already exist.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--threads",
|
||||
type=int,
|
||||
default=3,
|
||||
help="Number of parallel ImageMagick conversions to run (default: 2).",
|
||||
)
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
root = Path(args.root_dir).expanduser().resolve()
|
||||
if not root.is_dir():
|
||||
raise SystemExit(f"Not a directory: {root}")
|
||||
|
||||
ensure_imagemagick_available(args.magick_binary)
|
||||
|
||||
print(f"Scanning: {root}")
|
||||
print(f"Using ImageMagick binary: {args.magick_binary}")
|
||||
print(f"Variant markers: {args.variant_markers}")
|
||||
if args.dry_run:
|
||||
print("[DRY-RUN MODE] No files will be written.\n")
|
||||
|
||||
process_tree(
|
||||
root=root,
|
||||
magick_binary=args.magick_binary,
|
||||
variant_markers=args.variant_markers,
|
||||
dry_run=args.dry_run,
|
||||
overwrite=args.overwrite,
|
||||
threads=args.threads,
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
|
|
@ -0,0 +1,424 @@
|
|||
"""
|
||||
PyGallery.py
|
||||
|
||||
Wesley R. Elsberry
|
||||
|
||||
Minimal automatic gallery construction from a directory tree of images.
|
||||
|
||||
Create a page for a gallery based on the current directory tree of images.
|
||||
Uses CSS flexbox for arrangement.
|
||||
|
||||
Scans for JPG, PNG images in the directory tree.
|
||||
|
||||
Creates thumbnails in a pygal.thumbs directory.
|
||||
|
||||
Strips out EXIF data from thumbnails, mostly for size consideration.
|
||||
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import platform
|
||||
import docopt
|
||||
import PIL
|
||||
import re
|
||||
|
||||
import glob
|
||||
import pathlib
|
||||
|
||||
PROGNAME = "PyGallery.py"
|
||||
# Docstring for docopt use
|
||||
PROGDOCOPT = f"""{PROGNAME}
|
||||
|
||||
USAGE:
|
||||
{PROGNAME} [-h|--help]
|
||||
{PROGNAME} [-v|--version]
|
||||
{PROGNAME} -m [-t <title>] [-f <firstgalleryname>] [-e <excludedirslist>]
|
||||
|
||||
OPTIONS:
|
||||
-h, --help This help message
|
||||
-v, --version Program version
|
||||
-m Make gallery page
|
||||
-t <title> Title [default: Unknown]
|
||||
-f <firstgalleryname> First (top-level) gallery name [default: Unknown]
|
||||
-e <excludedirslist> List of directories to exclude [default: ['pygal.thumbs']]
|
||||
|
||||
{PROGNAME} aims to make it simple to set up an online gallery page
|
||||
using a directory tree of images in JPEG or PNG format.
|
||||
|
||||
By default, {PROGNAME} will produce an 'index.html' file in the current
|
||||
directory. It will create thumbnail images and a 'pygal.thumbs'
|
||||
directory for them.
|
||||
|
||||
Example invocation:
|
||||
|
||||
python {PROGNAME} -m -t 'Elsberry Family Photos' -f 'Elsberry Family'
|
||||
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import platform
|
||||
import docopt
|
||||
import PIL
|
||||
import re
|
||||
import glob
|
||||
import pathlib
|
||||
|
||||
PROGNAME = "PyGallery.py"
|
||||
|
||||
GALLERYTEMPLATE_TOP = """<html>
|
||||
<head>
|
||||
<title>%s</title>
|
||||
<style>
|
||||
div.gallery {
|
||||
margin: 5px;
|
||||
border: 1px solid #ccc;
|
||||
float: left;
|
||||
width: 180px;
|
||||
}
|
||||
div.gallery:hover {
|
||||
border: 1px solid #777;
|
||||
}
|
||||
div.gallery img {
|
||||
width: 100%%;
|
||||
height: auto;
|
||||
}
|
||||
div.desc {
|
||||
padding: 15px;
|
||||
text-align: center;
|
||||
}
|
||||
.container{
|
||||
display:inline-flex;
|
||||
}
|
||||
.box{
|
||||
font-size:35px;
|
||||
padding:15px;
|
||||
}
|
||||
.cards {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
align-items: center;
|
||||
justify-content: flex-start;
|
||||
}
|
||||
.cards img {
|
||||
margin: 10px;
|
||||
border: 3px solid #000;
|
||||
box-shadow: 3px 3px 8px 0px rgba(0,0,0,0.3);
|
||||
max-width: calc(100%%/%s); # This line has been modified
|
||||
}
|
||||
|
||||
/* The Modal (background) */
|
||||
.modal {
|
||||
display: none; /* Hidden by default */
|
||||
position: fixed; /* Stay in place */
|
||||
z-index: 1; /* Sit on top */
|
||||
left: 0;
|
||||
top: 0;
|
||||
width: 100%%; /* Full width */
|
||||
height: 100%%; /* Full height */
|
||||
overflow: auto; /* Enable scroll if needed */
|
||||
background-color: rgba(0,0,0,0.7); /* Black w/ opacity */
|
||||
display: flex; /* Added for centering */
|
||||
align-items: center; /* Center vertically */
|
||||
justify-content: center; /* Center horizontally */
|
||||
}
|
||||
|
||||
/* Modal Content (Image) */
|
||||
.modal-content {
|
||||
margin: auto;
|
||||
display: block;
|
||||
max-width: 90vw; /* set max width to 90%% of viewport width */
|
||||
max-height: 80vh; /* set max height to 80%% of viewport height */
|
||||
}
|
||||
|
||||
/* Close Button */
|
||||
.close {
|
||||
position: absolute;
|
||||
top: 15px;
|
||||
right: 35px;
|
||||
color: #f1f1f1;
|
||||
font-size: 40px;
|
||||
font-weight: bold;
|
||||
transition: 0.3s;
|
||||
}
|
||||
|
||||
.close:hover,
|
||||
.close:focus {
|
||||
color: #bbb;
|
||||
text-decoration: none;
|
||||
cursor: pointer;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>%s</h1>
|
||||
<p>Navigation: Click on a thumbnail to view the image. <Esc> exits the view. Left arrow for previous image, right arrow for next image.</p>
|
||||
"""
|
||||
|
||||
JAVASCRIPT_MODAL = """
|
||||
<script>
|
||||
document.addEventListener("DOMContentLoaded", function() {
|
||||
var images = document.querySelectorAll('.cards img');
|
||||
// rest of your code
|
||||
var currentIndex=0;
|
||||
console.log("images", images);
|
||||
console.log("currentIndex", currentIndex);
|
||||
|
||||
// Get the modal
|
||||
var modal = document.getElementById("myModal");
|
||||
|
||||
// Get the image and insert it inside the modal
|
||||
var modalImg = document.getElementById("img01");
|
||||
|
||||
document.addEventListener('click', function(event) {
|
||||
if(event.target.tagName.toLowerCase() === 'img' && event.target.parentElement.target === "_blank") {
|
||||
modal.style.display = "block";
|
||||
modalImg.src = event.target.parentElement.href;
|
||||
currentIndex = Array.from(images).indexOf(event.target); // Update the currentIndex
|
||||
event.preventDefault(); // Prevent the default behavior of opening the image in a new tab
|
||||
}
|
||||
});
|
||||
|
||||
// Get the <span> element that closes the modal
|
||||
var span = document.getElementsByClassName("close")[0];
|
||||
console.log("span", span);
|
||||
|
||||
// When the user clicks on <span> (x), close the modal
|
||||
span.onclick = function() {
|
||||
modal.style.display = "none";
|
||||
}
|
||||
|
||||
// Close the modal when 'esc' key is pressed
|
||||
document.addEventListener('keydown', function(event) {
|
||||
if (event.key === "Escape" && modal.style.display === "block") {
|
||||
modal.style.display = "none";
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
// Update the modal content based on arrow key pressed
|
||||
document.addEventListener('keydown', function(event) {
|
||||
if (modal.style.display === "block") {
|
||||
if (event.key === "ArrowRight") {
|
||||
currentIndex = (currentIndex + 1) % images.length;
|
||||
modalImg.src = images[currentIndex].parentElement.href;
|
||||
} else if (event.key === "ArrowLeft") {
|
||||
currentIndex = (currentIndex - 1 + images.length) % images.length;
|
||||
modalImg.src = images[currentIndex].parentElement.href;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Close the modal here at the start.
|
||||
modal.style.display = "none";
|
||||
|
||||
});
|
||||
|
||||
|
||||
</script>
|
||||
"""
|
||||
|
||||
GALLERYTEMPLATE_BOTTOM = """
|
||||
|
||||
<!-- The Modal -->
|
||||
<div id="myModal" class="modal">
|
||||
<span class="close">×</span>
|
||||
<img class="modal-content" id="img01">
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
|
||||
GALLERYTEMPLATE_PHOTO = """
|
||||
|
||||
<div class="gallery">
|
||||
<a target="_blank" href="%s">
|
||||
<img src="%s" alt="%s" %s>
|
||||
</a>
|
||||
<div class="desc">%s</div>
|
||||
</div>
|
||||
|
||||
"""
|
||||
|
||||
FLEXTEMPLATE_PHOTO = """
|
||||
|
||||
<div>
|
||||
<a target="_blank" href="%s">
|
||||
<img src="%s" alt="%s" %s>
|
||||
</a>
|
||||
<div class="desc">%s</div>
|
||||
</div>
|
||||
|
||||
"""
|
||||
|
||||
|
||||
def fill_photo_element(fullresname, thumbname, alttext="", caption="", extra=""):
|
||||
filepath, filename = os.path.split(fullresname)
|
||||
filebase, fileext = os.path.splitext(filename)
|
||||
if alttext in [None, ""]:
|
||||
alttext = filebase
|
||||
if caption in [None, ""]:
|
||||
caption = filebase
|
||||
#gtp = GALLERYTEMPLATE_PHOTO % (fullresname, thumbname, alttext, extra, caption)
|
||||
gtp = FLEXTEMPLATE_PHOTO % (fullresname, thumbname, alttext, extra, caption)
|
||||
return gtp
|
||||
|
||||
def endswithany(mystr, endlist=[], usecase=True):
|
||||
matched = False
|
||||
for eli in endlist:
|
||||
matched = matched or mystr.endswith(eli)
|
||||
return matched
|
||||
|
||||
|
||||
def get_file_list(scandir=".", myset={".jpg", ".jpeg", ".jfif", ".png", ".gif"}, excludedirs=['pygal.thumbs']):
|
||||
# print("get_file_list excludedirs", excludedirs)
|
||||
files = [p for p in (p.resolve() for p in pathlib.Path(scandir).glob("**/*") if p.suffix.lower() in myset and not any(exdir in p.parts for exdir in excludedirs))]
|
||||
files = [x for x in files if is_not_excluded(x, excludedirs)]
|
||||
return files
|
||||
|
||||
def is_not_excluded(filepath, excludedirslist):
|
||||
"""
|
||||
Check if the given filepath does not have any directory component
|
||||
that matches an entry in the excludedirslist.
|
||||
|
||||
Args:
|
||||
- filepath (str): The path to the file.
|
||||
- excludedirslist (list): List of directory names to exclude.
|
||||
|
||||
Returns:
|
||||
- bool: True if the file is not in an excluded directory, False otherwise.
|
||||
"""
|
||||
path_parts = pathlib.Path(filepath).parts
|
||||
passed = True
|
||||
for ppi in path_parts:
|
||||
if ppi in excludedirslist:
|
||||
passed = False
|
||||
#passed = not any(exdir in path_parts for exdir in excludedirslist)
|
||||
# print("is_not_excluded", filepath, path_parts, excludedirslist, passed)
|
||||
|
||||
return passed
|
||||
|
||||
# Example usage:
|
||||
#filepath = "/home/user/pygal.thumbs/image.jpg"
|
||||
#excludedirslist = ['pygal.thumbs']
|
||||
#print(is_not_excluded(filepath, excludedirslist)) # This should print False
|
||||
|
||||
|
||||
def add_to_dict_of_lists(dol, key, value):
|
||||
if key in dol:
|
||||
dol[key].append(value)
|
||||
else:
|
||||
dol[key] = [value]
|
||||
return dol
|
||||
|
||||
def list_to_groups(files):
|
||||
grouped = {}
|
||||
for fi in files:
|
||||
filepath, filename = os.path.split(fi)
|
||||
grouped = add_to_dict_of_lists(grouped, filepath, fi)
|
||||
grouplist = sorted([x for x in grouped.keys()])
|
||||
return grouplist, grouped
|
||||
|
||||
def strip_exif(files, stripper="jpegoptim -s "):
|
||||
for fi in files:
|
||||
cmd = f"{stripper} {fi}"
|
||||
print(cmd)
|
||||
os.system(cmd)
|
||||
|
||||
def prep_thumbs(files, proc='convert', thumbsdir="pygal.thumbs", thumbwidth=128, thumbheight=86):
|
||||
if not os.path.exists(thumbsdir):
|
||||
os.mkdir(thumbsdir)
|
||||
thumbdict = {}
|
||||
thumbfiles = []
|
||||
for fi in files:
|
||||
filepath, filename = os.path.split(fi)
|
||||
oldfn = fi
|
||||
newfn = os.path.join(thumbsdir, "thumb_" + filepath.replace("/", "_") + filename)
|
||||
thumbdict[fi] = newfn
|
||||
thumbfiles.append(newfn)
|
||||
cmd = f"{proc} {oldfn} -resize {thumbwidth}x{thumbheight} -channel RGB -contrast-stretch 0.02x0.02% {newfn}"
|
||||
print(cmd)
|
||||
os.system(cmd)
|
||||
|
||||
strip_exif(thumbfiles)
|
||||
return thumbdict
|
||||
|
||||
def make_index(docargs, maxlineimages=4, excludedirs=['pygal.thumbs']):
|
||||
# print("make_index excludedirs", excludedirs)
|
||||
filesraw = [str(x) for x in get_file_list(excludedirs=excludedirs)]
|
||||
filesraw = [x for x in filesraw if is_not_excluded(x, excludedirs)]
|
||||
# print(excludedirs, filesraw)
|
||||
curdir = os.path.abspath(".")
|
||||
filesrel = sorted([x[len(curdir)+1:] for x in filesraw])
|
||||
#for fri in filesrel:
|
||||
# print(fri)
|
||||
grouplist, grouped = list_to_groups(filesrel)
|
||||
#print(grouplist)
|
||||
#print(grouped)
|
||||
thumbdict = prep_thumbs(filesrel)
|
||||
#print(thumbdict)
|
||||
|
||||
#print(docargs)
|
||||
|
||||
# We have the components. Make the page.
|
||||
pgstr = GALLERYTEMPLATE_TOP % (docargs["-t"],
|
||||
maxlineimages,
|
||||
docargs["-t"])
|
||||
#pgstr += "\n<ul>\n"
|
||||
|
||||
for gli in grouplist:
|
||||
if gli in ['pygal.thumbs']:
|
||||
continue
|
||||
|
||||
if gli in [""]:
|
||||
groupname = docargs["-f"]
|
||||
else:
|
||||
groupname = gli
|
||||
# Emit top
|
||||
pgstr += f"\n<div><h3>{groupname}</h3>\n<div class='cards'>\n"
|
||||
|
||||
# Add photos to gallery
|
||||
for gfi in grouped[gli]:
|
||||
pgstr += fill_photo_element(gfi, thumbdict[gfi])
|
||||
|
||||
# Emit bottom
|
||||
pgstr += "</div>\n</div>\n"
|
||||
|
||||
#pgstr += "\n</ul>\n"
|
||||
pgstr += JAVASCRIPT_MODAL
|
||||
|
||||
|
||||
pgstr += GALLERYTEMPLATE_BOTTOM
|
||||
|
||||
# Put the string out to file
|
||||
fh = open("index.html", "w")
|
||||
fh.write(pgstr)
|
||||
fh.close()
|
||||
print("done.")
|
||||
|
||||
def dispatch(docargs, excludedirs):
|
||||
#print("dispatch excludedirs", excludedirs)
|
||||
if docargs["-m"]:
|
||||
make_index(docargs, maxlineimages=4, excludedirs=excludedirs)
|
||||
|
||||
if __name__ == "__main__":
|
||||
"""
|
||||
filepath = "/home/user/pygal.thumbs/image.jpg"
|
||||
filepath = "/home/user/tmp1/image.jpg"
|
||||
excludedirslist = ['pygal.thumbs', 'alt', 'tmp']
|
||||
print(filepath, excludedirslist, is_not_excluded(filepath, excludedirslist)) # This should print False
|
||||
"""
|
||||
|
||||
|
||||
docargs = docopt.docopt(PROGDOCOPT, version="1.01")
|
||||
|
||||
print(docargs)
|
||||
|
||||
# Extract excludedirs from docargs if specified, otherwise use the default
|
||||
excludedirs = docargs.get('-e', ['pygal.thumbs'])
|
||||
#print('main excludedirs', excludedirs)
|
||||
|
||||
dispatch(docargs, excludedirs=excludedirs)
|
||||
|
||||
print("pygal.py done.")
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
# MemorySharing / ImageGallery
|
||||
|
||||
## A Simple Gallery for Online Photo Sharing
|
||||
|
||||
Other tools in this collection address steps in getting together a collection of suitably processed, oriented, and sized images for a photo frame. However, photo frames are expensive, so having all that effort go into something only someone with a photo frame can appreciate seems less than fully rewarding. How to extend the utility of a photo frame collection? Making that accessible in another way, say as an online gallery, seems reasonable.
|
||||
|
||||
I did some looking, and there are lots of gallery programs or libraries in PHP and Javascript for sharing a single directory of photos. Close, but that's not my use case. I end up with a directory tree, with lots of sub-directories, full of images and nothing else. I needed something to present a reasonably easy-to-navigate gallery of images, suitable for either local access using a browser or hosting on a web site for broader distribution. I didn't find something to my liking, so I ended up writing a command-line program in Python to do the minimal gallery creation job for me. I call it PyGallery.py.
|
||||
|
||||
## PyGallery.py
|
||||
|
||||
The PyGallery.py program is designed to be run in the root directory of the directory tree of images for which you want a gallery.
|
||||
|
||||
### Dependencies
|
||||
|
||||
PyGallery.py requires the following packages:
|
||||
|
||||
- Python
|
||||
- docopt
|
||||
- pillow
|
||||
- pathlib
|
||||
- ImageMagick : Image resizing for thumbnails
|
||||
- JPEGOptim : Removal of EXIF data from thumbnails
|
||||
|
||||
### Installation
|
||||
|
||||
Download PyGallery.py from this repository
|
||||
|
||||
Install ImageMagick
|
||||
|
||||
Install JPEGOptim
|
||||
|
||||
Install Python 3
|
||||
|
||||
Install Python packages : docopt, pillow, pathlib
|
||||
|
||||
### Running
|
||||
|
||||
The usage help display can be seen with:
|
||||
|
||||
python PyGallery.py -h
|
||||
|
||||
Typically, you will want to make a gallery and specify the page title and the top-level directory's name.
|
||||
|
||||
For example,
|
||||
|
||||
python PyGallery.py -m -t='Elsberry Family Photo Gallery' -f='Elsberry Family Photos'
|
||||
|
||||
### Accessing the gallery
|
||||
|
||||
Locally, you can simply launch a browser to view the 'index.html' file in the directory.
|
||||
|
||||
If you are serving the gallery, you can point your browser to the top-level directory on your host, plus 'index.html'. (Often, servers automatically deliver 'index.html' if one requests the directory.)
|
||||
|
||||
It may take some time to load. All the thumbnails will be loaded into that page.
|
||||
|
||||
# Notes
|
||||
|
||||
This is pre-alpha class software currently. I've done several galleries with it so far, but test it to see if it fits your uses.
|
||||
|
|
@ -1,304 +1,504 @@
|
|||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license document.
|
||||
|
||||
4. Combined Works.
|
||||
You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU General Public License.
|
||||
|
||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
||||
|
||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
||||
|
||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
||||
|
||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
||||
|
||||
MemorySharing
|
||||
Copyright (C) 2025 welsberr
|
||||
|
||||
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/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
||||
|
||||
MemorySharing Copyright (C) 2025 welsberr
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library 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
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
|
||||
USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random
|
||||
Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
||||
|
|
|
|||
|
|
@ -1,3 +1,135 @@
|
|||
# MemorySharing
|
||||
|
||||
Tools in Python for processing photos and scans for digital photo frames and online galleries.
|
||||
# MemorySharing
|
||||
Tooling in Python to process process digital images for photo frames and online galleries. Relies on free open source projects.
|
||||
|
||||
## Introduction
|
||||
|
||||
I am myself getting old, with elderly parents, and I recently found myself taking possession of a large collection of photographic prints, slides, and negatives that my parents have collected over the years. Kodak used to advertise their photographic products with slogans about making memories. What I am discovering is that the taking of photos is now considerably easier than organizing, processing, and sharing photos and digital art.
|
||||
|
||||
Like many others, I've turned to use of a digital photo frame as a way to present digital images for my parents to view. Like many others, I'm working through the best ways to prepare images for use on such a device. The particular brand doesn't matter that much, I don't think, in that all of the ones featuring utterly simple setup and use are of modest dimensions and have relatively low native resolution. This means that the 12, 24, or 48 megapixel images coming out of cameras or the high resolution scans from scanners are overkill; one needs to be able to resize to the native resolution limits to efficiently use storage for the photo frame. (BTW, the frame I bought was a 15" Pix-Star, primarily on the ability to display photos even without an internet connection, sending photos to the frame as attachments via email, use of SD cards for additional storage, and ability to remotely manage and configure the frame.)
|
||||
|
||||
I am actively working through my processes, though I consider myself to be at the beginning of this journey. I am putting my work in this repository in the hopes that others may find some benefit in either my discussion or use of my code. Because I am building several of my tools using the PySimpleGui package, I am using the LGL license for materials in this repository. Please remember that this software comes with NO WARRANTY.
|
||||
|
||||
## Goals
|
||||
|
||||
Each of the tools I have placed in this repository is here in order to advance a basic set of goals I have set for my my approach.
|
||||
|
||||
- Workflow efficiency
|
||||
- Throughput
|
||||
- Archival considerations
|
||||
- Aid to organization
|
||||
|
||||
I'll go into more detail as I describe particular tools. In general, my available time to deal with this is quite limited. I've prioritized this project because of the advanced age of my parents and the realization that if I don't put in the time now, it is never going to be as valuable in the future. I surmise many others are in or will find themselves in this position. The overarching concern is to deliver as many images of significance as I can, with quality sufficient for viewing via a photo frame or online gallery. So the thing I've working toward here is to make my time count toward getting a digital image from an initial state to something that is good enough for viewing, not to support making the absolute optimal image out of each. There are plenty of well-regarded image editing tools that handle far finer improvements than what I am aiming for here. This is about getting more memories in front of eyes while those eyes are still around and still care to see them.
|
||||
|
||||
## Tasks
|
||||
|
||||
There are quite a few tasks that I have encountered along the way to preparing images for memory sharing via a photo frame. Only some of these have corresponding software tools.
|
||||
|
||||
### Image acquisition
|
||||
|
||||
To share an image as a memory, you have to have access to it in some form. Some of the forms of imagery I have include:
|
||||
|
||||
- Photographic prints
|
||||
- Framed art
|
||||
- Photographic negatives (both black-and-white and color)
|
||||
- Photographic slides
|
||||
- Newspaper clippings
|
||||
- Computer printouts of photos
|
||||
- Postcards
|
||||
- Video
|
||||
|
||||
Objects are also worthy of recording and sharing.
|
||||
|
||||
- Knick knacks
|
||||
- Trophies
|
||||
- Plaques
|
||||
- Jewelry
|
||||
- Figurines, small sculpture
|
||||
|
||||
I have a background in professional photography and also computer science. I have a wide array of devices that help me go from source materials, as listed above, to digital files to be processed for viewing. That includes:
|
||||
|
||||
- Mirrorless and DSLR digital cameras
|
||||
- Macro lenses for the above
|
||||
- Slide duplicator
|
||||
- Copy stand
|
||||
- Tripod
|
||||
- Light box
|
||||
- Electronic flash
|
||||
- Sheet of black paper
|
||||
- Scanners
|
||||
- Flatbed
|
||||
- Flatbed with transparency scanning
|
||||
- Fujitsu Scansnap document scanners
|
||||
- Film scanners
|
||||
- Composite video digitizer
|
||||
|
||||
Briefly, these are my current processes for image acquisition based on type of image.
|
||||
|
||||
DSLR/Mirrorless camera, macro lens, copy stand or tripod: Large images, framed art, jewelry, special documents
|
||||
|
||||
DSLR/Mirrorless camera, macro lens, copy stand, light box: Non-35mm negatives
|
||||
|
||||
DSLR/Mirrorless camera, slide duplicator, flash: 35mm slide and negatives
|
||||
|
||||
Fujitsu ScanSnap document scanner: Photo prints from 2x2" to letter size, ordinary documents
|
||||
|
||||
You may have noticed that I've covered about the range of source materials and have not mentioned my flatbed scanners or the film scanners. The primary reason is because both of those, at least the ones I have, are slow. The rate of image acquisition drops remarkably once you incorporate either of those into your workflow. I have cameras offering 24MP images with excellent color control and speed, reducing most of the time taken to that needed to shift from one source image to the next. These deliver results I find perfectly adequate to the task here. The scanner I mention by brand because I've found that brand to be reliable and a capable, speedy means of getting reasonably good images from photo prints. The Fujitsu ScanSnap I have doesn't deliver the same quality of results as a top flatbed scanner, or even a pro-sumer oriented photo scanner like the Epson V5** scanners, but it is not bad and operates quickly.
|
||||
|
||||
Why do I list the black sheet of paper? This is a needed item for certain documents and news clippings, or photos with distractingly heavy writing or printing on the back. If one simply scans or images these, one will end up with vestiges of the extraneous material being visible in the image. This can be greatly reduced simply by putting the black paper behind such documents or prints while digitizing them.
|
||||
|
||||
### Image naming
|
||||
|
||||
As you begin doing this, you are going to start running into logistical issues. The first is going to be adequately separating the source materials that remain undigitized from those that have been digitized. I am working on this by having a new box for putting digitized materials in for each box of source materials. The second is that either the camera or the scanner is going to create a series of files with no metadata relevant to the iamges. It is this latter issue that I am working on a software tool to assist with, PyMFR (Python Multi-File Renamer). This is still in progress, but I will make a version available as soon as I have the basic functional form working.
|
||||
|
||||
### Image editing
|
||||
|
||||
Certain classes of images will need post-processing to make them ready for final steps in the journey to the photo frame. Negatives need to be turned into positive versions. Many older negatives or prints may need cropping to eitehr exclude damaged areas or highlight the subject. As mentioned earlier, there are a great many existing photo editors, so one may inquire why I would feel the need for making my own? The answer is, again, trying to make the best use of my time. There are a relatively limited number of adjustments I typically make to either a scanned print or a negative in order to prepare it for viewing. By making my own application, I can put all the most-used options onto a single page, select which ones to apply, and allow me to modify things as needed, while making it simple and reasonably quick to advance through a directory of images. The software tool I have for this I am calling WImageEdit.py. It uses the Python Imaging Library (PIL) for display of source and post-processed images, and calls an external ImageMagick excetuable to actually do the various indicated transformations.
|
||||
|
||||
The essential operations I've identified and included in WImageEdit.py are:
|
||||
|
||||
- Cropping
|
||||
- Rotation (90, 180, 270, and custom degrees clockwise)
|
||||
- Flip/Flop (mirroring)
|
||||
- Inversion/Negation
|
||||
- Brightness/Contrast adjustment
|
||||
- Linear
|
||||
- Sigmoidal
|
||||
- Color correction
|
||||
- Contrast stretch
|
||||
- Resize
|
||||
- Grayscale
|
||||
|
||||
WImageEdit.py is a GUI program written with PySimpleGUI. It should function in any of Windows, Macos, and Linux systems. It has a dependency that ImageMagick needs to be installed and the 'magick' executable be in the path.
|
||||
|
||||
### Batch image operations
|
||||
|
||||
Once images are post-processed, there are still certain things to do that can be handled in a batch process.
|
||||
|
||||
The principal task to be handled is resizing to the resolution of the photo frame. A secondary task would be the removal of EXIF data from JPEG images. If the photo frame does not offer use of EXIF metadata, then removing it from files for the frame can save a significant fraction of the image size.
|
||||
|
||||
The ImgBatch.py command-line tool serves this function for me. It has dependencies on the ImageMagick package being installed and the 'magick' executable being in the path, and also the JPEGOptim excecutable must be in the path. The 'magick' executable handles individual image resizing requests, and the 'jpegoptim' exceutable is used for stripping EXIF data from files.
|
||||
|
||||
A future feature would be the batch modification of EXIF data in all JPEG files in a directory, say for adding a comment or a copyright notice.
|
||||
|
||||
### Online gallery generation
|
||||
|
||||
Photo frames are relatively expensive. It is impractical for most of us to buy a photo frame for every distant relation in our family or everyone in a circle of friends. Yet the time and effort involved in making memories available for sharing seems less worthwhile if the only ones who can benefit are the people who actually get the photo frame in question. I wanted to make the images I've collated available more broadly, and already have a server where I can place a directory of image and other files, so I wrote a simple command-line utilty that generates a single-page gallery from a directory tree of images such as one would deploy to a photo frame. That utility, PyGallery.py, is also dependent on both ImageMagick and JPEGOptim. It walks the directory tree, creates a directory for thumbnail images, creates the thumbnail images, and creates an 'index.html' page. The gallery organization is simple so far. Each directory of images is displayed as a row of thumbnail images. The photo-frame-sized image is linked with a target of a new tab, so viewing the larger file does not navigate away from the gallery page. This is all quite rudimentary at the moment, but it is functional.
|
||||
|
||||
# Acknowledgements
|
||||
|
||||
This set of tools was only possible because of the free open-source software projects it was built from.
|
||||
|
||||
- Python
|
||||
- PySimpleGUI
|
||||
- docopt
|
||||
- pillow (PIL)
|
||||
- Wand
|
||||
- ImageMagick
|
||||
- JPEGOptim
|
||||
|
||||
# Final notes
|
||||
|
||||
As of 2023-01-01, this is all essentially pre-alpha class code. There is very little in the way of testing in place. I've been pressed to be able to do anything in this regard, and this latest holiday break gave me enough time to make what I considered to be a reasonable start on the tooling I've long mused about having.
|
||||
|
||||
As such, I'd urge you to only place copies of digital files where these tools are used, until you have satisfied yourself of the usefulness and reliability of these tools. While I am cognizant of the need to preserve original files where they are and not threaten them with changes, some tools do directly affect original files (PyMFR.py, by renaming files), and other tools could overwrite originals if a bug were present (esp. WImageEdit.py).
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue