playlist.h 19.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
public slots:
274
    /**
275
     * Remove the currently selected items from the playlist and disk.
276
     */
277
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
Scott Wheeler's avatar
Scott Wheeler committed
278 279 280 281

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

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

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

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

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

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

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

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

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

330
protected:
331 332 333 334
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
335
    void removeFromDisk(const PlaylistItemList &items);
336

337 338 339
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
340
    virtual QDragObject *dragObject(QWidget *parent);
341
    virtual QDragObject *dragObject() { return dragObject(this); }
342
    virtual bool canDecode(QMimeSource *s);
343
    virtual void decode(QMimeSource *s, PlaylistItem *after = 0);
344
    virtual void contentsDropEvent(QDropEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
345
    virtual void showEvent(QShowEvent *e);
346
    virtual bool acceptDrag(QDropEvent *e) const { return KURLDrag::canDecode(e); }
Scott Wheeler's avatar
Scott Wheeler committed
347 348 349 350 351 352 353 354

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

357 358 359 360 361 362 363 364
    /**
     * 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);

365 366 367 368
    /**
     * Though it's somewhat obvious, this function will stat the file, so only use it when
     * you're out of a performance critical loop.
     */
369
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
370

371
signals:
372
    /**
373
     * This is emitted when the playlist selection is changed.  This is used
374
     * primarily to notify the TagEditor of the new data.
375
     */
376
    void signalSelectionChanged(const PlaylistItemList &selection);
377
    void signalDoubleClicked();
378

379
    /**
380
     * This is connected to the PlaylistBox::Item to let it know when the
381 382
     * playlist's name has changed.
     */
383
    void signalNameChanged(const QString &fileName);
384

385
    /**
386 387 388 389
     * This signal is emitted when items are added to or removed from the list.
     *
     * \see signalDataChanged()
     * \see signalChanged()
390
     */
391
    void signalCountChanged(Playlist *);
392

393
    /**
394 395 396 397 398 399 400 401 402 403 404
     * 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
405 406 407 408
     * changed.
     */
    void signalChanged();

409
    /**
410
     * This signal is emitted just before a playlist item is removed from the
411 412 413
     * 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.
414
     */
415
    void signalAboutToRemove(PlaylistItem *item);
416 417 418 419

    /**
     * This is emitted when \a files are dropped on a specific playlist.
     */
420
    void signalFilesDropped(const QStringList &files, Playlist *, PlaylistItem *after);
421 422 423 424 425

    /**
     * Set the next item to be played in the current playlist.  This is used by
     * the "Play Next" feature.
     */
426
    void signalSetNext(PlaylistItem *item);
427 428 429 430 431 432 433 434

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

437 438 439 440 441
    /**
     * Request creation of a playlist based on \a items.
     */
    void signalCreatePlaylist(const PlaylistItemList &items);

442 443
private:
    void setup();
444 445 446 447 448 449 450

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

453
    /**
454
     * Save the tag for an individual item.
455
     */
456
    void applyTag(QListViewItem *item, const QString &text, int column);
457 458 459 460 461 462

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

465 466 467 468 469 470
    /**
     * 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;

471
private slots:
472 473 474 475 476

    /**
     * This is just used to emit the selection as a list of PlaylistItems when
     * the selection changes.
     */
477
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
478 479 480 481 482

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

    /**
486 487 488
     * This slot applys the tag for a specific item.
     *
     * \see applyTag()
489 490 491 492 493 494 495
     */
    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.
     */
496
    void slotRenameTag();
497 498 499 500 501

    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
502
    void slotColumnOrderChanged(int, int from, int to);
503 504 505 506 507 508 509

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

512 513 514 515 516
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
    void slotCreateGroup() { emit signalCreatePlaylist(selectedItems()); }

517
private:
518
    StringHash m_members;
519
    int m_currentColumn;
520 521
    int m_processed;
    bool m_allowDuplicates;
522 523 524 525 526
    /**
     * 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;
Scott Wheeler's avatar
Scott Wheeler committed
527
    PlaylistItemList m_history;
528

529
    QString m_fileName;
530

531
    /**
532
     * Used to store the text for inline editing before it is changed so that
533 534 535 536
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
537 538 539 540 541

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
542
    QString m_playlistName;
543

544 545 546
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
547

548 549
    int m_rmbPasteID;
    int m_rmbEditID;
550 551 552
    int m_selectedCount;

    PlaylistItem *m_lastSelected;
553

554 555
    static PlaylistItem *m_playingItem;
    static int m_leftColumn;
556 557

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
558
    PlaylistSearch m_search;
559 560

    bool m_polished;
561 562
};

563 564 565
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

566 567
// template method implementations

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
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
	return 0;    
}

613 614 615 616 617 618 619
template <class CollectionItemType, class ItemType, class SiblingType>
void Playlist::createItems(const QValueList<SiblingType *> &siblings)
{
    ItemType *previous = 0;

    QValueListConstIterator<SiblingType *> it = siblings.begin();
    for(; it != siblings.end(); ++it) {
620
	if(!m_members.insert(resolveSymLinks((*it)->absFilePath())) || m_allowDuplicates) {
621 622 623 624 625 626 627 628
	    previous = new ItemType((*it)->collectionItem(), this, previous);
	    connect((*it)->collectionItem(), SIGNAL(destroyed()), (*it), SLOT(deleteLater()));
	}
    }

    emit signalCountChanged(this);
}

629
#endif