MetadataParser.cpp 14.2 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 31 32 33 34
#include "Media.h"
#include "Show.h"
#include "utils/Filename.h"

bool MetadataParser::initialize()
{
35
    m_unknownArtist = Artist::fetch( m_ml, medialibrary::UnknownArtistID );
36 37 38 39 40 41 42 43 44
    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;

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

/* Video files */

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

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

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

/* Audio files */

108
bool MetadataParser::parseAudioFile( parser::Task& task ) const
109
{
110
    task.media->setType( IMedia::Type::AudioType );
111

112 113
    if ( task.artworkMrl.empty() == false )
        task.media->setThumbnail( task.artworkMrl );
114

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

/* Album handling */
129
std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, Artist* albumArtist ) const
130 131 132
{
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
133
    auto albums = Album::fetchAll<Album>( m_ml, req, task.albumName );
134 135 136 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

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

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

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

        if ( album == nullptr )
        {
241
            album = m_ml->createAlbum( task.albumName );
242 243
            if ( album != nullptr )
            {
244 245
                if ( task.artworkMrl.length() != 0 )
                    album->setArtworkMrl( task.artworkMrl );
246
            }
247
            m_cb->onAlbumAdded( album );
248 249 250 251 252 253 254 255
        }
    }
    else
        album = artist->unknownAlbum();

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

273
    if ( task.albumArtist.empty() == true && task.artist.empty() == true )
274 275 276 277
    {
        return {nullptr, nullptr};
    }

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

/* Tracks handling */

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

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

    if ( task.genre.length() != 0 )
336
    {
337
        auto genre = Genre::fromName( m_ml, task.genre );
338 339
        if ( genre == nullptr )
        {
340
            genre = Genre::create( m_ml, task.genre );
341 342 343 344 345 346 347
            if ( genre == nullptr )
            {
                LOG_ERROR( "Failed to create a genre in database" );
                return nullptr;
            }
        }
        track->setGenre( genre );
348
    }
349
    if ( task.releaseDate.empty() == false )
350
    {
351
        auto releaseYear = atoi( task.releaseDate.c_str() );
352 353 354 355 356 357
        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 );
    }
358
    m_cb->onTrackAdded( task.media, track );
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
    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
407
            auto variousArtists = Artist::fetch( m_ml, medialibrary::VariousArtistID );
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
            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";
}
427 428 429 430 431 432 433 434 435 436

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