playlist.h 21.8 KB
Newer Older
1 2 3 4
/***************************************************************************
                          playlist.h  -  description
                             -------------------
    begin                : Sat Feb 16 2002
5
    copyright            : (C) 2002, 2003 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>
Dirk Mueller's avatar
compile  
Dirk Mueller committed
23
#include <kdebug.h>
24
#include <kglobalsettings.h>
25

26
#include <qvaluevector.h>
Dirk Mueller's avatar
compile  
Dirk Mueller committed
27
#include <qfileinfo.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

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

114 115 116
    /**
     * Returns a list of the currently selected items.
     */
117
    PlaylistItemList selectedItems();
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
    virtual PlaylistItem *createItem(const FileHandle &file,
135 136
				     QListViewItem *after = 0,
				     bool emitChanged = true);
137

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

150
    virtual void createItems(const PlaylistItemList &siblings);
151

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

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

164 165 166 167 168 169 170 171 172 173 174 175 176
    /**
     * Hides column \a c.  If \a emitChanged is true then a signal that the
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
    void hideColumn(int c, bool emitChanged = true);

    /**
     * Shows column \a c.  If \a emitChanged is true then a signal that the
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
    void showColumn(int c, bool emitChanged = true);
177 178
    bool isColumnVisible(int c) const;

179
    /**
180
     * If m_playlistName has no value -- i.e. the name has not been set to
181
     * something other than the filename, this returns the filename less the
182
     * extension.  If m_playlistName does have a value, this returns that.
183
     */
184
    QString name() const;
185

186 187
    /**
     * This sets a name for the playlist that is \e different from the file name.
188
     */
189
    void setName(const QString &n);
190

191 192 193
    /**
     * Returns the number of items in the playlist.
     */
194
    int count() const { return childCount(); }
195 196 197 198 199
    
    /**
     * Returns the combined time of all the itens.
     */
    int totalTime();
200

201
    /**
202 203 204 205 206
     * 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).
207
     */
208
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
209 210 211 212 213 214

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

217 218 219 220
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
221
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
222

223 224 225 226 227 228 229 230
    /**
     * 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
231
    bool playing() const;
232

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

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

245 246 247 248
    /**
     * 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
249
    PlaylistSearch search() const { return m_search; }
250 251 252 253 254 255

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

258 259 260 261 262 263 264 265
    /**
     * 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); }
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
    void setColumnWidthUpdatesDisabled(bool disabled) { m_disableColumnWidthUpdates = disabled; }

289 290 291 292 293 294 295
    /**
     * 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();

296 297
    void emitDataChanged() { emit signalDataChanged(); }

298 299 300 301 302 303 304 305 306 307 308 309
    /**
     * Returns true if full path sort is currently enabled for the file column.
     */
    bool fileColumnFullPathSort() const { return m_fileColumnFullPathSort; }

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

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

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

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

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
331
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
332 333 334 335

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
336
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
337 338 339 340 341 342 343

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

347 348 349 350 351 352
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

353
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
354 355 356 357 358 359

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

362 363 364
    /**
     * Reload the playlist contents from the m3u file.
     */
365
    virtual void slotReload();
366

367 368 369 370 371
    /**
     * 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.
     */
372
    void slotWeightDirty(int column = -1);
373

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

381 382 383
    // the following are all reimplemented from base classes

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

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

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

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

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

421
signals:
422
    /**
423
     * This is emitted when the playlist selection is changed.  This is used
424
     * primarily to notify the TagEditor of the new data.
425
     */
426
    void signalSelectionChanged(const PlaylistItemList &selection);
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 &fileName);
433

434
    /**
435 436 437 438
     * This signal is emitted when items are added to or removed from the list.
     *
     * \see signalDataChanged()
     * \see signalChanged()
439
     */
440
    void signalCountChanged(Playlist *);
441

442
    /**
443 444 445 446 447 448 449 450 451 452 453
     * 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
454 455 456 457
     * changed.
     */
    void signalChanged();

458
    /**
459
     * This signal is emitted just before a playlist item is removed from the
460 461 462
     * 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.
463
     */
464
    void signalAboutToRemove(PlaylistItem *item);
465 466 467 468

    /**
     * This is emitted when \a files are dropped on a specific playlist.
     */
469
    void signalFilesDropped(const QStringList &files, Playlist *, PlaylistItem *after);
470 471 472 473 474

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

477 478 479 480 481
    /**
     * Request creation of a playlist based on \a items.
     */
    void signalCreatePlaylist(const PlaylistItemList &items);

482 483
private:
    void setup();
484 485 486 487 488 489 490

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

493
    /**
Scott Wheeler's avatar
Scott Wheeler committed
494 495
     * Writes \a text to \a item in \a column.  This is used by the inline tag
     * editor.
496
     */
Scott Wheeler's avatar
Scott Wheeler committed
497
    void editTag(PlaylistItem *item, const QString &text, int column);
498 499 500 501 502 503

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

