forked from mia/Aegisub
1e0f08c0ed
Use boost::filesystem::path for all paths, and std::string for all other strings, converting to/from wxString as close to the actual uses of wx as possible. Where possible, replace the uses of non-UI wxWidgets functionality with the additions to the standard library in C++11, or the equivalents in boost. Move the path token management logic to libaegisub (and rewrite it in the process). Add a basic thread pool based on asio and std::thread to libaegisub. This touches nearly every file in the project and a nontrivial amount of code had to be rewritten entirely, so there's probably a lot of broken stuff.
520 lines
16 KiB
C++
520 lines
16 KiB
C++
// Copyright (c) 2007-2008, Niels Martin Hansen
|
|
// 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/
|
|
|
|
/// @file audio_provider_pcm.cpp
|
|
/// @brief PCM WAV and WAV64 audio provider
|
|
/// @ingroup audio_input
|
|
///
|
|
|
|
#include "config.h"
|
|
|
|
#include "audio_provider_pcm.h"
|
|
|
|
#include "aegisub_endian.h"
|
|
#include "audio_controller.h"
|
|
#include "utils.h"
|
|
|
|
#include <libaegisub/fs.h>
|
|
#include <libaegisub/log.h>
|
|
|
|
#include <cassert>
|
|
#include <cstdint>
|
|
#ifndef _WIN32
|
|
#include <sys/fcntl.h>
|
|
#include <sys/mman.h>
|
|
#include <sys/stat.h>
|
|
#endif
|
|
|
|
PCMAudioProvider::PCMAudioProvider(agi::fs::path const& filename)
|
|
: current_mapping(0)
|
|
, mapping_start(0)
|
|
, mapping_length(0)
|
|
#ifdef _WIN32
|
|
, file_handle(0, CloseHandle)
|
|
, file_mapping(0, CloseHandle)
|
|
{
|
|
file_handle = CreateFile(
|
|
filename.c_str(),
|
|
FILE_READ_DATA,
|
|
FILE_SHARE_READ|FILE_SHARE_WRITE,
|
|
0,
|
|
OPEN_EXISTING,
|
|
FILE_ATTRIBUTE_NORMAL|FILE_FLAG_RANDOM_ACCESS,
|
|
0);
|
|
|
|
if (file_handle == INVALID_HANDLE_VALUE)
|
|
throw agi::fs::FileNotFound(filename);
|
|
|
|
file_mapping = CreateFileMapping(
|
|
file_handle,
|
|
0,
|
|
PAGE_READONLY,
|
|
0, 0,
|
|
0);
|
|
|
|
if (file_mapping == 0)
|
|
throw agi::AudioProviderOpenError("Failed creating file mapping", 0);
|
|
#else
|
|
, file_handle(open(filename.c_str(), O_RDONLY), close)
|
|
{
|
|
if (file_handle == -1)
|
|
throw agi::fs::FileNotFound(filename.string());
|
|
#endif
|
|
float_samples = false;
|
|
|
|
try {
|
|
file_size = agi::fs::Size(filename);
|
|
}
|
|
catch (agi::Exception const& e) {
|
|
throw agi::AudioPlayerOpenError("Could not get file size", e.Copy());
|
|
}
|
|
}
|
|
|
|
PCMAudioProvider::~PCMAudioProvider() {
|
|
#ifdef _WIN32
|
|
if (current_mapping)
|
|
UnmapViewOfFile(current_mapping);
|
|
#else
|
|
if (current_mapping)
|
|
munmap(current_mapping, mapping_length);
|
|
#endif
|
|
}
|
|
|
|
char * PCMAudioProvider::EnsureRangeAccessible(int64_t range_start, int64_t range_length) const {
|
|
if (range_start + range_length > file_size)
|
|
throw AudioDecodeError("Attempted to map beyond end of file");
|
|
|
|
// Check whether the requested range is already visible
|
|
if (!current_mapping || range_start < mapping_start || range_start+range_length > mapping_start+(int64_t)mapping_length) {
|
|
// It's not visible, change the current mapping
|
|
if (current_mapping) {
|
|
#ifdef _WIN32
|
|
UnmapViewOfFile(current_mapping);
|
|
#else
|
|
munmap(current_mapping, mapping_length);
|
|
#endif
|
|
}
|
|
|
|
// Align range start on a 1 MB boundary and go 16 MB back
|
|
mapping_start = (range_start & ~0xFFFFF) - 0x1000000;
|
|
if (mapping_start < 0) mapping_start = 0;
|
|
|
|
if (sizeof(void*) > 4)
|
|
// Large address space, use a 2 GB mapping
|
|
mapping_length = 0x80000000;
|
|
else
|
|
// Small (32 bit) address space, use a 256 MB mapping
|
|
mapping_length = 0x10000000;
|
|
|
|
// Make sure to always make a mapping at least as large as the requested range
|
|
if ((int64_t)mapping_length < range_length) {
|
|
if (range_length > (int64_t)(~(size_t)0))
|
|
throw AudioDecodeError("Requested range larger than max size_t, cannot create view of file");
|
|
mapping_length = range_length;
|
|
}
|
|
// But also make sure we don't try to make a mapping larger than the file
|
|
if (mapping_start + (int64_t)mapping_length > file_size)
|
|
mapping_length = (size_t)(file_size - mapping_start);
|
|
// We already checked that the requested range doesn't extend over the end of the file
|
|
// Hopefully this should ensure that small files are always mapped in their entirety
|
|
|
|
#ifdef _WIN32
|
|
LARGE_INTEGER mapping_start_li;
|
|
mapping_start_li.QuadPart = mapping_start;
|
|
current_mapping = MapViewOfFile(
|
|
file_mapping, // Mapping handle
|
|
FILE_MAP_READ, // Access type
|
|
mapping_start_li.HighPart, // Offset high-part
|
|
mapping_start_li.LowPart, // Offset low-part
|
|
mapping_length); // Length of view
|
|
#else
|
|
current_mapping = mmap(0, mapping_length, PROT_READ, MAP_PRIVATE, file_handle, mapping_start);
|
|
#endif
|
|
|
|
if (!current_mapping)
|
|
throw AudioDecodeError("Failed mapping a view of the file");
|
|
}
|
|
|
|
assert(current_mapping);
|
|
assert(range_start >= mapping_start);
|
|
|
|
// Difference between actual current mapping start and requested range start
|
|
ptrdiff_t rel_ofs = (ptrdiff_t)(range_start - mapping_start);
|
|
|
|
// Calculate a pointer into current mapping for the requested range
|
|
return ((char*)current_mapping) + rel_ofs;
|
|
}
|
|
|
|
void PCMAudioProvider::FillBuffer(void *buf, int64_t start, int64_t count) const {
|
|
// Read blocks from the file
|
|
size_t index = 0;
|
|
while (count > 0 && index < index_points.size()) {
|
|
// Check if this index contains the samples we're looking for
|
|
const IndexPoint &ip = index_points[index];
|
|
if (ip.start_sample <= start && ip.start_sample+ip.num_samples > start) {
|
|
|
|
// How many samples we can maximum take from this block
|
|
int64_t samples_can_do = ip.num_samples - start + ip.start_sample;
|
|
if (samples_can_do > count) samples_can_do = count;
|
|
|
|
// Read as many samples we can
|
|
char *src = EnsureRangeAccessible(
|
|
ip.start_byte + (start - ip.start_sample) * bytes_per_sample * channels,
|
|
samples_can_do * bytes_per_sample * channels);
|
|
memcpy(buf, src, samples_can_do * bytes_per_sample * channels);
|
|
|
|
// Update data
|
|
buf = (char*)buf + samples_can_do * bytes_per_sample * channels;
|
|
start += samples_can_do;
|
|
count -= samples_can_do;
|
|
}
|
|
index++;
|
|
}
|
|
}
|
|
|
|
/// @class RiffWavPCMAudioProvider
|
|
/// @brief RIFF WAV PCM provider
|
|
///
|
|
/// Overview of RIFF WAV: <http://www.sonicspot.com/guide/wavefiles.html>
|
|
class RiffWavPCMAudioProvider : public PCMAudioProvider {
|
|
struct ChunkHeader {
|
|
/// Always "RIFF"
|
|
char type[4];
|
|
/// File size minus sizeof(ChunkHeader) (i.e. 8)
|
|
uint32_t size;
|
|
};
|
|
|
|
struct RIFFChunk {
|
|
ChunkHeader ch;
|
|
/// Always "WAVE"
|
|
char format[4];
|
|
};
|
|
|
|
struct fmtChunk {
|
|
/// compression format used
|
|
/// We support only PCM (0x1)
|
|
uint16_t compression;
|
|
|
|
/// Number of channels
|
|
uint16_t channels;
|
|
|
|
/// Samples per second
|
|
uint32_t samplerate;
|
|
|
|
/// Bytes per second
|
|
/// can't always be trusted
|
|
uint32_t avg_bytes_sec;
|
|
|
|
/// Bytes per sample
|
|
uint16_t block_align;
|
|
|
|
/// Bits per sample that are actually used; rest should be ignored
|
|
uint16_t significant_bits_sample;
|
|
// Here was supposed to be some more fields but we don't need them
|
|
// and just skipping by the size of the struct wouldn't be safe
|
|
// either way, as the fields can depend on the compression.
|
|
};
|
|
|
|
static bool CheckFourcc(const char (&str1)[4], const char (&str2)[5])
|
|
{
|
|
return
|
|
(str1[0] == str2[0]) &&
|
|
(str1[1] == str2[1]) &&
|
|
(str1[2] == str2[2]) &&
|
|
(str1[3] == str2[3]);
|
|
}
|
|
|
|
public:
|
|
|
|
RiffWavPCMAudioProvider(agi::fs::path const& filename)
|
|
: PCMAudioProvider(filename)
|
|
{
|
|
this->filename = filename;
|
|
|
|
// Read header
|
|
void *filestart = EnsureRangeAccessible(0, sizeof(RIFFChunk));
|
|
RIFFChunk &header = *(RIFFChunk*)filestart;
|
|
|
|
// Check magic values
|
|
if (!CheckFourcc(header.ch.type, "RIFF"))
|
|
throw agi::AudioDataNotFoundError("File is not a RIFF file", 0);
|
|
if (!CheckFourcc(header.format, "WAVE"))
|
|
throw agi::AudioDataNotFoundError("File is not a RIFF WAV file", 0);
|
|
|
|
// Count how much more data we can have in the entire file
|
|
// The first 4 bytes are already eaten by the header.format field
|
|
uint32_t data_left = Endian::LittleToMachine(header.ch.size) - 4;
|
|
// How far into the file we have processed.
|
|
// Must be incremented by the riff chunk size fields.
|
|
uint32_t filepos = sizeof(header);
|
|
|
|
bool got_fmt_header = false;
|
|
|
|
// Inherited from AudioProvider
|
|
num_samples = 0;
|
|
|
|
// Continue reading chunks until out of data
|
|
while (data_left) {
|
|
ChunkHeader &ch = *(ChunkHeader*)EnsureRangeAccessible(filepos, sizeof(ChunkHeader));
|
|
|
|
// Update counters
|
|
data_left -= sizeof(ch);
|
|
filepos += sizeof(ch);
|
|
|
|
if (CheckFourcc(ch.type, "fmt ")) {
|
|
if (got_fmt_header) throw agi::AudioProviderOpenError("Invalid file, multiple 'fmt ' chunks", 0);
|
|
got_fmt_header = true;
|
|
|
|
fmtChunk &fmt = *(fmtChunk*)EnsureRangeAccessible(filepos, sizeof(fmtChunk));
|
|
|
|
if (Endian::LittleToMachine(fmt.compression) != 1)
|
|
throw agi::AudioProviderOpenError("Can't use file, not PCM encoding", 0);
|
|
|
|
// Set stuff inherited from the AudioProvider class
|
|
sample_rate = Endian::LittleToMachine(fmt.samplerate);
|
|
channels = Endian::LittleToMachine(fmt.channels);
|
|
bytes_per_sample = (Endian::LittleToMachine(fmt.significant_bits_sample) + 7) / 8; // round up to nearest whole byte
|
|
}
|
|
|
|
else if (CheckFourcc(ch.type, "data")) {
|
|
// This won't pick up 'data' chunks inside 'wavl' chunks
|
|
// since the 'wavl' chunks wrap those.
|
|
|
|
if (!got_fmt_header) throw agi::AudioProviderOpenError("Found 'data' chunk before 'fmt ' chunk, file is invalid.", 0);
|
|
|
|
int64_t samples = Endian::LittleToMachine(ch.size) / bytes_per_sample;
|
|
int64_t frames = samples / channels;
|
|
|
|
IndexPoint ip;
|
|
ip.start_sample = num_samples;
|
|
ip.num_samples = frames;
|
|
ip.start_byte = filepos;
|
|
index_points.push_back(ip);
|
|
|
|
num_samples += frames;
|
|
}
|
|
|
|
// Support wavl (wave list) chunks too?
|
|
|
|
// Update counters
|
|
// Make sure they're word aligned
|
|
data_left -= (Endian::LittleToMachine(ch.size) + 1) & ~1;
|
|
filepos += (Endian::LittleToMachine(ch.size) + 1) & ~1;
|
|
}
|
|
}
|
|
|
|
bool AreSamplesNativeEndian() const {
|
|
// 8 bit samples don't consider endianness
|
|
if (bytes_per_sample < 2) return true;
|
|
// Otherwise test whether we're little endian
|
|
uint32_t testvalue = 0x008800ff;
|
|
return testvalue == Endian::LittleToMachine(testvalue);
|
|
}
|
|
};
|
|
|
|
static const uint8_t w64GuidRIFF[16] = {
|
|
// {66666972-912E-11CF-A5D6-28DB04C10000}
|
|
0x72, 0x69, 0x66, 0x66, 0x2E, 0x91, 0xCF, 0x11, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00
|
|
};
|
|
|
|
static const uint8_t w64GuidWAVE[16] = {
|
|
// {65766177-ACF3-11D3-8CD1-00C04F8EDB8A}
|
|
0x77, 0x61, 0x76, 0x65, 0xF3, 0xAC, 0xD3, 0x11, 0x8C, 0xD1, 0x00, 0xC0, 0x4F, 0x8E, 0xDB, 0x8A
|
|
};
|
|
|
|
static const uint8_t w64Guidfmt[16] = {
|
|
// {20746D66-ACF3-11D3-8CD1-00C04F8EDB8A}
|
|
0x66, 0x6D, 0x74, 0x20, 0xF3, 0xAC, 0xD3, 0x11, 0x8C, 0xD1, 0x00, 0xC0, 0x4F, 0x8E, 0xDB, 0x8A
|
|
};
|
|
|
|
static const uint8_t w64Guiddata[16] = {
|
|
// {61746164-ACF3-11D3-8CD1-00C04F8EDB8A}
|
|
0x64, 0x61, 0x74, 0x61, 0xF3, 0xAC, 0xD3, 0x11, 0x8C, 0xD1, 0x00, 0xC0, 0x4F, 0x8E, 0xDB, 0x8A
|
|
};
|
|
|
|
/// @class Wave64AudioProvider
|
|
/// @brief Sony Wave64 audio provider
|
|
///
|
|
/// http://www.vcs.de/fileadmin/user_upload/MBS/PDF/Whitepaper/Informations_about_Sony_Wave64.pdf
|
|
class Wave64AudioProvider : public PCMAudioProvider {
|
|
// Here's some copy-paste from the FFmpegSource2 code
|
|
|
|
/// http://msdn.microsoft.com/en-us/library/dd757720(VS.85).aspx
|
|
struct WaveFormatEx {
|
|
uint16_t wFormatTag;
|
|
uint16_t nChannels;
|
|
uint32_t nSamplesPerSec;
|
|
uint32_t nAvgBytesPerSec;
|
|
uint16_t nBlockAlign;
|
|
uint16_t wBitsPerSample;
|
|
uint16_t cbSize;
|
|
};
|
|
|
|
struct RiffChunk {
|
|
uint8_t riff_guid[16];
|
|
uint64_t file_size;
|
|
uint8_t format_guid[16];
|
|
};
|
|
|
|
struct FormatChunk {
|
|
uint8_t chunk_guid[16];
|
|
uint64_t chunk_size;
|
|
WaveFormatEx format;
|
|
uint8_t padding[6];
|
|
};
|
|
|
|
struct DataChunk {
|
|
uint8_t chunk_guid[16];
|
|
uint64_t chunk_size;
|
|
};
|
|
|
|
bool CheckGuid(const uint8_t *guid1, const uint8_t *guid2) {
|
|
return memcmp(guid1, guid2, 16) == 0;
|
|
}
|
|
|
|
public:
|
|
|
|
Wave64AudioProvider(agi::fs::path const& filename)
|
|
: PCMAudioProvider(filename)
|
|
{
|
|
this->filename = filename;
|
|
|
|
int64_t smallest_possible_file = sizeof(RiffChunk) + sizeof(FormatChunk) + sizeof(DataChunk);
|
|
|
|
if (file_size < smallest_possible_file)
|
|
throw agi::AudioDataNotFoundError("File is too small to be a Wave64 file", 0);
|
|
|
|
// Read header
|
|
// This should throw an exception if the mapping fails
|
|
void *filestart = EnsureRangeAccessible(0, sizeof(RiffChunk));
|
|
assert(filestart);
|
|
RiffChunk &header = *(RiffChunk*)filestart;
|
|
|
|
// Check magic values
|
|
if (!CheckGuid(header.riff_guid, w64GuidRIFF))
|
|
throw agi::AudioDataNotFoundError("File is not a Wave64 RIFF file", 0);
|
|
if (!CheckGuid(header.format_guid, w64GuidWAVE))
|
|
throw agi::AudioDataNotFoundError("File is not a Wave64 WAVE file", 0);
|
|
|
|
// Count how much more data we can have in the entire file
|
|
uint64_t data_left = Endian::LittleToMachine(header.file_size) - sizeof(RiffChunk);
|
|
// How far into the file we have processed.
|
|
// Must be incremented by the riff chunk size fields.
|
|
uint64_t filepos = sizeof(header);
|
|
|
|
bool got_fmt_header = false;
|
|
|
|
// Inherited from AudioProvider
|
|
num_samples = 0;
|
|
|
|
// Continue reading chunks until out of data
|
|
while (data_left) {
|
|
uint8_t *chunk_guid = (uint8_t*)EnsureRangeAccessible(filepos, 16);
|
|
uint64_t chunk_size = Endian::LittleToMachine(*(uint64_t*)EnsureRangeAccessible(filepos+16, sizeof(uint64_t)));
|
|
|
|
if (CheckGuid(chunk_guid, w64Guidfmt)) {
|
|
if (got_fmt_header)
|
|
throw agi::AudioProviderOpenError("Bad file, found more than one 'fmt' chunk", 0);
|
|
|
|
FormatChunk &fmt = *(FormatChunk*)EnsureRangeAccessible(filepos, sizeof(FormatChunk));
|
|
got_fmt_header = true;
|
|
|
|
if (Endian::LittleToMachine(fmt.format.wFormatTag) == 3)
|
|
throw agi::AudioProviderOpenError("File is IEEE 32 bit float format which isn't supported. Bug the developers if this matters.", 0);
|
|
if (Endian::LittleToMachine(fmt.format.wFormatTag) != 1)
|
|
throw agi::AudioProviderOpenError("Can't use file, not PCM encoding", 0);
|
|
|
|
// Set stuff inherited from the AudioProvider class
|
|
sample_rate = Endian::LittleToMachine(fmt.format.nSamplesPerSec);
|
|
channels = Endian::LittleToMachine(fmt.format.nChannels);
|
|
bytes_per_sample = (Endian::LittleToMachine(fmt.format.wBitsPerSample) + 7) / 8; // round up to nearest whole byte
|
|
}
|
|
else if (CheckGuid(chunk_guid, w64Guiddata)) {
|
|
if (!got_fmt_header)
|
|
throw agi::AudioProviderOpenError("Found 'data' chunk before 'fmt ' chunk, file is invalid.", 0);
|
|
|
|
int64_t samples = chunk_size / bytes_per_sample;
|
|
int64_t frames = samples / channels;
|
|
|
|
IndexPoint ip;
|
|
ip.start_sample = num_samples;
|
|
ip.num_samples = frames;
|
|
ip.start_byte = filepos;
|
|
index_points.push_back(ip);
|
|
|
|
num_samples += frames;
|
|
}
|
|
|
|
// Update counters
|
|
// Make sure they're 64 bit aligned
|
|
data_left -= (chunk_size + 7) & ~7;
|
|
filepos += (chunk_size + 7) & ~7;
|
|
}
|
|
}
|
|
|
|
bool AreSamplesNativeEndian() const {
|
|
// 8 bit samples don't consider endianness
|
|
if (bytes_per_sample < 2) return true;
|
|
// Otherwise test whether we're little endian
|
|
uint32_t testvalue = 0x008800ff;
|
|
return testvalue == Endian::LittleToMachine(testvalue);
|
|
}
|
|
};
|
|
|
|
AudioProvider *CreatePCMAudioProvider(agi::fs::path const& filename) {
|
|
bool wrong_file_type = true;
|
|
std::string msg;
|
|
|
|
try {
|
|
return new RiffWavPCMAudioProvider(filename);
|
|
}
|
|
catch (agi::AudioDataNotFoundError const& err) {
|
|
msg = "RIFF PCM WAV audio provider: " + err.GetMessage();
|
|
}
|
|
catch (agi::AudioProviderOpenError const& err) {
|
|
wrong_file_type = false;
|
|
msg = "RIFF PCM WAV audio provider: " + err.GetMessage();
|
|
}
|
|
|
|
try {
|
|
return new Wave64AudioProvider(filename);
|
|
}
|
|
catch (agi::AudioDataNotFoundError const& err) {
|
|
msg += "\nWave64 audio provider: " + err.GetMessage();
|
|
}
|
|
catch (agi::AudioProviderOpenError const& err) {
|
|
wrong_file_type = false;
|
|
msg += "\nWave64 audio provider: " + err.GetMessage();
|
|
}
|
|
|
|
if (wrong_file_type)
|
|
throw agi::AudioDataNotFoundError(msg, 0);
|
|
else
|
|
throw agi::AudioProviderOpenError(msg, 0);
|
|
}
|