MetadataParser.cpp 14.4 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 23 24 25 26 27
/*****************************************************************************
 * 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.
 *****************************************************************************/

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

bool MetadataParser::initialize()
{
38
    m_unknownArtist = Artist::fetch( m_ml, medialibrary::UnknownArtistID );
39 40 41 42 43 44 45 46 47
    if ( m_unknownArtist == nullptr )
        LOG_ERROR( "Failed to cache unknown artist" );
    return m_unknownArtist != nullptr;
}

parser::Task::Status MetadataParser::run( parser::Task& task )
{
    auto& media = task.media;

48
    auto t = m_ml->getConn()->newTransaction();
49 50
    bool isAudio = task.videoTracks.empty();
    for ( const auto& t : task.videoTracks )
51
    {
52
        media->addVideoTrack( t.fcc, t.width, t.height, t.fps );
53
    }
54
    for ( const auto& t : task.audioTracks )
55
    {
56 57
        media->addAudioTrack( t.fcc, t.bitrate, t.samplerate, t.nbChannels,
                              t.language, t.description );
58 59 60 61
    }
    t->commit();
    if ( isAudio == true )
    {
62
        if ( parseAudioFile( task ) == false )
63 64 65 66
            return parser::Task::Status::Fatal;
    }
    else
    {
67
        if (parseVideoFile( task ) == false )
68 69
            return parser::Task::Status::Fatal;
    }
70
    auto duration = task.duration;
71 72 73 74 75 76 77 78
    media->setDuration( duration );
    if ( media->save() == false )
        return parser::Task::Status::Error;
    return parser::Task::Status::Success;
}

/* Video files */

79
bool MetadataParser::parseVideoFile( parser::Task& task ) const
80
{
81
    auto media = task.media.get();
82
    media->setType( IMedia::Type::VideoType );
83
    if ( task.title.length() == 0 )
84
        return true;
85 86

    if ( task.showName.length() == 0 )
87
    {
88
        auto show = m_ml->show( task.showName );
89 90
        if ( show == nullptr )
        {
91
            show = m_ml->createShow( task.showName );
92 93 94 95
            if ( show == nullptr )
                return false;
        }

96
        if ( task.episode != 0 )
97 98
        {
            std::shared_ptr<Show> s = std::static_pointer_cast<Show>( show );
99
            s->addEpisode( *media, task.title, task.episode );
100 101 102 103 104 105 106 107 108 109 110
        }
    }
    else
    {
        // How do we know if it's a movie or a random video?
    }
    return true;
}

/* Audio files */

111
bool MetadataParser::parseAudioFile( parser::Task& task ) const
112
{
113
    task.media->setType( IMedia::Type::AudioType );
114

115 116
    if ( task.artworkMrl.empty() == false )
        task.media->setThumbnail( task.artworkMrl );
117

118 119
    auto artists = handleArtists( task );
    auto album = handleAlbum( task, artists.first, artists.second );
120 121 122 123 124
    if ( album == nullptr )
    {
        LOG_WARN( "Failed to get/create associated album" );
        return false;
    }
125
    auto t = m_ml->getConn()->newTransaction();
126
    auto res = link( *task.media, album, artists.first, artists.second );
127 128 129 130 131
    t->commit();
    return res;
}

/* Album handling */
132
std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, Artist* albumArtist ) const
133 134 135
{
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
136
    auto albums = Album::fetchAll<Album>( m_ml, req, task.albumName );
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167

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

    /*
     * 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
     * nullptr, so handleAlbum can create a new one.
     */
    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.
168
        if ( task.discTotal > 1 || task.discNumber > 1 )
169 170 171 172
        {
            ++it;
            continue;
        }
173
        const auto tracks = a->cachedTracks();
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
        assert( tracks.size() > 0 );

        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.
194
        auto newFileFolder = utils::file::directory( task.file->mrl() );
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
        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 )
    {
217
        LOG_WARN( "Multiple candidates for album ", task.albumName, ". Selecting first one out of luck" );
218 219 220 221
    }
    return std::static_pointer_cast<Album>( albums[0] );
}

