playlist.h 20.9 KB
Newer Older
1 2 3 4 5
/***************************************************************************
                          playlist.h  -  description
                             -------------------
    begin                : Sat Feb 16 2002
    copyright            : (C) 2002 by Scott Wheeler
6
    email                : wheeler@kde.org
7 8 9 10 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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef PLAYLIST_H
#define PLAYLIST_H

#include <klistview.h>
22
#include <kurldrag.h>
23
#include <kglobalsettings.h>
24 25

#include <qstringlist.h>
26
#include <qvaluevector.h>
27
#include <qptrstack.h>
28

29
#include "stringhash.h"
Scott Wheeler's avatar
Scott Wheeler committed
30
#include "playlistsearch.h"
31
#include "tagguesser.h"
32 33

class KPopupMenu;
34
class KActionMenu;
35 36

class QEvent;
Scott Wheeler's avatar
Scott Wheeler committed
37 38 39 40 41 42
class QFileInfo;

class PlaylistSearch;

class PlaylistItem;
typedef QValueList<PlaylistItem *> PlaylistItemList;
43

44 45
typedef QValueList<Playlist *> PlaylistList;

46 47 48
class Playlist : public KListView
{
    Q_OBJECT
49

50
public:
51

52 53
    /**
     * Before creating a playlist directly, please see
54 55
     * PlaylistSplitter::createPlaylist().
     */
56
    Playlist(QWidget *parent, const QString &name = QString::null);
57

58 59
    /**
     * Before creating a playlist directly, please see
60 61
     * PlaylistSplitter::openPlaylist().
     */
62
    Playlist(const QFileInfo &playlistFile, QWidget *parent, const QString &name);
63

64 65
    virtual ~Playlist();

66 67 68
    /**
     * Saves the file to the currently set file name.  If there is no filename
     * currently set, the default behavior is to prompt the user for a file
69
     * name.
70
     */
71
    virtual void save();
Scott Wheeler's avatar
Scott Wheeler committed
72 73 74 75 76

    /**
     * Standard "save as".  Prompts the user for a location where to save the
     * playlist to.
     */
77
    virtual void saveAs();
Scott Wheeler's avatar
Scott Wheeler committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91

    /**
     * Removes \a item from the Playlist, but not from the disk.  If
     * \a emitChanged is true this will also notify relevant classes
     * that the content of the list has changed.
     *
     * In some situations, for instance when removing items in a loop, it is
     * preferable to delay this notification until after other operations have
     * completed.  In those cases set \a emitChanged to false and call the
     * signal directly.
     *
     * @see signalCountChanged()
     * @see emitCountChanged()
     */
92
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
Scott Wheeler's avatar
Scott Wheeler committed
93 94 95 96 97

    /**
     * Remove \a items from the playlist and emit a signal indicating
     * that the number of items in the list has changed.
     */
98
    virtual void clearItems(const PlaylistItemList &items);
99

100 101
    /**
     * All of the (media) files in the list.
102
     */
103
    QStringList files();
104

105
    /**
106 107
     * Returns a list of all of the \e visible items in the playlist.
     */
108
    virtual PlaylistItemList items();
109

110
    /**
111
     * Returns a list of all of the items in the playlist.
112
     */
113
    PlaylistItemList visibleItems() const;
114

115 116 117
    /**
     * Returns a list of the currently selected items.
     */
118
    PlaylistItemList selectedItems() const;
119

120 121 122 123 124
    /**
     * Returns a list of the last 10 played items.
     */
    PlaylistItemList historyItems(PlaylistItem *current, bool random) const;

125 126
    /**
     * Allow duplicate files in the playlist.
127
     */
128
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
129

130
    /**
131
     * This is being used as a mini-factory of sorts to make the construction
132 133
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
134
     */
135 136
    virtual PlaylistItem *createItem(const QFileInfo &file,
				     const QString &absFilePath = QString::null,
137 138
				     QListViewItem *after = 0,
				     bool emitChanged = true);
139

