[vlc-devel] [PATCH v3 6/6] upnp: Add UPnP/DLNA MediaRenderer control plugin

Johan Gunnarsson johan.gunnarsson at gmail.com
Thu Jul 25 23:26:06 CEST 2019


---
 modules/control/dlna.cpp               | 860 +++++++++++++++++++++++++
 modules/control/dlna.hpp               |  93 +++
 modules/services_discovery/Makefile.am |   4 +-
 modules/services_discovery/upnp.cpp    |  10 +
 modules/services_discovery/upnp.hpp    |   1 -
 5 files changed, 966 insertions(+), 2 deletions(-)
 create mode 100644 modules/control/dlna.cpp
 create mode 100644 modules/control/dlna.hpp

diff --git a/modules/control/dlna.cpp b/modules/control/dlna.cpp
new file mode 100644
index 0000000000..63f5828d2d
--- /dev/null
+++ b/modules/control/dlna.cpp
@@ -0,0 +1,860 @@
+/*****************************************************************************
+ * dlna.cpp :  DLNA MediaRenderer module
+ *****************************************************************************
+ * Copyright (C) 2019 VLC authors and VideoLAN
+ *
+ * Authors: Johan Gunnarsson <johan.gunnarsson at gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <cstring>
+#include <ctime>
+#include <map>
+#include <unordered_map>
+#include <iostream>
+#include <functional>
+
+#include "../services_discovery/upnp-wrapper.hpp"
+
+#include <vlc_plugin.h>
+#include <vlc_interface.h>
+#include <vlc_playlist.h>
+#include <vlc_player.h>
+#include <vlc_strings.h>
+#include <vlc_input.h>
+
+#include "dlna.hpp"
+
+#define SINK_PROTOCOL_INFO ("http-get:*:video/mpeg:*," \
+                            "http-get:*:video/mp4:*," \
+                            "http-get:*:video/vnd.dlna.mpeg-tts:*," \
+                            "http-get:*:video/avi:*," \
+                            "http-get:*:video/x-matroska:*," \
+                            "http-get:*:video/x-ms-wmv:*," \
+                            "http-get:*:video/wtv:*," \
+                            "http-get:*:audio/mpeg:*," \
+                            "http-get:*:audio/mp3:*," \
+                            "http-get:*:audio/mp4:*," \
+                            "http-get:*:audio/x-ms-wma*," \
+                            "http-get:*:audio/wav:*," \
+                            "http-get:*:audio/L16:*," \
+                            "http-get:*image/jpeg:*," \
+                            "http-get:*image/png:*," \
+                            "http-get:*image/gif:*," \
+                            "http-get:*image/tiff:*")
+
+using upnp_ptr =
+    std::unique_ptr<UpnpInstanceWrapper,
+                    std::function<void(UpnpInstanceWrapper*)>>;
+
+using player_listener_ptr =
+    std::unique_ptr<vlc_player_listener_id,
+                    std::function<void(vlc_player_listener_id*)>>;
+
+using player_aout_listener_ptr =
+    std::unique_ptr<vlc_player_aout_listener_id,
+                    std::function<void(vlc_player_aout_listener_id*)>>;
+
+using ixml_document_ptr =
+    std::unique_ptr<IXML_Document,
+                    std::function<void(IXML_Document*)>>;
+
+using parammap =
+    std::unordered_map<std::string,
+                       std::string>;
+
+using ActionRequestHandler =
+    bool (*)( const parammap&, parammap&, intf_thread_t* );
+
+struct intf_sys_t
+{
+    vlc_playlist_t *playlist;
+    vlc_player_t *player;
+    upnp_ptr p_upnp;
+    std::shared_ptr<EventHandler> p_listener;
+    player_listener_ptr p_player_listener;
+    player_aout_listener_ptr p_player_aout_listener;
+};
+
+namespace
+{
+
+/**
+ * Convert ticks (in microseconds) to a string in the form H:MM:SS. Can't use
+ * secstotimestr since it will omit hours if time is less than 1 hour. Can't
+ * use strftime since it will limit the H part to 0-23. A 25 hour long media
+ * should produce the string "25:00:00".
+ */
+static std::string
+time_to_string( vlc_tick_t ticks )
+{
+    unsigned int time_in_seconds = (unsigned int) SEC_FROM_VLC_TICK(ticks);
+    unsigned int s = time_in_seconds % 60;
+    time_in_seconds -= s;
+    unsigned int m = (time_in_seconds / 60) % 60;
+    time_in_seconds -= 60 * m;
+    unsigned int h = time_in_seconds / (60 * 60);
+
+    char str[20] = {};
+    if( snprintf( str, sizeof( str ) - 1, "%u:%02u:%02u", h, m, s ) < 0 )
+        return std::string( "0:00:00" );
+
+    return std::string( str );
+}
+
+static float
+frac_to_float( std::string frac )
+{
+    int n = 0;
+    unsigned int d = 1;
+    if( !(sscanf( frac.c_str(), "%d/%u", &n, &d ) == 2 ||
+          sscanf( frac.c_str(), "%d", &n ) == 1) )
+        return 1.0; /* invalid input */
+    if( n == 0 || d == 0 )
+        return 1.0; /* invalid input */
+
+    return (float) n / (float) d;
+}
+
+static long
+gcd( long n, long d ) {
+    if( d == 0 )
+        return n;
+
+    return gcd( d, n % d );
+}
+
+static std::string
+float_to_frac( float frac )
+{
+    long n = std::lround( frac * 100 );
+    long d = 100;
+    long common_denominator = gcd( n, d );
+
+    return std::to_string( n / common_denominator ) + "/" +
+           std::to_string( d / common_denominator );
+}
+
+static bool
+handle_AVT_SetAVTransportURI( const parammap& in_params, parammap&,
+                              intf_thread_t *p_intf )
+{
+    auto s = in_params.find( "CurrentURI" );
+    if( s == in_params.end() )
+        return false;
+
+    input_item_t *item = input_item_New(s->second.c_str(), nullptr);
+    if( !item )
+    {
+        msg_Err( p_intf, "Failed to parse URL" );
+        return false;
+    }
+
+    vlc_player_Lock( p_intf->p_sys->player );
+    vlc_player_SetCurrentMedia( p_intf->p_sys->player, item );
+    vlc_player_Start( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    input_item_Release( item );
+
+    return true;
+}
+
+static bool
+handle_AVT_GetMediaInfo( const parammap&, parammap& out_params,
+                         intf_thread_t *p_intf )
+{
+    vlc_player_Lock( p_intf->p_sys->player );
+    vlc_tick_t length = vlc_player_GetLength( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    out_params["MediaDuration"] = time_to_string( length );
+
+    return true;
+}
+
+
+static bool
+handle_AVT_GetTransportInfo( const parammap&, parammap& out_params,
+                             intf_thread_t *p_intf )
+{
+    vlc_player_Lock( p_intf->p_sys->player );
+    enum vlc_player_state state = vlc_player_GetState( p_intf->p_sys->player );
+    enum vlc_player_error error = vlc_player_GetError( p_intf->p_sys->player );
+    float rate = vlc_player_GetRate( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    switch( state )
+    {
+    case VLC_PLAYER_STATE_STOPPED:
+        out_params["CurrentTransportState"] = "STOPPED";
+        break;
+    case VLC_PLAYER_STATE_PLAYING:
+        out_params["CurrentTransportState"] = "PLAYING";
+        break;
+    case VLC_PLAYER_STATE_PAUSED:
+        out_params["CurrentTransportState"] = "PAUSED_PLAYBACK";
+        break;
+    case VLC_PLAYER_STATE_STARTED: /* fall through */
+    case VLC_PLAYER_STATE_STOPPING:
+        out_params["CurrentTransportState"] = "TRANSITIONING";
+        break;
+    default:
+        out_params["CurrentTransportState"] = "UNKNOWN";
+        break;
+    }
+
+    switch( error )
+    {
+    case VLC_PLAYER_ERROR_NONE:
+        out_params["CurrentTransportStatus"] = "OK";
+        break;
+    case VLC_PLAYER_ERROR_GENERIC: /* fall through */
+    default:
+        out_params["CurrentTransportStatus"] = "ERROR_OCCURRED";
+        break;
+    }
+
+    out_params["CurrentSpeed"] = float_to_frac( rate );
+
+    return true;
+}
+
+static bool
+handle_AVT_GetPositionInfo( const parammap&, parammap& out_params,
+                            intf_thread_t *p_intf )
+{
+    vlc_player_Lock( p_intf->p_sys->player );
+    vlc_tick_t length = vlc_player_GetLength( p_intf->p_sys->player );
+    vlc_tick_t time = vlc_player_GetTime( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    out_params["Track"] = "0";
+    out_params["TrackDuration"] = time_to_string( length );
+    out_params["TrackMetaData"] = "";
+    out_params["TrackURI"] = "";
+    out_params["RelTime"] = time_to_string( time );
+    out_params["AbsTime"] = time_to_string( time );
+    out_params["RelCount"] = std::to_string( time );
+    out_params["AbsCount"] = std::to_string( time );
+
+    return true;
+}
+
+static bool
+handle_AVT_Stop( const parammap&, parammap&, intf_thread_t *p_intf )
+{
+    vlc_player_Lock( p_intf->p_sys->player );
+    vlc_player_Stop( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    return true;
+}
+
+static bool
+handle_AVT_Play( const parammap& in_params, parammap&, intf_thread_t *p_intf )
+{
+    auto speed = in_params.find( "Speed" );
+    if( speed == in_params.end() )
+        return false;
+
+    vlc_player_Lock( p_intf->p_sys->player );
+    vlc_player_ChangeRate( p_intf->p_sys->player,
+                           frac_to_float( speed->second ) );
+    vlc_player_Resume( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    return true;
+}
+
+static bool
+handle_AVT_Pause( const parammap&, parammap&, intf_thread_t *p_intf )
+{
+    vlc_player_Lock( p_intf->p_sys->player );
+    vlc_player_Pause( p_intf->p_sys->player );
+    vlc_player_Unlock( p_intf->p_sys->player );
+
+    return true;
+}
+
+static bool
+handle_AVT_Seek( const parammap& in_params, parammap&, intf_thread_t *p_intf )
+{
+    auto unit = in_params.find( "Unit" );
+    if( unit == in_params.end() )
+        return false;
+
+    auto target = in_params.find( "Target" );
+    if( target == in_params.end() )
+        return false;
+
+    if( unit->second == "ABS_TIME" || unit->second == "REL_TIME" )
+    {
+        unsigned int h = 0, m = 0, s = 0;
+        if( !(sscanf( target->second.c_str(), "%u:%u:%u", &h, &m, &s ) == 3 ||
+              sscanf( target->second.c_str(), "%u:%u", &m, &s ) == 2) )
+            return false;
+        if( m >= 60 || s >= 60 )
+            return false;
+
+        vlc_player_Lock( p_intf->p_sys->player );
+        vlc_player_SeekByTime( p_intf->p_sys->player,
+                               VLC_TICK_FROM_SEC(h*60*60 + m*60 + s),
+                               VLC_PLAYER_SEEK_FAST,
+                               VLC_PLAYER_WHENCE_ABSOLUTE );
+        vlc_player_Unlock( p_intf->p_sys->player );
+    }
+
+    return true;
+}
+
+static bool
+handle_CM_GetProtocolInfo( const parammap&, parammap& out_params,
+                           intf_thread_t * )
+{
+    out_params["Source"] = "";
+    out_params["Sink"] = SINK_PROTOCOL_INFO;
+
+    return true;
+}
+
+static bool
+handle_RC_GetVolume( const parammap&, parammap& out_params,
+                     intf_thread_t *p_intf )
+{
+    /* Volume in range [0.0, 2.0] or -1.0 if no audio */
+    float volume = vlc_player_aout_GetVolume( p_intf->p_sys->player );
+
+    /* Enforce [0.0, 2.0] range */
+    volume = VLC_CLIP(volume, 0.0, 2.0);
+
+    /* Output [0, 100] range */
+    out_params["CurrentVolume"] = std::to_string( std::lround( volume * 50 ) );
+
+    return true;
+}
+
+static bool
+handle_RC_SetVolume( const parammap& in_params, parammap&,
+                     intf_thread_t *p_intf )
+{
+    /* Volume in range [0, 100] */
+    auto volume = in_params.find( "DesiredVolume" );
+    if( volume == in_params.end() )
+        return false;
+
+    /* Enforce [0, 100] range */
+    unsigned long v = VLC_CLIP(std::stoul( volume->second ), 0, 100);
+
+    /* Outputs [0.0, 2.0] range */
+    vlc_player_aout_SetVolume( p_intf->p_sys->player, v / 50.0 );
+
+    return true;
+}
+
+static bool
+handle_RC_GetMute( const parammap&, parammap& out_params,
+                   intf_thread_t *p_intf )
+{
+    bool muted = vlc_player_aout_IsMuted( p_intf->p_sys->player );
+
+    if( muted )
+        out_params["CurrentMute"] = "1";
+    else
+        out_params["CurrentMute"] = "0";
+
+    return true;
+}
+
+static bool
+handle_RC_SetMute( const parammap& in_params, parammap&,
+                   intf_thread_t *p_intf )
+{
+    auto mute = in_params.find( "DesiredMute" );
+    if( mute == in_params.end() )
+        return false;
+
+    std::string m = mute->second;
+
+    if( m == "1" || m == "true" || m == "yes" )
+        vlc_player_aout_Mute( p_intf->p_sys->player, true );
+    else if( m == "0" || m == "false" || m == "no" )
+        vlc_player_aout_Mute( p_intf->p_sys->player, false );
+
+    return true;
+}
+
+#define SRV_AVT "urn:upnp-org:serviceId:AVTransport"
+#define SRV_RC  "urn:upnp-org:serviceId:RenderingControl"
+#define SRV_CM  "urn:upnp-org:serviceId:ConnectionManager"
+
+static struct {
+    const char *service;
+    const char *action;
+    ActionRequestHandler handler;
+} actions[] = {
+    { SRV_AVT, "SetAVTransportURI", handle_AVT_SetAVTransportURI },
+    { SRV_AVT, "GetMediaInfo", handle_AVT_GetMediaInfo },
+    { SRV_AVT, "GetTransportInfo", handle_AVT_GetTransportInfo },
+    { SRV_AVT, "GetPositionInfo", handle_AVT_GetPositionInfo },
+    { SRV_AVT, "Stop", handle_AVT_Stop },
+    { SRV_AVT, "Play", handle_AVT_Play },
+    { SRV_AVT, "Pause", handle_AVT_Pause },
+    { SRV_AVT, "Seek", handle_AVT_Seek },
+    { SRV_CM, "GetProtocolInfo", handle_CM_GetProtocolInfo },
+    { SRV_RC, "GetVolume", handle_RC_GetVolume },
+    { SRV_RC, "SetVolume", handle_RC_SetVolume },
+    { SRV_RC, "GetMute", handle_RC_GetMute },
+    { SRV_RC, "SetMute", handle_RC_SetMute },
+    { NULL, NULL, NULL }
+};
+
+static parammap
+build_param_map( IXML_Node *p_node )
+{
+    parammap params;
+
+    for( IXML_Node *param = ixmlNode_getFirstChild( p_node );
+         param != NULL;
+         param = ixmlNode_getNextSibling( param ) )
+    {
+        const DOMString key = ixmlNode_getNodeName(param);
+        if( !key )
+            continue;
+
+        IXML_Node *vnode = ixmlNode_getFirstChild( param );
+        if( !vnode )
+            continue;
+
+        const DOMString value = ixmlNode_getNodeValue( vnode );
+        if( !value )
+            continue;
+
+        params[key] = value;
+    }
+
+    return params;
+}
+
+static std::unique_ptr<char>
+build_event_xml( const char **keys, const char **values, int count )
+{
+    IXML_Document *p_doc = ixmlDocument_createDocument();
+    if( !p_doc )
+        return nullptr;
+
+    auto deleter = [](IXML_Document *p_doc) {
+        ixmlDocument_free( p_doc );
+    };
+    /* Setup std::unique_ptr with deleter */
+    ixml_document_ptr doc( p_doc, deleter );
+
+    IXML_Element *event = ixmlDocument_createElement( doc.get(), "Event" );
+    if( !event )
+        return nullptr;
+
+    if( ixmlNode_appendChild( (IXML_Node *)doc.get(),
+                              (IXML_Node *)event ) != IXML_SUCCESS )
+    {
+        ixmlElement_free( event );
+        return nullptr;
+    }
+
+    IXML_Element *instance = ixmlDocument_createElement( doc.get(),
+                                                         "InstanceID" );
+    if( !instance )
+        return nullptr;
+
+    if( ixmlNode_appendChild( (IXML_Node *)event,
+                              (IXML_Node *)instance ) != IXML_SUCCESS )
+    {
+        ixmlElement_free( instance );
+        return nullptr;
+    }
+
+    if( ixmlElement_setAttribute( instance, "val", "0") != IXML_SUCCESS )
+        return nullptr;
+
+    for( int i = 0; i < count; i++ )
+    {
+        IXML_Element *arg = ixmlDocument_createElement( doc.get(), keys[i] );
+        if( !arg )
+            return nullptr;
+
+        if( ixmlNode_appendChild( (IXML_Node *)instance,
+                                  (IXML_Node *)arg ) != IXML_SUCCESS )
+        {
+            ixmlElement_free( arg );
+            return nullptr;
+        }
+
+        if( ixmlElement_setAttribute( arg, "val", values[i] ) != IXML_SUCCESS )
+            return nullptr;
+    }
+
+    std::unique_ptr<char> xmlbuf( ixmlNodetoString( (IXML_Node *)doc.get() ) );
+    if( !xmlbuf )
+        return nullptr;
+
+    return std::unique_ptr<char>( vlc_xml_encode( xmlbuf.get() ) );
+}
+
+static void
+emit_event( intf_thread_t *p_intf, const std::string& sid,
+            const std::string& key, const std::string& value )
+{
+    const char *event_keys[1] = { key.c_str() };
+    const char *event_values[1] = { value.c_str() };
+
+    std::unique_ptr<char> event_xml = build_event_xml( event_keys,
+                                                       event_values, 1 );
+    if( !event_xml )
+    {
+        /* If we failed to build XML for this event there we might as well
+           return early here because there's nothing to send. */
+        msg_Warn( p_intf, "Failed to build event XML" );
+        return;
+    }
+
+    const char *var_keys[1] = { "LastChange" };
+    const char *var_values[1] = { event_xml.get() };
+
+    int ret = UpnpNotify( p_intf->p_sys->p_upnp->device_handle(),
+                          UPNP_UDN,
+                          sid.c_str(),
+                          (const char **) &var_keys,
+                          (const char **) &var_values,
+                          1 );
+    if( ret != UPNP_E_SUCCESS )
+        msg_Dbg( p_intf, "UpnpNotify failed" );
+}
+
+int
+EventHandler::onActionRequest( UpnpActionRequest *p_event, void * )
+{
+    /* For example urn:upnp-org:serviceId:AVTransport */
+    const char *service_id = UpnpActionRequest_get_ServiceID_cstr( p_event );
+
+    /* For example SetAVTransportURI */
+    const char *action_name = UpnpActionRequest_get_ActionName_cstr( p_event );
+
+    /* "Body" XML node in the request */
+    IXML_Document *body = UpnpActionRequest_get_ActionRequest( p_event );
+    if( !body )
+        return 0;
+
+    for( IXML_Node *action = ixmlNode_getFirstChild( (IXML_Node*) body );
+         action != NULL;
+         action = ixmlNode_getNextSibling( action ) )
+    {
+        const parammap in_params = build_param_map( action );
+
+        for( size_t i = 0; actions[i].handler; i++ )
+        {
+            if( strcmp( actions[i].service, service_id ) ||
+                strcmp( actions[i].action, action_name ) )
+                continue;
+
+            parammap out_params;
+
+            int r = actions[i].handler( in_params, out_params, p_intf );
+            if( !r )
+                continue;
+
+            IXML_Document *d = UpnpMakeActionResponse( action_name,
+                                                       service_id,
+                                                       0,
+                                                       NULL );
+            if( !d )
+                continue;
+
+            UpnpActionRequest_set_ActionResult( p_event, d );
+
+            for( auto& x : out_params )
+            {
+                int r = UpnpAddToActionResponse( &d,
+                                                 action_name,
+                                                 service_id,
+                                                 x.first.c_str(),
+                                                 x.second.c_str() );
+                if( r != UPNP_E_SUCCESS )
+                {
+                    if( d )
+                        ixmlDocument_free( d );
+
+                    UpnpActionRequest_set_ActionResult( p_event, NULL );
+                    UpnpActionRequest_set_ErrCode( p_event, r );
+                    return r;
+                }
+            }
+
+            UpnpActionRequest_set_ErrCode( p_event, UPNP_E_SUCCESS );
+            return UPNP_E_SUCCESS;
+        }
+    }
+
+    UpnpActionRequest_set_ErrCode( p_event, UPNP_E_INTERNAL_ERROR );
+    return UPNP_E_INTERNAL_ERROR;
+}
+
+int
+EventHandler::onGetVarRequest( UpnpStateVarRequest *, void * )
+{
+    // TODO
+    return 0;
+}
+
+int
+EventHandler::onSubscriptionRequest( UpnpSubscriptionRequest *p_event, void * )
+{
+    /* For example urn:upnmapp-org:serviceId:AVTransport */
+    const char *service_id =
+        UpnpSubscriptionRequest_get_ServiceId_cstr( p_event );
+
+    /* For example uuid:034fc8dc-ec22-44e5-a79b-38c935f11663 */
+    const char *udn = UpnpSubscriptionRequest_get_UDN_cstr( p_event );
+
+    /* For example uuid:d0874e24-a80b-11e9-9fd4-bed70abd916c */
+    const char *sid = UpnpSubscriptionRequest_get_SID_cstr( p_event );
+
+    std::unique_ptr<char> event_xml = build_event_xml( nullptr, nullptr, 0 );
+    if( !event_xml )
+        msg_Warn( p_intf, "Failed to build event XML" );
+
+    const char *var_keys[1] = { "LastChange" };
+    const char *var_values[1] = { event_xml.get() };
+
+    int ret = UpnpAcceptSubscription( p_intf->p_sys->p_upnp->device_handle(),
+                                      udn,
+                                      service_id,
+                                      (const char **) &var_keys,
+                                      (const char **) &var_values,
+                                      event_xml ? 1 : 0,
+                                      sid );
+    if( ret != UPNP_E_SUCCESS )
+        msg_Dbg( p_intf, "UpnpAcceptSubscription failed" );
+
+    return ret;
+}
+
+int
+EventHandler::onEvent( Upnp_EventType event_type, UpnpEventPtr p_event,
+                       void* p_user_data )
+{
+    switch( event_type )
+    {
+    case UPNP_CONTROL_ACTION_REQUEST:
+        return onActionRequest( (UpnpActionRequest *) p_event, p_user_data );
+    case UPNP_CONTROL_GET_VAR_REQUEST:
+        return onGetVarRequest( (UpnpStateVarRequest *) p_event, p_user_data );
+    case UPNP_EVENT_SUBSCRIPTION_REQUEST:
+        return onSubscriptionRequest( (UpnpSubscriptionRequest *) p_event,
+                                      p_user_data );
+    default:
+        return 0;
+    }
+}
+
+static void
+player_state_changed( vlc_player_t *, enum vlc_player_state state, void *data )
+{
+    intf_thread_t *p_intf = (intf_thread_t *)data;
+
+    const char *new_state;
+
+    switch (state)
+    {
+    case VLC_PLAYER_STATE_STOPPED:
+        new_state = "STOPPED";
+        break;
+    case VLC_PLAYER_STATE_PLAYING:
+        new_state = "PLAYING";
+        break;
+    case VLC_PLAYER_STATE_PAUSED:
+        new_state = "PAUSED_PLAYBACK";
+        break;
+    case VLC_PLAYER_STATE_STARTED: /* fall through */
+    case VLC_PLAYER_STATE_STOPPING:
+        new_state = "TRANSITIONING";
+        break;
+    default:
+        new_state = "UNKNOWN";
+        break;
+    }
+
+    emit_event( p_intf, SRV_AVT, "TransportState", new_state );
+}
+
+static void
+player_rate_changed( vlc_player_t *, float new_rate, void *data )
+{
+    intf_thread_t *p_intf = (intf_thread_t *)data;
+
+    emit_event( p_intf, SRV_AVT, "TransportPlaySpeed",
+                float_to_frac( new_rate ) );
+}
+
+static void
+player_aout_volume_changed( vlc_player_t *, float new_volume, void *data )
+{
+    intf_thread_t *p_intf = (intf_thread_t *) data;
+
+    new_volume = VLC_CLIP(new_volume, 0.0, 2.0);
+
+    /* Volume in range [0, 100] */
+    std::string v = std::to_string( std::lround( new_volume * 50 ) );
+
+    emit_event( p_intf, SRV_RC, "Volume", v );
+}
+
+static void
+player_aout_mute_changed( vlc_player_t *, bool new_mute, void *data )
+{
+    intf_thread_t *p_intf = (intf_thread_t *) data;
+
+    std::string m = new_mute ? "1" : "0";
+
+    emit_event( p_intf, SRV_RC, "Mute", m );
+}
+
+} // namespace anonymous
+
+namespace DLNA
+{
+
+int
+OpenControl( vlc_object_t *p_this )
+{
+    intf_thread_t *p_intf = (intf_thread_t *)p_this;
+
+    intf_sys_t *p_sys = p_intf->p_sys = new (std::nothrow) intf_sys_t;
+    if( !p_sys )
+        return VLC_EGENERIC;
+
+    p_sys->playlist = vlc_intf_GetMainPlaylist( p_intf );
+    if( !p_sys->playlist )
+        goto error;
+
+    p_sys->player = vlc_playlist_GetPlayer( p_sys->playlist );
+    if( !p_sys->player )
+        goto error;
+
+    {
+        auto p_upnp = UpnpInstanceWrapper::get( p_this );
+        if( !p_upnp )
+            goto error;
+
+        auto deleter = [](auto *p_upnp) {
+            p_upnp->release();
+        };
+        /* Setup std::unique_ptr with deleter */
+        p_sys->p_upnp = upnp_ptr( p_upnp, deleter );
+    }
+
+    try
+    {
+        p_sys->p_listener = std::make_shared<EventHandler>( p_intf );
+    }
+    catch( const std::bad_alloc& )
+    {
+        goto error;
+    }
+
+    p_sys->p_upnp->addListener( p_sys->p_listener );
+
+    /* Start the UPnP MediaRenderer service */
+    p_sys->p_upnp->startMediaRenderer( p_this );
+
+    static struct vlc_player_cbs player_cbs = {};
+    player_cbs.on_state_changed = player_state_changed;
+    player_cbs.on_rate_changed = player_rate_changed;
+
+    {
+        vlc_playlist_Lock( p_sys->playlist );
+        auto p_listener_id =
+            vlc_player_AddListener( p_sys->player,
+                                    &player_cbs,
+                                    p_intf );
+        vlc_playlist_Unlock( p_sys->playlist );
+        if( !p_listener_id )
+            goto error;
+
+        auto deleter = [p_sys](auto *p_listener_id) {
+            vlc_playlist_Lock( p_sys->playlist );
+            vlc_player_RemoveListener( p_sys->player, p_listener_id );
+            vlc_playlist_Unlock( p_sys->playlist );
+        };
+        /* Setup std::unique_ptr with custom deleter */
+        p_sys->p_player_listener =
+            player_listener_ptr(p_listener_id, deleter);
+    }
+
+    static struct vlc_player_aout_cbs player_aout_cbs = {};
+    player_aout_cbs.on_volume_changed = player_aout_volume_changed;
+    player_aout_cbs.on_mute_changed = player_aout_mute_changed;
+
+    {
+        vlc_playlist_Lock( p_sys->playlist );
+        auto p_listener_id =
+            vlc_player_aout_AddListener( p_sys->player,
+                                         &player_aout_cbs,
+                                         p_intf );
+        vlc_playlist_Unlock( p_sys->playlist );
+        if( !p_listener_id )
+            goto error;
+
+        auto deleter = [p_sys](auto *p_listener_id) {
+            vlc_playlist_Lock( p_sys->playlist );
+            vlc_player_aout_RemoveListener( p_sys->player, p_listener_id );
+            vlc_playlist_Unlock( p_sys->playlist );
+        };
+        /* Setup std::unique_ptr with custom deleter */
+        p_sys->p_player_aout_listener =
+            player_aout_listener_ptr(p_listener_id, deleter);
+    }
+
+    msg_Info( p_this, "Started MediaRenderer service" );
+
+    return VLC_SUCCESS;
+
+error:
+    delete p_sys;
+
+    return VLC_EGENERIC;
+}
+
+void
+CloseControl( vlc_object_t *p_this )
+{
+    intf_thread_t *p_intf = (intf_thread_t *)p_this;
+
+    intf_sys_t *p_sys = p_intf->p_sys;
+
+    p_sys->p_upnp->removeListener( p_sys->p_listener );
+
+    /* Stop the UPnP MediaRenderer service */
+    p_sys->p_upnp->stopMediaRenderer( p_this );
+
+    delete p_sys;
+
+    msg_Info( p_this, "Stopped MediaRenderer service" );
+}
+
+} // namespace DLNA
diff --git a/modules/control/dlna.hpp b/modules/control/dlna.hpp
new file mode 100644
index 0000000000..a6beb25f0e
--- /dev/null
+++ b/modules/control/dlna.hpp
@@ -0,0 +1,93 @@
+/*****************************************************************************
+ * dlna.hpp :  DLNA MediaRenderer module
+ *****************************************************************************
+ * Copyright (C) 2019 VLC authors and VideoLAN
+ *
+ * Authors: Johan Gunnarsson <johan.gunnarsson at gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifndef CONTROL_DLNA_H
+#define CONTROL_DLNA_H
+
+#include "../services_discovery/upnp-wrapper.hpp"
+
+#include <vlc_plugin.h>
+#include <vlc_interface.h>
+
+#if UPNP_VERSION < 10623
+/* For compatibility with libupnp older than 1.6.23 */
+typedef struct Upnp_Action_Request UpnpActionRequest;
+#define UpnpActionRequest_get_ActionName_cstr(x) ((x)->ActionName)
+#define UpnpActionRequest_get_ServiceID_cstr(x) ((x)->ServiceID)
+#define UpnpActionRequest_get_DevUDN_cstr(x) ((x)->DevUDN)
+#define UpnpActionRequest_get_ActionRequest(x) ((x)->ActionRequest)
+typedef struct Upnp_State_Var_Request UpnpStateVarRequest;
+#define UpnpStateVarRequest_get_StateVarName_cstr(x) ((x)->StateVarName)
+#define UpnpStateVarRequest_get_ServiceID_cstr(x) ((x)->ServiceID)
+#define UpnpStateVarRequest_get_DevUDN_cstr(x) ((x)->DevUDN)
+typedef struct Upnp_Subscription_Request UpnpSubscriptionRequest;
+#define UpnpSubscriptionRequest_get_ServiceId_cstr(x) ((x)->ServiceId)
+#define UpnpSubscriptionRequest_get_SID_cstr(x) ((x)->Sid)
+#define UpnpSubscriptionRequest_get_UDN_cstr(x) ((x)->UDN)
+#endif
+
+#if UPNP_VERSION < 10800
+/* For compatibility with libupnp older than 1.8.0 */
+#define UpnpActionRequest_set_ErrCode(x, y) ((x)->ErrCode = (y))
+#define UpnpActionRequest_set_ErrStr_cstr(x, y) ((x)->ErrStr = (y))
+#define UpnpActionRequest_set_ActionResult(x, y) ((x)->ActionResult = (y))
+#endif
+
+namespace
+{
+
+class EventHandler : public UpnpInstanceWrapper::Listener
+{
+public:
+    EventHandler( intf_thread_t *_p_intf )
+        : p_intf( _p_intf )
+    {
+    }
+
+    int onEvent( Upnp_EventType event_type,
+                 UpnpEventPtr p_event,
+                 void *p_user_data ) override;
+
+private:
+    intf_thread_t *p_intf;
+
+    int onActionRequest( UpnpActionRequest *p_event,
+                         void *p_user_data );
+
+    int onGetVarRequest( UpnpStateVarRequest *p_event,
+                         void *p_user_data );
+
+    int onSubscriptionRequest( UpnpSubscriptionRequest *p_event,
+                               void *p_user_data );
+};
+
+} // namespace anonymous
+
+namespace DLNA
+{
+
+int OpenControl( vlc_object_t *p_this );
+void CloseControl( vlc_object_t *p_this );
+
+} // namespace DLNA
+
+#endif
diff --git a/modules/services_discovery/Makefile.am b/modules/services_discovery/Makefile.am
index 72c21efb56..65af52edf8 100644
--- a/modules/services_discovery/Makefile.am
+++ b/modules/services_discovery/Makefile.am
@@ -31,7 +31,9 @@ libupnp_plugin_la_SOURCES = services_discovery/upnp.cpp services_discovery/upnp.
 			    stream_out/dlna/profile_names.hpp \
 			    stream_out/dlna/dlna_common.hpp \
 			    stream_out/dlna/dlna.hpp \
-			    stream_out/dlna/dlna.cpp
+			    stream_out/dlna/dlna.cpp \
+			    control/dlna.hpp \
+			    control/dlna.cpp
 libupnp_plugin_la_CXXFLAGS = $(AM_CXXFLAGS) $(UPNP_CFLAGS)
 libupnp_plugin_la_LDFLAGS = $(AM_LDFLAGS) -rpath '$(sddir)'
 libupnp_plugin_la_LIBADD = $(UPNP_LIBS)
diff --git a/modules/services_discovery/upnp.cpp b/modules/services_discovery/upnp.cpp
index 72644d0565..4dedfe91b0 100644
--- a/modules/services_discovery/upnp.cpp
+++ b/modules/services_discovery/upnp.cpp
@@ -43,6 +43,9 @@
 #include <set>
 #include <string>
 
+#include "../stream_out/dlna/dlna_common.hpp"
+#include "../control/dlna.hpp"
+
 /*
  * Constants
 */
@@ -180,6 +183,13 @@ vlc_module_begin()
         add_string(SOUT_CFG_PREFIX "base_url", NULL, BASE_URL_TEXT, BASE_URL_LONGTEXT, false)
         add_string(SOUT_CFG_PREFIX "url", NULL, URL_TEXT, URL_LONGTEXT, false)
         add_renderer_opts(SOUT_CFG_PREFIX)
+
+    add_submodule()
+        set_description( N_("UPnP/DLNA MediaRenderer") )
+        set_category( CAT_INTERFACE )
+        set_subcategory( SUBCAT_INTERFACE_CONTROL )
+        set_callbacks( DLNA::OpenControl, DLNA::CloseControl )
+        set_capability( "interface", 0 )
 vlc_module_end()
 
 /*
diff --git a/modules/services_discovery/upnp.hpp b/modules/services_discovery/upnp.hpp
index 4eef534f91..b257367000 100644
--- a/modules/services_discovery/upnp.hpp
+++ b/modules/services_discovery/upnp.hpp
@@ -28,7 +28,6 @@
 #include <string>
 
 #include "upnp-wrapper.hpp"
-#include "../stream_out/dlna/dlna_common.hpp"
 
 #include <vlc_url.h>
 #include <vlc_interrupt.h>
-- 
2.17.1



More information about the vlc-devel mailing list