codecleanup: Replace input_Item by input_item.
[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( services_discovery_t *p_sd );
144
145
146 /*****************************************************************************
147  * Open: initialize and create stuff
148  *****************************************************************************/
149 static int Open( vlc_object_t *p_this, enum type_e i_type )
150 {
151     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
152     services_discovery_SetLocalizedName( p_sd, _(p_items[i_type].psz_name) );
153     p_sd->pf_run = Run;
154     p_sd->p_sys = (void *)i_type;
155     return VLC_SUCCESS;
156 }
157
158 /*****************************************************************************
159  * ItemAdded:
160  *****************************************************************************/
161 static void ItemAdded( const vlc_event_t * p_event, void * user_data )
162 {
163     struct shout_category_t * params = user_data;
164     services_discovery_AddItem( params->p_sd,
165             p_event->u.input_item_subitem_added.p_new_child,
166             params->psz_category );
167 }
168
169 /*****************************************************************************
170  * CreateInputItemFromShoutItem:
171  *****************************************************************************/
172 static input_item_t * CreateInputItemFromShoutItem( services_discovery_t *p_sd,
173                                          const struct shout_item_t * p_item )
174 {
175     int i;
176     /* Create the item */
177     input_item_t *p_input = input_item_NewExt( p_sd,
178                     p_item->psz_url, _(p_item->psz_name),
179                     0, NULL, -1 );
180
181     /* Copy options */
182     for( i = 0; p_item->ppsz_options[i] != NULL; i++ )
183         input_item_AddOption( p_input, p_item->ppsz_options[i] );
184     input_item_AddOption( p_input, "no-playlist-autostart" );
185
186     return p_input;
187 }
188
189 /*****************************************************************************
190  * AddSubitemsOfShoutItemURL:
191  *****************************************************************************/
192 static void AddSubitemsOfShoutItemURL( services_discovery_t *p_sd,
193                                        const struct shout_item_t * p_item,
194                                        const char * psz_category )
195 {
196     struct shout_category_t category = { p_sd, psz_category };
197
198     /* Create the item */
199     input_item_t *p_input = CreateInputItemFromShoutItem( p_sd, p_item );
200
201     /* Read every subitems, and add them in ItemAdded */
202     vlc_event_attach( &p_input->event_manager, vlc_InputItemSubItemAdded,
203                       ItemAdded, &category );
204     input_Read( p_sd, p_input, true );
205     vlc_event_detach( &p_input->event_manager, vlc_InputItemSubItemAdded,
206                       ItemAdded, &category );
207
208     vlc_gc_decref( p_input );
209 }
210
211 /*****************************************************************************
212  * Run:
213  *****************************************************************************/
214 static void Run( services_discovery_t *p_sd )
215 {
216     enum type_e i_type = (enum type_e)p_sd->p_sys;
217     int i, j;
218     
219     if( !p_items[i_type].p_children )
220     {
221         AddSubitemsOfShoutItemURL( p_sd, &p_items[i_type], NULL );
222         return;
223     }
224     for( i = 0; p_items[i_type].p_children[i].psz_name; i++ )
225     {
226         const struct shout_item_t * p_subitem = &p_items[i_type].p_children[i];
227         if( !p_subitem->p_children )
228         {
229             AddSubitemsOfShoutItemURL( p_sd, p_subitem, p_subitem->psz_name );
230             continue;
231         }
232         for( j = 0; p_subitem->p_children[j].psz_name; j++ )
233         {
234             input_item_t *p_input = CreateInputItemFromShoutItem( p_sd, &p_subitem->p_children[j] );
235             services_discovery_AddItem( p_sd,
236                 p_input,
237                 p_subitem->psz_name );
238             vlc_gc_decref( p_input );
239         }
240     }
241 }
242
243 /*****************************************************************************
244  * Close:
245  *****************************************************************************/
246 static void Close( vlc_object_t *p_this )
247 {
248     VLC_UNUSED(p_this);
249 }