Scott Wheeler's avatar
Scott Wheeler committed
140 141 142 143 144 145 146
    /**
     * This is implemented as a template method to allow subclasses to
     * instantiate their PlaylistItem subclasses using the same method.  Some
     * of the types here are artificially templatized (i.e. CollectionListType and
     * CollectionItemType) to avoid recursive includes, but in fact will always
     * be the same.     
     */
147 148 149 150 151 152
    template <class ItemType, class CollectionItemType, class CollectionListType>
    ItemType *createItem(const QFileInfo &file,
			 const QString &absFilePath = QString::null,
			 QListViewItem *after = 0,
			 bool emitChanged = true);

153
    virtual void createItems(const PlaylistItemList &siblings);
154

155 156 157 158
    /**
     * Returns the file name associated with this playlist (an m3u file) or
     * QString::null if no such file exists.
     */
159
    QString fileName() const { return m_fileName; }
160 161 162 163 164

    /**
     * Sets the file name to be associated with this playlist; this file should
     * have the "m3u" extension.
     */
165
    void setFileName(const QString &n) { m_fileName = n; }
166

167 168 169 170 171 172 173 174 175 176 177 178 179
    /**
     * Hides column \a c.  If \a emitChanged is true then a signal that the
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
    void hideColumn(int c, bool emitChanged = true);

    /**
     * Shows column \a c.  If \a emitChanged is true then a signal that the
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
    void showColumn(int c, bool emitChanged = true);
180 181
    bool isColumnVisible(int c) const;

182
    /**
183
     * If m_playlistName has no value -- i.e. the name has not been set to
184
     * something other than the filename, this returns the filename less the
185
     * extension.  If m_playlistName does have a value, this returns that.
186
     */
187
    QString name() const;
188

189 190
    /**
     * This sets a name for the playlist that is \e different from the file name.
191
     */
192
    void setName(const QString &n);
193

194 195 196
    /**
     * Returns the number of items in the playlist.
     */
197
    int count() const { return childCount(); }
198

199
    /**
200 201 202 203 204
     * Returns the next item to be played.  If random is false this is just
     * the next item in the playlist (or null if the current items is the last
     * item in the list).  If random is true, then it will select an item at
     * random from this list (and try to be a bit clever about it to not repeat
     * items before everything has been played at least once).
205
     */
206
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
207 208 209 210 211 212

    /**
     * Returns the item played before the currently playing item.  If random is
     * false, this is simply the item above the currently playing item in the
     * list.  If random is true this checks the history of recently played items.
     */
213
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
214

215 216 217 218
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
219
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
220

221 222 223 224 225 226 227 228
    /**
     * Set item to be the playing item; also set this list to be the playing list.
     */
    static void setPlaying(PlaylistItem *item, bool p = true);

    /**
     * Returns true if this playlist is currently playing.
     */
Scott Wheeler's avatar
Scott Wheeler committed
229
    bool playing() const;
230

Scott Wheeler's avatar
Scott Wheeler committed
231 232 233
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
234
     */
Scott Wheeler's avatar
Scott Wheeler committed
235
    void updateLeftColumn();
236

237 238 239 240
    /**
     * Sets the items in the list to be either visible based on the value of
     * visible.  This is useful for search operations and such.
     */
241 242
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

243 244 245 246
    /**
     * Returns the search associated with this list, or an empty search if one
     * has not yet been set.
     */
Scott Wheeler's avatar
Scott Wheeler committed
247
    PlaylistSearch search() const { return m_search; }
248 249 250 251 252 253

    /**
     * Set the search associtated with this playlist.
     *
     * \note This does not cause the search to be rerun.
     */
Scott Wheeler's avatar
Scott Wheeler committed
254 255
    void setSearch(const PlaylistSearch &s) { m_search = s; }

256 257 258 259 260 261 262 263
    /**
     * Emits a signal indicating that the number of items have changed.  This
     * is useful in conjunction with createItem() where emitChanged is false.
     *
     * In many situations it is not practical for speed reasons to trigger the
     * actions associated with signalCountChanged() after each insertion.
     */
    void emitCountChanged() { emit signalCountChanged(this); }
264

Scott Wheeler's avatar
Scott Wheeler committed
265 266 267
    /**
     * Marks \a item as either selected or deselected based.
     */
