playermanager.cpp 17.8 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_sliderAction(0),
61
    m_playlistInterface(0),
62
    m_statusLabel(0),
63
    m_muted(false),
64
    m_setup(false),
65
    m_crossfadeTracks(true),
66
    m_curOutputPath(0)
67
{
Michael Pyne's avatar
Michael Pyne committed
68 69 70 71 72
// 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
Laurent Montel committed
73
    new PlayerAdaptor( this );
74
    QDBusConnection::sessionBus().registerObject("/Player", this);
75 76 77 78 79 80 81 82 83 84 85 86
}

PlayerManager::~PlayerManager()
{
}

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

PlayerManager *PlayerManager::instance() // static
{
87 88
    static PlayerManager manager;
    return &manager;
89 90
}

91 92
bool PlayerManager::playing() const
{
93
    if(!m_setup)
94 95
        return false;

96 97
    Phonon::State state = m_media[m_curOutputPath]->state();
    return (state == Phonon::PlayingState || state == Phonon::BufferingState);
98 99 100 101
}

bool PlayerManager::paused() const
{
102
    if(!m_setup)
103 104
        return false;

105
    return m_media[m_curOutputPath]->state() == Phonon::PausedState;
106 107 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
QStringList PlayerManager::trackProperties()
{
    return FileHandle::properties();
}

QString PlayerManager::trackProperty(const QString &property) const
{
Michael Pyne's avatar
Michael Pyne committed
153
    if(!playing() && !paused())
154
        return QString();
155 156 157 158

    return m_file.property(property);
}

Michael Pyne's avatar
Michael Pyne committed
159 160 161 162 163
QPixmap PlayerManager::trackCover(const QString &size) const
{
    if(!playing() && !paused())
        return QPixmap();

164
    if(size.toLower() == "small")
Michael Pyne's avatar
Michael Pyne committed
165
        return m_file.coverInfo()->pixmap(CoverInfo::Thumbnail);
166
    if(size.toLower() == "large")
Michael Pyne's avatar
Michael Pyne committed
167 168 169 170 171
        return m_file.coverInfo()->pixmap(CoverInfo::FullSize);

    return QPixmap();
}

172 173 174 175 176
FileHandle PlayerManager::playingFile() const
{
    return m_file;
}

177 178 179
QString PlayerManager::playingString() const
{
    if(!playing())
180
        return QString();
181

182 183 184 185 186
    QString str = m_file.tag()->artist() + " - " + m_file.tag()->title();
    if(m_file.tag()->artist().isEmpty())
        str = m_file.tag()->title();

    return str;
187 188
}

189
void PlayerManager::setPlaylistInterface(PlaylistInterface *interface)
190 191 192 193
{
    m_playlistInterface = interface;
}

194 195 196 197 198
void PlayerManager::setStatusLabel(StatusLabel *label)
{
    m_statusLabel = label;
}

199 200 201 202
////////////////////////////////////////////////////////////////////////////////
// public slots
////////////////////////////////////////////////////////////////////////////////

203
void PlayerManager::play(const FileHandle &file)
204
{
205
    if(!m_setup)
206 207
        setup();

208
    if(!m_media[0] || !m_media[1] || !m_playlistInterface)
209 210
        return;

211 212 213 214
    stopCrossfade();

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

216
    if(file.isNull()) {
217
        if(paused())
218
            mediaObject->play();
219
        else if(playing()) {
220
            mediaObject->seek(0);
221
        }
222
        else {
223
            m_playlistInterface->playNext();
224
            m_file = m_playlistInterface->currentFile();
225

226
            if(!m_file.isNull())
227
            {
228 229
                mediaObject->setCurrentSource(KUrl::fromPath(m_file.absFilePath()));
                mediaObject->play();
230
            }
231
        }
232
    }
233
    else {
234
        m_file = file;
Matthias Kretz's avatar
Matthias Kretz committed
235

236 237
        mediaObject->setCurrentSource(KUrl::fromPath(m_file.absFilePath()));
        mediaObject->play();
238
    }
239

240 241
    // Our state changed handler will perform the follow up actions necessary
    // once we actually start playing.
242 243
}

244 245 246 247 248 249 250 251 252
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
253 254 255 256 257
void PlayerManager::play()
{
    play(FileHandle::null());
}

258 259
void PlayerManager::pause()
{
260
    if(!m_setup)
261 262
        return;

263
    if(paused()) {
264 265 266 267
        play();
        return;
    }

268
    action("pause")->setEnabled(false);
269

270
    m_media[m_curOutputPath]->pause();
271 272

    emit signalPause();
273 274 275 276
}

void PlayerManager::stop()
{
277
    if(!m_setup || !m_playlistInterface)
278 279
        return;

280 281 282 283
    action("pause")->setEnabled(false);
    action("stop")->setEnabled(false);
    action("back")->setEnabled(false);
    action("forward")->setEnabled(false);
284
    action("forwardAlbum")->setEnabled(false);
285

286 287 288 289
    // Fading out playback is for chumps.
    stopCrossfade();
    m_media[0]->stop();
    m_media[1]->stop();
290 291
}

Laurent Montel's avatar
Laurent Montel committed
292
void PlayerManager::setVolume(float volume)
293
{
294
    if(!m_setup)
295
        setup();
296

297 298
    m_output[0]->setVolume(volume);
    m_output[1]->setVolume(volume);
299 300
}

301
void PlayerManager::seek(int seekTime)
302
{
303
    if(!m_setup || m_media[m_curOutputPath]->currentTime() == seekTime)
304
        return;
305

306 307
    kDebug() << "Stopping crossfade to seek from" << m_media[m_curOutputPath]->currentTime()
             << "to" << seekTime;
308 309
    stopCrossfade();
    m_media[m_curOutputPath]->seek(seekTime);
310 311 312 313
}

void PlayerManager::seekForward()
{
314 315 316 317 318 319
    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));
