git.sesse.net Git - vlc/blob - modules/services_discovery/upnp.hpp

   1 /*****************************************************************************
   2  * Upnp.hpp :  UPnP discovery module (libupnp) header
   3  *****************************************************************************
   4  * Copyright (C) 2004-2010 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rémi Denis-Courmont <rem # videolan.org> (original plugin)
   8  *          Christian Henz <henz # c-lab.de>
   9  *          Mirsal Ennaime <mirsal dot ennaime at gmail dot com>
  10  *
  11  * UPnP Plugin using the Intel SDK (libupnp) instead of CyberLink
  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 #include <vector>
  29 #include <string>
  30
  31 #include <upnp/upnp.h>
  32 #include <upnp/upnptools.h>
  33
  34 #include <vlc_common.h>
  35
  36 // Classes
  37 class Container;
  38
  39 class MediaServer
  40 {
  41 public:
  42
  43     static void parseDeviceDescription( IXML_Document* p_doc,
  44                                         const char*    psz_location,
  45                                         services_discovery_t* p_sd );
  46
  47     MediaServer( const char* psz_udn,
  48                  const char* psz_friendly_name,
  49                  services_discovery_t* p_sd );
  50
  51     ~MediaServer();
  52
  53     const char* getUDN() const;
  54     const char* getFriendlyName() const;
  55
  56     void setContentDirectoryEventURL( const char* psz_url );
  57     const char* getContentDirectoryEventURL() const;
  58
  59     void setContentDirectoryControlURL( const char* psz_url );
  60     const char* getContentDirectoryControlURL() const;
  61
  62     void subscribeToContentDirectory();
  63     void fetchContents();
  64
  65     void setInputItem( input_item_t* p_input_item );
  66     input_item_t* getInputItem() const;
  67
  68     bool compareSID( const char* psz_sid );
  69
  70 private:
  71
  72     bool _fetchContents( Container* p_parent );
  73     void _buildPlaylist( Container* p_container, input_item_node_t *p_item_node );
  74
  75     IXML_Document* _browseAction( const char*, const char*,
  76             const char*, const char*, const char*, const char* );
  77
  78     services_discovery_t* _p_sd;
  79
  80     Container* _p_contents;
  81     input_item_t* _p_input_item;
  82
  83     std::string _UDN;
  84     std::string _friendly_name;
  85
  86     std::string _content_directory_event_url;
  87     std::string _content_directory_control_url;
  88
  89     int _i_subscription_timeout;
  90     Upnp_SID _subscription_id;
  91 };
  92
  93
  94 class MediaServerList
  95 {
  96 public:
  97
  98     MediaServerList( services_discovery_t* p_sd );
  99     ~MediaServerList();
 100
 101     bool addServer( MediaServer* p_server );
 102     void removeServer( const char* psz_udn );
 103
 104     MediaServer* getServer( const char* psz_udn );
 105     MediaServer* getServerBySID( const char* psz_sid );
 106
 107 private:
 108
 109     services_discovery_t* _p_sd;
 110
 111     std::vector<MediaServer*> _list;
 112 };
 113
 114
 115 class Item
 116 {
 117 public:
 118
 119     Item( Container*  parent,
 120           const char* objectID,
 121           const char* title,
 122           const char* resource,
 123           mtime_t duration );
 124     ~Item();
 125
 126     const char* getObjectID() const;
 127     const char* getTitle() const;
 128     const char* getResource() const;
 129     mtime_t getDuration() const;
 130
 131     void setInputItem( input_item_t* p_input_item );
 132
 133 private:
 134
 135     input_item_t* _p_input_item;
 136
 137     Container* _parent;
 138     std::string _objectID;
 139     std::string _title;
 140     std::string _resource;
 141     mtime_t _duration;
 142 };
 143
 144
 145 class Container
 146 {
 147 public:
 148
 149     Container( Container* parent, const char* objectID, const char* title );
 150     ~Container();
 151
 152     void addItem( Item* item );
 153     void addContainer( Container* container );
 154
 155     const char* getObjectID() const;
 156     const char* getTitle() const;
 157
 158     unsigned int getNumItems() const;
 159     unsigned int getNumContainers() const;
 160
 161     Item* getItem( unsigned int i ) const;
 162     Container* getContainer( unsigned int i ) const;
 163     Container* getParent();
 164
 165     void setInputItem( input_item_t* p_input_item );
 166     input_item_t* getInputItem() const;
 167
 168 private:
 169
 170     input_item_t* _p_input_item;
 171
 172     Container* _parent;
 173
 174     std::string _objectID;
 175     std::string _title;
 176     std::vector<Item*> _items;
 177     std::vector<Container*> _containers;
 178 };
 179