MetadataParser.cpp 31.8 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 33 34
#include "filesystem/IDevice.h"
#include "filesystem/IDirectory.h"
#include "Folder.h"
35
#include "Genre.h"
36
#include "Media.h"
37
#include "Playlist.h"
38
#include "Show.h"
39
#include "utils/Directory.h"
40
#include "utils/Filename.h"
41
#include "utils/Url.h"
42
#include "utils/ModificationsNotifier.h"
43 44 45
#include "discoverer/FsDiscoverer.h"
#include "discoverer/probe/PathProbe.h"

46
#include <cstdlib>
47

48 49 50
namespace medialibrary
{

51
MetadataParser::MetadataParser()
52 53
    : m_ml( nullptr )
    , m_previousFolderId( 0 )
54 55 56
{
}

57
bool MetadataParser::cacheUnknownArtist()
58
{
59
    m_unknownArtist = Artist::fetch( m_ml, UnknownArtistID );
60 61 62 63 64
    if ( m_unknownArtist == nullptr )
        LOG_ERROR( "Failed to cache unknown artist" );
    return m_unknownArtist != nullptr;
}

65 66 67 68
bool MetadataParser::initialize( MediaLibrary* ml)
{
    m_ml = ml;
    m_notifier = ml->getNotifier();
69
    return cacheUnknownArtist();
70 71
}

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
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;
}

89 90
parser::Task::Status MetadataParser::run( parser::Task& task )
{
91 92 93 94 95 96 97 98 99 100 101
    bool alreadyInParser = false;
    int nbSubitem = task.vlcMedia.subitems()->count();
    // Assume that file containing subitem(s) is a Playlist
    if ( nbSubitem > 0 )
    {
        auto res = addPlaylistMedias( task, nbSubitem );
        if ( res == false ) // playlist addition may fail due to constraint violation
            return parser::Task::Status::Fatal;

        assert( task.file != nullptr );
        task.markStepCompleted( parser::Task::ParserStep::Completed );
102
        task.saveParserStep();
103 104 105
        return parser::Task::Status::Success;
    }

106
    if ( task.file == nullptr )
107
    {
108
        assert( task.media == nullptr );
109 110
        // Try to create Media & File
        try
111
        {
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
            auto t = m_ml->getConn()->newTransaction();
            LOG_INFO( "Adding ", task.mrl );
            task.media = Media::create( m_ml, IMedia::Type::Unknown, utils::file::fileName( task.mrl ) );
            if ( task.media == nullptr )
            {
                LOG_ERROR( "Failed to add media ", task.mrl, " to the media library" );
                return parser::Task::Status::Fatal;
            }
            // For now, assume all media are made of a single file
            task.file = task.media->addFile( *task.fileFs, task.parentFolder->id(),
                                             task.parentFolderFs->device()->isRemovable(),
                                             File::Type::Main );
            if ( task.file == nullptr )
            {
                LOG_ERROR( "Failed to add file ", task.mrl, " to media #", task.media->id() );
                return parser::Task::Status::Fatal;
            }
129
            task.updateFileId();
130
            t->commit();
131
        }
132 133
        // Voluntarily trigger an exception for a valid, but less common case, to avoid database overhead
        catch ( sqlite::errors::ConstraintViolation& ex )
134
        {
135 136 137 138 139 140 141 142 143 144 145 146 147 148
            LOG_INFO( "Creation of Media & File failed because ", ex.what(),
                      ". Assuming this task is a duplicate" );
            // Try to retrieve file & Media from database
            auto fileInDB = File::fromMrl( m_ml, task.mrl );
            if ( fileInDB == nullptr ) // The file is no longer present in DB, gracefully delete task
            {
                LOG_ERROR( "File ", task.mrl, " no longer present in DB, aborting");
                return parser::Task::Status::Fatal;
            }
            task.file = fileInDB;
            task.media = fileInDB->media();
            if ( task.media == nullptr ) // Without a media, we cannot go further
                return parser::Task::Status::Fatal;
            alreadyInParser = true;
149
        }
150
    }
151 152 153 154 155 156 157 158 159
    else if ( task.media == nullptr )
    {
        // If we have a file but no media, this is a problem, we can analyze as
        // much as we want, but won't be able to store anything.
        // Keep in mind that if we are in this code path, we are not analyzing
        // a playlist.
        assert( false );
        return parser::Task::Status::Fatal;
    }
160 161 162 163 164 165

    if ( task.parentPlaylist != nullptr )
        task.parentPlaylist->add( task.media->id(), task.parentPlaylistIndex );

    if ( alreadyInParser == true )
    {
166 167
        // Let the worker drop this duplicate task
        task.markStepCompleted( parser::Task::ParserStep::Completed );
168 169
        // And remove it from DB
        task.destroy( m_ml, task.id() );
170
        return parser::Task::Status::Success;
171 172
    }

173
    const auto& tracks = task.vlcMedia.tracks();
174 175

    if ( tracks.empty() == true )
176
        return parser::Task::Status::Fatal;
177

178
    bool isAudio = true;
179
    {
180 181 182
        using TracksT = decltype( tracks );
        sqlite::Tools::withRetries( 3, [this, &isAudio, &task]( TracksT tracks ) {
            auto t = m_ml->getConn()->newTransaction();
183
            for ( const auto& track : tracks )
184
            {
185
                auto codec = track.codec();
186
                std::string fcc( reinterpret_cast<const char*>( &codec ), 4 );
187
                if ( track.type() == VLC::MediaTrack::Type::Video )
188
                {
189 190 191
                    task.media->addVideoTrack( fcc, track.width(), track.height(),
                                          static_cast<float>( track.fpsNum() ) / static_cast<float>( track.fpsDen() ),
                                          track.language(), track.description() );
192 193
                    isAudio = false;
                }
194
                else if ( track.type() == VLC::MediaTrack::Type::Audio )
195
                {
196 197
                    task.media->addAudioTrack( fcc, track.bitrate(), track.rate(), track.channels(),
                                          track.language(), track.description() );
198
                }
199
            }
200 201 202
            task.media->setDuration( task.vlcMedia.duration() );
            t->commit();
        }, std::move( tracks ) );
203 204 205
    }
    if ( isAudio == true )
    {
206
        if ( parseAudioFile( task ) == false )
207 208 209 210
            return parser::Task::Status::Fatal;
    }
    else
    {
211
        if (parseVideoFile( task ) == false )
212 213
            return parser::Task::Status::Fatal;
    }
214

215 216 217
    if ( task.file->isDeleted() == true || task.media->isDeleted() == true )
        return parser::Task::Status::Fatal;

218
    task.markStepCompleted( parser::Task::ParserStep::MetadataAnalysis );
219
    if ( task.saveParserStep() == false )
220
        return parser::Task::Status::Fatal;
221
    m_notifier->notifyMediaCreation( task.media );
222 223 224
    return parser::Task::Status::Success;
}

