qimage.h

/****************************************************************************
** $Id: qimage.h,v 2.29 1998/07/03 00:09:34 hanord Exp $
**
** Definition of QImage and QImageIO classes
**
** Created : 950207
**
** Copyright (C) 1992-1998 Troll Tech AS.  All rights reserved.
**
** This file is part of Qt Free Edition, version 1.40.
**
** See the file LICENSE included in the distribution for the usage
** and distribution terms, or http://www.troll.no/free-license.html.
**
** IMPORTANT NOTE: You may NOT copy this file or any part of it into
** your own programs or libraries.
**
** Please see http://www.troll.no/pricing.html for information about 
** Qt Professional Edition, which is this same library but with a
** license which allows creation of commercial/proprietary software.
**
*****************************************************************************/

#ifndef QIMAGE_H
#define QIMAGE_H

#ifndef QT_H
#include "qpixmap.h"
#include "qstrlist.h"
#endif // QT_H


class QImage
{
public:
    enum Endian { IgnoreEndian, BigEndian, LittleEndian };

    QImage();
    QImage( int width, int height, int depth, int numColors=0,
            Endian bitOrder=IgnoreEndian );
    QImage( const QSize&, int depth, int numColors=0,
            Endian bitOrder=IgnoreEndian );
    QImage( const char *fileName, const char *format=0 );
    QImage( const char *xpm[] );
    QImage( const QImage & );
   ~QImage();

    QImage     &operator=( const QImage & );
    QImage     &operator=( const QPixmap & );
    void        detach();
    QImage      copy()          const;
    QImage      copy(int x, int y, int w, int h, int conversion_flags=0) const;
    QImage      copy(QRect&)    const;

    bool        isNull()        const   { return data->bits == 0; }

    int         width()         const   { return data->w; }
    int         height()        const   { return data->h; }
    QSize       size()          const   { return QSize(data->w,data->h); }
    QRect       rect()          const   { return QRect(0,0,data->w,data->h); }
    int         depth()         const   { return data->d; }
    int         numColors()     const   { return data->ncols; }
    Endian      bitOrder()      const   { return (Endian) data->bitordr; }

    QRgb        color( int i )  const;
    void        setColor( int i, QRgb c );
    void        setNumColors( int );

    bool        hasAlphaBuffer() const;
    void        setAlphaBuffer( bool );

    bool        allGray() const;
    bool        isGrayscale() const;

    uchar      *bits()          const;
    uchar      *scanLine( int ) const;
    uchar     **jumpTable()     const;
    QRgb       *colorTable()    const;
    int         numBytes()      const;
    int         bytesPerLine()  const;

    bool        create( int width, int height, int depth, int numColors=0,
                        Endian bitOrder=IgnoreEndian );
    bool        create( const QSize&, int depth, int numColors=0,
                        Endian bitOrder=IgnoreEndian );
    void        reset();

    void        fill( uint pixel );

    QImage      convertDepth( int ) const;
    QImage      convertDepthWithPalette( int, QRgb* p, int pc, int cf=0 ) const;
    QImage      convertDepth( int, int conversion_flags ) const;
    QImage      convertBitOrder( Endian ) const;
    QImage      smoothScale(int width, int height) const;

#if defined(HAS_BOOL_TYPE)
    // Needed for binary compatibility - calls createAlphaMask(int)
    QImage      createAlphaMask( bool dither=FALSE ) const;
#else
    // Needed for source compatibility - calls createAlphaMask(FALSE)
    QImage      createAlphaMask() const;
#endif

    QImage      createAlphaMask( int conversion_flags ) const;
    QImage      createHeuristicMask( bool clipTight=TRUE ) const;

    static Endian systemBitOrder();
    static Endian systemByteOrder();

    static const char *imageFormat( const char *fileName );
    static QStrList inputFormats();
    static QStrList outputFormats();

    bool        load( const char *fileName, const char *format=0 );
    bool        loadFromData( const uchar *buf, uint len,
                              const char *format=0 );
    bool        loadFromData( QByteArray data, const char *format=0 );
    bool        save( const char *fileName, const char *format ) const;

