modules/stream_out/standard.c

   1 /*****************************************************************************
   2  * standard.c: standard stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2003-2011 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_sout.h>
  34
  35 #include <vlc_network.h>
  36 #include <vlc_url.h>
  37 #include <vlc_memstream.h>
  38
  39 /*****************************************************************************
  40  * Module descriptor
  41  *****************************************************************************/
  42 #define ACCESS_TEXT N_("Output access method")
  43 #define ACCESS_LONGTEXT N_( \
  44     "Output method to use for the stream." )
  45 #define MUX_TEXT N_("Output muxer")
  46 #define MUX_LONGTEXT N_( \
  47     "Muxer to use for the stream." )
  48 #define DEST_TEXT N_("Output destination")
  49 #define DEST_LONGTEXT N_( \
  50     "Destination (URL) to use for the stream. Overrides path and bind parameters" )
  51 #define BIND_TEXT N_("Address to bind to (helper setting for dst)")
  52 #define BIND_LONGTEXT N_( \
  53   "address:port to bind vlc to listening incoming streams. "\
  54   "Helper setting for dst, dst=bind+'/'+path. dst-parameter overrides this." )
  55 #define PATH_TEXT N_("Filename for stream (helper setting for dst)")
  56 #define PATH_LONGTEXT N_( \
  57   "Filename for stream. "\
  58   "Helper setting for dst, dst=bind+'/'+path. dst-parameter overrides this." )
  59 #define NAME_TEXT N_("Session name")
  60 #define NAME_LONGTEXT N_( \
  61     "This is the name of the session that will be announced in the SDP " \
  62     "(Session Descriptor)." )
  63 #define DESC_TEXT N_("Session description")
  64 #define DESC_LONGTEXT N_( \
  65     "This allows you to give a short description with details about the stream, " \
  66     "that will be announced in the SDP (Session Descriptor)." )
  67 #define URL_TEXT N_("Session URL")
  68 #define URL_LONGTEXT N_( \
  69     "This allows you to give a URL with more details about the stream " \
  70     "(often the website of the streaming organization), that will " \
  71     "be announced in the SDP (Session Descriptor)." )
  72 #define EMAIL_TEXT N_("Session email")
  73 #define EMAIL_LONGTEXT N_( \
  74     "This allows you to give a contact mail address for the stream, that will " \
  75     "be announced in the SDP (Session Descriptor)." )
  76
  77 #define SAP_TEXT N_("SAP announcing")
  78 #define SAP_LONGTEXT N_("Announce this session with SAP.")
  79
  80 static int      Open    ( vlc_object_t * );
  81 static void     Close   ( vlc_object_t * );
  82
  83 #define SOUT_CFG_PREFIX "sout-standard-"
  84
  85 #ifdef ENABLE_SRT
  86 #define SRT_SHORTCUT "srt"
  87 #else
  88 #define SRT_SHORTCUT
  89 #endif
  90
  91 vlc_module_begin ()
  92     set_shortname( N_("Standard"))
  93     set_description( N_("Standard stream output") )
  94     set_capability( "sout stream", 50 )
  95     add_shortcut( "standard", "std", "file", "http", "udp", SRT_SHORTCUT )
  96     set_category( CAT_SOUT )
  97     set_subcategory( SUBCAT_SOUT_STREAM )
  98
  99     add_string( SOUT_CFG_PREFIX "access", "", ACCESS_TEXT, ACCESS_LONGTEXT, false )
 100     add_string( SOUT_CFG_PREFIX "mux", "", MUX_TEXT, MUX_LONGTEXT, false )
 101     add_string( SOUT_CFG_PREFIX "dst", "", DEST_TEXT, DEST_LONGTEXT, false )
 102     add_string( SOUT_CFG_PREFIX "bind", "", BIND_TEXT, BIND_LONGTEXT, false )
 103     add_string( SOUT_CFG_PREFIX "path", "", PATH_TEXT, PATH_LONGTEXT, false )
 104     add_bool(   SOUT_CFG_PREFIX "sap", false, SAP_TEXT, SAP_LONGTEXT, true )
 105     add_string( SOUT_CFG_PREFIX "name", "", NAME_TEXT, NAME_LONGTEXT, true )
 106     add_obsolete_string( SOUT_CFG_PREFIX "group" ) /* since 2.1.0 */
 107     add_string( SOUT_CFG_PREFIX "description", "", DESC_TEXT, DESC_LONGTEXT, true )
 108     add_string( SOUT_CFG_PREFIX "url", "", URL_TEXT, URL_LONGTEXT, true )
 109     add_string( SOUT_CFG_PREFIX "email", "", EMAIL_TEXT, EMAIL_LONGTEXT, true )
 110     add_obsolete_string( SOUT_CFG_PREFIX "phone" ) /* since 3.0.0 */
 111
 112     set_callbacks( Open, Close )
 113 vlc_module_end ()
 114
 115
 116 /*****************************************************************************
 117  * Exported prototypes
 118  *****************************************************************************/
 119 static const char *const ppsz_sout_options[] = {
 120     "access", "mux", "url", "dst",
 121     "sap", "name", "description", "url", "email",
 122     "bind", "path", NULL
 123 };
 124
 125 #define DEFAULT_PORT 1234
 126
 127 struct sout_stream_sys_t
 128 {
 129     sout_mux_t           *p_mux;
 130     session_descriptor_t *p_session;
 131 };
 132
 133 static sout_stream_id_sys_t * Add( sout_stream_t *p_stream, const es_format_t *p_fmt )
 134 {
 135     return (sout_stream_id_sys_t*)sout_MuxAddStream( p_stream->p_sys->p_mux, p_fmt );
 136 }
 137
 138 static void Del( sout_stream_t *p_stream, sout_stream_id_sys_t *id )
 139 {
 140     sout_MuxDeleteStream( p_stream->p_sys->p_mux, (sout_input_t*)id );
 141 }
 142
 143 static int Send( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
 144                  block_t *p_buffer )
 145 {
 146     return sout_MuxSendBuffer( p_stream->p_sys->p_mux, (sout_input_t*)id, p_buffer );
 147 }
 148
 149 static void Flush( sout_stream_t *p_stream, sout_stream_id_sys_t *id )
 150 {
 151     sout_MuxFlush( p_stream->p_sys->p_mux, (sout_input_t*)id );
 152 }
 153
 154 static void create_SDP(sout_stream_t *p_stream, sout_access_out_t *p_access)
 155 {
 156     sout_stream_sys_t   *p_sys = p_stream->p_sys;
 157
 158     static const struct addrinfo hints = {
 159         .ai_family = AF_UNSPEC,
 160         .ai_socktype = SOCK_DGRAM,
 161         .ai_protocol = 0,
 162         .ai_flags = AI_NUMERICHOST | AI_NUMERICSERV | AI_IDN,
 163     };
 164     char *shost = var_GetNonEmptyString (p_access, "src-addr");
 165     char *dhost = var_GetNonEmptyString (p_access, "dst-addr");
 166     int sport = var_GetInteger (p_access, "src-port");
 167     int dport = var_GetInteger (p_access, "dst-port");
 168     struct sockaddr_storage src, dst;
 169     socklen_t srclen = 0, dstlen = 0;
 170     struct addrinfo *res;
 171
 172     if (!vlc_getaddrinfo (dhost, dport, &hints, &res))
 173     {
 174         memcpy (&dst, res->ai_addr, dstlen = res->ai_addrlen);
 175         freeaddrinfo (res);
 176     }
 177
 178     if (!vlc_getaddrinfo (shost, sport, &hints, &res))
 179     {
 180         memcpy (&src, res->ai_addr, srclen = res->ai_addrlen);
 181         freeaddrinfo (res);
 182     }
 183
 184     struct vlc_memstream sdp;
 185
 186     if (vlc_sdp_Start(&sdp, VLC_OBJECT (p_stream), SOUT_CFG_PREFIX,
 187                       (struct sockaddr *)&src, srclen,
 188                       (struct sockaddr *)&dst, dstlen) == 0)
 189     {
 190         vlc_memstream_printf(&sdp, "m=video %d udp mpeg\r\n", dport);
 191
 192         /* Register the SDP with the SAP thread */
 193         if (vlc_memstream_close(&sdp) == 0)
 194         {
 195             msg_Dbg(p_stream, "Generated SDP:\n%s", sdp.ptr);
 196             p_sys->p_session =
 197                 sout_AnnounceRegisterSDP(p_stream, sdp.ptr, dhost);
 198             free(sdp.ptr);
 199         }
 200     }
 201     free(shost);
 202     free(dhost);
 203 }
 204
 205 static const char *getMuxFromAlias( const char *psz_alias )
 206 {
 207     static struct { const char alias[6]; const char mux[32]; } mux_alias[] =
 208     {
 209         { "avi", "avi" },
 210         { "ogg", "ogg" },
 211         { "ogm", "ogg" },
 212         { "ogv", "ogg" },
 213         { "flac","raw" },
 214         { "mp3", "raw" },
 215         { "mp4", "mp4" },
 216         { "mov", "mov" },
 217         { "moov","mov" },
 218         { "asf", "asf" },
 219         { "wma", "asf" },
 220         { "wmv", "asf" },
 221         { "trp", "ts" },
 222         { "ts",  "ts" },
 223         { "mpg", "ps" },
 224         { "mpeg","ps" },
 225         { "ps",  "ps" },
 226         { "mpeg1","mpeg1" },
 227         { "wav", "wav" },
 228         { "flv", "avformat{mux=flv}" },
 229         { "mkv", "avformat{mux=matroska}"},
 230         { "webm", "avformat{mux=webm}"},
 231     };
 232
 233     if( !psz_alias )
 234         return NULL;
 235
 236     for( size_t i = 0; i < sizeof mux_alias / sizeof *mux_alias; i++ )
 237         if( !strcasecmp( psz_alias, mux_alias[i].alias ) )
 238             return mux_alias[i].mux;
 239
 240     return NULL;
 241 }
 242
 243 static int fixAccessMux( sout_stream_t *p_stream, char **ppsz_mux,
 244                           char **ppsz_access, const char *psz_url )
 245 {
 246     char *psz_mux = *ppsz_mux;
 247     char *psz_access = *ppsz_access;
 248     if( !psz_mux )
 249     {
 250         const char *psz_ext = psz_url ? strrchr( psz_url, '.' ) : NULL;
 251         if( psz_ext )
 252             psz_ext++; /* use extension */
 253         const char *psz_mux_byext = getMuxFromAlias( psz_ext );
 254
 255         if( !psz_access )
 256         {
 257             if( !psz_mux_byext )
 258             {
 259                 msg_Err( p_stream, "no access _and_ no muxer" );
 260                 return 1;
 261             }
 262
 263             msg_Warn( p_stream,
 264                     "no access _and_ no muxer, extension gives file/%s",
 265                     psz_mux_byext );
 266             *ppsz_access = strdup("file");
 267             *ppsz_mux    = strdup(psz_mux_byext);
 268         }
 269         else
 270         {
 271             if( !strncmp( psz_access, "mmsh", 4 ) )
 272                 *ppsz_mux = strdup("asfh");
 273             else if (!strcmp (psz_access, "udp"))
 274                 *ppsz_mux = strdup("ts");
 275             else if( psz_mux_byext )
 276                 *ppsz_mux = strdup(psz_mux_byext);
 277             else
 278             {
 279                 msg_Err( p_stream, "no mux specified or found by extension" );
 280                 return 1;
 281             }
 282         }
 283     }
 284     else if( !psz_access )
 285     {
 286         if( !strncmp( psz_mux, "asfh", 4 ) )
 287             *ppsz_access = strdup("mmsh");
 288         else /* default file */
 289             *ppsz_access = strdup("file");
 290     }
 291     return 0;
 292 }
 293
 294 static bool exactMatch( const char *psz_target, const char *psz_string,
 295                         size_t i_len )
 296 {
 297     if ( strncmp( psz_target, psz_string, i_len ) )
 298         return false;
 299     else
 300         return ( psz_target[i_len] < 'a' || psz_target[i_len] > 'z' );
 301 }
 302
 303 static void checkAccessMux( sout_stream_t *p_stream, char *psz_access,
 304                             char *psz_mux )
 305 {
 306     if( exactMatch( psz_access, "mmsh", 4 ) && !exactMatch( psz_mux, "asfh", 4 ) )
 307         msg_Err( p_stream, "mmsh output is only valid with asfh mux" );
 308     else if( !exactMatch( psz_access, "file", 4 ) &&
 309              ( exactMatch( psz_mux, "mov", 3 ) || exactMatch( psz_mux, "mp4", 3 ) ) )
 310         msg_Err( p_stream, "mov and mp4 mux are only valid with file output" );
 311     else if( exactMatch( psz_access, "udp", 3 ) )
 312     {
 313         if( exactMatch( psz_mux, "ffmpeg", 6 ) || exactMatch( psz_mux, "avformat", 8 ) )
 314         {   /* why would you use ffmpeg's ts muxer ? YOU DON'T LOVE VLC ??? */
 315             char *psz_ffmpeg_mux = var_CreateGetString( p_stream, "sout-avformat-mux" );
 316             if( !psz_ffmpeg_mux || strncmp( psz_ffmpeg_mux, "mpegts", 6 ) )
 317                 msg_Err( p_stream, "UDP output is only valid with TS mux" );
 318             free( psz_ffmpeg_mux );
 319         }
 320         else if( !exactMatch( psz_mux, "ts", 2 ) )
 321             msg_Err( p_stream, "UDP output is only valid with TS mux" );
 322     }
 323 }
 324
 325 /*****************************************************************************
 326  * Open:
 327  *****************************************************************************/
 328 static int Open( vlc_object_t *p_this )
 329 {
 330     sout_stream_t       *p_stream = (sout_stream_t*)p_this;
 331     sout_stream_sys_t   *p_sys;
 332     char *psz_mux, *psz_access, *psz_url;
 333     sout_access_out_t   *p_access;
 334     int                 ret = VLC_EGENERIC;
 335
 336     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
 337                    p_stream->p_cfg );
 338
 339     psz_mux = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "mux" );
 340
 341     psz_access = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "access" );
 342     if( !psz_access )
 343         psz_access = strdup(p_stream->psz_name);
 344
 345     psz_url = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "dst" );
 346     if (!psz_url)
 347     {
 348         char *psz_bind = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "bind" );
 349         if( psz_bind )
 350         {
 351             char *psz_path = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "path" );
 352             if( psz_path )
 353             {
 354                 if( asprintf( &psz_url, "%s/%s", psz_bind, psz_path ) == -1 )
 355                     psz_url = NULL;
 356                 free(psz_bind);
 357                 free( psz_path );
 358             }
 359             else
 360                 psz_url = psz_bind;
 361         }
 362     }
 363
 364     p_sys = p_stream->p_sys = malloc( sizeof( sout_stream_sys_t) );
 365     if( !p_sys )
 366     {
 367         ret = VLC_ENOMEM;
 368         goto end;
 369     }
 370     p_sys->p_session = NULL;
 371
 372     if( fixAccessMux( p_stream, &psz_mux, &psz_access, psz_url ) )
 373         goto end;
 374
 375     checkAccessMux( p_stream, psz_access, psz_mux );
 376
 377     p_access = sout_AccessOutNew( p_stream, psz_access, psz_url );
 378     if( p_access == NULL )
 379     {
 380         msg_Err( p_stream, "no suitable sout access module for `%s/%s://%s'",
 381                  psz_access, psz_mux, psz_url );
 382         goto end;
 383     }
 384
 385     p_sys->p_mux = sout_MuxNew( p_stream->p_sout, psz_mux, p_access );
 386     if( !p_sys->p_mux )
 387     {
 388         const char *psz_mux_guess = getMuxFromAlias( psz_mux );
 389         if( psz_mux_guess && strcmp( psz_mux_guess, psz_mux ) )
 390         {
 391             msg_Dbg( p_stream, "Couldn't open mux `%s', trying `%s' instead",
 392                 psz_mux, psz_mux_guess );
 393             p_sys->p_mux = sout_MuxNew( p_stream->p_sout, psz_mux_guess, p_access );
 394         }
 395
 396         if( !p_sys->p_mux )
 397         {
 398             msg_Err( p_stream, "no suitable sout mux module for `%s/%s://%s'",
 399                 psz_access, psz_mux, psz_url );
 400
 401             sout_AccessOutDelete( p_access );
 402             goto end;
 403         }
 404     }
 405
 406     if( var_GetBool( p_stream, SOUT_CFG_PREFIX"sap" ) )
 407         create_SDP( p_stream, p_access );
 408
 409     p_stream->pf_add    = Add;
 410     p_stream->pf_del    = Del;
 411     p_stream->pf_send   = Send;
 412     p_stream->pf_flush  = Flush;
 413     if( !sout_AccessOutCanControlPace( p_access ) )
 414         p_stream->pace_nocontrol = true;
 415
 416     ret = VLC_SUCCESS;
 417
 418     msg_Dbg( p_this, "using `%s/%s://%s'", psz_access, psz_mux, psz_url );
 419
 420 end:
 421     if( ret != VLC_SUCCESS )
 422         free( p_sys );
 423     free( psz_access );
 424     free( psz_mux );
 425     free( psz_url );
 426
 427     return ret;
 428 }
 429
 430 /*****************************************************************************
 431  * Close:
 432  *****************************************************************************/
 433 static void Close( vlc_object_t * p_this )
 434 {
 435     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 436     sout_stream_sys_t *p_sys    = p_stream->p_sys;
 437     sout_access_out_t *p_access = p_sys->p_mux->p_access;
 438
 439     if( p_sys->p_session != NULL )
 440         sout_AnnounceUnRegister( p_stream, p_sys->p_session );
 441
 442     sout_MuxDelete( p_sys->p_mux );
 443     sout_AccessOutDelete( p_access );
 444
 445     free( p_sys );
 446 }