📥 lrprev-extract-go

📝 Summary of Project

lrprev-extract-go is a Go-based command-line tool designed for extracting the largest JPEG images embedded within Adobe Lightroom's .lrprev files. In addition to extracting images, the tool can also utilize Lightroom's catalog database (.lrcat) to ensure that the JPG files are stored in a structured way according to their original paths. 🚀

This project aims to facilitate the management of your Lightroom previews and is especially useful for photographers looking to backup or organize their image assets efficiently. With simple command-line options, users can quickly extract images from directories of Lightroom previews or individual files.

⚙️ How to Use

Prerequisites

• Go 1.23.2 or later
• Access to a Lightroom catalog (.lrcat) if you want to structure your output by original paths.

Installation

1. Clone the repository:

   git clone https://github.com/harperreed/lrprev-extract-go.git
   cd lrprev-extract-go

2. Compile the code:

   go build -o lrprev-extract ./cmd/lrprev-extract

3. Install required dependencies on Linux:

   sudo apt-get install -y libgl1-mesa-dev xorg-dev

Commands

The main executable is lrprev-extract. You can invoke it from the command line with the following options:

./lrprev-extract [-d <path-to-lightroom-directory> | -f <path-to-lrprev-file>] [-o <output-directory>] [-l <path-to-lrcat>] [-include-size] [-help]

• -d: Specify the path to a directory containing .lrdata files.
• -f: Specify the path to an individual .lrprev file.
• -o: Specify the output directory where the extracted JPEGs should be saved.
• -l: Specify the path to your Lightroom catalog (.lrcat) [Optional].
• -include-size: Include the size of the images in the filename of the output JPEGs [Optional].
• -help: Display help information and usage examples.

If you don't provide the required arguments, the tool will prompt you for the necessary information interactively.

Example Usage

1. To extract images from a directory:

   ./lrprev-extract -d /path/to/lightroom -o /path/to/output

2. To extract images from a single .lrprev file:

   ./lrprev-extract -f /path/to/file.lrprev -o /path/to/output

3. To extract images and include size information in the filename:

   ./lrprev-extract -d /path/to/lightroom -o /path/to/output -include-size

4. To extract images and use the Lightroom catalog for original file paths:

   ./lrprev-extract -d /path/to/lightroom -o /path/to/output -l /path/to/catalog.lrcat

5. To use the interactive mode:

   ./lrprev-extract

   This will prompt you for the necessary information step by step.

6. To display help information:

   ./lrprev-extract -help

🛠️ Tech Info

• Language: Go
• Dependencies:
  • github.com/mattn/go-sqlite3: A pure Go SQLite driver.
  • github.com/schollz/progressbar/v3: A progress bar for console applications.
  • github.com/rivo/tview: A rich TUI library for Go.

Directory Structure

lrprev-extract-go/
├── README.md          # Documentation file
├── cmd                # Command line interface code
│   └── lrprev-extract # Main executable for the tool
│       └── main.go    # Entry point of the application
├── go.mod             # Go module file for dependencies
├── internal           # Internal logic for the application
│   ├── cli            # CLI interaction logic
│   │   └── cli.go
│   ├── database       # Database interaction logic
│   │   └── database.go
│   ├── extractor      # Extraction logic for JPEGs
│   │   └── extractor.go
│   └── utils          # Utility functions
│       └── utils.go

File Descriptions

• main.go: The main application entry point that handles command-line arguments, interactive prompts, and invokes the appropriate functions for file processing.
• cli.go: Contains functions for interactive prompts and input validation.
• database.go: Contains functions for interacting with the Lightroom catalog database to retrieve original file paths.
• extractor.go: Implements the logic to read .lrprev files, extract JPEGs, and manage the output with detailed progress reporting.
• utils.go: Contains utility functions, including the extraction of UUIDs from filenames.
• utils_test.go: Contains unit tests for the utility functions in utils.go.

TUI Features

The TUI (Text User Interface) has been enhanced with the following features:

• Overall Extraction Progress: Displays an overall extraction progress indicator.
• Enhanced Progress Bars: Multiple progress bars for different stages of the extraction process, such as scanning directories, processing files, and writing output. Different colors for different progress bars to make it easier to distinguish between them. A percentage completion indicator next to each progress bar.
• Real-time Logs and Status Updates: Displays real-time logs and status updates in a separate section of the TUI. Shows detailed information about the current file being processed, including its name and size. Error messages and warnings are displayed in a distinct color to make them stand out.
• Interactive User Input: Users can pause, resume, or cancel the extraction process using keyboard shortcuts. Options for users to change settings, such as the output directory or whether to include image size information, without restarting the application. A help screen that displays available commands and their descriptions.

Testing

The project includes unit tests for the utility functions. To run the tests, use the following command:

go test ./internal/utils

Feel free to contribute! We welcome any improvements or bug fixes. 😊

For issues and feature requests, please create an issue on the GitHub Issues Page or submit a pull request! Happy coding! 💻🔥