Skip to content

Commit

Permalink
Modifying example to avoid possible confusion
Browse files Browse the repository at this point in the history
The size of the "fmt " chunk in the example is intentionally being
changed to a value other than 40, to avoid inadvertently implying
that this bug fix only applies to files in WAVE_FORMAT_EXTENSIBLE
format. Together with the final sentence of the previous bug fix,
it seems like the old example size could have led to that
conclusion.
  • Loading branch information
jstrait committed Dec 30, 2022
1 parent a4ed9e3 commit b60a5c0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@
chunk. The message will now correctly state that the chunk extension is too
large, rather than `"Not a supported wave file. The format chunk extension is
shorter than expected."`. As an example of what "too large" means, if a
`"fmt "` chunk has a size of 40 bytes, then any chunk extension larger than
22 bytes will be too large and overflow out of the chunk, since a chunk
`"fmt "` chunk has a size of 50 bytes, then any chunk extension larger than
32 bytes will be too large and overflow out of the chunk, since a chunk
extension's content always starts at byte 18 (0-based).


Expand Down
2 changes: 1 addition & 1 deletion README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ The full details:

* **Bug Fix:** More accurate message on the `InvalidFormatError` raised when reading a file whose `"fmt "` chunk extension is too large to fit in the chunk.

The message will now correctly state that the chunk extension is too large, rather than `"Not a supported wave file. The format chunk extension is shorter than expected."`. As an example of what "too large" means, if a `"fmt "` chunk has a size of 40 bytes, then any chunk extension larger than 22 bytes will be too large and overflow out of the chunk, since a chunk extension's content always starts at byte 18 (0-based).
The message will now correctly state that the chunk extension is too large, rather than `"Not a supported wave file. The format chunk extension is shorter than expected."`. As an example of what "too large" means, if a `"fmt "` chunk has a size of 50 bytes, then any chunk extension larger than 32 bytes will be too large and overflow out of the chunk, since a chunk extension's content always starts at byte 18 (0-based).

# Previous Release: v1.1.1

Expand Down

0 comments on commit b60a5c0

Please sign in to comment.