MetadataParser.cpp 14.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
/*****************************************************************************
 * 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
bool MetadataParser::initialize()
{
44
    m_unknownArtist = Artist::fetch( m_ml, UnknownArtistID );
45 46 47 48 49 50 51 52 53
    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;

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

/* Video files */

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

    if ( task.showName.length() == 0 )
94
    {
95
        auto show = m_ml->show( task.showName );
96 97
        if ( show == nullptr )
        {
98
            show = m_ml->createShow( task.showName );
99 100 101 102
            if ( show == nullptr )
                return false;
        }

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

/* Audio files */

118
bool MetadataParser::parseAudioFile( parser::Task& task ) const
119
{
120
    task.media->setType( IMedia::Type::AudioType );
121

122 123
    if ( task.artworkMrl.empty() == false )
        task.media->setThumbnail( task.artworkMrl );
124

125
    auto genre = handleGenre( task );
126
    auto artists = findOrCreateArtist( task );
127
    auto album = handleAlbum( task, artists.first, artists.second, genre.get() );
128 129 130 131 132
    if ( album == nullptr )
    {
        LOG_WARN( "Failed to get/create associated album" );
        return false;
    }
133
    auto t = m_ml->getConn()->newTransaction();
134
    auto res = link( *task.media, album, artists.first, artists.second );
135 136 137 138
    t->commit();
    return res;
}

139 140 141 142 143 144 145 146 147 148 149 150 151 152
std::shared_ptr<Genre> MetadataParser::handleGenre( parser::Task& task ) const
{
    if ( task.genre.length() == 0 )
        return nullptr;
    auto genre = Genre::fromName( m_ml, task.genre );
    if ( genre == nullptr )
    {
        genre = Genre::create( m_ml, task.genre );
        if ( genre == nullptr )
            LOG_ERROR( "Failed to get/create Genre", task.genre );
    }
    return genre;
}

153
/* Album handling */
154
std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, Artist* albumArtist ) const
155 156 157
{
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
158
    auto albums = Album::fetchAll<Album>( m_ml, req, task.albumName );
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189

    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.
190
        if ( task.discTotal > 1 || task.discNumber > 1 )
191 192 193 194
        {
            ++it;
            continue;
        }
195
        const auto tracks = a->cachedTracks();
196 197 198 199 200 201 202
        // 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;
        }
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

        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.
222
        auto newFileFolder = utils::file::directory( task.file->mrl() );
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
        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 )
    {
245
        LOG_WARN( "Multiple candidates for album ", task.albumName, ". Selecting first one out of luck" );
246 247 248 249
    }
    return std::static_pointer_cast<Album>( albums[0] );
}

250 251
std::shared_ptr<Album> MetadataParser::handleAlbum( parser::Task& task, std::shared_ptr<Artist> albumArtist,
                                                    std::shared_ptr<Artist> trackArtist, Genre* genre ) const
252 253 254 255 256 257 258 259 260 261 262 263 264
{
    std::shared_ptr<Album> album;
    std::shared_ptr<Artist> artist = albumArtist;
    if ( artist == nullptr )
    {
        if ( trackArtist != nullptr )
            artist = trackArtist;
        else
        {
            artist = m_unknownArtist;
        }
    }

265
    if ( task.albumName.length() > 0 )
266 267 268
    {
        // Album matching depends on the difference between artist & album artist.
        // Specificaly pass the albumArtist here.
269
        album = findAlbum( task, albumArtist.get() );
270 271 272

        if ( album == nullptr )
        {
273
            album = m_ml->createAlbum( task.albumName );
274 275
            if ( album != nullptr )
            {
276 277
                if ( task.artworkMrl.length() != 0 )
                    album->setArtworkMrl( task.artworkMrl );
278
            }
279
            m_notifier->notifyAlbumCreation( album );
280 281 282 283 284 285 286 287
        }
    }
    else
        album = artist->unknownAlbum();

    if ( album == nullptr )
        return nullptr;
    // If we know a track artist, specify it, otherwise, fallback to the album/unknown artist
288
    auto track = handleTrack( album, task, trackArtist ? trackArtist : artist, genre );
289 290 291 292 293
    return album;
}

