MetadataParser.cpp 18.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*****************************************************************************
 * Media Library
 *****************************************************************************
 * Copyright (C) 2015 Hugo Beauzée-Luyssen, Videolabs
 *
 * Authors: Hugo Beauzée-Luyssen<hugo@beauzee.fr>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

23 24 25 26
#if HAVE_CONFIG_H
# include "config.h"
#endif

27 28 29 30 31
#include "MetadataParser.h"
#include "Album.h"
#include "AlbumTrack.h"
#include "Artist.h"
#include "File.h"
32
#include "Genre.h"
33 34 35
#include "Media.h"
#include "Show.h"
#include "utils/Filename.h"
36
#include "utils/ModificationsNotifier.h"
37
#include <cstdlib>
38

39 40 41
namespace medialibrary
{

42 43 44 45 46
MetadataParser::MetadataParser()
    : m_previousFolderId( 0 )
{
}

47 48
bool MetadataParser::initialize()
{
49
    m_unknownArtist = Artist::fetch( m_ml, UnknownArtistID );
50 51 52 53 54
    if ( m_unknownArtist == nullptr )
        LOG_ERROR( "Failed to cache unknown artist" );
    return m_unknownArtist != nullptr;
}

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
int MetadataParser::toInt( VLC::Media& vlcMedia, libvlc_meta_t meta, const char* name )
{
    auto str = vlcMedia.meta( meta );
    if ( str.empty() == false )
    {
        try
        {
            return std::stoi( str );
        }
        catch( std::logic_error& ex)
        {
            LOG_WARN( "Invalid ", name, " provided (", str, "): ", ex.what() );
        }
    }
    return 0;
}

72 73 74
parser::Task::Status MetadataParser::run( parser::Task& task )
{
    auto& media = task.media;
75
    const auto& tracks = task.vlcMedia.tracks();
76 77 78 79 80

    // If we failed to extract any tracks, don't make any assumption and forward to the
    // thumbnailer. Since it starts an actual playback, it will have more information.
    // Since the metadata steps won't be marked, it will run again once the thumbnailer has completed.
    if ( tracks.empty() == true )
81 82
    {
        // However, if the file is not unknown anymore, it means the thumbnailer has already processed it
83
        if ( task.media->type() == Media::Type::Unknown )
84
        {
85 86 87 88 89
            // In case the thumbnailer ran before, but the application exited, we would skip the
            // thumbnailer execution, coming back here, and delegating again to the thumbnailer
            // over and over again. We need to ensure the thumbnailer will run, even partially, up to
            // the point the playback started.
            task.file->markStepUncompleted( File::ParserStep::Thumbnailer );
90
            LOG_INFO( "Skipping metadata parsing for file with unknown type: ", task.file->mrl() );
91
            return parser::Task::Status::Success;
92
        }
93 94 95
        // In that case, stop trying to do something with this file.
        return parser::Task::Status::Fatal;
    }
96

97
    bool isAudio = true;
98
    {
99
        auto t = m_ml->getConn()->newTransaction();
100
        for ( const auto& t : tracks )
101
        {
102 103 104 105 106 107 108 109 110 111 112 113 114 115
            auto codec = t.codec();
            std::string fcc( reinterpret_cast<const char*>( &codec ), 4 );
            if ( t.type() == VLC::MediaTrack::Type::Video )
            {
                media->addVideoTrack( fcc, t.width(), t.height(),
                                      static_cast<float>( t.fpsNum() ) / static_cast<float>( t.fpsDen() ),
                                      t.language(), t.description() );
                isAudio = false;
            }
            else if ( t.type() == VLC::MediaTrack::Type::Audio )
            {
                media->addAudioTrack( fcc, t.bitrate(), t.rate(), t.channels(),
                                      t.language(), t.description() );
            }
116
        }
117
        media->setDuration( task.vlcMedia.duration() );
118
        t->commit();
119 120 121
    }
    if ( isAudio == true )
    {
122
        if ( parseAudioFile( task ) == false )
123 124 125 126
            return parser::Task::Status::Fatal;
    }
    else
    {
127
        if (parseVideoFile( task ) == false )
128 129
            return parser::Task::Status::Fatal;
    }
130

131 132 133
    if ( task.file->isDeleted() == true || task.media->isDeleted() == true )
        return parser::Task::Status::Fatal;

134
    task.file->markStepCompleted( File::ParserStep::MetadataAnalysis );
135 136 137 138
    // Save ourselves from the useless processing of a thumbnail later if
    // we're analyzing an audio file
    if ( isAudio == true )
        task.file->markStepCompleted( File::ParserStep::Thumbnailer );
139
    if ( task.file->saveParserStep() == false )
140
        return parser::Task::Status::Fatal;
141
    m_notifier->notifyMediaCreation( media );
142 143 144 145 146
    return parser::Task::Status::Success;
}

/* Video files */

147
bool MetadataParser::parseVideoFile( parser::Task& task ) const
148
{
149
    auto media = task.media.get();
150
    media->setType( IMedia::Type::Video );
151 152
    const auto& title = task.vlcMedia.meta( libvlc_meta_Title );
    if ( title.length() == 0 )
153
        return true;
154

155 156
    const auto& showName = task.vlcMedia.meta( libvlc_meta_ShowName );
    if ( showName.length() == 0 )
157
    {
158 159
        auto t = m_ml->getConn()->newTransaction();

160
        auto show = m_ml->show( showName );
161 162
        if ( show == nullptr )
        {
163
            show = m_ml->createShow( showName );
164 165 166
            if ( show == nullptr )
                return false;
        }
167 168
        auto episode = toInt( task.vlcMedia, libvlc_meta_Episode, "episode number" );
        if ( episode != 0 )
169 170
        {
            std::shared_ptr<Show> s = std::static_pointer_cast<Show>( show );
171
            s->addEpisode( *media, title, episode );
172
        }
173 174
        task.media->save();
        t->commit();
175 176 177 178 179 180 181 182 183 184
    }
    else
    {
        // How do we know if it's a movie or a random video?
    }
    return true;
}

/* Audio files */

185
bool MetadataParser::parseAudioFile( parser::Task& task )
186
{
187
    task.media->setType( IMedia::Type::Audio );
188

189 190 191
    const auto artworkMrl = task.vlcMedia.meta( libvlc_meta_ArtworkURL );
    if ( artworkMrl.empty() == false )
        task.media->setThumbnail( artworkMrl );
192

193
    auto genre = handleGenre( task );
194
    auto artists = findOrCreateArtist( task );
195 196
    if ( artists.first == nullptr && artists.second == nullptr )
        return false;
197 198
    auto album = findAlbum( task, artists.first, artists.second );
    auto t = m_ml->getConn()->newTransaction();
199 200
    if ( album == nullptr )
    {
201 202
        const auto& albumName = task.vlcMedia.meta( libvlc_meta_Album );
        album = m_ml->createAlbum( albumName, artworkMrl );
203 204 205
        if ( album == nullptr )
            return false;
        m_notifier->notifyAlbumCreation( album );
206
    }
207
    // If we know a track artist, specify it, otherwise, fallback to the album/unknown artist
208 209
    auto track = handleTrack( album, task, artists.second ? artists.second : artists.first,
                              genre.get() );
210

211
    auto res = link( *task.media, album, artists.first, artists.second );
212
    task.media->save();
213 214 215 216
    t->commit();
    return res;
}

217 218
std::shared_ptr<Genre> MetadataParser::handleGenre( parser::Task& task ) const
{
219 220
    const auto& genreStr = task.vlcMedia.meta( libvlc_meta_Genre );
    if ( genreStr.length() == 0 )
221
        return nullptr;
222
    auto genre = Genre::fromName( m_ml, genreStr );
223 224
    if ( genre == nullptr )
    {
225
        genre = Genre::create( m_ml, genreStr );
226
        if ( genre == nullptr )
227
            LOG_ERROR( "Failed to get/create Genre", genreStr );
228 229 230 231
    }
    return genre;
}

232
/* Album handling */
233 234

std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, std::shared_ptr<Artist> albumArtist,
235
                                                    std::shared_ptr<Artist> trackArtist )
