Ability to add metadata when writing file

Hey all,

I was working with OGG Vorbis export and needed to add a metadata field to the file (here: OGG Vorbis Comment). I couldn’t see how this was possible with PySoundfile, so I used the mutagen library instead. It feels a bit hacky to write the file and then read it again to modify the metadata and then save again. Example:

import soundfile
import mutagen

# Write OGG file
soundfile.write('test_file.ogg', data, sr, format='ogg', subtype='vorbis')

# Read OGG file, add metadata and save again
file = mutagen.File('test_file.ogg')
tags_new = file.tags
tags_new['ARTIST'] = 'TEST ARTIST NAME"
file.tags = tags_new
file.save()

Ideally I think something like this would be handy:

import soundfile

# Write OGG file with metadata
tags_new = dict()
tags_new['ARTIST'] = 'TEST ARTIST NAME'
soundfile.write('test_file.ogg', data, sr, format='ogg', subtype='vorbis', tags=tags_new)

Nothing urgent, but probably a nice feature that could be added at some point. The more annoying part is probably making sure it works for each individual file type, as tags work differently for the different formats (MP3, OGG, WAV,…).

[bastibe]

Open a file, use the dict-like accessor to read or write the metadata:

with soundfile.Soundfile('test_file.wav') as file:
    file['artis'] = 'John Doe'
    album = file['album']

Available fields are:

• title
• copyright
• software
• artist
• comment
• date
• album
• license
• tracknumber
• genre

The feature is not supported for all file types.

[bastibe]

You can already edit the following metadata fields: title, copyright, software, artist, comment, date, album, license, tracknumber, and genre, using e.g. file['artist'] = 'Picasso'. Beyond that, however, no metadata is accessible through our underlying library, libsndfile.