Package: bs1770gain
Version: 0.6.5-1

Steps to reproduce:

$ sox -n file.wav synth 1 sine 1000
$ bs1770gain --xml --suppress-progress --sample-peak .
<bs1770gain norm="-23.00">
  <album folder=".">
    <track total="1" number="1" file="file.wav">
      <integrated lufs="-3.01" lu="-19.99"/>
      <sample-peak spfs="0.00" amplitude="1.00"/>
    </track>
    <integrated lufs="-3.01" lu="-19.99"/>
    <sample-peak spfs="0.00" amplitude="1.00"/>
  </album>
  <integrated lufs="-3.01" lu="-19.99"/>
  <sample-peak spfs="0.00" amplitude="1.00"/>
</bs1770gain>

In contrast, version 0.5 used to return something like this:

<bs1770gain>
  <album>
    <track total="1" number="1" file="file.wav">
      <integrated lufs="-3.01" lu="-19.99"/>
      <sample-peak spfs="0.00" factor="1.00"/>
    </track>
    <summary>
      <integrated lufs="-3.01" lu="-19.99"/>
      <sample-peak spfs="0.00" factor="1.00"/>
    </summary>
  </album>
</bs1770gain>

There are at least two breaking changes to the XML output format
between 0.5 and 0.6: The <summary> element disappeared and the
"factor" attribute was renamed to "amplitude".

As a result, programs that consume bs1770gain 0.5 XML output are
likely to break when bs1770gain is upgraded to 0.6.

I couldn't find any mention of this breaking change anywhere in the
bs1770gain website nor in the Debian changelog. One could argue that a
warning should be displayed to the user during the package upgrade
process so that they are not caught off-guard when their consumer
programs break. I'm also wondering if that means bs1770gain 0.6 should
be in a separate package altogether so that existing 0.5 packages
won't be automatically upgraded?

Reply via email to