Be consistent with module naming.
[vlc.git] / modules / demux / playlist / playlist.c
1 /*****************************************************************************
2  * playlist.c :  Playlist import module
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_demux.h>
34
35 #include "playlist.h"
36
37 /*****************************************************************************
38  * Module descriptor
39  *****************************************************************************/
40 #define AUTOSTART_TEXT N_( "Auto start" )
41 #define AUTOSTART_LONGTEXT N_( "Automatically start playing the playlist " \
42                 "content once it's loaded." )
43
44 #define SHOW_ADULT_TEXT N_( "Show shoutcast adult content" )
45 #define SHOW_ADULT_LONGTEXT N_( "Show NC17 rated video streams when " \
46                 "using shoutcast video playlists." )
47
48 #define SKIP_ADS_TEXT N_( "Skip ads" )
49 #define SKIP_ADS_LONGTEXT N_( "Use playlist options usually used to prevent " \
50     "ads skipping to detect ads and prevent adding them to the playlist." )
51
52 vlc_module_begin ()
53     add_shortcut( "playlist" )
54     set_category( CAT_INPUT )
55     set_subcategory( SUBCAT_INPUT_DEMUX )
56
57     add_bool( "playlist-autostart", 1, NULL,
58               AUTOSTART_TEXT, AUTOSTART_LONGTEXT, false )
59
60     add_integer( "parent-item", 0, NULL, NULL, NULL, true )
61         change_internal ()
62
63     add_bool( "playlist-skip-ads", 1, NULL,
64               SKIP_ADS_TEXT, SKIP_ADS_LONGTEXT, false )
65
66     set_shortname( N_("Playlist") )
67     set_description( N_("Playlist") )
68     add_submodule ()
69         set_description( N_("M3U playlist import") )
70         add_shortcut( "playlist" )
71         add_shortcut( "m3u-open" )
72         set_capability( "demux", 10 )
73         set_callbacks( Import_M3U, Close_M3U )
74     add_submodule ()
75         set_description( N_("RAM playlist import") )
76         add_shortcut( "playlist" )
77         add_shortcut( "ram-open" )
78         set_capability( "demux", 10 )
79         set_callbacks( Import_RAM, Close_RAM )
80     add_submodule ()
81         set_description( N_("PLS playlist import") )
82         add_shortcut( "playlist" )
83         add_shortcut( "pls-open" )
84         set_capability( "demux", 10 )
85         set_callbacks( Import_PLS, Close_PLS )
86     add_submodule ()
87         set_description( N_("B4S playlist import") )
88         add_shortcut( "playlist" )
89         add_shortcut( "b4s-open" )
90         add_shortcut( "shout-b4s" )
91         set_capability( "demux", 10 )
92         set_callbacks( Import_B4S, Close_B4S )
93     add_submodule ()
94         set_description( N_("DVB playlist import") )
95         add_shortcut( "playlist" )
96         add_shortcut( "dvb-open" )
97         set_capability( "demux", 10 )
98         set_callbacks( Import_DVB, Close_DVB )
99     add_submodule ()
100         set_description( N_("Podcast parser") )
101         add_shortcut( "playlist" )
102         add_shortcut( "podcast" )
103         set_capability( "demux", 10 )
104         set_callbacks( Import_podcast, Close_podcast )
105     add_submodule ()
106         set_description( N_("XSPF playlist import") )
107         add_shortcut( "playlist" )
108         add_shortcut( "xspf-open" )
109         set_capability( "demux", 10 )
110         set_callbacks( Import_xspf, Close_xspf )
111     add_submodule ()
112         set_description( N_("New winamp 5.2 shoutcast import") )
113         add_shortcut( "playlist" )
114         add_shortcut( "shout-winamp" )
115         set_capability( "demux", 10 )
116         set_callbacks( Import_Shoutcast, Close_Shoutcast )
117         add_bool( "shoutcast-show-adult", false, NULL,
118                    SHOW_ADULT_TEXT, SHOW_ADULT_LONGTEXT, false )
119     add_submodule ()
120         set_description( N_("ASX playlist import") )
121         add_shortcut( "playlist" )
122         add_shortcut( "asx-open" )
123         set_capability( "demux", 10 )
124         set_callbacks( Import_ASX, Close_ASX )
125     add_submodule ()
126         set_description( N_("Kasenna MediaBase parser") )
127         add_shortcut( "playlist" )
128         add_shortcut( "sgimb" )
129         set_capability( "demux", 10 )
130         set_callbacks( Import_SGIMB, Close_SGIMB )
131     add_submodule ()
132         set_description( N_("QuickTime Media Link importer") )
133         add_shortcut( "playlist" )
134         add_shortcut( "qtl" )
135         set_capability( "demux", 10 )
136         set_callbacks( Import_QTL, Close_QTL )
137     add_submodule ()
138         set_description( N_("Google Video Playlist importer") )
139         add_shortcut( "playlist" )
140         add_shortcut( "gvp" )
141         set_capability( "demux", 10 )
142         set_callbacks( Import_GVP, Close_GVP )
143     add_submodule ()
144         set_description( N_("Dummy ifo demux") )
145         add_shortcut( "playlist" )
146         set_capability( "demux", 12 )
147         set_callbacks( Import_IFO, Close_IFO )
148     add_submodule ()
149         set_description( N_("iTunes Music Library importer") )
150         add_shortcut( "playlist" )
151         add_shortcut( "itml" )
152         set_capability( "demux", 10 )
153         set_callbacks( Import_iTML, Close_iTML )
154     add_submodule ()
155         set_description( N_("WPL playlist import") )
156         add_shortcut( "playlist" )
157         add_shortcut( "wpl" )
158         set_capability( "demux", 10 )
159         set_callbacks( Import_WPL, Close_WPL )
160     add_submodule ()
161         set_description( N_("ZPL playlist import") )
162         add_shortcut( "playlist" )
163         add_shortcut( "zpl" )
164         set_capability( "demux", 10 )
165         set_callbacks( Import_ZPL, Close_ZPL )
166 vlc_module_end ()
167
168
169 /**
170  * Find directory part of the path to the playlist file, in case of
171  * relative paths inside
172  */
173 char *FindPrefix( demux_t *p_demux )
174 {
175     char *psz_file;
176     char *psz_prefix;
177     const char *psz_path = p_demux->psz_path;
178
179 #ifdef WIN32
180     psz_file = strrchr( psz_path, '\\' );
181     if( !psz_file )
182 #endif
183     psz_file = strrchr( psz_path, '/' );
184
185     if( psz_file )
186         psz_prefix = strndup( psz_path, psz_file - psz_path + 1 );
187     else
188         psz_prefix = strdup( "" );
189
190     return psz_prefix;
191 }
192
193 /**
194  * Add the directory part of the playlist file to the start of the
195  * mrl, if the mrl is a relative file path
196  */
197 char *ProcessMRL( char *psz_mrl, char *psz_prefix )
198 {
199     /* Check for a protocol name.
200      * for URL, we should look for "://"
201      * for MRL (Media Resource Locator) ([[<access>][/<demux>]:][<source>]),
202      * we should look for ":", so we end up looking simply for ":"
203      * PB: on some file systems, ':' are valid characters though */
204
205     /* Simple cases first */
206     if( !psz_mrl || !*psz_mrl ) return NULL;
207     if( !psz_prefix || !*psz_prefix ) return strdup( psz_mrl );
208
209     /* Check if the line specifies an absolute path */
210     if( *psz_mrl == '/' || *psz_mrl == '\\' ) return strdup( psz_mrl );
211
212     /* Check if the line specifies an mrl/url
213      * (and on win32, contains a drive letter) */
214     if( strchr( psz_mrl, ':' ) ) return strdup( psz_mrl );
215
216     /* This a relative path, prepend the prefix */
217     if( asprintf( &psz_mrl, "%s%s", psz_prefix, psz_mrl ) != -1 )
218         return psz_mrl;
219     else
220         return NULL;
221 }