268 269
    void markItemSelected(PlaylistItem *item, bool selected);

Scott Wheeler's avatar
Scott Wheeler committed
270 271 272 273 274 275
    /**
     * Subclasses of Playlist which add new columns will set this value to
     * specify how many of those colums exist.  This allows the Playlist
     * class to do some internal calculations on the number and positions
     * of columns.
     */
276
    virtual int columnOffset() const { return 0; }
Scott Wheeler's avatar
Scott Wheeler committed
277 278 279 280 281 282

    /**
     * Some subclasses of Playlist will be "read only" lists (i.e. the history
     * playlist).  This is a way for those subclasses to indicate that to the
     * Playlist internals.
     */
283
    virtual bool readOnly() const { return false; }
284

285 286
    void setColumnWidthUpdatesDisabled(bool disabled) { m_disableColumnWidthUpdates = disabled; }

287
public slots:
288
    /**
289
     * Remove the currently selected items from the playlist and disk.
290
     */
291
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
Scott Wheeler's avatar
Scott Wheeler committed
292 293 294 295

    /**
     * Set the first selected item to be the next item returned by nextItem().
     */
296 297
    void slotSetNext();

298 299 300 301
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
302
    virtual void cut() { copy(); clear(); }
Scott Wheeler's avatar
Scott Wheeler committed
303 304 305 306 307

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
308
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
309 310 311 312

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
313
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
314 315 316 317 318 319 320

    /**
     * Removes the selected items from the list, but not the disk.
     *
     * @see clearItem()
     * @see clearItems()
     */
321
    virtual void clear();
322
    virtual void selectAll() { KListView::selectAll(true); }
323

324 325 326 327 328 329
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

330
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
331 332 333 334 335 336

    /**
     * Renames the selected items' files based on their tags contents.
     *
     * @see PlaylistItem::renameFile()
     */
337 338
    void slotRenameFile();

339 340 341
    /**
     * Reload the playlist contents from the m3u file.
     */
342
    virtual void slotReload();
343

344 345 346 347 348
    /**
     * Tells the listview that the next time that it paints that the weighted
     * column widths must be recalculated.  If this is called without a column
     * all visible columns are marked as dirty.
     */
349
    void slotWeightDirty(int column = -1);
350

351
protected:
352 353 354 355
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
356
    void removeFromDisk(const PlaylistItemList &items);
357

358 359 360
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
361
    virtual QDragObject *dragObject(QWidget *parent);
362
    virtual QDragObject *dragObject() { return dragObject(this); }
363
    virtual bool canDecode(QMimeSource *s);
364
    virtual void decode(QMimeSource *s, PlaylistItem *after = 0);