236
{
237 238
    const auto& albumName = task.vlcMedia.meta( libvlc_meta_Album );
    if ( albumName.empty() == true )
239
    {
240 241 242 243 244 245
        std::shared_ptr<Artist> artist = albumArtist;
        if ( albumArtist != nullptr )
            return albumArtist->unknownAlbum();
        else if ( trackArtist != nullptr )
            return trackArtist->unknownAlbum();
        return m_unknownArtist->unknownAlbum();
246 247
    }

248 249 250 251 252 253
    if ( m_previousAlbum != nullptr && albumName == m_previousAlbum->title() &&
         m_previousFolderId != 0 && task.file->folderId() == m_previousFolderId )
        return m_previousAlbum;
    m_previousAlbum.reset();
    m_previousFolderId = 0;

254 255
    // Album matching depends on the difference between artist & album artist.
    // Specificaly pass the albumArtist here.
256 257
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
258
    auto albums = Album::fetchAll<Album>( m_ml, req, albumName );
259 260 261 262

    if ( albums.size() == 0 )
        return nullptr;

263 264
    const auto discTotal = toInt( task.vlcMedia, libvlc_meta_DiscTotal, "disc total" );
    const auto discNumber = toInt( task.vlcMedia, libvlc_meta_DiscNumber, "dist number" );
265 266 267 268 269
    /*
     * Even if we get only 1 album, we need to filter out invalid matches.
     * For instance, if we have already inserted an album "A" by an artist "john"
     * but we are now trying to handle an album "A" by an artist "doe", not filtering
     * candidates would yield the only "A" album we know, while we should return
270
     * nullptr, so the link() method can create a new one.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
     */
    for ( auto it = begin( albums ); it != end( albums ); )
    {
        auto a = (*it).get();
        if ( albumArtist != nullptr )
        {
            // We assume that an album without album artist is a positive match.
            // At the end of the day, without proper tags, there's only so much we can do.
            auto candidateAlbumArtist = a->albumArtist();
            if ( candidateAlbumArtist != nullptr && candidateAlbumArtist->id() != albumArtist->id() )
            {
                it = albums.erase( it );
                continue;
            }
        }
        // If this is a multidisc album, assume it could be in a multiple amount of folders.
        // Since folders can come in any order, we can't assume the first album will be the
        // first media we see. If the discTotal or discNumber meta are provided, that's easy. If not,
        // we assume that another CD with the same name & artists, and a disc number > 1
        // denotes a multi disc album
        // Check the first case early to avoid fetching tracks if unrequired.
292
        if ( discTotal > 1 || discNumber > 1 )
293 294 295 296
        {
            ++it;
            continue;
        }
297
        const auto tracks = a->cachedTracks();
298 299 300 301 302 303 304
        // If there is no tracks to compare with, we just have to hope this will be the only valid
        // album match
        if ( tracks.size() == 0 )
        {
            ++it;
            continue;
        }
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323

        auto multiDisc = false;
        for ( auto& t : tracks )
        {
            auto at = t->albumTrack();
            assert( at != nullptr );
            if ( at != nullptr && at->discNumber() > 1 )
            {
                multiDisc = true;
                break;
            }
        }
        if ( multiDisc )
        {
            ++it;
            continue;
        }

        // Assume album files will be in the same folder.
324
        auto newFileFolder = utils::file::directory( task.file->mrl() );
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
        auto trackFiles = tracks[0]->files();
        bool excluded = false;
        for ( auto& f : trackFiles )
        {
            auto candidateFolder = utils::file::directory( f->mrl() );
            if ( candidateFolder != newFileFolder )
            {
                excluded = true;
                break;
            }
        }
        if ( excluded == true )
        {
            it = albums.erase( it );
            continue;
        }
        ++it;
    }
    if ( albums.size() == 0 )
        return nullptr;
    if ( albums.size() > 1 )
    {
347
        LOG_WARN( "Multiple candidates for album ", albumName, ". Selecting first one out of luck" );
348
    }
349 350 351
    m_previousFolderId = task.file->folderId();
    m_previousAlbum = albums[0];
    return albums[0];
352 353 354 355
}

