#include <MP3FileReader.h>

Inheritance diagram for MP3FileReader:

Collaboration diagram for MP3FileReader:

Classes
struct	DecoderData

class	DecodeThread

Public Types
enum	GaplessMode { GaplessMode::Gapless, GaplessMode::Gappy }
	How the MP3FileReader should handle leading and trailing gaps. More...

enum	CacheMode { CacheInTemporaryFile, CacheInMemory }

enum	DecodeMode { DecodeAtOnce, DecodeThreaded }

typedef std::map< QString, QString >	TagMap
	Return any tag pairs picked up from the audio file. More...

Public Slots
void	cancelled ()

Signals
void	progress (int)

void	frameCountChanged ()

Public Member Functions
	MP3FileReader (FileSource source, DecodeMode decodeMode, CacheMode cacheMode, GaplessMode gaplessMode, sv_samplerate_t targetRate=0, bool normalised=false, ProgressReporter *reporter=0)

virtual	~MP3FileReader ()

QString	getError () const override
	If isOK() is false, return an error string. More...

QString	getLocation () const override
	Return the location of the audio data in the reader (as passed in to the FileSource constructor, for example). More...

QString	getTitle () const override
	Return the title of the work in the audio file, if known. More...

QString	getMaker () const override
	Return the "maker" of the work in the audio file, if known. More...

TagMap	getTags () const override

int	getDecodeCompletion () const override
	Return a percentage value indicating how far through decoding the audio file we are. More...

bool	isUpdating () const override
	Return true if decoding is still in progress and the frame count may change. More...

floatvec_t	getInterleavedFrames (sv_frame_t start, sv_frame_t count) const override
	Return interleaved samples for count frames from index start. More...

sv_samplerate_t	getNativeRate () const override
	Return the native samplerate of the file. More...

QString	getLocalFilename () const override
	Return the local file path of the audio data. More...

bool	isQuicklySeekable () const override
	Intermediate cache means all CodedAudioFileReaders are quickly seekable. More...

bool	isOK () const
	Return true if the file was opened successfully and no error has subsequently occurred. More...

