Changeset 182298 in webkit

Timestamp:

Apr 2, 2015 5:27:06 PM (9 years ago)

Author:

Brent Fulgham

Message:

REGRESSION: Caption Menus show language codes instead of display names.
​https://bugs.webkit.org/show_bug.cgi?id=143350
<rdar://problem/20094145>

Reviewed by Jer Noble.

The generic caption/track label handling in CaptionUserPreferences does not convert language codes
(e.g. 'fr-CA') into display names (e.g., 'French (Canada)'). Because we did not have an AudioTrack
override to process these types of menu items, they were being handled using the generic code.

• page/CaptionUserPreferencesMediaAF.cpp:

(WebCore::buildStringForTrackBase): Helper function to share code with the two flavors
of 'trackDisplayName'.
(WebCore::trackDisplayName): Add a version to support AudioTracks, and modify the TextTrack
version to use the new 'buildStringForTrackBase' function.
(WebCore::CaptionUserPreferencesMediaAF::displayNameForTrack): Add an AudioTrack override so
our AVFoundation tracks are processed in our CaptionUserPreferencesMediaAF implementation, not the
generic version.
(WebCore::CaptionUserPreferencesMediaAF::sortedTrackListForMenu): Add an AudioTrack override so
that the menu items are sorted in order of display name, not language code.

• page/CaptionUserPreferencesMediaAF.h:

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• page/CaptionUserPreferencesMediaAF.cpp (modified) (6 diffs)
• page/CaptionUserPreferencesMediaAF.h (modified) (2 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2015-04-02  Brent Fulgham  <bfulgham@apple.com>
+
+        REGRESSION: Caption Menus show language codes instead of display names.
+        https://bugs.webkit.org/show_bug.cgi?id=143350
+        <rdar://problem/20094145>
+
+        Reviewed by Jer Noble.
+
+        The generic caption/track label handling in CaptionUserPreferences does not convert language codes
+        (e.g. 'fr-CA') into display names (e.g., 'French (Canada)'). Because we did not have an AudioTrack
+        override to process these types of menu items, they were being handled using the generic code.
+
+        * page/CaptionUserPreferencesMediaAF.cpp:
+        (WebCore::buildStringForTrackBase): Helper function to share code with the two flavors
+        of 'trackDisplayName'.
+        (WebCore::trackDisplayName): Add a version to support AudioTracks, and modify the TextTrack
+        version to use the new 'buildStringForTrackBase' function.
+        (WebCore::CaptionUserPreferencesMediaAF::displayNameForTrack): Add an AudioTrack override so
+        our AVFoundation tracks are processed in our CaptionUserPreferencesMediaAF implementation, not the
+        generic version.
+        (WebCore::CaptionUserPreferencesMediaAF::sortedTrackListForMenu): Add an AudioTrack override so
+        that the menu items are sorted in order of display name, not language code.
+        * page/CaptionUserPreferencesMediaAF.h:
+
 2015-04-02  Brady Eidson  <beidson@apple.com>
 

trunk/Source/WebCore/page/CaptionUserPreferencesMediaAF.cpp

@@ -1 +1 @@
 /*
- * Copyright (C) 2012, 2013 Apple Inc. All rights reserved.
+ * Copyright (C) 2012-2015 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -30 +30 @@
 #include "CaptionUserPreferencesMediaAF.h"
 
+#include "AudioTrackList.h"
 #include "FloatConversion.h"
 #include "HTMLMediaElement.h"
@@ -537 +538 @@
 }
 
-static String trackDisplayName(TextTrack* track)
-{
-    if (track == TextTrack::captionMenuOffItem())
-        return textTrackOffMenuItemText();
-    if (track == TextTrack::captionMenuAutomaticItem())
-        return textTrackAutomaticMenuItemText();
-
-    StringBuilder displayName;
-    String label = track->label();
-    String trackLanguageIdentifier = track->language();
+static void buildDisplayStringForTrackBase(StringBuilder& displayName, const TrackBase& track)
+{
+    String label = track.label();
+    String trackLanguageIdentifier = track.language();
 
     RetainPtr<CFLocaleRef> currentLocale = adoptCF(CFLocaleCreate(kCFAllocatorDefault, defaultLanguage().createCFString().get()));
@@ -552 +547 @@
     RetainPtr<CFStringRef> languageCF = adoptCF(CFLocaleCopyDisplayNameForPropertyValue(currentLocale.get(), kCFLocaleLanguageCode, localeIdentifier.get()));
     String language = languageCF.get();
+
     if (!label.isEmpty()) {
         if (language.isEmpty() || label.contains(language))
@@ -582 +578 @@
             displayName.append(localeIdentifier.get());
     }
-    
+}
+
+static String trackDisplayName(AudioTrack* track)
+{
+    StringBuilder displayName;
+    buildDisplayStringForTrackBase(displayName, *track);
+    
+    if (displayName.isEmpty())
+        displayName.append(audioTrackNoLabelText());
+    
+    return displayName.toString();
+}
+
+String CaptionUserPreferencesMediaAF::displayNameForTrack(AudioTrack* track) const
+{
+    return trackDisplayName(track);
+}
+
+static String trackDisplayName(TextTrack* track)
+{
+    if (track == TextTrack::captionMenuOffItem())
+        return textTrackOffMenuItemText();
+    if (track == TextTrack::captionMenuAutomaticItem())
+        return textTrackAutomaticMenuItemText();
+
+    StringBuilder displayName;
+    buildDisplayStringForTrackBase(displayName, *track);
+
     if (displayName.isEmpty())
         displayName.append(textTrackNoLabelText());
@@ -721 +744 @@
     // ... and tracks of the same type and language sort by the menu item text.
     return codePointCompare(trackDisplayName(a.get()), trackDisplayName(b.get())) < 0;
+}
+
+Vector<RefPtr<AudioTrack>> CaptionUserPreferencesMediaAF::sortedTrackListForMenu(AudioTrackList* trackList)
+{
+    ASSERT(trackList);
+    
+    Vector<RefPtr<AudioTrack>> tracksForMenu;
+    
+    for (unsigned i = 0, length = trackList->length(); i < length; ++i) {
+        AudioTrack* track = trackList->item(i);
+        String language = displayNameForLanguageLocale(track->language());
+        tracksForMenu.append(track);
+    }
+    
+    std::sort(tracksForMenu.begin(), tracksForMenu.end(), [](const RefPtr<AudioTrack>& a, const RefPtr<AudioTrack>& b) {
+        return codePointCompare(trackDisplayName(a.get()), trackDisplayName(b.get())) < 0;
+    });
+    
+    return tracksForMenu;
 }
 

trunk/Source/WebCore/page/CaptionUserPreferencesMediaAF.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2012, 2013 Apple Inc. All rights reserved.
+ * Copyright (C) 2012-2015 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -65 +65 @@
     virtual String captionsStyleSheetOverride() const override;
     virtual int textTrackSelectionScore(TextTrack*, HTMLMediaElement*) const override;
-    virtual Vector<RefPtr<TextTrack>> sortedTrackListForMenu(TextTrackList*) override;
-    virtual String displayNameForTrack(TextTrack*) const override;
+    Vector<RefPtr<AudioTrack>> sortedTrackListForMenu(AudioTrackList*) override;
+    Vector<RefPtr<TextTrack>> sortedTrackListForMenu(TextTrackList*) override;
+    String displayNameForTrack(AudioTrack*) const override;
+    String displayNameForTrack(TextTrack*) const override;
 
 private: