Removed useless width/height fields in subpicture_t.
[vlc.git] / modules / video_filter / rss.c
1 /*****************************************************************************
2  * rss.c : rss/atom feed display video plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2003-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Atom : http://www.ietf.org/rfc/rfc4287.txt
26  * RSS : http://www.rssboard.org/rss-specification
27  *****************************************************************************/
28
29 /*****************************************************************************
30  * Preamble
31  *****************************************************************************/
32
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
36
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include <vlc_vout.h>
40
41 #include "vlc_filter.h"
42 #include "vlc_block.h"
43 #include "vlc_osd.h"
44
45 #include "vlc_block.h"
46 #include "vlc_stream.h"
47 #include "vlc_xml.h"
48 #include <vlc_charset.h>
49
50 #include "vlc_image.h"
51
52 #include <time.h>
53
54 /*****************************************************************************
55  * Local prototypes
56  *****************************************************************************/
57 static int  CreateFilter ( vlc_object_t * );
58 static void DestroyFilter( vlc_object_t * );
59 static subpicture_t *Filter( filter_t *, mtime_t );
60
61 static int FetchRSS( filter_t * );
62 static void FreeRSS( filter_t * );
63
64 static const int pi_color_values[] = {
65                0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
66                0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
67                0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
68                0x00000080, 0x000000FF, 0x0000FFFF};
69 static const char *const ppsz_color_descriptions[] = {
70                N_("Default"), N_("Black"),
71                N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
72                N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
73                N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
74                N_("Aqua") };
75
76 /*****************************************************************************
77  * filter_sys_t: rss filter descriptor
78  *****************************************************************************/
79
80 struct rss_item_t
81 {
82     char *psz_title;
83     char *psz_description;
84     char *psz_link;
85 };
86
87 struct rss_feed_t
88 {
89     char *psz_title;
90     char *psz_description;
91     char *psz_link;
92     char *psz_image;
93     picture_t *p_pic;
94
95     int i_items;
96     struct rss_item_t *p_items;
97 };
98
99 struct filter_sys_t
100 {
101     vlc_mutex_t lock;
102     vlc_mutex_t *p_lock;
103
104     int i_xoff, i_yoff;  /* offsets for the display string in the video window */
105     int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
106     int i_speed;
107     int i_length;
108
109     char *psz_marquee;    /* marquee string */
110
111     text_style_t *p_style; /* font control */
112
113     mtime_t last_date;
114
115     char *psz_urls;
116     int i_feeds;
117     struct rss_feed_t *p_feeds;
118
119     int i_ttl;
120     time_t t_last_update;
121     bool b_images;
122     int i_title;
123
124     int i_cur_feed;
125     int i_cur_item;
126     int i_cur_char;
127 };
128
129 #define MSG_TEXT N_("Feed URLs")
130 #define MSG_LONGTEXT N_("RSS/Atom feed '|' (pipe) seperated URLs.")
131 #define SPEED_TEXT N_("Speed of feeds")
132 #define SPEED_LONGTEXT N_("Speed of the RSS/Atom feeds in microseconds (bigger is slower).")
133 #define LENGTH_TEXT N_("Max length")
134 #define LENGTH_LONGTEXT N_("Maximum number of characters displayed on the " \
135                 "screen." )
136 #define TTL_TEXT N_("Refresh time")
137 #define TTL_LONGTEXT N_("Number of seconds between each forced refresh " \
138         "of the feeds. 0 means that the feeds are never updated." )
139 #define IMAGE_TEXT N_("Feed images")
140 #define IMAGE_LONGTEXT N_("Display feed images if available.")
141
142 #define POSX_TEXT N_("X offset")
143 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
144 #define POSY_TEXT N_("Y offset")
145 #define POSY_LONGTEXT N_("Y offset, down from the top." )
146 #define OPACITY_TEXT N_("Opacity")
147 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
148     "overlay text. 0 = transparent, 255 = totally opaque." )
149
150 #define SIZE_TEXT N_("Font size, pixels")
151 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
152     "font size)." )
153
154 #define COLOR_TEXT N_("Color")
155 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
156     "the video. This must be an hexadecimal (like HTML colors). The first two "\
157     "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
158     " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
159
160 #define POS_TEXT N_("Text position")
161 #define POS_LONGTEXT N_( \
162   "You can enforce the text position on the video " \
163   "(0=center, 1=left, 2=right, 4=top, 8=bottom; you can " \
164   "also use combinations of these values, eg 6 = top-right).")
165
166 #define TITLE_TEXT N_("Title display mode")
167 #define TITLE_LONGTEXT N_("Title display mode. Default is 0 (hidden) if the feed has an image and feed images are enabled, 1 otherwise.")
168
169 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
170 static const char *const ppsz_pos_descriptions[] =
171      { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
172      N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
173
174 enum title_modes {
175     default_title=-1,
176     hide_title,
177     prepend_title,
178     scroll_title };
179
180 static const int pi_title_modes[] = { default_title, hide_title, prepend_title, scroll_title };
181 static const char *const ppsz_title_modes[] =
182     { N_("Default"), N_("Don't show"), N_("Always visible"), N_("Scroll with feed") };
183
184 #define CFG_PREFIX "rss-"
185
186 /*****************************************************************************
187  * Module descriptor
188  *****************************************************************************/
189 vlc_module_begin();
190     set_capability( "sub filter", 1 );
191     set_shortname( "RSS / Atom" );
192     set_callbacks( CreateFilter, DestroyFilter );
193     set_category( CAT_VIDEO );
194     set_subcategory( SUBCAT_VIDEO_SUBPIC );
195     add_string( CFG_PREFIX "urls", "rss", NULL, MSG_TEXT, MSG_LONGTEXT, false );
196
197     set_section( N_("Position"), NULL );
198     add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true );
199     add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true );
200     add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false );
201         change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL );
202
203     set_section( N_("Font"), NULL );
204     /* 5 sets the default to top [1] left [4] */
205     add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
206         OPACITY_TEXT, OPACITY_LONGTEXT, false );
207     add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
208                   false );
209         change_integer_list( pi_color_values, ppsz_color_descriptions, NULL );
210     add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, false );
211
212     set_section( N_("Misc"), NULL );
213     add_integer( CFG_PREFIX "speed", 100000, NULL, SPEED_TEXT, SPEED_LONGTEXT,
214                  false );
215     add_integer( CFG_PREFIX "length", 60, NULL, LENGTH_TEXT, LENGTH_LONGTEXT,
216                  false );
217     add_integer( CFG_PREFIX "ttl", 1800, NULL, TTL_TEXT, TTL_LONGTEXT, false );
218     add_bool( CFG_PREFIX "images", 1, NULL, IMAGE_TEXT, IMAGE_LONGTEXT, false );
219     add_integer( CFG_PREFIX "title", default_title, NULL, TITLE_TEXT, TITLE_LONGTEXT, false );
220         change_integer_list( pi_title_modes, ppsz_title_modes, NULL );
221
222     set_description( N_("RSS and Atom feed display") );
223     add_shortcut( "rss" );
224     add_shortcut( "atom" );
225 vlc_module_end();
226
227 static const char *const ppsz_filter_options[] = {
228     "urls", "x", "y", "position", "color", "size", "speed", "length",
229     "ttl", "images", "title", NULL
230 };
231
232 /*****************************************************************************
233  * CreateFilter: allocates RSS video filter
234  *****************************************************************************/
235 static int CreateFilter( vlc_object_t *p_this )
236 {
237     filter_t *p_filter = (filter_t *)p_this;
238     filter_sys_t *p_sys;
239     int i_feed;
240
241     /* Allocate structure */
242     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
243     if( p_sys == NULL )
244         return VLC_ENOMEM;
245
246     vlc_mutex_init( &p_sys->lock );
247     vlc_mutex_lock( &p_sys->lock );
248
249     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
250                        p_filter->p_cfg );
251
252     p_sys->psz_urls = var_CreateGetString( p_filter, CFG_PREFIX "urls" );
253     p_sys->i_title = var_CreateGetInteger( p_filter, CFG_PREFIX "title" );
254     p_sys->i_cur_feed = 0;
255     p_sys->i_cur_item = p_sys->i_title == scroll_title ? -1 : 0;
256     p_sys->i_cur_char = 0;
257     p_sys->i_feeds = 0;
258     p_sys->p_feeds = NULL;
259     p_sys->i_speed = var_CreateGetInteger( p_filter, CFG_PREFIX "speed" );
260     p_sys->i_length = var_CreateGetInteger( p_filter, CFG_PREFIX "length" );
261     p_sys->i_ttl = __MAX( 0, var_CreateGetInteger( p_filter, CFG_PREFIX "ttl" ) );
262     p_sys->b_images = var_CreateGetBool( p_filter, CFG_PREFIX "images" );
263
264     p_sys->psz_marquee = (char *)malloc( p_sys->i_length + 1 );
265     if( p_sys->psz_marquee == NULL )
266     {
267         vlc_mutex_unlock( &p_sys->lock );
268         vlc_mutex_destroy( &p_sys->lock );
269         free( p_sys->psz_urls );
270         free( p_sys );
271         return VLC_ENOMEM;
272     }
273     p_sys->psz_marquee[p_sys->i_length] = '\0';
274
275     p_sys->p_style = malloc( sizeof( text_style_t ));
276     if( p_sys->p_style == NULL )
277     {
278         free( p_sys->psz_marquee );
279         vlc_mutex_unlock( &p_sys->lock );
280         vlc_mutex_destroy( &p_sys->lock );
281         free( p_sys->psz_urls );
282         free( p_sys );
283         return VLC_ENOMEM;
284     }
285     memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ));
286
287     p_sys->i_xoff = var_CreateGetInteger( p_filter, CFG_PREFIX "x" );
288     p_sys->i_yoff = var_CreateGetInteger( p_filter, CFG_PREFIX "y" );
289     p_sys->i_pos = var_CreateGetInteger( p_filter, CFG_PREFIX "position" );
290     p_sys->p_style->i_font_alpha = 255 - var_CreateGetInteger( p_filter, CFG_PREFIX "opacity" );
291     p_sys->p_style->i_font_color = var_CreateGetInteger( p_filter, CFG_PREFIX "color" );
292     p_sys->p_style->i_font_size = var_CreateGetInteger( p_filter, CFG_PREFIX "size" );
293
294     if( p_sys->b_images == true && p_sys->p_style->i_font_size == -1 )
295     {
296         msg_Warn( p_filter, "rss-size wasn't specified. Feed images will thus be displayed without being resized" );
297     }
298
299     if( FetchRSS( p_filter ) )
300     {
301         msg_Err( p_filter, "failed while fetching RSS ... too bad" );
302         free( p_sys->p_style );
303         free( p_sys->psz_marquee );
304         vlc_mutex_unlock( &p_sys->lock );
305         vlc_mutex_destroy( &p_sys->lock );
306         free( p_sys->psz_urls );
307         free( p_sys );
308         return VLC_EGENERIC;
309     }
310     p_sys->t_last_update = time( NULL );
311
312     if( p_sys->i_feeds == 0 )
313     {
314         free( p_sys->p_style );
315         free( p_sys->psz_marquee );
316         vlc_mutex_unlock( &p_sys->lock );
317         vlc_mutex_destroy( &p_sys->lock );
318         free( p_sys->psz_urls );
319         free( p_sys );
320         return VLC_EGENERIC;
321     }
322     for( i_feed=0; i_feed < p_sys->i_feeds; i_feed ++ )
323     {
324         if( p_sys->p_feeds[i_feed].i_items == 0 )
325         {
326             free( p_sys->p_style );
327             free( p_sys->psz_marquee );
328             FreeRSS( p_filter );
329             vlc_mutex_unlock( &p_sys->lock );
330             vlc_mutex_destroy( &p_sys->lock );
331             free( p_sys->psz_urls );
332             free( p_sys );
333             return VLC_EGENERIC;
334         }
335     }
336     /* Misc init */
337     p_filter->pf_sub_filter = Filter;
338     p_sys->last_date = (mtime_t)0;
339
340     vlc_mutex_unlock( &p_sys->lock );
341
342     return VLC_SUCCESS;
343 }
344 /*****************************************************************************
345  * DestroyFilter: destroy RSS video filter
346  *****************************************************************************/
347 static void DestroyFilter( vlc_object_t *p_this )
348 {
349     filter_t *p_filter = (filter_t *)p_this;
350     filter_sys_t *p_sys = p_filter->p_sys;
351
352     vlc_mutex_lock( &p_sys->lock );
353
354     free( p_sys->p_style );
355     free( p_sys->psz_marquee );
356     free( p_sys->psz_urls );
357     FreeRSS( p_filter );
358     vlc_mutex_unlock( &p_sys->lock );
359     vlc_mutex_destroy( &p_sys->lock );
360     free( p_sys );
361
362     /* Delete the RSS variables */
363     var_Destroy( p_filter, CFG_PREFIX "urls" );
364     var_Destroy( p_filter, CFG_PREFIX "speed" );
365     var_Destroy( p_filter, CFG_PREFIX "length" );
366     var_Destroy( p_filter, CFG_PREFIX "ttl" );
367     var_Destroy( p_filter, CFG_PREFIX "images" );
368     var_Destroy( p_filter, CFG_PREFIX "x" );
369     var_Destroy( p_filter, CFG_PREFIX "y" );
370     var_Destroy( p_filter, CFG_PREFIX "position" );
371     var_Destroy( p_filter, CFG_PREFIX "color");
372     var_Destroy( p_filter, CFG_PREFIX "opacity");
373     var_Destroy( p_filter, CFG_PREFIX "size");
374     var_Destroy( p_filter, CFG_PREFIX "title" );
375 }
376
377 /****************************************************************************
378  * Filter: the whole thing
379  ****************************************************************************
380  * This function outputs subpictures at regular time intervals.
381  ****************************************************************************/
382 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
383 {
384     filter_sys_t *p_sys = p_filter->p_sys;
385     subpicture_t *p_spu;
386     video_format_t fmt;
387     subpicture_region_t *p_region;
388
389     int i_feed, i_item;
390
391     struct rss_feed_t *p_feed;
392
393     memset( &fmt, 0, sizeof(video_format_t) );
394
395     vlc_mutex_lock( &p_sys->lock );
396
397     if( p_sys->last_date
398        + ( p_sys->i_cur_char == 0 && p_sys->i_cur_item == ( p_sys->i_title == scroll_title ? -1 : 0 ) ? 5 : 1 )
399            /* ( ... ? 5 : 1 ) means "wait 5 times more for the 1st char" */
400        * p_sys->i_speed > date )
401     {
402         vlc_mutex_unlock( &p_sys->lock );
403         return NULL;
404     }
405
406     /* Do we need to update the feeds ? */
407     if( p_sys->i_ttl
408         && time( NULL ) > p_sys->t_last_update + (time_t)p_sys->i_ttl )
409     {
410         msg_Dbg( p_filter, "Forcing update of all the RSS feeds" );
411         if( FetchRSS( p_filter ) )
412         {
413             msg_Err( p_filter, "Failed while fetching RSS ... too bad" );
414             vlc_mutex_unlock( &p_sys->lock );
415             return NULL; /* FIXME : we most likely messed up all the data,
416                           * so we might need to do something about it */
417         }
418         p_sys->t_last_update = time( NULL );
419     }
420
421     p_sys->last_date = date;
422     p_sys->i_cur_char++;
423     if( p_sys->i_cur_item == -1 ? p_sys->p_feeds[p_sys->i_cur_feed].psz_title[p_sys->i_cur_char] == 0 : p_sys->p_feeds[p_sys->i_cur_feed].p_items[p_sys->i_cur_item].psz_title[p_sys->i_cur_char] == 0 )
424     {
425         p_sys->i_cur_char = 0;
426         p_sys->i_cur_item++;
427         if( p_sys->i_cur_item >= p_sys->p_feeds[p_sys->i_cur_feed].i_items )
428         {
429             if( p_sys->i_title == scroll_title )
430                 p_sys->i_cur_item = -1;
431             else
432                 p_sys->i_cur_item = 0;
433             p_sys->i_cur_feed = (p_sys->i_cur_feed + 1)%p_sys->i_feeds;
434         }
435     }
436
437     p_spu = filter_NewSubpicture( p_filter );
438     if( !p_spu )
439     {
440         vlc_mutex_unlock( &p_sys->lock );
441         return NULL;
442     }
443
444     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
445
446     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
447     if( !p_spu->p_region )
448     {
449         p_filter->pf_sub_buffer_del( p_filter, p_spu );
450         vlc_mutex_unlock( &p_sys->lock );
451         return NULL;
452     }
453
454     /* Generate the string that will be displayed. This string is supposed to
455        be p_sys->i_length characters long. */
456     i_item = p_sys->i_cur_item;
457     i_feed = p_sys->i_cur_feed;
458     p_feed = &p_sys->p_feeds[i_feed];
459
460     if( ( p_feed->p_pic && p_sys->i_title == default_title )
461         || p_sys->i_title == hide_title )
462     {
463         /* Don't display the feed's title if we have an image */
464         snprintf( p_sys->psz_marquee, p_sys->i_length, "%s",
465                   p_sys->p_feeds[i_feed].p_items[i_item].psz_title
466                   +p_sys->i_cur_char );
467     }
468     else if( ( !p_feed->p_pic && p_sys->i_title == default_title )
469              || p_sys->i_title == prepend_title )
470     {
471         snprintf( p_sys->psz_marquee, p_sys->i_length, "%s : %s",
472                   p_sys->p_feeds[i_feed].psz_title,
473                   p_sys->p_feeds[i_feed].p_items[i_item].psz_title
474                   +p_sys->i_cur_char );
475     }
476     else /* scrolling title */
477     {
478         if( i_item == -1 )
479             snprintf( p_sys->psz_marquee, p_sys->i_length, "%s : %s",
480                       p_sys->p_feeds[i_feed].psz_title + p_sys->i_cur_char,
481                       p_sys->p_feeds[i_feed].p_items[i_item+1].psz_title );
482         else
483             snprintf( p_sys->psz_marquee, p_sys->i_length, "%s",
484                       p_sys->p_feeds[i_feed].p_items[i_item].psz_title
485                       +p_sys->i_cur_char );
486     }
487
488     while( strlen( p_sys->psz_marquee ) < (unsigned int)p_sys->i_length )
489     {
490         i_item++;
491         if( i_item == p_sys->p_feeds[i_feed].i_items ) break;
492         snprintf( strchr( p_sys->psz_marquee, 0 ),
493                   p_sys->i_length - strlen( p_sys->psz_marquee ),
494                   " - %s",
495                   p_sys->p_feeds[i_feed].p_items[i_item].psz_title );
496     }
497
498     /* Calls to snprintf might split multibyte UTF8 chars ...
499      * which freetype doesn't like. */
500     {
501         char *a = strdup( p_sys->psz_marquee );
502         char *a2 = a;
503         char *b = p_sys->psz_marquee;
504         EnsureUTF8( p_sys->psz_marquee );
505         /* we want to use ' ' instead of '?' for erroneous chars */
506         while( *b != '\0' )
507         {
508             if( *b != *a ) *b = ' ';
509             b++;a++;
510         }
511         free( a2 );
512     }
513
514     p_spu->p_region->psz_text = strdup(p_sys->psz_marquee);
515     if( p_sys->p_style->i_font_size > 0 )
516         p_spu->p_region->fmt.i_visible_height = p_sys->p_style->i_font_size;
517     p_spu->i_start = date;
518     p_spu->i_stop  = 0;
519     p_spu->b_ephemer = true;
520
521     /*  where to locate the string: */
522     if( p_sys->i_pos < 0 )
523     {   /*  set to an absolute xy */
524         p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
525         p_spu->b_absolute = true;
526     }
527     else
528     {   /* set to one of the 9 relative locations */
529         p_spu->p_region->i_align = p_sys->i_pos;
530         p_spu->b_absolute = false;
531     }
532
533     p_spu->i_x = p_sys->i_xoff;
534     p_spu->i_y = p_sys->i_yoff;
535
536     p_spu->p_region->p_style = p_sys->p_style;
537
538     if( p_feed->p_pic )
539     {
540         /* Display the feed's image */
541         picture_t *p_pic = p_feed->p_pic;
542         video_format_t fmt_out;
543
544         memset( &fmt_out, 0, sizeof(video_format_t) );
545
546         fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
547         fmt_out.i_aspect = VOUT_ASPECT_FACTOR;
548         fmt_out.i_sar_num = fmt_out.i_sar_den = 1;
549         fmt_out.i_width =
550             fmt_out.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
551         fmt_out.i_height =
552             fmt_out.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
553
554         p_region = p_spu->pf_create_region( VLC_OBJECT( p_filter ), &fmt_out );
555         if( !p_region )
556         {
557             msg_Err( p_filter, "cannot allocate SPU region" );
558         }
559         else
560         {
561             vout_CopyPicture( p_filter, &p_region->picture, p_pic );
562             p_spu->p_region->p_next = p_region;
563         }
564
565         /* Offset text to display right next to the image */
566         p_spu->p_region->i_x = p_pic->p[Y_PLANE].i_visible_pitch;
567     }
568
569     vlc_mutex_unlock( &p_sys->lock );
570     return p_spu;
571 }
572
573 /****************************************************************************
574  * RSS related functions
575  ****************************************************************************
576  * You should always lock the p_filter mutex before using any of these
577  * functions
578  ***************************************************************************/
579
580 #undef LoadImage /* do not conflict with Win32 API */
581
582 /****************************************************************************
583  * download and resize image located at psz_url
584  ***************************************************************************/
585 static picture_t *LoadImage( filter_t *p_filter, const char *psz_url )
586 {
587     filter_sys_t *p_sys = p_filter->p_sys;
588     video_format_t fmt_in;
589     video_format_t fmt_out;
590     picture_t *p_orig;
591     picture_t *p_pic = NULL;
592     image_handler_t *p_handler = image_HandlerCreate( p_filter );
593
594     memset( &fmt_in, 0, sizeof(video_format_t) );
595     memset( &fmt_out, 0, sizeof(video_format_t) );
596
597     fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
598     p_orig = image_ReadUrl( p_handler, psz_url, &fmt_in, &fmt_out );
599
600     if( !p_orig )
601     {
602         msg_Warn( p_filter, "Unable to read image %s", psz_url );
603     }
604     else if( p_sys->p_style->i_font_size > 0 )
605     {
606
607         fmt_in.i_chroma = VLC_FOURCC('Y','U','V','A');
608         fmt_in.i_height = p_orig->p[Y_PLANE].i_visible_lines;
609         fmt_in.i_width = p_orig->p[Y_PLANE].i_visible_pitch;
610         fmt_out.i_width = p_orig->p[Y_PLANE].i_visible_pitch
611             *p_sys->p_style->i_font_size/p_orig->p[Y_PLANE].i_visible_lines;
612         fmt_out.i_height = p_sys->p_style->i_font_size;
613
614         p_pic = image_Convert( p_handler, p_orig, &fmt_in, &fmt_out );
615         picture_Release( p_orig );
616         if( !p_pic )
617         {
618             msg_Warn( p_filter, "Error while converting %s", psz_url );
619         }
620     }
621     else
622     {
623         p_pic = p_orig;
624     }
625
626     image_HandlerDelete( p_handler );
627
628     return p_pic;
629 }
630
631 /****************************************************************************
632  * remove all ' ' '\t' '\n' '\r' characters from the begining and end of the
633  * string.
634  ***************************************************************************/
635 static char *removeWhiteChars( char *psz_src )
636 {
637     char *psz_src2 = strdup( psz_src );
638     char *psz_clean = strdup( psz_src2 );
639     char *psz_clean2;
640     int i;
641     while( ( *psz_clean == ' ' || *psz_clean == '\t'
642            || *psz_clean == '\n' || *psz_clean == '\r' )
643            && *psz_clean != '\0' )
644     {
645         psz_clean++;
646     }
647     i = strlen( psz_clean );
648     while( --i > 0 &&
649          ( psz_clean[i] == ' ' || psz_clean[i] == '\t'
650         || psz_clean[i] == '\n' || psz_clean[i] == '\r' ) );
651     psz_clean[i+1] = '\0';
652     psz_clean2 = strdup( psz_clean );
653     free( psz_src2 );
654     return psz_clean2;
655 }
656
657 /****************************************************************************
658  * FetchRSS (or Atom) feeds
659  ***************************************************************************/
660 static int FetchRSS( filter_t *p_filter)
661 {
662     filter_sys_t *p_sys = p_filter->p_sys;
663
664     stream_t *p_stream = NULL;
665     xml_t *p_xml = NULL;
666     xml_reader_t *p_xml_reader = NULL;
667
668     char *psz_eltname = NULL;
669     char *psz_eltvalue = NULL;
670     char *psz_feed = NULL;
671     char *psz_buffer = NULL;
672     char *psz_buffer_2 = NULL;
673
674     int i_feed;
675     int i_item;
676     bool b_is_item;
677     bool b_is_image;
678     int i_int;
679
680     FreeRSS( p_filter );
681     p_sys->i_feeds = 1;
682     i_int = 0;
683     while( p_sys->psz_urls[i_int] != 0 )
684         if( p_sys->psz_urls[i_int++] == '|' )
685             p_sys->i_feeds++;
686     p_sys->p_feeds = (struct rss_feed_t *)malloc( p_sys->i_feeds
687                                 * sizeof( struct rss_feed_t ) );
688
689     p_xml = xml_Create( p_filter );
690     if( !p_xml )
691     {
692         msg_Err( p_filter, "Failed to open XML parser" );
693         return 1;
694     }
695
696     psz_buffer = strdup( p_sys->psz_urls );
697     psz_buffer_2 = psz_buffer; /* keep track so we can free it */
698     for( i_feed = 0; i_feed < p_sys->i_feeds; i_feed++ )
699     {
700         struct rss_feed_t *p_feed = p_sys->p_feeds+i_feed;
701
702         if( psz_buffer == NULL ) break;
703         if( psz_buffer[0] == 0 ) psz_buffer++;
704         psz_feed = psz_buffer;
705         psz_buffer = strchr( psz_buffer, '|' );
706         if( psz_buffer != NULL ) psz_buffer[0] = 0;
707
708         p_feed->psz_title = NULL;
709         p_feed->psz_description = NULL;
710         p_feed->psz_link = NULL;
711         p_feed->psz_image = NULL;
712         p_feed->p_pic = NULL;
713         p_feed->i_items = 0;
714         p_feed->p_items = NULL;
715
716         msg_Dbg( p_filter, "opening %s RSS/Atom feed ...", psz_feed );
717
718         p_stream = stream_UrlNew( p_filter, psz_feed );
719         if( !p_stream )
720         {
721             msg_Err( p_filter, "Failed to open %s for reading", psz_feed );
722             return 1;
723         }
724
725         p_xml_reader = xml_ReaderCreate( p_xml, p_stream );
726         if( !p_xml_reader )
727         {
728             msg_Err( p_filter, "Failed to open %s for parsing", psz_feed );
729             return 1;
730         }
731
732         i_item = 0;
733         b_is_item = false;
734         b_is_image = false;
735
736         while( xml_ReaderRead( p_xml_reader ) == 1 )
737         {
738             switch( xml_ReaderNodeType( p_xml_reader ) )
739             {
740                 // Error
741                 case -1:
742                     return 1;
743
744                 case XML_READER_STARTELEM:
745                     free( psz_eltname );
746                     psz_eltname = xml_ReaderName( p_xml_reader );
747                     if( !psz_eltname )
748                     {
749                         return 1;
750                     }
751 #                   ifdef RSS_DEBUG
752                     msg_Dbg( p_filter, "element name: %s", psz_eltname );
753 #                   endif
754                     if( !strcmp( psz_eltname, "item" ) /* rss */
755                      || !strcmp( psz_eltname, "entry" ) ) /* atom */
756                     {
757                         b_is_item = true;
758                         p_feed->i_items++;
759                         p_feed->p_items = (struct rss_item_t *)realloc( p_feed->p_items, p_feed->i_items * sizeof( struct rss_item_t ) );
760                         p_feed->p_items[p_feed->i_items-1].psz_title = NULL;
761                         p_feed->p_items[p_feed->i_items-1].psz_description
762                                                                      = NULL;
763                         p_feed->p_items[p_feed->i_items-1].psz_link = NULL;
764                     }
765                     else if( !strcmp( psz_eltname, "image" ) ) /* rss */
766                     {
767                         b_is_image = true;
768                     }
769                     else if( !strcmp( psz_eltname, "link" ) ) /* atom */
770                     {
771                         char *psz_href = NULL;
772                         char *psz_rel = NULL;
773                         while( xml_ReaderNextAttr( p_xml_reader )
774                                == VLC_SUCCESS )
775                         {
776                             char *psz_name = xml_ReaderName( p_xml_reader );
777                             char *psz_value = xml_ReaderValue( p_xml_reader );
778                             if( !strcmp( psz_name, "rel" ) )
779                             {
780                                 if( psz_rel )
781                                 {
782                                     msg_Dbg( p_filter, "\"rel\" attribute of link atom duplicated (last value: %s)", psz_value );
783                                     free( psz_rel );
784                                 }
785                                 psz_rel = psz_value;
786                             }
787                             else if( !strcmp( psz_name, "href" ) )
788                             {
789                                 if( psz_href )
790                                 {
791                                     msg_Dbg( p_filter, "\"href\" attribute of link atom duplicated (last value: %s)", psz_href );
792                                     free( psz_href );
793                                 }
794                                 psz_href = psz_value;
795                             }
796                             else
797                             {
798                                 free( psz_value );
799                             }
800                             free( psz_name );
801                         }
802                         if( psz_rel && psz_href )
803                         {
804                             if( !strcmp( psz_rel, "alternate" )
805                                 && b_is_item == false
806                                 && b_is_image == false
807                                 && !p_feed->psz_link )
808                             {
809                                 p_feed->psz_link = psz_href;
810                             }
811                             /* this isn't in the rfc but i found some ... */
812                             else if( ( !strcmp( psz_rel, "logo" )
813                                     || !strcmp( psz_rel, "icon" ) )
814                                     && b_is_item == false
815                                     && b_is_image == false
816                                     && !p_feed->psz_image )
817                             {
818                                 p_feed->psz_image = psz_href;
819                             }
820                             else
821                             {
822                                 free( psz_href );
823                             }
824                         }
825                         else
826                         {
827                             free( psz_href );
828                         }
829                         free( psz_rel );
830                     }
831                     break;
832
833                 case XML_READER_ENDELEM:
834                     free( psz_eltname );
835                     psz_eltname = NULL;
836                     psz_eltname = xml_ReaderName( p_xml_reader );
837                     if( !psz_eltname )
838                     {
839                         return 1;
840                     }
841 #                   ifdef RSS_DEBUG
842                     msg_Dbg( p_filter, "element end : %s", psz_eltname );
843 #                   endif
844                     if( !strcmp( psz_eltname, "item" ) /* rss */
845                      || !strcmp( psz_eltname, "entry" ) ) /* atom */
846                     {
847                         b_is_item = false;
848                         i_item++;
849                     }
850                     else if( !strcmp( psz_eltname, "image" ) ) /* rss */
851                     {
852                         b_is_image = false;
853                     }
854                     free( psz_eltname );
855                     psz_eltname = NULL;
856                     break;
857
858                 case XML_READER_TEXT:
859                     if( !psz_eltname ) break;
860                     psz_eltvalue = xml_ReaderValue( p_xml_reader );
861                     if( !psz_eltvalue )
862                     {
863                         return 1;
864                     }
865                     else
866                     {
867                         char *psz_clean;
868                         psz_clean = removeWhiteChars( psz_eltvalue );
869                         free( psz_eltvalue ); psz_eltvalue = psz_clean;
870                     }
871 #                   ifdef RSS_DEBUG
872                     msg_Dbg( p_filter, "  text : <%s>", psz_eltvalue );
873 #                   endif
874                     if( b_is_item == true )
875                     {
876                         struct rss_item_t *p_item;
877                         p_item = p_feed->p_items+i_item;
878                         if( !strcmp( psz_eltname, "title" ) /* rss/atom */
879                             && !p_item->psz_title )
880                         {
881                             p_item->psz_title = psz_eltvalue;
882                         }
883                         else if( !strcmp( psz_eltname, "link" ) /* rss */
884                                  && !p_item->psz_link )
885                         {
886                             p_item->psz_link = psz_eltvalue;
887                         }
888                         else if((!strcmp( psz_eltname, "description" ) /* rss */
889                               || !strcmp( psz_eltname, "summary" ) ) /* atom */
890                               && !p_item->psz_description )
891                         {
892                             p_item->psz_description = psz_eltvalue;
893                         }
894                         else
895                         {
896                             free( psz_eltvalue );
897                             psz_eltvalue = NULL;
898                         }
899                     }
900                     else if( b_is_image == true )
901                     {
902                         if( !strcmp( psz_eltname, "url" ) /* rss */
903                             && !p_feed->psz_image )
904                         {
905                             p_feed->psz_image = psz_eltvalue;
906                         }
907                         else
908                         {
909                             free( psz_eltvalue );
910                             psz_eltvalue = NULL;
911                         }
912                     }
913                     else
914                     {
915                         if( !strcmp( psz_eltname, "title" ) /* rss/atom */
916                             && !p_feed->psz_title )
917                         {
918                             p_feed->psz_title = psz_eltvalue;
919                         }
920                         else if( !strcmp( psz_eltname, "link" ) /* rss */
921                                  && !p_feed->psz_link )
922                         {
923                             p_feed->psz_link = psz_eltvalue;
924                         }
925                         else if((!strcmp( psz_eltname, "description" ) /* rss */
926                               || !strcmp( psz_eltname, "subtitle" ) ) /* atom */
927                               && !p_feed->psz_description )
928                         {
929                             p_feed->psz_description = psz_eltvalue;
930                         }
931                         else if( ( !strcmp( psz_eltname, "logo" ) /* atom */
932                               || !strcmp( psz_eltname, "icon" ) ) /* atom */
933                               && !p_feed->psz_image )
934                         {
935                             p_feed->psz_image = psz_eltvalue;
936                         }
937                         else
938                         {
939                             free( psz_eltvalue );
940                             psz_eltvalue = NULL;
941                         }
942                     }
943                     break;
944             }
945         }
946
947         if( p_sys->b_images == true
948             && p_feed->psz_image && !p_feed->p_pic )
949         {
950             p_feed->p_pic = LoadImage( p_filter, p_feed->psz_image );
951         }
952
953         if( p_xml_reader && p_xml ) xml_ReaderDelete( p_xml, p_xml_reader );
954         if( p_stream ) stream_Delete( p_stream );
955         msg_Dbg( p_filter, "done with %s RSS/Atom feed", psz_feed );
956     }
957     free( psz_buffer_2 );
958     if( p_xml ) xml_Delete( p_xml );
959
960     return 0;
961 }
962
963 /****************************************************************************
964  * FreeRSS
965  ***************************************************************************/
966 static void FreeRSS( filter_t *p_filter)
967 {
968     filter_sys_t *p_sys = p_filter->p_sys;
969
970     struct rss_item_t *p_item;
971     struct rss_feed_t *p_feed;
972
973     int i_feed;
974     int i_item;
975
976     for( i_feed = 0; i_feed < p_sys->i_feeds; i_feed++ )
977     {
978         p_feed = p_sys->p_feeds+i_feed;
979         for( i_item = 0; i_item < p_feed->i_items; i_item++ )
980         {
981             p_item = p_feed->p_items+i_item;
982             free( p_item->psz_title );
983             free( p_item->psz_link );
984             free( p_item->psz_description );
985         }
986         free( p_feed->p_items );
987         free( p_feed->psz_title);
988         free( p_feed->psz_link );
989         free( p_feed->psz_description );
990         free( p_feed->psz_image );
991         if( p_feed->p_pic != NULL )
992             picture_Release( p_feed->p_pic );
993     }
994     free( p_sys->p_feeds );
995     p_sys->i_feeds = 0;
996 }