PixelAllocator.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/PixelAllocator.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_PixelAllocator_h
#define __PCL_PixelAllocator_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/SharedPixelData.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
template <class P> class PCL_CLASS GenericImage;
 
// ----------------------------------------------------------------------------
 
template <class P>
class PCL_CLASS PixelAllocator : public SharedPixelData
{
public:
 
   using pixel_traits = P;
 
   using sample = typename pixel_traits::sample;
 
   bool operator ==( const PixelAllocator<P>& x ) const noexcept
   {
      return SharedPixelData::operator ==( x );
   }
 
   sample* AllocatePixels( size_type n ) const
   {
      PCL_PRECONDITION( n != 0 )
      return reinterpret_cast<sample*>( SharedPixelData::Allocate( n*sizeof( sample ) ) );
   }
 
   sample* AllocatePixels( int width, int height ) const
   {
      return AllocatePixels( size_type( width )*size_type( height ) );
   }
 
   sample** AllocateChannelSlots( size_type n ) const
   {
      PCL_PRECONDITION( n != 0 )
      sample** cslots = reinterpret_cast<sample**>( SharedPixelData::Allocate( n*sizeof( sample* ) ) );
      ::memset( cslots, 0, n*sizeof( sample* ) );
      return cslots;
   }
 
   template <typename T>
   void Deallocate( T* p ) const
   {
      PCL_PRECONDITION( p != nullptr )
      SharedPixelData::Deallocate( reinterpret_cast<void*>( p ) );
   }
 
private:
 
   PixelAllocator() = default;
 
   PixelAllocator( void* handle )
      : SharedPixelData( handle, P::BitsPerSample(), P::IsFloatSample(), P::IsComplexSample() )
   {
   }
 
   PixelAllocator( const PixelAllocator<P>& x )
      : SharedPixelData( x )
   {
   }
 
   PixelAllocator( int width, int height, int numberOfChannels, int colorSpace )
      : SharedPixelData( width, height, numberOfChannels, P::BitsPerSample(), P::IsFloatSample(), colorSpace )
   {
   }
 
   PixelAllocator& operator =( const PixelAllocator<P>& x )
   {
      (void)SharedPixelData::operator =( x );
      return *this;
   }
 
   sample** GetSharedData() const
   {
      return reinterpret_cast<sample**>( SharedPixelData::GetSharedData() );
   }
 
   void SetSharedData( sample** ptrToShared )
   {
      SharedPixelData::SetSharedData( reinterpret_cast<void**>( ptrToShared ) );
   }
 
   friend class pcl::GenericImage<P>;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_PixelAllocator_h
 
// ----------------------------------------------------------------------------
// EOF pcl/PixelAllocator.h - Released 2024-06-18T15:48:54Z