225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
/* Playlist files */

bool MetadataParser::addPlaylistMedias( parser::Task& task, int nbSubitem ) const
{
    auto t = m_ml->getConn()->newTransaction();
    LOG_INFO( "Try to import ", task.mrl, " as a playlist" );
    auto playlistName = task.vlcMedia.meta( libvlc_meta_Title );
    if ( playlistName.empty() == true )
        playlistName = utils::url::decode( utils::file::fileName( task.mrl ) );
    auto playlistPtr = Playlist::create( m_ml, playlistName );
    if ( playlistPtr == nullptr )
    {
        LOG_ERROR( "Failed to create playlist ", task.mrl, " to the media library" );
        return false;
    }
    task.file = playlistPtr->addFile( *task.fileFs, task.parentFolder->id(), task.parentFolderFs->device()->isRemovable() );
    if ( task.file == nullptr )
    {
        LOG_ERROR( "Failed to add playlist file ", task.mrl );
        return false;
    }
    t->commit();
    auto subitems = task.vlcMedia.subitems();
    for ( int i = 0; i < nbSubitem; ++i ) // FIXME: Interrupt loop if paused
        addPlaylistElement( task, playlistPtr, subitems->itemAtIndex( i ), static_cast<unsigned int>( i ) + 1 );

    return true;
}

