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;
Scott Wheeler's avatar
Scott Wheeler committed
41
typedef QValueList<PlaylistItem *> PlaylistItemList;
42

43 44
typedef QValueList<Playlist *> PlaylistList;

45
class Playlist : public KListView, public PlaylistInterface
46 47
{
    Q_OBJECT
48

49
public:
50

51 52 53 54 55 56
    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");
57

58
    /**
59 60 61
     * 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.
62
     */
63
    Playlist(PlaylistCollection *collection, bool delaySetup);
64

65 66
    virtual ~Playlist();

67 68 69 70 71 72 73 74 75 76 77

    // 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();

78 79 80
    // Plays the top item of the playlist.
    void playFirst();

81 82 83
    /**
     * 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
84
     * name.
85
     */
86
    virtual void save();
Scott Wheeler's avatar
Scott Wheeler committed
87 88 89 90 91

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

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

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

112 113 114 115 116 117 118 119
    /**
     * 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.
     */
    PlaylistItem *playingItem() const { return m_playingItem; }

120 121
    /**
     * All of the (media) files in the list.
122
     */
123
    QStringList files();
124

125
    /**
Scott Wheeler's avatar
Scott Wheeler committed
126
     * Returns a list of all of the items in the playlist.
127
     */
128
    virtual PlaylistItemList items();
129

130
    /**
Scott Wheeler's avatar
Scott Wheeler committed
131
     * Returns a list of all of the \e visible items in the playlist.
132
     */
133
    PlaylistItemList visibleItems();
134

135 136 137
    /**
     * Returns a list of the currently selected items.
     */
138
    PlaylistItemList selectedItems();
139 140 141

    /**
     * Allow duplicate files in the playlist.
142
     */
143
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
144

145
    /**
146
     * This is being used as a mini-factory of sorts to make the construction
147 148
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
149
     */
150
    virtual PlaylistItem *createItem(const FileHandle &file,
151 152
				     QListViewItem *after = 0,
				     bool emitChanged = true);
153

Scott Wheeler's avatar
Scott Wheeler committed
154 155 156 157 158 159 160
    /**
     * 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.     
     */
161
    template <class ItemType, class CollectionItemType, class CollectionListType>
162
    ItemType *createItem(const FileHandle &file,
163 164 165
			 QListViewItem *after = 0,
			 bool emitChanged = true);

166
    virtual void createItems(const PlaylistItemList &siblings);
167

168 169 170 171
    /**
     * 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.
172 173 174 175
     *
     * 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.
176 177 178 179
     */
    void addFiles(const QStringList &files, bool importPlaylists,
		  PlaylistItem *after = 0);

180 181 182 183
    /**
     * Returns the file name associated with this playlist (an m3u file) or
     * QString::null if no such file exists.
     */
184
    QString fileName() const { return m_fileName; }
185 186 187 188 189

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

192
    /**
193
     * Hides column \a c.  If \a updateSearch is true then a signal that the
194 195 196
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
197
    void hideColumn(int c, bool updateSearch = true);
198 199

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

207 208 209 210
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */
    void setName(const QString &n);
211

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

218
    /**
219 220
     * Set item to be the playing item.  If \a item is null then this will clear
     * the playing indicator.
221
     */
222
    static void setPlaying(PlaylistItem *item, bool addToHistory = true);
223 224 225 226

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

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

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

241 242 243 244
    /**
     * 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
245
    PlaylistSearch search() const { return m_search; }
246 247 248 249

    /**
     * Set the search associtated with this playlist.
     */
250 251 252 253 254 255 256
    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
257

Scott Wheeler's avatar
Scott Wheeler committed
258 259 260
    /**
     * Marks \a item as either selected or deselected based.
     */
261 262
    void markItemSelected(PlaylistItem *item, bool selected);

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

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

278 279
    void setColumnWidthUpdatesDisabled(bool disabled) { m_disableColumnWidthUpdates = disabled; }

280 281 282 283 284 285 286
    /**
     * 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();

287 288 289 290 291
    /**
     * Returns true if full path sort is currently enabled for the file column.
     */
    bool fileColumnFullPathSort() const { return m_fileColumnFullPathSort; }

292 293 294 295 296
    /**
     * Sets whether or not the file column sorts using the full path.
     */
    void setFileColumnFullPathSort(bool enable);

297 298 299 300 301 302 303
    /**
     * Reimplemented to add toggling of the file column sorting mode.
     *
     * \see fileColumnFullPathSort()
     */
    virtual void setSorting(int column, bool ascending = true);

304 305
    void read(QDataStream &s);

306
public slots:
307
    /**
308
     * Remove the currently selected items from the playlist and disk.
309
     */
310
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
Scott Wheeler's avatar
Scott Wheeler committed
311 312 313 314

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

317 318 319 320
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
321
    virtual void cut() { copy(); clear(); }
Scott Wheeler's avatar
Scott Wheeler committed
322 323 324 325 326

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
327
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
328 329 330 331

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
332
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
333 334 335 336 337 338 339

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

343 344 345 346 347 348
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

349
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
350 351 352 353 354 355

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

358 359 360
    /**
     * Reload the playlist contents from the m3u file.
     */
361
    virtual void slotReload();
362

363 364 365 366 367
    /**
     * 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.
     */
368
    void slotWeightDirty(int column = -1);
369

370 371
    void slotShowPlaying();

372
protected:
373 374 375 376
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
377
    void removeFromDisk(const PlaylistItemList &items);
378

379 380 381
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
382
    virtual QDragObject *dragObject(QWidget *parent);
383
    virtual QDragObject *dragObject() { return dragObject(this); }
384
    virtual bool canDecode(QMimeSource *s);
385
    virtual void decode(QMimeSource *s, PlaylistItem *after = 0);
386
    virtual void contentsDropEvent(QDropEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
387
    virtual void showEvent(QShowEvent *e);
388
    virtual bool acceptDrag(QDropEvent *e) const { return KURLDrag::canDecode(e); }
389 390 391 392
    virtual void viewportPaintEvent(QPaintEvent *pe);
    virtual void viewportResizeEvent(QResizeEvent *re);

    void addColumn(const QString &label);
Scott Wheeler's avatar
Scott Wheeler committed
393 394 395 396 397 398 399 400

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

403 404 405 406 407 408 409 410
    /**
     * 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);

411 412 413 414 415 416 417 418
    /**
     * 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);

419 420 421 422
protected slots:
    void slotPopulateBackMenu() const;
    void slotPlayFromBackMenu(int number) const;

423
signals:
424

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

431
    /**
432
     * This signal is emitted just before a playlist item is removed from the
433 434 435
     * 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.
436
     */
437
    void signalAboutToRemove(PlaylistItem *item);
438

439 440
    void signalEnableDirWatch(bool enable);

441 442
private:
    void setup();
443

444 445
    PlaylistItem *nextItem(PlaylistItem *current = 0) const;

446 447 448 449 450
    /** Sets up album random play to play songs with the same album as
     * the given PlaylistItem.
     */
    void initAlbumSearch(const PlaylistItem *item);

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 503 504
    /**
     * Show the RMB menu.  Matches the signature for the signal 
     * QListView::contextMenuRequested().
     */
505
    void slotShowRMBMenu(QListViewItem *item, const QPoint &point, int column);
506 507

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

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

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

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

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

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

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

554 555
    void slotPlayCurrent();

556
private:
557 558
    PlaylistCollection *m_collection;

559
    StringHash m_members;
560

561
    int m_currentColumn;
562
    int m_processed;
563 564 565
    int m_rmbEditID;
    int m_selectedCount;

566
    bool m_allowDuplicates;
567
    bool m_polished;
568
    bool m_applySharedSettings;
569
    bool m_fileColumnFullPathSort;
570

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

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
581
    PlaylistItemList m_history;
582
    PlaylistSearch m_search;
583
    PlaylistSearch m_albumSearch;
584

585 586
    bool m_searchEnabled;

587
    PlaylistItem *m_lastSelected;
588

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

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
600
    QString m_playlistName;
601
    QString m_fileName;
602

603 604 605
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
606
    PlaylistToolTip *m_toolTip;
607

608 609 610 611 612
    /**
     * 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;
613
    static int m_leftColumn;
614
    static PlaylistItem *m_playingItem;
615
    static PlaylistItem *m_playNextItem;
616
    static QMap<int, PlaylistItem *> m_backMenuItems;
617 618
};

619 620
void processEvents();

621
QDataStream &operator<<(QDataStream &s, Playlist &p);
622 623
QDataStream &operator>>(QDataStream &s, Playlist &p);

624 625
// template method implementations

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

    if(!item) {
633
	item = new CollectionItemType(file);
634
	setupItem(item);
635 636

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

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

646
    if(item && !m_members.insert(file.absFilePath()) || m_allowDuplicates) {
647

648
	ItemType *i = after ? new ItemType(item, this, after) : new ItemType(item, this);
649 650
	setupItem(i);

651 652
        if(!m_randomList.isEmpty() && !m_visibleChanged)
            m_randomList.append(i);
653

654
	if(emitChanged)
655
	    dataChanged();
656 657 658 659

	return i;
    }
    else
660
	return 0;
661 662
}

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

    m_disableColumnWidthUpdates = true;
670
    ItemType *newItem = 0;
671 672 673

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

682
    dataChanged();
683
    m_disableColumnWidthUpdates = false;
684
    slotWeightDirty();
685 686
}

687
#endif