2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2021-10-06 18:47:07 +08:00
|
|
|
Copyright (c) 2021 Bytedance Inc.
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-10-06 18:47:07 +08:00
|
|
|
https://adxe.org
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <stdint.h>
|
2019-11-30 14:32:18 +08:00
|
|
|
#include <string>
|
2020-08-27 00:49:07 +08:00
|
|
|
#include "platform/CCFileStream.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
namespace cocos2d
|
|
|
|
{
|
2020-05-18 17:30:42 +08:00
|
|
|
enum class AUDIO_SOURCE_FORMAT : uint16_t
|
2020-05-18 14:56:13 +08:00
|
|
|
{
|
2021-12-25 10:04:45 +08:00
|
|
|
PCM_UNK, // Unknown
|
2020-05-18 14:56:13 +08:00
|
|
|
PCM_U8,
|
|
|
|
PCM_16,
|
|
|
|
PCM_24,
|
|
|
|
PCM_32,
|
|
|
|
PCM_64,
|
|
|
|
PCM_FLT32,
|
|
|
|
PCM_FLT64,
|
2020-05-18 17:30:42 +08:00
|
|
|
MULAW,
|
2021-12-25 10:04:45 +08:00
|
|
|
ALAW,
|
|
|
|
ADPCM, // Microsoft ADPCM
|
|
|
|
IMA_ADPCM, // IMA ADPCM
|
2020-05-18 14:56:13 +08:00
|
|
|
};
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief The class for decoding compressed audio file to PCM buffer.
|
|
|
|
*/
|
|
|
|
class AudioDecoder
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
static const uint32_t INVALID_FRAME_INDEX = UINT32_MAX;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Opens an audio file specified by a file path.
|
|
|
|
* @return true if succeed, otherwise false.
|
|
|
|
*/
|
2019-11-30 14:21:36 +08:00
|
|
|
virtual bool open(const std::string& path) = 0;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Checks whether decoder has opened file successfully.
|
|
|
|
* @return true if succeed, otherwise false.
|
|
|
|
*/
|
|
|
|
virtual bool isOpened() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Closes opened audio file.
|
|
|
|
* @note The method will also be automatically invoked in the destructor.
|
|
|
|
*/
|
|
|
|
virtual void close() = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Reads audio frames of PCM format.
|
|
|
|
* @param framesToRead The number of frames excepted to be read.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @param pcmBuf The buffer to hold the frames to be read, its size should be >= |framesToRead| / samplesPerBlock *
|
|
|
|
* _bytesPerBlock.
|
|
|
|
* @return The number of frames actually read, it's probably less than 'framesToRead'. Returns 0 means reach the end
|
|
|
|
* of file.
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
virtual uint32_t read(uint32_t framesToRead, char* pcmBuf) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Reads fixed audio frames of PCM format.
|
|
|
|
* @param framesToRead The number of frames excepted to be read.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @param pcmBuf The buffer to hold the frames to be read, its size should be >= |framesToRead| / samplesPerBlock *
|
|
|
|
* _bytesPerBlock.
|
|
|
|
* @return The number of frames actually read, it's probably less than |framesToRead|. Returns 0 means reach the end
|
|
|
|
* of file.
|
|
|
|
* @note The different between |read| and |readFixedFrames| is |readFixedFrames| will do multiple reading operations
|
|
|
|
* if |framesToRead| frames isn't filled entirely, while |read| just does reading operation once whatever
|
|
|
|
* |framesToRead| is or isn't filled entirely. If current position reaches the end of frames, the return value may
|
|
|
|
* smaller than |framesToRead| and the remaining buffer in |pcmBuf| will be set with silence data (0x00).
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
virtual uint32_t readFixedFrames(uint32_t framesToRead, char* pcmBuf);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Sets frame offest to be read.
|
|
|
|
* @param frameOffset The frame offest to be set.
|
|
|
|
* @return true if succeed, otherwise false
|
|
|
|
*/
|
|
|
|
virtual bool seek(uint32_t frameOffset) = 0;
|
|
|
|
|
|
|
|
/** Gets total frames of current audio.*/
|
|
|
|
virtual uint32_t getTotalFrames() const;
|
|
|
|
|
2020-06-04 12:26:25 +08:00
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* @brief The helper function for convert frames to bytes
|
|
|
|
*/
|
2020-06-03 23:09:45 +08:00
|
|
|
virtual uint32_t framesToBytes(uint32_t frames) const;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2020-06-04 12:26:25 +08:00
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* @brief The helper function for convert bytes to frames
|
|
|
|
*/
|
2020-06-04 12:26:25 +08:00
|
|
|
virtual uint32_t bytesToFrames(uint32_t bytes) const;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Gets sample rate of current audio.*/
|
|
|
|
virtual uint32_t getSampleRate() const;
|
|
|
|
|
|
|
|
/** Gets the channel count of current audio.
|
|
|
|
* @note Currently we only support 1 or 2 channels.
|
|
|
|
*/
|
|
|
|
virtual uint32_t getChannelCount() const;
|
|
|
|
|
2020-06-04 12:26:25 +08:00
|
|
|
/*
|
2021-12-25 10:04:45 +08:00
|
|
|
* @brief Gets samples per block, usually is 1 for .mp3 or .ogg, .wav may > 1
|
|
|
|
*/
|
2020-06-04 12:26:25 +08:00
|
|
|
uint32_t getSamplesPerBlock() const;
|
|
|
|
|
2020-05-18 17:30:42 +08:00
|
|
|
virtual AUDIO_SOURCE_FORMAT getSourceFormat() const;
|
2020-05-18 14:56:13 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
|
|
|
AudioDecoder();
|
|
|
|
virtual ~AudioDecoder();
|
|
|
|
|
|
|
|
bool _isOpened;
|
|
|
|
uint32_t _totalFrames;
|
2021-12-25 10:04:45 +08:00
|
|
|
uint32_t _bytesPerBlock; // Same as bytesPerFrame when _samplesPerBlock is 1
|
2020-06-04 12:26:25 +08:00
|
|
|
uint32_t _samplesPerBlock;
|
2019-11-23 20:27:39 +08:00
|
|
|
uint32_t _sampleRate;
|
|
|
|
uint32_t _channelCount;
|
2020-05-18 17:30:42 +08:00
|
|
|
AUDIO_SOURCE_FORMAT _sourceFormat;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
friend class AudioDecoderManager;
|
|
|
|
};
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
} // namespace cocos2d
|