summaryrefslogtreecommitdiff
path: root/README
blob: d118fd1d1116ccf153cd0b41669d0ad38c19e94a (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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                              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" (not really, but it sounds cool) of musicfs,
displaying the hierarchy we expose. /tmp/music is my mountpoint, and
the paths are added to my music collection when I append them to
.config.

vannlilje:/tmp/music% echo ~/Music/mfs_demo > .config
vannlilje:/tmp/music% tree
.
|-- Albums
|   `-- This Village
|       |-- 01 You Make Me Wonder.ogg
|       |-- 02 This Village.ogg
|       |-- 03 Love.ogg
|       |-- 04 While We Want.ogg
|       |-- 05 Bound.ogg
|       |-- 06 Southpaw.ogg
|       |-- 07 What I Need.ogg
|       |-- 08 Tomorrow.ogg
|       |-- 09 We Don't Know If Eyes Can See The Same.ogg
|       |-- 10 Move Out Of Line.ogg
|       |-- 11 Thinking Of You.ogg
|       `-- 12 Heaven.ogg
|-- Artists
|   |-- Lester
|   |   `-- This Village
|   |       |-- 01 You Make Me Wonder.ogg
|   |       |-- 02 This Village.ogg
|   |       |-- 03 Love.ogg
|   |       |-- 04 While We Want.ogg
|   |       |-- 05 Bound.ogg
|   |       |-- 06 Southpaw.ogg
|   |       |-- 07 What I Need.ogg
|   |       |-- 08 Tomorrow.ogg
|   |       |-- 09 We Don't Know If Eyes Can See The Same.ogg
|   |       |-- 10 Move Out Of Line.ogg
|   |       |-- 11 Thinking Of You.ogg
|   |       `-- 12 Heaven.ogg
|   `-- Metropolitan
|-- Genres
|   `-- Neo-Soul
|       `-- This Village
|           |-- 01 You Make Me Wonder.ogg
|           |-- 02 This Village.ogg
|           |-- 03 Love.ogg
|           |-- 04 While We Want.ogg
|           |-- 05 Bound.ogg
|           |-- 06 Southpaw.ogg
|           |-- 07 What I Need.ogg
|           |-- 08 Tomorrow.ogg
|           |-- 09 We Don't Know If Eyes Can See The Same.ogg
|           |-- 10 Move Out Of Line.ogg
|           |-- 11 Thinking Of You.ogg
|           `-- 12 Heaven.ogg
`-- Tracks
    |-- Lester - Bound.ogg
    |-- Lester - Heaven.ogg
    |-- Lester - Love.ogg
    |-- Lester - Move Out Of Line.ogg
    |-- Lester - Southpaw.ogg
    |-- Lester - Thinking Of You.ogg
    |-- Lester - This Village.ogg
    |-- Lester - Tomorrow.ogg
    |-- Lester - We Don't Know If Eyes Can See The Same.ogg
    |-- Lester - What I Need.ogg
    |-- Lester - While We Want.ogg
    `-- Lester - You Make Me Wonder.ogg

10 directories, 48 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