void MetadataParser::addPlaylistElement( parser::Task& task, const std::shared_ptr<Playlist>& playlistPtr,
                                         VLC::MediaPtr subitem, unsigned int index ) const
{
    if ( subitem == nullptr )
        return;
    const auto& mrl = subitem->mrl();
    LOG_INFO( "Try to add ", mrl, " to the playlist ", task.mrl );
    auto media = m_ml->media( mrl );
    if ( media != nullptr )
    {
        LOG_INFO( "Media for ", mrl, " already exists, adding it to the playlist ", task.mrl );
        playlistPtr->add( media->id(), index );
        return;
    }
    // Create Media, etc.
    auto fsFactory = m_ml->fsFactoryForMrl( mrl );

    if ( fsFactory == nullptr ) // Media not supported by any FsFactory, registering it as external
    {
        auto t2 = m_ml->getConn()->newTransaction();
        auto externalMedia = Media::create( m_ml, IMedia::Type::Unknown, utils::url::encode(
                subitem->meta( libvlc_meta_Title ) ) );
        if ( externalMedia == nullptr )
        {
            LOG_ERROR( "Failed to create external media for ", mrl, " in the playlist ", task.mrl );
            return;
        }
        // Assuming that external mrl present in playlist file is a main media resource
        auto externalFile = externalMedia->addExternalMrl( mrl, IFile::Type::Main );
        if ( externalFile == nullptr )
            LOG_ERROR( "Failed to create external file for ", mrl, " in the playlist ", task.mrl );
        playlistPtr->add( externalMedia->id(), index );
        t2->commit();
        return;
    }
    bool isDirectory;
    try
    {
        isDirectory = utils::fs::isDirectory( utils::file::toLocalPath( mrl ) );
    }
    catch ( std::system_error& ex )
    {
        LOG_ERROR( ex.what() );
        return;
    }
    LOG_INFO( "Importing ", isDirectory ? "folder " : "file ", mrl, " in the playlist ", task.mrl );
    auto directoryMrl = utils::file::directory( mrl );
    auto parentFolder = Folder::fromMrl( m_ml, directoryMrl );
    bool parentKnown = parentFolder != nullptr;

304 305 306 307 308 309 310 311
    // The minimal entrypoint must be a device mountpoint
    auto device = fsFactory->createDeviceFromMrl( mrl );
    if ( device == nullptr )
    {
        LOG_ERROR( "Can't add a local folder with unknown storage device. ");
        return;
    }
    auto entryPoint = device->mountpoint();
312 313 314 315 316
    if ( parentKnown == false && Folder::fromMrl( m_ml, entryPoint ) != nullptr )
    {
        auto probePtr = std::unique_ptr<prober::PathProbe>( new prober::PathProbe{ utils::file::stripScheme( mrl ),
                                                                                   isDirectory, playlistPtr, parentFolder,
                                                                                   utils::file::stripScheme( directoryMrl ), index, true } );
317
        FsDiscoverer discoverer( fsFactory, m_ml, nullptr, std::move( probePtr ) );
318 319 320 321 322 323
        discoverer.reload( entryPoint );
        return;
    }
    auto probePtr = std::unique_ptr<prober::PathProbe>( new prober::PathProbe{ utils::file::stripScheme( mrl ),
                                                                               isDirectory, playlistPtr, parentFolder,
                                                                               utils::file::stripScheme( directoryMrl ), index, false } );
324
    FsDiscoverer discoverer( fsFactory, m_ml, nullptr, std::move( probePtr ) );
325 326 327
    if ( parentKnown == false )
    {
        discoverer.discover( entryPoint );
328 329 330
        auto entryFolder = Folder::fromMrl( m_ml, entryPoint );
        if ( entryFolder != nullptr )
            Folder::excludeEntryFolder( m_ml, entryFolder->id() );
331 332 333 334 335
        return;
    }
    discoverer.reload( directoryMrl );
}

336 337
/* Video files */

