2010-08-13 21:09:48 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* the Mozilla Foundation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2010.
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
#ifndef MOZILLA_IMAGELIB_IMAGE_H_
|
|
|
|
#define MOZILLA_IMAGELIB_IMAGE_H_
|
|
|
|
|
|
|
|
#include "imgIContainer.h"
|
|
|
|
#include "imgStatusTracker.h"
|
|
|
|
#include "prtypes.h"
|
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace imagelib {
|
|
|
|
|
|
|
|
class Image : public imgIContainer
|
|
|
|
{
|
|
|
|
public:
|
2010-11-17 12:39:23 -08:00
|
|
|
// From NS_DECL_IMGICONTAINER:
|
|
|
|
NS_SCRIPTABLE NS_IMETHOD GetAnimationMode(PRUint16 *aAnimationMode);
|
|
|
|
NS_SCRIPTABLE NS_IMETHOD SetAnimationMode(PRUint16 aAnimationMode);
|
|
|
|
|
2010-08-23 15:44:07 -07:00
|
|
|
imgStatusTracker& GetStatusTracker() { return *mStatusTracker; }
|
2010-08-13 21:09:48 -07:00
|
|
|
|
2010-08-13 21:09:49 -07:00
|
|
|
/**
|
|
|
|
* Flags for Image initialization.
|
|
|
|
*
|
|
|
|
* Meanings:
|
|
|
|
*
|
|
|
|
* INIT_FLAG_NONE: Lack of flags
|
|
|
|
*
|
|
|
|
* INIT_FLAG_DISCARDABLE: The container should be discardable
|
|
|
|
*
|
|
|
|
* INIT_FLAG_DECODE_ON_DRAW: The container should decode on draw rather than
|
|
|
|
* decoding on load.
|
|
|
|
*
|
|
|
|
* INIT_FLAG_MULTIPART: The container will be used to display a stream of
|
|
|
|
* images in a multipart channel. If this flag is set, INIT_FLAG_DISCARDABLE
|
|
|
|
* and INIT_FLAG_DECODE_ON_DRAW must not be set.
|
|
|
|
*/
|
|
|
|
static const PRUint32 INIT_FLAG_NONE = 0x0;
|
|
|
|
static const PRUint32 INIT_FLAG_DISCARDABLE = 0x1;
|
|
|
|
static const PRUint32 INIT_FLAG_DECODE_ON_DRAW = 0x2;
|
|
|
|
static const PRUint32 INIT_FLAG_MULTIPART = 0x4;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new image container.
|
|
|
|
*
|
|
|
|
* @param aObserver Observer to send decoder and animation notifications to.
|
|
|
|
* @param aMimeType The mimetype of the image.
|
|
|
|
* @param aFlags Initialization flags of the INIT_FLAG_* variety.
|
|
|
|
*/
|
|
|
|
virtual nsresult Init(imgIDecoderObserver* aObserver,
|
|
|
|
const char* aMimeType,
|
2010-09-12 08:22:26 -07:00
|
|
|
const char* aURIString,
|
2010-08-13 21:09:49 -07:00
|
|
|
PRUint32 aFlags) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The rectangle defining the location and size of the currently displayed
|
2010-08-23 15:44:07 -07:00
|
|
|
* frame.
|
2010-08-13 21:09:49 -07:00
|
|
|
*/
|
2010-08-23 15:44:07 -07:00
|
|
|
virtual void GetCurrentFrameRect(nsIntRect& aRect) = 0;
|
2010-08-13 21:09:49 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The size, in bytes, occupied by the significant data portions of the image.
|
|
|
|
* This includes both compressed source data and decoded frames.
|
|
|
|
*/
|
2010-10-06 08:37:12 -07:00
|
|
|
PRUint32 GetDataSize();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The components that make up GetDataSize().
|
|
|
|
*/
|
|
|
|
virtual PRUint32 GetDecodedDataSize() = 0;
|
|
|
|
virtual PRUint32 GetSourceDataSize() = 0;
|
2010-08-11 17:49:50 -07:00
|
|
|
|
2010-08-22 19:30:45 -07:00
|
|
|
// Mimetype translation
|
|
|
|
enum eDecoderType {
|
|
|
|
eDecoderType_png = 0,
|
|
|
|
eDecoderType_gif = 1,
|
|
|
|
eDecoderType_jpeg = 2,
|
|
|
|
eDecoderType_bmp = 3,
|
|
|
|
eDecoderType_ico = 4,
|
|
|
|
eDecoderType_icon = 5,
|
|
|
|
eDecoderType_unknown = 6
|
|
|
|
};
|
|
|
|
static eDecoderType GetDecoderType(const char *aMimeType);
|
|
|
|
|
2010-09-07 17:33:02 -07:00
|
|
|
void IncrementAnimationConsumers();
|
|
|
|
void DecrementAnimationConsumers();
|
|
|
|
#ifdef DEBUG
|
|
|
|
PRUint32 GetAnimationConsumers() { return mAnimationConsumers; }
|
|
|
|
#endif
|
|
|
|
|
2010-12-20 08:21:59 -08:00
|
|
|
void SetWindowID(PRUint64 aWindowId) {
|
|
|
|
mWindowId = aWindowId;
|
|
|
|
}
|
|
|
|
PRUint64 WindowID() const { return mWindowId; }
|
|
|
|
|
2010-08-13 21:09:48 -07:00
|
|
|
protected:
|
2010-08-23 15:44:07 -07:00
|
|
|
Image(imgStatusTracker* aStatusTracker);
|
2010-08-13 21:09:48 -07:00
|
|
|
|
2010-09-07 17:33:02 -07:00
|
|
|
/**
|
|
|
|
* Decides whether animation should or should not be happening,
|
|
|
|
* and makes sure the right thing is being done.
|
|
|
|
*/
|
|
|
|
virtual void EvaluateAnimation();
|
|
|
|
|
|
|
|
virtual nsresult StartAnimation() = 0;
|
|
|
|
virtual nsresult StopAnimation() = 0;
|
|
|
|
|
2010-12-20 08:21:59 -08:00
|
|
|
PRUint64 mWindowId;
|
|
|
|
|
2010-08-13 21:09:48 -07:00
|
|
|
// Member data shared by all implementations of this abstract class
|
2010-08-23 15:44:07 -07:00
|
|
|
nsAutoPtr<imgStatusTracker> mStatusTracker;
|
2010-09-07 17:33:02 -07:00
|
|
|
PRUint32 mAnimationConsumers;
|
2010-11-17 12:39:23 -08:00
|
|
|
PRUint16 mAnimationMode; // Enum values in imgIContainer
|
|
|
|
PRPackedBool mInitialized:1; // Have we been initalized?
|
|
|
|
PRPackedBool mAnimating:1; // Are we currently animating?
|
|
|
|
PRPackedBool mError:1; // Error handling
|
2010-09-07 17:33:02 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Extended by child classes, if they have additional
|
|
|
|
* conditions for being able to animate
|
|
|
|
*/
|
2010-11-17 12:39:23 -08:00
|
|
|
virtual PRBool ShouldAnimate() {
|
|
|
|
return mAnimationConsumers > 0 && mAnimationMode != kDontAnimMode;
|
|
|
|
}
|
2010-08-13 21:09:48 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace imagelib
|
|
|
|
} // namespace mozilla
|
|
|
|
|
|
|
|
#endif // MOZILLA_IMAGELIB_IMAGE_H_
|