sv_frame_t	getFrameCount () const
	Return the number of audio sample frames (i.e. More...

int	getChannelCount () const
	Return the number of channels in the file. More...

sv_samplerate_t	getSampleRate () const
	Return the samplerate at which the file is being read. More...

virtual std::vector< floatvec_t >	getDeInterleavedFrames (sv_frame_t start, sv_frame_t count) const
	Return de-interleaved samples for count frames from index start. More...

Static Public Member Functions
static void	getSupportedExtensions (std::set< QString > &extensions)

static bool	supportsExtension (QString ext)

static bool	supportsContentType (QString type)

static bool	supports (FileSource &source)

Protected Member Functions
bool	decode (void *mm, sv_frame_t sz)

enum mad_flow	filter (struct mad_stream const , struct mad_frame )

enum mad_flow	accept (struct mad_header const , struct mad_pcm )

void	loadTags (int fd)

QString	loadTag (void vtag, const char name)

void	initialiseDecodeCache ()

void	setFramesToTrim (sv_frame_t fromStart, sv_frame_t fromEnd)

void	addSamplesToDecodeCache (float **samples, sv_frame_t nframes)

void	addSamplesToDecodeCache (float *samplesInterleaved, sv_frame_t nframes)

void	addSamplesToDecodeCache (const floatvec_t &interleaved)

void	finishDecodeCache ()

bool	isDecodeCacheInitialised () const

void	startSerialised (QString id, const std::atomic< bool > *cancelled)

void	endSerialised ()

Static Protected Member Functions
static enum mad_flow	input_callback (void , struct mad_stream )

static enum mad_flow	output_callback (void , struct mad_header const , struct mad_pcm *)

static enum mad_flow	filter_callback (void , struct mad_stream const , struct mad_frame *)

static enum mad_flow	error_callback (void , struct mad_stream , struct mad_frame *)

Protected Attributes
FileSource	m_source

QString	m_path

QString	m_error

QString	m_title

QString	m_maker

TagMap	m_tags

GaplessMode	m_gaplessMode

sv_frame_t	m_fileSize

double	m_bitrateNum

int	m_bitrateDenom

int	m_mp3FrameCount

int	m_completion

bool	m_done

unsigned char *	m_fileBuffer

size_t	m_fileBufferSize

float **	m_sampleBuffer

size_t	m_sampleBufferSize

ProgressReporter *	m_reporter

std::atomic< bool >	m_cancelled

bool	m_decodeErrorShown

DecodeThread *	m_decodeThread

QMutex	m_cacheMutex

CacheMode	m_cacheMode

floatvec_t	m_data

QMutex	m_dataLock

bool	m_initialised

Serialiser *	m_serialiser

sv_samplerate_t	m_fileRate

QString	m_cacheFileName

SNDFILE *	m_cacheFileWritePtr

WavFileReader *	m_cacheFileReader

float *	m_cacheWriteBuffer

sv_frame_t	m_cacheWriteBufferIndex

sv_frame_t	m_cacheWriteBufferFrames

breakfastquay::Resampler *	m_resampler

float *	m_resampleBuffer

int	m_resampleBufferFrames

sv_frame_t	m_fileFrameCount

bool	m_normalised

float	m_max

float	m_gain

sv_frame_t	m_trimFromStart

sv_frame_t	m_trimFromEnd

sv_frame_t	m_clippedCount

sv_frame_t	m_firstNonzero

sv_frame_t	m_lastNonzero

sv_frame_t	m_frameCount

int	m_channelCount

sv_samplerate_t	m_sampleRate

Detailed Description

Definition at line 31 of file MP3FileReader.h.

Member Typedef Documentation

typedef std::map<QString, QString> AudioFileReader::TagMap

inherited

Return any tag pairs picked up from the audio file.

See also getTitle and getMaker, and note that a reader which does not implement getTags may still return values from those.

Definition at line 117 of file AudioFileReader.h.

Member Enumeration Documentation

enum MP3FileReader::GaplessMode

strong

How the MP3FileReader should handle leading and trailing gaps.

See http://lame.sourceforge.net/tech-FAQ.txt for a technical explanation of the numbers here.

Enumerator

Gapless

Trim unwanted samples from the start and end of the decoded audio.

From the start, trim a number of samples equal to the decoder delay (a fixed 529 samples) plus any encoder delay that may be specified in Xing/LAME metadata. From the end, trim any padding specified in Xing/LAME metadata, less the fixed decoder delay. This usually results in "gapless" audio, i.e. with no spurious zero padding at either end.

Gappy

Do not trim any samples.

Also do not suppress any frames from being passed to the mp3 decoder, even Xing/LAME metadata frames. This will result in the audio being padded with zeros at either end: at the start, typically 529+576+1152 = 2257 samples for LAME-encoded mp3s; at the end an unknown number depending on the fill ratio of the final coded frame, but typically less than 1152-529 = 623.

This mode produces the same output as produced by older versions of this code before the gapless option was added, and is present mostly for backward compatibility.

Definition at line 41 of file MP3FileReader.h.

enum CodedAudioFileReader::CacheMode

inherited

Enumerator
CacheInTemporaryFile
CacheInMemory

Definition at line 47 of file CodedAudioFileReader.h.

enum CodedAudioFileReader::DecodeMode

inherited

Enumerator
DecodeAtOnce
DecodeThreaded

Definition at line 52 of file CodedAudioFileReader.h.

Constructor & Destructor Documentation

MP3FileReader::MP3FileReader	(	FileSource	source,
		DecodeMode	decodeMode,
		CacheMode	cacheMode,
		GaplessMode	gaplessMode,
		sv_samplerate_t	targetRate = `0`,
		bool	normalised = `false`,
		ProgressReporter *	reporter = `0`
	)

MP3FileReader::~MP3FileReader ( )

virtual

Definition at line 175 of file MP3FileReader.cpp.

References m_cancelled, and m_decodeThread.

Member Function Documentation

QString MP3FileReader::getError ( ) const

inlineoverridevirtual

If isOK() is false, return an error string.

Reimplemented from AudioFileReader.

Definition at line 78 of file MP3FileReader.h.

References m_error.

QString MP3FileReader::getLocation ( ) const

inlineoverridevirtual

Return the location of the audio data in the reader (as passed in to the FileSource constructor, for example).

This might be a remote URL.

See also getLocalFilename().

Implements AudioFileReader.

Definition at line 80 of file MP3FileReader.h.

References FileSource::getLocation(), and m_source.

QString MP3FileReader::getTitle ( ) const

inlineoverridevirtual

Return the title of the work in the audio file, if known.

This may be implemented by subclasses that support file tagging. This is not the same thing as the file name.

Implements AudioFileReader.

Definition at line 81 of file MP3FileReader.h.

References m_title.

QString MP3FileReader::getMaker ( ) const

inlineoverridevirtual

Return the "maker" of the work in the audio file, if known.

This could represent almost anything (band, composer, conductor, artist etc).

Implements AudioFileReader.

Definition at line 82 of file MP3FileReader.h.

References m_maker.

TagMap MP3FileReader::getTags ( ) const

inlineoverridevirtual

Reimplemented from AudioFileReader.

Definition at line 83 of file MP3FileReader.h.

References getSupportedExtensions(), m_tags, supports(), supportsContentType(), and supportsExtension().

void MP3FileReader::getSupportedExtensions ( std::set< QString > & extensions )

static

Definition at line 614 of file MP3FileReader.cpp.

Referenced by AudioFileReaderFactory::getKnownExtensions(), getTags(), and supportsExtension().

bool MP3FileReader::supportsExtension ( QString ext )

static

Definition at line 620 of file MP3FileReader.cpp.

References getSupportedExtensions().

Referenced by getTags(), and supports().

bool MP3FileReader::supportsContentType ( QString type )

static

Definition at line 628 of file MP3FileReader.cpp.

Referenced by getTags(), and supports().

bool MP3FileReader::supports ( FileSource & source )

static

Definition at line 634 of file MP3FileReader.cpp.

References FileSource::getContentType(), FileSource::getExtension(), supportsContentType(), and supportsExtension().

Referenced by AudioFileReaderFactory::createReader(), getTags(), and AudioFileReaderFactory::isSupported().

int MP3FileReader::getDecodeCompletion ( ) const

inlineoverridevirtual

Return a percentage value indicating how far through decoding the audio file we are.

This should be implemented by subclasses that will not know exactly how long the audio file is (in sample frames) until it has been completely decoded. A reader that initialises the frame count directly within its constructor should always return 100 from this.

Reimplemented from AudioFileReader.

Definition at line 90 of file MP3FileReader.h.

References m_completion.

bool MP3FileReader::isUpdating ( ) const

inlineoverridevirtual

Return true if decoding is still in progress and the frame count may change.

Reimplemented from AudioFileReader.

Definition at line 92 of file MP3FileReader.h.

References cancelled(), and m_decodeThread.

void MP3FileReader::cancelled ( )

slot

Definition at line 187 of file MP3FileReader.cpp.

References m_cancelled.

Referenced by isUpdating(), and MP3FileReader().

bool MP3FileReader::decode	(	void *	mm,
		sv_frame_t	sz
	)

protected

Definition at line 319 of file MP3FileReader.cpp.

References error_callback(), filter_callback(), MP3FileReader::DecoderData::finished, input_callback(), MP3FileReader::DecoderData::length, m_done, m_mp3FrameCount, output_callback(), MP3FileReader::DecoderData::reader, MP3FileReader::DecoderData::start, and SVDEBUG.

Referenced by MP3FileReader().

enum mad_flow MP3FileReader::filter	(	struct mad_stream const *	stream,
		struct mad_frame *
	)

protected

Definition at line 398 of file MP3FileReader.cpp.

References DEFAULT_DECODER_DELAY, Gappy, m_gaplessMode, m_mp3FrameCount, CodedAudioFileReader::setFramesToTrim(), SVDEBUG, and toMagic().

Referenced by filter_callback().

enum mad_flow MP3FileReader::accept	(	struct mad_header const *	header,
		struct mad_pcm *	pcm
	)

protected

enum mad_flow MP3FileReader::input_callback	(	void *	dp,
		struct mad_stream *	stream
	)

staticprotected

Definition at line 349 of file MP3FileReader.cpp.

References MP3FileReader::DecoderData::finished, MP3FileReader::DecoderData::length, MP3FileReader::DecoderData::start, and SVDEBUG.

Referenced by decode().

enum mad_flow MP3FileReader::output_callback	(	void *	dp,
		struct mad_header const *	header,
		struct mad_pcm *	pcm
	)

staticprotected

Definition at line 478 of file MP3FileReader.cpp.

References accept(), and MP3FileReader::DecoderData::reader.

Referenced by decode().

enum mad_flow MP3FileReader::filter_callback	(	void *	dp,
		struct mad_stream const *	stream,
		struct mad_frame *	frame
	)

staticprotected

Definition at line 380 of file MP3FileReader.cpp.

References filter(), and MP3FileReader::DecoderData::reader.

Referenced by decode().

enum mad_flow MP3FileReader::error_callback	(	void *	dp,
		struct mad_stream *	stream,
		struct mad_frame *
	)

staticprotected

Definition at line 585 of file MP3FileReader.cpp.

References MP3FileReader::DecoderData::finished, MP3FileReader::DecoderData::length, m_decodeErrorShown, m_path, MP3FileReader::DecoderData::reader, MP3FileReader::DecoderData::start, and SVCERR.

Referenced by decode().

void MP3FileReader::loadTags ( int fd )

protected

Definition at line 193 of file MP3FileReader.cpp.

References loadTag(), m_maker, m_tags, m_title, and SVDEBUG.

Referenced by MP3FileReader().

QString MP3FileReader::loadTag	(	void *	vtag,
		const char *	name
	)

protected

Definition at line 243 of file MP3FileReader.cpp.

References SVDEBUG.

Referenced by loadTags().

floatvec_t CodedAudioFileReader::getInterleavedFrames	(	sv_frame_t	start,
		sv_frame_t	count
	)		const

overridevirtualinherited

Return interleaved samples for count frames from index start.

The resulting vector will contain count * getChannelCount() samples (or fewer if end of file is reached).

The subclass implementations of this function must be thread-safe – that is, safe to call from multiple threads with different arguments on the same object at the same time.

Implements AudioFileReader.

Definition at line 550 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::CacheInMemory, CodedAudioFileReader::CacheInTemporaryFile, WavFileReader::getInterleavedFrames(), AudioFileReader::isOK(), CodedAudioFileReader::m_cacheFileReader, CodedAudioFileReader::m_cacheMode, AudioFileReader::m_channelCount, CodedAudioFileReader::m_data, CodedAudioFileReader::m_dataLock, CodedAudioFileReader::m_gain, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_normalised, and SVDEBUG.

sv_samplerate_t CodedAudioFileReader::getNativeRate ( ) const

inlineoverridevirtualinherited

Return the native samplerate of the file.

This will differ from getSampleRate() if the file is being resampled because it was requested to open at a different rate from native.

Reimplemented from AudioFileReader.

Definition at line 59 of file CodedAudioFileReader.h.

QString CodedAudioFileReader::getLocalFilename ( ) const

inlineoverridevirtualinherited

Return the local file path of the audio data.

This is the filesystem location most likely to contain readable audio data, but it may be in a different place or format from the originally specified location - for example, if the file has been retrieved and decoded, then it will be the (possibly temporary) decode target file.

This returns a non-empty value only if there is some local filename that contains exactly the audio data being provided by this reader. In some cases this may not exist, for example when a file has been resampled or normalised directly into a memory buffer. In this case, return an empty string.

See also getLocation().

Implements AudioFileReader.

Definition at line 61 of file CodedAudioFileReader.h.

bool CodedAudioFileReader::isQuicklySeekable ( ) const

inlineoverridevirtualinherited

Intermediate cache means all CodedAudioFileReaders are quickly seekable.

Implements AudioFileReader.

Definition at line 64 of file CodedAudioFileReader.h.

void CodedAudioFileReader::progress ( int )

signalinherited

Referenced by DecodingWavFileReader::addBlock().

void CodedAudioFileReader::initialiseDecodeCache ( )

protectedinherited

Definition at line 127 of file CodedAudioFileReader.cpp.

Referenced by accept(), BQAFileReader::BQAFileReader(), and DecodingWavFileReader::DecodingWavFileReader().

void CodedAudioFileReader::setFramesToTrim	(	sv_frame_t	fromStart,
		sv_frame_t	fromEnd
	)

protectedinherited

Definition at line 101 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_trimFromEnd, and CodedAudioFileReader::m_trimFromStart.

Referenced by filter(), and MP3FileReader().

void CodedAudioFileReader::addSamplesToDecodeCache	(	float **	samples,
		sv_frame_t	nframes
	)

protectedinherited

Definition at line 251 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_cacheMutex, CodedAudioFileReader::m_cacheWriteBuffer, CodedAudioFileReader::m_cacheWriteBufferIndex, AudioFileReader::m_channelCount, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_trimFromStart, and CodedAudioFileReader::pushCacheWriteBufferMaybe().

Referenced by accept(), DecodingWavFileReader::addBlock(), and BQAFileReader::BQAFileReader().

void CodedAudioFileReader::addSamplesToDecodeCache	(	float *	samplesInterleaved,
		sv_frame_t	nframes
	)

protectedinherited

Definition at line 276 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_cacheMutex, CodedAudioFileReader::m_cacheWriteBuffer, CodedAudioFileReader::m_cacheWriteBufferIndex, AudioFileReader::m_channelCount, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_trimFromStart, and CodedAudioFileReader::pushCacheWriteBufferMaybe().

void CodedAudioFileReader::addSamplesToDecodeCache ( const floatvec_t & interleaved )

protectedinherited

Definition at line 301 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_cacheMutex, CodedAudioFileReader::m_cacheWriteBuffer, CodedAudioFileReader::m_cacheWriteBufferIndex, CodedAudioFileReader::m_initialised, CodedAudioFileReader::m_trimFromStart, and CodedAudioFileReader::pushCacheWriteBufferMaybe().

void CodedAudioFileReader::finishDecodeCache ( )

protectedinherited

Definition at line 321 of file CodedAudioFileReader.cpp.

Referenced by BQAFileReader::BQAFileReader(), DecodingWavFileReader::DecodingWavFileReader(), and MP3FileReader().

bool CodedAudioFileReader::isDecodeCacheInitialised ( ) const

inlineprotectedinherited

Definition at line 87 of file CodedAudioFileReader.h.

Referenced by accept(), BQAFileReader::BQAFileReader(), DecodingWavFileReader::DecodingWavFileReader(), and MP3FileReader().

void CodedAudioFileReader::startSerialised	(	QString	id,
		const std::atomic< bool > *	cancelled
	)

protectedinherited

Definition at line 108 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_serialiser.

Referenced by accept().

void CodedAudioFileReader::endSerialised ( )

protectedinherited

Definition at line 118 of file CodedAudioFileReader.cpp.

References CodedAudioFileReader::m_serialiser.

Referenced by BQAFileReader::BQAFileReader(), DecodingWavFileReader::DecodingWavFileReader(), MP3FileReader(), and CodedAudioFileReader::~CodedAudioFileReader().

bool AudioFileReader::isOK ( ) const

inlineinherited

Return true if the file was opened successfully and no error has subsequently occurred.

Definition at line 38 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

Referenced by AudioFileReaderFactory::createReader(), DecodingWavFileReader::DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getData(), CodedAudioFileReader::getInterleavedFrames(), ReadOnlyWaveFileModel::getMultiChannelData(), CodedAudioFileReader::initialiseDecodeCache(), and ReadOnlyWaveFileModel::isOK().

sv_frame_t AudioFileReader::getFrameCount ( ) const

inlineinherited

Return the number of audio sample frames (i.e.

samples per channel) in the file.

Definition at line 49 of file AudioFileReader.h.

References AudioFileReader::m_frameCount.

Referenced by DecodingWavFileReader::addBlock(), DecodingWavFileReader::DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getFrameCount(), and WritableWaveFileModel::normaliseToTarget().

int AudioFileReader::getChannelCount ( ) const

inlineinherited

Return the number of channels in the file.

Definition at line 54 of file AudioFileReader.h.

References AudioFileReader::m_channelCount.

Referenced by WritableWaveFileModel::addSamples(), DecodingWavFileReader::DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getChannelCount(), and AudioFileReader::getDeInterleavedFrames().

sv_samplerate_t AudioFileReader::getSampleRate ( ) const

inlineinherited

Return the samplerate at which the file is being read.

This is the rate requested when the file was opened, which may differ from the native rate of the file (in which case the file will be resampled as it is read).

Definition at line 62 of file AudioFileReader.h.

References AudioFileReader::m_sampleRate.

Referenced by AudioFileReaderFactory::createReader(), DecodingWavFileReader::DecodingWavFileReader(), AudioFileSizeEstimator::estimate(), ReadOnlyWaveFileModel::getSampleRate(), and ReadOnlyWaveFileModel::ReadOnlyWaveFileModel().

vector< floatvec_t > AudioFileReader::getDeInterleavedFrames	(	sv_frame_t	start,
		sv_frame_t	count
	)		const

virtualinherited

Return de-interleaved samples for count frames from index start.

Implemented in this class (it calls getInterleavedFrames and de-interleaves). The resulting vector will contain getChannelCount() sample blocks of count samples each (or fewer if end of file is reached).

Definition at line 21 of file AudioFileReader.cpp.

References AudioFileReader::getChannelCount(), and AudioFileReader::getInterleavedFrames().

Referenced by AudioFileReader::isUpdating().

void AudioFileReader::frameCountChanged ( )

signalinherited

Referenced by AudioFileReader::isUpdating(), and WavFileReader::updateFrameCount().