1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/***************************************************************************
begin : Sun May 15 2005
copyright : (C) 2005 by Michael Pyne
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* 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 JUK_COVERMANAGER_H
#define JUK_COVERMANAGER_H
#include <ksharedptr.h>
#include <tqmap.h>
#include <tqdragobject.h>
class CoverManagerPrivate;
class TQString;
class TQPixmap;
class TQDataStream;
/**
* This class holds the data on a cover. This includes the path to the cover
* representation on-disk, and the artist and album associated with the cover.
* Don't assume that the artist or album information is filled out, it is
* there to allow the CoverManager to try to automatically assign covers to
* new tracks.
*
* @author Michael Pyne <[email protected]>
* @see CoverManager
*/
class CoverData : public KShared
{
public:
TQPixmap pixmap() const;
TQPixmap thumbnail() const;
TQString artist;
TQString album;
TQString path;
unsigned refCount; // Refers to number of tracks using this.
};
typedef KSharedPtr<CoverData> CoverDataPtr;
typedef unsigned long coverKey; ///< Type of the id for a cover.
typedef TQMap<coverKey, CoverDataPtr> CoverDataMap;
/**
* This class is used to drag covers in JuK. It adds a special mimetype that
* contains the cover ID used for this cover, and also supports an image/png
* mimetype for dragging to other applications.
*
* As of this writing the mimetype is application/x-juk-coverid
*
* @author Michael Pyne <[email protected]>
*/
class CoverDrag : public QDragObject
{
public:
CoverDrag(coverKey id, TQWidget *src);
virtual const char *format(int i) const;
virtual TQByteArray encodedData(const char *mimetype) const;
void setId(coverKey id) { m_id = id; }
/**
* Returns true if CoverDrag can decode the given mime source. Note that
* true is returned only if \p e contains a cover id, even though
* CoverDrag can convert it to an image.
*/
static bool canDecode(const TQMimeSource *e);
static bool decode(const TQMimeSource *e, coverKey &id);
static const char* mimetype;
private:
coverKey m_id;
};
/**
* This class holds all of the cover art, and manages looking it up by artist
* and/or album. This class is similar to a singleton class, but instead all
* of the methods are static. This way you can invoke methods like this:
* \code
* CoverManager::method()
* \endcode
* instead of using:
* \code
* CoverManager::instance()->method()
* \endcode
*
* @author Michael Pyne <[email protected]>
*/
class CoverManager
{
public:
/// The set of different sizes you can request a pixmap as.
typedef enum { Thumbnail, FullSize } Size;
/**
* Tries to match @p artist and @p album to a cover in the database.
*
* @param artist The artist to look for matching covers on.
* @param album The album to look for matching covers on.
* @return NoMatch if no match could be found, otherwise the id of the
* cover art that matches the given metadata.
*/
static coverKey idFromMetadata(const TQString &artist, const TQString &album);
/**
* Returns the cover art for @p id.
*
* @param id The id of the cover.
* @param size The size to return it as. Note that FullSize doesn't
* necessarily mean the pixmap is large, so you may need to
* scale it up.
* @return TQPixmap::null if there is no cover art for @p id, otherwise the
* cover art.
*/
static TQPixmap coverFromId(coverKey id, Size size = Thumbnail);
/**
* Returns the cover art for @p ptr. This function is intended for use
* by CoverData.
*
* @param ptr The CoverData to get the cover of. Note that it is a
* CoverData, not CoverDataPtr.
* @param size The size to return it as.
* @see CoverData
*/
static TQPixmap coverFromData(const CoverData &coverData, Size size = Thumbnail);
/**
* Returns the full suite of information known about the cover given by
* @p id.
*
* @param id the id of the cover to retrieve info on.
* @return 0 if there is no info on @p id, otherwise its information.
*/
static CoverDataPtr coverInfo(coverKey id);
/**
* Adds @p large to the cover database, associating with it @p artist and
* @p album.
*
* @param large The full size cover (the thumbnail is automatically
* generated).
* @param artist The artist of the new cover.
* @param album The album of the new cover.
*/
static coverKey addCover(const TQPixmap &large, const TQString &artist = "", const TQString &album = "");
/**
* Adds the file pointed to by the local path @p path to the database,
* associating it with @p artist and @p album.
*
* @param path The absolute path to the fullsize cover art.
* @param artist The artist of the new cover.
* @param album The album of the new cover.
*/
static coverKey addCover(const TQString &path, const TQString &artist = "", const TQString &album = "");
/**
* Function to determine if @p id matches any covers in the database.
*
* @param id The id of the cover to search for.
* @return true if the database has a cover identified by @p id, false
* otherwise.
*/
static bool hasCover(coverKey id);
/**
* Removes the cover identified by @p id.
*
* @param id the id of the cover to remove.
* @return true if the removal was successful, false if unsuccessful or if
* the cover didn't exist.
*/
static bool removeCover(coverKey id);
/**
* Replaces the cover art for the cover identified by @p id with @p large.
* Any other metadata such as artist and album is unchanged.
*
* @param id The id of the cover to replace.
* @param large The full size cover art for the new cover.
*/
static bool replaceCover(coverKey id, const TQPixmap &large);
/**
* Saves the current CoverManager information to disk. Changes are not
* automatically written to disk due to speed issues, so you can
* periodically call this function while running to reduce the chance of
* lost data in the event of a crash.
*/
static void saveCovers();
/**
* This is a hack, as we should be shut down automatically by
* KStaticDeleter, but JuK is crashing for me on shutdown before
* KStaticDeleter gets a chance to run, which is cramping my testing.
*/
static void shutdown();
/**
* @return Iterator pointing to the first element in the cover database.
*/
static CoverDataMap::ConstIterator begin();
/**
* @return Iterator pointing after the last element in the cover database.
*/
static CoverDataMap::ConstIterator end();
/**
* @return A list of all of the id's listed in the database.
*/
static TQValueList<coverKey> keys();
/**
* Associates @p path with the cover identified by @id. No comparison of
* metadata is performed to enforce this matching.
*
* @param path The absolute file path to the track.
* @param id The identifier of the cover to use with @p path.
*/
static void setIdForTrack(const TQString &path, coverKey id);
/**
* Returns the identifier of the cover for the track at @p path.
*
* @param path The absolute file path to the track.
* @return NoMatch if @p path doesn't have a cover, otherwise the id of
* its cover.
*/
static coverKey idForTrack(const TQString &path);
/**
* This identifier is used to indicate that no cover was found in the
* database.
*/
static const coverKey NoMatch = 0;
private:
static CoverManagerPrivate *m_data;
static CoverManagerPrivate *data();
static TQPixmap createThumbnail(const TQPixmap &base);
};
#endif /* JUK_COVERMANAGER_H */
// vim: set et sw=4 ts=4:
|