From b963b558d86f3d4f65e5224cce6170f63bec3522 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 1 Feb 2004 18:22:52 +0000 Subject: Initial revision git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@3 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..4e04b83 --- /dev/null +++ b/README @@ -0,0 +1,11 @@ +This is a "plugin" for the Video Disk Recorder (VDR). + +Written by: Your Name + +Project's homepage: URL + +Latest version available at: URL + +See the file COPYING for license information. + +Description: -- cgit v1.2.3 From 9759e698af717c16757bba005c77386fafe338f9 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 1 Feb 2004 19:06:11 +0000 Subject: Added author list git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@8 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 4e04b83..7f57c51 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ This is a "plugin" for the Video Disk Recorder (VDR). -Written by: Your Name +Written by: Ralf Klüber, Andi Kellner, Lars von Wedel Project's homepage: URL -- cgit v1.2.3 From c0b0e6c64d29eb1b279b58fcaec185599e248495 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 1 Feb 2004 19:08:44 +0000 Subject: Added Lars' email git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@9 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 7f57c51..7f1e222 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ This is a "plugin" for the Video Disk Recorder (VDR). -Written by: Ralf Klüber, Andi Kellner, Lars von Wedel +Written by: Ralf Klüber, Andi Kellner, Lars von Wedel Project's homepage: URL -- cgit v1.2.3 From 53ffef33f9e32ef4368fb55d8c87666ee7d667f5 Mon Sep 17 00:00:00 2001 From: RaK Date: Sun, 1 Feb 2004 19:12:19 +0000 Subject: *** empty log message *** git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@10 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 7f1e222..692baf1 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ This is a "plugin" for the Video Disk Recorder (VDR). -Written by: Ralf Klüber, Andi Kellner, Lars von Wedel +Written by: Ralf Klüber , Andi Kellner, Lars von Wedel Project's homepage: URL -- cgit v1.2.3 From 89b813bb617c34c24a22bc05442331cbbe71f061 Mon Sep 17 00:00:00 2001 From: RaK Date: Sun, 1 Feb 2004 22:12:56 +0000 Subject: Added new View Genre -> Year -> Track git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@11 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 692baf1..4f6cbbf 100644 --- a/README +++ b/README @@ -1,6 +1,8 @@ This is a "plugin" for the Video Disk Recorder (VDR). -Written by: Ralf Klüber , Andi Kellner, Lars von Wedel +Written by: Andi Kellner, + Lars von Wedel + Ralf Klüber , Project's homepage: URL -- cgit v1.2.3 From 068ea169c5d357d192b35c3544f4f9e90be96b29 Mon Sep 17 00:00:00 2001 From: lvw Date: Sun, 29 Aug 2004 14:39:33 +0000 Subject: Import running in basic version git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@127 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 168 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 165 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index 4f6cbbf..209dd46 100644 --- a/README +++ b/README @@ -1,8 +1,8 @@ This is a "plugin" for the Video Disk Recorder (VDR). -Written by: Andi Kellner, +Written by: Andi Kellner Lars von Wedel - Ralf Klüber , + Ralf Klueber , Project's homepage: URL @@ -10,4 +10,166 @@ Latest version available at: URL See the file COPYING for license information. -Description: + +PLEASE! + +This is a difficult plugin. It's nice but difficult. +With difficult I mean, that due to the underlying +database, many more sources of error can occur as +opposed to other plugins. + +Take some time to carefully read these instructions. +Please provide feedback to the authors whenever you +think, these instructions are not appropriate, wrong, +or useless in any other sense. + +1 DESCRIPTION + +The muggle plugin provides a database link for VDR so that selection of media becomes more flexible. +Prerequisites are describedin Section 2, Notes on Compilation are in Section 3. Before using the plugin, +you need to import your media into the database (cf. Section 4). The configuration of VDR and startup +parameters are descibed in Section 5. + +2 PREREQUISITES + +The plugin is written for VDR 1.2.6. In addition, the following pieces of +software are required: + +- mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) +- mySQL client libraries (Debian package libmysqlclient-dev) +- libmad (for mp3 decoding) (Debian package libmad0-dev) +- libtag (for ID3 tag reading/writing) (Debian package libtag1-dev) + +The server need not be on the same machine as the VDR. Also, music tracks can reside somewhere else, +if they are available through a remote filesystem (NFS, Samba). However, in this case you should +know what you are doing in terms of networking and security issues. + + +3 INSTALLING + +Unpack the sources in PLUGINS/src below your VDR directory (i.e. where all your other plugins are. +For example (paths and version numbers may vary) + + cd /usr/local/src/VDR/PLUGINS/src + tar xvjf muggle-0.1.7.tar.bz2 + +Establish a symlink as you would for other plugins: + + ln -s muggle-0.1.7 muggle + +Within the VDR main directory (e.g. /usr/local/src/VDR) issue a + + make plugins + +This should build all relevant stuff. If you have difficulties, check that required libraries are +in the library directories stated in the muggle Makefile. + + +4 IMPORT + +The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). +Then, these data structures are filled from the ID3 tags of your music tracks. + +4.1 Setup Database + +This step can be done on the database server or on some other client machine. +Within the directory scripts there are a few helpful files to support setting +up the database. Change into that directory:# + + cd scripts + +The first step is to essentially create the database: + + mysql -u root -p < createdb.mysql + +You will need to enter your root password that you choose during mySQL installation. +Next, we generate the database tables (schema): + + mysql -u root -p < createtables.mysql + +Further, initial data about known languages, genres, sources and musictypes is fed into the database: +Execute these commands on a single line, the \ for the linebreak ist just for presentation purposes here. + + echo " use GiantDisc; load data local infile 'genres.txt' into table genre;" | \ + mysql -u root -p --local-infile=1 + + echo "use GiantDisc; load data local infile 'languages.txt' into table language;" | \ + mysql -u root --local-infile=1 + + echo "use GiantDisc; load data local infile 'musictypes.txt' into table language;" | \ + mysql -u root --local-infile=1 + + echo "use GiantDisc; load data local infile '$SCRIPTDIR/sources.txt' into table language;" | \ + mysql -u root --local-infile=1 + +You can find the sequence of commands in the file scripts/make-empty-db. Use it at your own luck. + +Please note, that the scripts and commands above are quite basic in terms of security (e.g. no +password set for the vdr user, no proper selection of privileges). You may want to spend some +time reading the mySQL documentation in order to set up a proper configuration. Especially when +VDR and mySQL will run on different machines you'll have to invest some time into mySQL +networking and access rights. + +If you want your database name to be different than 'GiantDisc' you will need to adapt the name +in the files createdb.mysql and createtables.mysql and in the commands above. Now your database +is ready for import. + +4.2 Import Music + +The next step is to feed all music information into the database. There is a small tool called 'mugglei' +in the muggle main directory. It connects to the database, evaluates ID3 tags from a file, and writes +the tags into the database. It runs on just one file, so you need some more effort using the Unix command +'find' to take all files into consideration. + +For this step, it is helpful, that all music files are somehow gathered under a toplevel directory. +It does not matter whether there are further subdirectories which organize files into genres, artists, +album or whatever. If this is not the case, you may want to take some time to do this. Read on before +you start + +You probably do not want to import all files in one go: albums on which tracks of various artists are found +(samplers) require different treatment than files of just one artist. What I did: all samplers are collected +below a special subdirectory "Assorted". Import is then run separately for those tracks. + +For now, let's assume your music tracks are located in /home/music and samplers are in /home/music/Assorted. + +First, import the files in Assorted. This requires the flag -a to mugglei. Further flags -h, -n, -u, and -p +specify database host, name, user and password, respectively. The filename to import is given using the -f +directive. Using 'find' you can import all files for assorted albums with a command like: + + find Assorted -name '*' -type f -exec mugglei -a -f {} \; + +For reasons of simplicity, the arguments -h, -n, -u and -p are not shown. You will need them if the default +values do not apply or modify the source code accordingly (beginning of function main). Also, make sure +that either mugglei is on your path or specify an absolute or relative path in the above command line. + +For "regular" albums, the following command may be helpful: + + find * -path 'Assorted' -prune -o -type f -exec mugglei -f {} \; + +It is important that you perform all these steps from the same location so the filenames are relative to +exactly the same directory (e.g. /home/music in the example case). + +Speed should not be an issue: on my machine, it takes about 10 secs to run the import of 60 assorted +albums with more than 600 tracks. Further 1200 tracks or so require 20 more secs. This depends on machine +configuration, of course. + +5 MUGGLE CONFIGURATION + +Muggle uses a small set of command line parameters in order to control the interaction with the mySQL server. +Let's look at an example: + + -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' + +The -h parameter specifies the database host, -u specifies the user, -n is the database name. The scripts mentioned +above do not make use of passwords, but restrict database acccess on a server basis. + +The -t argument specifies the top level directory of the music files. On a local installation, this is the +directory in which you executed the import steps (Chapter 4.2). + +6 USING MUGGLE + +Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. +Then turn to the playlist view using yellow and start play using again the red function key. + + + -- cgit v1.2.3 From 0edf468feae65872a854be3cc3949d8d0a11587f Mon Sep 17 00:00:00 2001 From: lvw Date: Thu, 9 Sep 2004 06:25:57 +0000 Subject: Enhanced documentation for Doxygen git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@150 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 54 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 38 insertions(+), 16 deletions(-) (limited to 'README') diff --git a/README b/README index 209dd46..254e344 100644 --- a/README +++ b/README @@ -1,3 +1,5 @@ +/*! \mainpage Muggle: Media Juggler for VDR + This is a "plugin" for the Video Disk Recorder (VDR). Written by: Andi Kellner @@ -11,7 +13,7 @@ Latest version available at: URL See the file COPYING for license information. -PLEASE! +\section foreword PLEASE! This is a difficult plugin. It's nice but difficult. With difficult I mean, that due to the underlying @@ -23,73 +25,87 @@ Please provide feedback to the authors whenever you think, these instructions are not appropriate, wrong, or useless in any other sense. -1 DESCRIPTION +\section desc DESCRIPTION The muggle plugin provides a database link for VDR so that selection of media becomes more flexible. Prerequisites are describedin Section 2, Notes on Compilation are in Section 3. Before using the plugin, you need to import your media into the database (cf. Section 4). The configuration of VDR and startup parameters are descibed in Section 5. -2 PREREQUISITES +\section prereq PREREQUISITES The plugin is written for VDR 1.2.6. In addition, the following pieces of software are required: -- mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) -- mySQL client libraries (Debian package libmysqlclient-dev) -- libmad (for mp3 decoding) (Debian package libmad0-dev) -- libtag (for ID3 tag reading/writing) (Debian package libtag1-dev) + - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) + - mySQL client libraries (Debian package libmysqlclient-dev) + - libmad (for mp3 decoding) (Debian package libmad0-dev) + - libtag (for ID3 tag reading/writing) (Debian package libtag1-dev) + - optionally libvorbis and libvorbisfile (Debian packages ) +The developer versions are needed because their headers are required for compilation. The server need not be on the same machine as the VDR. Also, music tracks can reside somewhere else, if they are available through a remote filesystem (NFS, Samba). However, in this case you should know what you are doing in terms of networking and security issues. - -3 INSTALLING +\section install INSTALLING Unpack the sources in PLUGINS/src below your VDR directory (i.e. where all your other plugins are. For example (paths and version numbers may vary) +\verbatim cd /usr/local/src/VDR/PLUGINS/src tar xvjf muggle-0.1.7.tar.bz2 +\endverbatim Establish a symlink as you would for other plugins: +\verbatim ln -s muggle-0.1.7 muggle +\endverbatim Within the VDR main directory (e.g. /usr/local/src/VDR) issue a +\verbatim make plugins +\endverbatim This should build all relevant stuff. If you have difficulties, check that required libraries are in the library directories stated in the muggle Makefile. -4 IMPORT +\section import IMPORT The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). Then, these data structures are filled from the ID3 tags of your music tracks. -4.1 Setup Database +\subsection dbsetup Setup Database This step can be done on the database server or on some other client machine. Within the directory scripts there are a few helpful files to support setting up the database. Change into that directory:# +\verbatim cd scripts +\endverbatim The first step is to essentially create the database: +\verbatim mysql -u root -p < createdb.mysql +\endverbatim You will need to enter your root password that you choose during mySQL installation. Next, we generate the database tables (schema): +\verbatim mysql -u root -p < createtables.mysql +\endverbatim Further, initial data about known languages, genres, sources and musictypes is fed into the database: Execute these commands on a single line, the \ for the linebreak ist just for presentation purposes here. +\verbatim echo " use GiantDisc; load data local infile 'genres.txt' into table genre;" | \ mysql -u root -p --local-infile=1 @@ -101,6 +117,7 @@ Execute these commands on a single line, the \ for the linebreak ist just for pr echo "use GiantDisc; load data local infile '$SCRIPTDIR/sources.txt' into table language;" | \ mysql -u root --local-infile=1 +\endverbatim You can find the sequence of commands in the file scripts/make-empty-db. Use it at your own luck. @@ -114,7 +131,7 @@ If you want your database name to be different than 'GiantDisc' you will need to in the files createdb.mysql and createtables.mysql and in the commands above. Now your database is ready for import. -4.2 Import Music +\subsection importfile Import Music The next step is to feed all music information into the database. There is a small tool called 'mugglei' in the muggle main directory. It connects to the database, evaluates ID3 tags from a file, and writes @@ -136,7 +153,9 @@ First, import the files in Assorted. This requires the flag -a to mugglei. Furth specify database host, name, user and password, respectively. The filename to import is given using the -f directive. Using 'find' you can import all files for assorted albums with a command like: +\verbatim find Assorted -name '*' -type f -exec mugglei -a -f {} \; +\endverbatim For reasons of simplicity, the arguments -h, -n, -u and -p are not shown. You will need them if the default values do not apply or modify the source code accordingly (beginning of function main). Also, make sure @@ -144,7 +163,9 @@ that either mugglei is on your path or specify an absolute or relative path in t For "regular" albums, the following command may be helpful: +\verbatim find * -path 'Assorted' -prune -o -type f -exec mugglei -f {} \; +\endverbatim It is important that you perform all these steps from the same location so the filenames are relative to exactly the same directory (e.g. /home/music in the example case). @@ -153,12 +174,14 @@ Speed should not be an issue: on my machine, it takes about 10 secs to run the i albums with more than 600 tracks. Further 1200 tracks or so require 20 more secs. This depends on machine configuration, of course. -5 MUGGLE CONFIGURATION +\section config MUGGLE CONFIGURATION Muggle uses a small set of command line parameters in order to control the interaction with the mySQL server. Let's look at an example: +\verbatim -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' +\endverbatim The -h parameter specifies the database host, -u specifies the user, -n is the database name. The scripts mentioned above do not make use of passwords, but restrict database acccess on a server basis. @@ -166,10 +189,9 @@ above do not make use of passwords, but restrict database acccess on a server ba The -t argument specifies the top level directory of the music files. On a local installation, this is the directory in which you executed the import steps (Chapter 4.2). -6 USING MUGGLE +\section use USING MUGGLE Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. Then turn to the playlist view using yellow and start play using again the red function key. - - +*/ \ No newline at end of file -- cgit v1.2.3 From ba85624940c295af07e558e3bff16d0a8657ed1e Mon Sep 17 00:00:00 2001 From: rak Date: Mon, 13 Sep 2004 20:30:01 +0000 Subject: Added URLs for required packages git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@165 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) (limited to 'README') diff --git a/README b/README index 254e344..75b2d20 100644 --- a/README +++ b/README @@ -38,10 +38,18 @@ The plugin is written for VDR 1.2.6. In addition, the following pieces of software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) - - mySQL client libraries (Debian package libmysqlclient-dev) - - libmad (for mp3 decoding) (Debian package libmad0-dev) - - libtag (for ID3 tag reading/writing) (Debian package libtag1-dev) - - optionally libvorbis and libvorbisfile (Debian packages ) + - mySQL client libraries + (Debian package libmysqlclient-devi or + http://www.mysql.org) + - libmad (for mp3 decoding) + (Debian package libmad0-dev or + http://www.underbit.com/products/mad/) + - libtag (for ID3 tag reading/writing) + (Debian package libtag1-dev or + http://developer.kde.org/~wheeler/taglib.html) + - optionally libvorbis and libvorbisfile + (Debian packages or + http://www.xiph.org/ogg/vorbis/) The developer versions are needed because their headers are required for compilation. The server need not be on the same machine as the VDR. Also, music tracks can reside somewhere else, @@ -194,4 +202,4 @@ directory in which you executed the import steps (Chapter 4.2). Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. Then turn to the playlist view using yellow and start play using again the red function key. -*/ \ No newline at end of file +*/ -- cgit v1.2.3 From c4c3fabddb122710ee0d478d03ed98d82d24c435 Mon Sep 17 00:00:00 2001 From: lvw Date: Thu, 16 Sep 2004 08:02:00 +0000 Subject: Documentation updated. git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@168 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 75b2d20..c23fb5a 100644 --- a/README +++ b/README @@ -39,7 +39,7 @@ software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) - mySQL client libraries - (Debian package libmysqlclient-devi or + (Debian package libmysqlclient-dev or http://www.mysql.org) - libmad (for mp3 decoding) (Debian package libmad0-dev or @@ -81,7 +81,6 @@ Within the VDR main directory (e.g. /usr/local/src/VDR) issue a This should build all relevant stuff. If you have difficulties, check that required libraries are in the library directories stated in the muggle Makefile. - \section import IMPORT The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). -- cgit v1.2.3 From 50075887187e1801f3d3425f20a6b6127ffd7ff8 Mon Sep 17 00:00:00 2001 From: lvw Date: Mon, 4 Oct 2004 07:30:45 +0000 Subject: Added patch for using sockets and improved menu translations git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@199 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index c23fb5a..dcd3832 100644 --- a/README +++ b/README @@ -122,7 +122,7 @@ Execute these commands on a single line, the \ for the linebreak ist just for pr echo "use GiantDisc; load data local infile 'musictypes.txt' into table language;" | \ mysql -u root --local-infile=1 - echo "use GiantDisc; load data local infile '$SCRIPTDIR/sources.txt' into table language;" | \ + echo "use GiantDisc; load data local infile 'sources.txt' into table language;" | \ mysql -u root --local-infile=1 \endverbatim -- cgit v1.2.3 From 53564f64951ace9983bf1afe6c13f7d07a220435 Mon Sep 17 00:00:00 2001 From: lvw Date: Wed, 6 Oct 2004 11:24:24 +0000 Subject: Documentation extended git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@205 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README') diff --git a/README b/README index dcd3832..2934716 100644 --- a/README +++ b/README @@ -201,4 +201,7 @@ directory in which you executed the import steps (Chapter 4.2). Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. Then turn to the playlist view using yellow and start play using again the red function key. +During playback, Up/Down jumps forth and back in the current playlist. Yellow toggles play/pause mode and Ok +brings up a progress display. For VDR 1.3.6- the progress display is "quite simple". + */ -- cgit v1.2.3 From d616ab6f59cfa14a777d73346086f9052f55f0eb Mon Sep 17 00:00:00 2001 From: lvw Date: Mon, 25 Oct 2004 15:22:33 +0000 Subject: Added acknowledgements git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@244 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README') diff --git a/README b/README index 2934716..1d0ab9d 100644 --- a/README +++ b/README @@ -25,6 +25,15 @@ Please provide feedback to the authors whenever you think, these instructions are not appropriate, wrong, or useless in any other sense. +\section ack Acknowledgements + +Thanks to all who have supported the development of this plugin. Special thanks go to +- Muempf for the mp3 plugin. All code related to audio replay is largely taken over from this plugin. +- LordJaxom for constant support in the chat of VDR portal regarding OSD programming in VDR +- eloy (member of vdrportal.de) for alpha testing +- All beta testers at vdrportal.de and on the VDR mailing list +- decembersoul (member of vdrportal.de) for finding out how to run muggle on LinVDR + \section desc DESCRIPTION The muggle plugin provides a database link for VDR so that selection of media becomes more flexible. -- cgit v1.2.3 From 1ef194ae905bf0739c8853f1e26261bd1c73311a Mon Sep 17 00:00:00 2001 From: RaK Date: Wed, 27 Oct 2004 00:11:11 +0000 Subject: Detailed description of the concept behind the Muggle GUI git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@253 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 64 insertions(+), 10 deletions(-) (limited to 'README') diff --git a/README b/README index 1d0ab9d..c4fef6a 100644 --- a/README +++ b/README @@ -25,15 +25,6 @@ Please provide feedback to the authors whenever you think, these instructions are not appropriate, wrong, or useless in any other sense. -\section ack Acknowledgements - -Thanks to all who have supported the development of this plugin. Special thanks go to -- Muempf for the mp3 plugin. All code related to audio replay is largely taken over from this plugin. -- LordJaxom for constant support in the chat of VDR portal regarding OSD programming in VDR -- eloy (member of vdrportal.de) for alpha testing -- All beta testers at vdrportal.de and on the VDR mailing list -- decembersoul (member of vdrportal.de) for finding out how to run muggle on LinVDR - \section desc DESCRIPTION The muggle plugin provides a database link for VDR so that selection of media becomes more flexible. @@ -205,7 +196,7 @@ above do not make use of passwords, but restrict database acccess on a server ba The -t argument specifies the top level directory of the music files. On a local installation, this is the directory in which you executed the import steps (Chapter 4.2). -\section use USING MUGGLE +\section use USING MUGGLE - OVERVIEW Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. Then turn to the playlist view using yellow and start play using again the red function key. @@ -213,4 +204,67 @@ Then turn to the playlist view using yellow and start play using again the red f During playback, Up/Down jumps forth and back in the current playlist. Yellow toggles play/pause mode and Ok brings up a progress display. For VDR 1.3.6- the progress display is "quite simple". +\section use-detail USING MUGGLE + +The idea behind muggle and the concept of the GUI was driven by the requirement, that almost all funtionalities must be possible with only using the cursor keys, the colour keys and menu, ok and back. + +Muggle consist of three main views. The different views could allways be switch with the yellow key. In every view there is a context sensitiv menu with certain commands suitable for the current view. This menu could be reached from every view with the blue key. The two most common commands for a view could be reached with the remaining two colour keys red and green. + +In all views the cursor keys are used like in every VDR menu. + +That is all you have to know to get full access to all functions of muggle. So now lets look in more detail in the three different views. + +\subsection browserview BROWSER VIEW + +The Browser view will be the most used view within muggle. It presents all stored media within the database in a sort of tree view. A tree consist of nodes wich have child nodes which are also nodes. A leaf of such a tree consist of one single media file. Just to make it clear beneath a node there are on the bottom line at least on, but in the higher regions of the tree several media files. + +At present there are 5 different main trees: +- artist -> album -> title +- genre -> artist -> album -> tilte +- artist -> title +- genre -> year -> title +- album -> title + +To add all songs from Abba to the active playlist just use the "artist -> title" tree and look for Abba in the resulting list. Press OK and here you are. All songs from Abba which are stored in the database are shown on the screen and the higlighted one could be added with the red key (you remember: most common commands are on red/green) to the active playlist. If you want to add all songs from Abba to the active playlist just go up one level, Abba is highlighted and then press red and ready you are. + +With the green colour key you could easily reach the main trees (this is not implemented yet). + +Thats all you have to know about this view. Please keep in mind that red adds always _ALL_ songs beneath the current node to the active playlist. So pressing red on one of the main trees leads to adding _ALL_ media files within the database (this could be thousands) to the active playlist. + +\subsection playlistview PLAYLIST VIEW + +In this view you see the active playlist. All songs currently added to the playlist are shown here. With the blue colour key you can reach the context sensitive menu. Here you can find some actions to modify the playlist, clear it totaly and many others. + +\subsection searchview SEARCH VIEW + +The search view is a more advanced method to look into the content of your database. If you search for all songs from Abba which are rated "++" this is your tool. You could find three different search methods which are descripte later. You switch betweeen this search methods with the green colour key. + +\subsubsection titlesearch TITLE SEARCH + +If you want to search for a single media file, this is for you. You could insert some search criteria and after pressing the red button you see all media files which fullfill the restrictions. + +Example: Search for all songs from Abba which have "water" in the title an are publisched befor 2000. + + Artist: Abba + Title: water + Year(till): 2000 + +\subsubsection albumsearch ALBUM SEARCH + +If you want to search for a certain album and are interested in all songs of that album even if the songs not fullfill the search criteria, than this search is for you. + +Example: Search for all songs on an album from "U2" with "tree" in the album title. + + Album Title: tree + Album Artist: U2 + +\subsubsection playlistsearch PLAYLIST SEARCH + +If you want to search for a playlist wích contains songs which fullfill the criteria. + +Example: Yesterday during your birthday party you played a song from Tina Turner during your party, your best friend is interested in the song which was played just behind that Tina Turner song. The search presents all titles of that playlist. You could easily browser the list, find Tinas song and you have the one behind. + + Playlist Title: Birthday Party 2004 + Artist: Tina Turner + */ -- cgit v1.2.3 From 597487de0076f2e47544285a24f6022accedd22a Mon Sep 17 00:00:00 2001 From: lvw Date: Wed, 27 Oct 2004 08:14:03 +0000 Subject: Resolved conflicts in README git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@254 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index c4fef6a..a8e3a4b 100644 --- a/README +++ b/README @@ -25,6 +25,16 @@ Please provide feedback to the authors whenever you think, these instructions are not appropriate, wrong, or useless in any other sense. +\section ack Acknowledgements + +Thanks to all who have supported the development of this plugin. Special thanks go to +- Muempf for the mp3 plugin. All code related to audio replay is largely taken over from this plugin. +- LordJaxom for constant support in the chat of VDR portal regarding OSD programming in VDR +- eloy (member of vdrportal.de) for alpha testing +- All beta testers at vdrportal.de and on the VDR mailing list +- decembersoul (member of vdrportal.de) for finding out how to run muggle on LinVDR +- Hulk (member of vdrportal.de) for submitting several patches and helping out + \section desc DESCRIPTION The muggle plugin provides a database link for VDR so that selection of media becomes more flexible. @@ -208,7 +218,7 @@ brings up a progress display. For VDR 1.3.6- the progress display is "quite simp The idea behind muggle and the concept of the GUI was driven by the requirement, that almost all funtionalities must be possible with only using the cursor keys, the colour keys and menu, ok and back. -Muggle consist of three main views. The different views could allways be switch with the yellow key. In every view there is a context sensitiv menu with certain commands suitable for the current view. This menu could be reached from every view with the blue key. The two most common commands for a view could be reached with the remaining two colour keys red and green. +Muggle consist of three main views. The different views could always be switched with the yellow key. In every view there is a context sensitive menu with certain commands suitable for the current view. This menu could be reached from every view with the blue key. The two most common commands for a view could be reached with the remaining two colour keys red and green. In all views the cursor keys are used like in every VDR menu. -- cgit v1.2.3 From 8a119afd3a313bdf66747c9fbbc751c70771fcb2 Mon Sep 17 00:00:00 2001 From: lvw Date: Wed, 27 Oct 2004 15:00:27 +0000 Subject: Extend documentation git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@255 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 48 +++++++++++++++++++++++++++++++++++++----------- 1 file changed, 37 insertions(+), 11 deletions(-) (limited to 'README') diff --git a/README b/README index a8e3a4b..641d98f 100644 --- a/README +++ b/README @@ -6,13 +6,12 @@ Written by: Andi Kellner Lars von Wedel Ralf Klueber , -Project's homepage: URL +Project's homepage: http://www.htpc-tech.de/htpc/muggle.htm -Latest version available at: URL +Latest version available at: http://www.htpc-tech.de/htpc/muggle_archive/vdr-muggle-0.0.8-BETA.tgz See the file COPYING for license information. - \section foreword PLEASE! This is a difficult plugin. It's nice but difficult. @@ -27,7 +26,7 @@ or useless in any other sense. \section ack Acknowledgements -Thanks to all who have supported the development of this plugin. Special thanks go to +Thanks to all who have supported the development of this plugin. Special thanks (order does not mean importance :-) go to - Muempf for the mp3 plugin. All code related to audio replay is largely taken over from this plugin. - LordJaxom for constant support in the chat of VDR portal regarding OSD programming in VDR - eloy (member of vdrportal.de) for alpha testing @@ -44,7 +43,7 @@ parameters are descibed in Section 5. \section prereq PREREQUISITES -The plugin is written for VDR 1.2.6. In addition, the following pieces of +The plugin has been tested with VDR versions up to 1.3.12. In addition, the following pieces of software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) @@ -64,7 +63,8 @@ software are required: The developer versions are needed because their headers are required for compilation. The server need not be on the same machine as the VDR. Also, music tracks can reside somewhere else, if they are available through a remote filesystem (NFS, Samba). However, in this case you should -know what you are doing in terms of networking and security issues. +know what you are doing in terms of networking and security issues. In my personal setup, the mySQL +database runs on a server where also all music files are stored. Muggle accesses them via Samba. \section install INSTALLING @@ -82,7 +82,7 @@ Establish a symlink as you would for other plugins: ln -s muggle-0.1.7 muggle \endverbatim -Within the VDR main directory (e.g. /usr/local/src/VDR) issue a +Note that the actual directory names may vary, e.g. the version number will changes. Within the VDR main directory (e.g. /usr/local/src/VDR) issue a \verbatim make plugins @@ -93,14 +93,13 @@ in the library directories stated in the muggle Makefile. \section import IMPORT -The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). -Then, these data structures are filled from the ID3 tags of your music tracks. +The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). Then, these data structures are filled from the ID3 tags of your music tracks. \subsection dbsetup Setup Database This step can be done on the database server or on some other client machine. Within the directory scripts there are a few helpful files to support setting -up the database. Change into that directory:# +up the database. Change into that directory: \verbatim cd scripts @@ -243,7 +242,18 @@ Thats all you have to know about this view. Please keep in mind that red adds al \subsection playlistview PLAYLIST VIEW -In this view you see the active playlist. All songs currently added to the playlist are shown here. With the blue colour key you can reach the context sensitive menu. Here you can find some actions to modify the playlist, clear it totaly and many others. +In this view you see the active playlist. All songs currently added to the playlist are shown here. With the blue colour key you can reach the context sensitive menu. Here you can find some actions to modify, load, or save the playlist, clear all entries and many others. In detail the commands are +- Red: start playing the list from the beginning or at the last played song (cf. section Replay) +- Green: Move the current entry to reorder the playlist + +In the submenu the following commands can be selected: +- Rename playlist: change the playlist name using the up/down cursor keys +- Load playlist: show playlists in the database and load one (using Ok) +- Save playlist: Store the current playlist status into the database +- Clear playlist: Remove all entries from the playlist +- Delete current entry: Remove the currently selected entry from the playlist +- Export playlist: export the playlist in m3u (version 2) into the muggle config directory as .m3u +- Playlist commands: similar to commands.conf or reccmds.conf for VDR a file containing commands to execute on a playlist can be specified in a file playlist_commands.conf which must reside in the muggle config directory. The commands listed in that file will be called with one argument which is the path of the playlist file in m3u (version 2). \subsection searchview SEARCH VIEW @@ -277,4 +287,20 @@ Example: Yesterday during your birthday party you played a song from Tina Turner Playlist Title: Birthday Party 2004 Artist: Tina Turner +\subsection useplayer DURING PLAYBACK + +The functions available furing playback mostly relate to navigation in the playlist +and displaying information about the current track or playlist. + +- Up: Skip to the next title +- Down: Skip to the previous title +- Ok: toggle display (progress or information view) + +- Red: When display shown: toggle between progress and information view +- Green: When display shown: toggle between track and playlist view +- Yellow: Play/Pause +- Blue: stop replay but remind resume index (so Play from browser view starts with the track played last) + +- Back: stop replay (Play from browser will start from the beginning) + */ -- cgit v1.2.3 From 4a3a0058a3cba24b4d646a165501587ecbe449fe Mon Sep 17 00:00:00 2001 From: lvw Date: Thu, 28 Oct 2004 13:14:41 +0000 Subject: Documentation update git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@260 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'README') diff --git a/README b/README index 641d98f..9fae263 100644 --- a/README +++ b/README @@ -32,7 +32,7 @@ Thanks to all who have supported the development of this plugin. Special thanks - eloy (member of vdrportal.de) for alpha testing - All beta testers at vdrportal.de and on the VDR mailing list - decembersoul (member of vdrportal.de) for finding out how to run muggle on LinVDR -- Hulk (member of vdrportal.de) for submitting several patches and helping out +- Hulk (member of vdrportal.de) for submitting several patches (especially for gLCD display) \section desc DESCRIPTION @@ -159,13 +159,14 @@ It does not matter whether there are further subdirectories which organize files album or whatever. If this is not the case, you may want to take some time to do this. Read on before you start -You probably do not want to import all files in one go: albums on which tracks of various artists are found -(samplers) require different treatment than files of just one artist. What I did: all samplers are collected -below a special subdirectory "Assorted". Import is then run separately for those tracks. +You probably do not want to import all files in one go: albums on which tracks of various artists are +found (samplers) require different treatment than albums containing files of just one artist. What I did: +all samplers are collected below a special subdirectory "Assorted". Import is then run separately for those +tracks. For now, let's assume your music tracks are located in /home/music and samplers are in /home/music/Assorted. -First, import the files in Assorted. This requires the flag -a to mugglei. Further flags -h, -n, -u, and -p +First, let's import the files in Assorted. This requires the flag -a to mugglei. Further flags -h, -n, -u, and -p specify database host, name, user and password, respectively. The filename to import is given using the -f directive. Using 'find' you can import all files for assorted albums with a command like: @@ -196,7 +197,7 @@ Muggle uses a small set of command line parameters in order to control the inter Let's look at an example: \verbatim - -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' + vdr -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' \endverbatim The -h parameter specifies the database host, -u specifies the user, -n is the database name. The scripts mentioned @@ -205,7 +206,7 @@ above do not make use of passwords, but restrict database acccess on a server ba The -t argument specifies the top level directory of the music files. On a local installation, this is the directory in which you executed the import steps (Chapter 4.2). -\section use USING MUGGLE - OVERVIEW +\section use USING MUGGLE - QUICK OVERVIEW Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. Then turn to the playlist view using yellow and start play using again the red function key. @@ -296,8 +297,8 @@ and displaying information about the current track or playlist. - Down: Skip to the previous title - Ok: toggle display (progress or information view) -- Red: When display shown: toggle between progress and information view -- Green: When display shown: toggle between track and playlist view +- Red: When display shown: toggle between progress and information view, otherwise toggle loop mode (not yet functional) +- Green: When display shown: toggle between track and playlist view, otherwise toggle shuffle mode (not yet functional) - Yellow: Play/Pause - Blue: stop replay but remind resume index (so Play from browser view starts with the track played last) -- cgit v1.2.3 From 22a0df57ec45522eb109d6458c151fb077578d47 Mon Sep 17 00:00:00 2001 From: RaK Date: Thu, 28 Oct 2004 17:07:33 +0000 Subject: added my suggestion for an other key setting during playback git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@261 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README') diff --git a/README b/README index 9fae263..3f787e8 100644 --- a/README +++ b/README @@ -304,4 +304,18 @@ and displaying information about the current track or playlist. - Back: stop replay (Play from browser will start from the beginning) +Alternativ Key Settings: + +- Down: Pause +- Up: Play +- Right: Fast Forward +- Left: Rewind + +- Ok: toggle Display (Progress View -> Information -> View -> Playlist View -> Off) + +- Red +- Green: Skip to previous song. +- Yellow: Skip to next song. +- Blue: stop replay but remind resume index (so Play from browser view starts with the track played last) + */ -- cgit v1.2.3 From 0756ae40d68d403082c86adef042a4c0daba219f Mon Sep 17 00:00:00 2001 From: LarsAC Date: Fri, 7 Jan 2005 18:43:03 +0000 Subject: Merged branch osd_extensions back to main trunk git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@324 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 162 +++++++++++++++++++++++++++-------------------------------------- 1 file changed, 66 insertions(+), 96 deletions(-) (limited to 'README') diff --git a/README b/README index 3f787e8..1ec00c8 100644 --- a/README +++ b/README @@ -2,13 +2,14 @@ This is a "plugin" for the Video Disk Recorder (VDR). -Written by: Andi Kellner - Lars von Wedel +Written by: Andi Kellner, + Lars von Wedel , Ralf Klueber , + Wolfgang Rohdewald Project's homepage: http://www.htpc-tech.de/htpc/muggle.htm -Latest version available at: http://www.htpc-tech.de/htpc/muggle_archive/vdr-muggle-0.0.8-BETA.tgz +Latest version available at: http://www.htpc-tech.de/htpc/muggle-dev.htm See the file COPYING for license information. @@ -24,16 +25,6 @@ Please provide feedback to the authors whenever you think, these instructions are not appropriate, wrong, or useless in any other sense. -\section ack Acknowledgements - -Thanks to all who have supported the development of this plugin. Special thanks (order does not mean importance :-) go to -- Muempf for the mp3 plugin. All code related to audio replay is largely taken over from this plugin. -- LordJaxom for constant support in the chat of VDR portal regarding OSD programming in VDR -- eloy (member of vdrportal.de) for alpha testing -- All beta testers at vdrportal.de and on the VDR mailing list -- decembersoul (member of vdrportal.de) for finding out how to run muggle on LinVDR -- Hulk (member of vdrportal.de) for submitting several patches (especially for gLCD display) - \section desc DESCRIPTION The muggle plugin provides a database link for VDR so that selection of media becomes more flexible. @@ -43,7 +34,7 @@ parameters are descibed in Section 5. \section prereq PREREQUISITES -The plugin has been tested with VDR versions up to 1.3.12. In addition, the following pieces of +The plugin is written for VDR 1.2.6. In addition, the following pieces of software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) @@ -63,8 +54,7 @@ software are required: The developer versions are needed because their headers are required for compilation. The server need not be on the same machine as the VDR. Also, music tracks can reside somewhere else, if they are available through a remote filesystem (NFS, Samba). However, in this case you should -know what you are doing in terms of networking and security issues. In my personal setup, the mySQL -database runs on a server where also all music files are stored. Muggle accesses them via Samba. +know what you are doing in terms of networking and security issues. \section install INSTALLING @@ -82,7 +72,7 @@ Establish a symlink as you would for other plugins: ln -s muggle-0.1.7 muggle \endverbatim -Note that the actual directory names may vary, e.g. the version number will changes. Within the VDR main directory (e.g. /usr/local/src/VDR) issue a +Within the VDR main directory (e.g. /usr/local/src/VDR) issue \verbatim make plugins @@ -93,13 +83,14 @@ in the library directories stated in the muggle Makefile. \section import IMPORT -The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). Then, these data structures are filled from the ID3 tags of your music tracks. +The import is done in two steps: First, a database is created and initialized with proper data structures (so-called schema). +Then, these data structures are filled from the ID3 tags of your music tracks. \subsection dbsetup Setup Database This step can be done on the database server or on some other client machine. Within the directory scripts there are a few helpful files to support setting -up the database. Change into that directory: +up the database. Change into that directory:# \verbatim cd scripts @@ -135,7 +126,7 @@ Execute these commands on a single line, the \ for the linebreak ist just for pr mysql -u root --local-infile=1 \endverbatim -You can find the sequence of commands in the file scripts/make-empty-db. Use it at your own luck. +You can find the sequence of commands in the file scripts/make-empty-db. Use it at your own luck after making necessary modification (program paths, database names, servers, users, etc.). Please note, that the scripts and commands above are quite basic in terms of security (e.g. no password set for the vdr user, no proper selection of privileges). You may want to spend some @@ -159,14 +150,14 @@ It does not matter whether there are further subdirectories which organize files album or whatever. If this is not the case, you may want to take some time to do this. Read on before you start -You probably do not want to import all files in one go: albums on which tracks of various artists are -found (samplers) require different treatment than albums containing files of just one artist. What I did: -all samplers are collected below a special subdirectory "Assorted". Import is then run separately for those -tracks. +You probably do not want to import all files in one go: albums on which tracks of various artists are found +(samplers) require different treatment than files of just one artist. What I did: all samplers are collected +below a special subdirectory "Assorted". Import is then run separately for those tracks. There has been discussion +about this and ideas for better solutions are welcome. For now, let's assume your music tracks are located in /home/music and samplers are in /home/music/Assorted. -First, let's import the files in Assorted. This requires the flag -a to mugglei. Further flags -h, -n, -u, and -p +First, import the files in Assorted. This requires the flag -a to mugglei. Further flags -h, -n, -u, and -p specify database host, name, user and password, respectively. The filename to import is given using the -f directive. Using 'find' you can import all files for assorted albums with a command like: @@ -197,7 +188,7 @@ Muggle uses a small set of command line parameters in order to control the inter Let's look at an example: \verbatim - vdr -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' + -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' \endverbatim The -h parameter specifies the database host, -u specifies the user, -n is the database name. The scripts mentioned @@ -206,116 +197,95 @@ above do not make use of passwords, but restrict database acccess on a server ba The -t argument specifies the top level directory of the music files. On a local installation, this is the directory in which you executed the import steps (Chapter 4.2). -\section use USING MUGGLE - QUICK OVERVIEW +\section quickuse QUICK INTRO Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. -Then turn to the playlist view using yellow and start play using again the red function key. +Music will start instantly while you can continue to browse and add tracks. During playback, Up/Down jumps forth and back in the current playlist. Yellow toggles play/pause mode and Ok -brings up a progress display. For VDR 1.3.6- the progress display is "quite simple". +toggles a display of the replay process. Using Green, the display can be switched between playlist and single display mode, red toggles info and progress view. For VDR 1.3.6- the progress display is "quite simple", unfortunately. + +\section use DETAILED USER'S GUIDE + +The core concept of the Muggle user interface is called a *selection*. That is, as the name suggests, a selection of music tracks. Note, that a selection can be as small as a single track (a very simple selection, indeed) or as large as the whole music library. + +Selections are used to structure all tracks (the music library) into sets (e.g. a selection of all tracks by an author) and subsets (e.g. the tracks of an author on a certain album). Such selections are built by means of keys (e.g. author or album) defined in the database and are displayed in the *music browser*. The current selection in the *music browser* contains all tracks defined by the line the cursor is on. So if you place the cursor on the line "Pop", all tracks with Genre Pop are selected. If you then enter Pop and go to the line "Beatles", you narrow your selection to pop songs from the beatles. + +A collection is a special selection. Collections can be defined by the user, and he can add or remove any selection to / from a collection. A collection has only ony order: a number which is incremented for every added track. Otherwise, since a collection is also a selection, everything that is valid for selections also holds for collections. -\section use-detail USING MUGGLE +Collections can be defined by the user in the sense of a playlist. This is done by adding/removing selections to/from the *default collection*. -The idea behind muggle and the concept of the GUI was driven by the requirement, that almost all funtionalities must be possible with only using the cursor keys, the colour keys and menu, ok and back. +Changing the contents of a collection changes them directly in the data base. Saving or loading collections is not needed. -Muggle consist of three main views. The different views could always be switched with the yellow key. In every view there is a context sensitive menu with certain commands suitable for the current view. This menu could be reached from every view with the blue key. The two most common commands for a view could be reached with the remaining two colour keys red and green. +A very important term while working with Muggle is the *default collection*. This is a special collection which is the target of commands working on collections. Whenever you add selections to somewhere, they will be added to the default collection. The same happens when you remove selections. -In all views the cursor keys are used like in every VDR menu. +Another important collection is the 'play' collection. This is a temporary collection. Whatever is added to it will be played in that order. If you add something while muggle is not playing anything, this collection will first be emptied. +However 'temporary' does not mean that its content is not saved to the data base. -That is all you have to know to get full access to all functions of muggle. So now lets look in more detail in the three different views. +\subsection general General remarks -\subsection browserview BROWSER VIEW +There are two main views in Muggle, the *Music browser* view and the *Collection browser* view. You can toggle between them using the yellow key. -The Browser view will be the most used view within muggle. It presents all stored media within the database in a sort of tree view. A tree consist of nodes wich have child nodes which are also nodes. A leaf of such a tree consist of one single media file. Just to make it clear beneath a node there are on the bottom line at least on, but in the higher regions of the tree several media files. +Each of the two views has associated commands. To show a summary of the commands available for the current view press the blue key. Note, that the red, green and yellow keys do not have a fixed meaning. Rather, while the commands for a certain view are displayed, you can press red/green/yellow to make the respective key execute the command currently selected (highlighted) by the cursor. The commands you choose for red/green/yellow will be saved for the next time you start muggle. You can define different commands in both view *Music browser* and *Collection browser*. -At present there are 5 different main trees: -- artist -> album -> title -- genre -> artist -> album -> tilte -- artist -> title -- genre -> year -> title -- album -> title +\subsection browse Music browser -To add all songs from Abba to the active playlist just use the "artist -> title" tree and look for Abba in the resulting list. Press OK and here you are. All songs from Abba which are stored in the database are shown on the screen and the higlighted one could be added with the red key (you remember: most common commands are on red/green) to the active playlist. If you want to add all songs from Abba to the active playlist just go up one level, Abba is highlighted and then press red and ready you are. +By default, Muggle starts in the *Music browser* display at the place where you left it last time. This browser displays the music library according to a search order, e.g. according to artists / albums / tracks or genre / year / track. These search orders are currently fixed in the code, but the objective is to make them editable by the user on the OSD. Browsing these search orders is done using Up/Down/Left/Right keys. To display the contents of a currently selected selection, press Ok. To return to the parent selection press Back. -With the green colour key you could easily reach the main trees (this is not implemented yet). +A set of commands can be displayed with the Blue key on the remote control. A new menu will open and show the commands explained below. Remember that pressing Red, Green or Yellow will make these keys execute the command currently highlighted by the cursor from now on. -Thats all you have to know about this view. Please keep in mind that red adds always _ALL_ songs beneath the current node to the active playlist. So pressing red on one of the main trees leads to adding _ALL_ media files within the database (this could be thousands) to the active playlist. +Those commands are currently available in the *music browser*: -\subsection playlistview PLAYLIST VIEW +- Instant Play: instantly play the current selection. This does not enter any collection. -In this view you see the active playlist. All songs currently added to the playlist are shown here. With the blue colour key you can reach the context sensitive menu. Here you can find some actions to modify, load, or save the playlist, clear all entries and many others. In detail the commands are -- Red: start playing the list from the beginning or at the last played song (cf. section Replay) -- Green: Move the current entry to reorder the playlist +- Add to 'play': add the current selection to the default collection. After the first start of muggle, the default collection is 'play' -In the submenu the following commands can be selected: -- Rename playlist: change the playlist name using the up/down cursor keys -- Load playlist: show playlists in the database and load one (using Ok) -- Save playlist: Store the current playlist status into the database -- Clear playlist: Remove all entries from the playlist -- Delete current entry: Remove the currently selected entry from the playlist -- Export playlist: export the playlist in m3u (version 2) into the muggle config directory as .m3u -- Playlist commands: similar to commands.conf or reccmds.conf for VDR a file containing commands to execute on a playlist can be specified in a file playlist_commands.conf which must reside in the muggle config directory. The commands listed in that file will be called with one argument which is the path of the playlist file in m3u (version 2). +- Remove from 'play': remove the current selection from the default collection. If there are more than one instances of a specific track in the collection, they are all removed. -\subsection searchview SEARCH VIEW +- Collections: switch to the collection view -The search view is a more advanced method to look into the content of your database. If you search for all songs from Abba which are rated "++" this is your tool. You could find three different search methods which are descripte later. You switch betweeen this search methods with the green colour key. +- Select search order: select another search order -\subsubsection titlesearch TITLE SEARCH +- Export tracklist: generate a file X.m3u containing all tracks from the current selection -If you want to search for a single media file, this is for you. You could insert some search criteria and after pressing the red button you see all media files which fullfill the restrictions. +- External commands: whatever you define -Example: Search for all songs from Abba which have "water" in the title an are publisched befor 2000. +By default, the red key adds the currently selected collection to the default collection. The green key instantly plays the currently selected collection. The yellow key toggles between the *Music browser* and the *Collection browser*. Thus, if you want to play an album, browse to it and press green. Remember that you can redefine commands executed by red, green and yellow by pressing them while displaying the command list. - Artist: Abba - Title: water - Year(till): 2000 +\subsection collections Collection browser -\subsubsection albumsearch ALBUM SEARCH +The *Collection browser* displays a list of available collections. Browse the list with Up/Down and display the collection contents with Ok. Returning to the collection list is done by pressing Back. One of the collections (the one called "play" when you start up muggle for the first time) is marked with a "->" in front of the name, meaning that it is the default collection. Whenever you add or remove selections, this default collection is the current target, meaning that selections will be added/removed to/from this collection. -If you want to search for a certain album and are interested in all songs of that album even if the songs not fullfill the search criteria, than this search is for you. +At the bottom of the list, the entry "Create collection" is displayed. Entering it with the right key will make the editor appear on the second half of the line and using the keys Up/Down/Left/Right you can enter the name of the new collection. Pressing Ok will terminate the editing process and add the new collection to the list. -Example: Search for all songs on an album from "U2" with "tree" in the album title. +Just like with the *music browser*, a set of commands can be displayed with the Blue key on the remote control. - Album Title: tree - Album Artist: U2 +Those commands are currently available in the list of collections. Depending on the current selection, not all of them are available: -\subsubsection playlistsearch PLAYLIST SEARCH +- Instant play: See *music browser* -If you want to search for a playlist wích contains songs which fullfill the criteria. +- Add to 'play': See *music browser* -Example: Yesterday during your birthday party you played a song from Tina Turner during your party, your best friend is interested in the song which was played just behind that Tina Turner song. The search presents all titles of that playlist. You could easily browser the list, find Tinas song and you have the one behind. +- Remove from 'play': See *music browser*. Not available when the cursor is on the default collection. - Playlist Title: Birthday Party 2004 - Artist: Tina Turner +- Remove all entries from 'play': Only available when the cursor is on the default collection. -\subsection useplayer DURING PLAYBACK +- Search: switch to the *music browser* -The functions available furing playback mostly relate to navigation in the playlist -and displaying information about the current track or playlist. +- Set default collection to 'X': as it says. -- Up: Skip to the next title -- Down: Skip to the previous title -- Ok: toggle display (progress or information view) +- Delete collection: Not available for the default collection and for the 'play' collection. -- Red: When display shown: toggle between progress and information view, otherwise toggle loop mode (not yet functional) -- Green: When display shown: toggle between track and playlist view, otherwise toggle shuffle mode (not yet functional) -- Yellow: Play/Pause -- Blue: stop replay but remind resume index (so Play from browser view starts with the track played last) +- Export track list: See *music browser* -- Back: stop replay (Play from browser will start from the beginning) +- External commands: whatever you define -Alternativ Key Settings: +Note that you cannot only add to/remove from collections in the *music browser*. Rather, also collections can be added/removed. The reason is that - as explained above - a collection is also a selection. So everything that can be done with selections can also be done with collections. An example: if you want to give a party, you could create a new collection "Party". Now, steer your cursor to the collection entitled "Lounge music" and select add. Then go to "Pop 80s" and add again. Finally, go to "Dance classics" and add. Now you have created a collection "Party" from three already existing collections. To continue this example, let us assume that one of your guests has a personal dislike against "Modern Talking". Switch to the browser view, go to the artist selection of "Modern Talking" and select "Remove". Now all tracks written by Modern Talking will be removed from your "Party" collection. -- Down: Pause -- Up: Play -- Right: Fast Forward -- Left: Rewind +Please note that "Remove" means removing from the default collection. "Delete" will delete a collection. -- Ok: toggle Display (Progress View -> Information -> View -> Playlist View -> Off) +It is possible that a collection holds the same track several times if you add it several times. However when you remove that track, all of its occurrences will be removed. -- Red -- Green: Skip to previous song. -- Yellow: Skip to next song. -- Blue: stop replay but remind resume index (so Play from browser view starts with the track played last) +The remote buttons Play, Pause, Stop are also supported while muggle displays its OSD. If Stop is pressed, muggle first stops playing what was started by Instant Play. Muggle will then continue playing the 'play' collection. A second Stop will stop playing the 'play' collection. */ -- cgit v1.2.3 From 37e5ef3df27d40608d7b34f5fcb09234c7906295 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Mon, 10 Jan 2005 07:30:54 +0000 Subject: Mugglei now provides defaults for missing tags git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@341 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 1ec00c8..ea2046f 100644 --- a/README +++ b/README @@ -34,7 +34,7 @@ parameters are descibed in Section 5. \section prereq PREREQUISITES -The plugin is written for VDR 1.2.6. In addition, the following pieces of +The plugin currently runs on VDR 1.3.7+. In addition, the following pieces of software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) @@ -69,7 +69,7 @@ For example (paths and version numbers may vary) Establish a symlink as you would for other plugins: \verbatim - ln -s muggle-0.1.7 muggle + ln -s muggle-0.1.0 muggle \endverbatim Within the VDR main directory (e.g. /usr/local/src/VDR) issue @@ -182,6 +182,14 @@ Speed should not be an issue: on my machine, it takes about 10 secs to run the i albums with more than 600 tracks. Further 1200 tracks or so require 20 more secs. This depends on machine configuration, of course. +If a track has no ID3 tags, the following defaults will be applied: + +- Title: Filename will be used +- Artist: "Unknown" +- Album: "Unassigned" +- Track: 0 +- Year: 0 + \section config MUGGLE CONFIGURATION Muggle uses a small set of command line parameters in order to control the interaction with the mySQL server. -- cgit v1.2.3 From 356d968b27592d2b3b15fb28e7bd782d0c4b06d6 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 23 Jan 2005 10:59:29 +0000 Subject: Formatting beautified git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@383 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 178 ++++++++++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 131 insertions(+), 47 deletions(-) (limited to 'README') diff --git a/README b/README index ea2046f..06e0064 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ /*! \mainpage Muggle: Media Juggler for VDR -This is a "plugin" for the Video Disk Recorder (VDR). +This is a plugin for the Video Disk Recorder (VDR). Written by: Andi Kellner, Lars von Wedel , @@ -34,8 +34,8 @@ parameters are descibed in Section 5. \section prereq PREREQUISITES -The plugin currently runs on VDR 1.3.7+. In addition, the following pieces of -software are required: +The plugin currently runs on versions 1.3.17- of VDR. It also compiles on 1.3.18 but +your mileage may vary. In addition, the following pieces of software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) - mySQL client libraries @@ -63,13 +63,13 @@ For example (paths and version numbers may vary) \verbatim cd /usr/local/src/VDR/PLUGINS/src - tar xvjf muggle-0.1.7.tar.bz2 + tar xvjf muggle-0.1.1.tgz \endverbatim Establish a symlink as you would for other plugins: \verbatim - ln -s muggle-0.1.0 muggle + ln -s muggle-0.1.1 muggle \endverbatim Within the VDR main directory (e.g. /usr/local/src/VDR) issue @@ -192,63 +192,116 @@ If a track has no ID3 tags, the following defaults will be applied: \section config MUGGLE CONFIGURATION -Muggle uses a small set of command line parameters in order to control the interaction with the mySQL server. -Let's look at an example: +Muggle uses a small set of command line parameters in order to control +the interaction with the mySQL server. Let's look at an example: \verbatim -P'muggle -h localhost -u vdr -n GiantDisc -t/home/music' \endverbatim -The -h parameter specifies the database host, -u specifies the user, -n is the database name. The scripts mentioned -above do not make use of passwords, but restrict database acccess on a server basis. +The -h parameter specifies the database host, -u specifies the user, +-n is the database name. The scripts mentioned above do not make use +of passwords, but restrict database acccess on a server basis. -The -t argument specifies the top level directory of the music files. On a local installation, this is the -directory in which you executed the import steps (Chapter 4.2). +The -t argument specifies the top level directory of the music files. +On a local installation, this is the directory in which you executed the +import steps (Chapter 4.2). \section quickuse QUICK INTRO -Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), add them using the red button. -Music will start instantly while you can continue to browse and add tracks. +Quick version: select Muggle on the OSD, browse titles (using up/down and Ok), +add them using the red button. Music will start instantly while you can continue +to browse and add tracks. -During playback, Up/Down jumps forth and back in the current playlist. Yellow toggles play/pause mode and Ok -toggles a display of the replay process. Using Green, the display can be switched between playlist and single display mode, red toggles info and progress view. For VDR 1.3.6- the progress display is "quite simple", unfortunately. +During playback, Up/Down jumps forth and back in the current playlist. Yellow +toggles play/pause mode and Ok toggles a display of the replay process. Using +Green, the display can be switched between playlist and single display mode, +Red toggles info and progress view. For VDR 1.3.6- the progress display is +"quite simple", unfortunately. \section use DETAILED USER'S GUIDE -The core concept of the Muggle user interface is called a *selection*. That is, as the name suggests, a selection of music tracks. Note, that a selection can be as small as a single track (a very simple selection, indeed) or as large as the whole music library. - -Selections are used to structure all tracks (the music library) into sets (e.g. a selection of all tracks by an author) and subsets (e.g. the tracks of an author on a certain album). Such selections are built by means of keys (e.g. author or album) defined in the database and are displayed in the *music browser*. The current selection in the *music browser* contains all tracks defined by the line the cursor is on. So if you place the cursor on the line "Pop", all tracks with Genre Pop are selected. If you then enter Pop and go to the line "Beatles", you narrow your selection to pop songs from the beatles. - -A collection is a special selection. Collections can be defined by the user, and he can add or remove any selection to / from a collection. A collection has only ony order: a number which is incremented for every added track. Otherwise, since a collection is also a selection, everything that is valid for selections also holds for collections. - -Collections can be defined by the user in the sense of a playlist. This is done by adding/removing selections to/from the *default collection*. - -Changing the contents of a collection changes them directly in the data base. Saving or loading collections is not needed. - -A very important term while working with Muggle is the *default collection*. This is a special collection which is the target of commands working on collections. Whenever you add selections to somewhere, they will be added to the default collection. The same happens when you remove selections. - -Another important collection is the 'play' collection. This is a temporary collection. Whatever is added to it will be played in that order. If you add something while muggle is not playing anything, this collection will first be emptied. -However 'temporary' does not mean that its content is not saved to the data base. +The core concept of the Muggle user interface is called a *selection*. That is, +as the name suggests, a selection of music tracks. Note, that a selection can be +as small as a single track (a very simple selection, indeed) or as large as the +whole music library. + +Selections are used to structure all tracks (the music library) into sets (e.g. +a selection of all tracks by an author) and subsets (e.g. the tracks of an author +on a certain album). Such selections are built by means of keys (e.g. author +or album) defined in the database and are displayed in the *music browser*. The +current selection in the *music browser* contains all tracks defined by the line +the cursor is on. So if you place the cursor on the line "Pop", all tracks with +Genre Pop are selected. If you then enter Pop and go to the line "Beatles", you +narrow your selection to pop songs from the beatles. + +A collection is a special selection. Collections can be defined by the user, and +he can add or remove any selection to / from a collection. A collection has only +one order: a number which is incremented for every added track. Otherwise, since +a collection is also a selection, everything that is valid for selections also +holds for collections. + +Collections can be defined by the user in the sense of a playlist. This is done by +adding/removing selections to/from the *default collection*. + +Changing the contents of a collection changes them directly in the data base. Saving +or loading collections is not needed. + +An important term while working with Muggle is the *default collection*. This +is a special collection which is the target of commands working on collections. +Whenever you add selections to somewhere, they will be added to the default +collection. The same happens when you remove selections. + +Another important collection is the 'play' collection. This is a temporary collection. +Whatever is added to it will be played in that order. If you add something while muggle +is not playing anything, this collection will first be emptied. However 'temporary' does +not mean that its content is not saved to the data base. + +Starting from release 0.1.1 Muggle can be also used without default playlists. There are +new menu entries "Add X to collection" and "Remove X from collection" which show a list +of all collections to choose from. The concept of a default collection still exists and +both approaches can be used in common. However, you can spceify which commands to use for +the special keys Red/Green/Blueas you like. \subsection general General remarks -There are two main views in Muggle, the *Music browser* view and the *Collection browser* view. You can toggle between them using the yellow key. +There are two main views in Muggle, the *Music browser* view and the *Collection browser* +view. You can toggle between them using the Yellow key by default, however the key binding +can be changed. -Each of the two views has associated commands. To show a summary of the commands available for the current view press the blue key. Note, that the red, green and yellow keys do not have a fixed meaning. Rather, while the commands for a certain view are displayed, you can press red/green/yellow to make the respective key execute the command currently selected (highlighted) by the cursor. The commands you choose for red/green/yellow will be saved for the next time you start muggle. You can define different commands in both view *Music browser* and *Collection browser*. +Each of the two views has associated commands. To show a summary of the commands available +for the current view press the blue key. Note, that the red, green and yellow keys do not +have a fixed meaning. Rather, while the commands for a certain view are displayed, you can +press red/green/yellow to make the respective key execute the command currently selected +(highlighted) by the cursor. The commands you choose for red/green/yellow will be saved for +the next time you start muggle. You can define different commands in both view *Music browser* +and *Collection browser*. \subsection browse Music browser -By default, Muggle starts in the *Music browser* display at the place where you left it last time. This browser displays the music library according to a search order, e.g. according to artists / albums / tracks or genre / year / track. These search orders are currently fixed in the code, but the objective is to make them editable by the user on the OSD. Browsing these search orders is done using Up/Down/Left/Right keys. To display the contents of a currently selected selection, press Ok. To return to the parent selection press Back. +By default, Muggle starts in the *Music browser* display at the place where you left it +last time. This browser displays the music library according to a search order, e.g. +according to artists / albums / tracks or genre / year / track. These search orders are +currently fixed in the code, but the objective is to make them editable by the user on the +OSD. Browsing these search orders is done using Up/Down/Left/Right keys. To display the +contents of a currently selected selection, press Ok. To return to the parent selection +press Back. -A set of commands can be displayed with the Blue key on the remote control. A new menu will open and show the commands explained below. Remember that pressing Red, Green or Yellow will make these keys execute the command currently highlighted by the cursor from now on. +A set of commands can be displayed with the Blue key on the remote control. A new menu +will open and show the commands explained below. Remember that pressing Red, Green or +Yellow will make these keys execute the command currently highlighted by the cursor +from now on. Those commands are currently available in the *music browser*: - Instant Play: instantly play the current selection. This does not enter any collection. -- Add to 'play': add the current selection to the default collection. After the first start of muggle, the default collection is 'play' +- Add to 'play': add the current selection to the default collection. After the first +start of Muggle, the default collection is 'play' -- Remove from 'play': remove the current selection from the default collection. If there are more than one instances of a specific track in the collection, they are all removed. +- Remove from 'play': remove the current selection from the default collection. If +there are more than one instances of a specific track in the collection, they are all +removed. - Collections: switch to the collection view @@ -258,17 +311,32 @@ Those commands are currently available in the *music browser*: - External commands: whatever you define -By default, the red key adds the currently selected collection to the default collection. The green key instantly plays the currently selected collection. The yellow key toggles between the *Music browser* and the *Collection browser*. Thus, if you want to play an album, browse to it and press green. Remember that you can redefine commands executed by red, green and yellow by pressing them while displaying the command list. +By default, the red key adds the currently selected collection to the default collection. +The green key instantly plays the currently selected collection. The yellow key toggles +between the *Music browser* and the *Collection browser*. Thus, if you want to play an +album, browse to it and press green. Remember that you can redefine commands executed by +Red, Green and Yellow by pressing them while displaying the command list. \subsection collections Collection browser -The *Collection browser* displays a list of available collections. Browse the list with Up/Down and display the collection contents with Ok. Returning to the collection list is done by pressing Back. One of the collections (the one called "play" when you start up muggle for the first time) is marked with a "->" in front of the name, meaning that it is the default collection. Whenever you add or remove selections, this default collection is the current target, meaning that selections will be added/removed to/from this collection. +The *Collection browser* displays a list of available collections. Browse the list with +Up/Down and display the collection contents with Ok. Returning to the collection list +is done by pressing Back. One of the collections (the one called "play" when you start +up Muggle for the first time) is marked with a "->" in front of the name, meaning that +it is the default collection. Whenever you add or remove selections, this default +collection is the current target, meaning that selections will be added/removed +to/from this collection. -At the bottom of the list, the entry "Create collection" is displayed. Entering it with the right key will make the editor appear on the second half of the line and using the keys Up/Down/Left/Right you can enter the name of the new collection. Pressing Ok will terminate the editing process and add the new collection to the list. +At the bottom of the list, the entry "Create collection" is displayed. Entering it with +the right key will make the editor appear on the second half of the line and using the +keys Up/Down/Left/Right you can enter the name of the new collection. Pressing Ok will +terminate the editing process and add the new collection to the list. -Just like with the *music browser*, a set of commands can be displayed with the Blue key on the remote control. +Just like with the *music browser*, a set of commands can be displayed with the Blue +key on the remote control. -Those commands are currently available in the list of collections. Depending on the current selection, not all of them are available: +Those commands are currently available in the list of collections. Depending on the +current selection, not all of them are available: - Instant play: See *music browser* @@ -288,12 +356,28 @@ Those commands are currently available in the list of collections. Depending on - External commands: whatever you define -Note that you cannot only add to/remove from collections in the *music browser*. Rather, also collections can be added/removed. The reason is that - as explained above - a collection is also a selection. So everything that can be done with selections can also be done with collections. An example: if you want to give a party, you could create a new collection "Party". Now, steer your cursor to the collection entitled "Lounge music" and select add. Then go to "Pop 80s" and add again. Finally, go to "Dance classics" and add. Now you have created a collection "Party" from three already existing collections. To continue this example, let us assume that one of your guests has a personal dislike against "Modern Talking". Switch to the browser view, go to the artist selection of "Modern Talking" and select "Remove". Now all tracks written by Modern Talking will be removed from your "Party" collection. - -Please note that "Remove" means removing from the default collection. "Delete" will delete a collection. - -It is possible that a collection holds the same track several times if you add it several times. However when you remove that track, all of its occurrences will be removed. - -The remote buttons Play, Pause, Stop are also supported while muggle displays its OSD. If Stop is pressed, muggle first stops playing what was started by Instant Play. Muggle will then continue playing the 'play' collection. A second Stop will stop playing the 'play' collection. +Note that you cannot only add to/remove from collections in the *music browser*. +Rather, also collections can be added/removed. The reason is that - as explained +above - a collection is also a selection. So everything that can be done with +selections can also be done with collections. An example: if you want to give a +party, you could create a new collection "Party". Now, steer your cursor to the +collection entitled "Lounge music" and select add. Then go to "Pop 80s" and add +again. Finally, go to "Dance classics" and add. Now you have created a collection +"Party" from three already existing collections. To continue this example, let us +assume that one of your guests has a personal dislike against "Modern Talking". +Switch to the browser view, go to the artist selection of "Modern Talking" and +select "Remove". Now all tracks written by Modern Talking will be removed from +your "Party" collection. + +Please note that "Remove" means removing from the default collection. "Delete" will +delete a collection. + +It is possible that a collection holds the same track several times if you add it +several times. However when you remove that track, all of its occurrences will be removed. + +The remote buttons Play, Pause, Stop are also supported while muggle displays its +OSD. If Stop is pressed, muggle first stops playing what was started by Instant +Play. Muggle will then continue playing the 'play' collection. A second Stop will +stop playing the 'play' collection. */ -- cgit v1.2.3 From 05801055e91bef231bb6aa48a96034e69bd7f250 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 23 Jan 2005 13:03:34 +0000 Subject: Merged branches osd_extensions and flac_player for new release, yet untested git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@386 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 06e0064..5a00e64 100644 --- a/README +++ b/README @@ -34,8 +34,8 @@ parameters are descibed in Section 5. \section prereq PREREQUISITES -The plugin currently runs on versions 1.3.17- of VDR. It also compiles on 1.3.18 but -your mileage may vary. In addition, the following pieces of software are required: +The plugin currently runs on versions 1.3.17- of VDR (including 1.2.6). It also compiles on 1.3.18 +but your mileage may vary. In addition, the following pieces of software are required: - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) - mySQL client libraries -- cgit v1.2.3 From 8df8600565a9f2c0feb3c55ef4d9bfa5f378a273 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 23 Jan 2005 15:50:30 +0000 Subject: Final bugfixes for next release git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@388 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index 5a00e64..ff5e903 100644 --- a/README +++ b/README @@ -47,10 +47,11 @@ but your mileage may vary. In addition, the following pieces of software are req - libtag (for ID3 tag reading/writing) (Debian package libtag1-dev or http://developer.kde.org/~wheeler/taglib.html) - - optionally libvorbis and libvorbisfile - (Debian packages or + - optionally libvorbis and libvorbisfile to replay OGG Vorbis files + (Debian packages libvorbis-dev or http://www.xiph.org/ogg/vorbis/) - + - optionally libFLAC++ to replay FLAC files + (Debian package libflac++-dev or sources from flac.sourceforge.net) The developer versions are needed because their headers are required for compilation. The server need not be on the same machine as the VDR. Also, music tracks can reside somewhere else, if they are available through a remote filesystem (NFS, Samba). However, in this case you should -- cgit v1.2.3 From d4537b770d7bd6d64ba2ffe1cbe020789fdefbfa Mon Sep 17 00:00:00 2001 From: LarsAC Date: Sun, 23 Jan 2005 19:51:57 +0000 Subject: Minor bugfixes git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@394 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README') diff --git a/README b/README index ff5e903..ed769c0 100644 --- a/README +++ b/README @@ -73,6 +73,8 @@ Establish a symlink as you would for other plugins: ln -s muggle-0.1.1 muggle \endverbatim +Adapt the Makefile to your system. Define HAVE_VORBIS and/or HAVE_FLAC and adapt the LIBS variable accordingly. + Within the VDR main directory (e.g. /usr/local/src/VDR) issue \verbatim -- cgit v1.2.3 From 19b5fbe6f03d263ab8e427022156ed7d2bfcaea1 Mon Sep 17 00:00:00 2001 From: wr61 Date: Fri, 4 Feb 2005 17:08:13 +0000 Subject: fix import of sourc and musictype tables git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@435 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index ed769c0..0b6fd1a 100644 --- a/README +++ b/README @@ -122,10 +122,10 @@ Execute these commands on a single line, the \ for the linebreak ist just for pr echo "use GiantDisc; load data local infile 'languages.txt' into table language;" | \ mysql -u root --local-infile=1 - echo "use GiantDisc; load data local infile 'musictypes.txt' into table language;" | \ + echo "use GiantDisc; load data local infile 'musictypes.txt' into table musictype;" | \ mysql -u root --local-infile=1 - echo "use GiantDisc; load data local infile 'sources.txt' into table language;" | \ + echo "use GiantDisc; load data local infile 'sources.txt' into table source;" | \ mysql -u root --local-infile=1 \endverbatim -- cgit v1.2.3 From 1e61edee5d4dcaa185e3212fd30e663c32b7bbf9 Mon Sep 17 00:00:00 2001 From: LarsAC Date: Mon, 7 Feb 2005 09:37:48 +0000 Subject: Added documentation about user-editable search orders git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@448 e10066b5-e1e2-0310-b819-94efdf66514b --- README | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index 0b6fd1a..dd0d00c 100644 --- a/README +++ b/README @@ -37,8 +37,7 @@ parameters are descibed in Section 5. The plugin currently runs on versions 1.3.17- of VDR (including 1.2.6). It also compiles on 1.3.18 but your mileage may vary. In addition, the following pieces of software are required: - - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) - - mySQL client libraries + - mySQL server (tested with 4.0.18) (Debian packages mysql-server, mysql-client) - mySQL client libraries (Debian package libmysqlclient-dev or http://www.mysql.org) - libmad (for mp3 decoding) @@ -308,7 +307,7 @@ removed. - Collections: switch to the collection view -- Select search order: select another search order +- Select an order: select another search order, edit existing ones, or create new ones (see below) - Export tracklist: generate a file X.m3u containing all tracks from the current selection @@ -320,6 +319,20 @@ between the *Music browser* and the *Collection browser*. Thus, if you want to p album, browse to it and press green. Remember that you can redefine commands executed by Red, Green and Yellow by pressing them while displaying the command list. +Muggle comes with a few default browsing orders (like artist / album /track). Since release 0.1.2 +it is possible for the user to change these or create now ones without going into the code. +In the music browser submenu (enter with blue while in the music browser) enter "Select an order". +Existing search orders will be shown. Move the cursor to any of those and press the Red button to edit +it. Each key of the current search order will be shown on a line. Move the cursor to a line and +change the search key using Left/Right buttons. Note, that the number of key depends on what is +currently selected. So keys may appear/vanish as you cycle through the choices. This is intented +and not a bug. Play around with this a while to see, why this is necessary. Press Ok to make your +choices persistent, use back to leave the search order editor without making any changes. + +In addition, you can create new search orders using the Green key and delete orders no longer +needed using Yellow. As an exercise, try to e.g. create orders like "Decade > Genre > Track" or +"Year > Album > Track". + \subsection collections Collection browser The *Collection browser* displays a list of available collections. Browse the list with -- cgit v1.2.3