root/OpenSceneGraph/trunk/include/osg/Image @ 9913

Revision 9913, 15.4 kB (checked in by robert, 5 years ago)

Added docs on getPixelAspectRatio and corrected usage of getPixelAspection in osgmovie.cpp

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under 
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version.  The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_IMAGE
15#define OSG_IMAGE 1
16
17#include <osg/BufferObject>
18#include <osg/Vec2>
19#include <osg/Vec3>
20#include <osg/Vec4>
21#include <osg/FrameStamp>
22
23#include <string>
24#include <vector>
25
26#ifndef GL_VERSION_1_2
27    // 1.2 definitions...
28    #define GL_BGR                          0x80E0
29    #define GL_BGRA                         0x80E1
30    #define GL_UNSIGNED_BYTE_3_3_2          0x8032
31    #define GL_UNSIGNED_BYTE_2_3_3_REV      0x8362
32    #define GL_UNSIGNED_SHORT_5_6_5         0x8363
33    #define GL_UNSIGNED_SHORT_5_6_5_REV     0x8364
34    #define GL_UNSIGNED_SHORT_4_4_4_4       0x8033
35    #define GL_UNSIGNED_SHORT_4_4_4_4_REV   0x8365
36    #define GL_UNSIGNED_SHORT_5_5_5_1       0x8034
37    #define GL_UNSIGNED_SHORT_1_5_5_5_REV   0x8366
38    #define GL_UNSIGNED_INT_8_8_8_8         0x8035
39    #define GL_UNSIGNED_INT_8_8_8_8_REV     0x8367
40    #define GL_UNSIGNED_INT_10_10_10_2      0x8036
41    #define GL_UNSIGNED_INT_2_10_10_10_REV  0x8368
42#endif
43
44#ifndef GL_COMPRESSED_ALPHA
45    #define GL_COMPRESSED_ALPHA             0x84E9
46    #define GL_COMPRESSED_LUMINANCE         0x84EA
47    #define GL_COMPRESSED_LUMINANCE_ALPHA   0x84EB
48    #define GL_COMPRESSED_INTENSITY         0x84EC
49    #define GL_COMPRESSED_RGB               0x84ED
50    #define GL_COMPRESSED_RGBA              0x84EE
51#endif
52
53
54#ifndef GL_ABGR_EXT
55#define GL_ABGR_EXT                         0x8000
56#endif
57
58namespace osg {
59
60// forward declare
61class NodeVisitor;
62
63/** Image class for encapsulating the storage texture image data. */
64class OSG_EXPORT Image : public Object
65{
66
67    public :
68
69        Image();
70       
71        /** Copy constructor using CopyOp to manage deep vs shallow copy. */
72        Image(const Image& image,const CopyOp& copyop=CopyOp::SHALLOW_COPY);
73
74        virtual Object* cloneType() const { return new Image(); }
75        virtual Object* clone(const CopyOp& copyop) const { return new Image(*this,copyop); }
76        virtual bool isSameKindAs(const Object* obj) const { return dynamic_cast<const Image*>(obj)!=0; }
77        virtual const char* libraryName() const { return "osg"; }
78        virtual const char* className() const { return "Image"; }
79
80        /** Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. */
81        virtual int compare(const Image& rhs) const;
82
83        void setFileName(const std::string& fileName);
84        inline const std::string& getFileName() const { return _fileName; }
85       
86        enum WriteHint {
87            NO_PREFERENCE,
88            STORE_INLINE,
89            EXTERNAL_FILE
90        };
91       
92        void setWriteHint(WriteHint writeHint) { _writeHint = writeHint; }
93        WriteHint getWriteHint() const { return _writeHint; }
94       
95        enum AllocationMode {
96            NO_DELETE,
97            USE_NEW_DELETE,
98            USE_MALLOC_FREE
99        };
100       
101        /** Set the method used for deleting data once it goes out of scope. */
102        void setAllocationMode(AllocationMode mode) { _allocationMode = mode; }
103
104        /** Get the method used for deleting data once it goes out of scope. */
105        AllocationMode getAllocationMode() const { return _allocationMode; }
106
107
108        /** Allocate a pixel block of specified size and type. */
109        void allocateImage(int s,int t,int r,
110                           GLenum pixelFormat,GLenum type,
111                           int packing=1);
112       
113       
114        /** Set the image dimensions, format and data. */
115        void setImage(int s,int t,int r,
116                      GLint internalTextureformat,
117                      GLenum pixelFormat,GLenum type,
118                      unsigned char* data,
119                      AllocationMode mode,
120                      int packing=1);
121           
122        /** Read pixels from current frame buffer at specified position and size, using glReadPixels.
123          * Create memory for storage if required, reuse existing pixel coords if possible.
124        */
125        void readPixels(int x,int y,int width,int height,
126                        GLenum pixelFormat,GLenum type);
127           
128
129        /** Read the contents of the current bound texture, handling compressed pixelFormats if present.
130          * Create memory for storage if required, reuse existing pixel coords if possible.
131        */
132        void readImageFromCurrentTexture(unsigned int contextID, bool copyMipMapsIfAvailable, GLenum type = GL_UNSIGNED_BYTE);
133
134
135        /** Scale image to specified size. */
136        void scaleImage(int s,int t,int r) { scaleImage(s,t,r, getDataType()); }
137
138        /** Scale image to specified size and with specified data type. */
139        void scaleImage(int s,int t,int r, GLenum newDataType);
140
141        /** Copy a source Image into a subpart of this Image at specified position.
142          * Typically used to copy to an already allocated image, such as creating
143          * a 3D image from a stack 2D images.
144          * If this Image is empty then image data is created to
145          * accomodate the source image in its offset position.
146          * If source is NULL then no operation happens, this Image is left unchanged.
147        */
148        void copySubImage(int s_offset, int t_offset, int r_offset, const osg::Image* source);
149
150
151        enum Origin
152        {
153            BOTTOM_LEFT,
154            TOP_LEFT
155        };
156       
157        /** Set the origin of the image.
158          * The default value is BOTTOM_LEFT and is consistent with OpenGL.
159          * TOP_LEFT is used for imagery that follows standard Imagery convention, such as movies,
160          * and hasn't been flipped yet.  For such images one much flip the t axis of the tex coords.
161          * to handle this origin position. */
162        void setOrigin(Origin origin) { _origin = origin; }
163       
164        /** Get the origin of the image.*/
165        Origin getOrigin() const { return _origin; }
166       
167
168        /** Width of image. */
169        inline int s() const { return _s; }
170
171        /** Height of image. */
172        inline int t() const { return _t; }
173       
174        /** Depth of image. */
175        inline int r() const { return _r; }
176       
177        void setInternalTextureFormat(GLint internalFormat);
178        inline GLint getInternalTextureFormat() const { return _internalTextureFormat; }
179       
180        void setPixelFormat(GLenum pixelFormat);
181        inline GLenum getPixelFormat() const { return _pixelFormat; }
182       
183        void setDataType(GLenum dataType);
184        inline GLenum getDataType() const { return _dataType; }       
185       
186        void setPacking(unsigned int packing) { _packing = packing; }
187        inline unsigned int getPacking() const { return _packing; }
188
189        /** Set the pixel aspect ratio, defined as the pixel width divided by the pixel height.*/
190        inline void setPixelAspectRatio(float pixelAspectRatio) { _pixelAspectRatio = pixelAspectRatio; }
191
192        /** Get the pixel aspect ratio.*/
193        inline float getPixelAspectRatio() const { return _pixelAspectRatio; }
194       
195        /** Return the number of bits required for each pixel. */
196        inline unsigned int getPixelSizeInBits() const { return computePixelSizeInBits(_pixelFormat,_dataType); }
197
198        /** Return the number of bytes each row of pixels occupies once it has been packed. */
199        inline unsigned int getRowSizeInBytes() const { return computeRowWidthInBytes(_s,_pixelFormat,_dataType,_packing); }
200
201        /** Return the number of bytes each image (_s*_t) of pixels occupies. */
202        inline unsigned int getImageSizeInBytes() const { return getRowSizeInBytes()*_t; }
203       
204        /** Return the number of bytes the whole row/image/volume of pixels occupies. */
205        inline unsigned int getTotalSizeInBytes() const { return getImageSizeInBytes()*_r; }
206
207        /** Return the number of bytes the whole row/image/volume of pixels occupies, including all mip maps if included. */
208        unsigned int getTotalSizeInBytesIncludingMipmaps() const;
209
210        /** Return true if the Image represent a valid and usable imagery.*/
211        bool valid() const { return _s!=0 && _t!=0 && _r!=0 && _data!=0 && _dataType!=0; }
212
213        /** Raw image data. */
214        inline unsigned char* data() { return _data; }
215       
216        /** Raw const image data. */
217        inline const unsigned char* data() const { return _data; }
218
219
220        inline unsigned char* data(int column, int row=0,int image=0)
221        {
222            if (!_data) return NULL;
223            return _data+(column*getPixelSizeInBits())/8+row*getRowSizeInBytes()+image*getImageSizeInBytes();
224        }
225       
226        inline const unsigned char* data(int column, int row=0,int image=0) const
227        {
228            if (!_data) return NULL;
229            return _data+(column*getPixelSizeInBits())/8+row*getRowSizeInBytes()+image*getImageSizeInBytes();
230        }
231
232        /** Get the color value for specified texcoord.*/
233        Vec4 getColor(unsigned int s,unsigned t=0,unsigned r=0) const;
234
235        /** Get the color value for specified texcoord.*/
236        Vec4 getColor(const Vec2& texcoord) const { return getColor(Vec3(texcoord.x(),texcoord.y(),0.0f)); }
237
238        /** Get the color value for specified texcoord.*/
239        Vec4 getColor(const Vec3& texcoord) const;
240
241
242        /** Flip the image horizontally. */
243        void flipHorizontal();
244       
245        /** Flip the image vertically. */
246        void flipVertical();
247
248
249        /** Ensure image dimensions are a power of two.
250          * Mipmapped textures require the image dimensions to be
251          * power of two and are within the maxiumum texture size for
252          * the host machine.
253        */
254        void ensureValidSizeForTexturing(GLint maxTextureSize);
255     
256        /** Dirty the image, which increments the modified count, to force osg::Texture to reload the image. */
257        inline void dirty() { ++_modifiedCount; if (_bufferObject.valid()) _bufferObject->dirty(); }     
258     
259        /** Set the modified count value. Used by osg::Texture when using texture subloading. */
260        inline void setModifiedCount(unsigned int value) { _modifiedCount=value; }
261
262        /** Get modified count value. Used by osg::Texture when using texture subloading. */
263        inline unsigned int getModifiedCount() const { return _modifiedCount; }
264
265
266        static bool isPackedType(GLenum type);
267        static GLenum computePixelFormat(GLenum pixelFormat);
268        static GLenum computeFormatDataType(GLenum pixelFormat);
269        static unsigned int computeNumComponents(GLenum pixelFormat);
270        static unsigned int computePixelSizeInBits(GLenum pixelFormat,GLenum type);
271        static unsigned int computeRowWidthInBytes(int width,GLenum pixelFormat,GLenum type,int packing);
272        static int computeNearestPowerOfTwo(int s,float bias=0.5f);
273        static int computeNumberOfMipmapLevels(int s,int t = 1, int r = 1);
274               
275        /** Precomputed mipmaps stuff. */
276        typedef std::vector< unsigned int > MipmapDataType;
277
278        inline bool isMipmap() const {return !_mipmapData.empty();};
279
280        unsigned int getNumMipmapLevels() const
281        {
282            return static_cast<unsigned int>(_mipmapData.size())+1;
283        };
284
285        /** Send offsets into data. It is assumed that first mipmap offset (index 0) is 0.*/
286        inline void setMipmapLevels(const MipmapDataType& mipmapDataVector) { _mipmapData = mipmapDataVector; }
287       
288        inline const MipmapDataType& getMipmapLevels() const { return _mipmapData; }
289
290        inline unsigned int getMipmapOffset(unsigned int mipmapLevel) const
291        {
292            if(mipmapLevel == 0)
293                return 0;
294            else if (mipmapLevel < getNumMipmapLevels())
295               return _mipmapData[mipmapLevel-1];
296            return 0;
297        };
298       
299        inline unsigned char* getMipmapData(unsigned int mipmapLevel)
300        {
301           return _data+getMipmapOffset(mipmapLevel);
302        }
303
304        inline const unsigned char* getMipmapData(unsigned int mipmapLevel) const
305        {
306           return _data+getMipmapOffset(mipmapLevel);
307        }
308
309        /*inline const unsigned char* getMipmapData(unsigned int row, unsigned int column, unsigned int mipmapLevel) const
310        {
311           if (!_data) return NULL;
312           return getMipmapData(mipmapLevel) + (column*getPixelSizeInBits())/8+row*getRowSizeInBytes();
313        }*/
314
315        /** Return true if this image is translucent - i.e. it has alpha values that are less 1.0 (when normalized). */
316        virtual bool isImageTranslucent() const;
317
318        /** Set the optional PixelBufferObject used to map the image memory efficiently to graphics memory. */
319        void setPixelBufferObject(PixelBufferObject* buffer) { _bufferObject = buffer; if (_bufferObject.valid()) _bufferObject->setImage(this); }
320
321        /** Get the PixelBufferObject.*/
322        PixelBufferObject* getPixelBufferObject() { return _bufferObject.get(); }
323
324        /** Get the const PixelBufferObject.*/
325        const PixelBufferObject* getPixelBufferObject() const { return _bufferObject.get(); }
326       
327        virtual void update(NodeVisitor* /*nv*/) {}       
328
329        /** method for sending pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window.  Return true if handled. */
330        virtual bool sendPointerEvent(int /*x*/, int /*y*/, int /*buttonMask*/) { return false; }
331
332        /** method for sending key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window.  Return true if handled.*/
333        virtual bool sendKeyEvent(int /*key*/, bool /*keyDown*/) { return false; }
334
335        /** method for passing frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.*/
336        virtual void setFrameLastRendered(const osg::FrameStamp* /*frameStamp*/) {}
337
338    protected :
339
340        virtual ~Image();
341
342        Image& operator = (const Image&) { return *this; }
343
344        std::string _fileName;
345        WriteHint   _writeHint;
346
347
348        Origin _origin;
349
350        int _s, _t, _r;
351        GLint _internalTextureFormat;
352        GLenum _pixelFormat;
353        GLenum _dataType;
354        unsigned int _packing;
355        float _pixelAspectRatio;
356
357        AllocationMode _allocationMode;
358        unsigned char* _data;
359       
360        void deallocateData();
361       
362        void setData(unsigned char* data,AllocationMode allocationMode);
363
364        unsigned int _modifiedCount;
365
366        MipmapDataType _mipmapData;
367       
368        ref_ptr<PixelBufferObject> _bufferObject;
369};
370
371class Geode;
372
373/** Convenience function to be used by image loaders to generate a valid geode
374  * to return for readNode().
375  * Use the image's s and t values to scale the dimensions of the image.
376*/
377extern OSG_EXPORT Geode* createGeodeForImage(Image* image);
378/** Convenience function to be used by image loaders to generate a valid geode
379  * to return for readNode().
380  * Use the specified s and t values to scale the dimensions of the image.
381*/
382extern OSG_EXPORT Geode* createGeodeForImage(Image* image,float s,float t);
383
384}
385
386#endif                                            // __SG_IMAGE_H
Note: See TracBrowser for help on using the browser.