|
| 1 | +# CHANGELOG |
| 2 | + |
| 3 | +## samedec-0.4.1: Maintenance Release |
| 4 | + |
| 5 | +This minor maintenance release helps keep our dependencies |
| 6 | +up-to-date and building smoothly with the latest Rust. |
| 7 | + |
| 8 | +BREAKING |
| 9 | + |
| 10 | +* Due to low demand, CI binaries are no longer built for `-musl` |
| 11 | + Linux ABIs. We continue to support `-gnu` ABIs, which offer |
| 12 | + the best performance when available. We continue to require |
| 13 | + glibc >= 2.28, which makes our binaries compatible with |
| 14 | + Debian 10 (buster), AlmaLinux 8, and more modern distros. If |
| 15 | + you require a musl build, open an issue. |
| 16 | + |
| 17 | +* Update MSRVs: |
| 18 | + |
| 19 | + * `sameold`: 1.70 |
| 20 | + * `samedec`: 1.74 |
| 21 | + |
| 22 | +ENHANCEMENTS |
| 23 | + |
| 24 | +* cargo: update dependencies to the latest-available versions. |
| 25 | + Minor refactors were necessary. |
| 26 | + |
| 27 | +* ci: new builds for: |
| 28 | + |
| 29 | + * `aarch64-apple-darwin` (for M1 macs) |
| 30 | + * `i686-unknown-linux-gnu` |
| 31 | + |
| 32 | +* doc: add [CHANGELOG.md](./CHANGELOG.md) |
| 33 | + |
| 34 | +FIXES |
| 35 | + |
| 36 | +* sameold: permit dead code for Demod::push() |
| 37 | + |
| 38 | +* ci: Linux non-x86 architectures are now built by cross-compiling |
| 39 | + instead of emulated "native" toolchains. This is *much* faster. |
| 40 | + We have created custom container images for this purpose. |
| 41 | + |
| 42 | +## samedec-0.4.0: The Spring 2024 Update |
| 43 | + |
| 44 | +Are you "Weather Ready?" This release is mostly compatible with |
| 45 | +previous versions but adds more SAME codes and environment |
| 46 | +variables. |
| 47 | + |
| 48 | +ENHANCEMENTS |
| 49 | + |
| 50 | +* Support the following new SAME codes: |
| 51 | + |
| 52 | + * EAN: Renamed to National Emergency Message |
| 53 | + * NAT: National Audible Test |
| 54 | + * NST: National Silent Test |
| 55 | + * FSW: Flash Freeze Warning |
| 56 | + * FZW: Freeze Warning |
| 57 | + * HLS: Hurricane Local Statement |
| 58 | + * SQW: Snow Squall Warning |
| 59 | + |
| 60 | +* Discontinue the `SAMEDEC_SIGNIFICANCE` level of "`M`" |
| 61 | + (Message), which is not found anywhere in the standards |
| 62 | + document. The following messages are upgraded to |
| 63 | + Statement: |
| 64 | + |
| 65 | + * ADR: Administrative Message |
| 66 | + * NMN: Network Message Notification |
| 67 | + |
| 68 | +* Improved detection of National Weather Service vs |
| 69 | + Environment Canada. samedec will no longer output a |
| 70 | + generic `SAMEDEC_ORIGINATOR` of "`Weather Service`." |
| 71 | + Instead, samedec will output either |
| 72 | + "`National Weather Service`" or "`Environment Canada`." |
| 73 | + |
| 74 | +* New environment variables for child processes |
| 75 | + |
| 76 | + * `SAMEDEC_IS_NATIONAL`: "`Y`" for national activations; |
| 77 | + otherwise present but empty |
| 78 | + |
| 79 | + * `SAMEDEC_SIG_NUM`: a numeric representation of the |
| 80 | + significance level |
| 81 | + |
| 82 | +* Add proper integration test scripts for child processes |
| 83 | + |
| 84 | +FIXES |
| 85 | + |
| 86 | +* IMPORTANT: Fix code entry for ADR (Administrative Message), |
| 87 | + which was previously wrong. |
| 88 | + |
| 89 | +* Handle EOF within the main app. Child processes are now |
| 90 | + spawned even for very short input files. |
| 91 | + |
| 92 | +* Update to Edition 2021 |
| 93 | + |
| 94 | +* Replace is-terminal with terminal_size |
| 95 | + |
| 96 | +## samedec-0.3.0: Add fallback decoding |
| 97 | + |
| 98 | +ENHANCEMENTS |
| 99 | + |
| 100 | +* CLI-BREAKING: Suppress duplicate messages which follow |
| 101 | + each other quickly in time. This mainly affects Fast EOMs: |
| 102 | + now only one "`NNNN`" line will be printed per SAME |
| 103 | + message. Some users may consider this breaking. |
| 104 | + |
| 105 | +* CLI: Add fallback decoding which can decode SAME headers using |
| 106 | + only two bursts. The improved decoder adds a delay of |
| 107 | + **1.311 seconds** when reporting a Start Of Message. Since the |
| 108 | + SAME voice message is often prefixed with an extended period of |
| 109 | + silence and/or a Warning Alarm Tone, the additional delay |
| 110 | + should not impact most applications. |
| 111 | + |
| 112 | +FIXES |
| 113 | + |
| 114 | +* Fix decoding of back-to-back SAME messages when either or both |
| 115 | + have missed bursts |
| 116 | + |
| 117 | +* Update dependencies |
| 118 | + |
| 119 | +## samedec-0.2.5: CLI Improvements |
| 120 | + |
| 121 | +ENHANCEMENTS |
| 122 | + |
| 123 | +* Update to chrono 0.4.23 and replace |
| 124 | + deprecated functions. |
| 125 | + |
| 126 | +* Update to clap v4. Improve help text and |
| 127 | + general CLI behaviors. |
| 128 | + |
| 129 | +FIXES |
| 130 | + |
| 131 | +* samedec now errors on startup if reading |
| 132 | + from stdin and stdin is a terminal |
| 133 | + |
| 134 | +## samedec-0.2.4: Maintenance release |
| 135 | + |
| 136 | +CI binaries are now available on the Github |
| 137 | +Releases tab. These binaries are built with |
| 138 | +Github Actions on Github Workers. |
| 139 | + |
| 140 | +ENHANCEMENTS |
| 141 | + |
| 142 | +* Log the full text of each SAME burst |
| 143 | + |
| 144 | +FIXES |
| 145 | + |
| 146 | +* RUSTSEC-2022-0078: bump bumpalo to 3.12.0 |
| 147 | + |
| 148 | +* RUSTSEC-2021-0047: replace slice-deque with |
| 149 | + slice-ring-buffer |
| 150 | + |
| 151 | +* Documentation improvements |
| 152 | + |
| 153 | +## samedec-0.2.3: Message bugfix release |
| 154 | + |
| 155 | +FIXES |
| 156 | + |
| 157 | +* Support additional message characters |
| 158 | +* Support lowercase event codes |
| 159 | +* Use an 8-character callsign for |
| 160 | + built-in DMO messages. |
| 161 | + |
| 162 | +## samedec-0.2.2: Dependency update |
| 163 | + |
| 164 | +No source code changes are made. |
| 165 | + |
| 166 | +* Discontinue use of the `time` dependency of `chrono`, which has |
| 167 | + unresolved security issues [1]. |
| 168 | + |
| 169 | +* Update all dependencies. |
| 170 | + |
| 171 | +References |
| 172 | +1. https://rustsec.org/advisories/RUSTSEC-2020-0071 |
| 173 | + |
| 174 | +## samedec-0.2.1: Dependency update |
| 175 | + |
| 176 | +FIXES |
| 177 | + |
| 178 | +* Update dependencies to versions which correct |
| 179 | + security vulnerabilities. Previous versions |
| 180 | + of sameold are *not* known to be vulnerable. |
| 181 | + |
| 182 | +## samedec-0.2.0: Fast end-of-message detection |
| 183 | + |
| 184 | +ENHANCEMENTS |
| 185 | + |
| 186 | +* BREAKING: Output one `NNNN` line for every |
| 187 | + EOM/`NNNN` which successfully decodes. The |
| 188 | + previous behavior was to require all three |
| 189 | + bursts before outputting a single `NNNN`. |
| 190 | + The behavior for the header (`ZCZC-`) is |
| 191 | + unchanged. The `--demo` option mimics the |
| 192 | + new behavior. |
| 193 | + |
| 194 | +FIXES |
| 195 | + |
| 196 | +* `--help` documentation |
| 197 | + |
| 198 | +## samedec-0.1.0: Initial version |
| 199 | + |
| 200 | +* Decodes SAME signals from `i16` inputs |
| 201 | +* Dispatches alerts and streaming audio to child |
| 202 | + processes |
0 commit comments