txt2mca - Changelog
===================

All notable changes to txt2mca are documented here.
Newest release first.

[1.1.1] - 2026-11-19
--------------------
- Removed `<CL>`, `<K>` and `<IMI>`
  from list of prosigns in txt2mca.
  - Updated txt2mca_supported_morse_characters.pdf.
  - Updated DF7TV-txt2mca-sample.txt.

[1.1.0] - 2026-11-17
--------------------
- Consolidated improvements from subsequent development
  into a new stable release based on v1.0.0.
- Expanded Morse code support:
  - Added further national and accented characters.
  - Added additional prosigns, including `<K>`, `<IMI>`,
    `<KA>` and `<SN>`.
  - Added alternative prosign notations (aliases).
- Improved handling of German letter eszett / sharp S (U+00DF),
  encoded as the two separate Morse characters `S` and `Z`.
- Improved prosign recognition and handling:
  - Supports prosigns across text-processing chunk boundaries.
  - Improved handling of unknown and incomplete prosigns.
- Improved UTF-8 BOM compatibility for input and
  configuration files.
- Improved debug audio output:
  - Original unfiltered PCM WAV output retained.
  - Added separate FFmpeg-filtered WAV output when both
    DEBUG_MODE and BPF are enabled.
  - Improved reporting of generated debug WAV files,
    including when conversion is stopped by the user.
