You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Repository Guidelines
2
2
3
3
## Project Structure & Module Organization
4
-
`videostrip_core/` contains the C++17 extraction engine (feature detection, metadata writers, logging). `videostrip_cli/` builds the command-line entry point exported to `build/bin/videostrip_cli`. `videostrip_utils/` hosts shared helpers; `videostrip_gui/` is an experimental viewer. Pipeline templates for Meshroom live under `meshroom/`, sample YAML configs under `configs/`, and generated docs/manpages under `doc/`. Keep CMake build artifacts in `build/` and add new tests beside the existing Catch2 suites in `tests/`.
4
+
`videostrip_core/` contains the C++17 extraction engine (feature detection, metadata writers, logging). `videostrip_cli/` builds the command-line entry point exported to `build/bin/videostrip_cli`. `videostrip_utils/` hosts shared helpers; `videostrip_gui/` is an experimental viewer. Pipeline templates for Meshroom live under its own repository `videostrip-meshroom/`, sample YAML configs under `configs/`, and generated docs/manpages under `doc/`. Keep CMake build artifacts in `build/` and add new tests beside the existing Catch2 suites in `tests/`.
**videostrip** is a modular project for **video frame extraction and keyframe selection** to support **2D/3D reconstruction of underwater video transects**.
10
-
It produces **SfM-ready frame sets** and metadata for tools like **COLMAP, Meshroom, Metashape**, and our (future) **custom video transect pipeline**.
11
+
It produces **SfM-ready frame sets** and metadata for tools like **COLMAP, Metashape**, and our (future) **custom video transect pipeline**.
12
+
13
+
> ⚠️ **Note**: The Meshroom integration node has been moved to a separate repository: [videostrip-meshroom](https://github.com/cappelletto/videostrip-meshroom).
11
14
12
15
---
13
16
@@ -28,7 +31,7 @@ It produces **SfM-ready frame sets** and metadata for tools like **COLMAP, Meshr
28
31
29
32
---
30
33
31
-
## **Key Features (v0.8.2)**
34
+
## **Key Features (v0.7.X onwards)**
32
35
33
36
* ✅ **CLI support** for video processing with YAML or CLI configs.
34
37
* ✅ **Frame extraction with stride or overlap-based selection**.
@@ -61,7 +64,7 @@ It produces **SfM-ready frame sets** and metadata for tools like **COLMAP, Meshr
61
64
62
65
***C++17** compiler
63
66
***CMake ≥ 3.18**
64
-
***OpenCV ≥ 4.5**
67
+
***OpenCV ≥ 4.5** (option: bundle 4.12 for Meshroom compatibility)
TODO: extract this into a separate `docs/enhancement.md`.
145
150
146
151
Starting with **v0.7.x**, videostrip supports an optional **image enhancement stage** that preprocesses frames before feature extraction. This improves contrast and uniformity in underwater imagery.
147
152
@@ -170,8 +175,6 @@ Starting with **v0.7.x**, videostrip supports an optional **image enhancement st
170
175
171
176
### Minimal YAML configuration
172
177
173
-
Add an `enhance` block at the top level of the config file:
174
-
175
178
```yaml
176
179
enhance:
177
180
enable: true
@@ -199,8 +202,6 @@ is set, a default sequence `{grayworld, clahe(YCrCb)}` will be applied.
199
202
200
203
### CLI override
201
204
202
-
You can also pass a shorthand string (for quick tests):
* Cross-platform GUI for both pipeline configuration and dispatching.
231
-
* Integration with Meshroom (node-base core library)
235
+
* Meshroom integration continues in [videostrip-meshroom](https://github.com/cappelletto/videostrip-meshroom)
232
236
233
237
---
234
238
239
+
## **Contributing?**
240
+
241
+
For more information on how to contribute to this project, please visit the [Contributing guidelines](CONTRIBUTING.md)
242
+
235
243
## **License**
236
244
237
245
**Dual License Notice**
238
246
239
247
videostrip is dual-licensed under:
240
248
241
-
* Apache License, Version 2.0
242
-
(see LICENSE.Apache or https://www.apache.org/licenses/LICENSE-2.0)
249
+
* Apache License, Version 2.0
250
+
(see LICENSE.Apache or [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0))
243
251
244
-
* GNU Lesser General Public License, Version 3.0 or later
245
-
(see LICENSE.LGPL or https://www.gnu.org/licenses/lgpl-3.0.html)
252
+
* GNU Lesser General Public License, Version 3.0 or later
253
+
(see LICENSE.LGPL or [https://www.gnu.org/licenses/lgpl-3.0.html](https://www.gnu.org/licenses/lgpl-3.0.html))
246
254
247
255
You may choose to use *videostrip* as a whole under either license. Note that some dependencies (e.g., OpenCV with non-free modules) have their own licensing terms.
- Completed the Meshroom integration split: all node templates and scripts now live in the new [videostrip-meshroom](https://github.com/cappelletto/videostrip-
7
+
meshroom) repository, keeping this tree focused on the core extractor and CLI.
8
+
- Added `scripts/todo2issues.py`, a GitHub CLI helper that turns structured sections in `doc/TODO.md` into labelled issues (supports dry-run, milestone
9
+
assignment, and cross-repo targeting).
10
+
11
+
## Breaking Changes
12
+
- Meshroom node assets (`meshroom/` and `doc/TODO.md` entries tied to them) have been removed from this repository. Clone `videostrip-meshroom` alongside
13
+
`videostrip` if you rely on Meshroom pipelines.
14
+
15
+
## Enhancements
16
+
- Promoted the bundled `args.hxx` header to `third_party/args.hxx` and rewired include paths in the CLI/core targets, simplifying packaging and making the
17
+
dependency boundary explicit.
18
+
- Pruned the unused `videostrip_utils` module to reduce build surface area.
19
+
20
+
## Documentation
21
+
- README now opens with the Meshroom migration notice, refreshed build/usage guidance, and a direct link to the contributing guide.
22
+
- AGENTS.md updated to reference the new Meshroom repository and keep contributor roles accurate.
23
+
24
+
## Maintenance
25
+
- TODO backlog cleaned while moving Meshroom work items into issue automation.
26
+
- Version bumped to 0.9.2 in CMake to anchor release artifacts.
27
+
28
+
## Upgrade Notes
29
+
- Consumers who automated Meshroom flows should fetch `videostrip-meshroom` and update any paths that previously referenced `meshroom/` inside this repo.
30
+
- To try the TODO automation, install GitHub CLI, then run:
0 commit comments