Unreviewed, rolling out r244556.
[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 <AVFoundation/AVAsset.h>
32 #import <AVFoundation/AVMediaSelectionGroup.h>
33 #import <AVFoundation/AVPlayerItem.h>
34 #import <objc/runtime.h>
35 #import <wtf/Language.h>
36 #import <wtf/SoftLinking.h>
37 #import <wtf/text/WTFString.h>
38
39 SOFT_LINK_FRAMEWORK_OPTIONAL(AVFoundation)
40
41 SOFT_LINK_CLASS(AVFoundation, AVMediaSelectionGroup)
42 SOFT_LINK_CLASS(AVFoundation, AVMediaSelectionOption)
43
44 #if HAVE(MEDIA_ACCESSIBILITY_FRAMEWORK)
45 #include <MediaAccessibility/MediaAccessibility.h>
46 #include "MediaAccessibilitySoftLink.h"
47 #endif
48
49 namespace WebCore {
50
51 Ref<MediaSelectionOptionAVFObjC> MediaSelectionOptionAVFObjC::create(MediaSelectionGroupAVFObjC& group, AVMediaSelectionOption *option)
52 {
53     return adoptRef(*new MediaSelectionOptionAVFObjC(group, option));
54 }
55
56 MediaSelectionOptionAVFObjC::MediaSelectionOptionAVFObjC(MediaSelectionGroupAVFObjC& group, AVMediaSelectionOption *option)
57     : m_group(&group)
58     , m_mediaSelectionOption(option)
59 {
60 }
61
62 void MediaSelectionOptionAVFObjC::setSelected(bool selected)
63 {
64     if (!m_group)
65         return;
66
67     if (selected == this->selected())
68         return;
69
70     m_group->setSelectedOption(selected ? this : nullptr);
71 }
72
73 bool MediaSelectionOptionAVFObjC::selected() const
74 {
75     if (!m_group)
76         return false;
77     return this == m_group->selectedOption();
78 }
79
80 int MediaSelectionOptionAVFObjC::index() const
81 {
82     if (!m_group)
83         return 0;
84
85     return [[m_group->avMediaSelectionGroup() options] indexOfObject:m_mediaSelectionOption.get()];
86 }
87
88 Ref<MediaSelectionGroupAVFObjC> MediaSelectionGroupAVFObjC::create(AVPlayerItem *item, AVMediaSelectionGroup *group, const Vector<String>& characteristics)
89 {
90     return adoptRef(*new MediaSelectionGroupAVFObjC(item, group, characteristics));
91 }
92
93 MediaSelectionGroupAVFObjC::MediaSelectionGroupAVFObjC(AVPlayerItem *item, AVMediaSelectionGroup *group, const Vector<String>& characteristics)
94     : m_playerItem(item)
95     , m_mediaSelectionGroup(group)
96     , m_selectionTimer(*this, &MediaSelectionGroupAVFObjC::selectionTimerFired)
97 {
98     updateOptions(characteristics);
99 }
100
101 MediaSelectionGroupAVFObjC::~MediaSelectionGroupAVFObjC()
102 {
103     for (auto& option : m_options.values())
104         option->clearGroup();
105 }
106
107 void MediaSelectionGroupAVFObjC::updateOptions(const Vector<String>& characteristics)
108 {
109     RetainPtr<NSSet> newAVOptions = adoptNS([[NSSet alloc] initWithArray:[getAVMediaSelectionGroupClass() playableMediaSelectionOptionsFromArray:[m_mediaSelectionGroup options]]]);
110     RetainPtr<NSMutableSet> oldAVOptions = adoptNS([[NSMutableSet alloc] initWithCapacity:m_options.size()]);
111     for (auto& avOption : m_options.keys())
112         [oldAVOptions addObject:(__bridge AVMediaSelectionOption *)avOption];
113
114     RetainPtr<NSMutableSet> addedAVOptions = adoptNS([newAVOptions mutableCopy]);
115     [addedAVOptions minusSet:oldAVOptions.get()];
116
117     RetainPtr<NSMutableSet> removedAVOptions = adoptNS([oldAVOptions mutableCopy]);
118     [removedAVOptions minusSet:newAVOptions.get()];
119
120     for (AVMediaSelectionOption* removedAVOption in removedAVOptions.get()) {
121         if (m_selectedOption && removedAVOption == m_selectedOption->avMediaSelectionOption())
122             m_selectedOption = nullptr;
123
124         m_options.remove((__bridge CFTypeRef)removedAVOption);
125     }
126     ALLOW_DEPRECATED_DECLARATIONS_BEGIN
127     AVMediaSelectionOption* selectedOption = [m_playerItem selectedMediaOptionInMediaSelectionGroup:m_mediaSelectionGroup.get()];
128     ALLOW_DEPRECATED_DECLARATIONS_END
129     for (AVMediaSelectionOption* addedAVOption in addedAVOptions.get()) {
130         auto addedOption = MediaSelectionOptionAVFObjC::create(*this, addedAVOption);
131         if (addedAVOption == selectedOption)
132             m_selectedOption = addedOption.ptr();
133         m_options.set((__bridge CFTypeRef)addedAVOption, WTFMove(addedOption));
134     }
135
136     if (!m_shouldSelectOptionAutomatically)
137         return;
138
139     RetainPtr<NSMutableArray> nsLanguages = adoptNS([[NSMutableArray alloc] initWithCapacity:userPreferredLanguages().size()]);
140     for (auto& language : userPreferredLanguages())
141         [nsLanguages addObject:(NSString*)language];
142     NSArray* filteredOptions = [getAVMediaSelectionGroupClass() mediaSelectionOptionsFromArray:[m_mediaSelectionGroup options] filteredAndSortedAccordingToPreferredLanguages:nsLanguages.get()];
143
144     if (![filteredOptions count] && characteristics.isEmpty())
145         return;
146
147     // If no options match our language selection, search for matching characteristics across all the group's options
148     if (![filteredOptions count])
149         filteredOptions = [m_mediaSelectionGroup options];
150
151     RetainPtr<NSMutableArray> nsCharacteristics = adoptNS([[NSMutableArray alloc] initWithCapacity:characteristics.size()]);
152     for (auto& characteristic : characteristics)
153         [nsCharacteristics addObject:(NSString *)characteristic];
154
155     NSArray* optionsWithCharacteristics = [getAVMediaSelectionGroupClass() mediaSelectionOptionsFromArray:filteredOptions withMediaCharacteristics:nsCharacteristics.get()];
156     if (optionsWithCharacteristics && [optionsWithCharacteristics count])
157         filteredOptions = optionsWithCharacteristics;
158
159     if (![filteredOptions count])
160         return;
161
162     AVMediaSelectionOption* preferredOption = [filteredOptions objectAtIndex:0];
163     if (m_selectedOption && m_selectedOption->avMediaSelectionOption() == preferredOption)
164         return;
165
166     ASSERT(m_options.contains((__bridge CFTypeRef)preferredOption));
167     m_selectedOption = m_options.get((__bridge CFTypeRef)preferredOption);
168     m_selectionTimer.startOneShot(0_s);
169 }
170
171 void MediaSelectionGroupAVFObjC::setSelectedOption(MediaSelectionOptionAVFObjC* option)
172 {
173     if (m_selectedOption == option)
174         return;
175
176     m_shouldSelectOptionAutomatically = false;
177     m_selectedOption = option;
178     if (m_selectionTimer.isActive())
179         m_selectionTimer.stop();
180     m_selectionTimer.startOneShot(0_s);
181 }
182
183 void MediaSelectionGroupAVFObjC::selectionTimerFired()
184 {
185     [m_playerItem selectMediaOption:(m_selectedOption ? m_selectedOption->avMediaSelectionOption() : nil) inMediaSelectionGroup:m_mediaSelectionGroup.get()];
186 }
187
188 }
189
190 #endif