image.h

/*
    Large image displaying library.

    Copyright (C) 2004 Maks Orlovich ([email protected])

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
    AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
    AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

*/

#ifndef IMAGE_H
#define IMAGE_H

#include <QByteArray>
#include <QSize>
#include <QTimer>
#include <QPair>
#include <QMap>

#include <khtml_settings.h>

#include "imageformat.h"

class QPainter;

namespace khtmlImLoad
{

class ImageOwner;
class ImageLoader;
class PixmapPlane;

class Image
{
public:
    Image(ImageOwner *owner);

    bool processData(uchar *data, int length);

    void processEOF();

    ~Image();

    QSize size() const;

    bool complete() const;

    bool hasAlpha() const;

    QImage *qimage()  const;

    void setShowAnimations(KHTMLSettings::KAnimationAdvice);
private:
    //Interface to the loader.
    friend class ImageLoader;

    void notifyImageInfo(int width, int height);

    void notifyAppendFrame(int fwidth, int fheight, const ImageFormat &format);

    void notifyScanline(unsigned char version, unsigned char *data);

    void notifyQImage(unsigned char version, const QImage *image);

    void requestScanline(unsigned int lineNum, unsigned char *lineBuf);

    //### FIXME: restore the animprovider interface

private: //Interface to the painter.
    friend class ImagePainter;
    bool mayPaint()
    {
        return original;
    }
    void derefSize(QSize size);
    void refSize(QSize size);
    PixmapPlane *getSize(QSize size);

protected:
    ImageOwner *owner;

    //Update reporting to owner
    friend class Updater;
    friend class AnimProvider;
    bool updatesPending;
    int updatesStartLine;
    int updatesEndLine;

    //Incorporate the scanline into update range
    void requestUpdate(int line);

    //Sets the state as not having updates
    void noUpdates();

    void notifyPerformUpdate();

    void notifyFrameChange();

    //Loader stuff.
    QByteArray bufferPreDetect;
    ImageLoader *loader;
    PixmapPlane *loaderPlane;
    unsigned int loaderScanline;

    bool fullyDecoded;
    bool inError;

    //A little helper to set the error condition.
    void loadError();

    //Image state
    unsigned int width, height;
    PixmapPlane *original;
    QMap<QPair<int, int>, PixmapPlane *> scaled;
    KHTMLSettings::KAnimationAdvice animationAdvice;

};

}

#endif