IAudioSamples.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 IAUDIOSAMPLES_H_
#define IAUDIOSAMPLES_H_
 
#include <com/avpkit/core/AVPKit.h>
#include <com/avpkit/core/IMediaData.h>
#include <com/avpkit/core/IRational.h>
#include <com/avpkit/ferry/IBuffer.h>
namespace com { namespace avpkit { namespace core
{
 
  class VS_API_AVPKIT IAudioSamples : public IMediaData
  {
  public:
    //IAudioSamples
 
    typedef enum Format {
      FMT_NONE = -1,
      FMT_U8,          
      FMT_S16,         
      FMT_S32,         
      FMT_FLT,         
      FMT_DBL,         
 
      FMT_U8P,         
      FMT_S16P,        
      FMT_S32P,        
      FMT_FLTP,        
      FMT_DBLP,        
    } Format;
 
    virtual bool isComplete()=0;
 
    virtual int32_t getSampleRate()=0;
 
    virtual int32_t getChannels()=0;
    
    virtual int32_t getSampleBitDepth()=0;
 
    virtual Format getFormat()=0;
 
    virtual int32_t getNumSamples()=0;
 
    virtual int32_t getMaxBufferSize()=0;
 
    virtual int32_t getMaxSamples()=0;
 
    virtual int32_t getSampleSize()=0;
 
    virtual int64_t getPts()=0;
    
    virtual void setPts(int64_t aValue)=0;
 
    virtual int64_t getNextPts()=0;
 
    virtual void setComplete(bool complete, int32_t numSamples,
        int32_t sampleRate, int32_t channels, Format format,
        int64_t pts)=0;
 
#ifndef SWIG
    /*
     * Convenience method that from C++ returns the buffer
     * managed by getData() above.
     *
     * @param startingSample The sample to start the array at.
     *   That means that only getNumSamples()-startingSample
     *   samples are available in this AudioSamples collection.
     */
    virtual short *getRawSamples(uint32_t startingSample) = 0;
#endif
    
    virtual int32_t setSample(int32_t sampleIndex, int32_t channel, Format format, int32_t sample)=0;
 
    virtual int32_t getSample(int32_t sampleIndex, int32_t channel, Format format)=0;
 
    static int32_t findSampleBitDepth(Format format);
    
    static IAudioSamples* make(int32_t numSamples,
        int32_t numChannels);
    
 
    static int64_t samplesToDefaultPts(int64_t samples, int sampleRate);
 
    static int64_t defaultPtsToSamples(int64_t duration, int sampleRate);
 
  protected:
    IAudioSamples();
    virtual ~IAudioSamples();
    
