MetadataParser.cpp 17.6 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
    if ( m_unknownArtist == nullptr )
        LOG_ERROR( "Failed to cache unknown artist" );
    return m_unknownArtist != nullptr;
}

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
int MetadataParser::toInt( VLC::Media& vlcMedia, libvlc_meta_t meta, const char* name )
{
    auto str = vlcMedia.meta( meta );
    if ( str.empty() == false )
    {
#ifndef __ANDROID__
        try
        {
            return std::stoi( str );
        }
        catch( std::logic_error& ex)
        {
            LOG_WARN( "Invalid ", name, " provided (", str, "): ", ex.what() );
        }
#else
        return atoi( str.c_str() );
#endif
    }
    return 0;
}

71
72
73
parser::Task::Status MetadataParser::run( parser::Task& task )
{
    auto& media = task.media;
74
    const auto& tracks = task.vlcMedia.tracks();
75
76
77
78
79

    // If we failed to extract any tracks, don't make any assumption and forward to the
    // thumbnailer. Since it starts an actual playback, it will have more information.
    // Since the metadata steps won't be marked, it will run again once the thumbnailer has completed.
    if ( tracks.empty() == true )
80
81
    {
        // However, if the file is not unknown anymore, it means the thumbnailer has already processed it
82
        if ( task.media->type() == Media::Type::Unknown )
83
84
        {
            LOG_INFO( "Skipping metadata parsing for file with unknown type: ", task.file->mrl() );
85
            return parser::Task::Status::Success;
86
        }
87
88
89
        // In that case, stop trying to do something with this file.
        return parser::Task::Status::Fatal;
    }
90

91
    bool isAudio = true;
92
    {
93
        auto t = m_ml->getConn()->newTransaction();
94
        for ( const auto& t : tracks )
95
        {
96
97
98
99
100
101
102
103
104
105
106
107
108
109
            auto codec = t.codec();
            std::string fcc( reinterpret_cast<const char*>( &codec ), 4 );
            if ( t.type() == VLC::MediaTrack::Type::Video )
            {
                media->addVideoTrack( fcc, t.width(), t.height(),
                                      static_cast<float>( t.fpsNum() ) / static_cast<float>( t.fpsDen() ),
                                      t.language(), t.description() );
                isAudio = false;
            }
            else if ( t.type() == VLC::MediaTrack::Type::Audio )
            {
                media->addAudioTrack( fcc, t.bitrate(), t.rate(), t.channels(),
                                      t.language(), t.description() );
            }
110
111
        }
        t->commit();
112
113
114
    }
    if ( isAudio == true )
    {
115
        if ( parseAudioFile( task ) == false )
116
117
118
119
            return parser::Task::Status::Fatal;
    }
    else
    {
120
        if (parseVideoFile( task ) == false )
121
122
            return parser::Task::Status::Fatal;
    }
123
    media->setDuration( task.vlcMedia.duration() );
124
125

    auto t = m_ml->getConn()->newTransaction();
126
    if ( media->save() == false )
127
        return parser::Task::Status::Fatal;
128
    task.file->markStepCompleted( File::ParserStep::MetadataAnalysis );
129
130
131
132
    // Save ourselves from the useless processing of a thumbnail later if
    // we're analyzing an audio file
    if ( isAudio == true )
        task.file->markStepCompleted( File::ParserStep::Thumbnailer );
133
    if ( task.file->saveParserStep() == false )
134
        return parser::Task::Status::Fatal;
135
    t->commit();
136
    m_notifier->notifyMediaCreation( media );
137
138
139
140
141
    return parser::Task::Status::Success;
}

/* Video files */

