Spelling fixes and README.md enhancement

This commit is contained in:
2024-06-28 22:54:06 +02:00
parent 90e6c3f155
commit eef9b7a87b
2 changed files with 36 additions and 19 deletions

View File

@@ -12,13 +12,14 @@ Designed for ease contribution to street-level imagery projects like Mapillary o
Nothing simpler : collect your video, your GPS track, execute Python script and follow the guide ! Nothing simpler : collect your video, your GPS track, execute Python script and follow the guide !
In detail, the program is built around a TUI or _Textual User Interface_, permitting to launch video process easily with In detail, the program is built around a TUI or _Textual User Interface_, allowing to launch video process easily with
step-by-step parameters input. step-by-step parameter input.
Input is guided by textual help indicating attempted values. Input is guided by textual help indicating expected values.
Before script starting, you need to have : Before script starting, you need to have :
* a video file with exact timestamp (start) in local time or UTC * a video file (max. 1h23 min)
* known the exact timestamp (start) in local time or UTC
* a clean GPS tack file covering video duration * a clean GPS tack file covering video duration
* a working directory. * a working directory.
@@ -28,9 +29,21 @@ _Coming soon._
## Features ## Features
_Coming soon._ Program allows in one process to execute following tasks :
* video sampling according to a time interval
* incremental timestamp of frame sequence
* frames export to JPEG format
* exported frames geotagging from GPS track.
### Comparison v1 / v2 It also includes :
* timelapse video support
* frame resizing to a less resolution than original video with ratio keeping
* metadata adding in EXIF tags `artist`, `make`, `model` et `copyright` (see [documentation ExifTool](https://exiftool.org/TagNames/EXIF.html))
* millisecond accuracy timestamp
* local time support with UTC offset
* temporal offset adding for correlate video and GPS.
### Features v1 / v2
| Features | v1-beta | v2-alpha9 | | Features | v1-beta | v2-alpha9 |
|-----------------------------|------------|------------| |-----------------------------|------------|------------|
@@ -41,8 +54,8 @@ _Coming soon._
| Progress displaying | 🟡 raw | ✔️ | | Progress displaying | 🟡 raw | ✔️ |
| Multilingual TUI 🇺🇳 | 🟡 limited | ✔️ | | Multilingual TUI 🇺🇳 | 🟡 limited | ✔️ |
| Configuration customization | ❌ | 🟡 partial | | Configuration customization | ❌ | 🟡 partial |
| JPEG qualtiy customization | ❌ | 🔄 planned | | JPEG quality customization | ❌ | 🔄 planned |
| TOML setting | ❌ | 🔄 planned | | TOML process setting | ❌ | 🔄 planned |
## Languages ## Languages
@@ -51,7 +64,7 @@ TUI is multilingual thanks to "locales" base in the form of TOML files (`locales
| Languages | Locale | Support | Maintainer | | Languages | Locale | Support | Maintainer |
|--------------|---------|------------|--------------| |--------------|---------|------------|--------------|
| 🇺🇸 English | `en_us` | ✔️ 100 % | @lumathieu | | 🇺🇸 English | `en_us` | ✔️ 100 % | @lumathieu |
| 🇫🇷 French | `fr_fr` | ✔️ 100 % | @lumathieu | | 🇫🇷 French | `fr_fr` | ✔️ 99 % | @lumathieu |
| 🇮🇹 Italian | `it_it` | 🔄 planned | @lumathieu ? | | 🇮🇹 Italian | `it_it` | 🔄 planned | @lumathieu ? |
## Versions ## Versions
@@ -67,7 +80,7 @@ Recommended to use a virtual environnement (venv).
Entire project is developed and tested on **Python 3.11** (Windows x86-64). Entire project is developed and tested on **Python 3.11** (Windows x86-64).
### Dépendances ### Dependencies
Core script uses following Python libraries (see also `requirements.txt`) : Core script uses following Python libraries (see also `requirements.txt`) :
- `numpy` - `numpy`
@@ -76,11 +89,14 @@ Core script uses following Python libraries (see also `requirements.txt`) :
- `tomlkit` - `tomlkit`
- `tqdm`. - `tqdm`.
It also uses [`ExifTool`](https://exiftool.org/) for frame geotagging.
Call by a system command, this dependency is intended to be removed in future versions.
## Compatibility ## Compatibility
Code is designed to be platform-independent. Code is designed to be platform-independent.
Official supported platforms are Windows and Linux (partially tested under Debian / Ubuntu). At time, code as been "tested" on Windows and Linux platforms (partially under Debian / Ubuntu).
## Contribution ## Contribution

View File

@@ -18,7 +18,8 @@ facilement le traitement de la vidéo par la saisie pas-à-pas des paramètres.
La saisie est guidée par une aide textuelle indiquant les valeurs attendues. La saisie est guidée par une aide textuelle indiquant les valeurs attendues.
Avant de lancer le script, vous avez besoin d'avoir : Avant de lancer le script, vous avez besoin d'avoir :
* un fichier vidéo avec son horodatage exact (début) en temps local ou UTC * un fichier vidéo (max. 1h23 min)
* connaître son horodatage exact (début) en temps local ou UTC
* un fichier de trace GPS propre couvrant la durée de la vidéo * un fichier de trace GPS propre couvrant la durée de la vidéo
* un dossier de travail. * un dossier de travail.
@@ -40,11 +41,11 @@ Il inclut également :
* l'ajout de métadonnées avec les tags EXIF `artist`, `make`, `model` et `copyright` (cf. [documentation ExifTool](https://exiftool.org/TagNames/EXIF.html)) * l'ajout de métadonnées avec les tags EXIF `artist`, `make`, `model` et `copyright` (cf. [documentation ExifTool](https://exiftool.org/TagNames/EXIF.html))
* l'horodatage à la précision de la milliseconde * l'horodatage à la précision de la milliseconde
* le support du temps local décalé par rapport à UTC. * le support du temps local décalé par rapport à UTC.
* l'ajout d'un décalage temporel pour mieux corréler la vidéo et la trace GPS. * l'ajout d'un décalage temporel pour corréler la vidéo et la trace GPS.
Lors de l'export, un sous-dossier nommé selon la vidéo est créé automatiquement dans le répertoire de sortie. Lors de l'export, un sous-dossier nommé selon la vidéo est créé automatiquement dans le répertoire de sortie.
### Comparaison v1 / v2 ### Fonctionnalités v1 / v2
| Fonctionnalité | v1-beta | v2-alpha9 | | Fonctionnalité | v1-beta | v2-alpha9 |
|--------------------------------------|------------|--------------| |--------------------------------------|------------|--------------|
@@ -55,8 +56,8 @@ Lors de l'export, un sous-dossier nommé selon la vidéo est créé automatiquem
| Affichage de la progression | 🟡 brut | ✔️ | | Affichage de la progression | 🟡 brut | ✔️ |
| TUI multilingue 🇺🇳 | 🟡 limitée | ✔️ | | TUI multilingue 🇺🇳 | 🟡 limitée | ✔️ |
| Personnalisation de la configuration | ❌ | 🟡 partielle | | Personnalisation de la configuration | ❌ | 🟡 partielle |
| Personnalisation qualité JPEG | ❌ | 🔄 planifié | | Personnalisation qualité JPEG | ❌ | 🔄 planifiée |
| Paramétrage via TOML | ❌ | 🔄 planifié | | Paramétrage du traitement via TOML | ❌ | 🔄 planifié |
## Langues ## Langues
@@ -65,7 +66,7 @@ La TUI est multilingue grâce une base de "locales" sous forme de fichiers TOML
| Langue | Locale | Support | Mainteneur | | Langue | Locale | Support | Mainteneur |
|---------------|---------|-------------|--------------| |---------------|---------|-------------|--------------|
| 🇺🇸 Anglais | `en_us` | ✔️ 100 % | @lumathieu | | 🇺🇸 Anglais | `en_us` | ✔️ 100 % | @lumathieu |
| 🇫🇷 Français | `fr_fr` | ✔️ 100 % | @lumathieu | | 🇫🇷 Français | `fr_fr` | ✔️ 99 % | @lumathieu |
| 🇮🇹 Italien | `it_it` | 🔄 planifié | @lumathieu ? | | 🇮🇹 Italien | `it_it` | 🔄 planifié | @lumathieu ? |
## Versions ## Versions
@@ -97,13 +98,13 @@ Appelée par une commande système, cette dépendance est prévue pour être sup
Le code est conçu pour être indépendant de la plateforme. Le code est conçu pour être indépendant de la plateforme.
Les plateformes officiellement supportées sont Windows et Linux (partiellement testé sous Debian / Ubuntu). A ce jour, le code a été "testé" sur les plateformes Windows et Linux (partiellement sous Debian / Ubuntu).
## Contribution ## Contribution
_A venir._ _A venir._
Si vous intéressé pour contribuer au projet, vous pouvez envoyer un mail à campanu@luc-geo.fr. Si vous êtes intéressé pour contribuer au projet, vous pouvez envoyer un mail à campanu@luc-geo.fr.
## Licence ## Licence