6d54c3929a35aefb1e3269c044ba7a8cccc9633b
[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 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_demux.h>
35 #include <vlc_charset.h>
36
37 #include "playlist.h"
38
39 struct demux_sys_t
40 {
41     char *psz_prefix;
42 };
43
44 /*****************************************************************************
45  * Local prototypes
46  *****************************************************************************/
47 static int Demux( demux_t *p_demux);
48 static int Control( demux_t *p_demux, int i_query, va_list args );
49 static void parseEXTINF( char *psz_string, char **ppsz_artist, char **ppsz_name, int *pi_duration );
50 static bool ContainsURL( demux_t *p_demux );
51
52 /*****************************************************************************
53  * Import_M3U: main import function
54  *****************************************************************************/
55 int Import_M3U( vlc_object_t *p_this )
56 {
57     demux_t *p_demux = (demux_t *)p_this;
58     const uint8_t *p_peek;
59     CHECK_PEEK( p_peek, 8 );
60
61     if(! ( POKE( p_peek, "#EXTM3U", 7 ) || POKE( p_peek, "RTSPtext", 8 ) ||
62            demux_IsPathExtension( p_demux, ".m3u" ) || demux_IsPathExtension( p_demux, ".vlc" ) ||
63            demux_IsForced( p_demux,  "m3u" ) || ContainsURL( p_demux ) ) )
64         return VLC_EGENERIC;
65
66     STANDARD_DEMUX_INIT_MSG( "found valid M3U playlist" );
67     p_demux->p_sys->psz_prefix = FindPrefix( p_demux );
68
69     return VLC_SUCCESS;
70 }
71
72 static bool ContainsURL( demux_t *p_demux )
73 {
74     const uint8_t *p_peek, *p_peek_end;
75     int i_peek;
76
77     i_peek = stream_Peek( p_demux->s, &p_peek, 1024 );
78     if( i_peek <= 0 ) return false;
79     p_peek_end = p_peek + i_peek;
80
81     while( p_peek + sizeof( "https://" ) < p_peek_end )
82     {
83         /* One line starting with an URL is enough */
84         if( !strncasecmp( (const char *)p_peek, "http://", 7 ) ||
85             !strncasecmp( (const char *)p_peek, "mms://", 6 ) ||
86             !strncasecmp( (const char *)p_peek, "rtsp://", 7 ) ||
87             !strncasecmp( (const char *)p_peek, "https://", 8 ) ||
88             !strncasecmp( (const char *)p_peek, "ftp://", 6 ) )
89         {
90             return true;
91         }
92         /* Comments and blank lines are ignored */
93         else if( *p_peek != '#' && *p_peek != '\n' && *p_peek != '\r')
94         {
95             return false;
96         }
97
98         while( p_peek < p_peek_end && *p_peek != '\n' )
99             p_peek++;
100         if ( *p_peek == '\n' )
101             p_peek++;
102     }
103     return false;
104 }
105
106 /*****************************************************************************
107  * Deactivate: frees unused data
108  *****************************************************************************/
109 void Close_M3U( vlc_object_t *p_this )
110 {
111     demux_t *p_demux = (demux_t *)p_this;
112     free( p_demux->p_sys->psz_prefix );
113     free( p_demux->p_sys );
114 }
115
116
117 static int Demux( demux_t *p_demux )
118 {
119     char       *psz_line;
120     char       *psz_name = NULL;
121     char       *psz_artist = NULL;
122     int        i_parsed_duration = 0;
123     mtime_t    i_duration = -1;
124     const char**ppsz_options = NULL;
125     int        i_options = 0;
126     bool b_cleanup = false;
127     input_item_t *p_input;
128
129     input_item_t *p_current_input = GetCurrentItem(p_demux);
130
131     psz_line = stream_ReadLine( p_demux->s );
132     while( psz_line )
133     {
134         char *psz_parse = psz_line;
135
136         /* Skip leading tabs and spaces */
137         while( *psz_parse == ' ' || *psz_parse == '\t' ||
138                *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
139
140         if( *psz_parse == '#' )
141         {
142             /* Parse extra info */
143
144             /* Skip leading tabs and spaces */
145             while( *psz_parse == ' ' || *psz_parse == '\t' ||
146                    *psz_parse == '\n' || *psz_parse == '\r' ||
147                    *psz_parse == '#' ) psz_parse++;
148
149             if( !*psz_parse ) goto error;
150
151             if( !strncasecmp( psz_parse, "EXTINF:", sizeof("EXTINF:") -1 ) )
152             {
153                 /* Extended info */
154                 psz_parse += sizeof("EXTINF:") - 1;
155                 parseEXTINF( psz_parse, &psz_artist, &psz_name, &i_parsed_duration );
156                 if( i_parsed_duration >= 0 )
157                     i_duration = i_parsed_duration * INT64_C(1000000);
158                 if( psz_name )
159                     psz_name = FromLocaleDup( psz_name );
160                 if( psz_artist )
161                     psz_artist = FromLocaleDup( psz_artist );
162             }
163             else if( !strncasecmp( psz_parse, "EXTVLCOPT:",
164                                    sizeof("EXTVLCOPT:") -1 ) )
165             {
166                 /* VLC Option */
167                 char *psz_option;
168                 psz_parse += sizeof("EXTVLCOPT:") -1;
169                 if( !*psz_parse ) goto error;
170
171                 psz_option = FromLocaleDup( psz_parse );
172                 if( psz_option )
173                     INSERT_ELEM( ppsz_options, i_options, i_options,
174                                  psz_option );
175             }
176         }
177         else if( !strncasecmp( psz_parse, "RTSPtext", sizeof("RTSPtext") -1 ) )
178         {
179             ;/* special case to handle QuickTime RTSPtext redirect files */
180         }
181         else if( *psz_parse )
182         {
183             char *psz_mrl;
184
185             psz_parse = FromLocale( psz_parse );
186             if( !psz_name && psz_parse )
187                 /* Use filename as name for relative entries */
188                 psz_name = strdup( psz_parse );
189
190             psz_mrl = ProcessMRL( psz_parse, p_demux->p_sys->psz_prefix );
191
192             b_cleanup = true;
193             if( !psz_mrl ) goto error;
194
195             p_input = input_item_NewExt( p_demux, psz_mrl, psz_name,
196                                         i_options, ppsz_options, 0, i_duration );
197
198             LocaleFree( psz_parse );
199             free( psz_mrl );
200
201             if ( psz_artist && *psz_artist )
202                 input_item_SetArtist( p_input, psz_artist );
203
204             input_item_AddSubItem( p_current_input, p_input );
205             vlc_gc_decref( p_input );
206         }
207
208  error:
209
210         /* Fetch another line */
211         free( psz_line );
212         psz_line = stream_ReadLine( p_demux->s );
213         if( !psz_line ) b_cleanup = true;
214
215         if( b_cleanup )
216         {
217             /* Cleanup state */
218             while( i_options-- ) free( (char*)ppsz_options[i_options] );
219             free( ppsz_options );
220             ppsz_options = NULL; i_options = 0;
221             free( psz_name );
222             psz_name = NULL;
223             free( psz_artist );
224             psz_artist = NULL;
225             i_parsed_duration = 0;
226             i_duration = -1;
227
228             b_cleanup = false;
229         }
230     }
231     vlc_gc_decref(p_current_input);
232     var_Destroy( p_demux, "m3u-extvlcopt" );
233     return 0; /* Needed for correct operation of go back */
234 }
235
236 static int Control( demux_t *p_demux, int i_query, va_list args )
237 {
238     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
239     return VLC_EGENERIC;
240 }
241
242 static void parseEXTINF(char *psz_string, char **ppsz_artist,
243                         char **ppsz_name, int *pi_duration)
244 {
245     char *end = NULL;
246     char *psz_item = NULL;
247
248     end = psz_string + strlen( psz_string );
249
250     /* ignore whitespaces */
251     for (; psz_string < end && ( *psz_string == '\t' || *psz_string == ' ' );
252          psz_string++ );
253
254     /* duration: read to next comma */
255     psz_item = psz_string;
256     psz_string = strchr( psz_string, ',' );
257     if ( psz_string )
258     {
259         *psz_string = '\0';
260         *pi_duration = atoi( psz_item );
261     }
262     else
263     {
264         return;
265     }
266
267     if ( psz_string < end )               /* continue parsing if possible */
268         psz_string++;
269
270     /* analyse the remaining string */
271     psz_item = strstr( psz_string, " - " );
272
273     /* here we have the 0.8.2+ format with artist */
274     if ( psz_item )
275     {
276         /* *** "EXTINF:time,artist - name" */
277         *psz_item = '\0';
278         *ppsz_artist = psz_string;
279         *ppsz_name = psz_item + 3;          /* points directly after ' - ' */
280         return;
281     }
282
283     /* reaching this point means: 0.8.1- with artist or something without artist */
284     if ( *psz_string == ',' )
285     {
286         /* *** "EXTINF:time,,name" */
287         psz_string++;
288         *ppsz_name = psz_string;
289         return;
290     }
291
292     psz_item = psz_string;
293     psz_string = strchr( psz_string, ',' );
294     if ( psz_string )
295     {
296         /* *** "EXTINF:time,artist,name" */
297         *psz_string = '\0';
298         *ppsz_artist = psz_item;
299         *ppsz_name = psz_string+1;
300     }
301     else
302     {
303         /* *** "EXTINF:time,name" */
304         *ppsz_name = psz_item;
305     }
306     return;
307 }
308