222
std::shared_ptr<Album> MetadataParser::handleAlbum( parser::Task& task, std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> trackArtist ) const
223 224 225 226 227 228 229 230 231 232 233 234 235
{
    std::shared_ptr<Album> album;
    std::shared_ptr<Artist> artist = albumArtist;
    if ( artist == nullptr )
    {
        if ( trackArtist != nullptr )
            artist = trackArtist;
        else
        {
            artist = m_unknownArtist;
        }
    }

236
    if ( task.albumName.length() > 0 )
237 238 239
    {
        // Album matching depends on the difference between artist & album artist.
        // Specificaly pass the albumArtist here.
240
        album = findAlbum( task, albumArtist.get() );
241 242 243

        if ( album == nullptr )
        {
244
            album = m_ml->createAlbum( task.albumName );
245 246
            if ( album != nullptr )
            {
247 248
                if ( task.artworkMrl.length() != 0 )
                    album->setArtworkMrl( task.artworkMrl );
249
            }
250
            m_notifier->notifyAlbumCreation( album );
251 252 253 254 255 256 257 258
        }
    }
    else
        album = artist->unknownAlbum();

    if ( album == nullptr )
        return nullptr;
    // If we know a track artist, specify it, otherwise, fallback to the album/unknown artist
259
    auto track = handleTrack( album, task, trackArtist ? trackArtist : artist );
260 261 262 263 264 265 266 267 268 269 270
    return album;
}

///
/// \brief MetadataParser::handleArtists Returns Artist's involved on a track
/// \param media The track to analyze
/// \param vlcMedia VLC's media
/// \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
///
271
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::handleArtists( parser::Task& task ) const
272 273 274 275
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;

276
    if ( task.albumArtist.empty() == true && task.artist.empty() == true )
277 278 279 280
    {
        return {nullptr, nullptr};
    }

281
    if ( task.albumArtist.empty() == false )
282
    {
283
        albumArtist = std::static_pointer_cast<Artist>( m_ml->artist( task.albumArtist ) );
284 285
        if ( albumArtist == nullptr )
        {
286
            albumArtist = m_ml->createArtist( task.albumArtist );
287 288
            if ( albumArtist == nullptr )
            {
289
                LOG_ERROR( "Failed to create new artist ", task.albumArtist );
290 291
                return {nullptr, nullptr};
            }
292
            m_notifier->notifyArtistCreation( albumArtist );
293 294
        }
    }
295
    if ( task.artist.empty() == false && task.artist != task.albumArtist )
296
    {
297
        artist = std::static_pointer_cast<Artist>( m_ml->artist( task.artist ) );
298 299
        if ( artist == nullptr )
        {
300
            artist = m_ml->createArtist( task.artist );
301 302
            if ( artist == nullptr )
            {
303
                LOG_ERROR( "Failed to create new artist ", task.artist );
304 305
                return {nullptr, nullptr};
            }
306
            m_notifier->notifyArtistCreation( albumArtist );
307 308 309 310 311 312 313
        }
    }
    return {albumArtist, artist};
}

/* Tracks handling */

314
std::shared_ptr<AlbumTrack> MetadataParser::handleTrack( std::shared_ptr<Album> album, parser::Task& task, std::shared_ptr<Artist> artist ) const
315
{
316
    auto title = task.title;
317 318 319
    if ( title.empty() == true )
    {
        LOG_WARN( "Failed to get track title" );
320
        if ( task.trackNumber != 0 )
321 322
        {
            title = "Track #";
323
            title += toString( task.trackNumber );
324 325 326
        }
    }
    if ( title.empty() == false )
327
        task.media->setTitle( title );
328

329
    auto track = std::static_pointer_cast<AlbumTrack>( album->addTrack( task.media, task.trackNumber, task.discNumber ) );
330 331 332 333 334 335 336
    if ( track == nullptr )
    {
        LOG_ERROR( "Failed to create album track" );
        return nullptr;
    }
    if ( artist != nullptr )
        track->setArtist( artist );
337 338

    if ( task.genre.length() != 0 )
339
    {
340
        auto genre = Genre::fromName( m_ml, task.genre );
341 342
        if ( genre == nullptr )
        {
343
            genre = Genre::create( m_ml, task.genre );
344 345 346 347 348 349 350
            if ( genre == nullptr )
            {
                LOG_ERROR( "Failed to create a genre in database" );
                return nullptr;
            }
        }
        track->setGenre( genre );
351
    }
352
    if ( task.releaseDate.empty() == false )
353
    {
354
        auto releaseYear = atoi( task.releaseDate.c_str() );
355
        task.media->setReleaseDate( releaseYear );
356 357 358 359 360
        // 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 );
    }
361
    m_notifier->notifyAlbumTrackCreation( track );
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    return track;
}

/* Misc */

bool MetadataParser::link( Media& media, std::shared_ptr<Album> album,
                               std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> artist ) const
{
    if ( albumArtist == nullptr && artist == nullptr )
        albumArtist = m_unknownArtist;
    else
    {
        if ( albumArtist == nullptr )
            albumArtist = artist;
    }

    // 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)
399
        album->setAlbumArtist( albumArtist );
400 401 402 403 404 405 406 407 408 409
        // 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
410
            auto variousArtists = Artist::fetch( m_ml, medialibrary::VariousArtistID );
411
            album->setAlbumArtist( variousArtists );
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
            // 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";
}
430 431 432 433 434 435 436 437 438 439

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