Merge pull request #1026 from AudricV/audio-streams-descriptive-and-locale-properties

Add descriptive and locale properties to audio streams

Author: Stypox

extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCStreamExtractor.java

@@ -24,6 +24,7 @@
 import org.schabi.newpipe.extractor.stream.StreamType;
 import org.schabi.newpipe.extractor.stream.VideoStream;
 import org.schabi.newpipe.extractor.utils.JsonUtils;
+import org.schabi.newpipe.extractor.utils.LocaleCompat;
 
 import java.io.IOException;
 import java.util.ArrayList;
@@ -114,15 +115,24 @@ public List<AudioStream> getAudioStreams() throws ExtractionException {
                     mediaFormat = null;
                 }
 
-                // Not checking containsSimilarStream here, since MediaCCC does not provide enough
-                // information to decide whether two streams are similar. Hence that method would
-                // always return false, e.g. even for different language variations.
-                audioStreams.add(new AudioStream.Builder()
+                final AudioStream.Builder builder = new AudioStream.Builder()
                         .setId(recording.getString("filename", ID_UNKNOWN))
                         .setContent(recording.getString("recording_url"), true)
                         .setMediaFormat(mediaFormat)
-                        .setAverageBitrate(UNKNOWN_BITRATE)
-                        .build());
+                        .setAverageBitrate(UNKNOWN_BITRATE);
+
+                final String language = recording.getString("language");
+                // If the language contains a - symbol, this means that the stream has an audio
+                // track with multiple languages, so there is no specific language for this stream
+                // Don't set the audio language in this case
+                if (language != null && !language.contains("-")) {
+                    builder.setAudioLocale(LocaleCompat.forLanguageTag(language));
+                }
+
+                // Not checking containsSimilarStream here, since MediaCCC does not provide enough
+                // information to decide whether two streams are similar. Hence that method would
+                // always return false, e.g. even for different language variations.
+                audioStreams.add(builder.build());
             }
         }
         return audioStreams;

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/ItagItem.java

@@ -6,6 +6,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.io.Serializable;
+import java.util.Locale;
 
 import static org.schabi.newpipe.extractor.MediaFormat.M4A;
 import static org.schabi.newpipe.extractor.MediaFormat.MPEG_4;