    /*
     * Added for 2.1
     */
  public:
    enum class ChannelLayout : uint64_t {
CH_NONE=                   0,        
CH_FRONT_LEFT=             0x00000001,
CH_FRONT_RIGHT=            0x00000002,
CH_FRONT_CENTER=           0x00000004,
CH_LOW_FREQUENCY=          0x00000008,
CH_BACK_LEFT=              0x00000010,
CH_BACK_RIGHT=             0x00000020,
CH_FRONT_LEFT_OF_CENTER=   0x00000040,
CH_FRONT_RIGHT_OF_CENTER=  0x00000080,
CH_BACK_CENTER=            0x00000100,
CH_SIDE_LEFT=              0x00000200,
CH_SIDE_RIGHT=             0x00000400,
CH_TOP_CENTER=             0x00000800,
CH_TOP_FRONT_LEFT=         0x00001000,
CH_TOP_FRONT_CENTER=       0x00002000,
CH_TOP_FRONT_RIGHT=        0x00004000,
CH_TOP_BACK_LEFT=          0x00008000,
CH_TOP_BACK_CENTER=        0x00010000,
CH_TOP_BACK_RIGHT=         0x00020000,
CH_STEREO_LEFT=            0x20000000,  
CH_STEREO_RIGHT=           0x40000000,  
CH_WIDE_LEFT=              0x0000000080000000ULL,
CH_WIDE_RIGHT=             0x0000000100000000ULL,
CH_SURROUND_DIRECT_LEFT=   0x0000000200000000ULL,
CH_SURROUND_DIRECT_RIGHT=  0x0000000400000000ULL,
CH_LOW_FREQUENCY_2=        0x0000000800000000ULL,
 
CH_LAYOUT_NATIVE=          0x8000000000000000ULL,
 
CH_LAYOUT_MONO=              (CH_FRONT_CENTER),
CH_LAYOUT_STEREO=            (CH_FRONT_LEFT|CH_FRONT_RIGHT),
CH_LAYOUT_2POINT1=           (CH_LAYOUT_STEREO|CH_LOW_FREQUENCY),
CH_LAYOUT_2_1=               (CH_LAYOUT_STEREO|CH_BACK_CENTER),
CH_LAYOUT_SURROUND=          (CH_LAYOUT_STEREO|CH_FRONT_CENTER),
CH_LAYOUT_3POINT1=           (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY),
CH_LAYOUT_4POINT0=           (CH_LAYOUT_SURROUND|CH_BACK_CENTER),
CH_LAYOUT_4POINT1=           (CH_LAYOUT_4POINT0|CH_LOW_FREQUENCY),
CH_LAYOUT_2_2=               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT),
CH_LAYOUT_QUAD=              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT),
CH_LAYOUT_5POINT0=           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT),
CH_LAYOUT_5POINT1=           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY),
CH_LAYOUT_5POINT0_BACK=      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT),
CH_LAYOUT_5POINT1_BACK=      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY),
CH_LAYOUT_6POINT0=           (CH_LAYOUT_5POINT0|CH_BACK_CENTER),
CH_LAYOUT_6POINT0_FRONT=     (CH_LAYOUT_2_2|CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER),
CH_LAYOUT_HEXAGONAL=         (CH_LAYOUT_5POINT0_BACK|CH_BACK_CENTER),
CH_LAYOUT_6POINT1=           (CH_LAYOUT_5POINT1|CH_BACK_CENTER),
CH_LAYOUT_6POINT1_BACK=      (CH_LAYOUT_5POINT1_BACK|CH_BACK_CENTER),
CH_LAYOUT_6POINT1_FRONT=     (CH_LAYOUT_6POINT0_FRONT|CH_LOW_FREQUENCY),
CH_LAYOUT_7POINT0=           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT),
CH_LAYOUT_7POINT0_FRONT=     (CH_LAYOUT_5POINT0|CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER),
CH_LAYOUT_7POINT1=           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT),
CH_LAYOUT_7POINT1_WIDE=      (CH_LAYOUT_5POINT1|CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER),
CH_LAYOUT_7POINT1_WIDE_BACK= (CH_LAYOUT_5POINT1_BACK|CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER),
CH_LAYOUT_OCTAGONAL=         (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_CENTER|CH_BACK_RIGHT),
CH_LAYOUT_HEXADECAGONAL=     (CH_LAYOUT_OCTAGONAL|CH_WIDE_LEFT|CH_WIDE_RIGHT|CH_TOP_BACK_LEFT|CH_TOP_BACK_RIGHT|CH_TOP_BACK_CENTER|CH_TOP_FRONT_CENTER|CH_TOP_FRONT_LEFT|CH_TOP_FRONT_RIGHT),
CH_LAYOUT_STEREO_DOWNMIX=    (CH_STEREO_LEFT|CH_STEREO_RIGHT),
 
    } ;
    
    
    virtual ChannelLayout getChannelLayout() = 0;
    
    virtual void setComplete(bool complete, int32_t numSamples,
        int32_t sampleRate, int32_t channels, ChannelLayout channelLayout, Format format,
        int64_t pts)=0;
    
    /*
     * Added for 3.1
     */
    
    static IAudioSamples* make(
        com::avpkit::ferry::IBuffer* buffer, int channels,
        IAudioSamples::Format format);
 
    /*
     * Added for 3.2
     * 
     */
    static IAudioSamples* make(int32_t numSamples,
        int32_t numChannels,
        IAudioSamples::Format format);
    
  };
 
}}}
 
#endif /*IAUDIOSAMPLES_H_*/