SD probe: always provide a long name
[vlc.git] / modules / services_discovery / shout.c
index 98a8f6b..276e9b2 100644 (file)
@@ -1,10 +1,12 @@
 /*****************************************************************************
- * sap.c :  SAP interface module
+ * shout.c:  Shoutcast services discovery module
  *****************************************************************************
- * Copyright (C) 2004 VideoLAN
- * $Id: sap.c 9217 2004-11-07 11:02:59Z courmisch $
+ * Copyright (C) 2005-2007 the VideoLAN team
+ * $Id$
  *
- * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
+ * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
+ *          Antoine Cellerier <dionoea -@T- videolan -d.t- org>
+ *          Pierre d'Herbemont <pdherbemont # videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Includes
  *****************************************************************************/
-#include <stdlib.h>                                      /* malloc(), free() */
 
-#include <vlc/vlc.h>
-#include <vlc/intf.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
 
-#include <vlc/input.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_services_discovery.h>
 
-#include "network.h"
+/*****************************************************************************
+ * Module descriptor
+ *****************************************************************************/
 
-#include <errno.h>                                                 /* ENOMEM */
+enum type_e { ShoutRadio = 0, ShoutTV = 1, Freebox = 2, FrenchTV = 3 };
 
-#ifdef HAVE_UNISTD_H
-#    include <unistd.h>
-#endif
-#ifdef HAVE_SYS_TIME_H
-#    include <sys/time.h>
-#endif
+static int  Open( vlc_object_t *, enum type_e );
+static void Close( vlc_object_t * );
 
-/************************************************************************
- * Macros and definitions
- ************************************************************************/
+struct shout_item_t
+{
+    const char *psz_url;
+    const char *psz_name;
+    const char *ppsz_options[2];
+    const struct shout_item_t * p_children;
+};
 
-#define MAX_LINE_LENGTH 256
+#define endItem( ) { NULL, NULL, { NULL }, NULL }
+#define item( title, url ) { url, title, { NULL }, NULL }
+#define itemWithOption( title, url, option ) { url, title, { option, NULL }, NULL }
+#define itemWithChildren( title, children ) { "vlc://nop", title, { NULL }, children }
 
+/* WARN: We support only two levels */
 
-/*****************************************************************************
- * Module descriptor
- *****************************************************************************/
+static const struct shout_item_t p_frenchtv_canalplus[] = {
+    itemWithOption( N_("Les Guignols"), "http://www.canalplus.fr/index.php?pid=1784", "http-forward-cookies" ),
+    endItem()
+};
+    
+static const struct shout_item_t p_frenchtv[] = {
+    itemWithChildren( N_("Canal +"),  p_frenchtv_canalplus ),
+    endItem()
+};
 
-/* Callbacks */
-    static int  Open ( vlc_object_t * );
-    static void Close( vlc_object_t * );
+static const struct shout_item_t p_items[] = {
+    item(            N_("Shoutcast Radio"), "http/shout-winamp://www.shoutcast.com/sbin/newxml.phtml" ),
+    item(            N_("Shoutcast TV"),    "http/shout-winamp://www.shoutcast.com/sbin/newtvlister.phtml?alltv=1" ),
+    itemWithOption( N_("Freebox TV"),"http://mafreebox.freebox.fr/freeboxtv/playlist.m3u", "deinterlace=1"),
+    itemWithChildren(N_("French TV"),        p_frenchtv ),
+    endItem()
+};
 
-vlc_module_begin();
-    set_description( _("HAL device detection") );
-    set_category( CAT_PLAYLIST );
-    set_subcategory( SUBCAT_PLAYLIST_SD );
+#undef endItem
+#undef item
+#undef itemWithOptions
+#undef itemWithChildren
 
-    set_capability( "services_discovery", 0 );
-    set_callbacks( Open, Close );
+struct shout_category_t {
+    services_discovery_t * p_sd;
+    const char * psz_category;
+    const struct shout_item_t * p_parent;
+};
 