///
/// \brief MetadataParser::handleArtists Returns Artist's involved on a track
356
/// \param task The current parser task
357 358 359 360
/// \return A pair containing:
/// The album artist as a first element
/// The track artist as a second element, or nullptr if it is the same as album artist
///
361
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::findOrCreateArtist( parser::Task& task ) const
362 363 364
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;
365
    static const std::string req = "SELECT * FROM " + policy::ArtistTable::Name + " WHERE name = ?";
366

367 368 369
    const auto& albumArtistStr = task.vlcMedia.meta( libvlc_meta_AlbumArtist );
    const auto& artistStr = task.vlcMedia.meta( libvlc_meta_Artist );
    if ( albumArtistStr.empty() == true && artistStr.empty() == true )
370
    {
371
        return {m_unknownArtist, m_unknownArtist};
372 373
    }

374
    if ( albumArtistStr.empty() == false )
375
    {
376
        albumArtist = Artist::fetch( m_ml, req, albumArtistStr );
377 378
        if ( albumArtist == nullptr )
        {
379
            albumArtist = m_ml->createArtist( albumArtistStr );
380 381
            if ( albumArtist == nullptr )
            {
382
                LOG_ERROR( "Failed to create new artist ", albumArtistStr );
383 384
                return {nullptr, nullptr};
            }
385
            m_notifier->notifyArtistCreation( albumArtist );
386 387
        }
    }
388
    if ( artistStr.empty() == false && artistStr != albumArtistStr )
389
    {
390
        artist = Artist::fetch( m_ml, req, artistStr );
391 392
        if ( artist == nullptr )
        {
393
            artist = m_ml->createArtist( artistStr );
394 395
            if ( artist == nullptr )
            {
396
                LOG_ERROR( "Failed to create new artist ", artistStr );
397 398
                return {nullptr, nullptr};
            }
399
            m_notifier->notifyArtistCreation( albumArtist );
400 401 402 403 404 405 406
        }
    }
    return {albumArtist, artist};
}

