Skip to content

Commit 04748f7

Browse files
committed
docs(fix_orientation): deskew / libtiff integration spike notes (#116)
Add DeskewExternalToolSpike.h with an integration outline and list it in the fix_orientation CMake sources for discoverability.
1 parent cc5b626 commit 04748f7

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

src/core/filters/fix_orientation/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ set(ui_files
55
OptionsWidget.ui)
66

77
set(sources
8+
DeskewExternalToolSpike.h
89
ImageView.cpp ImageView.h
910
Filter.cpp Filter.h
1011
OptionsWidget.cpp OptionsWidget.h
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Copyright (C) 2026 ScanTailor-Advanced contributors
2+
// SPDX-License-Identifier: GPL-3.0-or-later
3+
//
4+
// Spike notes for GitHub #116 (TIFF deskew / external deskew integration).
5+
// This header is documentation only; it is not wired into the build.
6+
//
7+
// Integration outline:
8+
// 1. Decide scope: batch-only vs interactive, and whether to shell out to a
9+
// system tool (e.g. tiffcp/tiffutil) vs link libtiff directly.
10+
// 2. If external binary: locate executable per platform (Windows/macOS/Linux),
11+
// validate on startup or lazily, surface a clear error in the UI.
12+
// 3. Pipe I/O: write a temporary TIFF, run deskew, read back; or use in-memory
13+
// API if linking libtiff — mind thread safety with the worker pool.
14+
// 4. Preserve metadata (DPI, photometric) and failure modes (OOM, corrupt TIFF).
15+
// 5. Add an optional CMake feature flag so packagers can disable the dependency.
16+
//
17+
// Prefer keeping experimental code on a branch until packaging and UX are settled.
18+
19+
#ifndef SCANTAILOR_FIX_ORIENTATION_DESKEW_EXTERNAL_TOOL_SPIKE_H_
20+
#define SCANTAILOR_FIX_ORIENTATION_DESKEW_EXTERNAL_TOOL_SPIKE_H_
21+
22+
namespace fix_orientation {
23+
// Intentionally empty: see file comment above.
24+
} // namespace fix_orientation
25+
26+
#endif

0 commit comments

Comments
 (0)