Supporting extensible format(PCM) for wave.open(read-mode)

[acelletti]

BPO	32990
Nosy	@ned-deily, @serhiy-storchaka, @ZackerySpytz, @acelletti
PRs	bpo-32990: Support WAVE_FORMAT_EXTENSIBLE in the wave module #9515
Files	pluck-pcm24-ext.wav: PCM 24b with FORMAT_EXTENSIBLE

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2018-03-03.09:25:58.701>
labels = ['3.8', 'type-feature', 'library']
title = 'Supporting extensible format(PCM) for wave.open(read-mode)'
updated_at = <Date 2018-09-23.13:35:55.962>
user = 'https://github.com/acelletti'

bugs.python.org fields:

activity = <Date 2018-09-23.13:35:55.962>
actor = 'ZackerySpytz'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2018-03-03.09:25:58.701>
creator = 'acelletti'
dependencies = []
files = ['47467']
hgrepos = []
issue_num = 32990
keywords = ['patch']
message_count = 4.0
messages = ['313183', '313190', '313191', '325477']
nosy_count = 4.0
nosy_names = ['ned.deily', 'serhiy.storchaka', 'ZackerySpytz', 'acelletti']
pr_nums = ['9515']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32990'
versions = ['Python 3.8']

[acelletti]

The wave.Wave_read class currently supports 8, 16, 24, and 32 bit PCM files.
Wave files are only supported if the wFormatTag in the format chunk matches the flag WAVE_FORMAT_PCM, which is correct but incomplete for 24 bit files.

According to the specification the WAVE_FORMAT_EXTENSIBLE format should be used whenever the actual number of bits/sample is not equal to the container size. Based on this specification, most applications export 24 bit PCM with the WAVE_FORMAT_EXTENSIBLE flag since 24 is stored in container size 32.
Importing these files causes wave.open to raise an exception.

The specification also explains how to detect 24PCM exported in this fashion as "The first two bytes of the GUID form the sub-code specifying the data format code, e.g. WAVE_FORMAT_PCM.". In essence, we have to look at the first two bytes of the SubFormat tag and that will tell us if this file is PCM.

Based on this premise, it appears to me that there is no reason for not adding support for both format specification as the rest of the file is exactly the same for both.

I am attaching a file that can be used to test the exception being raised.

Source: http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html

[acelletti]

I am currently working on a patch for this.

When done can I try pushing this in 3.7 rather than 3.8?

It is not much of an enhancement but rather fixing the code that raises an error for a perfectly valid PCM wave file (bugfix).

[ned-deily]

Thanks for working on this. Please follow the process in our Developers Guide and submit a PR against the master branch (for 3.8). After a core developer reviews it and if it is accepted, we can then decide about backports to other release branches. Also, if you haven't already, please make sure to read the section on licensing and sign a contributor agreement:

https://devguide.python.org/pullrequest/

[ZackerySpytz]

Andrea, are you still working on this issue? If not, I will submit a PR.

[zooba]

Reopening this to update docs to limit our support to only PCM files.