playlist.h 20.9 KB
Newer Older
1 2
/***************************************************************************
    begin                : Sat Feb 16 2002
3
    copyright            : (C) 2002 - 2004 by Scott Wheeler
4
    email                : wheeler@kde.org
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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>
20
#include <kurldrag.h>
Dirk Mueller's avatar
compile  
Dirk Mueller committed
21
#include <kdebug.h>
22
#include <kglobalsettings.h>
23

24
#include <qvaluevector.h>
Dirk Mueller's avatar
compile  
Dirk Mueller committed
25
#include <qfileinfo.h>
26

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

class KPopupMenu;
33
class KActionMenu;
34 35

class QEvent;
Scott Wheeler's avatar
Scott Wheeler committed
36

37
class PlaylistCollection;
Scott Wheeler's avatar
Scott Wheeler committed
38 39

class PlaylistItem;
40
class PlaylistToolTip;
41 42
class UpcomingPlaylist;

Scott Wheeler's avatar
Scott Wheeler committed
43
typedef QValueList<PlaylistItem *> PlaylistItemList;
44

45 46
typedef QValueList<Playlist *> PlaylistList;

47
class Playlist : public KListView, public PlaylistInterface
48 49
{
    Q_OBJECT
50

51
public:
52

53 54 55 56 57 58
    Playlist(PlaylistCollection *collection, const QString &name = QString::null,
	     const QString &iconName = "midi");
    Playlist(PlaylistCollection *collection, const PlaylistItemList &items,
	     const QString &name = QString::null, const QString &iconName = "midi");
    Playlist(PlaylistCollection *collection, const QFileInfo &playlistFile,
	     const QString &iconName = "midi");
59

60
    /**
61 62 63
     * This constructor should generally only be used either by the cache
     * restoration methods or by subclasses that want to handle calls to
     * PlaylistCollection::setupPlaylist() differently.
64
     */
65
    Playlist(PlaylistCollection *collection, bool delaySetup);
66

67 68
    virtual ~Playlist();

69 70 71 72 73 74 75 76 77 78 79

    // The following group of functions implement the PlaylistInterface API.

    virtual QString name() const;
    virtual FileHandle currentFile() const;
    virtual int count() const { return childCount(); }
    virtual int time() const;
    virtual void playNext();
    virtual void playPrevious();
    virtual void stop();

80 81 82
    /**
     * Plays the top item of the playlist.
     */
83 84
    void playFirst();

85 86 87
    /**
     * 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
88
     * name.
89
     */
90
    virtual void save();
Scott Wheeler's avatar
Scott Wheeler committed
91 92 93 94 95

    /**
     * Standard "save as".  Prompts the user for a location where to save the
     * playlist to.
     */
96
    virtual void saveAs();
Scott Wheeler's avatar
Scott Wheeler committed
97 98 99 100 101 102 103 104 105 106 107

    /**
     * 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.
     */
108
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
Scott Wheeler's avatar
Scott Wheeler committed
109 110 111 112 113

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

116 117 118 119 120 121
    /**
     * Accessor function to return a pointer to the currently playing file.
     *
     * @return 0 if no file is playing, otherwise a pointer to the PlaylistItem
     *     of the track that is currently playing.
     */
122
    static PlaylistItem *playingItem() { return m_playingItem; }
123

124 125
    /**
     * All of the (media) files in the list.
126
     */
127
    QStringList files() const;
128

129
    /**
Scott Wheeler's avatar
Scott Wheeler committed
130
     * Returns a list of all of the items in the playlist.
131
     */
132
    virtual PlaylistItemList items();
133

134
    /**
Scott Wheeler's avatar
Scott Wheeler committed
135
     * Returns a list of all of the \e visible items in the playlist.
136
     */
137
    PlaylistItemList visibleItems();
138

139 140 141
    /**
     * Returns a list of the currently selected items.
     */
142
    PlaylistItemList selectedItems();
143

144 145 146 147 148
    /**
     * Returns properly casted first child item in list.
     */
    PlaylistItem *firstChild() const;

149 150
    /**
     * Allow duplicate files in the playlist.
151
     */
152
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
153

154
    /**
155
     * This is being used as a mini-factory of sorts to make the construction
156 157
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
158
     */