    bool        valid( int x, int y ) const;
    int         pixelIndex( int x, int y ) const;
    QRgb        pixel( int x, int y ) const;
    void        setPixel( int x, int y, uint index_or_rgb );

private:
    void        init();
    void        freeBits();

    struct QImageData : public QShared {        // internal image data
        int     w;                              // image width
        int     h;                              // image height
        int     d;                              // image depth
        int     ncols;                          // number of colors
        int     nbytes;                         // number of bytes data
        int     bitordr;                        // bit order (1 bit depth)
        QRgb   *ctbl;                           // color table
        uchar **bits;                           // image data
        bool    alpha;                          // alpha buffer
    } *data;

    friend void bitBlt( QImage* dst, int dx, int dy, const QImage* src,
                int sx, int sy, int sw, int sh, int conversion_flags );
};


// QImage stream functions

QDataStream &operator<<( QDataStream &, const QImage & );
QDataStream &operator>>( QDataStream &, QImage & );


class QIODevice;
typedef void (*image_io_handler)( QImageIO * ); // image IO handler


class QImageIO
{
public:
    QImageIO();
    QImageIO( QIODevice  *ioDevice, const char *format );
    QImageIO( const char *fileName, const char *format );
   ~QImageIO();


    const QImage &image()       const   { return im; }
    int         status()        const   { return iostat; }
    const char *format()        const   { return frmt; }
    QIODevice  *ioDevice()      const   { return iodev; }
    const char *fileName()      const   { return fname; }
    const char *parameters()    const   { return params; }
    const char *description()   const   { return descr; }

    void        setImage( const QImage & );
    void        setStatus( int );
    void        setFormat( const char * );
    void        setIODevice( QIODevice * );
    void        setFileName( const char * );
    void        setParameters( const char * );
    void        setDescription( const char * );

    bool        read();
    bool        write();

    static const char *imageFormat( const char *fileName );
    static const char *imageFormat( QIODevice * );
    static QStrList inputFormats();
    static QStrList outputFormats();

    static void defineIOHandler( const char *format,
                                 const char *header,
                                 const char *flags,
                                 image_io_handler read_image,
                                 image_io_handler write_image );

private:
    QImage      im;                             // image
    int         iostat;                         // IO status
    QString     frmt;                           // image format
    QIODevice  *iodev;                          // IO device
    QString     fname;                          // file name
    char       *params;                         // image parameters
    char       *descr;                          // image description

private:        // Disabled copy constructor and operator=
    QImageIO( const QImageIO & );
    QImageIO &operator=( const QImageIO & );
};


void bitBlt( QImage* dst, int dx, int dy, const QImage* src,
            int sx=0, int sy=0, int sw=-1, int sh=-1, int conversion_flags=0 );


/*****************************************************************************
  QImage member functions
 *****************************************************************************/

inline bool QImage::hasAlphaBuffer() const
{
    return data->alpha;
}

inline uchar *QImage::bits() const
{
    return data->bits ? data->bits[0] : 0;
}

inline uchar **QImage::jumpTable() const
{
    return data->bits;
}

inline QRgb *QImage::colorTable() const
{
    return data->ctbl;
}

inline int QImage::numBytes() const
{
    return data->nbytes;
}

inline int QImage::bytesPerLine() const
{
    return data->h ? data->nbytes/data->h : 0;
}

inline QImage QImage::copy(QRect& r) const
{
    return copy(r.x(), r.y(), r.width(), r.height());
}

#if !(defined(QIMAGE_C) || defined(DEBUG))

inline QRgb QImage::color( int i ) const
{
    return data->ctbl ? data->ctbl[i] : (QRgb)-1;
}

inline void QImage::setColor( int i, QRgb c )
{
    if ( data->ctbl )
        data->ctbl[i] = c;
}

inline uchar *QImage::scanLine( int i ) const
{
    return data->bits ? data->bits[i] : 0;
}

#endif


#endif // QIMAGE_H