///////////////////////////////////////////////////////////////////////////////
// LameXP - Audio Encoder Front-End
-// Copyright (C) 2004-2011 LoRd_MuldeR <MuldeR2@GMX.de>
+// Copyright (C) 2004-2020 LoRd_MuldeR <MuldeR2@GMX.de>
//
// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
+// it under the terms of the GNU GENERAL PUBLIC LICENSE as published by
// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// (at your option) any later version; always including the non-optional
+// LAMEXP GNU GENERAL PUBLIC LICENSE ADDENDUM. See "License.txt" file!
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
#include "Thread_FileAnalyzer.h"
+//Internal
#include "Global.h"
#include "LockedFile.h"
#include "Model_AudioFile.h"
+#include "Thread_FileAnalyzer_Task.h"
#include "PlaylistImporter.h"
+//MUtils
+#include <MUtils/Global.h>
+#include <MUtils/Exception.h>
+
+//Qt
#include <QDir>
#include <QFileInfo>
#include <QProcess>
#include <QDate>
#include <QTime>
#include <QDebug>
+#include <QImage>
+#include <QThreadPool>
+#include <QTime>
+#include <QElapsedTimer>
+#include <QTimer>
+#include <QQueue>
-#include <math.h>
+//Insert into QStringList *without* duplicates
+static inline void SAFE_APPEND_STRING(QStringList &list, const QString &str)
+{
+ if(!list.contains(str, Qt::CaseInsensitive))
+ {
+ list << str;
+ }
+}
////////////////////////////////////////////////////////////
// Constructor
FileAnalyzer::FileAnalyzer(const QStringList &inputFiles)
:
- m_inputFiles(inputFiles),
- m_mediaInfoBin(lamexp_lookup_tool("mediainfo.exe")),
- m_abortFlag(false)
+ m_tasksCounterNext(0),
+ m_tasksCounterDone(0),
+ m_inputFiles(inputFiles)
{
- m_bSuccess = false;
- m_bAborted = false;
-
- if(m_mediaInfoBin.isEmpty())
- {
- qFatal("Invalid path to MediaInfo binary. Tool not initialized properly.");
- }
-
m_filesAccepted = 0;
m_filesRejected = 0;
m_filesDenied = 0;
m_filesDummyCDDA = 0;
+ m_filesCueSheet = 0;
+
+ moveToThread(this); /*makes sure queued slots are executed in the proper thread context*/
+ m_timer.reset(new QElapsedTimer());
+}
+
+FileAnalyzer::~FileAnalyzer(void)
+{
+ if(!m_pool.isNull())
+ {
+ if(!m_pool->waitForDone(2500))
+ {
+ qWarning("There are still running tasks in the thread pool!");
+ }
+ }
}
////////////////////////////////////////////////////////////
void FileAnalyzer::run()
{
- m_bSuccess = false;
- m_bAborted = false;
+ m_bSuccess.fetchAndStoreOrdered(0);
+
+ m_tasksCounterNext = 0;
+ m_tasksCounterDone = 0;
+ m_completedCounter = 0;
+
+ m_completedFiles.clear();
+ m_completedTaskIds.clear();
+ m_runningTaskIds.clear();
m_filesAccepted = 0;
m_filesRejected = 0;
m_filesDenied = 0;
m_filesDummyCDDA = 0;
- m_inputFiles.sort();
-
- m_abortFlag = false;
-
- while(!m_inputFiles.isEmpty())
- {
- QString currentFile = QDir::fromNativeSeparators(m_inputFiles.takeFirst());
- qDebug64("Analyzing: %1", currentFile);
- emit fileSelected(QFileInfo(currentFile).fileName());
- AudioFileModel file = analyzeFile(currentFile);
-
- if(m_abortFlag)
- {
- MessageBeep(MB_ICONERROR);
- m_bAborted = true;
- qWarning("Operation cancelled by user!");
- return;
- }
-
- if(file.fileName().isEmpty() || file.formatContainerType().isEmpty() || file.formatAudioType().isEmpty())
- {
- if(!PlaylistImporter::importPlaylist(m_inputFiles, currentFile))
- {
- m_filesRejected++;
- qDebug64("Skipped: %1", file.filePath());
- }
- continue;
- }
-
- m_filesAccepted++;
- emit fileAnalyzed(file);
- }
+ m_filesCueSheet = 0;
- qDebug("All files added.\n");
- m_bSuccess = true;
-}
+ m_timer->invalidate();
-////////////////////////////////////////////////////////////
-// Privtae Functions
-////////////////////////////////////////////////////////////
+ //Sort files
+ MUtils::natural_string_sort(m_inputFiles, true);
-const AudioFileModel FileAnalyzer::analyzeFile(const QString &filePath)
-{
- AudioFileModel audioFile(filePath);
- m_currentSection = sectionOther;
- m_currentCover = coverNone;
+ //Handle playlist files first!
+ handlePlaylistFiles();
- QFile readTest(filePath);
- if(!readTest.open(QIODevice::ReadOnly))
- {
- qWarning("Cannot access file for reading, skipping!");
- m_filesDenied++;
- return audioFile;
- }
-
- if(checkFile_CDDA(readTest))
+ const unsigned int nFiles = m_inputFiles.count();
+ if(nFiles < 1)
{
- qWarning("Dummy CDDA file detected, skipping!");
- m_filesDummyCDDA ++;
- return audioFile;
- }
-
- readTest.close();
-
- QProcess process;
- process.setProcessChannelMode(QProcess::MergedChannels);
- process.setReadChannel(QProcess::StandardOutput);
- process.start(m_mediaInfoBin, QStringList() << QDir::toNativeSeparators(filePath));
-
- if(!process.waitForStarted())
- {
- qWarning("MediaInfo process failed to create!");
- qWarning("Error message: \"%s\"\n", process.errorString().toLatin1().constData());
- process.kill();
- process.waitForFinished(-1);
- return audioFile;
+ qWarning("File list is empty, nothing to do!");
+ return;
}
- while(process.state() != QProcess::NotRunning)
- {
- if(m_abortFlag)
- {
- process.kill();
- qWarning("Process was aborted on user request!");
- break;
- }
-
- if(!process.waitForReadyRead())
- {
- if(process.state() == QProcess::Running)
- {
- qWarning("MediaInfo time out. Killing process and skipping file!");
- process.kill();
- process.waitForFinished(-1);
- return audioFile;
- }
- }
-
- QByteArray data;
+ //Update progress
+ emit progressMaxChanged(nFiles);
+ emit progressValChanged(0);
- while(process.canReadLine())
- {
- QString line = QString::fromUtf8(process.readLine().constData()).simplified();
- if(!line.isEmpty())
- {
- int index = line.indexOf(':');
- if(index > 0)
- {
- QString key = line.left(index-1).trimmed();
- QString val = line.mid(index+1).trimmed();
- if(!key.isEmpty() && !val.isEmpty())
- {
- updateInfo(audioFile, key, val);
- }
- }
- else
- {
- updateSection(line);
- }
- }
- }
+ //Create the thread pool
+ if (m_pool.isNull())
+ {
+ m_pool.reset(new QThreadPool());
}
- if(audioFile.fileName().isEmpty())
+ //Update thread count
+ const int idealThreadCount = QThread::idealThreadCount();
+ if(idealThreadCount > 0)
{
- QString baseName = QFileInfo(filePath).fileName();
- int index = baseName.lastIndexOf(".");
+ m_pool->setMaxThreadCount(qBound(2, ((idealThreadCount * 3) / 2), 12));
+ }
- if(index >= 0)
- {
- baseName = baseName.left(index);
- }
+ //Start first N threads
+ QTimer::singleShot(0, this, SLOT(initializeTasks()));
- baseName = baseName.replace("_", " ").simplified();
- index = baseName.lastIndexOf(" - ");
+ //Start event processing
+ this->exec();
- if(index >= 0)
- {
- baseName = baseName.mid(index + 3).trimmed();
- }
+ //Wait for pending tasks to complete
+ m_pool->waitForDone();
- audioFile.setFileName(baseName);
+ //Was opertaion aborted?
+ if(MUTILS_BOOLIFY(m_bAborted))
+ {
+ qWarning("Operation cancelled by user!");
+ return;
}
- if(m_currentCover != coverNone)
+ //Update progress
+ emit progressValChanged(nFiles);
+
+ //Emit pending files (this should not be required though!)
+ if(!m_completedFiles.isEmpty())
{
- retrieveCover(audioFile, filePath);
+ qWarning("FileAnalyzer: Pending file information found after last thread terminated!");
+ QList<unsigned int> keys = m_completedFiles.keys(); qSort(keys);
+ while(!keys.isEmpty())
+ {
+ emit fileAnalyzed(m_completedFiles.take(keys.takeFirst()));
+ }
}
- return audioFile;
+ qDebug("All files added.\n");
+ m_bSuccess.fetchAndStoreOrdered(1);
+ QThread::msleep(333);
}
-void FileAnalyzer::updateSection(const QString §ion)
-{
- if(section.startsWith("General", Qt::CaseInsensitive))
- {
- m_currentSection = sectionGeneral;
- }
- else if(!section.compare("Audio", Qt::CaseInsensitive) || section.startsWith("Audio #1", Qt::CaseInsensitive))
- {
- m_currentSection = sectionAudio;
- }
- else if(section.startsWith("Audio", Qt::CaseInsensitive) || section.startsWith("Video", Qt::CaseInsensitive) || section.startsWith("Text", Qt::CaseInsensitive) ||
- section.startsWith("Menu", Qt::CaseInsensitive) || section.startsWith("Image", Qt::CaseInsensitive) || section.startsWith("Chapters", Qt::CaseInsensitive))
- {
- m_currentSection = sectionOther;
- }
- else
- {
- m_currentSection = sectionOther;
- qWarning("Unknown section: %s", section.toUtf8().constData());
- }
-}
+////////////////////////////////////////////////////////////
+// Privtae Functions
+////////////////////////////////////////////////////////////
-void FileAnalyzer::updateInfo(AudioFileModel &audioFile, const QString &key, const QString &value)
+bool FileAnalyzer::analyzeNextFile(void)
{
- switch(m_currentSection)
+ if(!(m_inputFiles.isEmpty() || MUTILS_BOOLIFY(m_bAborted)))
{
- case sectionGeneral:
- if(!key.compare("Title", Qt::CaseInsensitive) || !key.compare("Track", Qt::CaseInsensitive) || !key.compare("Track Name", Qt::CaseInsensitive))
- {
- if(audioFile.fileName().isEmpty()) audioFile.setFileName(value);
- }
- else if(!key.compare("Duration", Qt::CaseInsensitive))
- {
- if(!audioFile.fileDuration()) audioFile.setFileDuration(parseDuration(value));
- }
- else if(!key.compare("Artist", Qt::CaseInsensitive) || !key.compare("Performer", Qt::CaseInsensitive))
- {
- if(audioFile.fileArtist().isEmpty()) audioFile.setFileArtist(value);
- }
- else if(!key.compare("Album", Qt::CaseInsensitive))
- {
- if(audioFile.fileAlbum().isEmpty()) audioFile.setFileAlbum(value);
- }
- else if(!key.compare("Genre", Qt::CaseInsensitive))
- {
- if(audioFile.fileGenre().isEmpty()) audioFile.setFileGenre(value);
- }
- else if(!key.compare("Year", Qt::CaseInsensitive) || !key.compare("Recorded Date", Qt::CaseInsensitive) || !key.compare("Encoded Date", Qt::CaseInsensitive))
- {
- if(!audioFile.fileYear()) audioFile.setFileYear(parseYear(value));
- }
- else if(!key.compare("Comment", Qt::CaseInsensitive))
- {
- if(audioFile.fileComment().isEmpty()) audioFile.setFileComment(value);
- }
- else if(!key.compare("Track Name/Position", Qt::CaseInsensitive))
- {
- if(!audioFile.filePosition()) audioFile.setFilePosition(value.toInt());
- }
- else if(!key.compare("Format", Qt::CaseInsensitive))
- {
- if(audioFile.formatContainerType().isEmpty()) audioFile.setFormatContainerType(value);
- }
- else if(!key.compare("Format Profile", Qt::CaseInsensitive))
- {
- if(audioFile.formatContainerProfile().isEmpty()) audioFile.setFormatContainerProfile(value);
- }
- else if(!key.compare("Cover", Qt::CaseInsensitive) || !key.compare("Cover type", Qt::CaseInsensitive))
- {
- if(m_currentCover == coverNone) m_currentCover = coverJpeg;
- }
- else if(!key.compare("Cover MIME", Qt::CaseInsensitive))
- {
- QString temp = value.split(" ", QString::SkipEmptyParts, Qt::CaseInsensitive).first();
- if(!temp.compare("image/jpeg", Qt::CaseInsensitive))
- {
- m_currentCover = coverJpeg;
- }
- else if(!temp.compare("image/png", Qt::CaseInsensitive))
- {
- m_currentCover = coverPng;
- }
- else if(!temp.compare("image/gif", Qt::CaseInsensitive))
- {
- m_currentCover = coverGif;
- }
- }
- break;
+ const unsigned int taskId = m_tasksCounterNext++;
+ const QString currentFile = QDir::fromNativeSeparators(m_inputFiles.takeFirst());
- case sectionAudio:
- if(!key.compare("Year", Qt::CaseInsensitive) || !key.compare("Recorded Date", Qt::CaseInsensitive) || !key.compare("Encoded Date", Qt::CaseInsensitive))
- {
- if(!audioFile.fileYear()) audioFile.setFileYear(parseYear(value));
- }
- else if(!key.compare("Format", Qt::CaseInsensitive))
- {
- if(audioFile.formatAudioType().isEmpty()) audioFile.setFormatAudioType(value);
- }
- else if(!key.compare("Format Profile", Qt::CaseInsensitive))
- {
- if(audioFile.formatAudioProfile().isEmpty()) audioFile.setFormatAudioProfile(value);
- }
- else if(!key.compare("Format Version", Qt::CaseInsensitive))
+ if((!m_timer->isValid()) || (m_timer->elapsed() >= 333))
{
- if(audioFile.formatAudioVersion().isEmpty()) audioFile.setFormatAudioVersion(value);
+ emit fileSelected(QFileInfo(currentFile).fileName());
+ m_timer->restart();
}
- else if(!key.compare("Channel(s)", Qt::CaseInsensitive))
- {
- if(!audioFile.formatAudioChannels()) audioFile.setFormatAudioChannels(value.split(" ", QString::SkipEmptyParts).first().toInt());
- }
- else if(!key.compare("Sampling rate", Qt::CaseInsensitive))
- {
- if(!audioFile.formatAudioSamplerate()) audioFile.setFormatAudioSamplerate(ceil(value.split(" ", QString::SkipEmptyParts).first().toFloat() * 1000.0f));
- }
- else if(!key.compare("Bit depth", Qt::CaseInsensitive))
- {
- if(!audioFile.formatAudioBitdepth()) audioFile.setFormatAudioBitdepth(value.split(" ", QString::SkipEmptyParts).first().toInt());
- }
- else if(!key.compare("Duration", Qt::CaseInsensitive))
- {
- if(!audioFile.fileDuration()) audioFile.setFileDuration(parseDuration(value));
- }
- break;
+
+ AnalyzeTask *task = new AnalyzeTask(taskId, currentFile, m_bAborted);
+ connect(task, SIGNAL(fileAnalyzed(const unsigned int, const int, AudioFileModel)), this, SLOT(taskFileAnalyzed(unsigned int, const int, AudioFileModel)), Qt::QueuedConnection);
+ connect(task, SIGNAL(taskCompleted(const unsigned int)), this, SLOT(taskThreadFinish(const unsigned int)), Qt::QueuedConnection);
+ m_runningTaskIds.insert(taskId); m_pool->start(task);
+
+ return true;
}
+
+ return false;
}
-unsigned int FileAnalyzer::parseYear(const QString &str)
+void FileAnalyzer::handlePlaylistFiles(void)
{
- if(str.startsWith("UTC", Qt::CaseInsensitive))
+ QQueue<QVariant> queue;
+ QStringList importedFromPlaylist;
+
+ //Import playlist files into "hierarchical" list
+ while(!m_inputFiles.isEmpty())
{
- QDate date = QDate::fromString(str.mid(3).trimmed().left(10), "yyyy-MM-dd");
- if(date.isValid())
+ const QString currentFile = m_inputFiles.takeFirst();
+ QStringList importedFiles;
+ if(PlaylistImporter::importPlaylist(importedFiles, currentFile))
{
- return date.year();
+ queue.enqueue(importedFiles);
+ importedFromPlaylist << importedFiles;
}
else
{
- return 0;
+ queue.enqueue(currentFile);
}
}
- else
+
+ //Reduce temporary list
+ importedFromPlaylist.removeDuplicates();
+
+ //Now build the complete "flat" file list (files imported from playlist take precedence!)
+ while(!queue.isEmpty())
{
- bool ok = false;
- int year = str.toInt(&ok);
- if(ok && year > 0)
+ const QVariant current = queue.dequeue();
+ if(current.type() == QVariant::String)
+ {
+ const QString temp = current.toString();
+ if(!importedFromPlaylist.contains(temp, Qt::CaseInsensitive))
+ {
+ SAFE_APPEND_STRING(m_inputFiles, temp);
+ }
+ }
+ else if(current.type() == QVariant::StringList)
{
- return year;
+ const QStringList temp = current.toStringList();
+ for(QStringList::ConstIterator iter = temp.constBegin(); iter != temp.constEnd(); iter++)
+ {
+ SAFE_APPEND_STRING(m_inputFiles, (*iter));
+ }
}
else
{
- return 0;
+ qWarning("Encountered an unexpected variant type!");
}
}
}
-unsigned int FileAnalyzer::parseDuration(const QString &str)
-{
- QTime time;
-
- time = QTime::fromString(str, "z'ms'");
- if(time.isValid())
- {
- return max(1, (time.hour() * 60 * 60) + (time.minute() * 60) + time.second());
- }
-
- time = QTime::fromString(str, "s's 'z'ms'");
- if(time.isValid())
- {
- return max(1, (time.hour() * 60 * 60) + (time.minute() * 60) + time.second());
- }
-
- time = QTime::fromString(str, "m'mn 's's'");
- if(time.isValid())
- {
- return max(1, (time.hour() * 60 * 60) + (time.minute() * 60) + time.second());
- }
+////////////////////////////////////////////////////////////
+// Slot Functions
+////////////////////////////////////////////////////////////
- time = QTime::fromString(str, "h'h 'm'mn'");
- if(time.isValid())
+void FileAnalyzer::initializeTasks(void)
+{
+ for(int i = 0; i < m_pool->maxThreadCount(); i++)
{
- return max(1, (time.hour() * 60 * 60) + (time.minute() * 60) + time.second());
+ if(!analyzeNextFile()) break;
}
-
- return 0;
}
-bool FileAnalyzer::checkFile_CDDA(QFile &file)
+void FileAnalyzer::taskFileAnalyzed(const unsigned int taskId, const int fileType, const AudioFileModel &file)
{
- file.reset();
- QByteArray data = file.read(128);
-
- int i = data.indexOf("RIFF");
- int j = data.indexOf("CDDA");
- int k = data.indexOf("fmt ");
-
- return ((i >= 0) && (j >= 0) && (k >= 0) && (k > j) && (j > i));
-}
+ m_completedTaskIds.insert(taskId);
-void FileAnalyzer::retrieveCover(AudioFileModel &audioFile, const QString &filePath)
-{
- qDebug64("Retrieving cover from: %1", filePath);
- QString extension;
-
- switch(m_currentCover)
+ switch(fileType)
{
- case coverPng:
- extension = QString::fromLatin1("png");
+ case AnalyzeTask::fileTypeNormal:
+ m_filesAccepted++;
+ if(m_tasksCounterDone == taskId)
+ {
+ emit fileAnalyzed(file);
+ m_tasksCounterDone++;
+ }
+ else
+ {
+ m_completedFiles.insert(taskId, file);
+ }
break;
- case coverGif:
- extension = QString::fromLatin1("gif");
+ case AnalyzeTask::fileTypeCDDA:
+ m_filesDummyCDDA++;
break;
- default:
- extension = QString::fromLatin1("jpg");
+ case AnalyzeTask::fileTypeDenied:
+ m_filesDenied++;
break;
- }
-
- QProcess process;
- process.setProcessChannelMode(QProcess::MergedChannels);
- process.setReadChannel(QProcess::StandardOutput);
- process.start(m_mediaInfoBin, QStringList() << "-f" << QDir::toNativeSeparators(filePath));
-
- if(!process.waitForStarted())
- {
- qWarning("MediaInfo process failed to create!");
- qWarning("Error message: \"%s\"\n", process.errorString().toLatin1().constData());
- process.kill();
- process.waitForFinished(-1);
- return;
+ case AnalyzeTask::fileTypeCueSheet:
+ m_filesCueSheet++;
+ break;
+ case AnalyzeTask::fileTypeUnknown:
+ m_filesRejected++;
+ break;
+ default:
+ MUTILS_THROW("Unknown file type identifier!");
}
- while(process.state() != QProcess::NotRunning)
+ //Emit all pending files
+ while(m_completedTaskIds.contains(m_tasksCounterDone))
{
- if(m_abortFlag)
+ if(m_completedFiles.contains(m_tasksCounterDone))
{
- process.kill();
- qWarning("Process was aborted on user request!");
- break;
- }
-
- if(!process.waitForReadyRead())
- {
- if(process.state() == QProcess::Running)
- {
- qWarning("MediaInfo time out. Killing process and skipping file!");
- process.kill();
- process.waitForFinished(-1);
- return;
- }
+ emit fileAnalyzed(m_completedFiles.take(m_tasksCounterDone));
}
+ m_completedTaskIds.remove(m_tasksCounterDone);
+ m_tasksCounterDone++;
+ }
+}
- while(process.canReadLine())
+void FileAnalyzer::taskThreadFinish(const unsigned int taskId)
+{
+ m_runningTaskIds.remove(taskId);
+ emit progressValChanged(++m_completedCounter);
+
+ if(!analyzeNextFile())
+ {
+ if(m_runningTaskIds.empty())
{
- QString line = QString::fromUtf8(process.readLine().constData()).simplified();
- if(!line.isEmpty())
- {
- int index = line.indexOf(':');
- if(index > 0)
- {
- QString key = line.left(index-1).trimmed();
- QString val = line.mid(index+1).trimmed();
- if(!key.isEmpty() && !val.isEmpty())
- {
- if(!key.compare("Cover_Data", Qt::CaseInsensitive))
- {
- if(val.indexOf(" ") > 0)
- {
- val = val.split(" ", QString::SkipEmptyParts, Qt::CaseInsensitive).first();
- }
- QByteArray coverData = QByteArray::fromBase64(val.toLatin1());
- QFile coverFile(QString("%1/%2.%3").arg(lamexp_temp_folder2(), lamexp_rand_str(), extension));
- if(coverFile.open(QIODevice::WriteOnly))
- {
- coverFile.write(coverData);
- coverFile.close();
- audioFile.setFileCover(coverFile.fileName(), true);
- }
- break;
- }
- }
- }
- }
+ QTimer::singleShot(0, this, SLOT(quit())); //Stop event processing, if all threads have completed!
}
}
}
unsigned int FileAnalyzer::filesRejected(void)
{
- return max(m_filesRejected - (m_filesDenied + m_filesDummyCDDA), 0);
+ return m_filesRejected;
}
unsigned int FileAnalyzer::filesDenied(void)
return m_filesDummyCDDA;
}
+unsigned int FileAnalyzer::filesCueSheet(void)
+{
+ return m_filesCueSheet;
+}
+
////////////////////////////////////////////////////////////
// EVENTS
////////////////////////////////////////////////////////////