cog/Frameworks/OpenMPT.old/OpenMPT/soundlib/SampleFormatMP3.cpp

720 lines
18 KiB
C++

/*
* SampleFormatMP3.cpp
* -------------------
* Purpose: MP3 sample import.
* Notes :
* Authors: OpenMPT Devs
* The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
*/
#include "stdafx.h"
#include "Sndfile.h"
#ifndef MODPLUG_NO_FILESAVE
#include "../common/mptFileIO.h"
#endif
#include "../common/misc_util.h"
#include "Tagging.h"
#include "Loaders.h"
#include "ChunkReader.h"
#include "modsmp_ctrl.h"
#include "../soundbase/SampleFormatConverters.h"
#include "../soundbase/SampleFormatCopy.h"
#include "../soundlib/ModSampleCopy.h"
#include "../common/ComponentManager.h"
#ifdef MPT_ENABLE_MP3_SAMPLES
#include "MPEGFrame.h"
#endif // MPT_ENABLE_MP3_SAMPLES
#if defined(MPT_WITH_MINIMP3)
#include <minimp3/minimp3.h>
#endif // MPT_WITH_MINIMP3
// mpg123 must be last because of mpg123 large file support insanity
#if defined(MPT_WITH_MPG123)
#include <stddef.h>
#include <stdlib.h>
#include <sys/types.h>
#include <mpg123.h>
#endif
OPENMPT_NAMESPACE_BEGIN
///////////////////////////////////////////////////////////////////////////////////////////////////
// MP3 Samples
#if defined(MPT_WITH_MPG123)
typedef off_t mpg123_off_t;
typedef size_t mpg123_size_t;
// Check for exactly _MSC_VER as libmpg123 does, in order to also catch clang-cl.
#ifdef _MSC_VER
// ssize_t definition in libmpg123.h.in should never have existed at all.
// It got removed from libmpg23.h.in after 1.28.0 and before 1.28.1.
typedef ptrdiff_t mpg123_ssize_t;
#else
typedef ssize_t mpg123_ssize_t;
#endif
class ComponentMPG123
: public ComponentBuiltin
{
MPT_DECLARE_COMPONENT_MEMBERS
public:
static mpg123_ssize_t FileReaderRead(void *fp, void *buf, mpg123_size_t count)
{
FileReader &file = *static_cast<FileReader *>(fp);
size_t readBytes = std::min(count, static_cast<size_t>(file.BytesLeft()));
file.ReadRaw(static_cast<char *>(buf), readBytes);
return readBytes;
}
static mpg123_off_t FileReaderLSeek(void *fp, mpg123_off_t offset, int whence)
{
FileReader &file = *static_cast<FileReader *>(fp);
FileReader::off_t oldpos = file.GetPosition();
if(whence == SEEK_CUR) file.Seek(file.GetPosition() + offset);
else if(whence == SEEK_END) file.Seek(file.GetLength() + offset);
else file.Seek(offset);
MPT_MAYBE_CONSTANT_IF(!Util::TypeCanHoldValue<mpg123_off_t>(file.GetPosition()))
{
file.Seek(oldpos);
return static_cast<mpg123_off_t>(-1);
}
return static_cast<mpg123_off_t>(file.GetPosition());
}
public:
ComponentMPG123()
: ComponentBuiltin()
{
return;
}
bool DoInitialize() override
{
if(mpg123_init() != 0)
{
return false;
}
return true;
}
virtual ~ComponentMPG123()
{
if(IsAvailable())
{
mpg123_exit();
}
}
};
MPT_REGISTERED_COMPONENT(ComponentMPG123, "")
static mpt::ustring ReadMPG123String(const mpg123_string &str)
{
mpt::ustring result;
if(!str.p)
{
return result;
}
if(str.fill < 1)
{
return result;
}
result = mpt::ToUnicode(mpt::Charset::UTF8, std::string(str.p, str.p + str.fill - 1));
return result;
}
static mpt::ustring ReadMPG123String(const mpg123_string *str)
{
mpt::ustring result;
if(!str)
{
return result;
}
result = ReadMPG123String(*str);
return result;
}
template <std::size_t N>
static mpt::ustring ReadMPG123String(const char (&str)[N])
{
return mpt::ToUnicode(mpt::Charset::ISO8859_1, mpt::String::ReadBuf(mpt::String::spacePadded, str));
}
#endif // MPT_WITH_MPG123
bool CSoundFile::ReadMP3Sample(SAMPLEINDEX sample, FileReader &file, bool raw, bool mo3Decode)
{
#if defined(MPT_WITH_MPG123) || defined(MPT_WITH_MINIMP3)
// Check file for validity, or else mpg123 will happily munch many files that start looking vaguely resemble an MPEG stream mid-file.
file.Rewind();
while(file.CanRead(4))
{
uint8 magic[3];
file.ReadArray(magic);
if(!memcmp(magic, "ID3", 3))
{
// Skip ID3 tags
uint8 header[7];
file.ReadArray(header);
uint32 size = 0;
for(int i = 3; i < 7; i++)
{
if(header[i] & 0x80)
return false;
size = (size << 7) | header[i];
}
file.Skip(size);
} else if(!memcmp(magic, "APE", 3) && file.ReadMagic("TAGEX"))
{
// Skip APE tags
uint32 size = file.ReadUint32LE();
file.Skip(16 + size);
} else if(!memcmp(magic, "\x00\x00\x00", 3) || !memcmp(magic, "\xFF\x00\x00", 3))
{
// Some MP3 files are padded with zeroes...
} else if(magic[0] == 0)
{
// This might be some padding, followed by an MPEG header, so try again.
file.SkipBack(2);
} else if(MPEGFrame::IsMPEGHeader(magic))
{
// This is what we want!
break;
} else
{
// This, on the other hand, isn't.
return false;
}
}
#endif // MPT_WITH_MPG123 || MPT_WITH_MINIMP3
#if defined(MPT_WITH_MPG123)
ComponentHandle<ComponentMPG123> mpg123;
if(!IsComponentAvailable(mpg123))
{
return false;
}
struct MPG123Handle
{
mpg123_handle *mh;
MPG123Handle() : mh(mpg123_new(0, nullptr)) { }
~MPG123Handle() { mpg123_delete(mh); }
operator mpg123_handle *() { return mh; }
};
bool hasLameXingVbriHeader = false;
if(!raw)
{
mpg123_off_t length_raw = 0;
mpg123_off_t length_hdr = 0;
// libmpg123 provides no way to determine whether it parsed ID3V2 or VBR tags.
// Thus, we use a pre-scan with those disabled and compare the resulting length.
// We ignore ID3V2 stream length here, althrough we parse the ID3V2 header.
// libmpg123 only accounts for the VBR info frame if gapless &&!ignore_infoframe,
// thus we switch both of those for comparison.
{
MPG123Handle mh;
if(!mh)
{
return false;
}
file.Rewind();
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_QUIET, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_AUTO_RESAMPLE, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_REMOVE_FLAGS, MPG123_GAPLESS, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_IGNORE_INFOFRAME, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_REMOVE_FLAGS, MPG123_SKIP_ID3V2, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_IGNORE_STREAMLENGTH, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_INDEX_SIZE, -1000, 0.0)) // auto-grow
{
return false;
}
if(mpg123_replace_reader_handle(mh, ComponentMPG123::FileReaderRead, ComponentMPG123::FileReaderLSeek, 0))
{
return false;
}
if(mpg123_open_handle(mh, &file))
{
return false;
}
if(mpg123_scan(mh))
{
return false;
}
long rate = 0;
int channels = 0;
int encoding = 0;
if(mpg123_getformat(mh, &rate, &channels, &encoding))
{
return false;
}
if((channels != 1 && channels != 2) || (encoding & (MPG123_ENC_16 | MPG123_ENC_SIGNED)) != (MPG123_ENC_16 | MPG123_ENC_SIGNED))
{
return false;
}
mpg123_frameinfo frameinfo;
MemsetZero(frameinfo);
if(mpg123_info(mh, &frameinfo))
{
return false;
}
if(frameinfo.layer < 1 || frameinfo.layer > 3)
{
return false;
}
if(mpg123_param(mh, MPG123_FORCE_RATE, rate, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, (channels > 1) ? MPG123_FORCE_STEREO : MPG123_FORCE_MONO, 0.0))
{
return false;
}
length_raw = mpg123_length(mh);
}
{
MPG123Handle mh;
if(!mh)
{
return false;
}
file.Rewind();
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_QUIET, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_AUTO_RESAMPLE, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_GAPLESS, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_REMOVE_FLAGS, MPG123_IGNORE_INFOFRAME, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_REMOVE_FLAGS, MPG123_SKIP_ID3V2, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_IGNORE_STREAMLENGTH, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_INDEX_SIZE, -1000, 0.0)) // auto-grow
{
return false;
}
if(mpg123_replace_reader_handle(mh, ComponentMPG123::FileReaderRead, ComponentMPG123::FileReaderLSeek, 0))
{
return false;
}
if(mpg123_open_handle(mh, &file))
{
return false;
}
if(mpg123_scan(mh))
{
return false;
}
long rate = 0;
int channels = 0;
int encoding = 0;
if(mpg123_getformat(mh, &rate, &channels, &encoding))
{
return false;
}
if((channels != 1 && channels != 2) || (encoding & (MPG123_ENC_16 | MPG123_ENC_SIGNED)) != (MPG123_ENC_16 | MPG123_ENC_SIGNED))
{
return false;
}
mpg123_frameinfo frameinfo;
MemsetZero(frameinfo);
if(mpg123_info(mh, &frameinfo))
{
return false;
}
if(frameinfo.layer < 1 || frameinfo.layer > 3)
{
return false;
}
if(mpg123_param(mh, MPG123_FORCE_RATE, rate, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, (channels > 1) ? MPG123_FORCE_STEREO : MPG123_FORCE_MONO, 0.0))
{
return false;
}
length_hdr = mpg123_length(mh);
}
hasLameXingVbriHeader = (length_raw != length_hdr);
}
// Set up decoder...
MPG123Handle mh;
if(!mh)
{
return false;
}
file.Rewind();
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_QUIET, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, MPG123_AUTO_RESAMPLE, 0.0))
{
return false;
}
if(mpg123_param(mh, raw ? MPG123_REMOVE_FLAGS : MPG123_ADD_FLAGS, MPG123_GAPLESS, 0.0))
{
return false;
}
if(mpg123_param(mh, raw ? MPG123_ADD_FLAGS : MPG123_REMOVE_FLAGS, MPG123_IGNORE_INFOFRAME, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_REMOVE_FLAGS, MPG123_SKIP_ID3V2, 0.0))
{
return false;
}
if(mpg123_param(mh, raw ? MPG123_ADD_FLAGS : MPG123_REMOVE_FLAGS, MPG123_IGNORE_STREAMLENGTH, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_INDEX_SIZE, -1000, 0.0)) // auto-grow
{
return false;
}
if(mpg123_replace_reader_handle(mh, ComponentMPG123::FileReaderRead, ComponentMPG123::FileReaderLSeek, 0))
{
return false;
}
if(mpg123_open_handle(mh, &file))
{
return false;
}
if(mpg123_scan(mh))
{
return false;
}
long rate = 0;
int channels = 0;
int encoding = 0;
if(mpg123_getformat(mh, &rate, &channels, &encoding))
{
return false;
}
if((channels != 1 && channels != 2) || (encoding & (MPG123_ENC_16 | MPG123_ENC_SIGNED)) != (MPG123_ENC_16 | MPG123_ENC_SIGNED))
{
return false;
}
mpg123_frameinfo frameinfo;
MemsetZero(frameinfo);
if(mpg123_info(mh, &frameinfo))
{
return false;
}
if(frameinfo.layer < 1 || frameinfo.layer > 3)
{
return false;
}
// We force samplerate, channels and sampleformat, which in
// combination with auto-resample (set above) will cause libmpg123
// to stay with the given format even for completely confused
// MPG123_FRANKENSTEIN streams.
// Note that we cannot rely on mpg123_length() for the way we
// decode the mpeg streams because it depends on the actual frame
// sample rate instead of the returned sample rate.
if(mpg123_param(mh, MPG123_FORCE_RATE, rate, 0.0))
{
return false;
}
if(mpg123_param(mh, MPG123_ADD_FLAGS, (channels > 1) ? MPG123_FORCE_STEREO : MPG123_FORCE_MONO, 0.0))
{
return false;
}
std::vector<int16> data;
// decoder delay
std::size_t data_skip_frames = 0;
if(!raw && !hasLameXingVbriHeader)
{
if(frameinfo.layer == 1)
{
data_skip_frames = 240 + 1;
} else if(frameinfo.layer == 2)
{
data_skip_frames = 240 + 1;
} else if(frameinfo.layer == 3)
{
data_skip_frames = 528 + 1;
}
}
std::vector<std::byte> buf_bytes;
std::vector<int16> buf_samples;
bool decode_error = false;
bool decode_done = false;
while(!decode_error && !decode_done)
{
buf_bytes.resize(mpg123_outblock(mh));
buf_samples.resize(buf_bytes.size() / sizeof(int16));
mpg123_size_t buf_bytes_decoded = 0;
int mpg123_read_result = mpg123_read(mh, mpt::byte_cast<unsigned char*>(buf_bytes.data()), buf_bytes.size(), &buf_bytes_decoded);
std::memcpy(buf_samples.data(), buf_bytes.data(), buf_bytes_decoded);
data.insert(data.end(), buf_samples.data(), buf_samples.data() + buf_bytes_decoded / sizeof(int16));
if((data.size() / channels) > MAX_SAMPLE_LENGTH)
{
break;
}
if(mpg123_read_result == MPG123_OK)
{
// continue
} else if(mpg123_read_result == MPG123_NEW_FORMAT)
{
// continue
} else if(mpg123_read_result == MPG123_DONE)
{
decode_done = true;
} else
{
decode_error = true;
}
}
if((data.size() / channels) > MAX_SAMPLE_LENGTH)
{
return false;
}
FileTags tags;
mpg123_id3v1 *id3v1 = nullptr;
mpg123_id3v2 *id3v2 = nullptr;
if(mpg123_id3(mh, &id3v1, &id3v2) == MPG123_OK)
{
if(id3v2)
{
if(tags.title.empty()) tags.title = ReadMPG123String(id3v2->title);
if(tags.artist.empty()) tags.artist = ReadMPG123String(id3v2->artist);
if(tags.album.empty()) tags.album = ReadMPG123String(id3v2->album);
if(tags.year.empty()) tags.year = ReadMPG123String(id3v2->year);
if(tags.genre.empty()) tags.genre = ReadMPG123String(id3v2->genre);
if(tags.comments.empty()) tags.comments = ReadMPG123String(id3v2->comment);
}
if(id3v1)
{
if(tags.title.empty()) tags.title = ReadMPG123String(id3v1->title);
if(tags.artist.empty()) tags.artist = ReadMPG123String(id3v1->artist);
if(tags.album.empty()) tags.album = ReadMPG123String(id3v1->album);
if(tags.year.empty()) tags.year = ReadMPG123String(id3v1->year);
if(tags.comments.empty()) tags.comments = ReadMPG123String(id3v1->comment);
}
}
mpt::ustring sampleName = GetSampleNameFromTags(tags);
DestroySampleThreadsafe(sample);
if(!mo3Decode)
{
m_szNames[sample] = mpt::ToCharset(GetCharsetInternal(), sampleName);
Samples[sample].Initialize();
Samples[sample].nC5Speed = rate;
}
Samples[sample].nLength = mpt::saturate_cast<SmpLength>((data.size() / channels) - data_skip_frames);
Samples[sample].uFlags.set(CHN_16BIT);
Samples[sample].uFlags.set(CHN_STEREO, channels == 2);
Samples[sample].AllocateSample();
if(Samples[sample].HasSampleData())
{
std::memcpy(Samples[sample].sampleb(), data.data() + (data_skip_frames * channels), (data.size() - (data_skip_frames * channels)) * sizeof(int16));
}
if(!mo3Decode)
{
Samples[sample].Convert(MOD_TYPE_IT, GetType());
Samples[sample].PrecomputeLoops(*this, false);
}
return Samples[sample].HasSampleData();
#elif defined(MPT_WITH_MINIMP3)
MPT_UNREFERENCED_PARAMETER(raw);
file.Rewind();
FileReader::PinnedRawDataView rawDataView = file.GetPinnedRawDataView();
int64 bytes_left = rawDataView.size();
const uint8 *stream_pos = mpt::byte_cast<const uint8 *>(rawDataView.data());
std::vector<int16> raw_sample_data;
mp3dec_t mp3;
std::memset(&mp3, 0, sizeof(mp3dec_t));
mp3dec_init(&mp3);
int rate = 0;
int channels = 0;
mp3dec_frame_info_t info;
std::memset(&info, 0, sizeof(mp3dec_frame_info_t));
do
{
int16 sample_buf[MINIMP3_MAX_SAMPLES_PER_FRAME];
int frame_samples = mp3dec_decode_frame(&mp3, stream_pos, mpt::saturate_cast<int>(bytes_left), sample_buf, &info);
if(frame_samples < 0 || info.frame_bytes < 0) break; // internal error in minimp3
if(frame_samples > 0 && info.frame_bytes == 0) break; // internal error in minimp3
if(frame_samples == 0 && info.frame_bytes == 0) break; // end of stream, no progress
if(frame_samples == 0 && info.frame_bytes > 0) MPT_DO { } MPT_WHILE_0; // decoder skipped non-mp3 data
if(frame_samples > 0 && info.frame_bytes > 0) MPT_DO { } MPT_WHILE_0; // normal
if(info.frame_bytes > 0)
{
if(rate != 0 && rate != info.hz) break; // inconsistent stream
if(channels != 0 && channels != info.channels) break; // inconsistent stream
rate = info.hz;
channels = info.channels;
if(rate <= 0) break; // broken stream
if(channels != 1 && channels != 2) break; // broken stream
stream_pos += std::clamp(info.frame_bytes, 0, mpt::saturate_cast<int>(bytes_left));
bytes_left -= std::clamp(info.frame_bytes, 0, mpt::saturate_cast<int>(bytes_left));
if(frame_samples > 0)
{
try
{
raw_sample_data.insert(raw_sample_data.end(), sample_buf, sample_buf + frame_samples * channels);
} MPT_EXCEPTION_CATCH_OUT_OF_MEMORY(e)
{
MPT_EXCEPTION_DELETE_OUT_OF_MEMORY(e);
break;
}
}
}
if((raw_sample_data.size() / channels) > MAX_SAMPLE_LENGTH)
{
break;
}
} while(bytes_left > 0);
if(rate == 0 || channels == 0 || raw_sample_data.empty())
{
return false;
}
if((raw_sample_data.size() / channels) > MAX_SAMPLE_LENGTH)
{
return false;
}
DestroySampleThreadsafe(sample);
if(!mo3Decode)
{
m_szNames[sample] = "";
Samples[sample].Initialize();
Samples[sample].nC5Speed = rate;
}
Samples[sample].nLength = mpt::saturate_cast<SmpLength>(raw_sample_data.size() / channels);
Samples[sample].uFlags.set(CHN_16BIT);
Samples[sample].uFlags.set(CHN_STEREO, channels == 2);
Samples[sample].AllocateSample();
if(Samples[sample].HasSampleData())
{
std::copy(raw_sample_data.begin(), raw_sample_data.end(), Samples[sample].sample16());
}
if(!mo3Decode)
{
Samples[sample].Convert(MOD_TYPE_IT, GetType());
Samples[sample].PrecomputeLoops(*this, false);
}
return Samples[sample].HasSampleData();
#else
MPT_UNREFERENCED_PARAMETER(sample);
MPT_UNREFERENCED_PARAMETER(file);
MPT_UNREFERENCED_PARAMETER(raw);
MPT_UNREFERENCED_PARAMETER(mo3Decode);
#endif // MPT_WITH_MPG123 || MPT_WITH_MINIMP3
return false;
}
bool CSoundFile::CanReadMP3()
{
bool result = false;
#if defined(MPT_WITH_MPG123)
if(!result)
{
ComponentHandle<ComponentMPG123> mpg123;
if(IsComponentAvailable(mpg123))
{
result = true;
}
}
#endif
#if defined(MPT_WITH_MINIMP3)
if(!result)
{
result = true;
}
#endif
#if defined(MPT_WITH_MEDIAFOUNDATION)
if(!result)
{
if(CanReadMediaFoundation())
{
result = true;
}
}
#endif
return result;
}
OPENMPT_NAMESPACE_END