Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

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

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef PLAYLIST_H
#define PLAYLIST_H

#include <klistview.h>
22
#include <kurldrag.h>
23 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();
71
    virtual void saveAs();
72
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
73
    virtual void clearItems(const PlaylistItemList &items);
74

75 76
    /**
     * All of the (media) files in the list.
77
     */
78
    QStringList files() const;
79

80
    /**
81 82
     * Returns a list of all of the \e visible items in the playlist.
     */
83
    virtual PlaylistItemList items();
84

85
    /**
86
     * Returns a list of all of the items in the playlist.
87
     */
88
    PlaylistItemList visibleItems() const;
89

90 91 92
    /**
     * Returns a list of the currently selected items.
     */
93
    PlaylistItemList selectedItems() const;
94

95 96 97 98 99
    /**
     * Returns a list of the last 10 played items.
     */
    PlaylistItemList historyItems(PlaylistItem *current, bool random) const;

100 101
    /**
     * Allow duplicate files in the playlist.
102
     */
103
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
104

105
    /**
106
     * This is being used as a mini-factory of sorts to make the construction
107 108
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
109
     */
110 111
    virtual PlaylistItem *createItem(const QFileInfo &file,
				     const QString &absFilePath = QString::null,
112 113
				     QListViewItem *after = 0,
				     bool emitChanged = true);
114

115 116 117 118 119 120
    template <class ItemType, class CollectionItemType, class CollectionListType>
    ItemType *createItem(const QFileInfo &file,
			 const QString &absFilePath = QString::null,
			 QListViewItem *after = 0,
			 bool emitChanged = true);

121
    virtual void createItems(const PlaylistItemList &siblings);
122

123 124 125 126
    /**
     * Returns the file name associated with this playlist (an m3u file) or
     * QString::null if no such file exists.
     */
127
    QString fileName() const { return m_fileName; }
128 129 130 131 132

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

135 136 137 138
    void hideColumn(int c);
    void showColumn(int c);
    bool isColumnVisible(int c) const;

139
    /**
140
     * If m_playlistName has no value -- i.e. the name has not been set to
141
     * something other than the filename, this returns the filename less the
142
     * extension.  If m_playlistName does have a value, this returns that.
143
     */
144
    QString name() const;
145

146 147
    /**
     * This sets a name for the playlist that is \e different from the file name.
148
     */
149
    void setName(const QString &n);
150

151 152 153
    /**
     * Returns the number of items in the playlist.
     */
154
    int count() const { return childCount(); }
155

156
    /**
157 158 159 160 161
     * 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).
162
     */
163
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
164 165 166 167 168 169

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

172 173 174 175
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
176
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
177

178 179 180 181 182 183 184 185
    /**
     * 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
186
    bool playing() const;
187

Scott Wheeler's avatar
Scott Wheeler committed
188 189 190
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
191
     */
Scott Wheeler's avatar
Scott Wheeler committed
192
    void updateLeftColumn();
193

194 195 196 197
    /**
     * Sets the items in the list to be either visible based on the value of
     * visible.  This is useful for search operations and such.
     */
198 199
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

200 201 202 203
    /**
     * 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
204
    PlaylistSearch search() const { return m_search; }
205 206 207 208 209 210

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

213 214 215 216 217 218 219 220
    /**
     * 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); }
221

222 223
    void markItemSelected(PlaylistItem *item, bool selected);

224 225
    virtual int columnOffset() const { return 0; }
    virtual bool readOnly() const { return false; }
226

227
public slots:
228
    /**
229
     * Remove the currently selected items from the playlist and disk.
230
     */
231
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
232 233
    void slotSetNext();

234 235 236 237
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
238
    virtual void cut() { copy(); clear(); }
239
    virtual void copy();
240
    virtual void paste();
241
    virtual void clear();
242
    virtual void selectAll() { KListView::selectAll(true); }
243

244 245 246 247 248 249
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

250
    void slotGuessTagInfo(TagGuesser::Type type);
251 252
    void slotRenameFile();

253 254 255
    /**
     * Reload the playlist contents from the m3u file.
     */
256
    virtual void slotReload();
257

258
protected:
259 260 261 262
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
263
    void removeFromDisk(const PlaylistItemList &items);
264

265 266 267
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
268
    virtual QDragObject *dragObject(QWidget *parent);
269
    virtual QDragObject *dragObject() { return dragObject(this); }
270
    virtual bool canDecode(QMimeSource *s);
