AudioSamples.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 AUDIOSAMPLES_H_
#define AUDIOSAMPLES_H_
 
#include <com/avpkit/ferry/RefPointer.h>
#include <com/avpkit/core/AVPKit.h>
#include <com/avpkit/core/IAudioSamples.h>
#include <com/avpkit/ferry/IBuffer.h>
#include <com/avpkit/core/IRational.h>
 
namespace com { namespace avpkit { namespace core
{
 
  class AudioSamples : public IAudioSamples
  {
    VS_JNIUTILS_REFCOUNTED_OBJECT_PRIVATE_MAKE(AudioSamples)
  public:
    // IMediaData
    virtual int64_t getTimeStamp() { return getPts(); }
    virtual void setTimeStamp(int64_t aTimeStamp) { setPts(aTimeStamp); }
    virtual IRational* getTimeBase() { return mTimeBase.get(); }
    virtual void setTimeBase(IRational *aBase) { mTimeBase.reset(aBase, true); }
    virtual int32_t getSize() { return getNumSamples()*getSampleSize(); }
    virtual bool isKey() { return true; }
 
    // IAudioSamples
    virtual bool isComplete();
    virtual int32_t getSampleRate();
    virtual int32_t getChannels();
    
    virtual IAudioSamples::ChannelLayout getChannelLayout();
 
    virtual Format getFormat();
    virtual int32_t getSampleBitDepth();
 
    virtual int32_t getNumSamples();
    virtual int32_t getMaxBufferSize();
    virtual int32_t getSampleSize();
    virtual int32_t getMaxSamples();
    virtual com::avpkit::ferry::IBuffer* getData();
    virtual int64_t getPts();
    virtual void setPts(int64_t aValue);
    virtual int64_t getNextPts();
    virtual int32_t setSample(int32_t sampleIndex, int32_t channel, Format format, int32_t sample);
    virtual int32_t getSample(int32_t sampleIndex, int32_t channel, Format format);
    virtual void setData(com::avpkit::ferry::IBuffer* buffer);
    virtual void setComplete(bool complete, int32_t numSamples,
        int32_t sampleRate, int32_t channels, Format sampleFmt,
        int64_t pts);
 
    virtual void setComplete(bool complete, int32_t numSamples, 
        int32_t sampleRate, int32_t channels, ChannelLayout channelLayout, 
        Format format, int64_t pts);
 
 
 
    /*
     * 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);
    
    virtual int32_t ensureCapacity(int32_t capacityInBytes);
    
    /*
     * This creates an audio sample.
     */
    static AudioSamples* make(int32_t numSamples,
        int32_t numChannels);
    static AudioSamples* make(int32_t numSamples,
        int32_t numChannels, IAudioSamples::Format);
    
    static AudioSamples* make(com::avpkit::ferry::IBuffer* buffer, int32_t channels,
        IAudioSamples::Format format);
  protected:
    AudioSamples();
    virtual ~AudioSamples();
  private:
    void allocInternalSamples();
    static void setBufferType(IAudioSamples::Format format,
        com::avpkit::ferry::IBuffer * buffer);
    com::avpkit::ferry::RefPointer<com::avpkit::ferry::IBuffer> mSamples;
    com::avpkit::ferry::RefPointer<IRational> mTimeBase;
    int32_t mNumSamples;
    int32_t mRequestedSamples;
    int32_t mSampleRate;
    int32_t mChannels;
    ChannelLayout mChannelLayout;
    int32_t mIsComplete;
    Format mSampleFmt;
    int64_t mPts;
  };
 
}}}
 
#endif /*AUDIOSAMPLES_H_*/