@@ -198,6 +199,10 @@ public ItagItem(@Nonnull final ItagItem itagItem) {
         this.targetDurationSec = itagItem.targetDurationSec;
         this.approxDurationMs = itagItem.approxDurationMs;
         this.contentLength = itagItem.contentLength;
+        this.audioTrackId = itagItem.audioTrackId;
+        this.audioTrackName = itagItem.audioTrackName;
+        this.isDescriptiveAudio = itagItem.isDescriptiveAudio;
+        this.audioLocale = itagItem.audioLocale;
     }
 
     public MediaFormat getMediaFormat() {
@@ -246,6 +251,9 @@ public MediaFormat getMediaFormat() {
     private long contentLength = CONTENT_LENGTH_UNKNOWN;
     private String audioTrackId;
     private String audioTrackName;
+    private boolean isDescriptiveAudio;
+    @Nullable
+    private Locale audioLocale;
 
     public int getBitrate() {
         return bitrate;
@@ -569,19 +577,61 @@ public void setAudioTrackId(@Nullable final String audioTrackId) {
     /**
      * Get the {@code audioTrackName} of the stream, if present.
      *
-     * @return the {@code audioTrackName} of the stream or null
+     * @return the {@code audioTrackName} of the stream or {@code null}
      */
     @Nullable
     public String getAudioTrackName() {
         return audioTrackName;
     }
 
     /**
-     * Set the {@code audioTrackName} of the stream.
+     * Set the {@code audioTrackName} of the stream, if present.
      *
-     * @param audioTrackName the {@code audioTrackName} of the stream
+     * @param audioTrackName the {@code audioTrackName} of the stream or {@code null}
      */
     public void setAudioTrackName(@Nullable final String audioTrackName) {
         this.audioTrackName = audioTrackName;
     }
+
+    /**
+     * Return whether the stream is a descriptive audio.
+     *
+     * @return whether the stream is a descriptive audio
+     */
+    public boolean isDescriptiveAudio() {
+        return isDescriptiveAudio;
+    }
+
+    /**
+     * Set whether the stream is a descriptive audio.
+     *
+     * @param isDescriptiveAudio whether the stream is a descriptive audio
+     */
+    public void setIsDescriptiveAudio(final boolean isDescriptiveAudio) {
+        this.isDescriptiveAudio = isDescriptiveAudio;
+    }
+
+    /**
+     * Return the audio {@link Locale} of the stream, if known.
+     *
+     * @return the audio {@link Locale} of the stream, if known, or {@code null} if that's not the
+     * case
+     */
+    @Nullable
+    public Locale getAudioLocale() {
+        return audioLocale;
+    }
+
+    /**
+     * Set the audio {@link Locale} of the stream.
+     *
+     * <p>
+     * If it is unknown, {@code null} could be passed, which is the default value.
+     * </p>
+     *
+     * @param audioLocale the audio {@link Locale} of the stream, which could be {@code null}
+     */
+    public void setAudioLocale(@Nullable final Locale audioLocale) {
+        this.audioLocale = audioLocale;
+    }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeDashManifestCreatorsUtils.java

@@ -124,7 +124,7 @@ public static void setAttribute(final Element element,
      *     <li>{@code Period} (using {@link #generatePeriodElement(Document)});</li>
      *     <li>{@code AdaptationSet} (using {@link #generateAdaptationSetElement(Document,
      *     ItagItem)});</li>
-     *     <li>{@code Role} (using {@link #generateRoleElement(Document)});</li>
+     *     <li>{@code Role} (using {@link #generateRoleElement(Document, ItagItem)});</li>
      *     <li>{@code Representation} (using {@link #generateRepresentationElement(Document,
      *     ItagItem)});</li>
      *     <li>and, for audio streams, {@code AudioChannelConfiguration} (using
@@ -144,7 +144,7 @@ public static Document generateDocumentAndDoCommonElementsGeneration(
 
         generatePeriodElement(doc);
         generateAdaptationSetElement(doc, itagItem);
-        generateRoleElement(doc);
+        generateRoleElement(doc, itagItem);
         generateRepresentationElement(doc, itagItem);
         if (itagItem.itagType == ItagItem.ItagType.AUDIO) {
             generateAudioChannelConfigurationElement(doc, itagItem);
@@ -208,7 +208,7 @@ public static Document generateDocumentAndMpdElement(final long duration)
      * {@link #generateDocumentAndMpdElement(long)}.
      * </p>
      *
-     * @param doc the {@link Document} on which the the {@code <Period>} element will be appended
+     * @param doc the {@link Document} on which the {@code <Period>} element will be appended
      */
     public static void generatePeriodElement(@Nonnull final Document doc)
             throws CreationException {
@@ -249,6 +249,16 @@ public static void generateAdaptationSetElement(@Nonnull final Document doc,
                         "the MediaFormat or its mime type is null or empty");
             }
 
+            if (itagItem.itagType == ItagItem.ItagType.AUDIO) {
+                final Locale audioLocale = itagItem.getAudioLocale();
+                if (audioLocale != null) {
+                    final String audioLanguage = audioLocale.getLanguage();
+                    if (!audioLanguage.isEmpty()) {
+                        setAttribute(adaptationSetElement, doc, "lang", audioLanguage);
+                    }
+                }
+            }
+
             setAttribute(adaptationSetElement, doc, "mimeType", mediaFormat.getMimeType());
             setAttribute(adaptationSetElement, doc, "subsegmentAlignment", "true");
 
@@ -267,25 +277,29 @@ public static void generateAdaptationSetElement(@Nonnull final Document doc,
      * </p>
      *
      * <p>
-     * {@code <Role schemeIdUri="urn:mpeg:DASH:role:2011" value="main"/>}
+     * {@code <Role schemeIdUri="urn:mpeg:DASH:role:2011" value="VALUE"/>}, where {@code VALUE} is
+     * {@code main} for videos and audios and {@code alternate} for descriptive audio
      * </p>
      *
      * <p>
      * The {@code <AdaptationSet>} element needs to be generated before this element with
      * {@link #generateAdaptationSetElement(Document, ItagItem)}).
      * </p>
      *
-     * @param doc the {@link Document} on which the the {@code <Role>} element will be appended
+     * @param doc      the {@link Document} on which the {@code <Role>} element will be appended
+     * @param itagItem the {@link ItagItem} corresponding to the stream, which must not be null
      */
-    public static void generateRoleElement(@Nonnull final Document doc)
+    public static void generateRoleElement(@Nonnull final Document doc,
+                                           @Nonnull final ItagItem itagItem)
             throws CreationException {
         try {
             final Element adaptationSetElement = (Element) doc.getElementsByTagName(
                     ADAPTATION_SET).item(0);
             final Element roleElement = doc.createElement(ROLE);
 
             setAttribute(roleElement, doc, "schemeIdUri", "urn:mpeg:DASH:role:2011");
-            setAttribute(roleElement, doc, "value", "main");
+            setAttribute(roleElement, doc, "value", itagItem.isDescriptiveAudio()
+                    ? "alternate" : "main");
 
             adaptationSetElement.appendChild(roleElement);
         } catch (final DOMException e) {
@@ -302,7 +316,7 @@ public static void generateRoleElement(@Nonnull final Document doc)
      * {@link #generateAdaptationSetElement(Document, ItagItem)}).
      * </p>
      *
-     * @param doc the {@link Document} on which the the {@code <SegmentTimeline>} element will be
+     * @param doc the {@link Document} on which the {@code <SegmentTimeline>} element will be
      *            appended
      * @param itagItem the {@link ItagItem} to use, which must not be null
      */
@@ -522,7 +536,7 @@ public static void generateSegmentTemplateElement(@Nonnull final Document doc,
      * {@link #generateSegmentTemplateElement(Document, String, DeliveryType)}.
      * </p>
      *
-     * @param doc the {@link Document} on which the the {@code <SegmentTimeline>} element will be
+     * @param doc the {@link Document} on which the {@code <SegmentTimeline>} element will be
      *            appended
      */
     public static void generateSegmentTimelineElement(@Nonnull final Document doc)

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java

@@ -82,6 +82,7 @@
 import org.schabi.newpipe.extractor.stream.SubtitlesStream;
 import org.schabi.newpipe.extractor.stream.VideoStream;
 import org.schabi.newpipe.extractor.utils.JsonUtils;
+import org.schabi.newpipe.extractor.utils.LocaleCompat;
 import org.schabi.newpipe.extractor.utils.Pair;
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Utils;
@@ -1309,6 +1310,8 @@ private java.util.function.Function<ItagInfo, AudioStream> getAudioStreamBuilder
                     .setAverageBitrate(itagItem.getAverageBitrate())
                     .setAudioTrackId(itagItem.getAudioTrackId())
                     .setAudioTrackName(itagItem.getAudioTrackName())
+                    .setAudioLocale(itagItem.getAudioLocale())
+                    .setIsDescriptive(itagItem.isDescriptiveAudio())
                     .setItagItem(itagItem);
 
             if (streamType == StreamType.LIVE_STREAM
@@ -1454,9 +1457,6 @@ private ItagInfo buildAndAddItagInfoToList(
         itagItem.setQuality(formatData.getString("quality"));
         itagItem.setCodec(codec);
 
-        itagItem.setAudioTrackId(formatData.getObject("audioTrack").getString("id"));
-        itagItem.setAudioTrackName(formatData.getObject("audioTrack").getString("displayName"));
-
         if (streamType == StreamType.LIVE_STREAM || streamType == StreamType.POST_LIVE_STREAM) {
             itagItem.setTargetDurationSec(formatData.getInt("targetDurationSec"));
         }
@@ -1473,6 +1473,27 @@ private ItagInfo buildAndAddItagInfoToList(
                     // AudioChannelConfiguration element of DASH manifests of audio streams in
                     // YoutubeDashManifestCreatorUtils
                     2));
+
+            final String audioTrackId = formatData.getObject("audioTrack")
+                    .getString("id");
+            if (!isNullOrEmpty(audioTrackId)) {
+                itagItem.setAudioTrackId(audioTrackId);
+                final int audioTrackIdLastLocaleCharacter = audioTrackId.indexOf(".");
+                if (audioTrackIdLastLocaleCharacter != -1) {
+                    // Audio tracks IDs are in the form LANGUAGE_CODE.TRACK_NUMBER
+                    itagItem.setAudioLocale(LocaleCompat.forLanguageTag(
+                            audioTrackId.substring(0, audioTrackIdLastLocaleCharacter)));
+                }
+            }
+
+            itagItem.setAudioTrackName(formatData.getObject("audioTrack")
+                    .getString("displayName"));
+
+            // Descriptive audio tracks
+            // This information is also provided as a protobuf object in the formatData
+            itagItem.setIsDescriptiveAudio(streamUrl.contains("acont%3Ddescriptive")
+                    // Support "decoded" URLs
+                    || streamUrl.contains("acont=descriptive"));
         }
 
         // YouTube return the content length and the approximate duration as strings