338
bool MetadataParser::parseVideoFile( parser::Task& task ) const
339
{
340
    auto media = task.media.get();
341
    media->setType( IMedia::Type::Video );
342 343
    const auto& title = task.vlcMedia.meta( libvlc_meta_Title );
    if ( title.length() == 0 )
344
        return true;
345

346
    const auto& showName = task.vlcMedia.meta( libvlc_meta_ShowName );
347
    const auto& artworkMrl = task.vlcMedia.meta( libvlc_meta_ArtworkURL );
348

349
    return sqlite::Tools::withRetries( 3, [this, &showName, &title, &task, &artworkMrl]() {
350 351 352
        auto t = m_ml->getConn()->newTransaction();
        task.media->setTitleBuffered( title );

353 354 355
        if ( artworkMrl.empty() == false )
            task.media->setThumbnail( artworkMrl, Thumbnail::Origin::Media );

356 357
        if ( showName.length() != 0 )
        {
358
            auto show = m_ml->show( showName );
359
            if ( show == nullptr )
360 361 362 363 364 365 366 367 368 369 370
            {
                show = m_ml->createShow( showName );
                if ( show == nullptr )
                    return false;
            }
            auto episode = toInt( task.vlcMedia, libvlc_meta_Episode, "episode number" );
            if ( episode != 0 )
            {
                std::shared_ptr<Show> s = std::static_pointer_cast<Show>( show );
                s->addEpisode( *task.media, title, episode );
            }
371 372 373 374 375 376 377 378 379
        }
        else
        {
            // How do we know if it's a movie or a random video?
        }
        task.media->save();
        t->commit();
        return true;
    });
380 381 382 383 384
    return true;
}

/* Audio files */

385
bool MetadataParser::parseAudioFile( parser::Task& task )
386
{
387
    task.media->setType( IMedia::Type::Audio );
388

389
    auto artworkMrl = task.vlcMedia.meta( libvlc_meta_ArtworkURL );
390
    if ( artworkMrl.empty() == false )
391
    {
392
        task.media->setThumbnail( artworkMrl, Thumbnail::Origin::Media );
393 394 395 396 397
        // Don't use an attachment as default artwork for album/artists
        if ( utils::file::schemeIs( "attachment", artworkMrl ) )
            artworkMrl.clear();
    }

398

399
    auto genre = handleGenre( task );
400
    auto artists = findOrCreateArtist( task );
401 402
    if ( artists.first == nullptr && artists.second == nullptr )
        return false;
403
    auto album = findAlbum( task, artists.first, artists.second );
404 405 406
    return sqlite::Tools::withRetries( 3, [this, &task, &artists]( std::string artworkMrl,
                                                  std::shared_ptr<Album> album, std::shared_ptr<Genre> genre ) {
        auto t = m_ml->getConn()->newTransaction();
407
        if ( album == nullptr )
408 409
        {
            const auto& albumName = task.vlcMedia.meta( libvlc_meta_Album );
410 411 412 413 414 415 416 417 418
            int64_t thumbnailId = 0;
            if ( artworkMrl.empty() == false )
            {
                auto thumbnail = Thumbnail::create( m_ml, artworkMrl,
                                                    Thumbnail::Origin::Album );
                if ( thumbnail != nullptr )
                    thumbnailId = thumbnail->id();
            }
            album = m_ml->createAlbum( albumName, thumbnailId );
419 420 421 422 423 424 425 426 427 428 429 430 431
            if ( album == nullptr )
                return false;
            m_notifier->notifyAlbumCreation( album );
        }
        // If we know a track artist, specify it, otherwise, fallback to the album/unknown artist
        auto track = handleTrack( album, task, artists.second ? artists.second : artists.first,
                                  genre.get() );

        auto res = link( *task.media, album, artists.first, artists.second );
        task.media->save();
        t->commit();
        return res;
    }, std::move( artworkMrl ), std::move( album ), std::move( genre ) );
432 433
}

434 435
std::shared_ptr<Genre> MetadataParser::handleGenre( parser::Task& task ) const
{
436 437
    const auto& genreStr = task.vlcMedia.meta( libvlc_meta_Genre );
    if ( genreStr.length() == 0 )
438
        return nullptr;
439
    auto genre = Genre::fromName( m_ml, genreStr );
440 441
    if ( genre == nullptr )
    {
442
        genre = Genre::create( m_ml, genreStr );
443
        if ( genre == nullptr )
444
            LOG_ERROR( "Failed to get/create Genre", genreStr );
445 446 447 448
    }
    return genre;
}

