src/playlist/PlaylistModel.h

   1 /***************************************************************************
   2  * copyright            : (C) 2007 Ian Monroe <ian@monroe.nu>              *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License version 2        *
   6  *   as published by the Free Software Foundation.                         *
   7  ***************************************************************************/
   8
   9 #ifndef AMAROK_PLAYLISTMODEL_H
  10 #define AMAROK_PLAYLISTMODEL_H
  11
  12 #include "meta.h"
  13
  14 #include "UndoCommands.h"
  15
  16 #include <QAbstractListModel>
  17 #include <QHash>
  18 #include <QVector>
  19
  20 #include <KLocale>
  21 #include <kdemacros.h>
  22 #include "PlaylistItem.h"
  23
  24 class QMimeData;
  25 class QModelIndex;
  26 class QueryMaker;
  27 class QUndoStack;
  28
  29 //PORT rename to Playlist when the playlist class is removed
  30 namespace PlaylistNS {
  31
  32 class TrackAdvancer;
  33
  34     enum Column
  35     {
  36         Album  = 1,
  37         AlbumArtist,
  38         Artist,
  39         Bitrate,
  40         Bpm,
  41         Comment,
  42         Composer,
  43         CoverImage,
  44         Directory,
  45         DiscNumber,
  46         Filename,
  47         Filesize,
  48         Genre,
  49         LastPlayed,
  50         Length,
  51         Mood,
  52         PlayCount,
  53         Rating,
  54         SampleRate,
  55         Score,
  56         Title,
  57         TrackNumber,
  58         Type,
  59         Year,
  60         NUM_COLUMNS
  61     };
  62     enum DataRoles
  63     {
  64         TrackRole = 0xc0ffee,
  65         ItemRole,
  66         ActiveTrackRole
  67     };
  68     ///Options for insertTracks
  69     enum AddOptions
  70     {
  71         Append     = 1,     /// inserts media after the last item in the playlist
  72         Queue      = 2,     /// inserts media after the currentTrack
  73         Replace    = 4,     /// clears the playlist first
  74         DirectPlay = 8,     /// start playback of the first item in the list
  75         Unique     = 16,    /// don't insert anything already in the playlist
  76         StartPlay  = 32,    /// start playback of the first item in the list if nothing else playing
  77         Colorize   = 64,    /// colorize newly added items
  78         AppendAndPlay = Append | Unique | StartPlay
  79     };
  80
  81     class Model : public QAbstractListModel, Meta::Observer
  82     {
  83         friend class AddTracksCmd;
  84         friend class RemoveTracksCmd;
  85         Q_OBJECT
  86         public:
  87             Model( QObject* parent = 0 );
  88             ~Model();
  89         //required by QAbstractListModel
  90             int rowCount(const QModelIndex &parent = QModelIndex() ) const;
  91             int columnCount(const QModelIndex &parent = QModelIndex() ) const { Q_UNUSED(parent); return 1; }
  92             QVariant data(const QModelIndex &index, int role) const;
  93         //overriding QAbstractItemModel
  94             bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() );
  95             QVariant headerData(int /*section*/, Qt::Orientation /*orientation*/, int /*role*/) const { return QVariant(); }
  96             Qt::DropActions supportedDropActions() const;
  97
  98         //Drag and Drop methods
  99             virtual bool insertRows(  int /*row*/, int /*count*/, const QModelIndex &parent = QModelIndex() ) { Q_UNUSED(parent); return true; }
 100             Qt::ItemFlags flags(const QModelIndex &index) const;
 101             QStringList mimeTypes() const;
 102             QMimeData* mimeData(const QModelIndexList &indexes) const;
 103             bool dropMimeData ( const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent );
 104         //other methods
 105             void init();
 106 ///Restore playlist from previous session of Amarok
 107             void restoreSession() { }
 108 ///Save M3U of current playlist to a given location
 109             bool saveM3U( const QString &path, bool relative ) const;
 110
 111 /**
 112 * Insert tracks into the playlist with some handy options.
 113 * @param list tracks to add
 114 * @param options valid values are Unique || (Append xor Queue xor Replace) || ( DirectPlay xor StartPlay )
 115 **/
 116             void insertOptioned( Meta::TrackList list, int options );
 117             void insertOptioned( Meta::TrackPtr track, int options ); //convenience method
 118             void insertOptioned( QueryMaker *qm, int options );
 119             void insertTrack( int row, Meta::TrackPtr track ); //convenience method
 120             void insertTracks( int row, Meta::TrackList list );
 121             void insertTracks( int row, QueryMaker *qm );
 122
 123             int activeRow() const { return m_activeRow; }
 124             void setActiveRow( int row );
 125             Meta::TrackPtr activeTrack() const { return m_items.at( m_activeRow )->track(); }
 126         //    Qt::ItemFlags flags(const QModelIndex &index) const;
 127             void testData();
 128             ///deprecated function to ease porting to Meta::Track from URLs
 129             KDE_DEPRECATED void insertMedia( KUrl::List list, int options = Append );
 130             virtual void metadataChanged( Meta::Track *track );
 131             virtual void metadataChanged( Meta::Album *album );
 132             void play( int row );
 133             static Model* s_instance; //! instance variable
 134
 135             //various methods for playlist name
 136             //I believe this is used for when you open a playlist file, it can keep the same name when it is
 137             //later saved
 138             void setPlaylistName( const QString &name, bool proposeOverwriting = false ) { m_playlistName = name; m_proposeOverwriting = proposeOverwriting; }
 139             void proposePlaylistName( const QString &name, bool proposeOverwriting = false ) { if( ( rowCount() == 0 ) || m_playlistName==i18n("Untitled") ) m_playlistName = name; m_proposeOverwriting = proposeOverwriting; }
 140             const QString &playlistName() const { return m_playlistName; }
 141             bool proposeOverwriteOnSave() const { return m_proposeOverwriting; }
 142
 143         public slots:
 144             void play( const QModelIndex& index );
 145
 146             void clear(); ///clear the playlist of all items
 147         private slots:
 148             void trackFinished(); //! what to do when a track finishes
 149             void queryDone();
 150             void newResultReady( const QString &collectionId, const Meta::TrackList &tracks );
 151
 152         private:
 153             QString m_playlistName;
 154             bool m_proposeOverwriting;
 155
 156             /**This performs the actual work involved with inserting tracks. It is to be *only* called by an UndoCommand.
 157              * @arg row Row number in the playlist to insert the list after.
 158              * @arg list The list to be inserted.
 159              */
 160             void insertTracksCommand( int row, Meta::TrackList list );
 161             /**This performs the actual work involved with removing tracks. It is to be *only* called by an UndoCommand.
 162              * @arg row Row number in the playlist to insert the list after.
 163              * @arg list The list to be inserted.
 164              */
 165             Meta::TrackList removeRowsCommand( int position, int rows );
 166
 167             static QString prettyColumnName( Column index ); //!takes a Column enum and returns its string name
 168
 169             QList<Item*> m_items; //! list of tracks in order currently in the playlist
 170             int m_activeRow; //! the row being played
 171             TrackAdvancer* m_advancer; //! the strategy of what to do when a track finishes playing
 172             QUndoStack* m_undoStack; //! for pushing on undo commands
 173             QHash<QueryMaker*, int> m_queryMap; //!maps queries to the row where the results should be inserted
 174             QHash<QueryMaker*, int> m_optionedQueryMap; //!maps queries to the options to be used when inserting the result
 175
 176     };
 177 }
 178
 179
 180
 181 #endif