320 321 322 323
}

void PlayerManager::seekBack()
{
324 325 326 327 328 329
    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));
330 331
}

332 333
void PlayerManager::playPause()
{
David Faure's avatar
David Faure committed
334
    playing() ? action("pause")->trigger() : action("play")->trigger();
335 336
}

337 338
void PlayerManager::forward()
{
339 340
    m_playlistInterface->playNext();
    FileHandle file = m_playlistInterface->currentFile();
341

342 343 344 345 346 347 348 349
    if(!file.isNull())
        play(file);
    else
        stop();
}

void PlayerManager::back()
{
350 351
    m_playlistInterface->playPrevious();
    FileHandle file = m_playlistInterface->currentFile();
352

353 354 355 356 357 358
    if(!file.isNull())
        play(file);
    else
        stop();
}

359 360
void PlayerManager::volumeUp()
{
361
    if(!m_setup)
362
        return;
363

364
    setVolume(volume() + 0.04); // 4% up
365 366 367 368
}

void PlayerManager::volumeDown()
{
369
    if(!m_output)
370
        return;
371

372
    setVolume(volume() - 0.04); // 4% down
373 374 375 376
}

void PlayerManager::mute()
{
377
    if(!m_setup)
378 379
        return;

380
    m_output[m_curOutputPath]->setMuted(!m_output[m_curOutputPath]->isMuted());
381 382
}

383 384 385
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////
386

387 388
void PlayerManager::slotNeedNextUrl()
{
389
    if(m_file.isNull() || !m_crossfadeTracks)
Matthias Kretz's avatar
Matthias Kretz committed
390
        return;
391

392 393
    m_playlistInterface->playNext();
    FileHandle nextFile = m_playlistInterface->currentFile();
394 395

    if(!nextFile.isNull()) {
396
        m_file = nextFile;
397
        crossfadeToFile(m_file);
398 399 400
    }
}

