Allow specifying options specific to each url in the shout service discovery.
[vlc.git] / modules / demux / playlist / m3u.c
1 /*****************************************************************************
2  * m3u.c : M3U playlist format import
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Sigmund Augdal Helberg <dnumgis@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #include <vlc/vlc.h>
30 #include <vlc_demux.h>
31 #include <vlc_charset.h>
32
33 #include "playlist.h"
34
35 struct demux_sys_t
36 {
37     char *psz_prefix;
38 };
39
40 /*****************************************************************************
41  * Local prototypes
42  *****************************************************************************/
43 static int Demux( demux_t *p_demux);
44 static int Control( demux_t *p_demux, int i_query, va_list args );
45 static void parseEXTINF( char *psz_string, char **ppsz_artist, char **ppsz_name, int *pi_duration );
46
47 /*****************************************************************************
48  * Import_M3U: main import function
49  *****************************************************************************/
50 int E_(Import_M3U)( vlc_object_t *p_this )
51 {
52     demux_t *p_demux = (demux_t *)p_this;
53     const uint8_t *p_peek;
54     CHECK_PEEK( p_peek, 8 );
55
56     if(! ( POKE( p_peek, "#EXTM3U", 7 ) || POKE( p_peek, "RTSPtext", 8 ) ||
57            demux2_IsPathExtension( p_demux, ".m3u" ) || demux2_IsPathExtension( p_demux, ".vlc" ) ||
58            /* A .ram file can contain a single rtsp link */
59            demux2_IsPathExtension( p_demux, ".ram" ) || demux2_IsPathExtension( p_demux, ".rm" ) ||
60            demux2_IsForced( p_demux,  "m3u" ) ) )
61         return VLC_EGENERIC;
62
63     STANDARD_DEMUX_INIT_MSG( "found valid M3U playlist" );
64     p_demux->p_sys->psz_prefix = E_(FindPrefix)( p_demux );
65
66     return VLC_SUCCESS;
67 }
68
69 /*****************************************************************************
70  * Deactivate: frees unused data
71  *****************************************************************************/
72 void E_(Close_M3U)( vlc_object_t *p_this )
73 {
74     demux_t *p_demux = (demux_t *)p_this;
75     free( p_demux->p_sys->psz_prefix );
76     free( p_demux->p_sys );
77 }
78
79
80 /* Gruik! */
81 static inline char *MaybeFromLocaleDup (const char *str)
82 {
83     if (str == NULL)
84         return NULL;
85
86     return IsUTF8 (str) ? strdup (str) : FromLocaleDup (str);
87 }
88
89
90 static inline void MaybeFromLocaleRep (char **str)
91 {
92     char *const orig_str = *str;
93
94     if ((orig_str != NULL) && !IsUTF8 (orig_str))
95     {
96         *str = FromLocaleDup (orig_str);
97         free (orig_str);
98     }
99 }
100
101
102 static int Demux( demux_t *p_demux )
103 {
104     char       *psz_line;
105     char       *psz_name = NULL;
106     char       *psz_artist = NULL;
107     int        i_parsed_duration = 0;
108     mtime_t    i_duration = -1;
109     const char**ppsz_options = NULL;
110     int        i_options = 0;
111     vlc_bool_t b_cleanup = VLC_FALSE;
112     vlc_bool_t b_enable_extvlcopt = var_CreateGetInteger( p_demux,
113                                                           "m3u-extvlcopt" );
114     input_item_t *p_input;
115
116     INIT_PLAYLIST_STUFF;
117
118     psz_line = stream_ReadLine( p_demux->s );
119     while( psz_line )
120     {
121         char *psz_parse = psz_line;
122
123         /* Skip leading tabs and spaces */
124         while( *psz_parse == ' ' || *psz_parse == '\t' ||
125                *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
126
127         if( *psz_parse == '#' )
128         {
129             /* Parse extra info */
130
131             /* Skip leading tabs and spaces */
132             while( *psz_parse == ' ' || *psz_parse == '\t' ||
133                    *psz_parse == '\n' || *psz_parse == '\r' ||
134                    *psz_parse == '#' ) psz_parse++;
135
136             if( !*psz_parse ) goto error;
137
138             if( !strncasecmp( psz_parse, "EXTINF:", sizeof("EXTINF:") -1 ) )
139             {
140                 /* Extended info */
141                 psz_parse += sizeof("EXTINF:") - 1;
142                 parseEXTINF( psz_parse, &psz_artist, &psz_name, &i_parsed_duration );
143                 if( i_parsed_duration >= 0 )
144                     i_duration = i_parsed_duration * I64C(1000000);
145                 if( psz_name )
146                     psz_name = strdup( psz_name );
147                 if( psz_artist )
148                     psz_artist = strdup( psz_artist );
149             }
150             else if( !strncasecmp( psz_parse, "EXTVLCOPT:",
151                                    sizeof("EXTVLCOPT:") -1 ) )
152             {
153                 if( b_enable_extvlcopt )
154                 {
155                     /* VLC Option */
156                     char *psz_option;
157                     psz_parse += sizeof("EXTVLCOPT:") -1;
158                     if( !*psz_parse ) goto error;
159
160                     psz_option = MaybeFromLocaleDup( psz_parse );
161                     if( psz_option )
162                         INSERT_ELEM( ppsz_options, i_options, i_options,
163                                      psz_option );
164                 }
165                 else
166                 {
167                     msg_Err( p_demux, "m3u EXTVLCOPT parsing is disabled for security reasons. If you need it and trust the m3u playlist you are trying to open, please append --m3u-extvlcopt to your command line." );
168                 }
169             }
170         }
171         else if( !strncasecmp( psz_parse, "RTSPtext", sizeof("RTSPtext") -1 ) )
172         {
173             ;/* special case to handle QuickTime RTSPtext redirect files */
174         }
175         else if( *psz_parse )
176         {
177             char *psz_mrl;
178             if( !psz_name || !*psz_name )
179             {
180                 /* Use filename as name for relative entries */
181                 psz_name = MaybeFromLocaleDup( psz_parse );
182             }
183
184             psz_mrl = E_(ProcessMRL)( psz_parse, p_demux->p_sys->psz_prefix );
185             MaybeFromLocaleRep( &psz_mrl );
186
187             b_cleanup = VLC_TRUE;
188             if( !psz_mrl ) goto error;
189
190             p_input = input_ItemNewExt( p_playlist, psz_mrl, psz_name,
191                                         i_options, ppsz_options, i_duration );
192             if ( psz_artist && *psz_artist )
193                 input_ItemAddInfo( p_input, _(VLC_META_INFO_CAT),
194                                    _(VLC_META_ARTIST), "%s", psz_artist );
195             input_ItemAddSubItem( p_current_input, p_input );
196             vlc_gc_decref( p_input );
197             free( psz_mrl );
198         }
199
200  error:
201
202         /* Fetch another line */
203         free( psz_line );
204         psz_line = stream_ReadLine( p_demux->s );
205         if( !psz_line ) b_cleanup = VLC_TRUE;
206
207         if( b_cleanup )
208         {
209             /* Cleanup state */
210             while( i_options-- ) free( (char*)ppsz_options[i_options] );
211             if( ppsz_options ) free( ppsz_options );
212             ppsz_options = NULL; i_options = 0;
213             if( psz_name ) free( psz_name );
214             psz_name = NULL;
215             if ( psz_artist ) free( psz_artist );
216             psz_artist = NULL;
217             i_parsed_duration = 0;
218             i_duration = -1;
219
220             b_cleanup = VLC_FALSE;
221         }
222     }
223     HANDLE_PLAY_AND_RELEASE;
224     var_Destroy( p_demux, "m3u-extvlcopt" );
225     return 0; /* Needed for correct operation of go back */
226 }
227
228 static int Control( demux_t *p_demux, int i_query, va_list args )
229 {
230     return VLC_EGENERIC;
231 }
232
233 static void parseEXTINF(char *psz_string, char **ppsz_artist,
234                         char **ppsz_name, int *pi_duration)
235 {
236     char *end = NULL;
237     char *psz_item = NULL;
238
239     end = psz_string + strlen( psz_string );
240
241     /* ignore whitespaces */
242     for (; psz_string < end && ( *psz_string == '\t' || *psz_string == ' ' );
243          psz_string++ );
244
245     /* duration: read to next comma */
246     psz_item = psz_string;
247     psz_string = strchr( psz_string, ',' );
248     if ( psz_string )
249     {
250         *psz_string = '\0';
251         *pi_duration = atoi( psz_item );
252     }
253     else
254     {
255         return;
256     }
257
258     if ( psz_string < end )               /* continue parsing if possible */
259         psz_string++;
260
261     /* analyse the remaining string */
262     psz_item = strstr( psz_string, " - " );
263
264     /* here we have the 0.8.2+ format with artist */
265     if ( psz_item )
266     {
267         /* *** "EXTINF:time,artist - name" */
268         *psz_item = '\0';
269         *ppsz_artist = psz_string;
270         *ppsz_name = psz_item + 3;          /* points directly after ' - ' */
271         return;
272     }
273
274     /* reaching this point means: 0.8.1- with artist or something without artist */
275     if ( *psz_string == ',' )
276     {
277         /* *** "EXTINF:time,,name" */
278         psz_string++;
279         *ppsz_name = psz_string;
280         return;
281     }
282
283     psz_item = psz_string;
284     psz_string = strchr( psz_string, ',' );
285     if ( psz_string )
286     {
287         /* *** "EXTINF:time,artist,name" */
288         *psz_string = '\0';
289         *ppsz_artist = psz_item;
290         *ppsz_name = psz_string+1;
291     }
292     else
293     {
294         /* *** "EXTINF:time,name" */
295         *ppsz_name = psz_item;
296     }
297     return;
298 }
299