-vlc_module_end();
+/* Main functions */
+#define OPEN( type )                                \
+static int Open ## type ( vlc_object_t *p_this )    \
+{                                                   \
+    msg_Dbg( p_this, "Starting " #type );           \
+    return Open( p_this, type );                    \
+}
 
+OPEN( ShoutRadio )
+OPEN( ShoutTV )
+OPEN( Freebox )
+OPEN( FrenchTV )
 
-/*****************************************************************************
- * Local structures
- *****************************************************************************/
+#undef OPEN
 
-struct services_discovery_sys_t
-{
-    /* playlist node */
-    playlist_item_t *p_node;
-    input_thread_t *p_input;
+static int vlc_sd_probe_Open( vlc_object_t * );
+
+vlc_module_begin ()
+    set_category( CAT_PLAYLIST )
+    set_subcategory( SUBCAT_PLAYLIST_SD )
+
+    add_obsolete_integer( "shoutcast-limit" )
+
+        set_shortname( "Shoutcast")
+        set_description( N_("Shoutcast Radio") )
+        set_capability( "services_discovery", 0 )
+        set_callbacks( OpenShoutRadio, Close )
+        add_shortcut( "shoutcast" )
+
+    add_submodule ()
+        set_shortname( "ShoutcastTV" )
+        set_description( N_("Shoutcast TV") )
+        set_capability( "services_discovery", 0 )
+        set_callbacks( OpenShoutTV, Close )
+        add_shortcut( "shoutcasttv" )
+
+    add_submodule ()
+        set_shortname( "frenchtv")
+        set_description( N_("French TV") )
+        set_capability( "services_discovery", 0 )
+        set_callbacks( OpenFrenchTV, Close )
+        add_shortcut( "frenchtv" )
+
+    add_submodule ()
+        set_shortname( "Freebox")
+        set_description( N_("Freebox TV") )
+        set_capability( "services_discovery", 0 )
+        set_callbacks( OpenFreebox, Close )
+        add_shortcut( "freebox" )
+
+    VLC_SD_PROBE_SUBMODULE
+vlc_module_end ()
 
-};
 
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
 
-/* Main functions */
-    static void Run    ( services_discovery_t *p_intf );
+static void *Run( void * );
+struct services_discovery_sys_t
+{
+    vlc_thread_t thread;
+    enum type_e i_type;
+};
 
 /*****************************************************************************
  * Open: initialize and create stuff
  *****************************************************************************/
-static int Open( vlc_object_t *p_this )
+static int Open( vlc_object_t *p_this, enum type_e i_type )
 {
     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
-    services_discovery_sys_t *p_sys  = malloc(
-                                    sizeof( services_discovery_sys_t ) );
 
-    vlc_value_t         val;
-    playlist_t          *p_playlist;
-    playlist_view_t     *p_view;
-    playlist_item_t     *p_item;
+    p_sd->p_sys = malloc (sizeof (*(p_sd->p_sys)));
+    if (p_sd->p_sys == NULL)
+        return VLC_ENOMEM;
 
-    p_sd->pf_run = Run;
-    p_sd->p_sys  = p_sys;
-
-    /* Create our playlist node */
-    p_playlist = (playlist_t *)vlc_object_find( p_sd, VLC_OBJECT_PLAYLIST,
-                                                FIND_ANYWHERE );
-    if( !p_playlist )
+    p_sd->p_sys->i_type = i_type;
+    if (vlc_clone (&p_sd->p_sys->thread, Run, p_sd, VLC_THREAD_PRIORITY_LOW))
     {
-        msg_Warn( p_sd, "unable to find playlist, cancelling");
+        free (p_sd->p_sys);
         return VLC_EGENERIC;
     }
+    return VLC_SUCCESS;
+}
 
-    p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
-    p_sys->p_node = playlist_NodeCreate( p_playlist, VIEW_CATEGORY,
-                                         _("Shoutcast"), p_view->p_root );
-    p_item = playlist_ItemNew( p_playlist, "http/shout-b4s://shoutcast.com/sbin/xmllister.phtml?service=vlc&no_compress=1&limit=1000", "Top 1000" );
-    playlist_NodeAddItem( p_playlist, p_item,
-                          p_sys->p_node->pp_parents[0]->i_view,
-                          p_sys->p_node, PLAYLIST_APPEND,
-                          PLAYLIST_END );
-
-    p_sys->p_input = input_CreateThread( p_playlist, &p_item->input );
-    /* We need to declare the parents of the node as the same of the
-     * parent's ones */
-    playlist_CopyParents( p_sys->p_node, p_item );
-    
-    p_sys->p_node->i_flags |= PLAYLIST_RO_FLAG;
-    val.b_bool = VLC_TRUE;
-    var_Set( p_playlist, "intf-change", val );
+/*****************************************************************************
+ * ItemAdded:
+ *****************************************************************************/
+static void ItemAdded( const vlc_event_t * p_event, void * user_data )
+{
+    struct shout_category_t * params = user_data;
+    const struct shout_item_t * p_parent = params->p_parent;
+    input_item_t * p_input = p_event->u.input_item_subitem_added.p_new_child;
 
-    vlc_object_release( p_playlist );
+    for(int i = 0; p_parent->ppsz_options[i] != NULL; i++)
+        input_item_AddOption( p_input, p_parent->ppsz_options[i], VLC_INPUT_OPTION_TRUSTED);
 
-    return VLC_SUCCESS;
+    services_discovery_AddItem( params->p_sd, p_input, params->psz_category );
 }
 
 /*****************************************************************************
- * Close:
+ * CreateInputItemFromShoutItem:
  *****************************************************************************/
-static void Close( vlc_object_t *p_this )
+static input_item_t * CreateInputItemFromShoutItem( services_discovery_t *p_sd,
+                                         const struct shout_item_t * p_item )
 {
-    services_discovery_t *p_sd = ( services_discovery_t* )p_this;
-    services_discovery_sys_t *p_sys  = p_sd->p_sys;
-    playlist_t *p_playlist =  (playlist_t *) vlc_object_find( p_sd,
-                                 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
-    if( p_playlist )
-    {
-        playlist_NodeDelete( p_playlist, p_sys->p_node, VLC_TRUE, VLC_TRUE );
-        vlc_object_release( p_playlist );
-    }
-    if( p_sd->p_sys->p_input )
-    {
-        input_StopThread( p_sd->p_sys->p_input );
-        input_DestroyThread( p_sd->p_sys->p_input );
-        vlc_object_detach( p_sd->p_sys->p_input );
-        vlc_object_destroy( p_sd->p_sys->p_input );
-        p_sd->p_sys->p_input = NULL;        
-    }
-    free( p_sys );
+    /* Create the item */
+    input_item_t *p_input = input_item_New( p_sd, p_item->psz_url,
+                                            vlc_gettext(p_item->psz_name) );
+
+    /* Copy options */
+    for(int i = 0; p_item->ppsz_options[i] != NULL; i++)
+        input_item_AddOption( p_input, p_item->ppsz_options[i], VLC_INPUT_OPTION_TRUSTED );
+    input_item_AddOption( p_input, "no-playlist-autostart", VLC_INPUT_OPTION_TRUSTED );
+
+    return p_input;
+}
+
+/*****************************************************************************
+ * AddSubitemsOfShoutItemURL:
+ *****************************************************************************/
+static void AddSubitemsOfShoutItemURL( services_discovery_t *p_sd,
+                                       const struct shout_item_t * p_item,
+                                       const char * psz_category )
+{
+    struct shout_category_t category = { p_sd, psz_category, p_item };
+
+    /* Create the item */
+    input_item_t *p_input = CreateInputItemFromShoutItem( p_sd, p_item );
+
+    /* Read every subitems, and add them in ItemAdded */
+    vlc_event_attach( &p_input->event_manager, vlc_InputItemSubItemAdded,
+                      ItemAdded, &category );
+    input_Read( p_sd, p_input );
+    vlc_event_detach( &p_input->event_manager, vlc_InputItemSubItemAdded,
+                      ItemAdded, &category );
+
+    vlc_gc_decref( p_input );
 }
 
 /*****************************************************************************
- * Run: main thread
+ * Run:
  *****************************************************************************/
-static void Run( services_discovery_t *p_sd )
+static void *Run( void *data )
 {
-    while( !p_sd->b_die )
+    services_discovery_t *p_sd = data;
+    services_discovery_sys_t *p_sys = p_sd->p_sys;
+    enum type_e i_type = p_sys->i_type;
+    int i, j;
+    int canc = vlc_savecancel();
+    
+    if( !p_items[i_type].p_children )
+    {
+        AddSubitemsOfShoutItemURL( p_sd, &p_items[i_type], NULL );
+        vlc_restorecancel(canc);
+        return NULL;
+    }
+    for( i = 0; p_items[i_type].p_children[i].psz_name; i++ )
     {
-        if( p_sd->p_sys->p_input &&
-            ( p_sd->p_sys->p_input->b_eof || p_sd->p_sys->p_input->b_error ) )
+        const struct shout_item_t * p_subitem = &p_items[i_type].p_children[i];
+        if( !p_subitem->p_children )
         {
-            input_StopThread( p_sd->p_sys->p_input );
-            input_DestroyThread( p_sd->p_sys->p_input );
-            vlc_object_detach( p_sd->p_sys->p_input );
-            vlc_object_destroy( p_sd->p_sys->p_input );
-            p_sd->p_sys->p_input = NULL;
+            AddSubitemsOfShoutItemURL( p_sd, p_subitem, p_subitem->psz_name );
+            continue;
+        }
+        for( j = 0; p_subitem->p_children[j].psz_name; j++ )
+        {
+            input_item_t *p_input = CreateInputItemFromShoutItem( p_sd, &p_subitem->p_children[j] );
+            services_discovery_AddItem( p_sd,
+                p_input,
+                p_subitem->psz_name );
+            vlc_gc_decref( p_input );
         }
-        msleep( 100000 );
     }
+    vlc_restorecancel(canc);
+    return NULL;
+}
+
+/*****************************************************************************
+ * Close:
+ *****************************************************************************/
+static void Close( vlc_object_t *p_this )
+{
+    services_discovery_t *p_sd = (services_discovery_t *)p_this;
+    services_discovery_sys_t *p_sys = p_sd->p_sys;
+
+    vlc_join (p_sys->thread, NULL);
+    free (p_sys);
+}
+
+static int vlc_sd_probe_Open( vlc_object_t *obj )
+{
+    vlc_probe_t *probe = (vlc_probe_t *)obj;
+
+    vlc_sd_probe_Add( probe, "shoutcast{longname=\"Shoutcast Radio\"}",
+                      N_("Shoutcast Radio") );
+    vlc_sd_probe_Add( probe, "shoutcasttv{longname=\"Shoutcast TV\"}",
+                      N_("Shoutcast TV") );
+    vlc_sd_probe_Add( probe, "frenchtv{longname=\"French TV\"}",
+                      N_("French TV") );
+    return VLC_PROBE_CONTINUE;
 }