506 507 508 509 510 511 512 513 514 515
    /**
     * 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);

516 517 518 519 520
    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

521 522 523 524 525 526
    /**
     * 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;

527
private slots:
528

529 530
    void slotUpdateColumnWidths();

531 532 533 534
    /**
     * This is just used to emit the selection as a list of PlaylistItems when
     * the selection changes.
     */
535
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
536 537 538 539 540

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

    /**
Scott Wheeler's avatar
Scott Wheeler committed
544 545
     * This slot is called when the inline tag editor has completed its editing
     * and starts the process of renaming the values.
546
     *
Scott Wheeler's avatar
Scott Wheeler committed
547
     * \see editTag()
548
     */
Scott Wheeler's avatar
Scott Wheeler committed
549
    void slotInlineEditDone(QListViewItem *, const QString &, int column);
550 551 552 553 554

    /**
     * This starts the renaming process by displaying a line edit if the mouse is in 
     * an appropriate position.
     */
555
    void slotRenameTag();
556 557 558 559 560

    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
561
    void slotColumnOrderChanged(int, int from, int to);
562 563 564 565 566 567 568

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

571 572 573 574 575
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
    void slotCreateGroup() { emit signalCreatePlaylist(selectedItems()); }

576 577 578 579 580 581
    /**
     * 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);

582 583 584 585 586 587 588 589
    /**
     * 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);

590
private:
591
    StringHash m_members;
592

593
    int m_currentColumn;
594
    int m_processed;
595 596 597 598 599 600

    int m_rmbPasteID;
    int m_rmbEditID;

    int m_selectedCount;

601
    bool m_allowDuplicates;
602
    bool m_polished;
603
    bool m_applySharedSettings;
604
    bool m_fileColumnFullPathSort;
605

606
    QValueList<int> m_weightDirty;
607
    bool m_disableColumnWidthUpdates;
608
    /**
609
     * The average minimum widths of columns to be used in balancing calculations.
610
     */
611
    QValueVector<int> m_columnWeights;
612 613
    QValueVector<int> m_columnFixedWidths;
    bool m_widthsDirty;
614 615

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
616
    PlaylistItemList m_history;
617
    PlaylistSearch m_search;
618

619
    PlaylistItem *m_lastSelected;
620

621
    /**
622
     * Used to store the text for inline editing before it is changed so that
623 624 625 626
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
627 628 629 630 631

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
632
    QString m_playlistName;
633
    QString m_fileName;
634

635 636 637
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
638

639 640 641 642 643
    /**
     * 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;
644
    static int m_leftColumn;
645
    static PlaylistItem *m_playingItem;
646 647
};

648
QDataStream &operator<<(QDataStream &s, Playlist &p);
649 650
QDataStream &operator>>(QDataStream &s, Playlist &p);

651 652
// template method implementations

653
template <class ItemType, class CollectionItemType, class CollectionListType>
654 655
ItemType *Playlist::createItem(const FileHandle &file, QListViewItem *after,
			       bool emitChanged)
656
{
657
    CollectionItemType *item = CollectionListType::instance()->lookup(file.absFilePath());
658 659

    if(!item) {
660
	item = new CollectionItemType(file);
661
	setupItem(item);
662 663 664 665

	// If a valid tag was not created, destroy the CollectionListItem.
	if(!item->isValid()) {
	    kdError(65432) << "Playlist::createItem() -- A valid tag was not created for \""
666
			   << file.absFilePath() << "\"" << endl;
667 668 669 670 671
	    delete item;
	    return 0;
	}
    }

672
    if(item && !m_members.insert(file.absFilePath()) || m_allowDuplicates) {
673

674
	ItemType *i = after ? new ItemType(item, this, after) : new ItemType(item, this);
675 676
	setupItem(i);

677 678
        if(!m_randomList.isEmpty() && !m_visibleChanged)
            m_randomList.append(i);
679

680 681 682 683 684 685 686 687
	emit signalCountChanged(this);

	if(emitChanged)
	    emit signalCountChanged(this);

	return i;
    }
    else
688
	return 0;
689 690
}

691 692 693
template <class CollectionItemType, class ItemType, class SiblingType>
void Playlist::createItems(const QValueList<SiblingType *> &siblings)
{
694 695 696 697
    if(siblings.isEmpty())
	return;

    m_disableColumnWidthUpdates = true;
698
    ItemType *newItem = 0;
699 700 701

    QValueListConstIterator<SiblingType *> it = siblings.begin();
    for(; it != siblings.end(); ++it) {
702
	if(!m_members.insert((*it)->file().absFilePath()) || m_allowDuplicates) {
703 704 705 706
	    newItem = new ItemType((*it)->collectionItem(), this, newItem);
	    setupItem(newItem);
	    if(!m_randomList.isEmpty() && !m_visibleChanged)
		m_randomList.append(newItem);
707 708 709 710
	}
    }

    emit signalCountChanged(this);
711
    m_disableColumnWidthUpdates = false;
712
    slotWeightDirty();
713 714
}

715
#endif