Cinder

  • Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List
  • File Members

include/cinder/Buffer.h

Go to the documentation of this file.
00001 /*
00002  Copyright (c) 2010, The Barbarian Group
00003  All rights reserved.
00004 
00005  Redistribution and use in source and binary forms, with or without modification, are permitted provided that
00006  the following conditions are met:
00007 
00008     * Redistributions of source code must retain the above copyright notice, this list of conditions and
00009     the following disclaimer.
00010     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
00011     the following disclaimer in the documentation and/or other materials provided with the distribution.
00012 
00013  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
00014  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00015  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00016  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00017  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00018  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00019  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00020  POSSIBILITY OF SUCH DAMAGE.
00021 */
00022 
00023 #pragma once
00024 
00025 #include "cinder/Cinder.h"
00026 
00027 #define DEFAULT_COMPRESSION_LEVEL 6
00028 
00029 namespace cinder { 
00030 
00031 class Buffer {
00032  private:
00033     struct Obj {
00034         Obj( void * aBuffer, size_t aSize, bool aOwnsData );
00035         ~Obj();
00036     
00037         void    * mData;
00038         size_t  mAllocatedSize;
00039         size_t  mDataSize;
00040         bool    mOwnsData;
00041     };
00042 
00043  public:
00044     Buffer() {}
00045     Buffer( void * aBuffer, size_t aSize );
00046     Buffer( size_t size );
00047     
00048     size_t getAllocatedSize() const { return mObj->mAllocatedSize; }
00049     size_t getDataSize() const { return mObj->mDataSize; }
00050     void setDataSize( size_t aSize ) { mObj->mDataSize = aSize; }
00051     
00052     void * getData() { return mObj->mData; }
00053     const void * getData() const { return mObj->mData; }
00054     
00056     shared_ptr<uint8_t> convertToSharedPtr();
00057     
00058     void resize( size_t newSize );
00059     
00060     void copyFrom( const void * aData, size_t length );
00061     //TODO: copy from region of another buffer
00062     
00063   private:
00064     shared_ptr<Obj>     mObj;
00065 
00066   public:
00068 
00069     typedef shared_ptr<Obj> Buffer::*unspecified_bool_type;
00070     operator unspecified_bool_type() { return ( mObj.get() == 0 ) ? 0 : &Buffer::mObj; }
00071     void reset() { mObj.reset(); }
00073 };
00074 
00075 Buffer compressBuffer( const Buffer &aBuffer, int8_t compressionLevel = DEFAULT_COMPRESSION_LEVEL, bool resizeResult = true );
00076 Buffer decompressBuffer( const Buffer &aBuffer, bool resizeResult = true );
00077 
00078 } //namespace