mirror of https://github.com/odrling/Aegisub
106 lines
3.4 KiB
C++
106 lines
3.4 KiB
C++
// Copyright (c) 2006, Rodrigo Braz Monteiro
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
// and/or other materials provided with the distribution.
|
|
// * Neither the name of the Aegisub Group nor the names of its contributors
|
|
// may be used to endorse or promote products derived from this software
|
|
// without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// Aegisub Project http://www.aegisub.org/
|
|
//
|
|
// $Id$
|
|
|
|
/// @file audio_provider.h
|
|
/// @brief Declaration of base-class for audio providers
|
|
/// @ingroup main_headers audio_input
|
|
///
|
|
|
|
#pragma once
|
|
|
|
#ifndef AGI_PRE
|
|
#include <wx/string.h>
|
|
#endif
|
|
|
|
#include <libaegisub/exception.h>
|
|
#include "factory_manager.h"
|
|
|
|
/// @class AudioProvider
|
|
/// @brief DOCME
|
|
///
|
|
/// DOCME
|
|
class AudioProvider {
|
|
protected:
|
|
/// DOCME
|
|
int channels;
|
|
|
|
/// for one channel, ie. number of PCM frames
|
|
int64_t num_samples;
|
|
|
|
/// DOCME
|
|
int sample_rate;
|
|
|
|
/// DOCME
|
|
int bytes_per_sample;
|
|
|
|
bool float_samples;
|
|
|
|
|
|
/// DOCME
|
|
wxString filename;
|
|
|
|
public:
|
|
virtual ~AudioProvider() { }
|
|
|
|
virtual wxString GetFilename() const { return filename; };
|
|
virtual void GetAudio(void *buf, int64_t start, int64_t count) const = 0;
|
|
void GetAudioWithVolume(void *buf, int64_t start, int64_t count, double volume) const;
|
|
|
|
int64_t GetNumSamples() const { return num_samples; }
|
|
int GetSampleRate() const { return sample_rate; }
|
|
int GetBytesPerSample() const { return bytes_per_sample; }
|
|
int GetChannels() const { return channels; }
|
|
bool AreSamplesFloat() const { return float_samples; }
|
|
virtual bool AreSamplesNativeEndian() const = 0;
|
|
|
|
/// @brief Does this provider benefit from external caching?
|
|
virtual bool NeedsCache() const { return false; }
|
|
};
|
|
|
|
/// DOCME
|
|
/// @class AudioProviderFactory
|
|
/// @brief DOCME
|
|
///
|
|
/// DOCME
|
|
class AudioProviderFactory : public Factory1<AudioProvider, wxString> {
|
|
public:
|
|
static void RegisterProviders();
|
|
|
|
/// Get a provider for the file
|
|
/// @param filename URI to open
|
|
/// @param cache Caching mode
|
|
static AudioProvider *GetProvider(wxString const& filename, int cache=-1);
|
|
};
|
|
|
|
DEFINE_BASE_EXCEPTION_NOINNER(AudioProviderError, agi::Exception)
|
|
/// Error of some sort occurred while decoding a frame
|
|
DEFINE_SIMPLE_EXCEPTION_NOINNER(AudioDecodeError, AudioProviderError, "audio/error")
|