MetadataParser.cpp 13.9 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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/*****************************************************************************
 * 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"
#include "Media.h"
#include "Show.h"
#include "utils/Filename.h"

MetadataParser::MetadataParser( DBConnection dbConnection, std::shared_ptr<factory::IFileSystem> fsFactory)
    : m_dbConn( dbConnection )
    , m_fsFactory( fsFactory )
{
}

bool MetadataParser::initialize()
{
    m_ml = mediaLibrary();
    m_unknownArtist = Artist::fetch( m_dbConn, medialibrary::UnknownArtistID );
    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;

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

/* Video files */

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

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

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

/* Audio files */

114
bool MetadataParser::parseAudioFile( parser::Task& task ) const
115
{
116
    task.media->setType( IMedia::Type::AudioType );
117

118 119
    if ( task.artworkMrl.empty() == false )
        task.media->setThumbnail( task.artworkMrl );
120

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

/* Album handling */
135
std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, Artist* albumArtist ) const
136 137 138
{
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
139
    auto albums = Album::fetchAll<Album>( m_dbConn, req, task.albumName );
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 168 169 170

    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.
171
        if ( task.discTotal > 1 || task.discNumber > 1 )
172 173 174 175
        {
            ++it;
            continue;
        }
176
        const auto tracks = a->cachedTracks();
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
        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.
197
        auto newFileFolder = utils::file::directory( task.file->mrl() );
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
        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 )
    {
220
        LOG_WARN( "Multiple candidates for album ", task.albumName, ". Selecting first one out of luck" );
221 222 223 224
    }
    return std::static_pointer_cast<Album>( albums[0] );
}

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

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

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

    if ( album == nullptr )
        return nullptr;
    // If we know a track artist, specify it, otherwise, fallback to the album/unknown artist
261
    auto track = handleTrack( album, task, trackArtist ? trackArtist : artist );
262 263 264 265 266 267 268 269 270 271 272
    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
///
273
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::handleArtists( parser::Task& task ) const
274 275 276 277
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;

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

283
    if ( task.albumArtist.empty() == false )
284
    {
285
        albumArtist = std::static_pointer_cast<Artist>( m_ml->artist( task.albumArtist ) );
286 287
        if ( albumArtist == nullptr )
        {
288
            albumArtist = m_ml->createArtist( task.albumArtist );
289 290
            if ( albumArtist == nullptr )
            {
291
                LOG_ERROR( "Failed to create new artist ", task.albumArtist );
292 293 294 295
                return {nullptr, nullptr};
            }
        }
    }
296
    if ( task.artist.empty() == false && task.artist != task.albumArtist )
297
    {
298
        artist = std::static_pointer_cast<Artist>( m_ml->artist( task.artist ) );
299 300
        if ( artist == nullptr )
        {
301
            artist = m_ml->createArtist( task.artist );
302 303
            if ( artist == nullptr )
            {
304
                LOG_ERROR( "Failed to create new artist ", task.artist );
305 306 307 308 309 310 311 312 313
                return {nullptr, nullptr};
            }
        }
    }
    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 += std::to_string( 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
        track->setGenre( task.genre );
341
    }
342
    if ( task.releaseDate.empty() == false )
343
    {
344
        auto releaseYear = atoi( task.releaseDate.c_str() );
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 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 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
        track->setReleaseYear( releaseYear );
        // 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 );
    }
    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)
        album->setAlbumArtist( albumArtist.get() );
        // 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
            auto variousArtists = Artist::fetch( m_dbConn, medialibrary::VariousArtistID );
            album->setAlbumArtist( variousArtists.get() );
            // 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";
}
419 420 421 422 423 424 425 426 427 428

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