142
bool MetadataParser::parseVideoFile( parser::Task& task ) const
143
{
144
    auto media = task.media.get();
145
    media->setType( IMedia::Type::Video );
146
147
    const auto& title = task.vlcMedia.meta( libvlc_meta_Title );
    if ( title.length() == 0 )
148
        return true;
149

150
151
    const auto& showName = task.vlcMedia.meta( libvlc_meta_ShowName );
    if ( showName.length() == 0 )
152
    {
153
        auto show = m_ml->show( showName );
154
155
        if ( show == nullptr )
        {
156
            show = m_ml->createShow( showName );
157
158
159
            if ( show == nullptr )
                return false;
        }
160
161
        auto episode = toInt( task.vlcMedia, libvlc_meta_Episode, "episode number" );
        if ( episode != 0 )
162
163
        {
            std::shared_ptr<Show> s = std::static_pointer_cast<Show>( show );
164
            s->addEpisode( *media, title, episode );
165
166
167
168
169
170
171
172
173
174
175
        }
    }
    else
    {
        // How do we know if it's a movie or a random video?
    }
    return true;
}

/* Audio files */

176
bool MetadataParser::parseAudioFile( parser::Task& task ) const
177
{
178
    task.media->setType( IMedia::Type::Audio );
179

180
181
182
    const auto artworkMrl = task.vlcMedia.meta( libvlc_meta_ArtworkURL );
    if ( artworkMrl.empty() == false )
        task.media->setThumbnail( artworkMrl );
183

184
    auto genre = handleGenre( task );
185
    auto artists = findOrCreateArtist( task );
186
187
    auto album = findAlbum( task, artists.first, artists.second );
    auto t = m_ml->getConn()->newTransaction();
188
189
    if ( album == nullptr )
    {
190
191
        const auto& albumName = task.vlcMedia.meta( libvlc_meta_Album );
        album = m_ml->createAlbum( albumName, artworkMrl );
192
193
194
        if ( album == nullptr )
            return false;
        m_notifier->notifyAlbumCreation( album );
195
    }
196
197
198
199
    // 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 ? artists.first : m_unknownArtist), genre.get() );

200
    auto res = link( *task.media, album, artists.first, artists.second );
201
202
203
204
    t->commit();
    return res;
}

205
206
std::shared_ptr<Genre> MetadataParser::handleGenre( parser::Task& task ) const
{
207
208
    const auto& genreStr = task.vlcMedia.meta( libvlc_meta_Genre );
    if ( genreStr.length() == 0 )
209
        return nullptr;
210
    auto genre = Genre::fromName( m_ml, genreStr );
211
212
    if ( genre == nullptr )
    {
213
        genre = Genre::create( m_ml, genreStr );
214
        if ( genre == nullptr )
215
            LOG_ERROR( "Failed to get/create Genre", genreStr );
216
217
218
219
    }
    return genre;
}

220
/* Album handling */
221
222
223

std::shared_ptr<Album> MetadataParser::findAlbum( parser::Task& task, std::shared_ptr<Artist> albumArtist,
                                                    std::shared_ptr<Artist> trackArtist ) const
224
{
225
226
    const auto& albumName = task.vlcMedia.meta( libvlc_meta_Album );
    if ( albumName.empty() == true )
227
    {
228
229
230
231
232
233
        std::shared_ptr<Artist> artist = albumArtist;
        if ( albumArtist != nullptr )
            return albumArtist->unknownAlbum();
        else if ( trackArtist != nullptr )
            return trackArtist->unknownAlbum();
        return m_unknownArtist->unknownAlbum();
234
235
236
237
    }

    // Album matching depends on the difference between artist & album artist.
    // Specificaly pass the albumArtist here.
238
239
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
240
    auto albums = Album::fetchAll<Album>( m_ml, req, albumName );
241
242
243
244

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

245
246
    const auto discTotal = toInt( task.vlcMedia, libvlc_meta_DiscTotal, "disc total" );
    const auto discNumber = toInt( task.vlcMedia, libvlc_meta_DiscNumber, "dist number" );
247
248
249
250
251
    /*
     * 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
252
     * nullptr, so the link() method can create a new one.
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
     */
    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.
274
        if ( discTotal > 1 || discNumber > 1 )
275
276
277
278
        {
            ++it;
            continue;
        }
279
        const auto tracks = a->cachedTracks();
280
281
282
283
284
285
286
        // 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;
        }
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305

        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.
