include/FCam/Image.h

Go to the documentation of this file.

#ifndef FCAM_IMAGE_H
#define FCAM_IMAGE_H

#include "Base.h"
#include <stdio.h>
#include <pthread.h>
#include <string>

namespace FCam {

    class Image {
    public:

        inline Size size() const {
            return _size;
        }

        inline unsigned int width() const {
            return _size.width;
        }

        inline unsigned int height() const {
            return _size.height;
        }

        inline ImageFormat type() const {
            return _type;
        }

        inline unsigned int bytesPerPixel() const {
            return _bytesPerPixel;
        }

        inline unsigned int bytesPerRow() const {
            return _bytesPerRow;
        }

        inline bool valid() const {
            return (data != Image::Discard && data != Image::AutoAllocate);
        }

        inline bool discard() const {
            return data == Image::Discard;
        }

        inline bool autoAllocate() const {
            return data == Image::AutoAllocate;
        }


        static unsigned char *Discard;

        static unsigned char *AutoAllocate;

        ~Image();

        Image(Size, ImageFormat);
        Image(int, int, ImageFormat);

        Image copy() const;



        Image(Size, ImageFormat, unsigned char *, int srcBytesPerRow=-1);
        Image(int, int, ImageFormat, unsigned char *, int srcBytesPerRow=-1);

        Image();

        Image(const Image &other); 

        Image subImage(unsigned int x, unsigned int y, Size) const;

        const Image &operator=(const Image &other);



        inline unsigned char *operator()(unsigned int x, unsigned int y) const {
            return data + bytesPerPixel()*x + bytesPerRow()*y;
        }

        void copyFrom(const Image &);

        bool lock(int timeout = -1);

        void unlock();

        bool operator==(const Image &) const;

        void debug(const char *name="") const;

    private:
        Size _size;
        ImageFormat _type;
        unsigned int _bytesPerPixel;
        unsigned int _bytesPerRow;

        unsigned char *data;
        
        unsigned char *buffer;

        // Reference counting mechanisms
        unsigned int *refCount;
        pthread_mutex_t *mutex; 

        // Is this a weak reference to somebody else's data?
        bool weak() {
            return (buffer == NULL);
        }

        // Does this reference currently have the image locked?
        bool holdingLock;

        void setBuffer(unsigned char *b, unsigned char *d=NULL);

    };

}

#define FCAM_IMAGE_DEBUG(i) (i).debug(#i)

#endif