[Mac] HLS audio is not correctly selected according to system language
[WebKit-https.git] / Source / WebCore / platform / graphics / avfoundation / MediaSelectionGroupAVFObjC.mm
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "MediaSelectionGroupAVFObjC.h"
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #import "Language.h"
32 #import "SoftLinking.h"
33 #import <AVFoundation/AVAsset.h>
34 #import <AVFoundation/AVMediaSelectionGroup.h>
35 #import <AVFoundation/AVPlayerItem.h>
36 #import <objc/runtime.h>
37 #import <wtf/HashMap.h>
38 #import <wtf/HashSet.h>
39 #import <wtf/text/WTFString.h>
40
41 SOFT_LINK_FRAMEWORK_OPTIONAL(AVFoundation)
42
43 SOFT_LINK_CLASS(AVFoundation, AVMediaSelectionGroup)
44 SOFT_LINK_CLASS(AVFoundation, AVMediaSelectionOption)
45
46 namespace WebCore {
47
48 PassRefPtr<MediaSelectionOptionAVFObjC> MediaSelectionOptionAVFObjC::create(MediaSelectionGroupAVFObjC& group, AVMediaSelectionOption *option)
49 {
50     return adoptRef(new MediaSelectionOptionAVFObjC(group, option));
51 }
52
53 MediaSelectionOptionAVFObjC::MediaSelectionOptionAVFObjC(MediaSelectionGroupAVFObjC& group, AVMediaSelectionOption *option)
54     : m_group(&group)
55     , m_mediaSelectionOption(option)
56 {
57 }
58
59 void MediaSelectionOptionAVFObjC::setSelected(bool selected)
60 {
61     if (!m_group)
62         return;
63
64     if (selected == this->selected())
65         return;
66
67     m_group->setSelectedOption(selected ? this : nullptr);
68 }
69
70 bool MediaSelectionOptionAVFObjC::selected() const
71 {
72     if (!m_group)
73         return false;
74     return this == m_group->selectedOption();
75 }
76
77 int MediaSelectionOptionAVFObjC::index() const
78 {
79     if (!m_group)
80         return 0;
81
82     return [[m_group->avMediaSelectionGroup() options] indexOfObject:m_mediaSelectionOption.get()];
83 }
84
85 PassRefPtr<MediaSelectionGroupAVFObjC> MediaSelectionGroupAVFObjC::create(AVPlayerItem *item, AVMediaSelectionGroup *group)
86 {
87     return adoptRef(new MediaSelectionGroupAVFObjC(item, group));
88 }
89
90 MediaSelectionGroupAVFObjC::MediaSelectionGroupAVFObjC(AVPlayerItem *item, AVMediaSelectionGroup *group)
91     : m_playerItem(item)
92     , m_mediaSelectionGroup(group)
93     , m_selectionTimer(*this, &MediaSelectionGroupAVFObjC::selectionTimerFired)
94 {
95     updateOptions();
96 }
97
98 MediaSelectionGroupAVFObjC::~MediaSelectionGroupAVFObjC()
99 {
100     for (auto& option : m_options.values())
101         option->clearGroup();
102 }
103
104 void MediaSelectionGroupAVFObjC::updateOptions()
105 {
106     RetainPtr<NSSet> newAVOptions = adoptNS([[NSSet alloc] initWithArray:[getAVMediaSelectionGroupClass() playableMediaSelectionOptionsFromArray:[m_mediaSelectionGroup options]]]);
107     RetainPtr<NSMutableSet> oldAVOptions = adoptNS([[NSMutableSet alloc] initWithCapacity:m_options.size()]);
108     for (auto& avOption : m_options.keys())
109         [oldAVOptions addObject:avOption];
110
111     RetainPtr<NSMutableSet> addedAVOptions = adoptNS([newAVOptions mutableCopy]);
112     [addedAVOptions minusSet:oldAVOptions.get()];
113
114     RetainPtr<NSMutableSet> removedAVOptions = adoptNS([oldAVOptions mutableCopy]);
115     [removedAVOptions minusSet:newAVOptions.get()];
116
117     for (AVMediaSelectionOption* removedAVOption in removedAVOptions.get()) {
118         if (m_selectedOption && removedAVOption == m_selectedOption->avMediaSelectionOption())
119             m_selectedOption = nullptr;
120
121         m_options.remove(removedAVOption);
122     }
123
124     AVMediaSelectionOption* selectedOption = [m_playerItem selectedMediaOptionInMediaSelectionGroup:m_mediaSelectionGroup.get()];
125
126     for (AVMediaSelectionOption* addedAVOption in addedAVOptions.get()) {
127         RefPtr<MediaSelectionOptionAVFObjC> addedOption = MediaSelectionOptionAVFObjC::create(*this, addedAVOption);
128         if (addedAVOption == selectedOption)
129             m_selectedOption = addedOption.get();
130         m_options.set(addedAVOption, addedOption.release());
131     }
132
133     if (!m_shouldSelectOptionAutomatically)
134         return;
135
136     RetainPtr<NSMutableArray> nsLanguages = adoptNS([[NSMutableArray alloc] initWithCapacity:userPreferredLanguages().size()]);
137     for (auto& language : userPreferredLanguages())
138         [nsLanguages addObject:(NSString*)language];
139     NSArray* filteredOptions = [getAVMediaSelectionGroupClass() mediaSelectionOptionsFromArray:[m_mediaSelectionGroup options] filteredAndSortedAccordingToPreferredLanguages:nsLanguages.get()];
140
141     if (![filteredOptions count])
142         return;
143
144     AVMediaSelectionOption* preferredOption = [filteredOptions objectAtIndex:0];
145     if (m_selectedOption && m_selectedOption->avMediaSelectionOption() == preferredOption)
146         return;
147
148     ASSERT(m_options.contains(preferredOption));
149     m_selectedOption = m_options.get(preferredOption);
150     m_selectionTimer.startOneShot(0);
151 }
152
153 void MediaSelectionGroupAVFObjC::setSelectedOption(MediaSelectionOptionAVFObjC* option)
154 {
155     if (m_selectedOption == option)
156         return;
157
158     m_shouldSelectOptionAutomatically = false;
159     m_selectedOption = option;
160     if (m_selectionTimer.isActive())
161         m_selectionTimer.stop();
162     m_selectionTimer.startOneShot(0);
163 }
164
165 void MediaSelectionGroupAVFObjC::selectionTimerFired()
166 {
167     [m_playerItem selectMediaOption:(m_selectedOption ? m_selectedOption->avMediaSelectionOption() : nil) inMediaSelectionGroup:m_mediaSelectionGroup.get()];
168 }
169
170 }
171
172 #endif