Files
libopenshot/src/AudioReaderSource.h
Frank Dana 59138ea3e4 Adopt license management via Reuse project/tool (#711)
* reuse-managed license/copyright headers

reuse is a tool for compliance with the REUSE recommendations. See
<https://reuse.software/> for more information, and
<https://reuse.readthedocs.io/> for the online documentation.

* Set jsoncpp license
* Add MIT license for Decklink sources
* Explicitly license examples/
  - Add headers to source files
  - Change blanket licensing in .reuse/dep5 to only cover binary media
  - Import CC-BY-3.0 license and assign to sintel_trailer
2021-10-16 01:26:26 -04:00

118 lines
4.2 KiB
C++

/**
* @file
* @brief Header file for AudioReaderSource class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#ifndef OPENSHOT_AUDIOREADERSOURCE_H
#define OPENSHOT_AUDIOREADERSOURCE_H
#include <iomanip>
#include "ReaderBase.h"
#include <OpenShotAudio.h>
/// This namespace is the default namespace for all code in the openshot library
namespace openshot
{
/**
* @brief This class is used to expose any ReaderBase derived class as an AudioSource in JUCE.
*
* This allows any reader to play audio through JUCE (our audio framework).
*/
class AudioReaderSource : public juce::PositionableAudioSource
{
private:
int position; /// The position of the audio source (index of buffer)
bool repeat; /// Repeat the audio source when finished
int size; /// The size of the internal buffer
juce::AudioSampleBuffer *buffer; /// The audio sample buffer
int speed; /// The speed and direction to playback a reader (1=normal, 2=fast, 3=faster, -1=rewind, etc...)
ReaderBase *reader; /// The reader to pull samples from
int64_t frame_number; /// The current frame number
std::shared_ptr<Frame> frame; /// The current frame object that is being read
int64_t frame_position; /// The position of the current frame's buffer
double estimated_frame; /// The estimated frame position of the currently playing buffer
int estimated_samples_per_frame; /// The estimated samples per frame of video
/// Get more samples from the reader
void GetMoreSamplesFromReader();
/// Reverse an audio buffer (for backwards audio)
juce::AudioSampleBuffer* reverse_buffer(juce::AudioSampleBuffer* buffer);
public:
/// @brief Constructor that reads samples from a reader
/// @param audio_reader This reader provides constant samples from a ReaderBase derived class
/// @param starting_frame_number This is the frame number to start reading samples from the reader.
/// @param buffer_size The max number of samples to keep in the buffer at one time.
AudioReaderSource(ReaderBase *audio_reader, int64_t starting_frame_number, int buffer_size);
/// Destructor
~AudioReaderSource();
/// @brief Get the next block of audio samples
/// @param info This struct informs us of which samples are needed next.
void getNextAudioBlock (const juce::AudioSourceChannelInfo& info);
/// Prepare to play this audio source
void prepareToPlay(int, double);
/// Release all resources
void releaseResources();
/// @brief Set the next read position of this source
/// @param newPosition The sample # to start reading from
void setNextReadPosition (juce::int64 newPosition);
/// Get the next read position of this source
juce::int64 getNextReadPosition() const;
/// Get the total length (in samples) of this audio source
juce::int64 getTotalLength() const;
/// Determines if this audio source should repeat when it reaches the end
bool isLooping() const;
/// @brief Set if this audio source should repeat when it reaches the end
/// @param shouldLoop Determines if the audio source should repeat when it reaches the end
void setLooping (bool shouldLoop);
/// Update the internal buffer used by this source
void setBuffer (juce::AudioSampleBuffer *audio_buffer);
const ReaderInfo & getReaderInfo() const { return reader->info; }
/// Return the current frame object
std::shared_ptr<Frame> getFrame() const { return frame; }
/// Get the estimate frame that is playing at this moment
int64_t getEstimatedFrame() const { return int64_t(estimated_frame); }
/// Set Speed (The speed and direction to playback a reader (1=normal, 2=fast, 3=faster, -1=rewind, etc...)
void setSpeed(int new_speed) { speed = new_speed; }
/// Get Speed (The speed and direction to playback a reader (1=normal, 2=fast, 3=faster, -1=rewind, etc...)
int getSpeed() const { return speed; }
/// Set Reader
void Reader(ReaderBase *audio_reader) { reader = audio_reader; }
/// Get Reader
ReaderBase* Reader() const { return reader; }
/// Seek to a specific frame
void Seek(int64_t new_position) { frame_number = new_position; estimated_frame = new_position; }
};
}
#endif