git.sesse.net Git - vlc/blob - modules/services_discovery/upnp_cc.cpp

   1 /*****************************************************************************
   2  * upnp_cc.cpp :  UPnP discovery module
   3  *****************************************************************************
   4  * Copyright (C) 2004-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rémi Denis-Courmont <rem # videolan.org>
   8  *
   9  * Based on original wxWindows patch for VLC, and dependent on CyberLink
  10  * UPnP library from :
  11  *          Satoshi Konno <skonno@cybergarage.org>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  26  *****************************************************************************/
  27
  28 /*****************************************************************************
  29  * Includes
  30  *****************************************************************************/
  31
  32 #include <cybergarage/upnp/media/player/MediaPlayer.h>
  33
  34 #undef PACKAGE_NAME
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 #include <vlc_common.h>
  40 #include <vlc_plugin.h>
  41 #include <vlc_playlist.h>
  42
  43 /* FIXME: thread-safety ?? */
  44 /* FIXME: playlist locking */
  45
  46 /************************************************************************
  47  * Macros and definitions
  48  ************************************************************************/
  49 using namespace std;
  50 using namespace CyberLink;
  51
  52 /*****************************************************************************
  53  * Module descriptor
  54  *****************************************************************************/
  55
  56 /* Callbacks */
  57     static int  Open ( vlc_object_t * );
  58     static void Close( vlc_object_t * );
  59
  60 vlc_module_begin ()
  61     set_shortname( "UPnP")
  62     set_description( N_("Universal Plug'n'Play discovery") )
  63     set_category( CAT_PLAYLIST )
  64     set_subcategory( SUBCAT_PLAYLIST_SD )
  65
  66     set_capability( "services_discovery", 0 )
  67     set_callbacks( Open, Close )
  68
  69 vlc_module_end ()
  70
  71 /*****************************************************************************
  72  * Run: main UPnP thread
  73  *****************************************************************************
  74  * Processes UPnP events
  75  *****************************************************************************/
  76 class UPnPHandler : public MediaPlayer, public DeviceChangeListener,
  77                     /*public EventListener,*/ public SearchResponseListener
  78 {
  79     private:
  80         services_discovery_t *p_sd;
  81
  82         Device *GetDeviceFromUSN( const string& usn )
  83         {
  84             return getDevice( usn.substr( 0, usn.find( "::" ) ).c_str() );
  85         }
  86
  87         playlist_item_t *FindDeviceNode( Device *dev )
  88         {
  89             return playlist_ChildSearchName( p_sd->p_cat, dev->getFriendlyName() );
  90         }
  91
  92         playlist_item_t *FindDeviceNode( const string &usn )
  93         {
  94             return FindDeviceNode( GetDeviceFromUSN( usn ) );
  95         }
  96
  97         playlist_item_t *AddDevice( Device *dev );
  98         void AddDeviceContent( Device *dev );
  99         void AddContent( playlist_item_t *p_parent, ContentNode *node );
 100         void RemoveDevice( Device *dev );
 101
 102         /* CyberLink callbacks */
 103         virtual void deviceAdded( Device *dev );
 104         virtual void deviceRemoved( Device *dev );
 105
 106         virtual void deviceSearchResponseReceived( SSDPPacket *packet );
 107         /*virtual void eventNotifyReceived( const char *uuid, long seq,
 108                                           const char *name,
 109                                           const char *value );*/
 110
 111     public:
 112         UPnPHandler( services_discovery_t *p_this )
 113             : p_sd( p_this )
 114         {
 115             addDeviceChangeListener( this );
 116             addSearchResponseListener( this );
 117             //addEventListener( this );
 118         }
 119 };
 120
 121 /*****************************************************************************
 122  * Open: initialize and create stuff
 123  *****************************************************************************/
 124 static int Open( vlc_object_t *p_this )
 125 {
 126     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
 127
 128     UPnPHandler *u = new UPnPHandler( p_sd );
 129     u->start( );
 130     msg_Dbg( p_sd, "upnp discovery started" );
 131     p_sd->p_private = u;
 132
 133     return VLC_SUCCESS;
 134 }
 135
 136
 137 /*****************************************************************************
 138  * Close:
 139  *****************************************************************************/
 140 static void Close( vlc_object_t *p_this )
 141 {
 142     UPnPHandler *u = (UPnPHandler *)p_this->p_private;
 143     u->stop( );
 144
 145     msg_Dbg( p_this, "upnp discovery started" );
 146 }
 147
 148
 149 playlist_item_t *UPnPHandler::AddDevice( Device *dev )
 150 {
 151     if( dev == NULL )
 152         return NULL;
 153
 154     /* We are not interested in IGD devices or whatever (at the moment) */
 155     if ( !dev->isDeviceType( MediaServer::DEVICE_TYPE ) )
 156         return NULL;
 157
 158     playlist_item_t *p_item = FindDeviceNode( dev );
 159     if ( p_item != NULL )
 160         return p_item;
 161
 162     /* FIXME:
 163      * Maybe one day, VLC API will make sensible use of the const keyword;
 164      * That day, you will no longer need this strdup().
 165      */
 166     char *str = strdup( dev->getFriendlyName( ) );
 167
 168     p_item = playlist_NodeCreate( p_playlist, str, p_sd->p_cat, 0, NULL );
 169     p_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
 170     msg_Dbg( p_sd, "device %s added", str );
 171     free( str );
 172
 173     return p_item;
 174 }
 175
 176 void UPnPHandler::AddDeviceContent( Device *dev )
 177 {
 178     playlist_item_t *p_devnode = AddDevice( dev );
 179
 180     if( p_devnode == NULL )
 181         return;
 182
 183     AddContent( p_devnode, getContentDirectory( dev ) );
 184 }
 185
 186 void UPnPHandler::AddContent( playlist_item_t *p_parent, ContentNode *node )
 187 {
 188     if( node == NULL )
 189         return;
 190
 191     const char *title = node->getTitle();
 192     if( title == NULL )
 193         return;
 194
 195     msg_Dbg( p_sd, "title = %s", title );
 196
 197     if ( node->isItemNode() )
 198     {
 199         ItemNode *iNode = (ItemNode *)node;
 200         input_item_t *p_input = input_item_New( p_sd, iNode->getResource(), title );
 201         /* FIXME: playlist_AddInput() can fail */
 202         playlist_BothAddInput( p_playlist, p_input, p_parent,
 203                                PLAYLIST_APPEND, PLAYLIST_END, NULL, NULL,
 204                                false );
 205         vlc_gc_decref( p_input );
 206     } else if ( node->isContainerNode() )
 207     {
 208         ContainerNode *conNode = (ContainerNode *)node;
 209
 210         char* p_name = strdup(title); /* See other comment on strdup */
 211         playlist_item_t* p_node = playlist_NodeCreate( p_playlist, p_name,
 212                                                        p_parent, 0, NULL );
 213         free(p_name);
 214
 215         unsigned nContentNodes = conNode->getNContentNodes();
 216
 217         for( unsigned n = 0; n < nContentNodes; n++ )
 218            AddContent( p_node, conNode->getContentNode( n ) );
 219     }
 220 }
 221
 222
 223 void UPnPHandler::RemoveDevice( Device *dev )
 224 {
 225     playlist_item_t *p_item = FindDeviceNode( dev );
 226
 227     if( p_item != NULL )
 228         playlist_NodeDelete( p_playlist, p_item, true, true );
 229 }
 230
 231
 232 void UPnPHandler::deviceAdded( Device *dev )
 233 {
 234     msg_Dbg( p_sd, "adding device" );
 235     AddDeviceContent( dev );
 236 }
 237
 238
 239 void UPnPHandler::deviceRemoved( Device *dev )
 240 {
 241     msg_Dbg( p_sd, "removing device" );
 242     RemoveDevice( dev );
 243 }
 244
 245
 246 void UPnPHandler::deviceSearchResponseReceived( SSDPPacket *packet )
 247 {
 248     if( !packet->isRootDevice() )
 249         return;
 250
 251     string usn, nts, nt, udn;
 252
 253     packet->getUSN( usn );
 254     packet->getNT( nt );
 255     packet->getNTS( nts );
 256     udn = usn.substr( 0, usn.find( "::" ) );
 257
 258     /* Remove existing root device before adding updated one */
 259
 260     Device *dev = GetDeviceFromUSN( usn );
 261     RemoveDevice( dev );
 262
 263     if( !packet->isByeBye() )
 264         AddDeviceContent( dev );
 265 }
 266
 267 /*void UPnPHandler::eventNotifyReceived( const char *uuid, long seq,
 268                                        const char *name, const char *value )
 269 {
 270     msg_Dbg( p_sd, "event notify received" );
 271     msg_Dbg( p_sd, "uuid = %s, name = %s, value = %s", uuid, name, value );
 272 }*/