Clone this wiki locally
Collections (currently scheduled for DrGonzo) mark an important change in the way XMMS2 interacts with its Media Library.
A collection is a subset of the Media Library, or in other words, a group of songs. It can be static or dynamic, ordered or not, but in the end it's just that: a set of media entries.
For instance, a collection can be "all songs by Led Zeppelin before 1975" or "all songs added to the Media Library less than 10 days ago" (dynamic collections). It can also be an arbitrary sequence of songs: "Smells Like Teen Spirit", "Hotel California" and "The Sounds of Silence" (static collection). It can even be an automatic static list, e.g. "10 songs randomly fetched from the collection 'Any Music But Usher'".
With just a few examples, we see that the concept of collections provides a solid basis for different concepts, previously separated in the API and the server: queries, views, playlists (static or "smart"), etc. The goal of collections is indeed to unify them into one unique but powerful structure.
For the client developer, collections will replace SQL queries and allow persistence of "views" of the Library, dynamic playlists, and other such features. The user will benefit from the new features hence possible in the clients: Party Shuffle playlists, saved queries common to all clients, etc.
The current API allows powerful queries in the medialib db, saved playlists, etc. Why change something if it's not broken?
The problem is that it will be broken as soon as we try to introduce new features, such as dynamic playlists, saved queries, etc. While they could be hacked as hooks in a client, this solution is neither elegant, nor robust. Connect several such clients and they will start competing to change the playlist or won't be able to share saved views of the medialib.
We can therefore conclude that these features must be implemented in the server, so that all clients can make a common use of them. However, since they require the selection of a subset of the library (e.g. "playlist containing only Beatles songs"), the only way to perform this currently is by using the corresponding SQL query. First, this implies that each client has created its own functions to generate the SQL query corresponding to the user's choice. Second, parsing back the query into a usable structure (e.g. so that the user can edit its choice) is a major hassle.
The solution to this problem is to unify the way queries are represented, in a higher level of abstraction.
In the diagram above, we clearly see the raise of the position of the API in the query flow. As a consequence, the client only deals with an abstract representation of queries and the transformation to the SQL form is done by the server. This introduces a looser coupling between what the client sees and implementation of the Media Library on the server. Therefore, all clients and the server share the same representation of queries, which can be exchanged, read and written freely. Moreover, it allows to transparently change the storage system used by the Media Library.
Having such a universal representation of queries makes it possible to add features based on sets of songs on the server, such as saved views or Party Shuffle playlists. In addition to that, by using operators to make collections orderable, we can represent not only sets but also lists of songs ; this allows us to generalize the concept of collections to handle the playlists.
This generalization can be exploited to refactor the playlist API. Instead of the current model, where there is one "active playlist" and separate "saved playlists" in the medialib, a more natural approach would be to always play one of the saved playlists, which would itself be a collection. The interface would thus gain in uniformity.
In conclusion, collections are a new step towards abstraction of the access and usage of the Media Library, unification of previously separate concepts on the server, improvement of shared structures among clients, and creation of new varieties of playlists.
See also: Proposal for definitions of nomenclature
The Media Library is the entity containing all the Media.
A playable entity, usually a piece of music. It is identified by a unique id and stores informations about the entry as properties: the URI of the file, plus some technical informations (bitrate, mime-type, duration, etc) and possibly song metadata (title, artist, genre, etc). In practice, files and streams are the most common types of media.
A property is an information attached to a given entity. In practice, both Media and Collections can have properties.
In mathematics, a Directed Acyclic Graph is a set of nodes (or vertices) connected by directed edges, without any directed cycle.
A collection is a subset of the Media Library, i.e. a group of Media. It can be static or dynamic (e.g. if resulting for a query). It can be unordered (set) or ordered (list).
Operators are used on collections to form new collections (e.g. filter by artist, intersection set operation, etc). Consequently, a collection is a DAG whose nodes are operators ; each node of such a graph is in fact a collection itself.
The largest possible collection is the Media Library itself, which contains all the Media.
Collections are organized in namespaces. In other words, the space where collections live is partitioned in several non-overlapping areas, and each collection belongs to one and only one of these namespaces.
The two namespaces expected at this point are "Collections" and "Playlists". More might be added later on.
Note that, from a collection in a given namespace, it is possible to reference another collection in a different namespace.
A media set is (surprise) a set of media, i.e. an unordered collection.
A media list is (surprise-bis) a list of media, i.e. an ordered collection.
Operators are nodes in the collection DAG. They are used to combine and restrict collections. Therefore, the result (output) of an operator is always a collection. The input varies: some operators take no input (e.g. idlist), some take one collection as input (e.g. match, complement), some take two collections as input (e.g. union, intersection).
There are different types of operators
Exemples of operators include:
- set operators: union, intersection, complement
- filtering operators: equals, match, larger, smaller
- list operators: idlist, idqueue, Party Shuffle
Each operator outputs a specific type of collection. The first two types of operators (set and filtering) produce mediasets; the last type (list) produces medialists.
Note: it was said above that collections have properties. It would be more accurate to say that operators have properties. Read ---below for a discussion on collections vs. operators.
An idlist is an operator that stores a list of media ids. It takes no input and outputs the medialist corresponding to its list of ids.
The conventional definition of a playlist is a list of songs. Therefore, in our vocabulary, it is a medialist and hence an ordered collection. For instance, a playlist can correspond to an idlist.
Note that not all collections can be seen as playlists ; mediasets cannot, because there would be no way to determine the play order.
The Concept of Collections
Images speak better than words, so let's have a look at the representation of a collection:
This diagram represents the definition of the UberSound collection (bottom).
Dashed blue round boxes are references to existing collections. Yellow boxes are operators and arrows connect their inputs and outputs. The name of each operator appears in the top part of the box, while properties (if any) appear in the lower part. The green squares represent the content (i.e. list of media ids) of the idlist operator .
The All Media collection is a special collection containing all the media ; it is equivalent to considering the whole Media Library. The Boring Playlist collection has been defined previously ; its definition is not shown here.
The informal definition of UberSound is: all media by Beck released between 1999 and 2004, including additional media specified in , except media found in the Boring Playlist collection.
It is important to understand that collections appear at every step of the graph: at the input of operator LARGER  ("all media"), at the output of operator  and input of operator  ("all media after 1999"), at the output of operator  ("all media between 1999 and 2004"), at the output of operator  ("all media by Beck, between 1999 and 2004"), etc. However, only the collection at the output of operator  has a label (UberSound), others are just intermediate (anonymous) collections.
The usage of operators is quite self-explanatory in this example, but let's have an exhaustive overview of the different types of operators available.
We can split the collection operators in three types:
- Set operators
- Filter operators
- List operators
Set operators allow grouping and combination of multiple collections.
The output of set operators is a mediaset. The input is a list of collections (two on the figure, but there can be more).
Description of the operators:
and: intersection operator. The resulting collection only contains media present in /both/ input collections.
or: union operator. The resulting collection contains all media present in /either/ input collections.
not: complement operator. The resulting collection contains all media /not/ present in the input collection.
Filter operators impose restrictions on collections.
The output of filter operators is a mediaset. The input is the collection to filter.
Filter operators are configured using their two properties:
fieldproperty determines which property of the media should have its value extracted for comparison (
valueproperty determines the value to compare with (
- The optional
case-sensitiveproperty determines whether the comparison is case-sensitive. Set it to "true" to enable case-sensitivity ; by default, comparisons are case-insensitive.
Description of the operators:
equals: The resulting collection only contains media for which
mis exactly equal to
match: The resulting collection only contains media for which
owith possible wildcards (SQL syntax). The
%wildcard can be used to represent any number of characters ; the
_wildcard can be used to represent one single character. For example,
12, but not
larger: The resulting collection only contains media for which
mis larger than
smaller: The resulting collection only contains media for which
mis smaller than
has: The resulting collection only contains media for which the given property is set.
List operators create static, ordered collections. Unlike the other two (dynamic) types of operators, list operators actually /store/ their content, as a list of media ids. This is represented on the figure as a green stack of squares.
The output of list operators is a medialist.
Description of the operators:
idlist: a static list of media ids. If present, the
jumplistproperty gives the name of the playlist to jump to after playback reaches the end of the list.
queue: a static list of media ids ; when used as a playlist, played songs are popped out of it. The
historyproperty specifies how many played songs are kept before they are removed.
shuffle: a static list of media ids, populated by a random selection of songs from the input collection until there is a certain number of entries after the current one. This is specified by the
upcomingproperty. Played songs are popped similarly to the idqueue operator, using the
historyproperty. More property could be added to further customize this operator.
- List operators are especially useful to include or exclude some given media from a collection (using the set operators), and to create playlists!
- Special functions should be made available to create, edit and reorder the list of ids in a list operator.
Formal definition of a Collection
At that point, things might have become slightly confusing: what exactly is a collection?
A set of media? An operator? A DAG? A label? A query?
Technically, all of the above. To avoid confusion in discussions about Collections, let's try to define the relations between these different forms.
A collection is equivalent to a query in the Media Library, which matches a set of media. The query is extracted from the DAG of all incoming edges to the operator referenced by the collection.
Thus, a collection:
- matches a set of media;
- references (or labels) an operator;
- corresponds to a DAG (above the operator);
- is equivalent to a query;
It is therefore important to know what exactly we mean when we refer to a collection.
Sometimes, it can be made clearer by explicitely calling collection structure the DAG corresponding to the collection, and content of the collection the set of media matched by the collection (e.g. a client will create a collection structure and save it on the server, before querying it to list the content of the collection).
idlist is an operator that stores a static list of media.
It does not have any input; its output is the set of media it stores. When this output is used as the input for another operator (e.g. the
and set operator), it is used as a set, that is in no particular order. However, it is important to keep in mind that an
idlist stores an ordered list of media.
Idlists can therefore be used as playlists. Only
idlist operators can be saved in the Playlists namespace ; all collections in this namespace can be played as playlists and accessed using the standard collection and
idlist operator is created, the list of media it contains must be specified. It can be done either by providing a list of media ids, or by "feeding" the
idlist with the content of a collection. This is a key feature, as it allows to "instanciate" a collection as an
idlist — a playlist — and therefore to play it!
idlist must be editable:
- insertion of a new media at a given position ;
- removal of a media at a given position ;
- sorting of the list by one or several field ;
- shuffling of the list ;
- clearing of the list.
These correspond to the functions provided by the current playlist API. The next section explains how collections change the playlist management.
Playlists as Collections
The playlist API needs a major refactoring. Currently, there is one "active" playlist, which can be saved in the medialibrary under a given name. The content of "saved" playlists can then be loaded into the "active" playlist. It is therefore similar to the way a player such as XMMS1 handles playlists (one active playlist, saved playlist files).
The current API is very limited: saved playlists cannot be modified and the concept of an "active" playlist is confusing.
The new playlist API is based on collections. Hence, a playlist is simply a medialist saved in the Playlists namespace. One of these medialists is referenced as the "current" playlist and songs are played sequentially from its content. A
position property in the collection indicated which song is played (or was last played, for non-current playlists).
It is important to note that not all collections can be playlists: medialists can, but mediasets cannot. To be even more accurate, only
idlists can be used as playlists. The reason for this is that otherwise, even with ordered sets of media, it would be impossible to reorder the playlist. This would make playlists confusing in clients.
Because the Playlists namespace only contains
idlist collections, playlists always correspond to a static list of media (as opposed to a dynamic list obtained from a query); their content can therefore be modified, reordered, etc.
However, this does not imply that all playlists have to be hand-picked. List operators can automatically produce
idlists from more complex sources, for instance the Party Shuffle operator.
Advanced Collection Operator: Party Shuffle
A Party Shuffle (inspired from the eponymous feature in iTunes) is a collection operator that takes a collection as input and outputs a random medialist from the collection. The size of the list is determined by the
size property of the operator.
The resulting collection being a medialist, it can be used as a playlist.
It is important to note that the output is not a random mediaset. Reading the content of the Party Shuffle twice returns the same list and not a new random list. However, when it is used as a playlist and the top entry is being played, as soon as the song is finished the list is updated (played song popped out and a new random song enqueued at the end). The same goes if a client removes media from the list: new random songs are enqueued to fill the list up to the correct size. To "refresh" the shuffle, a client could therefore simply empty the playlist.
In short, a Party Shuffle is a static collection automatically updated by playback or modification events, so as always to store
More customization properties could be handled (as does amaroK):
played: whether to pop played songs from the list.
property: which property to select random media from. For instance, if set to "album", all tracks of a given album will be added to the playlist at once. By default, the random property would be "id", which represents a single random media.
Advanced Collection Operator: Suggestion Shuffle
This is only a proposition, mainly to show how advanced playlists and operators can be.
This type of playlist exists in the amaroK player.
Advanced Collection Operator: Playlist Round-Robin
This is only a proposition, mainly to show how advanced playlists and operators can be.
A Playlist Round-Robin is a collection operator that takes a set of medialists as input and combines them using a round-robin policy (i.e. taking an equal amount of media from each of them).
Now that the concept of collections has been explained, let's present how to use and work with them.
A collection is first created locally by a client, using API functions to create operators and connect them together to build the wanted graph structure that corresponds to the collection.
Let's look at the following example (a simplified version of an earlier graph):
The build sequence to create this structure is the following:
- Create a node (1) referencing the All Media collection;
- Create a
largernode (2), give it node (1) as input, set its
fieldproperty to "year" and
- Create a
smallernode (3), give it node (2) as input, set its
fieldproperty to "year" and
- Create an
equalsnode (4), give it node (1) as input, set its
fieldproperty to "artist" and
- Create an
andnode (5), give it node (3) and (4) as input;
- Create a node (6) referencing the Pop Playlist collection;
- Create an
ornode (7), give it node (5) and (6) as input;
Note that the graph must be built from top to bottom, often starting from a reference to an existing collection (e.g. All Media). Also note that no node is created for the Precious Coll label (8); it only represents the name under which the collection should be saved on the server.
Once the collection graph has been prepared by the client, it can either be used to query the Media Library or saved on the server in the Collection Space.
Collections on the Server
Collections can be saved on the server. They are identified by their namespace and their name (unique in each namespace). Note that some restrictions may apply to the type of collection that can be saved in a given namespace (e.g. only
idlists in the Playlists namespace).
To browse the saved collections, one can ask the server for the list of names of all collections in a given namespace. Another feature can be used to find the list of names of all collections containing a given media. The structure of a collection can then be retrieved using its name.
Collections can of course be removed from the server at any time. Once it is identified (by its name and namespace), the corresponding part of the collection graph is deleted. If another collection references the removed collection, the reference will be replaced by a copy of the removed collection.
To modify a saved collection, a client must first retrieve its structure. After editing it locally, it must save it again on the server under the same name. The new collection graph will replace the previous one.
Browsing a Collection
Obviously, the primary usage of collections is to select media.
The first way to do this it to use the query media feature to retrieve the list of media (i.e. media ids) matching a collection. In addition to the collection structure, it can optionally take:
- a list of fields by which to order the list of media ids (by default, simply order by media id). This is similar to
- a range to only retrieve part of the content of the collection, specified by the start position and the maximum number of media (all by default). This is similar to
Another function can then be used to retrieve all the properties of a media given its id. Combined with query media, it can be used to do lazy loading of media informations.
The second way to retrieve data from a collection is the query infos feature, that retrieves the properties of media matching a collection. That is, while query media returns a list of media ids, query infos returns a list of media properties (or dict). Again, in addition to the collection structure, it can optionally take:
- a list of fields by which to order the list of media (by default, simply order by media id).
- a range to only retrieve part of the content of the collection, specified by the start position and the maximum number of media (all by default).
- the list of properties to retrieve (all by default).
- a list of fields by which to group media infos (none by default). This is similar to
The last parameter is especially useful to select specific informations from a collection. For instance, by only selecting and grouping by the artist property, query infos will return the list of all artists contained in the collection.
Playing a Collection (Playlist)
The other main usage of collections is to be used as playlists.
Changing the active playlist can be done by loading another collection from the Playlists namespace. The latter becomes the new active playlist, with playback position resumed at the position when it was last played (saved as the
Because playlists are collections (or, to be accurate,
idlists), they can be modified identically to normal collections: a playlist can be retrieved, modified and saved back on the server.
However, this is often suboptimal as most operations are performed on a limited number of entries, and retrieving the collection structure containing the whole list of ids is costly. It also makes it harder to track atomic changes to the playlist.
The alternative is to keep a dedicated API to modify playlists, similar to the current one. The functions available can basically remain unchanged, though with the difference that the actions can be performed on any of the saved playlist, not just the active playlist.
Sample Use Cases
Find all songs by Ladytron except album "604" and song with id 719.
Create the collection structure pictured above, by using
equals operators to filter all songs by Ladytron and exclude the album called "604" (using the
not operator) as well as the song with id 719 (stored in an idlist).
Then, query media on the server by giving it the whole structure, i.e. a reference to the
and operator (6). The songs matching the constraint will be returned.
Find all albums by Pink Floyd.
Create the simple collection structure pictured above.
Then query infos on the server and set "album" as the only property to select and group by. The list of albums by Pink Floyd will be returned.
Create an "Interesting" Party Shuffle playlist of size 20 containing all songs by artists whose name start by "A" and the content of collection "Rock 90's".
Create the collection structure pictured above, by taking the union of all media by artists whose name start by "A" and a reference to the "Rock 90's" playlist, and feeding it to a
Shuffle operator (with the
size property set to 20).
Save that node (4) on the server under the name "Interesting" (displayed as (5) on the graph), in the Playlists namespace.
Create a "Some Björk" collection containing all music by Björk in Flac format except the songs found in playlist "Foo".
Create the collection structure pictured above, by taking the intersection of all media by Björk in Flac format and the complement of playlist "Foo" (thus excluding its content).
and node (5) on the server under the name "Some Björk", in the Collections namespace.
Find all playlists containing songs from the album "Felt Mountain" by Goldfrapp.
Create the collection structure pictured above, that matches all media by Goldfrapp from album "Felt Mountain".
Then, query media on the server by giving it the leaf node (2); for each media id in the retrieved list, search all collections containing it in the Playlists namespace.