Source/WebCore/platform/audio/MediaSessionManager.h

   1 /*
   2  * Copyright (C) 2013-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 #ifndef MediaSessionManager_h
  27 #define MediaSessionManager_h
  28
  29 #include "MediaSession.h"
  30 #include "RemoteCommandListener.h"
  31 #include "Settings.h"
  32 #include "SystemSleepListener.h"
  33 #include <map>
  34 #include <wtf/Vector.h>
  35
  36 namespace WebCore {
  37
  38 class HTMLMediaElement;
  39 class MediaSession;
  40 class RemoteCommandListener;
  41
  42 class MediaSessionManagerClient {
  43 public:
  44     virtual ~MediaSessionManagerClient() { }
  45
  46     virtual bool isListeningForRemoteControlCommands() = 0;
  47     virtual void startListeningForRemoteControlCommands() = 0;
  48     virtual void stopListeningForRemoteControlCommands() = 0;
  49     virtual void didBeginPlayback() = 0;
  50
  51 protected:
  52     MediaSessionManagerClient() { }
  53 };
  54
  55 class MediaSessionManager : RemoteCommandListenerClient, SystemSleepListener::Client {
  56 public:
  57     static MediaSessionManager& sharedManager();
  58     virtual ~MediaSessionManager() { }
  59
  60     bool has(MediaSession::MediaType) const;
  61     int count(MediaSession::MediaType) const;
  62
  63     void beginInterruption(MediaSession::InterruptionType);
  64     void endInterruption(MediaSession::EndInterruptionFlags);
  65
  66     void applicationWillEnterForeground() const;
  67     void applicationWillEnterBackground() const;
  68     void wirelessRoutesAvailableChanged();
  69
  70     enum SessionRestrictionFlags {
  71         NoRestrictions = 0,
  72         ConcurrentPlaybackNotPermitted = 1 << 0,
  73         InlineVideoPlaybackRestricted = 1 << 1,
  74         MetadataPreloadingNotPermitted = 1 << 2,
  75         AutoPreloadingNotPermitted = 1 << 3,
  76         BackgroundPlaybackNotPermitted = 1 << 4,
  77     };
  78     typedef unsigned SessionRestrictions;
  79
  80     void addRestriction(MediaSession::MediaType, SessionRestrictions);
  81     void removeRestriction(MediaSession::MediaType, SessionRestrictions);
  82     SessionRestrictions restrictions(MediaSession::MediaType);
  83     virtual void resetRestrictions();
  84
  85     virtual void sessionWillBeginPlayback(MediaSession&);
  86     virtual void sessionWillEndPlayback(MediaSession&);
  87
  88     bool sessionRestrictsInlineVideoPlayback(const MediaSession&) const;
  89
  90 #if ENABLE(IOS_AIRPLAY)
  91     virtual bool hasWirelessTargetsAvailable() { return false; }
  92     virtual void startMonitoringAirPlayRoutes() { }
  93     virtual void stopMonitoringAirPlayRoutes() { }
  94 #endif
  95
  96     virtual void didReceiveRemoteControlCommand(MediaSession::RemoteControlCommandType) override;
  97
  98     void addClient(MediaSessionManagerClient*);
  99     void removeClient(MediaSessionManagerClient*);
 100
 101 protected:
 102     friend class MediaSession;
 103     explicit MediaSessionManager();
 104
 105     void addSession(MediaSession&);
 106     void removeSession(MediaSession&);
 107
 108     void setCurrentSession(MediaSession&);
 109     MediaSession* currentSession();
 110
 111 private:
 112     friend class Internals;
 113
 114     void updateSessionState();
 115
 116     virtual void systemWillSleep();
 117     virtual void systemDidWake();
 118
 119     SessionRestrictions m_restrictions[MediaSession::WebAudio + 1];
 120
 121     Vector<MediaSession*> m_sessions;
 122     Vector<MediaSessionManagerClient*> m_clients;
 123     std::unique_ptr<RemoteCommandListener> m_remoteCommandListener;
 124     std::unique_ptr<SystemSleepListener> m_systemSleepListener;
 125     bool m_interrupted;
 126 };
 127
 128 }
 129
 130 #endif // MediaSessionManager_h