File | Date | Author | Commit |
---|---|---|---|
deploy | 2023-02-17 | Michiel Jansen | [b4adb1] FPS now passed on correctly to ffmpeg |
installer | 2024-06-02 | Michiel Jansen | [a118b6] Installer to new version |
src | 2024-06-02 | Michiel Jansen | [d30d6f] Espanol finished |
LICENSE | 2010-12-01 | Fabien Valthier | [447f9e] routegen 1.4 |
README.md | 2024-05-25 | Michiel Jansen | [7330cb] German translations added with help of ChatGPT.... |
Route Generator is a tool to draw routes on a map and generate a movie from it.
This movie can be imported in your video editing software, so you can add it to
your own movies.
I have cloned this repository from SourceForge, to have the source code available
on GitHub as well, with the intention that more people are willing to contribute
to it.
On Windows use the distributed installer named routegen-winxx-x.x.exe
On Linux and Mac OS the program has to be build from source code (see below)
Since version x.x Route Generator should be built using Qt 5.15 or higher using CMake.
So Qt 5.15 or higher should be downloaded and installed, including CMake.
Also now Route Generator supports importing GeoTiff maps, so it requires
libgeotiff development libraries to be installed, before it can be build.
Libgeotiff depends on libtiff, libproj and sqlite3, so they have to be installed as well.
Execute the following commands:
- sudo apt install sqlite3
- sudo apt install proj
- sudo apt install libproj-dev
- mkdir libgeotiff
- cd libgeotiff
- git clone https://github.com/OSGeo/libgeotiff.git
- git checkout 1.7.1
- cd libgeotiff
Then follow the GeoTiff installation instructions and choose for the cmake installation,
so that the GeoTIFF package can be found from the CMakeLists.txt, e.g.
- cd build_cmake
- sudo make install
On Windows all dependent packages have to be build from source.
- Download libtiff from https://download.osgeo.org/libtiff/ (at least version 4.5)
- Download Proj (dev) from https://proj.org/download.html (at least version 9.1)
- Download sqlite3 source code from: https://sqlite.org/download.html (sqlite-amalgamation-3400100.zip)
- Download libgeotiff source code from https://github.com/OSGeo/libgeotiff/releases/tag/1.7.1
"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
cd ...\tiff-4.5.0
nmake install
cd ...\sqlite-amalgamation-3400100
copy *.exe file to C:/Users/mjans/dev/local/bin
cd ...\proj-9.1.0
nmake install
cd ...\libgeotiff-1.7.1
After everything is setup correctly, now Route Generator itself can be build.
- unzip or clone the Route Generator source code in a new directory
Note: when using QtCreator on Windows you also have to set the CMAKE_INSTALL_PREFIX key in the CMake
build setting to point to the "C:/Users/mjans/dev/local", directory, otherwise GeoTIFF cannot be found.
Builds release version of routegen executable locally
- make
Will install the release executable in the bin sub-directory
Note that this step is required to create a release executable that has the correct
rpath set to ${ORIGIN}/lib, to be able to distribute the Qt libraries in a lib
sub-directory (defined in qt.conf)!
- make install
Some information regarding translation of Route Generator (up to now only, EN, NL and IT supported)
To generate or update the translation source files, I now manually execute lupdate/lrelease, because
doing this automatic during the build process has some disadvantages. Also it is not required to re-update
the ts files each time. This is only required when new dialogs or (translatable) texts are added.
To regenerate the ts files (i.e. parse the source code to search for new translatable strings:
After this step the ts files can be opened in Qt linguist and translations can be added.
Then to generate the qm files that are used runtime (and should also be deployed):
- lrelease i18n/routegen_nl.ts i18n/routegen_it.ts
Additionally the default Qt translations (e.g. default Ok, Cancel, Yes, No buttons) should
also be available (if available for the translated language), so we (at least) need to deploy
a single translation file for the used Qt base packages.
Finally we embed all required qm files in the routegen.qrc file and reference them from there.
Route Generator is developed using the GPL version of Qt 5.15
(Copyright (C) 2008-2021 The Qt Company Ltd. All rights reserved).
Qt can be downloaded from The Qt Company website.
On Linux, Route Generator makes use of a 3rdparty tool:
FFmpeg licensed under the LGPLv2.1.
This tool is not included in the source, so you will have to install it on
your computer before running Route Generator. Make sure it is installed if you
want to be able to generate a movie.
FFmpeg for Windows is also distributed with Route Generator for Windows
and will be selected as the default at installation.
The CODEX FFmpeg Windows builds are provided by Gyan Doshi from:
https://www.gyan.dev/ffmpeg/builds/
On Windows, Route Generator can also make use of a freeware 3rdparty tool:
Bmp2Avi (Copyright (C) Paul Roberts 1996 - 1998)
This tool is available in the subdirectory bmp2avi. By default Route Generator
tries to find bmp2avi.exe in that directory, so you can leave it there.
Route Generator will automatically check for bmp2avi.exe in this directory
when it starts up. If it cannot find it in the default location, it will ask
you to browse to a different location.
Bmp2Avi can freely be re-distributed as long as you provide the documentation
with it (also located in the bmp2avi sub-directory).
Route Generator is build for Windows and Linux by default.
However, it's developed using the cross-platform GUI toolkit, Qt,
which is also available for other Mac. So it is also possible
to build and run Route Generator on Mac as well, but you have to build it
yourself from the source code (see building instructions below).
NOTE: Route Generator makes use of a video encoder (Bmp2Avi on Windows and
ffmpeg on linux)! However, the video encoder is not required to run Route
Generator. The only thing that will not work without the video encoder is the
last stage of the generation process:converting a list of bmp files to an avi
file.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
For more details about GPL see the LICENSE file
If you have any more questions about or problems with using and or building
Route Generator, you can contact me at: info@routegenerator.net
Of course, suggestions for improvement are also welcome!
Michiel Jansen