306
        auto newFileFolder = utils::file::directory( task.file->mrl() );
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
        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 )
    {
329
        LOG_WARN( "Multiple candidates for album ", albumName, ". Selecting first one out of luck" );
330
331
332
333
334
335
    }
    return std::static_pointer_cast<Album>( albums[0] );
}

///
/// \brief MetadataParser::handleArtists Returns Artist's involved on a track
336
/// \param task The current parser task
337
338
339
340
/// \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
///
341
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::findOrCreateArtist( parser::Task& task ) const
342
343
344
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;
345
    static const std::string req = "SELECT * FROM " + policy::ArtistTable::Name + " WHERE name = ?";
346

347
348
349
    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 )
350
    {
351
        return {m_unknownArtist, m_unknownArtist};
352
353
    }

354
    if ( albumArtistStr.empty() == false )
355
    {
356
        albumArtist = Artist::fetch( m_ml, req, albumArtistStr );
357
358
        if ( albumArtist == nullptr )
        {
359
            albumArtist = m_ml->createArtist( albumArtistStr );
360
361
            if ( albumArtist == nullptr )
            {
362
                LOG_ERROR( "Failed to create new artist ", albumArtistStr );
363
364
                return {nullptr, nullptr};
            }
365
            m_notifier->notifyArtistCreation( albumArtist );
366
367
        }
    }
368
    if ( artistStr.empty() == false && artistStr != albumArtistStr )
369
    {
370
        artist = Artist::fetch( m_ml, req, artistStr );
371
372
        if ( artist == nullptr )
        {
373
            artist = m_ml->createArtist( artistStr );
374
375
            if ( artist == nullptr )
            {
376
                LOG_ERROR( "Failed to create new artist ", artistStr );
377
378
                return {nullptr, nullptr};
            }
379
            m_notifier->notifyArtistCreation( albumArtist );
380
381
382
383
384
385
386
        }
    }
    return {albumArtist, artist};
}

/* Tracks handling */

387
388
std::shared_ptr<AlbumTrack> MetadataParser::handleTrack( std::shared_ptr<Album> album, parser::Task& task,
                                                         std::shared_ptr<Artist> artist, Genre* genre ) const
389
{
390
391
392
    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" );
393
394
395
    if ( title.empty() == true )
    {
        LOG_WARN( "Failed to get track title" );
396
        if ( trackNumber != 0 )
397
398
        {
            title = "Track #";
399
            title += std::to_string( trackNumber );
400
401
402
        }
    }
    if ( title.empty() == false )
403
        task.media->setTitle( title );
404

405
406
    auto track = std::static_pointer_cast<AlbumTrack>( album->addTrack( task.media, trackNumber,
                                                                        discNumber, artist->id(),
407
                                                                        genre != nullptr ? genre->id() : 0 ) );
408
409
410
411
412
    if ( track == nullptr )
    {
        LOG_ERROR( "Failed to create album track" );
        return nullptr;
    }
413

414
415
    const auto& releaseDate = task.vlcMedia.meta( libvlc_meta_Date );
    if ( releaseDate.empty() == false )
416
    {
417
        auto releaseYear = atoi( releaseDate.c_str() );
418
        task.media->setReleaseDate( releaseYear );
419
420
421
422
423
        // 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 );
    }
424
    m_notifier->notifyAlbumTrackCreation( track );
425
426
427
428
429
430
431
432
    return track;
}

/* Misc */

bool MetadataParser::link( Media& media, std::shared_ptr<Album> album,
                               std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> artist ) const
{
433
434
    if ( albumArtist == nullptr )
        albumArtist = artist;
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456

    // 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)
457
        album->setAlbumArtist( albumArtist );
458
459
460
461
462
463
464
465
466
467
        // 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
468
            auto variousArtists = Artist::fetch( m_ml, VariousArtistID );
469
            album->setAlbumArtist( variousArtists );
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
            // 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";
}
488
489
490
491
492
493
494
495
496
497

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

499
500
501
502
503
File::ParserStep MetadataParser::step() const
{
    return File::ParserStep::MetadataAnalysis;
}

504
}