Remove PassRefPtr use from the "html" directory, other improvements
[WebKit-https.git] / Source / WebCore / platform / graphics / avfoundation / objc / SourceBufferPrivateAVFObjC.h
1 /*
2  * Copyright (C) 2013-2017 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #if ENABLE(MEDIA_SOURCE) && USE(AVFOUNDATION)
29
30 #include "SourceBufferPrivate.h"
31 #include <dispatch/group.h>
32 #include <dispatch/semaphore.h>
33 #include <wtf/Deque.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/MediaTime.h>
36 #include <wtf/OSObjectPtr.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/RetainPtr.h>
39 #include <wtf/Vector.h>
40 #include <wtf/WeakPtr.h>
41 #include <wtf/text/AtomicString.h>
42
43 OBJC_CLASS AVAsset;
44 OBJC_CLASS AVStreamDataParser;
45 OBJC_CLASS AVSampleBufferAudioRenderer;
46 OBJC_CLASS AVSampleBufferDisplayLayer;
47 OBJC_CLASS NSData;
48 OBJC_CLASS NSError;
49 OBJC_CLASS NSObject;
50 OBJC_CLASS WebAVStreamDataParserListener;
51 OBJC_CLASS WebAVSampleBufferErrorListener;
52
53 typedef struct opaqueCMSampleBuffer *CMSampleBufferRef;
54 typedef const struct opaqueCMFormatDescription *CMFormatDescriptionRef;
55
56 namespace WebCore {
57
58 class CDMSessionMediaSourceAVFObjC;
59 class MediaSourcePrivateAVFObjC;
60 class TimeRanges;
61 class AudioTrackPrivate;
62 class VideoTrackPrivate;
63 class AudioTrackPrivateMediaSourceAVFObjC;
64 class VideoTrackPrivateMediaSourceAVFObjC;
65
66 class SourceBufferPrivateAVFObjCErrorClient {
67 public:
68     virtual ~SourceBufferPrivateAVFObjCErrorClient() { }
69     virtual void layerDidReceiveError(AVSampleBufferDisplayLayer *, NSError *, bool& shouldIgnore) = 0;
70     virtual void rendererDidReceiveError(AVSampleBufferAudioRenderer *, NSError *, bool& shouldIgnore) = 0;
71 };
72
73 class SourceBufferPrivateAVFObjC final : public SourceBufferPrivate {
74 public:
75     static RefPtr<SourceBufferPrivateAVFObjC> create(MediaSourcePrivateAVFObjC*);
76     virtual ~SourceBufferPrivateAVFObjC();
77
78     void clearMediaSource() { m_mediaSource = nullptr; }
79
80     // AVStreamDataParser delegate methods
81     void didParseStreamDataAsAsset(AVAsset*);
82     void didFailToParseStreamDataWithError(NSError*);
83     void didProvideMediaDataForTrackID(int trackID, CMSampleBufferRef, const String& mediaType, unsigned flags);
84     void didReachEndOfTrackWithTrackID(int trackID, const String& mediaType);
85     void willProvideContentKeyRequestInitializationDataForTrackID(int trackID);
86     void didProvideContentKeyRequestInitializationDataForTrackID(NSData*, int trackID, OSObjectPtr<dispatch_semaphore_t>);
87
88     bool processCodedFrame(int trackID, CMSampleBufferRef, const String& mediaType);
89
90     bool hasVideo() const;
91     bool hasAudio() const;
92
93     void trackDidChangeEnabled(VideoTrackPrivateMediaSourceAVFObjC*);
94     void trackDidChangeEnabled(AudioTrackPrivateMediaSourceAVFObjC*);
95
96     void willSeek();
97     void seekToTime(MediaTime);
98     MediaTime fastSeekTimeForMediaTime(MediaTime, MediaTime negativeThreshold, MediaTime positiveThreshold);
99     FloatSize naturalSize();
100
101     int protectedTrackID() const { return m_protectedTrackID; }
102     AVStreamDataParser* parser() const { return m_parser.get(); }
103     void setCDMSession(CDMSessionMediaSourceAVFObjC*);
104
105     void flush();
106
107     void registerForErrorNotifications(SourceBufferPrivateAVFObjCErrorClient*);
108     void unregisterForErrorNotifications(SourceBufferPrivateAVFObjCErrorClient*);
109     void layerDidReceiveError(AVSampleBufferDisplayLayer *, NSError *);
110     void rendererDidReceiveError(AVSampleBufferAudioRenderer *, NSError *);
111
112 private:
113     explicit SourceBufferPrivateAVFObjC(MediaSourcePrivateAVFObjC*);
114
115     // SourceBufferPrivate overrides
116     void setClient(SourceBufferPrivateClient*) final;
117     void append(const unsigned char* data, unsigned length) final;
118     void abort() final;
119     void resetParserState() final;
120     void removedFromMediaSource() final;
121     MediaPlayer::ReadyState readyState() const final;
122     void setReadyState(MediaPlayer::ReadyState) final;
123     void flush(const AtomicString& trackID) final;
124     void enqueueSample(Ref<MediaSample>&&, const AtomicString& trackID) final;
125     bool isReadyForMoreSamples(const AtomicString& trackID) final;
126     void setActive(bool) final;
127     void notifyClientWhenReadyForMoreSamples(const AtomicString& trackID) final;
128
129     void didBecomeReadyForMoreSamples(int trackID);
130     void appendCompleted();
131     void destroyParser();
132     void destroyRenderers();
133
134     void flush(AVSampleBufferDisplayLayer *);
135     void flush(AVSampleBufferAudioRenderer *);
136
137     WeakPtr<SourceBufferPrivateAVFObjC> createWeakPtr() { return m_weakFactory.createWeakPtr(); }
138
139     Vector<RefPtr<VideoTrackPrivateMediaSourceAVFObjC>> m_videoTracks;
140     Vector<RefPtr<AudioTrackPrivateMediaSourceAVFObjC>> m_audioTracks;
141     Vector<SourceBufferPrivateAVFObjCErrorClient*> m_errorClients;
142
143     WeakPtrFactory<SourceBufferPrivateAVFObjC> m_weakFactory;
144     WeakPtrFactory<SourceBufferPrivateAVFObjC> m_appendWeakFactory;
145
146     RetainPtr<AVStreamDataParser> m_parser;
147     RetainPtr<AVAsset> m_asset;
148     RetainPtr<AVSampleBufferDisplayLayer> m_displayLayer;
149     HashMap<int, RetainPtr<AVSampleBufferAudioRenderer>> m_audioRenderers;
150     RetainPtr<WebAVStreamDataParserListener> m_delegate;
151     RetainPtr<WebAVSampleBufferErrorListener> m_errorListener;
152     RetainPtr<NSError> m_hdcpError;
153     OSObjectPtr<dispatch_semaphore_t> m_hasSessionSemaphore;
154     OSObjectPtr<dispatch_group_t> m_isAppendingGroup;
155
156     MediaSourcePrivateAVFObjC* m_mediaSource;
157     SourceBufferPrivateClient* m_client { nullptr };
158 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
159     CDMSessionMediaSourceAVFObjC* m_session { nullptr };
160 #endif
161
162     std::optional<FloatSize> m_cachedSize;
163     FloatSize m_currentSize;
164     bool m_parsingSucceeded { true };
165     bool m_parserStateWasReset { false };
166     int m_enabledVideoTrackID { -1 };
167     int m_protectedTrackID { -1 };
168 };
169
170 }
171
172 #endif // ENABLE(MEDIA_SOURCE) && USE(AVFOUNDATION)