Audacity Bug Summary
••• Introduction •••
••• Keywords •••
    Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla



Bug 2217 - Metadata: When exporting to FLAC the "Comment" field is ignored and not exported with the audio file
Metadata: When exporting to FLAC the "Comment" field is ignored and not expor...
Status: RESOLVED FIXED
Product: Audacity
Classification: Unclassified
Component: Application Core
2.3.3
Per OS All
: P3 RepeatableAll
Assigned To: Default Assignee for New Bugs
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2019-09-23 08:34 UTC by Peter Sampson
Modified: 2021-01-28 15:40 UTC (History)
8 users (show)

See Also:
Steps To Reproduce:
1) get some audio 2) File > Export > Export Audio 3) choose FLAC Files as the File Type 4) add "this is a comment" in Comment metadata field 5) export 6) Observe: the exported FLAC file does not carry the comment metadata
Release Note:
Group: Exports *When exporting to FLAC the "Comment" metadata field is ignored and not exported with the audio file
First Git SHA:
Group: ---
Workaround:
Edit the FLAC files metadata with a metadata editor.
Closed: 2021-01-28 00:00:00
petersampsonaudacity: Test‑OK‑Win+
petersampsonaudacity: Test‑OK‑Mac+


Attachments
still no Comments tag (17.91 KB, image/png)
2021-01-23 12:33 UTC, Peter Sampson
Details
No comment - and year is wrong (15.81 KB, image/png)
2021-01-24 11:05 UTC, Peter Sampson
Details
Metadata before (116.68 KB, image/png)
2021-01-24 15:22 UTC, Leland Lucius
Details
Properties after (70.91 KB, image/png)
2021-01-24 15:23 UTC, Leland Lucius
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Sampson 2019-09-23 08:34:27 UTC
When exporting to FLAC the "Comment" metadata field is ignored and not exported with the audio file.

Reported by a user on the Forum: https://forum.audacityteam.org/viewtopic.php?f=47&t=106892&p=377461

Tested on W10 and Mac Mojave fails on both - so assume All platforms.

This is inconsistent with other file type exports (e.g. MP3 where the Comment tag is properly exported)
Comment 1 Leland Lucius 2021-01-23 10:04:05 UTC
Fix in:

https://github.com/audacity/audacity/commit/81da0ef

Note that some applications use COMMENT and some use DESCRIPTION to represent the comment.  We were using COMMENTS.  We are now using COMMENT.
Comment 2 Peter Sampson 2021-01-23 12:33:34 UTC
Created attachment 1056 [details]
still no Comments tag

Testing on W10 with Audacity 3.0.0 4e6e3c2

Although I get all the other Metadata I set - I still don't see the Comments field coming through - see attachment
Comment 3 Leland Lucius 2021-01-23 18:34:40 UTC
(In reply to Peter Sampson from comment #2)
> Created attachment 1056 [details]
> still no Comments tag
> 
> Testing on W10 with Audacity 3.0.0 4e6e3c2
> 
> Although I get all the other Metadata I set - I still don't see the Comments
> field coming through - see attachment

Windows uses a tag called "DESCRIPTION".  Other things like Foobar use one called "COMMENT".  We were using "COMMENTS" which was just wrong.

So, who do we make happy?

We could actually write both COMMENT and DESCRIPTION if we don't want to have to settle for one or the other.
Comment 4 Leland Lucius 2021-01-23 18:49:22 UTC
Appears that Ubuntu file properties also uses "COMMENT".
Comment 5 Leland Lucius 2021-01-23 19:41:24 UTC
I've update it to store both COMMENT and DESCRIPTION:

https://github.com/audacity/audacity/commit/37a7583

And I've modified Import to use the COMMENT value if both are present.
Comment 6 Peter Sampson 2021-01-24 11:05:46 UTC
Created attachment 1057 [details]
No comment - and year is wrong

Tested on W10 with Audacity 3.0.0 4b07fba

1) I still see no comment in the FLAC file (see red-ring in attachment)

2) The "Year" that I enter in that Audacity Metadata editor is attached to "Date released" rather than "Year" in the FLAC's metadata (see blue-ring in attachment).
Comment 7 Leland Lucius 2021-01-24 15:22:19 UTC
Created attachment 1059 [details]
Metadata before

Here's what I have specified for metadata.
Comment 8 Leland Lucius 2021-01-24 15:23:00 UTC
Created attachment 1060 [details]
Properties after

Here's what Windows shows.
Comment 9 Leland Lucius 2021-01-24 15:34:03 UTC
Comment on attachment 1059 [details]
Metadata before

Ignore this
Comment 10 Leland Lucius 2021-01-24 15:34:26 UTC
Comment on attachment 1060 [details]
Properties after

Ignore this
Comment 11 Leland Lucius 2021-01-24 15:40:52 UTC
Somewhere along the line I lost the code changes that I thought I'd committed.  Redoing it now.

But, I can explain the Year problem.  If you specify just a year, like "1999", Windows will populate the "Year" and "Date released" property.  If you specify anything in addition to just the year, Windows displays it in the "Date released" property only.  After all, it's not just the year anymore.  :-)  This is all Windows and nothing we can do about it.
Comment 12 Leland Lucius 2021-01-24 15:54:13 UTC
One more try (stoopid Leland!):

https://github.com/audacity/audacity/commit/a2cee50
Comment 13 Peter Sampson 2021-01-24 16:18:30 UTC
(In reply to Leland Lucius from comment #12)
Audacity 3.0.0 a2cee50

Tested on W10 with Audacity 3.0.0 a2cee50

This now works fine
a) the comment is passed through into the FLAC file's metadata

b) the "2021" year propagates to "Year" and "Date released" - whuch is fine by me


>(stoopid Leland!)
Nah...  very clever Leland, looks to be well-fixed
Comment 14 Peter Sampson 2021-01-24 16:27:24 UTC
(In reply to Leland Lucius from comment #12)
Audacity 3.0.0 a2cee50

Tested on macOS 11.1 Big Sur with Audacity 3.0.0 a2cee50

This now works fine
a) the comment is passed through into the FLAC file's metadata into the "Comment" field

b) the "2021" year propagates to "Recorded date" - which is fine by me
Comment 15 Peter Sampson 2021-01-28 15:40:58 UTC
Examining the two commits that related to this fix
https://github.com/audacity/audacity/commit/a2cee50c0146dd1e842d7e65876f1b276502de90
https://github.com/audacity/audacity/commit/81da0ef1f7c37fe35d1e5591779b219f54a52983

shows that this fix is not platform-dependent or platform-specific, therefore as this tests OK on Win and Mac I shall mark this as FIXED