playermanager.cpp 18.1 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
Port it  
Laurent Montel committed
73
    new PlayerAdaptor( this );
74 75 76 77 78 79 80 81 82 83 84 85
}

PlayerManager::~PlayerManager()
{
}

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

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

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

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

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

104
    return m_media[m_curOutputPath]->state() == Phonon::PausedState;
105 106 107 108
}

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

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

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

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

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

126 127 128
    return 0;
}

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

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

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

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

145 146 147 148 149 150 151
QStringList PlayerManager::trackProperties()
{
    return FileHandle::properties();
}

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

    return m_file.property(property);
}

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

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

    return QPixmap();
}

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

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

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

    return str;
186 187
}

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

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

198 199 200 201
////////////////////////////////////////////////////////////////////////////////
// public slots
////////////////////////////////////////////////////////////////////////////////

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

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

210 211 212 213
    stopCrossfade();

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

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

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

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

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

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

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

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

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

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

    emit signalPause();
272 273 274 275
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

382 383 384
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////
385

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

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

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

400 401
void PlayerManager::slotFinished()
{
402 403 404 405
    // 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
406 407 408 409 410 411
    // 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;
412

413 414
    m_playlistInterface->playNext();
    m_file = m_playlistInterface->currentFile();
415

416 417 418 419 420 421 422
    if(m_file.isNull()) {
        stop();
    }
    else {
        m_media[m_curOutputPath]->setCurrentSource(m_file.absFilePath());
        m_media[m_curOutputPath]->play();
    }
423 424
}

425 426 427 428 429
void PlayerManager::slotLength(qint64 msec)
{
    m_statusLabel->setItemTotalTime(msec / 1000);
}

430
void PlayerManager::slotTick(qint64 msec)
431
{
432
    if(!m_setup || !m_playlistInterface)
433
        return;
434

435
    if(m_statusLabel)
436
        m_statusLabel->setItemCurrentTime(msec / 1000);
437 438
}

439
void PlayerManager::slotStateChanged(Phonon::State newstate, Phonon::State oldstate)
Matthias Kretz's avatar
Matthias Kretz committed
440
{
441 442 443 444 445 446
    // 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
447
    if(newstate == Phonon::ErrorState) {
448 449 450 451 452 453
        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(),
454
              mediaObject->errorString()
455 456
            );

457
        switch(mediaObject->errorType()) {
458 459 460
            case Phonon::NoError:
                kDebug() << "received a state change to ErrorState but errorType is NoError!?";
                break;
461

Matthias Kretz's avatar
Matthias Kretz committed
462 463
            case Phonon::NormalError:
                forward();
464
                KMessageBox::information(0, errorMessage);
Matthias Kretz's avatar
Matthias Kretz committed
465
                break;
466

Matthias Kretz's avatar
Matthias Kretz committed
467 468
            case Phonon::FatalError:
                stop();
469
                KMessageBox::sorry(0, errorMessage);
Matthias Kretz's avatar
Matthias Kretz committed
470 471 472
                break;
        }
    }
473

474 475 476 477 478
    // Now bail out if we're not dealing with the currently playing media
    // object.

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

480 481 482 483 484 485
    // 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
486
        emit signalStop();
487
    }
488 489 490 491 492 493 494 495 496 497
    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();
    }
498 499
}

500 501 502 503 504 505 506 507
////////////////////////////////////////////////////////////////////////////////
// private members
////////////////////////////////////////////////////////////////////////////////

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

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

519 520 521 522
    if(m_setup)
        return;
    m_setup = true;

523 524 525 526 527 528
    // 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);
529

530 531 532
        m_media[i] = new Phonon::MediaObject(this);
        m_audioPath[i] = Phonon::createPath(m_media[i], m_output[i]);
        m_media[i]->setTickInterval(200);
533
        m_media[i]->setPrefinishMark(2000);
534

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

547 548
    // initialize action states

