1404661 - Typo in dom/media/flac/FlacDemuxer.cpp:86

Status: RESOLVED FIXED

(Core :: Audio/Video: Playback, enhancement)

Description

[Rob Wu [:robwu]]

FrameHeader::Parse has the following comment [1]:

    // Reserved bit, most be 1.
    if (br.ReadBit()) {
      // Broken stream, invalid padding.
      return false;
    }

The comment and the code do not match with each other. Clearly, if the bit is 1, the function returns false (i.e. header is invalid).

According to https://xiph.org/flac/format.html#frame_header (after the "Sample size in bits:" row), this value must be:

    Reserved:
    0 : mandatory value
    1 : reserved for future use

So the code is correct, and the comment is wrong.

[1] https://searchfox.org/mozilla-central/rev/c296ed9811319cdd61ac35e9e648f95639cda726/dom/media/flac/FlacDemuxer.cpp#86

Comment 1

[Rob Wu [:robwu]]

Attachment: Bug 1404661 - Fix typo in comment of flac::FrameHeader::Parse

Review commit: https://reviewboard.mozilla.org/r/185412/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/185412/

Comment 2

[u480271]

Comment on attachment 8914019 [details]
Bug 1404661 - Fix typo in comment of flac::FrameHeader::Parse

https://reviewboard.mozilla.org/r/185412/#review190836

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e5658cad4190
Fix typo in comment of flac::FrameHeader::Parse r=kamidphish

Comment 4

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/e5658cad4190