playlist.h 20.1 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 24

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

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

class KPopupMenu;
33
class KActionMenu;
34 35

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

class PlaylistSearch;

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

43 44
typedef QValueList<Playlist *> PlaylistList;

45 46 47
class Playlist : public KListView
{
    Q_OBJECT
48

49
public:
50

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

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

63 64
    virtual ~Playlist();

65 66 67
    /**
     * 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
68
     * name.
69
     */
70
    virtual void save();
Scott Wheeler's avatar
Scott Wheeler committed
71 72 73 74 75

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

    /**
     * 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()
     */
91
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
Scott Wheeler's avatar
Scott Wheeler committed
92 93 94 95 96

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

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

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

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

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

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

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

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

Scott Wheeler's avatar
Scott Wheeler committed
139 140 141 142 143 144 145
    /**
     * 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.     
     */
146 147 148 149 150 151
    template <class ItemType, class CollectionItemType, class CollectionListType>
    ItemType *createItem(const QFileInfo &file,
			 const QString &absFilePath = QString::null,
			 QListViewItem *after = 0,
			 bool emitChanged = true);

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

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

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

166 167 168 169
    void hideColumn(int c);
    void showColumn(int c);
    bool isColumnVisible(int c) const;

170
    /**
171
     * If m_playlistName has no value -- i.e. the name has not been set to
172
     * something other than the filename, this returns the filename less the
173
     * extension.  If m_playlistName does have a value, this returns that.
174
     */
175
    QString name() const;
176

177 178
    /**
     * This sets a name for the playlist that is \e different from the file name.
179
     */
180
    void setName(const QString &n);
181

182 183 184
    /**
     * Returns the number of items in the playlist.
     */
185
    int count() const { return childCount(); }
186

187
    /**
188 189 190 191 192
     * 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).
193
     */
194
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
195 196 197 198 199 200

    /**
     * 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.
     */
201
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
202

203 204 205 206
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
207
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
208

209 210 211 212 213 214 215 216
    /**
     * 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
217
    bool playing() const;
218

Scott Wheeler's avatar
Scott Wheeler committed
219 220 221
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
222
     */
Scott Wheeler's avatar
Scott Wheeler committed
223
    void updateLeftColumn();
224

225 226 227 228
    /**
     * Sets the items in the list to be either visible based on the value of
     * visible.  This is useful for search operations and such.
     */
229 230
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

231 232 233 234
    /**
     * 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
235
    PlaylistSearch search() const { return m_search; }
236 237 238 239 240 241

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

244 245 246 247 248 249 250 251
    /**
     * 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); }
252

Scott Wheeler's avatar
Scott Wheeler committed
253 254 255
    /**
     * Marks \a item as either selected or deselected based.
     */
256 257
    void markItemSelected(PlaylistItem *item, bool selected);

Scott Wheeler's avatar
Scott Wheeler committed
258 259 260 261 262 263
    /**
     * 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.
     */
264
    virtual int columnOffset() const { return 0; }
Scott Wheeler's avatar
Scott Wheeler committed
265 266 267 268 269 270

