8a9e696f3ed179946750cfef89aeb2194ec47498
[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 = config_GetInt( p_demux, "m3u-extvlcopt" );
113     input_item_t *p_input;
114
115     INIT_PLAYLIST_STUFF;
116
117     psz_line = stream_ReadLine( p_demux->s );
118     while( psz_line )
119     {
120         char *psz_parse = psz_line;
121
122         /* Skip leading tabs and spaces */
123         while( *psz_parse == ' ' || *psz_parse == '\t' ||
124                *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
125
126         if( *psz_parse == '#' )
127         {
128             /* Parse extra info */
129
130             /* Skip leading tabs and spaces */
131             while( *psz_parse == ' ' || *psz_parse == '\t' ||
132                    *psz_parse == '\n' || *psz_parse == '\r' ||
133                    *psz_parse == '#' ) psz_parse++;
134
135             if( !*psz_parse ) goto error;
136
137             if( !strncasecmp( psz_parse, "EXTINF:", sizeof("EXTINF:") -1 ) )
138             {
139                 /* Extended info */
140                 psz_parse += sizeof("EXTINF:") - 1;
141                 parseEXTINF( psz_parse, &psz_artist, &psz_name, &i_parsed_duration );
142                 if( i_parsed_duration >= 0 )
143                     i_duration = i_parsed_duration * I64C(1000000);
144                 if( psz_name )
145                     psz_name = strdup( psz_name );
146                 if( psz_artist )
147                     psz_artist = strdup( psz_artist );
148             }
149             else if( !strncasecmp( psz_parse, "EXTVLCOPT:",
150                                    sizeof("EXTVLCOPT:") -1 ) )
151             {
152                 if( b_enable_extvlcopt )
153                 {
154                     /* VLC Option */
155                     char *psz_option;
156                     psz_parse += sizeof("EXTVLCOPT:") -1;
157                     if( !*psz_parse ) goto error;
158
159                     psz_option = MaybeFromLocaleDup( psz_parse );
160                     if( psz_option )
161                         INSERT_ELEM( ppsz_options, i_options, i_options,
162                                      psz_option );
163                 }
164                 else
165                 {
166                     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." );
167                 }
168             }
169         }
170         else if( !strncasecmp( psz_parse, "RTSPtext", sizeof("RTSPtext") -1 ) )
171         {
172             ;/* special case to handle QuickTime RTSPtext redirect files */
173         }
174         else if( *psz_parse )
175         {
176             char *psz_mrl;
177             if( !psz_name || !*psz_name )
178             {
179                 /* Use filename as name for relative entries */
180                 psz_name = MaybeFromLocaleDup( psz_parse );
181             }
182
183             psz_mrl = E_(ProcessMRL)( psz_parse, p_demux->p_sys->psz_prefix );
184             MaybeFromLocaleRep( &psz_mrl );
185
186             b_cleanup = VLC_TRUE;
187             if( !psz_mrl ) goto error;
188
189             p_input = input_ItemNewExt( p_playlist, psz_mrl, psz_name,
190                                         i_options, ppsz_options, i_duration );
191             if ( psz_artist && *psz_artist )
192                 input_ItemAddInfo( p_input, _(VLC_META_INFO_CAT),
193                                    _(VLC_META_ARTIST), "%s", psz_artist );
194             input_ItemAddSubItem( p_current_input, p_input );
195             vlc_gc_decref( p_input );
196             free( psz_mrl );
197         }
198
199  error:
200
201         /* Fetch another line */
202         free( psz_line );
203         psz_line = stream_ReadLine( p_demux->s );
204         if( !psz_line ) b_cleanup = VLC_TRUE;
205
206         if( b_cleanup )
207         {
208             /* Cleanup state */
209             while( i_options-- ) free( (char*)ppsz_options[i_options] );
210             if( ppsz_options ) free( ppsz_options );
211             ppsz_options = NULL; i_options = 0;
212             if( psz_name ) free( psz_name );
213             psz_name = NULL;
214             if ( psz_artist ) free( psz_artist );
215             psz_artist = NULL;
216             i_parsed_duration = 0;
217             i_duration = -1;
218
219             b_cleanup = VLC_FALSE;
220         }
221     }
222     HANDLE_PLAY_AND_RELEASE;
223     return 0; /* Needed for correct operation of go back */
224 }
225
226 static int Control( demux_t *p_demux, int i_query, va_list args )
227 {
228     return VLC_EGENERIC;
229 }
230
231 static void parseEXTINF(char *psz_string, char **ppsz_artist,
232                         char **ppsz_name, int *pi_duration)
233 {
234     char *end = NULL;
235     char *psz_item = NULL;
236
237     end = psz_string + strlen( psz_string );
238
239     /* ignore whitespaces */
240     for (; psz_string < end && ( *psz_string == '\t' || *psz_string == ' ' );
241          psz_string++ );
242
243     /* duration: read to next comma */
244     psz_item = psz_string;
245     psz_string = strchr( psz_string, ',' );
246     if ( psz_string )
247     {
248         *psz_string = '\0';
249         *pi_duration = atoi( psz_item );
250     }
251     else
252     {
253         return;
254     }
255
256     if ( psz_string < end )               /* continue parsing if possible */
257         psz_string++;
258
259     /* analyse the remaining string */
260     psz_item = strstr( psz_string, " - " );
261
262     /* here we have the 0.8.2+ format with artist */
263     if ( psz_item )
264     {
265         /* *** "EXTINF:time,artist - name" */
266         *psz_item = '\0';
267         *ppsz_artist = psz_string;
268         *ppsz_name = psz_item + 3;          /* points directly after ' - ' */
269         return;
270     }
271
272     /* reaching this point means: 0.8.1- with artist or something without artist */
273     if ( *psz_string == ',' )
274     {
275         /* *** "EXTINF:time,,name" */
276         psz_string++;
277         *ppsz_name = psz_string;
278         return;
279     }
280
281     psz_item = psz_string;
282     psz_string = strchr( psz_string, ',' );
283     if ( psz_string )
284     {
285         /* *** "EXTINF:time,artist,name" */
286         *psz_string = '\0';
287         *ppsz_artist = psz_item;
288         *ppsz_name = psz_string+1;
289     }
290     else
291     {
292         /* *** "EXTINF:time,name" */
293         *ppsz_name = psz_item;
294     }
295     return;
296 }
297