449
/* Album handling */
450 451

std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, std::shared_ptr<Artist> albumArtist,
452
                                                    std::shared_ptr<Artist> trackArtist )
453
{
454 455
    const auto& albumName = task.vlcMedia.meta( libvlc_meta_Album );
    if ( albumName.empty() == true )
456
    {
457 458
        if ( albumArtist != nullptr )
            return albumArtist->unknownAlbum();
459
        if ( trackArtist != nullptr )
460 461
            return trackArtist->unknownAlbum();
        return m_unknownArtist->unknownAlbum();
462 463
    }

464 465 466 467 468 469
    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;

470 471
    // Album matching depends on the difference between artist & album artist.
    // Specificaly pass the albumArtist here.
472 473
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
474
    auto albums = Album::fetchAll<Album>( m_ml, req, albumName );
475 476 477 478

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

479
    const auto discTotal = toInt( task.vlcMedia, libvlc_meta_DiscTotal, "disc total" );
480
    const auto discNumber = toInt( task.vlcMedia, libvlc_meta_DiscNumber, "disc number" );
481 482 483 484 485
    /*
     * 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
486
     * nullptr, so the link() method can create a new one.
487 488 489 490
     */
    for ( auto it = begin( albums ); it != end( albums ); )
    {
        auto a = (*it).get();
491
        auto candidateAlbumArtist = a->albumArtist();
492 493 494 495
        // When we find an album, we will systematically assign an artist to it.
        // Not having an album artist (even it it's only a temporary one in the
        // case of a compilation album) is not expected at all.
        assert( candidateAlbumArtist != nullptr );
496 497 498 499
        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.
500
            if ( candidateAlbumArtist->id() != albumArtist->id() )
501 502 503 504 505 506 507 508 509 510 511
            {
                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.
512
        if ( discTotal > 1 || discNumber > 1 )
513 514 515 516
        {
            ++it;
            continue;
        }
517
        const auto tracks = a->cachedTracks();
518 519 520 521 522 523 524
        // 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;
        }
525 526

        auto multiDisc = false;
527 528
        auto multipleArtists = false;
        int64_t previousArtistId = trackArtist != nullptr ? trackArtist->id() : 0;
529 530 531 532
        for ( auto& t : tracks )
        {
            auto at = t->albumTrack();
            assert( at != nullptr );
533 534 535
            if ( at == nullptr )
                continue;
            if ( at->discNumber() > 1 )
536
                multiDisc = true;
537 538 539 540 541
            if ( previousArtistId != 0 && previousArtistId != at->artist()->id() )
                multipleArtists = true;
            previousArtistId = at->artist()->id();
            // We now know enough about the album, we can stop looking at its tracks
            if ( multiDisc == true && multipleArtists == true )
542 543 544 545 546 547 548 549
                break;
        }
        if ( multiDisc )
        {
            ++it;
            continue;
        }

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
        // Assume album files will be in the same folder.
        auto newFileFolder = utils::file::directory( task.file->mrl() );
        auto trackFiles = tracks[0]->files();
        bool differentFolder = false;
        for ( auto& f : trackFiles )
        {
            auto candidateFolder = utils::file::directory( f->mrl() );
            if ( candidateFolder != newFileFolder )
            {
                differentFolder = true;
                break;
            }
        }
        // We now have a candidate by the same artist in the same folder, assume it to be
        // a positive match.
        if ( differentFolder == false )
        {
            ++it;
            continue;
        }

571 572 573 574
        // Attempt to discriminate by date, but only for the same artists.
        // Not taking the artist in consideration would cause compilation to
        // create multiple albums, especially when track are only partially
        // tagged with a year.
575
        if ( multipleArtists == false )
576
        {
577 578
            auto candidateDate = task.vlcMedia.meta( libvlc_meta_Date );
            if ( candidateDate.empty() == false )
579
            {
580 581 582 583 584 585 586 587 588 589 590 591 592
                try
                {
                    unsigned int year = std::stoi( candidateDate );
                    if ( year != a->releaseYear() )
                        it = albums.erase( it );
                    else
                        ++it;
                    continue;
                }
                catch (...)
                {
                    // Date wasn't helpful, simply ignore the error and continue
                }
593 594
            }
        }
595 596 597 598 599 600 601 602 603
        // The candidate is :
        // - in a different folder
        // - not a multidisc album
        // - Either:
        //      - from the same artist & without a date to discriminate
        //      - from the same artist & with a different date
        //      - from different artists
        // Assume it's a negative match.
        it = albums.erase( it );
604 605 606 607 608
    }
    if ( albums.size() == 0 )
        return nullptr;
    if ( albums.size() > 1 )
    {
609
        LOG_WARN( "Multiple candidates for album ", albumName, ". Selecting first one out of luck" );
610
    }
611 612 613
    m_previousFolderId = task.file->folderId();
    m_previousAlbum = albums[0];
    return albums[0];
614 615 616 617
}

