ITASampleBuffer.h

/*
 * ----------------------------------------------------------------
 *
 *		ITA core libs
 *		(c) Copyright Institute of Technical Acoustics (ITA)
 *		RWTH Aachen University, Germany, 2015-2024
 *
 * ----------------------------------------------------------------
 *				    ____  __________  _______
 *				   //  / //__   ___/ //  _   |
 *				  //  /    //  /    //  /_|  |
 *				 //  /    //  /    //  ___   |
 *				//__/    //__/    //__/   |__|
 *
 * ----------------------------------------------------------------
 *
 */

#ifndef INCLUDE_WATCHER_ITA_SAMPLE_BUFFER
#define INCLUDE_WATCHER_ITA_SAMPLE_BUFFER

// ITABase
#include <ITABaseDefinitions.h>

// STL
#include <string>

// Forwards
class ITASampleFrame;

//! Buffer for a field of audio samples of type 32-bit floating point
/**
 *
 */
class ITA_BASE_API ITASampleBuffer
{
public:
	ITASampleBuffer( );

	//! Create sample buffer of certain size
	/**
	 * \param iLength	Length (size) of buffer in samples
	 */
	explicit ITASampleBuffer( int iLength, bool bZeroInit = true );

	//! Copy constructor as pointer
	/**
	 * \param pSource Pointer to source buffer
	 */
	ITASampleBuffer( const ITASampleBuffer* pSource );

	//! Copy constructor as reference
	/**
	 * \param pbSource Reference to source buffer
	 */
	ITASampleBuffer( const ITASampleBuffer& sbSource );

	virtual ~ITASampleBuffer( );

	bool IsEmpty( ) const;

	//! Deprecated
	inline int length( ) { return GetLength( ); };

	//! Length (size) of buffer (number of samples)
	int GetLength( ) const;

	//! Deprecated
	inline const float* data( ) const { return GetData( ); };