271
    virtual void decode(QMimeSource *s, PlaylistItem *after = 0);
272
    virtual void contentsDropEvent(QDropEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
273
    virtual void showEvent(QShowEvent *e);
274
    virtual bool acceptDrag(QDropEvent *e) const { return KURLDrag::canDecode(e); }
275
    virtual void polish();
276

277 278 279 280 281 282 283 284
    /**
     * 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);

285 286 287 288
    /**
     * Though it's somewhat obvious, this function will stat the file, so only use it when
     * you're out of a performance critical loop.
     */
289
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
290

291
signals:
292
    /**
293
     * This is emitted when the playlist selection is changed.  This is used
294
     * primarily to notify the TagEditor of the new data.
295
     */
296
    void signalSelectionChanged(const PlaylistItemList &selection);
297
    void signalDoubleClicked();
298

299
    /**
300
     * This is connected to the PlaylistBox::Item to let it know when the
301 302
     * playlist's name has changed.
     */
303
    void signalNameChanged(const QString &fileName);
304

305
    /**
306 307 308 309
     * This signal is emitted when items are added to or removed from the list.
     *
     * \see signalDataChanged()
     * \see signalChanged()
310
     */
311
    void signalCountChanged(Playlist *);
312

313
    /**
314 315 316 317 318 319 320 321 322 323 324
     * 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
325 326 327 328
     * changed.
     */
    void signalChanged();

329
    /**
330
     * This signal is emitted just before a playlist item is removed from the
331 332 333
     * 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.
334
     */
335
    void signalAboutToRemove(PlaylistItem *item);
336 337 338 339

    /**
     * This is emitted when \a files are dropped on a specific playlist.
     */
340
    void signalFilesDropped(const QStringList &files, Playlist *, PlaylistItem *after);
341 342 343 344 345

    /**
     * Set the next item to be played in the current playlist.  This is used by
     * the "Play Next" feature.
     */
346
    void signalSetNext(PlaylistItem *item);
347 348 349 350 351 352 353 354

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

357 358 359 360 361
    /**
     * Request creation of a playlist based on \a items.
     */
    void signalCreatePlaylist(const PlaylistItemList &items);

362 363
private:
    void setup();
364 365 366 367 368 369 370

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

373
    /**
374
     * Save the tag for an individual item.
375
     */
376
    void applyTag(QListViewItem *item, const QString &text, int column);
377 378 379 380 381 382

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

385 386 387 388 389 390
    /**
     * 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;

391
private slots:
392 393 394 395 396

    /**
     * This is just used to emit the selection as a list of PlaylistItems when
     * the selection changes.
     */
397
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
398 399 400 401 402

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

    /**
406 407 408
     * This slot applys the tag for a specific item.
     *
     * \see applyTag()
409 410 411 412 413 414 415
     */
    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.
     */
416
    void slotRenameTag();
417 418 419 420 421

    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
422
    void slotColumnOrderChanged(int, int from, int to);
423 424 425 426 427 428 429

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

432 433 434 435 436
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
    void slotCreateGroup() { emit signalCreatePlaylist(selectedItems()); }

437
private:
438
    StringHash m_members;
439
    int m_currentColumn;
440 441
    int m_processed;
    bool m_allowDuplicates;
442 443 444 445 446
    /**
     * 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
447
    PlaylistItemList m_history;
448

449
    QString m_fileName;
450

451
    /**
452
     * Used to store the text for inline editing before it is changed so that
453 454 455 456
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
457 458 459 460 461

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

464 465 466
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
467

468 469
    int m_rmbPasteID;
    int m_rmbEditID;
470 471 472
    int m_selectedCount;

    PlaylistItem *m_lastSelected;
473

474 475
    static PlaylistItem *m_playingItem;
    static int m_leftColumn;
476 477

    PlaylistItemList m_randomList;
Scott Wheeler's avatar
Scott Wheeler committed
478
    PlaylistSearch m_search;
479 480

    bool m_polished;
481 482
};

483 484 485
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

486 487
// template method implementations

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
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;    
}

533 534 535 536 537 538 539
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) {
540
	if(!m_members.insert(resolveSymLinks((*it)->absFilePath())) || m_allowDuplicates) {
541 542 543 544 545 546 547 548
	    previous = new ItemType((*it)->collectionItem(), this, previous);
	    connect((*it)->collectionItem(), SIGNAL(destroyed()), (*it), SLOT(deleteLater()));
	}
    }

    emit signalCountChanged(this);
}

549
#endif