///
/// \brief MetadataParser::handleArtists Returns Artist's involved on a track
618
/// \param task The current parser task
619 620 621 622
/// \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
///
623
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::findOrCreateArtist( parser::Task& task ) const
624 625 626
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;
627
    static const std::string req = "SELECT * FROM " + policy::ArtistTable::Name + " WHERE name = ?";
628

629 630 631
    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 )
632
    {
633
        return {m_unknownArtist, m_unknownArtist};
634 635
    }

636
    if ( albumArtistStr.empty() == false )
637
    {
638
        albumArtist = Artist::fetch( m_ml, req, albumArtistStr );
639 640
        if ( albumArtist == nullptr )
        {
641
            albumArtist = m_ml->createArtist( albumArtistStr );
642 643
            if ( albumArtist == nullptr )
            {
644
                LOG_ERROR( "Failed to create new artist ", albumArtistStr );
645 646
                return {nullptr, nullptr};
            }
647
            m_notifier->notifyArtistCreation( albumArtist );
648 649
        }
    }
650
    if ( artistStr.empty() == false && artistStr != albumArtistStr )
651
    {
652
        artist = Artist::fetch( m_ml, req, artistStr );
653 654
        if ( artist == nullptr )
        {
655
            artist = m_ml->createArtist( artistStr );
656 657
            if ( artist == nullptr )
            {
658
                LOG_ERROR( "Failed to create new artist ", artistStr );
659 660
                return {nullptr, nullptr};
            }
661
            m_notifier->notifyArtistCreation( artist );
662 663 664 665 666 667 668
        }
    }
    return {albumArtist, artist};
}

/* Tracks handling */

669 670
std::shared_ptr<AlbumTrack> MetadataParser::handleTrack( std::shared_ptr<Album> album, parser::Task& task,
                                                         std::shared_ptr<Artist> artist, Genre* genre ) const
671
{
672 673
    assert( sqlite::Transaction::transactionInProgress() == true );

674 675 676
    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" );
677 678 679
    if ( title.empty() == true )
    {
        LOG_WARN( "Failed to get track title" );
680
        if ( trackNumber != 0 )
681 682
        {
            title = "Track #";
683
            title += std::to_string( trackNumber );
684 685 686
        }
    }
    if ( title.empty() == false )
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
687
        task.media->setTitleBuffered( title );
688

689 690
    auto track = std::static_pointer_cast<AlbumTrack>( album->addTrack( task.media, trackNumber,
                                                                        discNumber, artist->id(),
691
                                                                        genre ) );
692 693 694 695 696
    if ( track == nullptr )
    {
        LOG_ERROR( "Failed to create album track" );
        return nullptr;
    }
697

698 699
    const auto& releaseDate = task.vlcMedia.meta( libvlc_meta_Date );
    if ( releaseDate.empty() == false )
700
    {
701
        auto releaseYear = atoi( releaseDate.c_str() );
702
        task.media->setReleaseDate( releaseYear );
703 704 705 706 707
        // 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 );
    }
708
    m_notifier->notifyAlbumTrackCreation( track );
709 710 711 712 713 714
    return track;
}

/* Misc */

bool MetadataParser::link( Media& media, std::shared_ptr<Album> album,
715
                               std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> artist )
