Clementine-audio-player-Mac.../src/transcoder/transcoder.cpp

652 lines
21 KiB
C++
Raw Permalink Normal View History

/* This file is part of Clementine.
Copyright 2010, David Sansome <me@davidsansome.com>
Clementine is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Clementine is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Clementine. If not, see <http://www.gnu.org/licenses/>.
*/
#include "transcoder.h"
2010-05-06 18:28:19 +02:00
#include <QCoreApplication>
#include <QDir>
#include <QFile>
#include <QSettings>
#include <QThread>
#include <QtDebug>
2020-09-18 16:15:19 +02:00
#include <algorithm>
#include <memory>
#include "core/logging.h"
#include "core/signalchecker.h"
#include "core/utilities.h"
using std::shared_ptr;
static QString UrlToLocalFileIfPossible(QUrl url) {
if (url.isLocalFile()) return url.toLocalFile();
return url.toString();
}
2010-05-06 18:28:19 +02:00
int Transcoder::JobFinishedEvent::sEventType = -1;
TranscoderPreset::TranscoderPreset(Song::FileType type, const QString& name,
const QString& extension,
const QString& codec_mimetype,
const QString& muxer_mimetype)
: type_(type),
name_(name),
extension_(extension),
codec_mimetype_(codec_mimetype),
muxer_mimetype_(muxer_mimetype) {}
GstElement* Transcoder::CreateElement(const QString& factory_name,
GstElement* bin, const QString& name) {
GstElement* ret = gst_element_factory_make(
2015-04-11 22:52:31 +02:00
factory_name.toLatin1().constData(),
name.isNull() ? factory_name.toLatin1().constData()
: name.toLatin1().constData());
if (ret && bin) gst_bin_add(GST_BIN(bin), ret);
if (!ret) {
emit LogLine(
tr("Could not create the GStreamer element \"%1\" -"
" make sure you have all the required GStreamer plugins installed")
.arg(factory_name));
} else {
SetElementProperties(factory_name, G_OBJECT(ret));
}
return ret;
}
struct SuitableElement {
SuitableElement(const QString& name = QString(), int rank = 0)
: name_(name), rank_(rank) {}
bool operator<(const SuitableElement& other) const {
return rank_ < other.rank_;
}
QString name_;
int rank_;
};
SuitableElement Transcoder::FindBestElementForMimeType(
const QString& element_type, const QString& mime_type) {
if (element_type.isEmpty() || mime_type.isEmpty()) return SuitableElement();
// HACK: Force mp4mux because it doesn't set any useful src caps
if (mime_type == "audio/mp4") {
return SuitableElement("mp4mux", -1);
}
// Keep track of all the suitable elements we find and figure out which
// is the best at the end.
QList<SuitableElement> suitable_elements_;
// The caps we're trying to find
GstCaps* target_caps = gst_caps_from_string(mime_type.toUtf8().constData());
GstRegistry* registry = gst_registry_get();
GList* const features =
gst_registry_get_feature_list(registry, GST_TYPE_ELEMENT_FACTORY);
for (GList* p = features; p; p = g_list_next(p)) {
GstElementFactory* factory = GST_ELEMENT_FACTORY(p->data);
// Is this the right type of plugin?
2020-09-18 16:15:19 +02:00
if (QString(gst_element_factory_get_klass(factory))
.contains(element_type)) {
const GList* const templates =
gst_element_factory_get_static_pad_templates(factory);
for (const GList* p = templates; p; p = g_list_next(p)) {
// Only interested in source pads
GstStaticPadTemplate* pad_template =
reinterpret_cast<GstStaticPadTemplate*>(p->data);
if (pad_template->direction != GST_PAD_SRC) continue;
// Does this pad support the mime type we want?
GstCaps* caps = gst_static_pad_template_get_caps(pad_template);
GstCaps* intersection = gst_caps_intersect(caps, target_caps);
if (intersection) {
if (!gst_caps_is_empty(intersection)) {
int rank = gst_plugin_feature_get_rank(GST_PLUGIN_FEATURE(factory));
QString name = GST_OBJECT_NAME(factory);
if (name.startsWith("ffmux") || name.startsWith("ffenc"))
rank = -1; // ffmpeg usually sucks
suitable_elements_ << SuitableElement(name, rank);
}
gst_caps_unref(intersection);
}
}
}
}
gst_plugin_feature_list_free(features);
gst_caps_unref(target_caps);
if (suitable_elements_.isEmpty()) return SuitableElement();
// Sort by rank
std::sort(suitable_elements_.begin(), suitable_elements_.end());
return suitable_elements_.last();
}
GstElement* Transcoder::CreateElementForMimeType(const QString& element_type,
const QString& mime_type,
GstElement* bin) {
SuitableElement best = FindBestElementForMimeType(element_type, mime_type);
if (best.name_.isEmpty()) {
emit LogLine(tr("Suitable element not found"));
return nullptr;
}
emit LogLine(QString("Using '%1' (rank %2)").arg(best.name_).arg(best.rank_));
if (best.name_ == "lamemp3enc") {
// Special case: we need to add xingmux and id3v2mux to the pipeline when
// using lamemp3enc because it doesn't write the VBR or ID3v2 headers
// itself.
emit LogLine("Adding xingmux and id3v2mux to the pipeline");
// Create the bin
GstElement* mp3bin = gst_bin_new("mp3bin");
gst_bin_add(GST_BIN(bin), mp3bin);
// Create the elements
GstElement* lame = CreateElement("lamemp3enc", mp3bin);
GstElement* xing = CreateElement("xingmux", mp3bin);
GstElement* id3v2 = CreateElement("id3v2mux", mp3bin);
if (!lame || !xing || !id3v2) {
return nullptr;
}
// Link the elements together
gst_element_link_many(lame, xing, id3v2, nullptr);
// Link the bin's ghost pads to the elements on each end
GstPad* pad = gst_element_get_static_pad(lame, "sink");
gst_element_add_pad(mp3bin, gst_ghost_pad_new("sink", pad));
gst_object_unref(GST_OBJECT(pad));
pad = gst_element_get_static_pad(id3v2, "src");
gst_element_add_pad(mp3bin, gst_ghost_pad_new("src", pad));
gst_object_unref(GST_OBJECT(pad));
return mp3bin;
} else {
return CreateElement(best.name_, bin);
}
}
QString Transcoder::GetEncoderFactoryForMimeType(const QString& mime_type) {
SuitableElement best =
FindBestElementForMimeType("Codec/Encoder/Audio", mime_type);
return best.name_;
}
Transcoder::JobFinishedEvent::JobFinishedEvent(JobState* state, bool success)
: QEvent(QEvent::Type(sEventType)), state_(state), success_(success) {}
2010-05-06 18:28:19 +02:00
void Transcoder::JobState::PostFinished(bool success) {
if (success) {
emit parent_->LogLine(tr("Successfully written %1")
.arg(QDir::toNativeSeparators(job_.output)));
}
QCoreApplication::postEvent(parent_,
new Transcoder::JobFinishedEvent(this, success));
2010-05-06 18:28:19 +02:00
}
QString Transcoder::JobState::GetDisplayName() {
return job_.input.fileName() + " => " + QFileInfo(job_.output).fileName();
}
Transcoder::Transcoder(QObject* parent, const QString& settings_postfix)
: QObject(parent),
max_threads_(QThread::idealThreadCount()),
settings_postfix_(settings_postfix),
model_(new GstPipelineModel(this)) {
2010-05-06 18:28:19 +02:00
if (JobFinishedEvent::sEventType == -1)
JobFinishedEvent::sEventType = QEvent::registerEventType();
// Initialise some settings for the lamemp3enc element.
QSettings s;
s.beginGroup("Transcoder/lamemp3enc" + settings_postfix_);
if (s.value("target").isNull()) {
s.setValue("target", 1); // 1 == bitrate
}
if (s.value("cbr").isNull()) {
s.setValue("cbr", true);
}
}
2010-05-06 18:28:19 +02:00
QList<TranscoderPreset> Transcoder::GetAllPresets() {
QList<TranscoderPreset> ret;
ret << PresetForFileType(Song::Type_Flac);
ret << PresetForFileType(Song::Type_Mp4);
ret << PresetForFileType(Song::Type_Mpeg);
ret << PresetForFileType(Song::Type_OggVorbis);
ret << PresetForFileType(Song::Type_OggFlac);
ret << PresetForFileType(Song::Type_OggSpeex);
ret << PresetForFileType(Song::Type_Asf);
ret << PresetForFileType(Song::Type_Wav);
ret << PresetForFileType(Song::Type_OggOpus);
return ret;
}
QString Transcoder::MimeType(CodecType type) {
switch (type) {
case Codec_None:
return QString();
case Codec_Flac:
return "audio/x-flac";
case Codec_Mp4:
return "audio/mpeg, mpegversion=(int)4";
case Codec_Mp3:
return "audio/mpeg, mpegversion=(int)1, layer=(int)3";
case Codec_Vorbis:
return "audio/x-vorbis";
case Codec_Speex:
return "audio/x-speex";
case Codec_Opus:
return "audio/x-opus";
case Codec_Wma:
return "audio/x-wma";
}
return "unknown";
}
TranscoderPreset Transcoder::PresetForFileType(Song::FileType type) {
switch (type) {
case Song::Type_Flac:
return TranscoderPreset(type, tr("FLAC"), "flac", MimeType(Codec_Flac));
case Song::Type_Mp4:
return TranscoderPreset(type, tr("M4A AAC"), "mp4", MimeType(Codec_Mp4),
"audio/mp4");
case Song::Type_Mpeg:
return TranscoderPreset(type, tr("MP3"), "mp3", MimeType(Codec_Mp3));
case Song::Type_OggVorbis:
return TranscoderPreset(type, tr("Ogg Vorbis"), "ogg",
MimeType(Codec_Vorbis), "application/ogg");
case Song::Type_OggFlac:
return TranscoderPreset(type, tr("Ogg Flac"), "ogg", MimeType(Codec_Flac),
"application/ogg");
case Song::Type_OggSpeex:
return TranscoderPreset(type, tr("Ogg Speex"), "spx",
MimeType(Codec_Speex), "application/ogg");
case Song::Type_OggOpus:
return TranscoderPreset(type, tr("Ogg Opus"), "opus",
MimeType(Codec_Opus), "application/ogg");
case Song::Type_Asf:
return TranscoderPreset(type, tr("Windows Media audio"), "wma",
MimeType(Codec_Wma), "video/x-ms-asf");
case Song::Type_Wav:
return TranscoderPreset(type, tr("Wav"), "wav", MimeType(Codec_None),
"audio/x-wav");
default:
2011-04-22 18:50:29 +02:00
qLog(Warning) << "Unsupported format in PresetForFileType:" << type;
return TranscoderPreset();
}
}
Song::FileType Transcoder::PickBestFormat(QList<Song::FileType> supported) {
if (supported.isEmpty()) return Song::Type_Unknown;
QList<Song::FileType> best_formats;
best_formats << Song::Type_Mpeg;
best_formats << Song::Type_OggVorbis;
best_formats << Song::Type_Asf;
for (Song::FileType type : best_formats) {
if (supported.isEmpty() || supported.contains(type)) return type;
}
return supported[0];
}
void Transcoder::AddJob(const QUrl& input, const TranscoderPreset& preset,
const QString& output, bool overwrite_existing) {
Job job;
job.input = input;
job.preset = preset;
2010-05-03 23:24:43 +02:00
// Use the supplied filename if there was one, otherwise take the file
// extension off the input filename and append the correct one.
if (!output.isEmpty())
job.output = output;
else
job.output = UrlToLocalFileIfPossible(input).section('.', 0, -2) + '.' +
preset.extension_;
// Don't overwrite existing files if overwrite_existing is not set
if (!overwrite_existing && QFile::exists(job.output)) {
for (int i = 0;; ++i) {
2020-09-18 16:15:19 +02:00
QString new_filename = QString("%1.%2.%3")
.arg(job.output.section('.', 0, -2))
.arg(i)
.arg(preset.extension_);
2010-05-03 23:24:43 +02:00
if (!QFile::exists(new_filename)) {
job.output = new_filename;
break;
}
}
}
2010-05-06 18:28:19 +02:00
queued_jobs_ << job;
}
void Transcoder::AddTemporaryJob(const QUrl& input,
2020-09-18 16:15:19 +02:00
const TranscoderPreset& preset) {
AddJob(input, preset, Utilities::GetTemporaryFileName());
}
void Transcoder::Start() {
emit LogLine(tr("Transcoding %1 files using %2 threads")
.arg(queued_jobs_.count())
.arg(max_threads()));
// Kick off worker threads.
2010-05-06 18:28:19 +02:00
forever {
StartJobStatus status = MaybeStartNextJob();
if (status == AllThreadsBusy || status == NoMoreJobs) break;
2010-05-06 18:28:19 +02:00
}
}
2010-05-06 18:28:19 +02:00
Transcoder::StartJobStatus Transcoder::MaybeStartNextJob() {
if (current_jobs_.count() >= max_threads()) return AllThreadsBusy;
2010-05-06 18:28:19 +02:00
if (queued_jobs_.isEmpty()) {
if (current_jobs_.isEmpty()) {
2010-05-06 18:28:19 +02:00
emit AllJobsComplete();
}
2010-05-06 18:28:19 +02:00
return NoMoreJobs;
}
2010-05-06 18:28:19 +02:00
Job job = queued_jobs_.takeFirst();
if (StartJob(job)) {
return StartedSuccessfully;
}
emit JobComplete(job.input, job.output, false);
return FailedToStart;
}
2020-09-18 16:15:19 +02:00
void Transcoder::NewPadCallback(GstElement*, GstPad* pad, gpointer data) {
JobState* state = reinterpret_cast<JobState*>(data);
GstPad* const audiopad =
gst_element_get_static_pad(state->convert_element_, "sink");
if (GST_PAD_IS_LINKED(audiopad)) {
2011-04-22 18:50:29 +02:00
qLog(Debug) << "audiopad is already linked, unlinking old pad";
gst_pad_unlink(audiopad, GST_PAD_PEER(audiopad));
}
gst_pad_link(pad, audiopad);
gst_object_unref(audiopad);
}
GstBusSyncReply Transcoder::BusCallbackSync(GstBus*, GstMessage* msg,
gpointer data) {
JobState* state = reinterpret_cast<JobState*>(data);
switch (GST_MESSAGE_TYPE(msg)) {
case GST_MESSAGE_EOS:
2010-05-06 18:28:19 +02:00
state->PostFinished(true);
break;
case GST_MESSAGE_ERROR:
state->ReportError(msg);
2010-05-06 18:28:19 +02:00
state->PostFinished(false);
break;
default:
break;
}
return GST_BUS_PASS;
}
void Transcoder::JobState::ReportError(GstMessage* msg) {
GError* error;
gchar* debugs;
gst_message_parse_error(msg, &error, &debugs);
QString message = QString::fromLocal8Bit(error->message);
g_error_free(error);
free(debugs);
// clean up output file if it was already created
if (QFile::exists(job_.output)) {
QFile::remove(job_.output);
}
2020-09-18 16:15:19 +02:00
emit parent_->LogLine(
tr("Error processing %1: %2")
.arg(UrlToLocalFileIfPossible(job_.input), message));
}
bool Transcoder::StartJob(const Job& job) {
2010-05-06 18:28:19 +02:00
shared_ptr<JobState> state(new JobState(job, this));
emit LogLine(tr("Starting %1").arg(UrlToLocalFileIfPossible(job.input)));
2010-05-03 22:10:55 +02:00
// Create the pipeline.
// This should be a scoped_ptr, but scoped_ptr doesn't support custom
// destructors.
if (!state->Init()) return false;
// Create all the elements
GstElement* decode = CreateElement("uridecodebin", state->Pipeline());
GstElement* convert = CreateElement("audioconvert", state->Pipeline());
GstElement* resample = CreateElement("audioresample", state->Pipeline());
GstElement* codec = CreateElementForMimeType(
"Codec/Encoder/Audio", job.preset.codec_mimetype_, state->Pipeline());
GstElement* muxer = CreateElementForMimeType(
"Codec/Muxer", job.preset.muxer_mimetype_, state->Pipeline());
GstElement* sink = CreateElement("filesink", state->Pipeline());
if (!decode || !convert || !sink) return false;
if (!codec && !job.preset.codec_mimetype_.isEmpty()) {
emit LogLine(
tr("Couldn't find an encoder for %1, check you have the correct "
"GStreamer plugins installed")
.arg(job.preset.codec_mimetype_));
return false;
}
if (!muxer && !job.preset.muxer_mimetype_.isEmpty()) {
emit LogLine(tr("Couldn't find a muxer for %1, check you have the correct "
"GStreamer plugins installed")
.arg(job.preset.muxer_mimetype_));
return false;
}
// Join them together
if (codec && muxer)
gst_element_link_many(convert, resample, codec, muxer, sink, nullptr);
else if (codec)
gst_element_link_many(convert, resample, codec, sink, nullptr);
else if (muxer)
gst_element_link_many(convert, resample, muxer, sink, nullptr);
// Set properties
g_object_set(decode, "uri", job.input.toString().toUtf8().constData(),
nullptr);
g_object_set(sink, "location", job.output.toUtf8().constData(), nullptr);
// Create target directory, if it does not exist
QFileInfo output_file_path(job.output);
output_file_path.dir().mkpath(".");
// Set callbacks
2010-05-06 18:28:19 +02:00
state->convert_element_ = convert;
CHECKED_GCONNECT(decode, "pad-added", &NewPadCallback, state.get());
gst_bus_set_sync_handler(
gst_pipeline_get_bus(GST_PIPELINE(state->Pipeline())), BusCallbackSync,
state.get(), nullptr);
2010-05-06 18:28:19 +02:00
// Start the pipeline
gst_element_set_state(state->Pipeline(), GST_STATE_PLAYING);
2010-05-06 18:28:19 +02:00
// GStreamer now transcodes in another thread, so we can return now and do
// something else. Keep the JobState object around. It'll post an event
// to our event loop when it finishes.
current_jobs_ << state;
model_->AddPipeline(state->id(), state->GetDisplayName());
2010-05-06 18:28:19 +02:00
return true;
}
2010-05-06 18:28:19 +02:00
bool Transcoder::event(QEvent* e) {
if (e->type() == JobFinishedEvent::sEventType) {
JobFinishedEvent* finished_event = static_cast<JobFinishedEvent*>(e);
// Find this job in the list
JobStateList::iterator it = current_jobs_.begin();
while (it != current_jobs_.end()) {
if (it->get() == finished_event->state_) break;
2010-05-06 18:28:19 +02:00
++it;
}
if (it == current_jobs_.end()) {
// Couldn't find it, maybe GStreamer gave us an event after we'd destroyed
// the pipeline?
return true;
}
QUrl input = (*it)->job_.input;
QString output = (*it)->job_.output;
2010-05-06 18:28:19 +02:00
// Remove event handlers from the gstreamer pipeline so they don't get
// called after the pipeline is shutting down
gst_bus_set_sync_handler(
gst_pipeline_get_bus(GST_PIPELINE(finished_event->state_->Pipeline())),
nullptr, nullptr, nullptr);
2010-05-06 18:28:19 +02:00
// Remove it from the list - this will also destroy the GStreamer pipeline
model_->RemovePipeline((*it)->id());
2010-05-06 18:28:19 +02:00
current_jobs_.erase(it);
// Emit the finished signal
emit JobComplete(input, output, finished_event->success_);
2010-05-06 18:28:19 +02:00
// Start some more jobs
MaybeStartNextJob();
return true;
}
return QObject::event(e);
}
2010-05-06 18:28:19 +02:00
void Transcoder::Cancel() {
// Remove all pending jobs
queued_jobs_.clear();
// Stop the running ones
JobStateList::iterator it = current_jobs_.begin();
while (it != current_jobs_.end()) {
shared_ptr<JobState> state(*it);
// Remove event handlers from the gstreamer pipeline so they don't get
// called after the pipeline is shutting down
2020-09-18 16:15:19 +02:00
gst_bus_set_sync_handler(
gst_pipeline_get_bus(GST_PIPELINE(state->Pipeline())), nullptr, nullptr,
2020-09-18 16:15:19 +02:00
nullptr);
2010-05-06 18:28:19 +02:00
// Stop the pipeline
if (gst_element_set_state(state->Pipeline(), GST_STATE_NULL) ==
GST_STATE_CHANGE_ASYNC) {
2010-05-06 18:28:19 +02:00
// Wait for it to finish stopping...
gst_element_get_state(state->Pipeline(), nullptr, nullptr,
GST_CLOCK_TIME_NONE);
2010-05-06 18:28:19 +02:00
}
// Remove the job, this destroys the GStreamer pipeline too
model_->RemovePipeline((*it)->id());
2010-05-06 18:28:19 +02:00
it = current_jobs_.erase(it);
}
}
void Transcoder::DumpGraph(int id) {
for (JobStateList::iterator it = current_jobs_.begin();
it != current_jobs_.end(); it++) {
if ((*it)->id() == id) {
(*it)->DumpGraph();
}
}
}
QMap<QUrl, float> Transcoder::GetProgress() const {
QMap<QUrl, float> ret;
for (const auto& state : current_jobs_) {
if (!state->Pipeline()) continue;
gint64 position = 0;
gint64 duration = 0;
gst_element_query_position(state->Pipeline(), GST_FORMAT_TIME, &position);
gst_element_query_duration(state->Pipeline(), GST_FORMAT_TIME, &duration);
ret[state->job_.input] = float(position) / duration;
}
return ret;
}
void Transcoder::SetElementProperties(const QString& name, GObject* object) {
QSettings s;
s.beginGroup("Transcoder/" + name + settings_postfix_);
guint properties_count = 0;
GParamSpec** properties = g_object_class_list_properties(
G_OBJECT_GET_CLASS(object), &properties_count);
for (int i = 0; i < properties_count; ++i) {
GParamSpec* property = properties[i];
const QVariant value = s.value(property->name);
if (value.isNull()) continue;
emit LogLine(QString("Setting %1 property: %2 = %3")
.arg(name, property->name, value.toString()));
switch (property->value_type) {
case G_TYPE_DOUBLE:
g_object_set(object, property->name, value.toDouble(), nullptr);
break;
case G_TYPE_FLOAT:
g_object_set(object, property->name, value.toFloat(), nullptr);
break;
case G_TYPE_BOOLEAN:
g_object_set(object, property->name, value.toInt(), nullptr);
break;
case G_TYPE_INT:
default:
g_object_set(object, property->name, value.toInt(), nullptr);
break;
}
}
g_free(properties);
}