401 402
void PlayerManager::slotFinished()
{
403 404 405 406 407
    // 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
    // crossfading one)
408

409 410
    m_playlistInterface->playNext();
    m_file = m_playlistInterface->currentFile();
411

412 413 414 415 416 417 418
    if(m_file.isNull()) {
        stop();
    }
    else {
        m_media[m_curOutputPath]->setCurrentSource(m_file.absFilePath());
        m_media[m_curOutputPath]->play();
    }
419 420
}

421 422 423 424 425
void PlayerManager::slotLength(qint64 msec)
{
    m_statusLabel->setItemTotalTime(msec / 1000);
}

426
void PlayerManager::slotTick(qint64 msec)
427
{
428
    if(!m_setup || !m_playlistInterface)
429
        return;
430

431
    if(m_statusLabel)
432
        m_statusLabel->setItemCurrentTime(msec / 1000);
433 434
}

435
void PlayerManager::slotStateChanged(Phonon::State newstate, Phonon::State oldstate)
Matthias Kretz's avatar
Matthias Kretz committed
436
{
437 438 439 440 441 442
    // 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
443
    if(newstate == Phonon::ErrorState) {
444 445 446 447 448 449
        QString errorMessage =
            i18nc(
              "%1 will be the /path/to/file, %2 will be some string from Phonon describing the error",
              "JuK is unable to play the audio file<nl><filename>%1</filename><nl>"
                "for the following reason:<nl><message>%2</message>",
              m_file.absFilePath(),
450
              mediaObject->errorString()
451 452
            );

453
        switch(mediaObject->errorType()) {
454 455 456
            case Phonon::NoError:
                kDebug() << "received a state change to ErrorState but errorType is NoError!?";
                break;
457

Matthias Kretz's avatar
Matthias Kretz committed
458 459
            case Phonon::NormalError:
                forward();
460
                KMessageBox::information(0, errorMessage);
Matthias Kretz's avatar
Matthias Kretz committed
461
                break;
462

Matthias Kretz's avatar
Matthias Kretz committed
463 464
            case Phonon::FatalError:
                stop();
465
                KMessageBox::sorry(0, errorMessage);
Matthias Kretz's avatar
Matthias Kretz committed
466 467 468
                break;
        }
    }
469

470 471 472 473 474
    // Now bail out if we're not dealing with the currently playing media
    // object.

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

476 477 478 479 480 481
    // 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
482
        emit signalStop();
483
    }
484 485 486 487 488 489 490 491 492 493
    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();
    }
494 495
}

496 497 498 499 500 501 502 503
////////////////////////////////////////////////////////////////////////////////
// private members
////////////////////////////////////////////////////////////////////////////////

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

504 505 506
    if(!action("pause") ||
       !action("stop") ||
       !action("back") ||
507
       !action("forwardAlbum") ||
508 509
       !action("forward") ||
       !action("trackPositionAction"))
510
    {
511
        kWarning() << "Could not find all of the required actions.";
512 513 514
        return;
    }

515 516 517 518
    if(m_setup)
        return;
    m_setup = true;

519 520 521 522 523 524
    // 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);
525

526 527 528
        m_media[i] = new Phonon::MediaObject(this);
        m_audioPath[i] = Phonon::createPath(m_media[i], m_output[i]);
        m_media[i]->setTickInterval(200);
529
        m_media[i]->setPrefinishMark(2000);
530

531 532 533 534 535 536
        // 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)));
537
        connect(m_media[i], SIGNAL(prefinishMarkReached(qint32)), SLOT(slotNeedNextUrl()));
538 539 540 541
        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()));
    }
542

543 544
    // initialize action states

545 546 547 548
    action("pause")->setEnabled(false);
    action("stop")->setEnabled(false);
    action("back")->setEnabled(false);
    action("forward")->setEnabled(false);
549
    action("forwardAlbum")->setEnabled(false);
550

551
    // setup sliders (a separate slot is used to switch as needed)
552

553
    m_sliderAction = action<SliderAction>("trackPositionAction");
554

555
    if(m_sliderAction->trackPositionSlider())
