Use gettext() as per gettext standard for non-constant parameters
[vlc.git] / modules / services_discovery / shout.c
1 /*****************************************************************************
2  * shout.c:  Shoutcast services discovery module
3  *****************************************************************************
4  * Copyright (C) 2005-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
8  *          Antoine Cellerier <dionoea -@T- videolan -d.t- org>
9  *          Pierre d'Herbemont <pdherbemont # videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Includes
28  *****************************************************************************/
29
30 #ifdef HAVE_CONFIG_H
31 # include "config.h"
32 #endif
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_services_discovery.h>
37
38 /*****************************************************************************
39  * Module descriptor
40  *****************************************************************************/
41
42 enum type_e { ShoutRadio = 0, ShoutTV = 1, Freebox = 2, FrenchTV = 3 };
43
44 static int  Open( vlc_object_t *, enum type_e );
45 static void Close( vlc_object_t * );
46
47 struct shout_item_t
48 {
49     const char *psz_url;
50     const char *psz_name;
51     const char *ppsz_options[2];
52     const struct shout_item_t * p_children;
53 };
54
55 #define endItem( ) { NULL, NULL, { NULL }, NULL }
56 #define item( title, url ) { url, title, { NULL }, NULL }
57 #define itemWithOption( title, url, option ) { url, title, { option, NULL }, NULL }
58 #define itemWithChildren( title, children ) { "vlc://nop", title, { NULL }, children }
59
60 /* WARN: We support only two levels */
61
62 static const struct shout_item_t p_frenchtv_canalplus[] = {
63     itemWithOption( N_("Les Guignols"), "http://www.canalplus.fr/index.php?pid=1784", "http-forward-cookies" ),
64     endItem()
65 };
66     
67 static const struct shout_item_t p_frenchtv[] = {
68     itemWithChildren( N_("Canal +"),  p_frenchtv_canalplus ),
69     endItem()
70 };
71
72 static const struct shout_item_t p_items[] = {
73     item(            N_("Shoutcast Radio"), "http/shout-winamp://www.shoutcast.com/sbin/newxml.phtml" ),
74     item(            N_("Shoutcast TV"),    "http/shout-winamp://www.shoutcast.com/sbin/newtvlister.phtml?alltv=1" ),
75     item(            N_("Freebox TV"),      "http://mafreebox.freebox.fr/freeboxtv/playlist.m3u" ),
76     itemWithChildren(N_("French TV"),        p_frenchtv ),
77     endItem()
78 };
79
80 #undef endItem
81 #undef item
82 #undef itemWithOptions
83 #undef itemWithChildren
84
85 struct shout_category_t {
86     services_discovery_t * p_sd;
87     const char * psz_category;
88 };
89
90 /* Main functions */
91 #define OPEN( type )                                \
92 static int Open ## type ( vlc_object_t *p_this )    \
93 {                                                   \
94     msg_Dbg( p_this, "Starting " #type );           \
95     return Open( p_this, type );                    \
96 }
97
98 OPEN( ShoutRadio )
99 OPEN( ShoutTV )
100 OPEN( Freebox )
101 OPEN( FrenchTV )
102
103 vlc_module_begin ()
104     set_category( CAT_PLAYLIST )
105     set_subcategory( SUBCAT_PLAYLIST_SD )
106
107     add_obsolete_integer( "shoutcast-limit" )
108
109         set_shortname( "Shoutcast")
110         set_description( N_("Shoutcast radio listings") )
111         set_capability( "services_discovery", 0 )
112         set_callbacks( OpenShoutRadio, Close )
113         add_shortcut( "shoutcast" )
114
115     add_submodule ()
116         set_shortname( "ShoutcastTV" )
117         set_description( N_("Shoutcast TV listings") )
118         set_capability( "services_discovery", 0 )
119         set_callbacks( OpenShoutTV, Close )
120         add_shortcut( "shoutcasttv" )
121
122     add_submodule ()
123         set_shortname( "frenchtv")
124         set_description( N_("French TV") )
125         set_capability( "services_discovery", 0 )
126         set_callbacks( OpenFrenchTV, Close )
127         add_shortcut( "frenchtv" )
128
129     add_submodule ()
130         set_shortname( "Freebox")
131         set_description( N_("Freebox TV listing (French ISP free.fr services)") )
132         set_capability( "services_discovery", 0 )
133         set_callbacks( OpenFreebox, Close )
134         add_shortcut( "freebox" )
135
136 vlc_module_end ()
137
138
139 /*****************************************************************************
140  * Local prototypes
141  *****************************************************************************/
142
143 static void *Run( void * );
144 struct services_discovery_sys_t
145 {
146     vlc_thread_t thread;
147     enum type_e i_type;
148 };
149
150 /*****************************************************************************
151  * Open: initialize and create stuff
152  *****************************************************************************/
153 static int Open( vlc_object_t *p_this, enum type_e i_type )
154 {
155     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
156
157     p_sd->p_sys = malloc (sizeof (*(p_sd->p_sys)));
158     if (p_sd->p_sys == NULL)
159         return VLC_ENOMEM;
160
161     p_sd->p_sys->i_type = i_type;
162     if (vlc_clone (&p_sd->p_sys->thread, Run, p_sd, VLC_THREAD_PRIORITY_LOW))
163     {
164         free (p_sd->p_sys);
165         return VLC_EGENERIC;
166     }
167     return VLC_SUCCESS;
168 }
169
170 /*****************************************************************************
171  * ItemAdded:
172  *****************************************************************************/
173 static void ItemAdded( const vlc_event_t * p_event, void * user_data )
174 {
175     struct shout_category_t * params = user_data;
176     services_discovery_AddItem( params->p_sd,
177             p_event->u.input_item_subitem_added.p_new_child,
178             params->psz_category );
179 }
180
181 /*****************************************************************************
182  * CreateInputItemFromShoutItem:
183  *****************************************************************************/
184 static input_item_t * CreateInputItemFromShoutItem( services_discovery_t *p_sd,
185                                          const struct shout_item_t * p_item )
186 {
187     int i;
188     /* Create the item */
189     input_item_t *p_input = input_item_New( p_sd, p_item->psz_url,
190                                             gettext(p_item->psz_name) );
191
192     /* Copy options */
193     for( i = 0; p_item->ppsz_options[i] != NULL; i++ )
194         input_item_AddOption( p_input, p_item->ppsz_options[i], VLC_INPUT_OPTION_TRUSTED );
195     input_item_AddOption( p_input, "no-playlist-autostart", VLC_INPUT_OPTION_TRUSTED );
196
197     return p_input;
198 }
199
200 /*****************************************************************************
201  * AddSubitemsOfShoutItemURL:
202  *****************************************************************************/
203 static void AddSubitemsOfShoutItemURL( services_discovery_t *p_sd,
204                                        const struct shout_item_t * p_item,
205                                        const char * psz_category )
206 {
207     struct shout_category_t category = { p_sd, psz_category };
208
209     /* Create the item */
210     input_item_t *p_input = CreateInputItemFromShoutItem( p_sd, p_item );
211
212     /* Read every subitems, and add them in ItemAdded */
213     vlc_event_attach( &p_input->event_manager, vlc_InputItemSubItemAdded,
214                       ItemAdded, &category );
215     input_Read( p_sd, p_input, true );
216     vlc_event_detach( &p_input->event_manager, vlc_InputItemSubItemAdded,
217                       ItemAdded, &category );
218
219     vlc_gc_decref( p_input );
220 }
221
222 /*****************************************************************************
223  * Run:
224  *****************************************************************************/
225 static void *Run( void *data )
226 {
227     services_discovery_t *p_sd = data;
228     services_discovery_sys_t *p_sys = p_sd->p_sys;
229     enum type_e i_type = p_sys->i_type;
230     int i, j;
231     int canc = vlc_savecancel();
232     
233     if( !p_items[i_type].p_children )
234     {
235         AddSubitemsOfShoutItemURL( p_sd, &p_items[i_type], NULL );
236         vlc_restorecancel(canc);
237         return NULL;
238     }
239     for( i = 0; p_items[i_type].p_children[i].psz_name; i++ )
240     {
241         const struct shout_item_t * p_subitem = &p_items[i_type].p_children[i];
242         if( !p_subitem->p_children )
243         {
244             AddSubitemsOfShoutItemURL( p_sd, p_subitem, p_subitem->psz_name );
245             continue;
246         }
247         for( j = 0; p_subitem->p_children[j].psz_name; j++ )
248         {
249             input_item_t *p_input = CreateInputItemFromShoutItem( p_sd, &p_subitem->p_children[j] );
250             services_discovery_AddItem( p_sd,
251                 p_input,
252                 p_subitem->psz_name );
253             vlc_gc_decref( p_input );
254         }
255     }
256     vlc_restorecancel(canc);
257     return NULL;
258 }
259
260 /*****************************************************************************
261  * Close:
262  *****************************************************************************/
263 static void Close( vlc_object_t *p_this )
264 {
265     services_discovery_t *p_sd = (services_discovery_t *)p_this;
266     services_discovery_sys_t *p_sys = p_sd->p_sys;
267
268     vlc_join (p_sys->thread, NULL);
269     free (p_sys);
270 }