82 lines
2.6 KiB
C++
82 lines
2.6 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* 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 MediaResourceCallback_h_
|
|
#define MediaResourceCallback_h_
|
|
|
|
#include "nsError.h"
|
|
#include "nsISupportsImpl.h"
|
|
|
|
namespace mozilla {
|
|
|
|
class MediaDecoderOwner;
|
|
class MediaResource;
|
|
|
|
/**
|
|
* A callback used by MediaResource (sub-classes like FileMediaResource,
|
|
* RtspMediaResource, and ChannelMediaResource) to notify various events.
|
|
* Currently this is implemented by MediaDecoder only.
|
|
*
|
|
* Since this class has no pure virtual function, it is convenient to write
|
|
* gtests for the readers without using a mock MediaResource when you don't
|
|
* care about the events notified by the MediaResource.
|
|
*/
|
|
class MediaResourceCallback {
|
|
public:
|
|
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(MediaResourceCallback);
|
|
|
|
// Returns a weak reference to the media decoder owner.
|
|
virtual MediaDecoderOwner* GetMediaOwner() const { return nullptr; }
|
|
|
|
// Notify is duration is known to this MediaResource.
|
|
virtual void SetInfinite(bool aInfinite) {}
|
|
|
|
// Notify if seeking is supported by this MediaResource.
|
|
virtual void SetMediaSeekable(bool aMediaSeekable) {}
|
|
|
|
// Notify that server connection is closed.
|
|
virtual void ResetConnectionState() {}
|
|
|
|
// Used by RtspMediaResource which has an unusual sequence
|
|
// to setup the decoder.
|
|
virtual nsresult FinishDecoderSetup(MediaResource* aResource) {
|
|
return NS_OK;
|
|
}
|
|
|
|
// Notify that a network error is encountered.
|
|
virtual void NotifyNetworkError() {}
|
|
|
|
// Notify that decoding has failed.
|
|
virtual void NotifyDecodeError() {}
|
|
|
|
// Notify that data arrives on the stream and is read into the cache.
|
|
virtual void NotifyDataArrived() {}
|
|
|
|
// Notify that MediaResource has received some data.
|
|
virtual void NotifyBytesDownloaded() {}
|
|
|
|
// Notify download is ended.
|
|
// NOTE: this can be called with the media cache lock held, so don't
|
|
// block or do anything which might try to acquire a lock!
|
|
virtual void NotifyDataEnded(nsresult aStatus) {}
|
|
|
|
// Notify that the principal of MediaResource has changed.
|
|
virtual void NotifyPrincipalChanged() {}
|
|
|
|
// Notify that the "cache suspended" status of MediaResource changes.
|
|
virtual void NotifySuspendedStatusChanged() {}
|
|
|
|
// Notify the number of bytes read from the resource.
|
|
virtual void NotifyBytesConsumed(int64_t aBytes, int64_t aOffset) {}
|
|
|
|
protected:
|
|
virtual ~MediaResourceCallback() {}
|
|
};
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif //MediaResourceCallback_h_
|