Feat: opus metadata encoding by mira-x · Pull Request #12974 · TeamNewPipe/NewPipe

mira-x · 2025-12-30T14:47:54Z

What is it?

Bugfix (user facing)
Feature (user facing) ⚠️ Your PR must target the refactor branch
Codebase improvement (dev facing)
Meta improvement to the project (dev facing)

Description of the changes in your PR

With this patch, downloaded .opus audio files will contain basic metadata (see example below). This is not a directly visible change, but comes in handy when you use downloaded audio with media players.

Here is the ffprobe output of a downloaded file that shows all tags that were added.

Input #0, ogg, from 'Boney M. - Sunny (Official Audio).opus':
  Duration: 00:04:02.87, start: 0.007500, bitrate: 127 kb/s
  Stream #0:0: Audio: opus, 48000 Hz, stereo, fltp, start 0.007500
    Metadata:
      COMMENT         : Downloaded using NewPipe 0.28.0 on 2025-12-30T14:29:11.091+01:00;URL: https://www.youtube.com/watch?v=ghGiv7YLC7Q
      GENRE           : Music
      ARTIST          : BoneyMVEVO
      TITLE           : Boney M. - Sunny (Official Audio)
      DATE            : 2020-08-07

(On a side note, I thought about adding metadata encoding to m4a downloads as well. But after some research, I figured that this is a nontrivial change)

Fixes the following issue(s)

Partially fixes Add metadata while downloading files #4341

APK testing

The APK can be found by going to the "Checks" tab below the title. On the left pane, click on "CI", scroll down to "artifacts" and click "app" to download the zip file which contains the debug APK of this PR. You can find more info and a video demonstration on this wiki page.

Due diligence

I read the contribution guidelines.
The proposed changes follow the AI policy.
I tested the changes using an emulator or a physical device.

This adds a simple timestamp to downloaded opus files in the form of a COMMENT tag.

This adds content-aware metadata tags to downloaded opus files. Previously, only a static string with a timestamp was added.

TobiGr

Thank you for the PR.

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java

app/src/main/java/us/shandian/giga/service/DownloadManagerService.java

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java

mira-x · 2026-01-01T10:27:32Z

Hi, thanks for your review. You have some good points. But I disagree on the comment tag.

I can see that the NewPipe version and download date do not add value for the user. But the source URL is very useful. For instance, when you want to see the music video of a song you downloaded, or when you want to see the video of a downloaded podcast. Encoding the URL into the metadata is the reason why I made this PR, and I don't see how this would obstruct the user.

Would you prefer using a different tag? The Opus standard contains no standard tag for the source of an audio. That's why I chose the COMMENT tag. But the tags are formless, so one could use a custom one. See this RFC.

This simplifies the code by not serializing and de-serializing the tags data, and also removes the DownloadManagerService.EXTRA_SOURCE field, which is always inferred from the StreamInfo.

mira-x · 2026-01-02T17:39:01Z

I have added and tested your proposed changes, but I kept the bare URL in the comment tag for now.

TobiGr

Thank you. LGTM, just a small nitpick

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java

mira-x · 2026-01-03T10:15:49Z

I have implemented this change, and it does not exceed the line limit.

TobiGr

thank you

TobiGr · 2026-01-03T10:46:58Z

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java

+            final var metadata = new ArrayList<Pair<String, String>>();
+            if (streamInfo != null) {
+                metadata.add(Pair.create("COMMENT", streamInfo.getUrl()));
+                metadata.add(Pair.create("GENRE", streamInfo.getCategory()));


The genre should only be set if getCategory() is not empty

Line 357 of OggFromWebMWriter.java filters out empty tags. Have you tested this and found that this filter does not work? I have not yet come across a video without a category, so I might be wrong.

Feat: Downloading: Add opus audio metadata tags for title, author, date, and a comment tag with the originating URL This removes the DownloadManagerService.EXTRA_SOURCE field, which is always inferred from the StreamInfo.

TobiGr · 2026-01-03T11:28:25Z

I backported this to 0.28.1

mira-x added 2 commits December 30, 2025 12:47

Feat: Downloading: Add opus audio metadata tags

e3f75f5

This adds a simple timestamp to downloaded opus files in the form of a COMMENT tag.

Opus metadata download: Add dynamic tags

3cda47b

This adds content-aware metadata tags to downloaded opus files. Previously, only a static string with a timestamp was added.

github-actions bot added the size/medium PRs with less than 250 changed lines label Dec 30, 2025

TobiGr added feature request Issue is related to a feature in the app downloader Issue is related to the downloader labels Dec 30, 2025

TobiGr self-requested a review December 31, 2025 08:49

TobiGr requested changes Dec 31, 2025

View reviewed changes

TobiGr reviewed Dec 31, 2025

View reviewed changes

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java Outdated Show resolved Hide resolved

Apply improvements from code review

4ce721e

This simplifies the code by not serializing and de-serializing the tags data, and also removes the DownloadManagerService.EXTRA_SOURCE field, which is always inferred from the StreamInfo.

mira-x requested a review from TobiGr January 2, 2026 17:38

TobiGr reviewed Jan 2, 2026

View reviewed changes

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java Outdated Show resolved Hide resolved

app/src/main/java/org/schabi/newpipe/streams/OggFromWebMWriter.java Outdated Show resolved Hide resolved

Include debug logs only in debug builds

5934ccd

mira-x requested a review from TobiGr January 3, 2026 10:14

TobiGr approved these changes Jan 3, 2026

View reviewed changes

TobiGr reviewed Jan 3, 2026

View reviewed changes

TobiGr merged commit 3369607 into TeamNewPipe:refactor Jan 3, 2026
8 of 9 checks passed

TobiGr mentioned this pull request Jan 3, 2026

Release 0.28.1 (please TEST!) #12925

Closed

4 tasks

mira-x deleted the feat-opus-metadata branch January 3, 2026 11:30

Uh oh!

Conversation

mira-x commented Dec 30, 2025

What is it?

Description of the changes in your PR

Fixes the following issue(s)

APK testing

Due diligence

Uh oh!

TobiGr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mira-x commented Jan 1, 2026

Uh oh!

mira-x commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TobiGr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mira-x commented Jan 3, 2026

Uh oh!

TobiGr left a comment

Choose a reason for hiding this comment

Uh oh!

TobiGr Jan 3, 2026

Choose a reason for hiding this comment

Uh oh!

mira-x Jan 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TobiGr commented Jan 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mira-x commented Jan 2, 2026 •

edited

Loading