/* Tracks handling */

407 408
std::shared_ptr<AlbumTrack> MetadataParser::handleTrack( std::shared_ptr<Album> album, parser::Task& task,
                                                         std::shared_ptr<Artist> artist, Genre* genre ) const
409
{
410 411 412
    auto title = task.vlcMedia.meta( libvlc_meta_Title );
    const auto trackNumber = toInt( task.vlcMedia, libvlc_meta_TrackNumber, "track number" );
    const auto discNumber = toInt( task.vlcMedia, libvlc_meta_DiscNumber, "disc number" );
413 414 415
    if ( title.empty() == true )
    {
        LOG_WARN( "Failed to get track title" );
416
        if ( trackNumber != 0 )
417 418
        {
            title = "Track #";
419
            title += std::to_string( trackNumber );
420 421 422
        }
    }
    if ( title.empty() == false )
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
423
        task.media->setTitleBuffered( title );
424

425 426
    auto track = std::static_pointer_cast<AlbumTrack>( album->addTrack( task.media, trackNumber,
                                                                        discNumber, artist->id(),
427
                                                                        genre ) );
428 429 430 431 432
    if ( track == nullptr )
    {
        LOG_ERROR( "Failed to create album track" );
        return nullptr;
    }
433

434 435
    const auto& releaseDate = task.vlcMedia.meta( libvlc_meta_Date );
    if ( releaseDate.empty() == false )
436
    {
437
        auto releaseYear = atoi( releaseDate.c_str() );
438
        task.media->setReleaseDate( releaseYear );
439 440 441 442 443
        // Let the album handle multiple dates. In order to do this properly, we need
        // to know if the date has been changed before, which can be known only by
        // using Album class internals.
        album->setReleaseYear( releaseYear, false );
    }
444
    m_notifier->notifyAlbumTrackCreation( track );
445 446 447 448 449 450
    return track;
}

/* Misc */

bool MetadataParser::link( Media& media, std::shared_ptr<Album> album,
451
                               std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> artist )
452
{
453 454
    if ( albumArtist == nullptr )
        albumArtist = artist;
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

    // We might modify albumArtist later, hence handle thumbnails before.
    // If we have an albumArtist (meaning the track was properly tagged, we
    // can assume this artist is a correct match. We can use the thumbnail from
    // the current album for the albumArtist, if none has been set before.
    if ( albumArtist != nullptr && albumArtist->artworkMrl().empty() == true &&
         album != nullptr && album->artworkMrl().empty() == false )
        albumArtist->setArtworkMrl( album->artworkMrl() );

    if ( albumArtist != nullptr )
        albumArtist->addMedia( media );
    if ( artist != nullptr && ( albumArtist == nullptr || albumArtist->id() != artist->id() ) )
        artist->addMedia( media );

    auto currentAlbumArtist = album->albumArtist();

    // If we have no main artist yet, that's easy, we need to assign one.
    if ( currentAlbumArtist == nullptr )
    {
        // We don't know if the artist was tagged as artist or albumartist, however, we simply add it
        // as the albumartist until proven we were wrong (ie. until one of the next tracks
        // has a different artist)
477
        album->setAlbumArtist( albumArtist );
478 479 480 481 482 483 484 485 486 487
        // Always add the album artist as an artist
        album->addArtist( albumArtist );
        if ( artist != nullptr )
            album->addArtist( artist );
    }
    else
    {
        if ( albumArtist->id() != currentAlbumArtist->id() )
        {
            // We have more than a single artist on this album, fallback to various artists
488 489 490
            if ( m_variousArtists == nullptr )
                m_variousArtists = Artist::fetch( m_ml, VariousArtistID );
            album->setAlbumArtist( m_variousArtists );
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
            // Add those two artists as "featuring".
            album->addArtist( albumArtist );
        }
        if ( artist != nullptr && artist->id() != albumArtist->id() )
        {
            if ( albumArtist->id() != artist->id() )
               album->addArtist( artist );
        }
    }

    return true;
}

const char* MetadataParser::name() const
{
    return "Metadata";
}
508 509 510 511 512 513 514 515 516 517

uint8_t MetadataParser::nbThreads() const
{
//    auto nbProcs = std::thread::hardware_concurrency();
//    if ( nbProcs == 0 )
//        return 1;
//    return nbProcs;
    // Let's make this code thread-safe first :)
    return 1;
}
518

519
bool MetadataParser::isCompleted( const parser::Task& task ) const
520
{
521 522 523
    // We always need to run this task if the metadata extraction isn't completed
    return ( static_cast<uint8_t>( task.file->parserStep() ) &
            static_cast<uint8_t>( File::ParserStep::MetadataAnalysis ) ) != 0;
524 525
}

526
}