getUserMedia is resolving before the document knows it is capturing
[WebKit-https.git] / Source / WebCore / Modules / mediastream / UserMediaRequest.h
1 /*
2  * Copyright (C) 2011 Ericsson AB. All rights reserved.
3  * Copyright (C) 2013-2016 Apple Inc. All rights reserved.
4  * Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer
14  *    in the documentation and/or other materials provided with the
15  *    distribution.
16  * 3. Neither the name of Ericsson nor the names of its contributors
17  *    may be used to endorse or promote products derived from this
18  *    software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #pragma once
34
35 #if ENABLE(MEDIA_STREAM)
36
37 #include "ActiveDOMObject.h"
38 #include "CaptureDevice.h"
39 #include "JSDOMPromiseDeferred.h"
40 #include "MediaConstraints.h"
41 #include "MediaStreamPrivate.h"
42
43 namespace WebCore {
44
45 class MediaStream;
46 class SecurityOrigin;
47 class UserMediaController;
48
49 class UserMediaRequest : public RefCounted<UserMediaRequest>, private ContextDestructionObserver {
50 public:
51     static ExceptionOr<void> start(Document&, MediaConstraints&& audioConstraints, MediaConstraints&& videoConstraints, DOMPromiseDeferred<IDLInterface<MediaStream>>&&);
52
53     virtual ~UserMediaRequest();
54
55     void start();
56
57     WEBCORE_EXPORT void setAllowedMediaDeviceUIDs(const String& audioDeviceUID, const String& videoDeviceUID);
58     WEBCORE_EXPORT void allow(CaptureDevice&& audioDevice, CaptureDevice&& videoDevice, String&& deviceIdentifierHashSalt);
59
60     enum MediaAccessDenialReason { NoConstraints, UserMediaDisabled, NoCaptureDevices, InvalidConstraint, HardwareError, PermissionDenied, OtherFailure };
61     WEBCORE_EXPORT void deny(MediaAccessDenialReason, const String& invalidConstraint);
62
63     const Vector<String>& audioDeviceUIDs() const { return m_audioDeviceUIDs; }
64     const Vector<String>& videoDeviceUIDs() const { return m_videoDeviceUIDs; }
65
66     const MediaConstraints& audioConstraints() const { return m_audioConstraints; }
67     const MediaConstraints& videoConstraints() const { return m_videoConstraints; }
68
69     WEBCORE_EXPORT SecurityOrigin* userMediaDocumentOrigin() const;
70     WEBCORE_EXPORT SecurityOrigin* topLevelDocumentOrigin() const;
71     WEBCORE_EXPORT Document* document() const;
72
73 private:
74     UserMediaRequest(Document&, UserMediaController&, MediaConstraints&& audioConstraints, MediaConstraints&& videoConstraints, DOMPromiseDeferred<IDLInterface<MediaStream>>&&);
75
76     void contextDestroyed() final;
77
78     void mediaStreamIsReady(Ref<MediaStream>&&);
79
80     class PendingActivationMediaStream : public RefCounted<PendingActivationMediaStream>, private MediaStreamPrivate::Observer {
81     public:
82         static Ref<PendingActivationMediaStream> create(Ref<UserMediaRequest>&& request, Ref<MediaStream>&& stream)
83         {
84             return adoptRef(*new PendingActivationMediaStream { WTFMove(request), WTFMove(stream) });
85         }
86         ~PendingActivationMediaStream();
87
88     private:
89         PendingActivationMediaStream(Ref<UserMediaRequest>&&, Ref<MediaStream>&&);
90
91         void characteristicsChanged() final;
92
93         Ref<UserMediaRequest> m_request;
94         Ref<MediaStream> m_mediaStream;
95     };
96
97     MediaConstraints m_audioConstraints;
98     MediaConstraints m_videoConstraints;
99
100     Vector<String> m_videoDeviceUIDs;
101     Vector<String> m_audioDeviceUIDs;
102
103     CaptureDevice m_allowedVideoDevice;
104     CaptureDevice m_allowedAudioDevice;
105
106     UserMediaController* m_controller;
107     DOMPromiseDeferred<IDLInterface<MediaStream>> m_promise;
108     RefPtr<UserMediaRequest> m_protector;
109     RefPtr<PendingActivationMediaStream> m_pendingActivationMediaStream;
110 };
111
112 } // namespace WebCore
113
114 #endif // ENABLE(MEDIA_STREAM)