159
    virtual PlaylistItem *createItem(const FileHandle &file,
160 161
				     QListViewItem *after = 0,
				     bool emitChanged = true);
162

Scott Wheeler's avatar
Scott Wheeler committed
163 164 165 166 167 168 169
    /**
     * 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.     
     */
170
    template <class ItemType, class CollectionItemType, class CollectionListType>
171
    ItemType *createItem(const FileHandle &file,
172 173 174
			 QListViewItem *after = 0,
			 bool emitChanged = true);

175
    virtual void createItems(const PlaylistItemList &siblings, PlaylistItem *after = 0);
176

177 178 179 180
    /**
     * This handles adding files of various types -- music, playlist or directory
     * files.  Music files that are found will be added to this playlist.  New
     * playlist files that are found will result in new playlists being created.
181 182 183 184
     *
     * Note that this should not be used in the case of adding *only* playlist
     * items since it has the overhead of checking to see if the file is a playlist
     * or directory first.
185 186 187 188
     */
    void addFiles(const QStringList &files, bool importPlaylists,
		  PlaylistItem *after = 0);

189 190 191 192
    /**
     * Returns the file name associated with this playlist (an m3u file) or
     * QString::null if no such file exists.
     */
193
    QString fileName() const { return m_fileName; }
194 195 196 197 198

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

201
    /**
202
     * Hides column \a c.  If \a updateSearch is true then a signal that the
203 204 205
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
206
    void hideColumn(int c, bool updateSearch = true);
207 208

    /**
209
     * Shows column \a c.  If \a updateSearch is true then a signal that the
210 211 212
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
213
    void showColumn(int c, bool updateSearch = true);
214 215
    bool isColumnVisible(int c) const;

216 217 218 219
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */
    void setName(const QString &n);
220

221 222 223 224
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
225
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
226

227
    /**
228 229
     * Set item to be the playing item.  If \a item is null then this will clear
     * the playing indicator.
230
     */
231
    static void setPlaying(PlaylistItem *item, bool addToHistory = true);
232 233 234 235

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

Scott Wheeler's avatar
Scott Wheeler committed
238 239 240
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
241
     */
Scott Wheeler's avatar
Scott Wheeler committed
242
    void updateLeftColumn();
243

244 245 246 247
    /**
     * Sets the items in the list to be either visible based on the value of
     * visible.  This is useful for search operations and such.
     */
248 249
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

250 251 252 253
    /**
     * 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
254
    PlaylistSearch search() const { return m_search; }
255 256 257 258

    /**
     * Set the search associtated with this playlist.
     */
259 260 261 262 263 264 265
    void setSearch(const PlaylistSearch &s);

    /**
     * If the search is disabled then all items will be shown, not just those that
     * match the current search.
     */
    void setSearchEnabled(bool searchEnabled);
Scott Wheeler's avatar
Scott Wheeler committed
266

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

Scott Wheeler's avatar
Scott Wheeler committed
272 273 274 275 276 277
    /**
     * 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.
     */
278
    virtual int columnOffset() const { return 0; }
Scott Wheeler's avatar
Scott Wheeler committed
279 280 281 282 283 284

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

287 288 289 290 291
    /**
     * Returns true if it's possible to reload this playlist.
     */
    virtual bool canReload() const { return !m_fileName.isNull(); }

292 293 294 295 296 297 298
    /**
     * Playlists have a common set of shared settings such as visible columns
     * that should be applied just before the playlist is shown.  Calling this
     * method applies those.
     */
    void applySharedSettings();

299 300
    void read(QDataStream &s);

301
public slots:
302
    /**
303
     * Remove the currently selected items from the playlist and disk.
304
     */
305
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
Scott Wheeler's avatar
Scott Wheeler committed
306

307 308 309 310
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
311
    virtual void cut() { copy(); clear(); }
Scott Wheeler's avatar
Scott Wheeler committed
312 313 314 315 316

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
317
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
318 319 320 321

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
322
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
323 324 325 326 327 328 329

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

333 334 335 336 337 338
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

339
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
340 341 342 343 344 345

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

348 349 350
    /**
     * Reload the playlist contents from the m3u file.
     */
