playlist.h 20.5 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() const;
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
    void hideColumn(int c);
    void showColumn(int c);
    bool isColumnVisible(int c) const;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

442 443 444 445 446
    /**
     * Request creation of a playlist based on \a items.
     */
    void signalCreatePlaylist(const PlaylistItemList &items);

447 448
private:
    void setup();
449 450 451 452 453 454 455

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

458
    /**
459
     * Save the tag for an individual item.
460
     */
461
    void applyTag(PlaylistItem *item, const QString &text, int column);
462 463 464 465 466 467

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

470 471 472 473 474
    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

475 476 477 478 479 480
    /**
     * 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;

481
private slots:
482

483 484
    void slotUpdateColumnWidths();

485 486 487 488
    /**
     * This is just used to emit the selection as a list of PlaylistItems when
     * the selection changes.
     */
489
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
490 491 492 493 494

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

    /**
498 499 500
     * This slot applys the tag for a specific item.
     *
     * \see applyTag()
501 502 503 504 505 506 507
     */
    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.
     */
508
    void slotRenameTag();
509 510 511 512 513

    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
514
    void slotColumnOrderChanged(int, int from, int to);
515 516 517 518 519 520 521

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

524 525 526 527 528
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
    void slotCreateGroup() { emit signalCreatePlaylist(selectedItems()); }

529 530 531 532 533 534
    /**
     * 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);

535 536 537 538 539 540 541 542
    /**
     * 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);

543
private:
544
    StringHash m_members;
545

546
    int m_currentColumn;
547
    int m_processed;
548 549 550 551 552 553

    int m_rmbPasteID;
    int m_rmbEditID;

    int m_selectedCount;

554
    bool m_allowDuplicates;
555 556
    bool m_polished;

557
    QValueList<int> m_weightDirty;
558
    bool m_disableColumnWidthUpdates;
559
    /**
560
     * The average minimum widths of columns to be used in balancing calculations.
561
     */
562
    QValueVector<int> m_columnWeights;
563 564
    QValueVector<int> m_columnFixedWidths;
    bool m_widthsDirty;
565 566

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
567
    PlaylistItemList m_history;
568
    PlaylistSearch m_search;
569

570
    PlaylistItem *m_lastSelected;
571

572
    /**
573
     * Used to store the text for inline editing before it is changed so that
574 575 576 577
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
578 579 580 581 582

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
583
    QString m_playlistName;
584
    QString m_fileName;
585

586 587 588
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
589

590 591 592 593 594
    /**
     * 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;
595
    static int m_leftColumn;
596
    static PlaylistItem *m_playingItem;
597 598
};

599 600 601
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

602 603
// template method implementations

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 639 640 641 642 643 644 645
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
646
	return 0;
647 648
}

649 650 651
template <class CollectionItemType, class ItemType, class SiblingType>
void Playlist::createItems(const QValueList<SiblingType *> &siblings)
{
652 653 654 655
    if(siblings.isEmpty())
	return;

    m_disableColumnWidthUpdates = true;
656 657 658 659
    ItemType *previous = 0;

    QValueListConstIterator<SiblingType *> it = siblings.begin();
    for(; it != siblings.end(); ++it) {
660
	if(!m_members.insert(resolveSymLinks((*it)->absFilePath())) || m_allowDuplicates) {
661 662 663 664 665 666
	    previous = new ItemType((*it)->collectionItem(), this, previous);
	    connect((*it)->collectionItem(), SIGNAL(destroyed()), (*it), SLOT(deleteLater()));
	}
    }

    emit signalCountChanged(this);
667
    m_disableColumnWidthUpdates = false;
668
    slotWeightDirty();
669 670
}

671
#endif