diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /dom/media/MediaDecoderOwner.h | |
parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
download | uxp-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz |
Add m-esr52 at 52.6.0
Diffstat (limited to 'dom/media/MediaDecoderOwner.h')
-rw-r--r-- | dom/media/MediaDecoderOwner.h | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/dom/media/MediaDecoderOwner.h b/dom/media/MediaDecoderOwner.h new file mode 100644 index 0000000000..f884686fb2 --- /dev/null +++ b/dom/media/MediaDecoderOwner.h @@ -0,0 +1,156 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim:set ts=2 sw=2 sts=2 et cindent: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +#ifndef MediaDecoderOwner_h_ +#define MediaDecoderOwner_h_ +#include "AbstractMediaDecoder.h" +#include "nsAutoPtr.h" + +namespace mozilla { + +class VideoFrameContainer; +class MediaResult; + +namespace dom { +class HTMLMediaElement; +} // namespace dom + +class MediaDecoderOwner +{ +public: + // Called by the media decoder to indicate that the download is progressing. + virtual void DownloadProgressed() = 0; + + // Dispatch an asynchronous event to the decoder owner + virtual nsresult DispatchAsyncEvent(const nsAString& aName) = 0; + + // Triggers a recomputation of readyState. + virtual void UpdateReadyState() = 0; + + /** + * Fires a timeupdate event. If aPeriodic is true, the event will only + * be fired if we've not fired a timeupdate event (for any reason) in the + * last 250ms, as required by the spec when the current time is periodically + * increasing during playback. + */ + virtual void FireTimeUpdate(bool aPeriodic) = 0; + + // Get the HTMLMediaElement object if the decoder is being used from an + // HTML media element, and null otherwise. + virtual dom::HTMLMediaElement* GetMediaElement() + { + return nullptr; + } + + // Return true if decoding should be paused + virtual bool GetPaused() = 0; + + // Called by the video decoder object, on the main thread, + // when it has read the metadata containing video dimensions, + // etc. + // Must take ownership of MetadataTags aTags argument. + virtual void MetadataLoaded(const MediaInfo* aInfo, + nsAutoPtr<const MetadataTags> aTags) = 0; + + // Called by the decoder object, on the main thread, + // when it has read the first frame of the video or audio. + virtual void FirstFrameLoaded() = 0; + + // Called by the decoder object, on the main thread, + // when the resource has a network error during loading. + // The decoder owner should call Shutdown() on the decoder and drop the + // reference to the decoder to prevent further calls into the decoder. + virtual void NetworkError() = 0; + + // Called by the decoder object, on the main thread, when the + // resource has a decode error during metadata loading or decoding. + // The decoder owner should call Shutdown() on the decoder and drop the + // reference to the decoder to prevent further calls into the decoder. + virtual void DecodeError(const MediaResult& aError) = 0; + + // Return true if media element error attribute is not null. + virtual bool HasError() const = 0; + + // Called by the video decoder object, on the main thread, when the + // resource load has been cancelled. + virtual void LoadAborted() = 0; + + // Called by the video decoder object, on the main thread, + // when the video playback has ended. + virtual void PlaybackEnded() = 0; + + // Called by the video decoder object, on the main thread, + // when the resource has started seeking. + virtual void SeekStarted() = 0; + + // Called by the video decoder object, on the main thread, + // when the resource has completed seeking. + virtual void SeekCompleted() = 0; + + // Called by the media stream, on the main thread, when the download + // has been suspended by the cache or because the element itself + // asked the decoder to suspend the download. + virtual void DownloadSuspended() = 0; + + // Called by the media stream, on the main thread, when the download + // has been resumed by the cache or because the element itself + // asked the decoder to resumed the download. + // If aForceNetworkLoading is True, ignore the fact that the download has + // previously finished. We are downloading the middle of the media after + // having downloaded the end, we need to notify the element a download in + // ongoing. + virtual void DownloadResumed(bool aForceNetworkLoading = false) = 0; + + // Called by the media decoder to indicate whether the media cache has + // suspended the channel. + virtual void NotifySuspendedByCache(bool aIsSuspended) = 0; + + // called to notify that the principal of the decoder's media resource has changed. + virtual void NotifyDecoderPrincipalChanged() = 0; + + // The status of the next frame which might be available from the decoder + enum NextFrameStatus { + // The next frame of audio/video is available + NEXT_FRAME_AVAILABLE, + // The next frame of audio/video is unavailable because the decoder + // is paused while it buffers up data + NEXT_FRAME_UNAVAILABLE_BUFFERING, + // The next frame of audio/video is unavailable for the decoder is seeking. + NEXT_FRAME_UNAVAILABLE_SEEKING, + // The next frame of audio/video is unavailable for some other reasons + NEXT_FRAME_UNAVAILABLE, + // Sentinel value + NEXT_FRAME_UNINITIALIZED + }; + + // Check if the decoder owner is active. + virtual bool IsActive() const = 0; + + // Check if the decoder owner is hidden. + virtual bool IsHidden() const = 0; + + // Called by the media decoder and the video frame to get the + // ImageContainer containing the video data. + virtual VideoFrameContainer* GetVideoFrameContainer() = 0; + + // Called by media decoder when the audible state changed + virtual void SetAudibleState(bool aAudible) = 0; + + // Notified by the decoder that XPCOM shutdown has begun. + // The decoder owner should call Shutdown() on the decoder and drop the + // reference to the decoder to prevent further calls into the decoder. + virtual void NotifyXPCOMShutdown() = 0; + + // Dispatches a "encrypted" event to the HTMLMediaElement, with the + // provided init data. Actual dispatch may be delayed until HAVE_METADATA. + // Main thread only. + virtual void DispatchEncrypted(const nsTArray<uint8_t>& aInitData, + const nsAString& aInitDataType) = 0; +}; + +} // namespace mozilla + +#endif + |