summaryrefslogtreecommitdiff
path: root/README
blob: 7fa0dc836918a8feaf3329ebb5c27fd29843005a (plain)
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                              musicfs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
musicfs is a FUSE module implementing a media filesystem in
userland. The purpose of musicfs is to provide filesystem hierarchy
based on id3 tags of mp3-files.


Usage
~~~~~
1. Compile:

$ make

2. Make the initial configuration with the provided script

$ bash initialize.sh

3. Start musicfs

$ ./musicfs <mountdir>

4. Add your music path(s) to <mountdir>/.config

$ echo "/storage/music" >> <mountdir>/.config


Screenshot
~~~~~~~~~~
This is a "screenshot" (or dump, or whatever) of musicfs, displaying
the hierarchy we expose. /tmp/mp3s is my mountpoint, and the paths are
added to my music collection when I append them to .config.

vannlilje:/tmp/mp3s% echo "/storage/musikk/Beady_Belle/Belvedere" >> .config
vannlilje:/tmp/mp3s% echo "/storage/musikk/Micatone" >> .config
vannlilje:/tmp/mp3s% tree
.
|-- Albums
|   |-- Belle et Fou (Original Soundtrack)
|   |   `-- D-D-D-D-Dance.mp3
|   |-- Belvedere
|   |   |-- A Touch Of Paradise.mp3
|   |   |-- Apron Strings.mp3
|   |   |-- Boiling Milk.mp3
|   |   |-- Intermission Music (Feat. Jamie Cullum).mp3
|   |   |-- Self-Fulfilling (Feat. India Arie).mp3
|   |   |-- Tower Of Lament.mp3
|   |   |-- Tranquil Flight.mp3
|   |   |-- Two-Faced.mp3
|   |   `-- Viscous Ocean.mp3
|   `-- Nomad Songs
|       |-- Circle.mp3
|       |-- Mars Reprise.mp3
|       |-- Mars.mp3
|       |-- Nomad.mp3
|       |-- Out Of The Game.mp3
|       |-- Trouble Boy (feat. Ear aka Demba Nabé).mp3
|       |-- Where I Am: Part 1.mp3
|       |-- Where I Am: Part 2.mp3
|       |-- Yeah, Yeah, Yeah (That´s The Way It Goes).mp3
|       `-- You´ve Taken All.mp3
|-- Artists
|   |-- Beady Belle
|   |   `-- Belvedere
|   |       |-- 01 Apron Strings.mp3
|   |       |-- 02 A Touch Of Paradise.mp3
|   |       |-- 03 Tower Of Lament.mp3
|   |       |-- 04 Self-Fulfilling (Feat. India Arie).mp3
|   |       |-- 05 Tranquil Flight.mp3
|   |       |-- 06 Intermission Music (Feat. Jamie Cullum).mp3
|   |       |-- 07 Viscous Ocean.mp3
|   |       |-- 08 Boiling Milk.mp3
|   |       `-- 09 Two-Faced.mp3
|   |-- Jazzanova
|   |   `-- Belle et Fou (Original Soundtrack)
|   |       `-- 07 D-D-D-D-Dance.mp3
|   `-- Micatone
|       `-- Nomad Songs
|           |-- 01 Mars.mp3
|           |-- 02 Out Of The Game.mp3
|           |-- 03 Where I Am: Part 1.mp3
|           |-- 04 Where I Am: Part 2.mp3
|           |-- 05 Trouble Boy (feat. Ear aka Demba Nabé).mp3
|           |-- 06 Nomad.mp3
|           |-- 07 Yeah, Yeah, Yeah (That´s The Way It Goes).mp3
|           |-- 09 You´ve Taken All.mp3
|           |-- 10 Circle.mp3
|           `-- 11 Mars Reprise.mp3
|-- Genres
|   |-- Electronic
|   |   |-- Belle et Fou (Original Soundtrack)
|   |   `-- Nomad Songs
|   `-- Jazz
|       `-- Belvedere
`-- Tracks
    |-- Beady Belle - A Touch Of Paradise.mp3
    |-- Beady Belle - Apron Strings.mp3
    |-- Beady Belle - Boiling Milk.mp3
    |-- Beady Belle - Intermission Music (Feat. Jamie Cullum).mp3
    |-- Beady Belle - Self-Fulfilling (Feat. India Arie).mp3
    |-- Beady Belle - Tower Of Lament.mp3
    |-- Beady Belle - Tranquil Flight.mp3
    |-- Beady Belle - Two-Faced.mp3
    |-- Beady Belle - Viscous Ocean.mp3
    |-- Jazzanova - D-D-D-D-Dance.mp3
    |-- Micatone - Circle.mp3
    |-- Micatone - Mars Reprise.mp3
    |-- Micatone - Mars.mp3
    |-- Micatone - Nomad.mp3
    |-- Micatone - Out Of The Game.mp3
    |-- Micatone - Trouble Boy (feat. Ear aka Demba Nabé).mp3
    |-- Micatone - Where I Am: Part 1.mp3
    |-- Micatone - Where I Am: Part 2.mp3
    |-- Micatone - Yeah, Yeah, Yeah (That´s The Way It Goes).mp3
    `-- Micatone - You´ve Taken All.mp3

18 directories, 60 files


Dependencies
~~~~~~~~~~~~
- taglib 1.5
- FUSE 2.6
- Sqlite 3


License
~~~~~~~
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

A copy of the license can typically be found in COPYING