Skip to content

feat: add multi-audio track metadata support to Multiplex provider #2071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nums wants to merge 7 commits into
base: master
Choose a base branch
from
+324 −78
Open

feat: add multi-audio track metadata support to Multiplex provider #2071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
68bdbce
add multi-audio track metadata support to Multiplex provider
nums Apr 17, 2026
cb7bc1d
update documentation of multiplex-channel
nums Apr 17, 2026
62f0273
remove whitespaces
nums Apr 17, 2026
68b3bdc
validate audio_index interger
nums Apr 17, 2026
ff134d6
fix occurence value with groupIndex
nums Apr 17, 2026
9c8285f
improve audio tracks selection strategy
nums Apr 20, 2026
ade2111
Merge branch 'OvenMediaLabs:master' into feat/multiplex-audio-tracks
nums Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion docs/live-source/multiplex-channel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,37 @@ mux files can be created or deleted while the system is running. This works dyna
<NewTrackName>tv2_opus</NewTrackName>
</Track>
</TrackMap>

</SourceStream>
<!-- This source stream carries multiple audio tracks (e.g. sent via SRT with embedded multi-language audio) -->
<SourceStream>
<Name>live</Name>
<Url>stream://default/app/live</Url>
<TrackMap>
<Track>
<SourceTrackName>bypass_video</SourceTrackName>
<NewTrackName>video_1080p</NewTrackName>
</Track>
<Track>
<SourceTrackName>video_720</SourceTrackName>
<NewTrackName>video_720p</NewTrackName>
</Track>
<!-- Both audio tracks share the same SourceTrackName but are distinguished by AudioIndex (0-based). -->
<!-- AudioIndex refers to the order in which the tracks appear in the source stream. -->
<Track>
<SourceTrackName>aac_audio</SourceTrackName>
<NewTrackName>audio</NewTrackName>
<AudioIndex>0</AudioIndex>
<PublicName>English</PublicName>
<Language>eng</Language>
</Track>
<Track>
<SourceTrackName>aac_audio</SourceTrackName>
<NewTrackName>audio</NewTrackName>
<AudioIndex>1</AudioIndex>
<PublicName>Korean</PublicName>
<Language>kor</Language>
</Track>
</TrackMap>
</SourceStream>
</SourceStreams>

Expand All @@ -86,13 +116,34 @@ mux files can be created or deleted while the system is running. This works dyna
<Name>1080p</Name>
<Video>tv1_video</Video>
<Audio>tv1_audio</Audio>
<!-- When the audio group contains multiple tracks, AudioIndexHint selects which one -->
<!-- <AudioIndexHint>0</AudioIndexHint> -->
</Rendition>
<Rendition>
<Name>720p</Name>
<Video>tv2_video</Video>
<Audio>tv2_audio</Audio>
</Rendition>
</Playlist>
<Playlist>
<Name>ABR Multi-Audio</Name>
<FileName>index</FileName>
<Options>
<HLSChunklistPathDepth>0</HLSChunklistPathDepth>
<EnableTsPackaging>true</EnableTsPackaging>
</Options>
<!-- Both renditions reference the same audio group, exposing all audio tracks to the player -->
<Rendition>
<Name>1080p</Name>
<Video>video_1080p</Video>
<Audio>audio</Audio>
</Rendition>
<Rendition>
<Name>720p</Name>
<Video>video_720p</Video>
<Audio>audio</Audio>
</Rendition>
</Playlist>
</Playlists>

</Multiplex>
Expand Down
222 changes: 194 additions & 28 deletions src/projects/providers/multiplex/multiplex_profile.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,67 @@ namespace pvd
framerate_conf = framerate_conf_object.asInt();
}

ov::String public_name;
auto public_name_object = track_object["publicName"];
if (!public_name_object.isNull())
{
public_name = public_name_object.asString().c_str();
}

ov::String language;
auto language_object = track_object["language"];
if (!language_object.isNull())
{
language = language_object.asString().c_str();
}

ov::String characteristics;
auto characteristics_object = track_object["characteristics"];
if (!characteristics_object.isNull())
{
characteristics = characteristics_object.asString().c_str();
}