365
    virtual void contentsDropEvent(QDropEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
366
    virtual void showEvent(QShowEvent *e);
367
    virtual bool acceptDrag(QDropEvent *e) const { return KURLDrag::canDecode(e); }
368 369 370 371
    virtual void viewportPaintEvent(QPaintEvent *pe);
    virtual void viewportResizeEvent(QResizeEvent *re);

    void addColumn(const QString &label);
Scott Wheeler's avatar
Scott Wheeler committed
372 373 374 375 376 377 378 379

    /**
     * Here I'm using delayed setup of some things that aren't quite intuitive.
     * Creating columns and setting up connections are both time consuming if
     * there are a lot of playlists to initialize.  This moves that cost from the
     * startup time to the time when the widget is "polished" -- i.e. just before
     * it's painted the first time.
     */
380
    virtual void polish();
381

382 383 384 385 386 387 388 389
    /**
     * As a template this allows us to use the same code to initialize the items
     * in subclasses.  CollectionItemType should always be CollectionListItem and
     * ItemType should be a PlaylistItem subclass.
     */
    template <class CollectionItemType, class ItemType, class SiblingType>
    void createItems(const QValueList<SiblingType *> &siblings);

390 391 392 393
    /**
     * Though it's somewhat obvious, this function will stat the file, so only use it when
     * you're out of a performance critical loop.
     */
394
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
395

396
signals:
397
    /**
398
     * This is emitted when the playlist selection is changed.  This is used
399
     * primarily to notify the TagEditor of the new data.
400
     */
401
    void signalSelectionChanged(const PlaylistItemList &selection);
402
    void signalDoubleClicked();
403

404
    /**
405
     * This is connected to the PlaylistBox::Item to let it know when the
406 407
     * playlist's name has changed.
     */
408
    void signalNameChanged(const QString &fileName);
409

410
    /**
411 412 413 414
     * This signal is emitted when items are added to or removed from the list.
     *
     * \see signalDataChanged()
     * \see signalChanged()
415
     */
416
    void signalCountChanged(Playlist *);
417

418
    /**
419 420 421 422 423 424 425 426 427 428 429
     * This signal is connected to PlaylistItem::refreshed() in the PlaylistItem
     * class.  It is emitted when a playlist item's data has been changed.
     *
     * \see signalCountChanged()
     * \see signalChanged()
     */
    void signalDataChanged();

    /**
     * This is the union of signalDataChanged() and signalCountChanged().
     * It is emitted with either quantity or value of the PlaylistItems are
430 431 432 433
     * changed.
     */
    void signalChanged();

434
    /**
435
     * This signal is emitted just before a playlist item is removed from the
436 437 438
     * list allowing for any cleanup that needs to happen.  Typically this
     * is used to remove the item from the history and safeguard against
     * dangling pointers.
439
     */
440
    void signalAboutToRemove(PlaylistItem *item);
441 442 443 444

    /**
     * This is emitted when \a files are dropped on a specific playlist.
     */
445
    void signalFilesDropped(const QStringList &files, Playlist *, PlaylistItem *after);
446 447 448 449 450

    /**
     * Set the next item to be played in the current playlist.  This is used by
     * the "Play Next" feature.
     */
451
    void signalSetNext(PlaylistItem *item);
452

453 454 455 456 457
    /**
     * Request creation of a playlist based on \a items.
     */
    void signalCreatePlaylist(const PlaylistItemList &items);

458 459
private:
    void setup();
460 461 462 463 464 465 466

    /**
     * Load the playlist from a file.  \a fileName should be the absolute path.
     * \a fileInfo should point to the same file as \a fileName.  This is a
     * little awkward API-wise, but keeps us from throwing away useful
     * information.
     */
467
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
468

469
    /**
470
     * Save the tag for an individual item.
471
     */
472
    void applyTag(PlaylistItem *item, const QString &text, int column);
473 474 475 476 477 478

    /**
     * Returns the index of the left most visible column in the playlist.
     *
     * \see isColumnVisible()
     */
479
    int leftMostVisibleColumn() const;
480

481 482 483 484 485
    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

486 487 488 489 490 491
    /**
     * This class is used internally to store settings that are shared by all
     * of the playlists, such as column order.  It is implemented as a singleton.
     */
    class SharedSettings;

492
private slots:
493

494 495
    void slotUpdateColumnWidths();

496 497 498 499
    /**
     * This is just used to emit the selection as a list of PlaylistItems when
     * the selection changes.
     */
500
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
501 502 503 504 505

    /**
     * Show the RMB menu.  Matches the signature for the signal 
     * QListView::contextMenuRequested().
     */
506
    void slotShowRMBMenu(QListViewItem *item, const QPoint &point, int column);
507 508

    /**
509 510 511
     * This slot applys the tag for a specific item.
     *
     * \see applyTag()
512 513 514 515 516 517 518
     */
    void slotApplyModification(QListViewItem *, const QString &text, int column);

    /**
     * This starts the renaming process by displaying a line edit if the mouse is in 
     * an appropriate position.
     */
519
    void slotRenameTag();
520 521 522 523 524

    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
525
    void slotColumnOrderChanged(int, int from, int to);
526 527 528 529 530 531 532

    /**
     * Toggles a columns visible status.  Useful for KActions.
     *
     * \see hideColumn()
     * \see showColumn()
     */
533
    void slotToggleColumnVisible(int column);
534

535 536 537 538 539
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
    void slotCreateGroup() { emit signalCreatePlaylist(selectedItems()); }

540 541 542 543 544 545
    /**
     * This slot is called when the user drags the slider in the listview header
     * to manually set the size of the column.
     */
    void slotColumnSizeChanged(int column, int oldSize, int newSize);

546 547 548 549 550 551 552 553
    /**
     * The slot is called when the completion mode for the line edit in the
     * inline tag editor is changed.  It saves the settings and through the
     * magic of the SharedSettings class will apply it to the other playlists as
     * well.
     */
    void slotInlineCompletionModeChanged(KGlobalSettings::Completion mode);

554
private:
555
    StringHash m_members;
556

557
    int m_currentColumn;
558
    int m_processed;
559 560 561 562 563 564

    int m_rmbPasteID;
    int m_rmbEditID;

    int m_selectedCount;

565
    bool m_allowDuplicates;
566 567
    bool m_polished;

568
    QValueList<int> m_weightDirty;
569
    bool m_disableColumnWidthUpdates;
570
    /**
571
     * The average minimum widths of columns to be used in balancing calculations.
572
     */
573
    QValueVector<int> m_columnWeights;
574 575
    QValueVector<int> m_columnFixedWidths;
    bool m_widthsDirty;
576 577

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
578
    PlaylistItemList m_history;
579
    PlaylistSearch m_search;
580

581
    PlaylistItem *m_lastSelected;
582

583
    /**
584
     * Used to store the text for inline editing before it is changed so that
585 586 587 588
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
589 590 591 592 593

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
594
    QString m_playlistName;
595
    QString m_fileName;
596

597 598 599
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
600

601 602 603 604 605
    /**
     * This is used to indicate if the list of visible items has changed (via a 
     * call to setVisibleItems()) while random play is playing.
     */
    static bool m_visibleChanged;
606
    static int m_leftColumn;
607
    static PlaylistItem *m_playingItem;
608 609
};

