playermanager.cpp 17.6 KB
Newer Older
1 2 3 4
/***************************************************************************
    begin                : Sat Feb 14 2004
    copyright            : (C) 2004 by Scott Wheeler
    email                : wheeler@kde.org
5 6 7 8

    copyright            : (C) 2007 by Matthias Kretz
    email                : kretz@kde.org

9
    copyright            : (C) 2008, 2009 by Michael Pyne
10
    email                : michael.pyne@kdemail.net
11 12 13 14 15 16 17 18 19 20 21
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

22 23
#include "playermanager.h"

24
#include <kdebug.h>
Matthias Kretz's avatar
Matthias Kretz committed
25
#include <kmessagebox.h>
26
#include <klocale.h>
27 28 29
#include <kactioncollection.h>
#include <kselectaction.h>
#include <ktoggleaction.h>
Andreas Pakulat's avatar
Andreas Pakulat committed
30
#include <kurl.h>
31

32 33 34
#include <Phonon/AudioOutput>
#include <Phonon/MediaObject>
#include <Phonon/VolumeFaderEffect>
35

Laurent Montel's avatar
Laurent Montel committed
36
#include <QPixmap>
37 38
#include <QTimer>

39 40
#include <math.h>

41
#include "playlistinterface.h"
42
#include "playeradaptor.h"
43
#include "slideraction.h"
44
#include "statuslabel.h"
45
#include "actioncollection.h"
46
#include "collectionlist.h"
Michael Pyne's avatar
Michael Pyne committed
47
#include "coverinfo.h"
48
#include "tag.h"
49 50

using namespace ActionCollection;
51

Stephan Kulow's avatar
Stephan Kulow committed
52
enum PlayerManagerStatus { StatusStopped = -1, StatusPaused = 1, StatusPlaying = 2 };
53

54 55 56 57 58
////////////////////////////////////////////////////////////////////////////////
// protected members
////////////////////////////////////////////////////////////////////////////////

PlayerManager::PlayerManager() :
59
    QObject(),
60
    m_playlistInterface(0),
61
    m_statusLabel(0),
62
    m_setup(false),
63
    m_crossfadeTracks(true),
64
    m_curOutputPath(0)
65
{
Michael Pyne's avatar
Michael Pyne committed
66 67 68 69 70
// This class is the first thing constructed during program startup, and
// therefore has no access to the widgets needed by the setup() method.
// Since the setup() method will be called indirectly by the player() method
// later, just disable it here. -- mpyne
//    setup();
Laurent Montel's avatar
Port it  
Laurent Montel committed
71
    new PlayerAdaptor( this );
72 73 74 75
}

PlayerManager::~PlayerManager()
{
76

77 78 79 80 81 82
}

////////////////////////////////////////////////////////////////////////////////
// public members
////////////////////////////////////////////////////////////////////////////////

83 84
bool PlayerManager::playing() const
{
85
    if(!m_setup)
86 87
        return false;

88 89
    Phonon::State state = m_media[m_curOutputPath]->state();
    return (state == Phonon::PlayingState || state == Phonon::BufferingState);
90 91 92 93
}

bool PlayerManager::paused() const
{
94
    if(!m_setup)
95 96
        return false;

97
    return m_media[m_curOutputPath]->state() == Phonon::PausedState;
98 99
}

100 101 102 103 104 105 106 107
bool PlayerManager::muted() const
{
    if(!m_setup)
        return false;

    return m_output[m_curOutputPath]->isMuted();
}

108 109
float PlayerManager::volume() const
{
110
    if(!m_setup)
111
        return 1.0;
112

113
    return m_output[m_curOutputPath]->volume();
114 115
}

116 117
int PlayerManager::status() const
{
118
    if(!m_setup)
119
        return StatusStopped;
120

121
    if(paused())
122
        return StatusPaused;
123

124
    if(playing())
125
        return StatusPlaying;
126

127 128 129
    return 0;
}

Scott Wheeler's avatar
Scott Wheeler committed
130
int PlayerManager::totalTime() const
131
{
132
    if(!m_setup)
133 134
        return 0;

135
    return m_media[m_curOutputPath]->totalTime() / 1000;
136 137
}

Scott Wheeler's avatar
Scott Wheeler committed
138
int PlayerManager::currentTime() const
139
{
140
    if(!m_setup)
141 142
        return 0;

143
    return m_media[m_curOutputPath]->currentTime() / 1000;
144 145
}

146 147 148 149 150 151 152 153
bool PlayerManager::seekable() const
{
    if(!m_setup)
        return false;

    return m_media[m_curOutputPath]->isSeekable();
}

154 155 156 157 158 159 160
QStringList PlayerManager::trackProperties()
{
    return FileHandle::properties();
}

QString PlayerManager::trackProperty(const QString &property) const
{
Michael Pyne's avatar
Michael Pyne committed
161
    if(!playing() && !paused())
162
        return QString();
163 164 165 166

    return m_file.property(property);
}

Michael Pyne's avatar
Michael Pyne committed
167 168 169 170 171
QPixmap PlayerManager::trackCover(const QString &size) const
{
    if(!playing() && !paused())
        return QPixmap();

172
    if(size.toLower() == "small")
Michael Pyne's avatar
Michael Pyne committed
173
        return m_file.coverInfo()->pixmap(CoverInfo::Thumbnail);
174
    if(size.toLower() == "large")
Michael Pyne's avatar
Michael Pyne committed
175 176 177 178 179
        return m_file.coverInfo()->pixmap(CoverInfo::FullSize);

    return QPixmap();
}

180 181 182 183 184
FileHandle PlayerManager::playingFile() const
{
    return m_file;
}

185 186
QString PlayerManager::playingString() const
{
187
    if(!playing() || m_file.isNull())
188
        return QString();
189

190
    return m_file.tag()->playingString();
191 192
}

193
void PlayerManager::setPlaylistInterface(PlaylistInterface *interface)
194 195 196 197
{
    m_playlistInterface = interface;
}

198 199 200 201 202
void PlayerManager::setStatusLabel(StatusLabel *label)
{
    m_statusLabel = label;
}

203 204 205 206
////////////////////////////////////////////////////////////////////////////////
// public slots
////////////////////////////////////////////////////////////////////////////////

207
void PlayerManager::play(const FileHandle &file)
208
{
209
    if(!m_setup)
210 211
        setup();

212
    if(!m_media[0] || !m_media[1] || !m_playlistInterface)
213 214
        return;

215 216 217 218
    stopCrossfade();

    // The "currently playing" media object.
    Phonon::MediaObject *mediaObject = m_media[m_curOutputPath];
219

220
    if(file.isNull()) {
221
        if(paused())
222
            mediaObject->play();
223
        else if(playing()) {
224
            mediaObject->seek(0);
225
        }
226
        else {
227
            m_playlistInterface->playNext();
228
            m_file = m_playlistInterface->currentFile();
229

230
            if(!m_file.isNull())
231
            {
232 233
                mediaObject->setCurrentSource(KUrl::fromPath(m_file.absFilePath()));
                mediaObject->play();
234 235

                emit signalItemChanged(m_file);
236
            }
237
        }
238
    }
239
    else {
240
        mediaObject->setCurrentSource(KUrl::fromPath(file.absFilePath()));
241
        mediaObject->play();
242 243 244 245 246

        if(m_file != file)
            emit signalItemChanged(file);

        m_file = file;
247
    }
248

249 250
    // Our state changed handler will perform the follow up actions necessary
    // once we actually start playing.
251 252
}

253 254 255 256 257 258 259 260 261
void PlayerManager::play(const QString &file)
{
    CollectionListItem *item = CollectionList::instance()->lookup(file);
    if(item) {
        Playlist::setPlaying(item);
        play(item->file());
    }
}

Scott Wheeler's avatar
Scott Wheeler committed
262 263 264 265 266
void PlayerManager::play()
{
    play(FileHandle::null());
}

267 268
void PlayerManager::pause()
{
269
    if(!m_setup)
270 271
        return;

272
    if(paused()) {
273 274 275 276
        play();
        return;
    }

277
    action("pause")->setEnabled(false);
278

279
    m_media[m_curOutputPath]->pause();
280 281

    emit signalPause();
282 283 284 285
}

void PlayerManager::stop()
{
286
    if(!m_setup || !m_playlistInterface)
287 288
        return;

289 290 291 292
    action("pause")->setEnabled(false);
    action("stop")->setEnabled(false);
    action("back")->setEnabled(false);
    action("forward")->setEnabled(false);
293
    action("forwardAlbum")->setEnabled(false);
294

295 296 297 298
    // Fading out playback is for chumps.
    stopCrossfade();
    m_media[0]->stop();
    m_media[1]->stop();
299 300 301 302 303

    if(!m_file.isNull()) {
        m_file = FileHandle::null();
        emit signalItemChanged(m_file);
    }
304 305
}

Laurent Montel's avatar
Laurent Montel committed
306
void PlayerManager::setVolume(float volume)
307
{
308
    if(!m_setup)
309
        setup();
310

311 312
    m_output[0]->setVolume(volume);
    m_output[1]->setVolume(volume);
313 314
}

315
void PlayerManager::seek(int seekTime)
316
{
317
    if(!m_setup || m_media[m_curOutputPath]->currentTime() == seekTime)
318
        return;
319

320 321
    kDebug() << "Stopping crossfade to seek from" << m_media[m_curOutputPath]->currentTime()
             << "to" << seekTime;
322 323
    stopCrossfade();
    m_media[m_curOutputPath]->seek(seekTime);
324 325 326 327
}

void PlayerManager::seekForward()
{
328 329 330 331 332 333
    Phonon::MediaObject *mediaObject = m_media[m_curOutputPath];
    const qint64 total = mediaObject->totalTime();
    const qint64 newtime = mediaObject->currentTime() + total / 100;

    stopCrossfade();
    mediaObject->seek(qMin(total, newtime));
334 335 336 337
}

void PlayerManager::seekBack()
{
338 339 340 341 342 343
    Phonon::MediaObject *mediaObject = m_media[m_curOutputPath];
    const qint64 total = mediaObject->totalTime();
    const qint64 newtime = mediaObject->currentTime() - total / 100;

    stopCrossfade();
    mediaObject->seek(qMax(qint64(0), newtime));
344 345
}

346 347
void PlayerManager::playPause()
{
David Faure's avatar
David Faure committed
348
    playing() ? action("pause")->trigger() : action("play")->trigger();
349 350
}

351 352
void PlayerManager::forward()
{
353 354
    m_playlistInterface->playNext();
    FileHandle file = m_playlistInterface->currentFile();
355

356 357 358 359 360 361 362 363
    if(!file.isNull())
        play(file);
    else
        stop();
}

void PlayerManager::back()
{
364 365
    m_playlistInterface->playPrevious();
    FileHandle file = m_playlistInterface->currentFile();
366

367 368 369 370 371 372
    if(!file.isNull())
        play(file);
    else
        stop();
}

373 374
void PlayerManager::volumeUp()
{
375
    if(!m_setup)
376
        return;
377

378
    setVolume(volume() + 0.04); // 4% up
379 380 381 382
}

void PlayerManager::volumeDown()
{
383
    if(!m_output)
384
        return;
385

386
    setVolume(volume() - 0.04); // 4% down
387 388
}

389
void PlayerManager::setMuted(bool m)
390
{
391
    if(!m_setup)
392 393
        return;

394 395 396 397 398 399 400 401 402 403 404
    m_output[m_curOutputPath]->setMuted(m);
}

bool PlayerManager::mute()
{
    if(!m_setup)
        return false;

    bool newState = !muted();
    setMuted(newState);
    return newState;
405 406
}

407 408 409
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////
410

411 412
void PlayerManager::slotNeedNextUrl()
{
413
    if(m_file.isNull() || !m_crossfadeTracks)
Matthias Kretz's avatar
Matthias Kretz committed
414
        return;
415

416 417
    m_playlistInterface->playNext();
    FileHandle nextFile = m_playlistInterface->currentFile();
418 419

    if(!nextFile.isNull()) {
420
        m_file = nextFile;
421
        crossfadeToFile(m_file);
422 423 424
    }
}

425 426
void PlayerManager::slotFinished()
{
427 428 429 430
    // It is possible to end up in this function if a file simply fails to play or if the
    // user moves the slider all the way to the end, therefore see if we can keep playing
    // and if we can, do so.  Otherwise, stop.  Note that this slot should
    // only be called by the currently "main" output path (i.e. not from the
431 432 433 434 435 436
    // crossfading one).  However life isn't always so nice apparently, so do some
    // sanity-checking.

    Phonon::MediaObject *mediaObject = qobject_cast<Phonon::MediaObject *>(sender());
    if(mediaObject != m_media[m_curOutputPath])
        return;
437

438 439
    m_playlistInterface->playNext();
    m_file = m_playlistInterface->currentFile();
440

441 442 443 444
    if(m_file.isNull()) {
        stop();
    }
    else {
445
        emit signalItemChanged(m_file);
446 447 448
        m_media[m_curOutputPath]->setCurrentSource(m_file.absFilePath());
        m_media[m_curOutputPath]->play();
    }
449 450
}

451 452 453
void PlayerManager::slotLength(qint64 msec)
{
    m_statusLabel->setItemTotalTime(msec / 1000);
454
    emit totalTimeChanged(msec);
455 456
}

457
void PlayerManager::slotTick(qint64 msec)
458
{
459
    if(!m_setup || !m_playlistInterface)
460
        return;
461

462
    if(m_statusLabel)
463
        m_statusLabel->setItemCurrentTime(msec / 1000);
464 465

    emit tick(msec);
466 467
}

468
void PlayerManager::slotStateChanged(Phonon::State newstate, Phonon::State oldstate)
Matthias Kretz's avatar
Matthias Kretz committed
469
{
470 471 472 473 474 475
    // Use sender() since either media object may have sent the signal.
    Phonon::MediaObject *mediaObject = qobject_cast<Phonon::MediaObject *>(sender());
    if(!mediaObject)
        return;

    // Handle errors for either media object
476
    if(newstate == Phonon::ErrorState) {
477 478 479
        QString errorMessage =
            i18nc(
              "%1 will be the /path/to/file, %2 will be some string from Phonon describing the error",
480 481
              "JuK is unable to play the audio file<nl/><filename>%1</filename><nl/>"
                "for the following reason:<nl/><message>%2</message>",
482
              m_file.absFilePath(),
483
              mediaObject->errorString()
484 485
            );

486
        switch(mediaObject->errorType()) {
487 488 489
            case Phonon::NoError:
                kDebug() << "received a state change to ErrorState but errorType is NoError!?";
                break;
490

Matthias Kretz's avatar
Matthias Kretz committed
491 492
            case Phonon::NormalError:
                forward();
493
                KMessageBox::information(0, errorMessage);
Matthias Kretz's avatar
Matthias Kretz committed
494
                break;
495

Matthias Kretz's avatar
Matthias Kretz committed
496 497
            case Phonon::FatalError:
                stop();
498
                KMessageBox::sorry(0, errorMessage);
Matthias Kretz's avatar
Matthias Kretz committed
499 500 501
                break;
        }
    }
502

503 504 505 506 507
    // Now bail out if we're not dealing with the currently playing media
    // object.

    if(mediaObject != m_media[m_curOutputPath])
        return;
508

509 510 511 512 513 514
    // Handle state changes for the playing media object.
    if(newstate == Phonon::StoppedState && oldstate != Phonon::LoadingState) {
        // If this occurs it should be due to a transitory shift (i.e. playing a different
        // song when one is playing now), since it didn't occur in the error handler.  Just
        // in case we really did abruptly stop, handle that case in a couple of seconds.
        QTimer::singleShot(2000, this, SLOT(slotUpdateGuiIfStopped()));
Michael Pyne's avatar
Michael Pyne committed
515
        emit signalStop();
516
    }
517 518 519 520 521 522 523 524 525 526
    else if(newstate == Phonon::PlayingState) {
        action("pause")->setEnabled(true);
        action("stop")->setEnabled(true);
        action("forward")->setEnabled(true);
        if(action<KToggleAction>("albumRandomPlay")->isChecked())
            action("forwardAlbum")->setEnabled(true);
        action("back")->setEnabled(true);

        emit signalPlay();
    }
527 528
}

529 530 531 532 533 534 535 536
////////////////////////////////////////////////////////////////////////////////
// private members
////////////////////////////////////////////////////////////////////////////////

void PlayerManager::setup()
{
    // All of the actions required by this class should be listed here.

537 538 539
    if(!action("pause") ||
       !action("stop") ||
       !action("back") ||
540
       !action("forwardAlbum") ||
541 542
       !action("forward") ||
       !action("trackPositionAction"))
543
    {
544
        kWarning() << "Could not find all of the required actions.";
545 546 547
        return;
    }

548 549 550 551
    if(m_setup)
        return;
    m_setup = true;

552 553 554 555 556 557
    // We use two audio paths at all times to make cross fading easier (and to also easily
    // support not using cross fading with the same code).  The currently playing audio
    // path is controlled using m_curOutputPath.

    for(int i = 0; i < 2; ++i) {
        m_output[i] = new Phonon::AudioOutput(Phonon::MusicCategory, this);
558

559 560 561
        m_media[i] = new Phonon::MediaObject(this);
        m_audioPath[i] = Phonon::createPath(m_media[i], m_output[i]);
        m_media[i]->setTickInterval(200);
562
        m_media[i]->setPrefinishMark(2000);
563

564 565 566 567 568 569
        // Pre-cache a volume fader object
        m_fader[i] = new Phonon::VolumeFaderEffect(m_media[i]);
        m_audioPath[i].insertEffect(m_fader[i]);
        m_fader[i]->setVolume(1.0f);

        connect(m_media[i], SIGNAL(stateChanged(Phonon::State, Phonon::State)), SLOT(slotStateChanged(Phonon::State, Phonon::State)));
570
        connect(m_media[i], SIGNAL(prefinishMarkReached(qint32)), SLOT(slotNeedNextUrl()));
571 572 573 574
        connect(m_media[i], SIGNAL(totalTimeChanged(qint64)), SLOT(slotLength(qint64)));
        connect(m_media[i], SIGNAL(tick(qint64)), SLOT(slotTick(qint64)));
        connect(m_media[i], SIGNAL(finished()), SLOT(slotFinished()));
    }
575

576 577
    // initialize action states

578 579 580 581
    action("pause")->setEnabled(false);
    action("stop")->setEnabled(false);
    action("back")->setEnabled(false);
    action("forward")->setEnabled(false);
582
    action("forwardAlbum")->setEnabled(false);
583

584
    QDBusConnection::sessionBus().registerObject("/Player", this);
585 586 587
}

void PlayerManager::slotUpdateGuiIfStopped()
588
{
589 590 591
    if(m_media[0]->state() == Phonon::StoppedState && m_media[1]->state() == Phonon::StoppedState)
        stop();
}
592

593 594 595
void PlayerManager::crossfadeToFile(const FileHandle &newFile)
{
    int nextOutputPath = 1 - m_curOutputPath;
596

597 598 599
    // Don't need this anymore
    disconnect(m_media[m_curOutputPath], SIGNAL(finished()), this, 0);
    connect(m_media[nextOutputPath], SIGNAL(finished()), SLOT(slotFinished()));
600

601
    m_fader[nextOutputPath]->setVolume(0.0f);
602

603
    emit signalItemChanged(newFile);
604 605
    m_media[nextOutputPath]->setCurrentSource(newFile.absFilePath());
    m_media[nextOutputPath]->play();
606

607 608
    m_fader[m_curOutputPath]->setVolume(1.0f);
    m_fader[m_curOutputPath]->fadeTo(0.0f, 2000);
609

610
    m_fader[nextOutputPath]->fadeTo(1.0f, 2000);
611

612 613
    m_curOutputPath = nextOutputPath;
}
614

615 616 617 618
void PlayerManager::stopCrossfade()
{
    // According to the Phonon docs, setVolume immediately takes effect,
    // which is "good enough for government work" ;)
619

620 621 622
    // 1 - curOutputPath is the other output path...
    m_fader[m_curOutputPath]->setVolume(1.0f);
    m_fader[1 - m_curOutputPath]->setVolume(0.0f);
623

624 625 626 627 628 629 630 631
    // We don't actually need to physically stop crossfading as the playback
    // code will call ->play() when necessary anyways.  If we hit stop()
    // here instead of pause() then we will trick our stateChanged handler
    // into thinking Phonon had a spurious stop and we'll switch tracks
    // unnecessarily.  (This isn't a problem after crossfade completes due to
    // the signals being disconnected).

    m_media[1 - m_curOutputPath]->pause();
632 633
}

Michael Pyne's avatar
Michael Pyne committed
634 635 636 637 638 639 640 641 642
QString PlayerManager::randomPlayMode() const
{
    if(action<KToggleAction>("randomPlay")->isChecked())
        return "Random";
    if(action<KToggleAction>("albumRandomPlay")->isChecked())
        return "AlbumRandom";
    return "NoRandom";
}

643 644 645 646 647
void PlayerManager::setCrossfadeEnabled(bool crossfadeEnabled)
{
    m_crossfadeTracks = crossfadeEnabled;
}

Michael Pyne's avatar
Michael Pyne committed
648 649
void PlayerManager::setRandomPlayMode(const QString &randomMode)
{
650
    if(randomMode.toLower() == "random")
Michael Pyne's avatar
Michael Pyne committed
651
        action<KToggleAction>("randomPlay")->setChecked(true);
652
    if(randomMode.toLower() == "albumrandom")
Michael Pyne's avatar
Michael Pyne committed
653
        action<KToggleAction>("albumRandomPlay")->setChecked(true);
654
    if(randomMode.toLower() == "norandom")
Michael Pyne's avatar
Michael Pyne committed
655 656 657
        action<KToggleAction>("disableRandomPlay")->setChecked(true);
}

658
#include "playermanager.moc"
659

660
// vim: set et sw=4 tw=0 sta: