tools/README.md
author Pekka Ristola <pekkarr@protonmail.com>
Mon, 27 Jan 2025 19:08:05 +0100
changeset 16096 dbdb98dafd80
parent 14182 fe5bfe70c3c2
permissions -rw-r--r--
Add support for ffmpeg 6.0 - Use the new send_frame/receive_packet API for encoding - Use the new channel layout API for audio - Fix audio recording - Copy codec parameters to the stream parameters - Set correct pts for audio frames - Read audio samples from file directly to the refcounted AVFrame buffer instead of the `g_pSamples` buffer - Use global AVPackets allocated with `av_packet_alloc` - Stop trying to write more audio frames when `WriteAudioFrame` fails with a negative error code - Fix segfault with `g_pContainer->url`. The field has to be allocated with `av_malloc` before writing to it. It's set to `NULL` by default. - Properly free allocations with `avcodec_free_context` and `avformat_free_context`

# tools/ directory

This directory contains various tools for HW development.

To learn more about each individual tool, open its source file in a text editor,
it often contains a brief comment at the top.

## List of tools (excerpt)

### Files
* `update_locale_files.sh`: Update locale files
* `check_engine_locale_files.sh`: Check the engine locale files for missing translations and problems
* `hwmap2lua.sh`: Convert HWMAP files to Lua code for usage in missions
* `create_dmg.sh`: Generate a .dmg file (relevant for Mac)
* `dmg_pkg_install.sh`: Downloads and install a .dmg from a URL (relevant for Mac)
* `docgen.sh`: Generate QTfrontend documentation with Doxygen (it's not very good)
* `check_translations.sh`: Check most translation files for mistakes and generate a simple progress report
* `find_outdated_engine_translations.sh`: Check for strings in engine translations that MIGHT be outdated

### Directories
* `hwmapconverter`: C++ application to edit HWMAP files in text form
* `pas2c`: Pascal-to-C rewriter. Used when hwengine is built as C application with `BUILD_ENGINE_C=1`
* `old`: Very outdated stuff that needs re-examination and possibly deletion