X Tutup
Skip to content

AudioStreamOggVorbis: only show invalid comment warning in Editor builds#109844

Merged
Repiteo merged 1 commit intogodotengine:masterfrom
nikitalita:invalid-ogg-comment
Oct 27, 2025
Merged

AudioStreamOggVorbis: only show invalid comment warning in Editor builds#109844
Repiteo merged 1 commit intogodotengine:masterfrom
nikitalita:invalid-ogg-comment

Conversation

@nikitalita
Copy link
Contributor

There are a bunch of music editors love to set invalid Vorbis comments in ogg vorbis files that they export (e.g. Sony's likes to write "Sony Ogg Vorbis 1.0 Final"), and this results in a lot of logspam whenever an ogg like this is loaded up. We should really only be emitting a warning about it if tools are enabled.

@nikitalita nikitalita requested a review from a team as a code owner August 21, 2025 23:19
@AThousandShips AThousandShips added this to the 4.x milestone Aug 22, 2025
Copy link
Member

@aaronfranke aaronfranke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be a good opportunity to link to the specification, explaining why Godot cares about the comment at all.

@nikitalita
Copy link
Contributor Author

https://xiph.org/vorbis/doc/v-comment.html

Basically, comments are structured like env vars in vorbis, VAR=VALUE. This is how tags are stored (artist, album, etc.), and Godot parses them out for display. When it comes across one that is not formatted like this, it throws a warning.

@aaronfranke
Copy link
Member

@nikitalita Can you put that in a comment in the code?

@nikitalita nikitalita force-pushed the invalid-ogg-comment branch from be19b86 to df7c7d8 Compare August 23, 2025 00:21
@nikitalita
Copy link
Contributor Author

done

Copy link
Member

@aaronfranke aaronfranke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be squashed, but this looks good to me.

@nikitalita nikitalita force-pushed the invalid-ogg-comment branch from 3ab7490 to 9aa9bac Compare August 25, 2025 17:55
@nikitalita
Copy link
Contributor Author

I can't re-run the failed jobs

@nikitalita
Copy link
Contributor Author

I think this is ready to go.

@Repiteo Repiteo modified the milestones: 4.x, 4.6 Oct 24, 2025
Copy link
Contributor

@Repiteo Repiteo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but still needs the commits to be squashed. See our pull request guidelines for more information

@nikitalita
Copy link
Contributor Author

nikitalita commented Oct 24, 2025

Looks good, but still needs the commits to be squashed. See our pull request guidelines for more information

I've done that, but I wish I understood why the maintainers of this project forbid "squash and merge".

@AThousandShips
Copy link
Member

Is the title of the PR outdated? The code doesn't filter out only in editor builds now

@AThousandShips
Copy link
Member

AThousandShips commented Oct 24, 2025

I've done that, but I wish I understood why the maintainers of this project forbid "squash and merge".

For several reasons, one is the workload on our production team (dozens of PRs is a lot to squash and make sure it was done right, considering squashing a single one can be annoying, imagine a dozen), another is that we want a clean history where we have a clear merge commit which means the PR is as is, without other changes, so it can be easily reverted, or cherry picked

We could use "squash and use merge commit" but GitHub doesn't allow that, we also have several maintainers and contributors who sign their commits because downstream consumers need that security, if we only used one type of merge method we'd lose that (squashed commits, or plain merged commits lose their sign information as it is recommitted), and having multiple means of merging things doesn't work with merge queues, and adds a burden to the production team

@nikitalita
Copy link
Contributor Author

nikitalita commented Oct 24, 2025

Is the title of the PR outdated? The code doesn't filter out only in editor builds now

It was a mistake that I made when rebasing on top of master to appease the PR guidelines. It's fixed now.

@AThousandShips
Copy link
Member

And there you have the risks of having the production team doing it instead, not being familiar with the PR!

@Repiteo Repiteo merged commit bf90fc8 into godotengine:master Oct 27, 2025
20 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Oct 27, 2025

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

X Tutup