IBuffer.h

/*******************************************************************************
 * Copyright (c) 2024, 2026, Olivier Ayache.  All rights reserved.
 *
 * This file is part of AVPKit.
 *
 * AVPKit is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AVPKit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with AVPKit.  If not, see <http://www.gnu.org/licenses/>.
 *******************************************************************************/
 
#ifndef IBUFFER_H_
#define IBUFFER_H_
 
#include <com/avpkit/ferry/Ferry.h>
#include <com/avpkit/ferry/RefCounted.h>
 
namespace com
{
namespace avpkit
{
namespace ferry
{
 
class VS_API_FERRY IBuffer : public com::avpkit::ferry::RefCounted
{
public:
#ifndef SWIG
  typedef void
  (*FreeFunc)(void * mem, void *closure);
 
  virtual void*
  getBytes(int32_t offset, int32_t length)=0;
 
  static IBuffer*
  make(RefCounted* requestor, void * bufToWrap, int32_t bufferSize,
      FreeFunc freeFunc, void * closure);
 
#endif // ! SWIG
  virtual int32_t
  getBufferSize()=0;
 
  static IBuffer*
  make(com::avpkit::ferry::RefCounted* requestor, int32_t bufferSize);
 
  /*
   * Added for 3.1
   */
  typedef enum {
    IBUFFER_UINT8,
    IBUFFER_SINT8,
    IBUFFER_UINT16,
    IBUFFER_SINT16,
    IBUFFER_UINT32,
    IBUFFER_SINT32,
    IBUFFER_UINT64,
    IBUFFER_SINT64,
    IBUFFER_FLT32,
    IBUFFER_DBL64,
    IBUFFER_NB,
  } Type;
  
  virtual Type getType()=0;
  
  virtual void setType(Type type)=0;
  
  static int32_t getTypeSize(Type type);
  
  virtual int32_t getSize()=0;
  
  static IBuffer*
  make(com::avpkit::ferry::RefCounted* requestor,
      Type type, int32_t numElements, bool zero);
 
 
protected:
  IBuffer();
  virtual
  ~IBuffer();
};
 
}
}
}
 
#endif /*IBUFFER_H_*/