VVBufferPool.h

#import <Cocoa/Cocoa.h>
#import <OpenGL/CGLMacro.h>
#import <pthread.h>
#import <VVBasics/VVBasics.h>

#import "VVBufferPoolStringAdditions.h"
#import "VVBuffer.h"
#import "VVBufferAggregate.h"
#import "VVBufferGLView.h"
#import "RenderThread.h"
#import "VVSizingTool.h"
#import "GLScene.h"
#import "GLShaderScene.h"
#import "CIGLScene.h"
#import "VVQCComposition.h"
#import "QCGLScene.h"
#import "VVBufferCopier.h"
#import "HapSupport.h"
extern id               _globalVVBufferPool;    //  retained, nil on launch- this is the "main" buffer pool, used to generate image resources for hardware-accelerated image processing.  can't be created automatically, b/c it needs to be based on a shared context.
extern int              _msaaMaxSamples;
extern BOOL         _bufferPoolInitialized;
extern VVStopwatch  *_bufferTimestampMaker;




//#define FOURCC(x) ((unsigned long)((*(x+0)<<24) + (*(x+1)<<16) + (*(x+2)<<8) + (*(x+3))))
//#define FOURCC(x) ((unsigned long)((*(x+0)) + (*(x+1)<<8) + (*(x+2)<<16) + (*(x+3)<<24)))
//#define FOURCC(x) ((x[0]<<24)|(x[1]<<16)|(x[2]<<8)|(x[3]))
#define FOURCC_PACK(a,b,c,d) ((unsigned long)((((uint32_t)d)) | (((uint32_t)c)<<8) | (((uint32_t)b)<<16) | (((uint32_t)a)<<24)))





@interface VVBufferPool : GLScene {
    MutLockArray        *freeBuffers;
    pthread_mutex_t     contextLock;    //  makes sure context doesn't get accessed simultaneously on disparate threads
    VVThreadLoop        *housekeepingThread;
}

+ (int) msaaMaxSamples;
+ (void) setGlobalVVBufferPool:(id)n;


+ (void) createGlobalVVBufferPoolWithSharedContext:(NSOpenGLContext *)n;
+ (id) globalVVBufferPool;

+ (void) timestampThisBuffer:(id)n;

- (void) housekeeping;
- (void) startHousekeepingThread;
- (void) stopHousekeepingThread;

//  returns a RETAINED (retainCount is 1) instance of VVBuffer!  must be explicitly released when done!
- (VVBuffer *) allocBufferForDescriptor:(VVBufferDescriptor *)d sized:(NSSize)s backingPtr:(void *)b backingSize:(NSSize)bs;
//  returns a RETAINED (retainCount is 1) instance of VVBuffer, or nil!
- (VVBuffer *) _findFreeBufferMatchingDescriptor:(VVBufferDescriptor *)d sized:(NSSize)s;

/*      shortcuts for creating resources which are (relatively commonly) used.  all these return RETAINED (retainCount is 1) instances of VVBuffer- they must be released manually by whatever creates them!        */
- (VVBuffer *) allocFBO;
- (VVBuffer *) allocBGRTexSized:(NSSize)s;

- (VVBuffer *) allocBGR2DPOTTexSized:(NSSize)s;

- (VVBuffer *) allocBGRFloatTexSized:(NSSize)s;

- (VVBuffer *) allocBGRFloat2DPOTTexSized:(NSSize)s;

- (VVBuffer *) allocDepthSized:(NSSize)s;

- (VVBuffer *) allocMSAAColorSized:(NSSize)s numOfSamples:(int)n;

- (VVBuffer *) allocMSAADepthSized:(NSSize)s numOfSamples:(int)n;


- (VVBuffer *) allocBufferForNSImage:(NSImage *)img;

- (VVBuffer *) allocBufferForNSImage:(NSImage *)img prefer2DTexture:(BOOL)prefer2D;
- (VVBuffer *) allocBufferForBitmapRep:(NSBitmapImageRep *)rep;

- (VVBuffer *) allocBufferForBitmapRep:(NSBitmapImageRep *)rep prefer2DTexture:(BOOL)prefer2D;

- (VVBuffer *) allocBufferForCVGLTex:(CVOpenGLTextureRef)cvt;

#ifndef __LP64__
- (VVBuffer *) allocTexRangeForHapCVImageBuffer:(CVImageBufferRef)img;
#endif

- (VVBuffer *) allocBufferForTexBackedIOSurfaceSized:(NSSize)s;

- (VVBuffer *) allocBufferForIOSurfaceID:(IOSurfaceID)n;

//  DO NOT CALL THIS METHOD MANUALLY- ONLY FROM VVBUFFER'S DEALLOC METHOD
//  called by instances of VVBuffer if its idleCount is 0 on dealloc
- (void) _returnBufferToPool:(VVBuffer *)b;
//  DO NOT CALL THIS METHOD MANUALLY- ONLY FROM VVBUFFER'S DEALLOC METHOD
//  called by instances of VVBuffer if its idleCount is > 0 on dealloc
- (void) _releaseBufferResource:(VVBuffer *)b;

- (void) _lock;
- (void) _unlock;


@end




unsigned long VVPackFourCC_fromChar(char *charPtr);
void VVUnpackFourCC_toChar(unsigned long fourCC, char *destCharPtr);