git.sesse.net Git - vlc/blob - 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/vlc.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
  51 /*****************************************************************************
  52  * Import_M3U: main import function
  53  *****************************************************************************/
  54 int E_(Import_M3U)( vlc_object_t *p_this )
  55 {
  56     demux_t *p_demux = (demux_t *)p_this;
  57     const uint8_t *p_peek;
  58     CHECK_PEEK( p_peek, 8 );
  59
  60     if(! ( POKE( p_peek, "#EXTM3U", 7 ) || POKE( p_peek, "RTSPtext", 8 ) ||
  61            demux2_IsPathExtension( p_demux, ".m3u" ) || demux2_IsPathExtension( p_demux, ".vlc" ) ||
  62            /* A .ram file can contain a single rtsp link */
  63            demux2_IsPathExtension( p_demux, ".ram" ) || demux2_IsPathExtension( p_demux, ".rm" ) ||
  64            demux2_IsForced( p_demux,  "m3u" ) ) )
  65         return VLC_EGENERIC;
  66
  67     STANDARD_DEMUX_INIT_MSG( "found valid M3U playlist" );
  68     p_demux->p_sys->psz_prefix = E_(FindPrefix)( p_demux );
  69
  70     return VLC_SUCCESS;
  71 }
  72
  73 /*****************************************************************************
  74  * Deactivate: frees unused data
  75  *****************************************************************************/
  76 void E_(Close_M3U)( vlc_object_t *p_this )
  77 {
  78     demux_t *p_demux = (demux_t *)p_this;
  79     free( p_demux->p_sys->psz_prefix );
  80     free( p_demux->p_sys );
  81 }
  82
  83
  84 /* Gruik! */
  85 static inline char *MaybeFromLocaleDup (const char *str)
  86 {
  87     if (str == NULL)
  88         return NULL;
  89
  90     return IsUTF8 (str) ? strdup (str) : FromLocaleDup (str);
  91 }
  92
  93
  94 static inline void MaybeFromLocaleRep (char **str)
  95 {
  96     char *const orig_str = *str;
  97
  98     if ((orig_str != NULL) && !IsUTF8 (orig_str))
  99     {
 100         *str = FromLocaleDup (orig_str);
 101         free (orig_str);
 102     }
 103 }
 104
 105
 106 static int Demux( demux_t *p_demux )
 107 {
 108     char       *psz_line;
 109     char       *psz_name = NULL;
 110     char       *psz_artist = NULL;
 111     int        i_parsed_duration = 0;
 112     mtime_t    i_duration = -1;
 113     const char**ppsz_options = NULL;
 114     int        i_options = 0;
 115     vlc_bool_t b_cleanup = VLC_FALSE;
 116     vlc_bool_t b_enable_extvlcopt = var_CreateGetInteger( p_demux,
 117                                                           "m3u-extvlcopt" );
 118     input_item_t *p_input;
 119
 120     INIT_PLAYLIST_STUFF;
 121
 122     psz_line = stream_ReadLine( p_demux->s );
 123     while( psz_line )
 124     {
 125         char *psz_parse = psz_line;
 126
 127         /* Skip leading tabs and spaces */
 128         while( *psz_parse == ' ' || *psz_parse == '\t' ||
 129                *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
 130
 131         if( *psz_parse == '#' )
 132         {
 133             /* Parse extra info */
 134
 135             /* Skip leading tabs and spaces */
 136             while( *psz_parse == ' ' || *psz_parse == '\t' ||
 137                    *psz_parse == '\n' || *psz_parse == '\r' ||
 138                    *psz_parse == '#' ) psz_parse++;
 139
 140             if( !*psz_parse ) goto error;
 141
 142             if( !strncasecmp( psz_parse, "EXTINF:", sizeof("EXTINF:") -1 ) )
 143             {
 144                 /* Extended info */
 145                 psz_parse += sizeof("EXTINF:") - 1;
 146                 parseEXTINF( psz_parse, &psz_artist, &psz_name, &i_parsed_duration );
 147                 if( i_parsed_duration >= 0 )
 148                     i_duration = i_parsed_duration * I64C(1000000);
 149                 if( psz_name )
 150                     psz_name = strdup( psz_name );
 151                 if( psz_artist )
 152                     psz_artist = strdup( psz_artist );
 153             }
 154             else if( !strncasecmp( psz_parse, "EXTVLCOPT:",
 155                                    sizeof("EXTVLCOPT:") -1 ) )
 156             {
 157                 if( b_enable_extvlcopt )
 158                 {
 159                     /* VLC Option */
 160                     char *psz_option;
 161                     psz_parse += sizeof("EXTVLCOPT:") -1;
 162                     if( !*psz_parse ) goto error;
 163
 164                     psz_option = MaybeFromLocaleDup( psz_parse );
 165                     if( psz_option )
 166                         INSERT_ELEM( ppsz_options, i_options, i_options,
 167                                      psz_option );
 168                 }
 169                 else
 170                 {
 171                     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." );
 172                 }
 173             }
 174         }
 175         else if( !strncasecmp( psz_parse, "RTSPtext", sizeof("RTSPtext") -1 ) )
 176         {
 177             ;/* special case to handle QuickTime RTSPtext redirect files */
 178         }
 179         else if( *psz_parse )
 180         {
 181             char *psz_mrl;
 182             if( !psz_name || !*psz_name )
 183             {
 184                 /* Use filename as name for relative entries */
 185                 psz_name = MaybeFromLocaleDup( psz_parse );
 186             }
 187
 188             psz_mrl = E_(ProcessMRL)( psz_parse, p_demux->p_sys->psz_prefix );
 189             MaybeFromLocaleRep( &psz_mrl );
 190
 191             b_cleanup = VLC_TRUE;
 192             if( !psz_mrl ) goto error;
 193
 194             p_input = input_ItemNewExt( p_playlist, psz_mrl, psz_name,
 195                                         i_options, ppsz_options, i_duration );
 196             if ( psz_artist && *psz_artist )
 197                 input_ItemAddInfo( p_input, _(VLC_META_INFO_CAT),
 198                                    _(VLC_META_ARTIST), "%s", psz_artist );
 199             input_ItemAddSubItem( p_current_input, p_input );
 200             vlc_gc_decref( p_input );
 201             free( psz_mrl );
 202         }
 203
 204  error:
 205
 206         /* Fetch another line */
 207         free( psz_line );
 208         psz_line = stream_ReadLine( p_demux->s );
 209         if( !psz_line ) b_cleanup = VLC_TRUE;
 210
 211         if( b_cleanup )
 212         {
 213             /* Cleanup state */
 214             while( i_options-- ) free( (char*)ppsz_options[i_options] );
 215             if( ppsz_options ) free( ppsz_options );
 216             ppsz_options = NULL; i_options = 0;
 217             if( psz_name ) free( psz_name );
 218             psz_name = NULL;
 219             if ( psz_artist ) free( psz_artist );
 220             psz_artist = NULL;
 221             i_parsed_duration = 0;
 222             i_duration = -1;
 223
 224             b_cleanup = VLC_FALSE;
 225         }
 226     }
 227     HANDLE_PLAY_AND_RELEASE;
 228     var_Destroy( p_demux, "m3u-extvlcopt" );
 229     return 0; /* Needed for correct operation of go back */
 230 }
 231
 232 static int Control( demux_t *p_demux, int i_query, va_list args )
 233 {
 234     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
 235     return VLC_EGENERIC;
 236 }
 237
 238 static void parseEXTINF(char *psz_string, char **ppsz_artist,
 239                         char **ppsz_name, int *pi_duration)
 240 {
 241     char *end = NULL;
 242     char *psz_item = NULL;
 243
 244     end = psz_string + strlen( psz_string );
 245
 246     /* ignore whitespaces */
 247     for (; psz_string < end && ( *psz_string == '\t' || *psz_string == ' ' );
 248          psz_string++ );
 249
 250     /* duration: read to next comma */
 251     psz_item = psz_string;
 252     psz_string = strchr( psz_string, ',' );
 253     if ( psz_string )
 254     {
 255         *psz_string = '\0';
 256         *pi_duration = atoi( psz_item );
 257     }
 258     else
 259     {
 260         return;
 261     }
 262
 263     if ( psz_string < end )               /* continue parsing if possible */
 264         psz_string++;
 265
 266     /* analyse the remaining string */
 267     psz_item = strstr( psz_string, " - " );
 268
 269     /* here we have the 0.8.2+ format with artist */
 270     if ( psz_item )
 271     {
 272         /* *** "EXTINF:time,artist - name" */
 273         *psz_item = '\0';
 274         *ppsz_artist = psz_string;
 275         *ppsz_name = psz_item + 3;          /* points directly after ' - ' */
 276         return;
 277     }
 278
 279     /* reaching this point means: 0.8.1- with artist or something without artist */
 280     if ( *psz_string == ',' )
 281     {
 282         /* *** "EXTINF:time,,name" */
 283         psz_string++;
 284         *ppsz_name = psz_string;
 285         return;
 286     }
 287
 288     psz_item = psz_string;
 289     psz_string = strchr( psz_string, ',' );
 290     if ( psz_string )
 291     {
 292         /* *** "EXTINF:time,artist,name" */
 293         *psz_string = '\0';
 294         *ppsz_artist = psz_item;
 295         *ppsz_name = psz_string+1;
 296     }
 297     else
 298     {
 299         /* *** "EXTINF:time,name" */
 300         *ppsz_name = psz_item;
 301     }
 302     return;
 303 }
 304