diff --git a/README.md b/README.md index c49d8f8..e1a7584 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,34 @@ # video2geoframes.py -Python script to generate a collection of geotagged images from a video and a GPS track. +Python program to generate a collection of geotagged images from a video and a GPS track. -Designed for contribution to street-level imagery projects like Mapillary or Panoramax. \ No newline at end of file +Designed for contribution to street-level imagery projects like Mapillary or Panoramax. + +## Notes + +This program was originally designed for personal use to contribute to Mapillary and now to Panoramax with a smartphone +(video mode) or a dashcam. + +This v1 is the last version of the original code, published "as it is" with certain known bugs and limitations. + +Since June 2024, a v2 was started to develop with the aim of : +* enhance performances +* fix known bugs +* clean code +* remove non-Python dependencies +* implement more flexible configuration with TOML. + +## ⚠ Bugs and limitations + +| Report | Workaround | +|------------------------------------------------------------------------------------------------------|-------------------------------------------------------| +| [bug] in non-timelapse mode, **FFmpeg** doesn't extract first video frame and shifts every timestamp | 🔃 adding chosen framesampling interval to GPS offset | +| [bug] **ExifTool** timestamp very long (~1 frame / s) | ❌ | +| [bug] uncontrolled incrementation if export directory is on a Samba share (ZFS) | ❌ | +| 9999 frames limit (naming model) | ❌ | + +## License + +This repository, except dependencies, is licensed under **GNU GPL v3**. + +Dependencies are included in repository for development and keep their original license. \ No newline at end of file diff --git a/video2geoframes.py b/video2geoframes.py index 310a413..4a845ce 100644 --- a/video2geoframes.py +++ b/video2geoframes.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """video2geoframes.py -Python script to generate a collection of geotagged images from a video and a GPS track. +Python program to generate a collection of geotagged images from a video and a GPS track. Designed for contribution to street-level imagery projects like Mapillary or Panoramax. """