716
{
717
    if ( albumArtist == nullptr )
718 719
    {
        assert( artist != nullptr );
720
        albumArtist = artist;
721
    }
722
    assert( album != nullptr );
723

724 725
    auto albumThumbnail = album->thumbnail();

726 727 728 729
    // 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.
730 731 732 733
    // Although we don't want to do this for unknown/various artists, as the
    // thumbnail wouldn't reflect those "special" artists
    if ( albumArtist != nullptr && albumArtist->id() != UnknownArtistID &&
         albumArtist->id() != VariousArtistID &&
734 735 736 737 738 739 740 741 742 743 744 745 746 747
         albumThumbnail != nullptr )
    {
        auto albumArtistThumbnail = albumArtist->thumbnail();
        // If the album artist has no thumbnail, let's assign it
        if ( albumArtistThumbnail == nullptr )
        {
            albumArtist->setArtworkMrl( albumThumbnail->mrl(), Thumbnail::Origin::AlbumArtist );
        }
        else if ( albumArtistThumbnail->origin() == Thumbnail::Origin::Artist )
        {
            // We only want to change the thumbnail if it was assigned from an
            // album this artist was only featuring on
        }
    }
748

749 750 751 752
    // Until we have a better artwork extraction/assignation, simply do the same
    // for artists
    if ( artist != nullptr && artist->id() != UnknownArtistID &&
         artist->id() != VariousArtistID &&
753 754 755 756
         albumThumbnail != nullptr && artist->thumbnail() == nullptr )
    {
        artist->setArtworkMrl( album->artworkMrl(), Thumbnail::Origin::Artist );
    }
757

758 759 760 761 762 763 764 765 766 767 768 769 770
    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)
771
        album->setAlbumArtist( albumArtist );
772 773
        // Always add the album artist as an artist
        album->addArtist( albumArtist );
774 775 776
        // Always update the album artist number of tracks.
        // The artist might be different, and will be handled a few lines below
        albumArtist->updateNbTrack( 1 );
777
        if ( artist != nullptr )
778 779 780 781 782
        {
            // If the album artist is not the artist, we need to update the
            // album artist track count as well.
            if ( albumArtist->id() != artist->id() )
                artist->updateNbTrack( 1 );
783
            album->addArtist( artist );
784
        }
785 786 787
    }
    else
    {
788
        // We have more than a single artist on this album, fallback to various artists
789 790
        if ( albumArtist->id() != currentAlbumArtist->id() )
        {
791 792
            if ( m_variousArtists == nullptr )
                m_variousArtists = Artist::fetch( m_ml, VariousArtistID );
793 794 795 796 797 798 799 800 801 802 803 804 805 806
            // If we already switched to various artist, no need to do it again
            if ( m_variousArtists->id() != currentAlbumArtist->id() )
            {
                // All tracks from this album must now also be reflected in various
                // artist number of tracks
                m_variousArtists->updateNbTrack( album->nbTracks() );
                album->setAlbumArtist( m_variousArtists );
            }
            // However we always need to bump the various artist number of tracks
            else
            {
                m_variousArtists->updateNbTrack( 1 );
            }
            // Add this artist as "featuring".
807 808 809 810
            album->addArtist( albumArtist );
        }
        if ( artist != nullptr && artist->id() != albumArtist->id() )
        {
811 812
           album->addArtist( artist );
           artist->updateNbTrack( 1 );
813
        }
814
        albumArtist->updateNbTrack( 1 );
815 816 817 818 819 820 821 822 823
    }

    return true;
}

const char* MetadataParser::name() const
{
    return "Metadata";
}
824 825 826 827 828 829 830 831 832 833

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;
}
834

835
void MetadataParser::onFlushing()
836 837 838 839 840 841
{
    m_variousArtists = nullptr;
    m_previousAlbum = nullptr;
    m_previousFolderId = 0;
}

842
void MetadataParser::onRestarted()
843 844
{
    // Reset locally cached entities
845
    cacheUnknownArtist();
846 847
}

848
bool MetadataParser::isCompleted( const parser::Task& task ) const
849
{
850
    // We always need to run this task if the metadata extraction isn't completed
851
    return task.isStepCompleted( parser::Task::ParserStep::MetadataAnalysis );
852 853
}

854
}