    /**
     * 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.
     */
271
    virtual bool readOnly() const { return false; }
272

273 274
    void setColumnWidthUpdatesDisabled(bool disabled) { m_disableColumnWidthUpdates = disabled; }

275
public slots:
276
    /**
277
     * Remove the currently selected items from the playlist and disk.
278
     */
279
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
Scott Wheeler's avatar
Scott Wheeler committed
280 281 282 283

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

286 287 288 289
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
290
    virtual void cut() { copy(); clear(); }
Scott Wheeler's avatar
Scott Wheeler committed
291 292 293 294 295

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
296
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
297 298 299 300

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
301
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
302 303 304 305 306 307 308

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

312 313 314 315 316 317
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

318
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
319 320 321 322 323 324

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

327 328 329
    /**
     * Reload the playlist contents from the m3u file.
     */
330
    virtual void slotReload();
331

332 333 334 335 336 337 338
    /**
     * 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.
     */
    void slotWidthDirty(int column = -1);

339
protected:
340 341 342 343
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
344
    void removeFromDisk(const PlaylistItemList &items);
345

346 347 348
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
349
    virtual QDragObject *dragObject(QWidget *parent);
350
    virtual QDragObject *dragObject() { return dragObject(this); }
351
    virtual bool canDecode(QMimeSource *s);
352
    virtual void decode(QMimeSource *s, PlaylistItem *after = 0);
353
    virtual void contentsDropEvent(QDropEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
354
    virtual void showEvent(QShowEvent *e);
355
    virtual bool acceptDrag(QDropEvent *e) const { return KURLDrag::canDecode(e); }
356 357 358 359
    virtual void viewportPaintEvent(QPaintEvent *pe);
    virtual void viewportResizeEvent(QResizeEvent *re);

    void addColumn(const QString &label);
Scott Wheeler's avatar
Scott Wheeler committed
360 361 362 363 364 365 366 367

    /**
     * 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.
     */
368
    virtual void polish();
369

370 371 372 373 374 375 376 377
    /**
     * 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);

378 379 380 381
    /**
     * Though it's somewhat obvious, this function will stat the file, so only use it when
     * you're out of a performance critical loop.
     */
382
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
383

384
signals:
385
    /**
386
     * This is emitted when the playlist selection is changed.  This is used
387
     * primarily to notify the TagEditor of the new data.
388
     */
389
    void signalSelectionChanged(const PlaylistItemList &selection);
390
    void signalDoubleClicked();
391

392
    /**
393
     * This is connected to the PlaylistBox::Item to let it know when the
394 395
     * playlist's name has changed.
     */
396
    void signalNameChanged(const QString &fileName);
397

398
    /**
399 400 401 402
     * This signal is emitted when items are added to or removed from the list.
     *
     * \see signalDataChanged()
     * \see signalChanged()
403
     */
404
    void signalCountChanged(Playlist *);
405

406
    /**
407 408 409 410 411 412 413 414 415 416 417
     * 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
418 419 420 421
     * changed.
     */
    void signalChanged();

422
    /**
423
     * This signal is emitted just before a playlist item is removed from the
424 425 426
     * 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.
427
     */
428
    void signalAboutToRemove(PlaylistItem *item);
429 430 431 432

    /**
     * This is emitted when \a files are dropped on a specific playlist.
     */
433
    void signalFilesDropped(const QStringList &files, Playlist *, PlaylistItem *after);
434 435 436 437 438

    /**
     * Set the next item to be played in the current playlist.  This is used by
     * the "Play Next" feature.
     */
439
    void signalSetNext(PlaylistItem *item);
440 441 442 443 444 445 446 447

    /**
     * This is emitted when the set of columns that is visible is changed.
     *
     * \see hideColumn()
     * \see showColumn()
     * \see isColumnVisible()
     */
448
    void signalVisibleColumnsChanged();
449

450 451 452 453 454
    /**
     * Request creation of a playlist based on \a items.
     */
    void signalCreatePlaylist(const PlaylistItemList &items);

455 456
private:
    void setup();
457 458 459 460 461 462 463

    /**
     * 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.
     */
464
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
465

466
    /**
467
     * Save the tag for an individual item.
468
     */
469
    void applyTag(QListViewItem *item, const QString &text, int column);
470 471 472 473 474 475

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

478 479 480 481 482 483 484
    void updateColumnWidths();

    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

485
private:
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 496 497

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

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

    /**
507 508 509
     * This slot applys the tag for a specific item.
     *
     * \see applyTag()
510 511 512 513 514 515 516
     */
    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.
     */
517
    void slotRenameTag();
518 519 520 521 522

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

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

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

538
private:
539
    StringHash m_members;
540

541
    int m_currentColumn;
542
    int m_processed;
543 544 545 546 547 548

    int m_rmbPasteID;
    int m_rmbEditID;

    int m_selectedCount;

549
    bool m_allowDuplicates;
550 551 552
    bool m_polished;

    QValueList<int> m_widthDirty;
553
    bool m_disableColumnWidthUpdates;
554
    /**
555
     * The average minimum widths of columns to be used in balancing calculations.
556
     */
557 558 559
    QValueVector<int> m_columnWeights;

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
560
    PlaylistItemList m_history;
561
    PlaylistSearch m_search;
562

563
    PlaylistItem *m_lastSelected;
564

565
    /**
566
     * Used to store the text for inline editing before it is changed so that
567 568 569 570
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
571 572 573 574 575

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
576
    QString m_playlistName;
577
    QString m_fileName;
578

579 580 581
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
582

583 584 585 586 587
    /**
     * 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;
588
    static int m_leftColumn;
589
    static PlaylistItem *m_playingItem;
590 591
};

592 593 594
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

595 596
// template method implementations

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
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
639
	return 0;
640 641
}

642 643 644
template <class CollectionItemType, class ItemType, class SiblingType>
void Playlist::createItems(const QValueList<SiblingType *> &siblings)
{
645 646 647 648
    if(siblings.isEmpty())
	return;

    m_disableColumnWidthUpdates = true;
649 650 651 652
    ItemType *previous = 0;

    QValueListConstIterator<SiblingType *> it = siblings.begin();
    for(; it != siblings.end(); ++it) {
653
	if(!m_members.insert(resolveSymLinks((*it)->absFilePath())) || m_allowDuplicates) {
654 655 656 657 658 659
	    previous = new ItemType((*it)->collectionItem(), this, previous);
	    connect((*it)->collectionItem(), SIGNAL(destroyed()), (*it), SLOT(deleteLater()));
	}
    }

    emit signalCountChanged(this);
660 661
    m_disableColumnWidthUpdates = false;
    slotWidthDirty();
662 663
}

664
#endif