int32_t audio_index = -1;
auto audio_index_object = track_object["audioIndex"];
if (!audio_index_object.isNull())
{
if (!audio_index_object.isInt())
{
_last_error = "Invalid sourceStreams/trackMap/audioIndex: must be an integer";
return false;
}

audio_index = audio_index_object.asInt();
Comment thread
nums marked this conversation as resolved.
if (audio_index < -1)
{
_last_error = "Invalid sourceStreams/trackMap/audioIndex: must be -1 or greater";
return false;
}
}

ov::String source_track_name = source_track_name_object.asString().c_str();
ov::String new_track_name = new_track_name_object.asString().c_str();
source_stream->AddTrackMap(source_track_name, NewTrackInfo(source_track_name, new_track_name, bitrate_conf, framerate_conf));

// Warn if adding a second catch-all for the same source track name
if (audio_index == -1)
{
const auto &existing = source_stream->GetTrackMap();
auto eit = existing.find(source_track_name);
if (eit != existing.end())
{
for (const auto &e : eit->second)
{
if (e.audio_index == -1)
{
logtw("Multiplex: duplicate catch-all <Track> for sourceTrackName '%s' (no audioIndex). Use audioIndex to distinguish occurrences.", source_track_name.CStr());
break;
}
}
}
}

source_stream->AddTrackMap(source_track_name, NewTrackInfo(source_track_name, new_track_name, bitrate_conf, framerate_conf, public_name, language, characteristics, audio_index));
_new_track_names.emplace(new_track_name, true);
}

Expand Down Expand Up @@ -600,9 +658,61 @@ namespace pvd
framerate_conf = framerate_conf_node.text().as_int();
}

ov::String public_name;
auto public_name_node = track_node.child("PublicName");
if (public_name_node)
{
public_name = public_name_node.text().as_string();
}

ov::String language;
auto language_node = track_node.child("Language");
if (language_node)
{
language = language_node.text().as_string();
}

ov::String characteristics;
auto characteristics_node = track_node.child("Characteristics");
if (characteristics_node)
{
characteristics = characteristics_node.text().as_string();
}

int32_t audio_index = -1;
auto audio_index_node = track_node.child("AudioIndex");
if (audio_index_node)
{
audio_index = audio_index_node.text().as_int();
if (audio_index < -1)
{
_last_error = "Invalid sourceStreams/trackMap/AudioIndex: must be -1 or greater";
return false;
}
}

ov::String source_track_name = source_track_name_node.text().as_string();
ov::String new_track_name = new_track_name_node.text().as_string();
source_stream->AddTrackMap(source_track_name, NewTrackInfo(source_track_name, new_track_name, bitrate_conf, framerate_conf));

// Warn if adding a second catch-all for the same source track name
if (audio_index == -1)
{
const auto &existing = source_stream->GetTrackMap();
auto eit = existing.find(source_track_name);
if (eit != existing.end())
{
for (const auto &e : eit->second)
{
if (e.audio_index == -1)
{
logtw("Multiplex: duplicate catch-all <Track> for SourceTrackName '%s' (no <AudioIndex>). Use <AudioIndex> to distinguish occurrences.", source_track_name.CStr());
break;
}
}
}
}

source_stream->AddTrackMap(source_track_name, NewTrackInfo(source_track_name, new_track_name, bitrate_conf, framerate_conf, public_name, language, characteristics, audio_index));
_new_track_names.emplace(new_track_name, true);
}

Expand Down Expand Up @@ -636,20 +746,43 @@ namespace pvd
source_stream_node.append_child("Url").text().set(source_stream->GetUrlStr().CStr());