610
QDataStream &operator<<(QDataStream &s, Playlist &p);
611 612
QDataStream &operator>>(QDataStream &s, Playlist &p);

613 614
// template method implementations

615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
template <class ItemType, class CollectionItemType, class CollectionListType>
ItemType *Playlist::createItem(const QFileInfo &file, const QString &absFilePath,
			       QListViewItem *after, bool emitChanged)
{
    QString filePath;

    if(absFilePath.isNull())
	filePath = resolveSymLinks(file);
    else
	filePath = absFilePath;

    CollectionItemType *item = CollectionListType::instance()->lookup(filePath);

    if(!item) {
	item = new CollectionItemType(file, filePath);

	// If a valid tag was not created, destroy the CollectionListItem.
	if(!item->isValid()) {
	    kdError(65432) << "Playlist::createItem() -- A valid tag was not created for \""
			   << file.filePath() << "\"" << endl;
	    delete item;
	    return 0;
	}
    }

    if(item && !m_members.insert(filePath) || m_allowDuplicates) {
	ItemType *i;
	if(after)
	    i = new ItemType(item, this, after);
	else
	    i = new ItemType(item, this);
        if(!m_randomList.isEmpty() && !m_visibleChanged)
            m_randomList.append(i);
	emit signalCountChanged(this);
	connect(item, SIGNAL(destroyed()), i, SLOT(deleteLater()));

	if(emitChanged)
	    emit signalCountChanged(this);

	return i;
    }
    else
657
	return 0;
658 659
}

660 661 662
template <class CollectionItemType, class ItemType, class SiblingType>
void Playlist::createItems(const QValueList<SiblingType *> &siblings)
{
663 664 665 666
    if(siblings.isEmpty())
	return;

    m_disableColumnWidthUpdates = true;
667 668 669 670
    ItemType *previous = 0;

    QValueListConstIterator<SiblingType *> it = siblings.begin();
    for(; it != siblings.end(); ++it) {
671
	if(!m_members.insert(resolveSymLinks((*it)->absFilePath())) || m_allowDuplicates) {
672 673 674 675 676 677
	    previous = new ItemType((*it)->collectionItem(), this, previous);
	    connect((*it)->collectionItem(), SIGNAL(destroyed()), (*it), SLOT(deleteLater()));
	}
    }

    emit signalCountChanged(this);
678
    m_disableColumnWidthUpdates = false;
679
    slotWeightDirty();
680 681
}

682
#endif