1 /*****************************************************************************
2 * ram.c : RAM playlist format import
3 *****************************************************************************
4 * Copyright (C) 2009 the VideoLAN team
7 * Authors: Srikanth Raju <srikiraju@gmail.com>
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.
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.
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 *****************************************************************************/
26 rtsp://helixserver.example.com/video1.rm?rpcontextheight=250
27 &rpcontextwidth=280&rpcontexturl="http://www.example.com/relatedinfo1.html"
28 rtsp://helixserver.example.com/video2.rm?rpurl="http://www.example.com/index.html"
29 rtsp://helixserver.example.com/sample1.smil?screensize=full
30 rtsp://helixserver.example.com/audio1.rm?start=55&end=1:25
31 rtsp://helixserver.example.com/introvid.rm?title="Introduction to Streaming Media
32 Production"&author="RealNetworks, Inc."©right="©2001, RealNetworks, Inc."
33 rtsp://helixserver.example.com/song1.rm?clipinfo="title=Artist of the Year|artist name=Your Name
34 Here|album name=My Debut|genre=Rock|copyright=2001|year=2001|comments=This one really
38 http://service.real.com/help/library/guides/realone/IntroGuide/HTML/htmfiles/ramsum.htm
39 http://service.real.com/help/library/guides/realone/IntroGuide/HTML/htmfiles/ramfile.htm
43 /*****************************************************************************
45 *****************************************************************************/
50 #include <vlc_common.h>
51 #include <vlc_demux.h>
61 /*****************************************************************************
63 *****************************************************************************/
64 static int Demux( demux_t *p_demux);
65 static int Control( demux_t *p_demux, int i_query, va_list args );
66 static void ParseClipInfo( const char * psz_clipinfo, char **ppsz_artist, char **ppsz_title,
67 char **ppsz_album, char **ppsz_genre, char **ppsz_year,
68 char **ppsz_cdnum, char **ppsz_comments );
71 * Import_RAM: main import function
72 * @param p_this: this demux object
73 * @return VLC_SUCCESS if everything is okay
75 int Import_RAM( vlc_object_t *p_this )
77 demux_t *p_demux = (demux_t *)p_this;
79 if(! demux_IsPathExtension( p_demux, ".ram" ) ||
80 demux_IsPathExtension( p_demux, ".rm" ) )
83 STANDARD_DEMUX_INIT_MSG( "found valid RAM playlist" );
84 p_demux->p_sys->psz_prefix = FindPrefix( p_demux );
90 * Frees up memory on module close
91 * @param p_this: this demux object
93 void Close_RAM( vlc_object_t *p_this )
95 demux_t *p_demux = (demux_t *)p_this;
96 free( p_demux->p_sys->psz_prefix );
97 free( p_demux->p_sys );
101 * Skips blanks in a given buffer
102 * @param s: input string
103 * @param i_strlen: length of the buffer
105 static const char *SkipBlanks( const char *s, size_t i_strlen )
107 while( i_strlen > 0 ) {
125 * Converts a time of format hour:minutes:sec.fraction to seconds
126 * @param s: input string
127 * @param i_strlen: length of the buffer
128 * @return time in seconds
130 static int ParseTime( const char *s, size_t i_strlen)
132 // need to parse hour:minutes:sec.fraction string
135 const char *end = s + i_strlen;
136 // skip leading spaces if any
137 s = SkipBlanks(s, i_strlen);
140 while( (s < end) && isdigit(*s) )
142 int newval = val*10 + (*s - '0');
153 s = SkipBlanks(s, end-s);
157 s = SkipBlanks(s, end-s);
158 result = result * 60;
160 while( (s < end) && isdigit(*s) )
162 int newval = val*10 + (*s - '0');
173 s = SkipBlanks(s, end-s);
177 s = SkipBlanks(s, end-s);
178 result = result * 60;
180 while( (s < end) && isdigit(*s) )
182 int newval = val*10 + (*s - '0');
193 // TODO: one day, we may need to parse fraction for sub-second resolution
200 * Main demux callback function
201 * @param p_demux: this demux object
203 static int Demux( demux_t *p_demux )
206 char *psz_artist = NULL, *psz_album = NULL, *psz_genre = NULL, *psz_year = NULL;
207 char *psz_author = NULL, *psz_title = NULL, *psz_copyright = NULL, *psz_cdnum = NULL, *psz_comments = NULL;
208 int i_parsed_duration = 0;
209 mtime_t i_duration = -1;
210 const char **ppsz_options = NULL;
211 int i_options = 0, i_start = 0, i_stop = 0;
212 bool b_cleanup = false;
213 input_item_t *p_input;
215 input_item_t *p_current_input = GetCurrentItem(p_demux);
217 input_item_node_t *p_subitems = input_item_node_Create( p_current_input );
219 psz_line = stream_ReadLine( p_demux->s );
222 char *psz_parse = psz_line;
224 /* Skip leading tabs and spaces */
225 while( *psz_parse == ' ' || *psz_parse == '\t' ||
226 *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
228 if( *psz_parse == '#' )
230 /* Ignore comments */
232 else if( *psz_parse )
234 char *psz_mrl, *psz_option_next, *psz_option;
235 char *psz_param, *psz_value;
237 /* Get the MRL from the file. Note that this might contain parameters of form ?param1=value1¶m2=value2 in a RAM file */
238 psz_mrl = ProcessMRL( psz_parse, p_demux->p_sys->psz_prefix );
241 if ( !psz_mrl ) goto error;
243 /* We have the MRL, now we have to check for options and parse them from MRL */
244 psz_option = strchr( psz_mrl, '?' ); /* Look for start of options */
247 /* Remove options from MRL
248 because VLC can't get the file otherwise */
251 psz_option_next = psz_option;
252 while( 1 ) /* Process each option */
254 /* Look for end of first option which maybe a & or \0 */
255 psz_option = psz_option_next;
256 psz_option_next = strchr( psz_option, '&' );
257 if( psz_option_next )
259 *psz_option_next = '\0';
263 psz_option_next = strchr( psz_option, '\0' );
264 /* Quit if options are over */
265 if( psz_option_next == psz_option )
268 /* Parse out param and value */
269 psz_param = psz_option;
270 psz_value = strchr( psz_option, '=' );
271 if( psz_value == NULL )
276 /* Take action based on parameter value in the below if else structure */
277 /* TODO: Remove any quotes surrounding values if required */
278 if( !strcmp( psz_param, "clipinfo" ) )
280 ParseClipInfo( psz_value, &psz_artist, &psz_title,
281 &psz_album, &psz_genre, &psz_year,
282 &psz_cdnum, &psz_comments ); /* clipinfo has various sub parameters, which is parsed by this function */
284 else if( !strcmp( psz_param, "author" ) )
285 psz_author = decode_URI_duplicate(psz_value);
286 else if( !strcmp( psz_param, "start" ) )
288 i_start = ParseTime( psz_value, strlen( psz_value ) );
292 if( asprintf( &temp, ":start-time=%d", i_start ) != -1 )
293 INSERT_ELEM( ppsz_options, i_options, i_options, temp );
296 else if( !strcmp( psz_param, "end" ) )
298 i_stop = ParseTime( psz_value, strlen( psz_value ) );
302 if( asprintf( &temp, ":stop-time=%d", i_stop ) != -1 )
303 INSERT_ELEM( ppsz_options, i_options, i_options, temp );
306 else if( !strcmp( psz_param, "title" ) )
307 psz_title = decode_URI_duplicate(psz_value);
308 else if( !strcmp( psz_param, "copyright" ) )
309 psz_copyright = decode_URI_duplicate(psz_value);
311 { /* TODO: insert option anyway? Currently ignores*/
312 /* INSERT_ELEM( ppsz_options, i_options, i_options, psz_option ); */
317 /* Create the input item and pump in all the options into playlist item */
318 p_input = input_item_NewExt( p_demux, psz_mrl, psz_title, i_options, ppsz_options, 0, i_duration );
320 if( !EMPTY_STR( psz_artist ) ) input_item_SetArtist( p_input, psz_artist );
321 if( !EMPTY_STR( psz_author ) ) input_item_SetPublisher( p_input, psz_author );
322 if( !EMPTY_STR( psz_title ) ) input_item_SetTitle( p_input, psz_title );
323 if( !EMPTY_STR( psz_copyright ) ) input_item_SetCopyright( p_input, psz_copyright );
324 if( !EMPTY_STR( psz_album ) ) input_item_SetAlbum( p_input, psz_album );
325 if( !EMPTY_STR( psz_genre ) ) input_item_SetGenre( p_input, psz_genre );
326 if( !EMPTY_STR( psz_year ) ) input_item_SetDate( p_input, psz_copyright );
327 if( !EMPTY_STR( psz_cdnum ) ) input_item_SetTrackNum( p_input, psz_cdnum );
328 if( !EMPTY_STR( psz_comments ) ) input_item_SetDescription( p_input, psz_comments );
330 input_item_node_AppendItem( p_subitems, p_input );
331 vlc_gc_decref( p_input );
336 /* Fetch another line */
338 psz_line = stream_ReadLine( p_demux->s );
339 if( !psz_line ) b_cleanup = true;
344 while( i_options-- ) free( (char*)ppsz_options[i_options] );
345 FREENULL( ppsz_options );
346 FREENULL( psz_artist );
347 FREENULL( psz_title );
348 FREENULL( psz_author );
349 FREENULL( psz_copyright );
350 FREENULL( psz_album );
351 FREENULL( psz_genre );
352 FREENULL( psz_year );
353 FREENULL( psz_cdnum );
354 FREENULL( psz_comments );
356 i_parsed_duration = 0;
363 input_item_node_PostAndDelete( p_subitems );
364 vlc_gc_decref(p_current_input);
365 var_Destroy( p_demux, "m3u-extvlcopt" );
366 return 0; /* Needed for correct operation of go back */
370 * @param p_demux: This object
372 * @param args: List of arguments
374 static int Control( demux_t *p_demux, int i_query, va_list args )
376 VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
381 * Parses clipinfo parameter
382 * @param psz_clipinfo: string containing the clipinfo parameter along with quotes
383 * @param ppsz_artist: Buffer to store artist name
384 * @param ppsz_title: Buffer to store title
385 * @param ppsz_album: Buffer to store album
386 * @param ppsz_genre: Buffer to store genre
387 * @param ppsz_year: Buffer to store year
388 * @param ppsz_cdnum: Buffer to store cdnum
389 * @param ppsz_comments: Buffer to store comments
391 static void ParseClipInfo( const char *psz_clipinfo, char **ppsz_artist, char **ppsz_title,
392 char **ppsz_album, char **ppsz_genre, char **ppsz_year,
393 char **ppsz_cdnum, char **ppsz_comments )
395 char *psz_option_next, *psz_option_start, *psz_param, *psz_value, *psz_suboption;
396 char *psz_temp_clipinfo = strdup( psz_clipinfo );
397 psz_option_start = strchr( psz_temp_clipinfo, '"' );
398 if( !psz_option_start )
400 free( psz_temp_clipinfo );
405 psz_option_next = psz_option_start;
406 while( 1 ) /* Process each sub option */
408 /* Get the sub option */
409 psz_option_start = psz_option_next;
410 psz_option_next = strchr( psz_option_start, '|' );
411 if( psz_option_next )
412 *psz_option_next = '\0';
414 psz_option_next = strchr( psz_option_start, '"' );
415 if( psz_option_next )
416 *psz_option_next = '\0';
418 psz_option_next = strchr( psz_option_start, '\0' );
419 if( psz_option_next == psz_option_start )
422 psz_suboption = strdup( psz_option_start );
426 /* Parse out param and value */
427 psz_param = psz_suboption;
428 if( strchr( psz_suboption, '=' ) )
430 psz_value = strchr( psz_suboption, '=' ) + 1;
431 *( strchr( psz_suboption, '=' ) ) = '\0';
436 if( !strcmp( psz_param, "artist name" ) )
437 *ppsz_artist = decode_URI_duplicate( psz_value );
438 else if( !strcmp( psz_param, "title" ) )
439 *ppsz_title = decode_URI_duplicate( psz_value );
440 else if( !strcmp( psz_param, "album name" ) )
441 *ppsz_album = decode_URI_duplicate( psz_value );
442 else if( !strcmp( psz_param, "genre" ) )
443 *ppsz_genre = decode_URI_duplicate( psz_value );
444 else if( !strcmp( psz_param, "year" ) )
445 *ppsz_year = decode_URI_duplicate( psz_value );
446 else if( !strcmp( psz_param, "cdnum" ) )
447 *ppsz_cdnum = decode_URI_duplicate( psz_value );
448 else if( !strcmp( psz_param, "comments" ) )
449 *ppsz_comments = decode_URI_duplicate( psz_value );
451 free( psz_suboption );
455 free( psz_temp_clipinfo );