blob: 4766b34a599028c0e2c865e8549fe9c7f48f79ad [file] [log] [blame]
/*
* Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
* Copyright (C) 2011, 2012 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(VIDEO)
#include "Chrome.h"
#include "HTMLDivElement.h"
#include "MediaControlElements.h"
#include <wtf/RefPtr.h>
#if ENABLE(VIDEO_TRACK)
#include "TextTrackCue.h"
#endif
namespace WebCore {
class Document;
class Event;
class MediaPlayer;
class RenderBox;
class RenderMedia;
// An abstract class with the media control elements that all ports support.
class MediaControls : public HTMLDivElement {
WTF_MAKE_ISO_ALLOCATED(MediaControls);
public:
virtual ~MediaControls() = default;
// This function is to be implemented in your port-specific media
// controls implementation since it will return a child instance.
static RefPtr<MediaControls> tryCreate(Document&);
virtual void setMediaController(MediaControllerInterface*);
virtual void reset();
virtual void reportedError();
virtual void loadedMetadata();
virtual void show();
virtual void hide();
virtual void makeOpaque();
virtual void makeTransparent();
virtual bool shouldHideControls();
virtual void bufferingProgressed();
virtual void playbackStarted();
virtual void playbackProgressed();
virtual void playbackStopped();
virtual void updateStatusDisplay() { };
virtual void updateCurrentTimeDisplay();
virtual void showVolumeSlider();
virtual void changedMute();
virtual void changedVolume();
virtual void changedClosedCaptionsVisibility();
virtual void refreshClosedCaptionsButtonVisibility();
virtual void toggleClosedCaptionTrackList() { }
virtual void closedCaptionTracksChanged();
virtual void enteredFullscreen();
virtual void exitedFullscreen();
#if !PLATFORM(IOS_FAMILY)
bool willRespondToMouseMoveEvents() override { return true; }
#endif
virtual void hideFullscreenControlsTimerFired();
virtual void startHideFullscreenControlsTimer();
virtual void stopHideFullscreenControlsTimer();
#if ENABLE(VIDEO_TRACK)
virtual void createTextTrackDisplay();
virtual void showTextTrackDisplay();
virtual void hideTextTrackDisplay();
virtual void updateTextTrackDisplay();
virtual void textTrackPreferencesChanged();
virtual void clearTextDisplayContainer();
#endif
protected:
explicit MediaControls(Document&);
void defaultEventHandler(Event&) override;
virtual bool containsRelatedTarget(Event&);
void setSliderVolume();
MediaControllerInterface* m_mediaController;
// Container for the media control elements.
MediaControlPanelElement* m_panel;
// Container for the text track cues.
#if ENABLE(VIDEO_TRACK)
MediaControlTextTrackContainerElement* m_textDisplayContainer;
#endif
// Media control elements.
MediaControlPlayButtonElement* m_playButton;
MediaControlCurrentTimeDisplayElement* m_currentTimeDisplay;
MediaControlTimelineElement* m_timeline;
MediaControlPanelMuteButtonElement* m_panelMuteButton;
MediaControlPanelVolumeSliderElement* m_volumeSlider;
MediaControlToggleClosedCaptionsButtonElement* m_toggleClosedCaptionsButton;
MediaControlFullscreenButtonElement* m_fullScreenButton;
Timer m_hideFullscreenControlsTimer;
bool m_isFullscreen;
bool m_isMouseOverControls;
private:
bool isMediaControls() const final { return true; }
};
inline MediaControls* toMediaControls(Node* node)
{
ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isMediaControls());
return static_cast<MediaControls*>(node);
}
// This will catch anyone doing an unneccessary cast.
void toMediaControls(const MediaControls*);
} // namespace WebCore
#endif // ENABLE(VIDEO)