556 557
        m_sliderAction->trackPositionSlider()->setMediaObject(m_media[0]);

558
    if(m_sliderAction->volumeSlider())
559 560 561 562 563 564 565
        m_sliderAction->volumeSlider()->setAudioOutput(m_output[0]);
}

void PlayerManager::slotUpdateSliders()
{
    m_sliderAction->trackPositionSlider()->setMediaObject(m_media[m_curOutputPath]);
    m_sliderAction->volumeSlider()->setAudioOutput(m_output[m_curOutputPath]);
566

567 568
    disconnect(m_media[1 - m_curOutputPath], 0, this, SLOT(slotUpdateSliders()));
    connect(m_media[1 - m_curOutputPath], SIGNAL(finished()), SLOT(slotFinished()));
569 570
}

571
void PlayerManager::slotUpdateGuiIfStopped()
572
{
573 574 575
    if(m_media[0]->state() == Phonon::StoppedState && m_media[1]->state() == Phonon::StoppedState)
        stop();
}
576

577 578 579
void PlayerManager::crossfadeToFile(const FileHandle &newFile)
{
    int nextOutputPath = 1 - m_curOutputPath;
580

581 582 583
    // Don't need this anymore
    disconnect(m_media[m_curOutputPath], SIGNAL(finished()), this, 0);
    connect(m_media[nextOutputPath], SIGNAL(finished()), SLOT(slotFinished()));
584

585 586 587
    // Wait a couple of seconds and switch slider objects.  (We would simply
    // handle this when finished() is emitted but phonon-gst is buggy).
    QTimer::singleShot(2000, this, SLOT(slotUpdateSliders()));
588

589
    m_fader[nextOutputPath]->setVolume(0.0f);
590

591 592
    m_media[nextOutputPath]->setCurrentSource(newFile.absFilePath());
    m_media[nextOutputPath]->play();
593

594 595
    m_fader[m_curOutputPath]->setVolume(1.0f);
    m_fader[m_curOutputPath]->fadeTo(0.0f, 2000);
596

597
    m_fader[nextOutputPath]->fadeTo(1.0f, 2000);
598

599 600
    m_curOutputPath = nextOutputPath;
}
601

602 603 604 605
void PlayerManager::stopCrossfade()
{
    // According to the Phonon docs, setVolume immediately takes effect,
    // which is "good enough for government work" ;)
606

607 608 609
    // 1 - curOutputPath is the other output path...
    m_fader[m_curOutputPath]->setVolume(1.0f);
    m_fader[1 - m_curOutputPath]->setVolume(0.0f);
610

611 612 613 614 615 616 617 618
    // 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();
619 620
}

Michael Pyne's avatar
Michael Pyne committed
621 622 623 624 625 626 627 628 629
QString PlayerManager::randomPlayMode() const
{
    if(action<KToggleAction>("randomPlay")->isChecked())
        return "Random";
    if(action<KToggleAction>("albumRandomPlay")->isChecked())
        return "AlbumRandom";
    return "NoRandom";
}

630 631 632 633 634
void PlayerManager::setCrossfadeEnabled(bool crossfadeEnabled)
{
    m_crossfadeTracks = crossfadeEnabled;
}

Michael Pyne's avatar
Michael Pyne committed
635 636
void PlayerManager::setRandomPlayMode(const QString &randomMode)
{
637
    if(randomMode.toLower() == "random")
Michael Pyne's avatar
Michael Pyne committed
638
        action<KToggleAction>("randomPlay")->setChecked(true);
639
    if(randomMode.toLower() == "albumrandom")
Michael Pyne's avatar
Michael Pyne committed
640
        action<KToggleAction>("albumRandomPlay")->setChecked(true);
641
    if(randomMode.toLower() == "norandom")
Michael Pyne's avatar
Michael Pyne committed
642 643 644
        action<KToggleAction>("disableRandomPlay")->setChecked(true);
}

645
#include "playermanager.moc"
646

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