351
    virtual void slotReload();
352

353 354 355 356 357
    /**
     * 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.
     */
358
    void slotWeightDirty(int column = -1);
359

360 361
    void slotShowPlaying();

362 363
    void slotColumnResizeModeChanged();

364
protected:
365 366 367 368
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
369
    void removeFromDisk(const PlaylistItemList &items);
370

371 372 373
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
374
    virtual QDragObject *dragObject(QWidget *parent);
375
    virtual QDragObject *dragObject() { return dragObject(this); }
376
    virtual bool canDecode(QMimeSource *s);
377
    virtual void decode(QMimeSource *s, PlaylistItem *after = 0);
378
    virtual void contentsDropEvent(QDropEvent *e);
379
    virtual void contentsMouseDoubleClickEvent(QMouseEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
380
    virtual void showEvent(QShowEvent *e);
381
    virtual bool acceptDrag(QDropEvent *e) const { return KURLDrag::canDecode(e); }
382 383 384 385
    virtual void viewportPaintEvent(QPaintEvent *pe);
    virtual void viewportResizeEvent(QResizeEvent *re);

    void addColumn(const QString &label);
Scott Wheeler's avatar
Scott Wheeler committed
386 387 388 389 390 391 392 393

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

396 397 398 399
    UpcomingPlaylist *upcomingPlaylist() const { return m_upcomingPlaylist; }

    void setUpcomingPlaylist(UpcomingPlaylist *playlist) { m_upcomingPlaylist = playlist; }

400 401 402 403 404 405 406 407
    /**
     * Do some finial initialization of created items.  Notably ensure that they
     * are shown or hidden based on the contents of the current PlaylistSearch.
     *
     * This is called by the PlaylistItem constructor.
     */
    void setupItem(PlaylistItem *item);

408 409 410 411 412 413
    /**
     * Forwards the call to the parent to enable or disable automatic deletion
     * of tree view playlists.  Used by CollectionListItem.
     */
    void setCanDeletePlaylist(bool canDelete);

414 415 416 417 418 419
    /**
     * 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>
420
    void createItems(const QValueList<SiblingType *> &siblings, ItemType *after = 0);
421

422 423 424 425
protected slots:
    void slotPopulateBackMenu() const;
    void slotPlayFromBackMenu(int number) const;

426
signals:
427

428
    /**
429
     * This is connected to the PlaylistBox::Item to let it know when the
430 431
     * playlist's name has changed.
     */
432
    void signalNameChanged(const QString &name);
433

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
    void signalEnableDirWatch(bool enable);

444 445
    void signalPlaylistItemsDropped(Playlist *p);

446 447
private:
    void setup();
448

449 450
    PlaylistItem *nextItem(PlaylistItem *current = 0) const;

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

459
    /**
Scott Wheeler's avatar
Scott Wheeler committed
460
     * Writes \a text to \a item in \a column.  This is used by the inline tag
461
     * editor.  Returns false if the tag update failed.
462
     */
463
    bool editTag(PlaylistItem *item, const QString &text, int column);
464 465 466 467 468 469

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

472 473 474 475 476 477 478 479 480 481
    /**
     * This method is used internally to provide the backend to the other item
     * lists.
     *
     * \see items()
     * \see visibleItems()
     * \see selectedItems()
     */
    PlaylistItemList items(QListViewItemIterator::IteratorFlag flags);

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

487 488 489 490
    PlaylistItem *addFile(const QString &file, bool importPlaylists, PlaylistItem *after);

    void redisplaySearch() { setSearch(m_search); }

491 492 493 494 495 496
    /**
     * 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;

497
private slots:
498

499 500
    void slotUpdateColumnWidths();

501 502
    void slotAddToUpcoming();

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

    /**
Scott Wheeler's avatar
Scott Wheeler committed
510 511
     * This slot is called when the inline tag editor has completed its editing
     * and starts the process of renaming the values.
512
     *
Scott Wheeler's avatar
Scott Wheeler committed
513
     * \see editTag()
514
     */
Scott Wheeler's avatar
Scott Wheeler committed
515
    void slotInlineEditDone(QListViewItem *, const QString &, int column);
516 517 518 519 520

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

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

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

537 538 539
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
540
    void slotCreateGroup();
541

542 543 544 545 546 547
    /**
     * 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);

548 549 550 551 552 553 554 555
    /**
     * 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);

556 557
    void slotPlayCurrent();

558
private:
559 560
    PlaylistCollection *m_collection;

561
    StringHash m_members;
562

563
    int m_currentColumn;
564
    int m_processed;
565
    int m_rmbEditID;
566
    int m_rmbUpcomingID;
567 568
    int m_selectedCount;

569
    bool m_allowDuplicates;
570
    bool m_polished;
571
    bool m_applySharedSettings;
572
    bool m_mousePressed;
573

574
    QValueList<int> m_weightDirty;
575
    bool m_disableColumnWidthUpdates;
576

577
    /**
578
     * The average minimum widths of columns to be used in balancing calculations.
579
     */
580
    QValueVector<int> m_columnWeights;
581 582
    QValueVector<int> m_columnFixedWidths;
    bool m_widthsDirty;
583 584

    PlaylistItemList m_randomList;
585
    static PlaylistItemList m_history;
586
    PlaylistSearch m_search;
587

588 589
    bool m_searchEnabled;

590
    PlaylistItem *m_lastSelected;
591

592
    /**
593
     * Used to store the text for inline editing before it is changed so that
594 595 596 597
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
598 599 600 601 602

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
603
    QString m_playlistName;
604
    QString m_fileName;
605

606 607 608
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
609
    PlaylistToolTip *m_toolTip;
610

611 612 613 614 615
    /**
     * 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;
616
    static int m_leftColumn;
617
    static PlaylistItem *m_playingItem;
618
    static UpcomingPlaylist *m_upcomingPlaylist;
619
    static QMap<int, PlaylistItem *> m_backMenuItems;
620 621
};

622
bool processEvents();
623

624
QDataStream &operator<<(QDataStream &s, const Playlist &p);
625 626
QDataStream &operator>>(QDataStream &s, Playlist &p);

627 628
// template method implementations

629
template <class ItemType, class CollectionItemType, class CollectionListType>
630 631
ItemType *Playlist::createItem(const FileHandle &file, QListViewItem *after,
			       bool emitChanged)
632
{
633
    CollectionItemType *item = CollectionListType::instance()->lookup(file.absFilePath());
634 635

    if(!item) {
636
	item = new CollectionItemType(file);
637
	setupItem(item);
638 639

	// If a valid tag was not created, destroy the CollectionListItem.
640

641 642
	if(!item->isValid()) {
	    kdError(65432) << "Playlist::createItem() -- A valid tag was not created for \""
643
			   << file.absFilePath() << "\"" << endl;
644 645 646 647 648
	    delete item;
	    return 0;
	}
    }

649
    if(item && !m_members.insert(file.absFilePath()) || m_allowDuplicates) {
650

651
	ItemType *i = after ? new ItemType(item, this, after) : new ItemType(item, this);
652 653
	setupItem(i);

654 655
        if(!m_randomList.isEmpty() && !m_visibleChanged)
            m_randomList.append(i);
656

657
	if(emitChanged)
658
	    dataChanged();
659 660 661 662

	return i;
    }
    else
663
	return 0;
664 665
}

666
template <class CollectionItemType, class ItemType, class SiblingType>
667
void Playlist::createItems(const QValueList<SiblingType *> &siblings, ItemType *after)
668
{
669 670 671 672
    if(siblings.isEmpty())
	return;

    m_disableColumnWidthUpdates = true;
673
    ItemType *newItem = after;
674 675 676

    QValueListConstIterator<SiblingType *> it = siblings.begin();
    for(; it != siblings.end(); ++it) {
677
	if(!m_members.insert((*it)->file().absFilePath()) || m_allowDuplicates) {
678 679 680 681
	    newItem = new ItemType((*it)->collectionItem(), this, newItem);
	    setupItem(newItem);
	    if(!m_randomList.isEmpty() && !m_visibleChanged)
		m_randomList.append(newItem);
682 683 684
	}
    }

685
    dataChanged();
686
    m_disableColumnWidthUpdates = false;
687
    slotWeightDirty();
688 689
}

690
#endif