NowPlayingInfo should contain a unique identifier
[WebKit-https.git] / Source / WebCore / platform / audio / mac / MediaSessionManagerMac.h
1 /*
2  * Copyright (C) 2016-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. 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 #pragma once
27
28 #if PLATFORM(MAC)
29
30 #include "GenericTaskQueue.h"
31 #include "PlatformMediaSessionManager.h"
32
33 namespace WebCore {
34
35 class MediaSessionManagerMac : public PlatformMediaSessionManager {
36 public:
37     virtual ~MediaSessionManagerMac();
38
39     bool hasActiveNowPlayingSession() const final { return m_nowPlayingActive; }
40     String lastUpdatedNowPlayingTitle() const final { return m_lastUpdatedNowPlayingTitle; }
41     double lastUpdatedNowPlayingDuration() const final { return m_lastUpdatedNowPlayingDuration; }
42     double lastUpdatedNowPlayingElapsedTime() const final { return m_lastUpdatedNowPlayingElapsedTime; }
43     uint64_t lastUpdatedNowPlayingInfoUniqueIdentifier() const final { return m_lastUpdatedNowPlayingInfoUniqueIdentifier; }
44
45 private:
46     friend class PlatformMediaSessionManager;
47
48     MediaSessionManagerMac();
49
50     void scheduleUpdateNowPlayingInfo() override;
51     void removeSession(PlatformMediaSession&) override;
52
53     bool sessionWillBeginPlayback(PlatformMediaSession&) override;
54     void sessionWillEndPlayback(PlatformMediaSession&) override;
55     void sessionDidEndRemoteScrubbing(const PlatformMediaSession&) override;
56     void clientCharacteristicsChanged(PlatformMediaSession&) override;
57
58     void updateNowPlayingInfo();
59
60     PlatformMediaSession* nowPlayingEligibleSession();
61
62     bool m_nowPlayingActive { false };
63     bool m_isInBackground { false };
64
65     // For testing purposes only.
66     String m_lastUpdatedNowPlayingTitle;
67     double m_lastUpdatedNowPlayingDuration { NAN };
68     double m_lastUpdatedNowPlayingElapsedTime { NAN };
69     uint64_t m_lastUpdatedNowPlayingInfoUniqueIdentifier { 0 };
70
71     GenericTaskQueue<Timer> m_nowPlayingUpdateTaskQueue;
72 };
73
74 } // namespace WebCore
75
76 #endif // PLATFORM(MAC)