auto track_map_node = source_stream_node.append_child("TrackMap");
for (const auto &[source_track_name, new_track_info] : source_stream->GetTrackMap())
for (const auto &[source_track_name, infos] : source_stream->GetTrackMap())
{
auto track_node = track_map_node.append_child("Track");
track_node.append_child("SourceTrackName").text().set(source_track_name.CStr());
track_node.append_child("NewTrackName").text().set(new_track_info.new_track_name.CStr());

if (new_track_info.bitrate_conf != 0)
for (const auto &new_track_info : infos)
{
track_node.append_child("BitrateConf").text().set(new_track_info.bitrate_conf);
}
auto track_node = track_map_node.append_child("Track");
track_node.append_child("SourceTrackName").text().set(source_track_name.CStr());
track_node.append_child("NewTrackName").text().set(new_track_info.new_track_name.CStr());

if (new_track_info.framerate_conf != 0)
{
track_node.append_child("FramerateConf").text().set(new_track_info.framerate_conf);
if (new_track_info.bitrate_conf != 0)
{
track_node.append_child("BitrateConf").text().set(new_track_info.bitrate_conf);
}

if (new_track_info.framerate_conf != 0)
{
track_node.append_child("FramerateConf").text().set(new_track_info.framerate_conf);
}

if (new_track_info.public_name.IsEmpty() == false)
{
track_node.append_child("PublicName").text().set(new_track_info.public_name.CStr());
}

if (new_track_info.language.IsEmpty() == false)
{
track_node.append_child("Language").text().set(new_track_info.language.CStr());
}

if (new_track_info.characteristics.IsEmpty() == false)
{
track_node.append_child("Characteristics").text().set(new_track_info.characteristics.CStr());
}

if (new_track_info.audio_index >= 0)
{
track_node.append_child("AudioIndex").text().set(new_track_info.audio_index);
}
}
}
}
Expand Down Expand Up @@ -725,23 +858,46 @@ namespace pvd
source_stream_object["url"] = source_stream->GetUrlStr().CStr();

Json::Value track_map_object;
for (const auto &[source_track_name, new_track_info] : source_stream->GetTrackMap())
for (const auto &[source_track_name, infos] : source_stream->GetTrackMap())
{
Json::Value track_object;
track_object["sourceTrackName"] = source_track_name.CStr();
track_object["newTrackName"] = new_track_info.new_track_name.CStr();

if (new_track_info.bitrate_conf != 0)
for (const auto &new_track_info : infos)
{
track_object["bitrateConf"] = new_track_info.bitrate_conf;
}
Json::Value track_object;
track_object["sourceTrackName"] = source_track_name.CStr();
track_object["newTrackName"] = new_track_info.new_track_name.CStr();

if (new_track_info.framerate_conf != 0)
{
track_object["framerateConf"] = new_track_info.framerate_conf;
}
if (new_track_info.bitrate_conf != 0)
{
track_object["bitrateConf"] = new_track_info.bitrate_conf;
}

if (new_track_info.framerate_conf != 0)
{
track_object["framerateConf"] = new_track_info.framerate_conf;
}

if (new_track_info.public_name.IsEmpty() == false)
{
track_object["publicName"] = new_track_info.public_name.CStr();
}

if (new_track_info.language.IsEmpty() == false)
{
track_object["language"] = new_track_info.language.CStr();
}

track_map_object.append(track_object);
if (new_track_info.characteristics.IsEmpty() == false)
{
track_object["characteristics"] = new_track_info.characteristics.CStr();
}

if (new_track_info.audio_index >= 0)
{
track_object["audioIndex"] = new_track_info.audio_index;
}

track_map_object.append(track_object);
}
}

source_stream_object["trackMap"] = track_map_object;
Expand Down Expand Up @@ -846,9 +1002,19 @@ namespace pvd
info_str += ov::String::FormatString("\tSourceStream : %s\n", source->GetName().CStr());
info_str += ov::String::FormatString("\tUrl : %s\n", source->GetUrlStr().CStr());

for (const auto &[source_track_name, new_track_info] : source->GetTrackMap())
for (const auto &[source_track_name, infos] : source->GetTrackMap())
{
info_str += ov::String::FormatString("\t\tTrackMap : %s -> %s\n", source_track_name.CStr(), new_track_info.new_track_name.CStr());
for (const auto &new_track_info : infos)
{
if (new_track_info.audio_index >= 0)
{
info_str += ov::String::FormatString("\t\tTrackMap : %s[%d] -> %s\n", source_track_name.CStr(), new_track_info.audio_index, new_track_info.new_track_name.CStr());
}
else
{
info_str += ov::String::FormatString("\t\tTrackMap : %s -> %s\n", source_track_name.CStr(), new_track_info.new_track_name.CStr());
}
}
}
}

Expand Down
Loading
Loading