- Corrected unsupported-character reporting to display
  a single backslash (`\`) instead of its escaped
  representation (`\\`).
- Retained the original single-process FFmpeg audio
  processing pipeline from v1.0.0.
  - The experimental two-stage FFmpeg pipeline introduced
    in v1.0.1 was not retained.
- Tested the consolidated version, including Morse character
  support, prosigns, debug audio output, BPF operation,
  stop handling and error reporting.

[1.0.3] - 2026-11-17
--------------------
- Expanded prosign support:
  - Added `<K>` (Invitation to transmit).
  - Added `<KA>` as an alternative notation (alias)
    for `<CT>` (Commence traffic).
  - Added `<SN>` as an alternative notation (alias)
    for `<VE>` (Understood).
  - Both aliases use the same Morse sequences as
    their corresponding existing prosigns.
- Improved error handling and robustness of the two-stage
  FFmpeg audio processing pipeline:
  - The audio pump thread continues draining filtered audio
    if the MP3 encoder stops accepting data.
  - Prevents the filter process from becoming blocked
    if the encoder terminates unexpectedly.
  - Improved handling of errors occurring while writing
    the filtered debug WAV file.
  - Improved error detection and reporting for pipeline
    failures.
- Verified error handling by testing simulated MP3 encoder
  failure and confirming that the application remains
  responsive and can perform subsequent conversions.

[1.0.2] - 2026-11-16
--------------------
- Further expanded the list of supported Morse characters,
  including additional accented characters encoded using
  simplified base-letter approximations and non-ITU Morse
  extensions.
- Added the following prosign:
  - `<IMI>` (Repeat / say again)
- Updated unsupported-character display in `convert_file()`
  and `conversion_finished()` to display a single backslash
  (`\`) instead of its escaped representation (`\\`).

[1.0.1] - 2026-11-15
--------------------
- Added the following prosigns:
  - `<CL>` (Closing station)
  - `<CT>` (Commence traffic)
  - `<HH>` (Error / correction signal)
  - `<VE>` (Understood)
- Added support for the German letter
  eszett / sharp S (U+00DF),
  encoded as the two separate Morse characters `S` and `Z`
  (based on German naval practice; not a national
  Morse assignment).
- Expanded the list of additional accented characters.
  These are encoded using the Morse sequence of their
  corresponding base letter (simplified approximation).
- Reworked the audio processing pipeline:
  - Split FFmpeg processing into two separate stages.
  - Stage 1: Raw PCM audio is passed through FFmpeg's
    band-pass filter (BPF), if enabled.
  - Stage 2: The resulting PCM audio is passed to FFmpeg
    for MP3 encoding only.
  - Filtered PCM audio is transferred directly between
    the two FFmpeg processes using a pipe.
  - No intermediate PCM file is required.
- Preserved the existing BPF frequency and bandwidth settings.
- Added error handling for the two-stage FFmpeg
  processing pipeline.
- Improved debug audio output for inspection and troubleshooting:
  - The original unfiltered audio is still saved as a WAV file
    when `DEBUG_MODE` is enabled.
  - Added an optional separate WAV output containing the
    filtered audio, allowing the BPF result to be inspected
    and compared with the original.
  - The filtered debug WAV is generated only when both
    `DEBUG_MODE` and BPF are enabled.
  - These debug WAV files are for diagnostic purposes only
    and do not affect the normal conversion process.

[1.0.0] - 2026-11-13
--------------------
First stable release.

- The initial development and testing phase is complete.
- The implemented feature set is considered complete.
- No additional features are currently planned.

This release incorporates all improvements and features introduced
during the 0.2.x development series.


[0.2.7] - 2026-11-12
--------------------
- Added support for Morse procedural signs (prosigns):
  - Added the following signs: <AR>, <AS>, <BT>,
    <KN> and <SK>.
  - Prosigns are recognized as single tokens, preventing
    unwanted character gaps within their Morse sequences.
  - Added dedicated Morse code mappings for each prosign.


[0.2.6] - 2026-11-11
--------------------
- Improved conversion interface:
  - Added visual feedback for disabled Edge-Shaping controls.
  - Adjusted Edge-Shaping combobox colors for better consistency
    with other input fields.
- Added conversion elapsed-time reporting when conversion completes.
- Added support for decimal commas in WPM and frequency settings.
  Values are normalized to decimal points when saved and used.
- Fixed a missing WPM variable initialization in
  update_rise_time_display().
- Added an ON/OFF switch for the existing Band-Pass Filter (BPF)
  to the graphical interface.
- BPF is enabled by default on fresh installations.
  Keeping BPF enabled is recommended.
- The selected BPF state is saved in the configuration file
  and restored when the application is restarted.
- The BPF switch is temporarily disabled during conversion.


[0.2.5] - 2026-11-10
--------------------
- Script comments updated to reflect the code changes
  introduced in v0.2.4, including continuous-phase
  oscillator and cumulative sample counting.
- README updated to clarify timing accuracy and the
  effects of audio filtering and MP3 encoding at
  extremely high Morse speeds.
- Added developer-only DEBUG_MODE, disabled by default.
  - When enabled, an additional uncompressed WAV file
    (txt2mca_debug.wav) is generated alongside the MP3.
  - The debug WAV contains the raw Morse PCM audio before
    FFmpeg filtering and MP3 encoding.
  - Both output files use the same generated PCM stream,
    allowing direct waveform and timing comparisons.
  - Partial debug WAV files are properly finalized when
    conversion is stopped by the user.
  - Debug WAV and MP3 output files are removed if
    conversion fails.
  - DEBUG_MODE is only available in the Python script.


[0.2.4] - 2026-11-09
--------------------
- Improved tone generation for smoother, more consistent
  Morse code audio (continuous-phase sine oscillator).
- Improved timing accuracy through cumulative sample
  counting, preventing small timing differences from
  adding up during longer conversions.
- Improved FFmpeg error reporting to provide more useful
  diagnostic information when conversion fails.
- My heartfelt thanks to Chuck, AA0HW, who drew my
  attention to these necessary changes made in v0.2.4.


[0.2.3] - 2026-11-09
--------------------
- README improved:
  - Clarified how input and output filenames are handled.
  - Added information about macOS compatibility of the
    Python script.
- Windows executable packaged by PyInstaller,
  now using Python 3.12 instead of 3.10.
- Minor changes in the Python script
  (comments, handling of version number, etc.).
- Thanks to Joe/AA8TA, a further tester of the Python script
  for macOS compatibility.


[0.2.2] - 2026-11-07
--------------------
First practically useful release.

- Functional text-to-Morse-code-audio conversion.
- MP3 output using FFmpeg.
- Tkinter graphical user interface.
- Adjustable Morse code parameters.
- Configuration parameters are saved between sessions.
- Audio edge shaping by selectable edge-shaping functions.
- Adjustable Added Code Element Time (keying compensation).
  Tone duration is increased by shortening the following
  silence by the same amount, preserving the overall
  Morse code timing and speed.
- Support for additional pauses through consecutive spaces.
- Windows executable and cross-platform Python script available.
- Windows executable packaged by PyInstaller using Python 3.10.
- Thanks to Mark/AJ6CU, Jeff/N0MII and Holger/DL9HDA,
  who tested the Python script on macOS!


[0.2.1]
-------
Intermediate development release.


[0.2.0]
-------
Initial development version.