///
/// \brief MetadataParser::handleArtists Returns Artist's involved on a track
294
/// \param task The current parser task
295 296 297 298
/// \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
///
299
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::findOrCreateArtist( parser::Task& task ) const
300 301 302
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;
303
    static const std::string req = "SELECT * FROM " + policy::ArtistTable::Name + " WHERE name = ?";
304

305
    if ( task.albumArtist.empty() == true && task.artist.empty() == true )
306
    {
307
        return {m_unknownArtist, m_unknownArtist};
308 309
    }

310
    if ( task.albumArtist.empty() == false )
311
    {
312
        albumArtist = Artist::fetch( m_ml, req, task.albumArtist);
313 314
        if ( albumArtist == nullptr )
        {
315
            albumArtist = m_ml->createArtist( task.albumArtist );
316 317
            if ( albumArtist == nullptr )
            {
318
                LOG_ERROR( "Failed to create new artist ", task.albumArtist );
319 320
                return {nullptr, nullptr};
            }
321
            m_notifier->notifyArtistCreation( albumArtist );
322 323
        }
    }
324
    if ( task.artist.empty() == false && task.artist != task.albumArtist )
325
    {
326
        artist = Artist::fetch( m_ml, req, task.artist );
327 328
        if ( artist == nullptr )
        {
329
            artist = m_ml->createArtist( task.artist );
330 331
            if ( artist == nullptr )
            {
332
                LOG_ERROR( "Failed to create new artist ", task.artist );
333 334
                return {nullptr, nullptr};
            }
335
            m_notifier->notifyArtistCreation( albumArtist );
336 337 338 339 340 341 342
        }
    }
    return {albumArtist, artist};
}

/* Tracks handling */

343 344
std::shared_ptr<AlbumTrack> MetadataParser::handleTrack( std::shared_ptr<Album> album, parser::Task& task,
                                                         std::shared_ptr<Artist> artist, Genre* genre ) const
345
{
346
    auto title = task.title;
347 348 349
    if ( title.empty() == true )
    {
        LOG_WARN( "Failed to get track title" );
350
        if ( task.trackNumber != 0 )
351 352
        {
            title = "Track #";
353
            title += std::to_string( task.trackNumber );
354 355 356
        }
    }
    if ( title.empty() == false )
357
        task.media->setTitle( title );
358

359 360 361
    auto track = std::static_pointer_cast<AlbumTrack>( album->addTrack( task.media, task.trackNumber,
                                                                        task.discNumber, artist->id(),
                                                                        genre != nullptr ? genre->id() : 0 ) );
362 363 364 365 366
    if ( track == nullptr )
    {
        LOG_ERROR( "Failed to create album track" );
        return nullptr;
    }
367 368

    if ( task.releaseDate.empty() == false )
369
    {
370
        auto releaseYear = atoi( task.releaseDate.c_str() );
371
        task.media->setReleaseDate( releaseYear );
372 373 374 375 376
        // 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 );
    }
377
    m_notifier->notifyAlbumTrackCreation( track );
378 379 380 381 382 383 384 385
    return track;
}

/* Misc */

bool MetadataParser::link( Media& media, std::shared_ptr<Album> album,
                               std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> artist ) const
{
386 387
    if ( albumArtist == nullptr )
        albumArtist = artist;
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

    // 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)
410
        album->setAlbumArtist( albumArtist );
411 412 413 414 415 416 417 418 419 420
        // 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
421
            auto variousArtists = Artist::fetch( m_ml, VariousArtistID );
422
            album->setAlbumArtist( variousArtists );
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
            // 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";
}
441 442 443 444 445 446 447 448 449 450

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

}