549 550 551 552
    action("pause")->setEnabled(false);
    action("stop")->setEnabled(false);
    action("back")->setEnabled(false);
    action("forward")->setEnabled(false);
553
    action("forwardAlbum")->setEnabled(false);
554

555
    // setup sliders (a separate slot is used to switch as needed)
556

557
    m_sliderAction = action<SliderAction>("trackPositionAction");
558

559
    if(m_sliderAction->trackPositionSlider())
560 561
        m_sliderAction->trackPositionSlider()->setMediaObject(m_media[0]);

562
    if(m_sliderAction->volumeSlider())
563
        m_sliderAction->volumeSlider()->setAudioOutput(m_output[0]);
564 565

    QDBusConnection::sessionBus().registerObject("/Player", this);
566 567 568 569 570 571
}

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

573 574
    disconnect(m_media[1 - m_curOutputPath], 0, this, SLOT(slotUpdateSliders()));
    connect(m_media[1 - m_curOutputPath], SIGNAL(finished()), SLOT(slotFinished()));
575 576
}

577
void PlayerManager::slotUpdateGuiIfStopped()
578
{
579 580 581
    if(m_media[0]->state() == Phonon::StoppedState && m_media[1]->state() == Phonon::StoppedState)
        stop();
}
582

583 584 585
void PlayerManager::crossfadeToFile(const FileHandle &newFile)
{
    int nextOutputPath = 1 - m_curOutputPath;
586

587 588 589
    // Don't need this anymore
    disconnect(m_media[m_curOutputPath], SIGNAL(finished()), this, 0);
    connect(m_media[nextOutputPath], SIGNAL(finished()), SLOT(slotFinished()));
590

591 592 593
    // 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()));
594

595
    m_fader[nextOutputPath]->setVolume(0.0f);
596

597 598
    m_media[nextOutputPath]->setCurrentSource(newFile.absFilePath());
    m_media[nextOutputPath]->play();
599

600 601
    m_fader[m_curOutputPath]->setVolume(1.0f);
    m_fader[m_curOutputPath]->fadeTo(0.0f, 2000);
602

603
    m_fader[nextOutputPath]->fadeTo(1.0f, 2000);
604

605 606
    m_curOutputPath = nextOutputPath;
}
607

608 609 610 611
void PlayerManager::stopCrossfade()
{
    // According to the Phonon docs, setVolume immediately takes effect,
    // which is "good enough for government work" ;)
612

613 614 615
    // 1 - curOutputPath is the other output path...
    m_fader[m_curOutputPath]->setVolume(1.0f);
    m_fader[1 - m_curOutputPath]->setVolume(0.0f);
616

617 618 619 620 621 622 623 624
    // 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();
625 626
}

Michael Pyne's avatar
Michael Pyne committed
627 628 629 630 631 632 633 634 635
QString PlayerManager::randomPlayMode() const
{
    if(action<KToggleAction>("randomPlay")->isChecked())
        return "Random";
    if(action<KToggleAction>("albumRandomPlay")->isChecked())
        return "AlbumRandom";
    return "NoRandom";
}

636 637 638 639 640
void PlayerManager::setCrossfadeEnabled(bool crossfadeEnabled)
{
    m_crossfadeTracks = crossfadeEnabled;
}

Michael Pyne's avatar
Michael Pyne committed
641 642
void PlayerManager::setRandomPlayMode(const QString &randomMode)
{
643
    if(randomMode.toLower() == "random")
Michael Pyne's avatar
Michael Pyne committed
644
        action<KToggleAction>("randomPlay")->setChecked(true);
645
    if(randomMode.toLower() == "albumrandom")
Michael Pyne's avatar
Michael Pyne committed
646
        action<KToggleAction>("albumRandomPlay")->setChecked(true);
647
    if(randomMode.toLower() == "norandom")
Michael Pyne's avatar
Michael Pyne committed
648 649 650
        action<KToggleAction>("disableRandomPlay")->setChecked(true);
}

651
#include "playermanager.moc"
652

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