Fix XSPF (Closes:#651)
[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 #include <vlc/vlc.h>
28 #include <vlc/input.h>
29 #include <vlc_playlist.h>
30
31 #include "playlist.h"
32
33 /*****************************************************************************
34  * Module descriptor
35  *****************************************************************************/
36 #define AUTOSTART_TEXT N_( "Auto start" )
37 /// \bug [String] Why \n ?
38 #define AUTOSTART_LONGTEXT N_( "Automatically start playing the playlist " \
39                 "content once it's loaded.\n" )
40
41 #define SHOW_ADULT_TEXT N_( "Show shoutcast adult content" )
42 #define SHOW_ADULT_LONGTEXT N_( "Show NC17 rated video streams when " \
43                 "using shoutcast video playlists." )
44
45 vlc_module_begin();
46     add_shortcut( "playlist" );
47     set_category( CAT_INPUT );
48     set_subcategory( SUBCAT_INPUT_DEMUX );
49
50     add_bool( "playlist-autostart", 1, NULL,
51               AUTOSTART_TEXT, AUTOSTART_LONGTEXT, VLC_FALSE );
52
53     add_integer( "parent-item", 0, NULL, NULL, NULL, VLC_TRUE );
54
55     set_shortname( _("Playlist") );
56     set_description( _("Playlist") );
57     add_shortcut( "old-open" );
58     set_capability( "demux2", 10 );
59     set_callbacks( E_(Import_Old), NULL );
60     add_submodule();
61         set_description( _("M3U playlist import") );
62         add_shortcut( "m3u-open" );
63         set_capability( "demux2", 10 );
64         set_callbacks( E_(Import_M3U), E_(Close_M3U) );
65     add_submodule();
66         set_description( _("PLS playlist import") );
67         add_shortcut( "pls-open" );
68         set_capability( "demux2", 10 );
69         set_callbacks( E_(Import_PLS), E_(Close_PLS) );
70     add_submodule();
71         set_description( _("B4S playlist import") );
72         add_shortcut( "b4s-open" );
73         add_shortcut( "shout-b4s" );
74         set_capability( "demux2", 10 );
75         set_callbacks( E_(Import_B4S), E_(Close_B4S) );
76     add_submodule();
77         set_description( _("DVB playlist import") );
78         add_shortcut( "dvb-open" );
79         set_capability( "demux2", 10 );
80         set_callbacks( E_(Import_DVB), E_(Close_DVB) );
81     add_submodule();
82         set_description( _("Podcast parser") );
83         add_shortcut( "podcast" );
84         set_capability( "demux2", 10 );
85         set_callbacks( E_(Import_podcast), E_(Close_podcast) );
86     add_submodule();
87         set_description( _("XSPF playlist import") );
88         add_shortcut( "xspf-open" );
89         set_capability( "demux2", 10 );
90         set_callbacks( E_(xspf_import_Activate), NULL );
91     add_submodule();
92         set_description( _("New winamp 5.2 shoutcast import") );
93         add_shortcut( "shout-winamp" );
94         set_capability( "demux2", 10 );
95         set_callbacks( E_(Import_Shoutcast), E_(Close_Shoutcast) );
96         add_bool( "shoutcast-show-adult", VLC_FALSE, NULL,
97                    SHOW_ADULT_TEXT, SHOW_ADULT_LONGTEXT, VLC_FALSE );
98 vlc_module_end();
99
100
101 /**
102  * Find directory part of the path to the playlist file, in case of
103  * relative paths inside
104  */
105 char *E_(FindPrefix)( demux_t *p_demux )
106 {
107     char *psz_name;
108     char *psz_path = strdup( p_demux->psz_path );
109
110 #ifndef WIN32
111     psz_name = strrchr( psz_path, '/' );
112 #else
113     psz_name = strrchr( psz_path, '\\' );
114     if( !psz_name ) psz_name = strrchr( psz_path, '/' );
115 #endif
116     if( psz_name ) psz_name[1] = '\0';
117     else *psz_path = '\0';
118
119     return psz_path;
120 }
121
122 /**
123  * Add the directory part of the playlist file to the start of the
124  * mrl, if the mrl is a relative file path
125  */
126 char *E_(ProcessMRL)( char *psz_mrl, char *psz_prefix )
127 {
128     /* Check for a protocol name.
129      * for URL, we should look for "://"
130      * for MRL (Media Resource Locator) ([[<access>][/<demux>]:][<source>]),
131      * we should look for ":", so we end up looking simply for ":"
132      * PB: on some file systems, ':' are valid characters though */
133
134     /* Simple cases first */
135     if( !psz_mrl || !*psz_mrl ) return NULL;
136     if( !psz_prefix || !*psz_prefix ) return strdup( psz_mrl );
137
138     /* Check if the line specifies an absolute path */
139     if( *psz_mrl == '/' || *psz_mrl == '\\' ) return strdup( psz_mrl );
140
141     /* Check if the line specifies an mrl/url
142      * (and on win32, contains a drive letter) */
143     if( strchr( psz_mrl, ':' ) ) return strdup( psz_mrl );
144
145     /* This a relative path, prepend the prefix */
146     asprintf( &psz_mrl, "%s%s", psz_prefix, psz_mrl );
147     return psz_mrl;
148 }
149
150 void E_(AddToPlaylist)( demux_t *p_demux, playlist_t *p_playlist,
151                         input_item_t *p_input,
152                         playlist_item_t *p_item, int i_parent_id )
153 {
154     // Only add to parent if specific parent requested or not current
155     // playlist item
156    if( i_parent_id > 0 || ! (
157          p_playlist->status.p_item &&
158          p_playlist->status.p_item->p_input ==
159               ((input_thread_t *)p_demux->p_parent)->input.p_item ) )
160    {
161        playlist_NodeAddInput( p_playlist, p_input, p_item,
162                               PLAYLIST_APPEND, PLAYLIST_END );
163    }
164    // Else, add to both
165    else
166    {
167        playlist_BothAddInput( p_playlist, p_input, p_item,
168                               PLAYLIST_APPEND, PLAYLIST_END );
169    }
170    vlc_input_item_CopyOptions( p_item->p_input, p_input );
171 }
172
173
174 vlc_bool_t E_(FindItem)( demux_t *p_demux, playlist_t *p_playlist,
175                      playlist_item_t **pp_item )
176 {
177      vlc_bool_t b_play = var_CreateGetBool( p_demux, "playlist-autostart" );
178
179      if( b_play && p_playlist->status.p_item &&
180              p_playlist->status.p_item->p_input ==
181                 ((input_thread_t *)p_demux->p_parent)->input.p_item )
182      {
183          msg_Dbg( p_playlist, "starting playlist playback" );
184          *pp_item = p_playlist->status.p_item;
185          b_play = VLC_TRUE;
186      }
187      else
188      {
189          input_item_t *p_current = ( (input_thread_t*)p_demux->p_parent)->
190                                                         input.p_item;
191          *pp_item = playlist_LockItemGetByInput( p_playlist, p_current );
192          if( !*pp_item )
193          {
194              msg_Dbg( p_playlist, "unable to find item in playlist");
195          }
196          msg_Dbg( p_playlist, "not starting playlist playback");
197          b_play = VLC_FALSE;
198      }
199      return b_play;
200 }