modules/stream_out/standard.c

   1 /*****************************************************************************
   2  * standard.c: standard stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2003-2007 the VideoLAN team
   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
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, 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 #ifndef _WIN32_WINNT
  32 # define _WIN32_WINNT 0x0500
  33 #endif
  34
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_sout.h>
  38
  39 #include <vlc_network.h>
  40 #include <vlc_url.h>
  41
  42 /*****************************************************************************
  43  * Module descriptor
  44  *****************************************************************************/
  45 #define ACCESS_TEXT N_("Output access method")
  46 #define ACCESS_LONGTEXT N_( \
  47     "Output method to use for the stream." )
  48 #define MUX_TEXT N_("Output muxer")
  49 #define MUX_LONGTEXT N_( \
  50     "Muxer to use for the stream." )
  51 #define DEST_TEXT N_("Output destination")
  52 #define DEST_LONGTEXT N_( \
  53     "Destination (URL) to use for the stream. Overrides path and bind parameters" )
  54 #define BIND_TEXT N_("address to bind to (helper setting for dst)")
  55 #define BIND_LONGTEXT N_( \
  56   "address:port to bind vlc to listening incoming streams "\
  57   "helper setting for dst,dst=bind+'/'+path. dst-parameter overrides this" )
  58 #define PATH_TEXT N_("filename for stream (helper setting for dst)")
  59 #define PATH_LONGTEXT N_( \
  60   "Filename for stream "\
  61   "helper setting for dst, dst=bind+'/'+path, dst-parameter overrides this" )
  62 #define NAME_TEXT N_("Session name")
  63 #define NAME_LONGTEXT N_( \
  64     "This is the name of the session that will be announced in the SDP " \
  65     "(Session Descriptor)." )
  66
  67 #define GROUP_TEXT N_("Session groupname")
  68 #define GROUP_LONGTEXT N_( \
  69   "This allows you to specify a group for the session, that will be announced "\
  70   "if you choose to use SAP." )
  71
  72 #define DESC_TEXT N_("Session description")
  73 #define DESC_LONGTEXT N_( \
  74     "This allows you to give a short description with details about the stream, " \
  75     "that will be announced in the SDP (Session Descriptor)." )
  76 #define URL_TEXT N_("Session URL")
  77 #define URL_LONGTEXT N_( \
  78     "This allows you to give an URL with more details about the stream " \
  79     "(often the website of the streaming organization), that will " \
  80     "be announced in the SDP (Session Descriptor)." )
  81 #define EMAIL_TEXT N_("Session email")
  82 #define EMAIL_LONGTEXT N_( \
  83     "This allows you to give a contact mail address for the stream, that will " \
  84     "be announced in the SDP (Session Descriptor)." )
  85 #define PHONE_TEXT N_("Session phone number")
  86 #define PHONE_LONGTEXT N_( \
  87     "This allows you to give a contact telephone number for the stream, that will " \
  88     "be announced in the SDP (Session Descriptor)." )
  89
  90
  91 #define SAP_TEXT N_("SAP announcing")
  92 #define SAP_LONGTEXT N_("Announce this session with SAP.")
  93
  94 static int      Open    ( vlc_object_t * );
  95 static void     Close   ( vlc_object_t * );
  96
  97 #define SOUT_CFG_PREFIX "sout-standard-"
  98
  99 vlc_module_begin ()
 100     set_shortname( N_("Standard"))
 101     set_description( N_("Standard stream output") )
 102     set_capability( "sout stream", 50 )
 103     add_shortcut( "standard", "std", "file", "http", "udp" )
 104     set_category( CAT_SOUT )
 105     set_subcategory( SUBCAT_SOUT_STREAM )
 106
 107     add_string( SOUT_CFG_PREFIX "access", "", ACCESS_TEXT,
 108                 ACCESS_LONGTEXT, false )
 109     add_string( SOUT_CFG_PREFIX "mux", "", MUX_TEXT,
 110                 MUX_LONGTEXT, false )
 111     add_string( SOUT_CFG_PREFIX "dst", "", DEST_TEXT,
 112                 DEST_LONGTEXT, false )
 113     add_string( SOUT_CFG_PREFIX "bind", "", BIND_TEXT,
 114                 BIND_LONGTEXT, false )
 115     add_string( SOUT_CFG_PREFIX "path", "", PATH_TEXT,
 116                 PATH_LONGTEXT, false )
 117
 118     add_bool( SOUT_CFG_PREFIX "sap", false, NULL, SAP_TEXT, SAP_LONGTEXT,
 119               true )
 120     add_string( SOUT_CFG_PREFIX "name", "", NAME_TEXT, NAME_LONGTEXT,
 121                                         true )
 122     add_string( SOUT_CFG_PREFIX "group", "", GROUP_TEXT, GROUP_LONGTEXT,
 123                                         true )
 124     add_string( SOUT_CFG_PREFIX "description", "", DESC_TEXT, DESC_LONGTEXT,
 125                                         true )
 126     add_string( SOUT_CFG_PREFIX "url", "", URL_TEXT, URL_LONGTEXT,
 127                                         true )
 128     add_string( SOUT_CFG_PREFIX "email", "", EMAIL_TEXT, EMAIL_LONGTEXT,
 129                                         true )
 130     add_string( SOUT_CFG_PREFIX "phone", "", PHONE_TEXT, PHONE_LONGTEXT,
 131                                         true )
 132     add_obsolete_bool( SOUT_CFG_PREFIX "sap-ipv6" )
 133
 134     set_callbacks( Open, Close )
 135 vlc_module_end ()
 136
 137
 138 /*****************************************************************************
 139  * Exported prototypes
 140  *****************************************************************************/
 141 static const char *const ppsz_sout_options[] = {
 142     "access", "mux", "url", "dst",
 143     "sap", "name", "group", "description", "url", "email", "phone",
 144     "bind", "path", NULL
 145 };
 146
 147 #define DEFAULT_PORT 1234
 148
 149 static sout_stream_id_t *Add ( sout_stream_t *, es_format_t * );
 150 static int               Del ( sout_stream_t *, sout_stream_id_t * );
 151 static int               Send( sout_stream_t *, sout_stream_id_t *, block_t* );
 152
 153 struct sout_stream_sys_t
 154 {
 155     sout_mux_t           *p_mux;
 156     session_descriptor_t *p_session;
 157 };
 158
 159 /*****************************************************************************
 160  * Open:
 161  *****************************************************************************/
 162 static int Open( vlc_object_t *p_this )
 163 {
 164     sout_stream_t       *p_stream = (sout_stream_t*)p_this;
 165     sout_instance_t     *p_sout = p_stream->p_sout;
 166     sout_stream_sys_t   *p_sys;
 167
 168     char *psz_mux;
 169     char *psz_access;
 170     char *psz_url=NULL;
 171     char *psz_bind;
 172     char *psz_path;
 173
 174     vlc_value_t val;
 175
 176     sout_access_out_t   *p_access;
 177     sout_mux_t          *p_mux;
 178
 179     const char          *psz_mux_byext = NULL;
 180
 181     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
 182                    p_stream->p_cfg );
 183
 184     psz_access = var_GetString( p_stream, SOUT_CFG_PREFIX "access" );
 185     if( EMPTY_STR(psz_access) )
 186     {
 187         if( !strcmp( p_stream->psz_name, "http" ) )
 188         {
 189             psz_access = strdup("http");
 190         }
 191         else if (!strcmp (p_stream->psz_name, "udp"))
 192         {
 193             psz_access = strdup("udp");
 194         }
 195         else if (!strcmp (p_stream->psz_name, "file"))
 196         {
 197             psz_access = strdup("file");
 198         }
 199     }
 200
 201     psz_mux = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "mux" );
 202     psz_bind = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "bind" );
 203     psz_path = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "path" );
 204
 205     if( psz_bind && psz_path )
 206     {
 207         if( asprintf( &psz_url, "%s/%s", psz_bind, psz_path ) == -1 )
 208             psz_url = NULL;
 209     }
 210     else if( psz_bind )
 211     {
 212         psz_url = psz_bind;
 213         psz_bind = NULL;
 214     }
 215     free( psz_path );
 216
 217     var_Get( p_stream, SOUT_CFG_PREFIX "dst", &val );
 218     if( *val.psz_string )
 219     {
 220         free( psz_url);
 221         psz_url = val.psz_string;
 222     }
 223     else
 224         free( val.psz_string );
 225
 226     p_sys = p_stream->p_sys = malloc( sizeof( sout_stream_sys_t) );
 227     if( !p_sys )
 228     {
 229         free( psz_access );
 230         free( psz_mux );
 231         free( psz_bind );
 232         free( psz_url );
 233         return VLC_ENOMEM;
 234     }
 235     p_stream->p_sys->p_session = NULL;
 236
 237     msg_Dbg( p_this, "creating `%s/%s://%s'", psz_access, psz_mux, psz_url );
 238
 239     /* ext -> muxer name */
 240     if( psz_url && strrchr( psz_url, '.' ) )
 241     {
 242         /* by extension */
 243         static struct { const char ext[6]; const char mux[32]; } exttomux[] =
 244         {
 245             { "avi", "avi" },
 246             { "ogg", "ogg" },
 247             { "ogm", "ogg" },
 248             { "ogv", "ogg" },
 249             { "flac","raw" },
 250             { "mp3", "raw" },
 251             { "mp4", "mp4" },
 252             { "mov", "mov" },
 253             { "moov","mov" },
 254             { "asf", "asf" },
 255             { "wma", "asf" },
 256             { "wmv", "asf" },
 257             { "trp", "ts" },
 258             { "ts",  "ts" },
 259             { "mpg", "ps" },
 260             { "mpeg","ps" },
 261             { "ps",  "ps" },
 262             { "mpeg1","mpeg1" },
 263             { "wav", "wav" },
 264             { "flv", "ffmpeg{mux=flv}" },
 265             { "mkv", "ffmpeg{mux=matroska}"},
 266             { "webm", "ffmpeg{mux=webm}"},
 267             { "",    "" }
 268         };
 269         const char *psz_ext = strrchr( psz_url, '.' ) + 1;
 270
 271         msg_Dbg( p_this, "extension is %s", psz_ext );
 272         for( int i = 0; exttomux[i].ext[0]; i++ )
 273         {
 274             if( !strcasecmp( psz_ext, exttomux[i].ext ) )
 275             {
 276                 psz_mux_byext = exttomux[i].mux;
 277                 break;
 278             }
 279         }
 280         msg_Dbg( p_this, "extension -> mux=%s", psz_mux_byext );
 281     }
 282
 283     /* We fix access/mux to valid couple */
 284
 285     if( !psz_access && !psz_mux )
 286     {
 287         if( psz_mux_byext )
 288         {
 289             msg_Warn( p_stream,
 290                       "no access _and_ no muxer, extension gives file/%s",
 291                       psz_mux_byext );
 292             psz_access = strdup("file");
 293             psz_mux    = strdup(psz_mux_byext);
 294         }
 295         else
 296         {
 297             msg_Err( p_stream, "no access _and_ no muxer (fatal error)" );
 298             free( psz_bind );
 299             free( psz_url );
 300             free( p_sys );
 301             return VLC_EGENERIC;
 302         }
 303     }
 304
 305     if( psz_access && !psz_mux )
 306     {
 307         /* access given, no mux */
 308         if( !strncmp( psz_access, "mmsh", 4 ) )
 309         {
 310             psz_mux = strdup("asfh");
 311         }
 312         else if (!strcmp (psz_access, "udp"))
 313         {
 314             psz_mux = strdup("ts");
 315         }
 316         else if( psz_mux_byext )
 317         {
 318             psz_mux = strdup(psz_mux_byext);
 319         }
 320         else
 321         {
 322             msg_Err( p_stream, "no mux specified or found by extension" );
 323             free( psz_access );
 324             free( psz_bind );
 325             free( psz_url );
 326             free( p_sys );
 327             return VLC_EGENERIC;
 328         }
 329     }
 330     else if( psz_mux && !psz_access )
 331     {
 332         /* mux given, no access */
 333         if( !strncmp( psz_mux, "asfh", 4 ) )
 334         {
 335             psz_access = strdup("mmsh");
 336         }
 337         else
 338         {
 339             /* default file */
 340             psz_access = strdup("file");
 341         }
 342     }
 343
 344     /* fix or warn of incompatible couple */
 345     if( !strncmp( psz_access, "mmsh", 4 ) &&
 346         strncmp( psz_mux, "asfh", 4 ) )
 347     {
 348         char *p = strchr( psz_mux,'{' );
 349
 350         msg_Warn( p_stream, "fixing to mmsh/asfh" );
 351         if( p )
 352         {
 353             if( asprintf( &p, "asfh%s", p ) == -1 )
 354                 p = NULL;
 355             free( psz_mux );
 356             psz_mux = p;
 357         }
 358         else
 359         {
 360             free( psz_mux );
 361             psz_mux = strdup("asfh");
 362         }
 363     }
 364     else if( !strncmp( psz_access, "udp", 3 ) )
 365     {
 366         if( !strncmp( psz_mux, "ffmpeg", 6 ) )
 367         {   /* why would you use ffmpeg's ts muxer ? YOU DON'T LOVE VLC ??? */
 368             char *psz_ffmpeg_mux = var_CreateGetString( p_this, "ffmpeg-mux" );
 369             if( !psz_ffmpeg_mux || strncmp( psz_ffmpeg_mux, "mpegts", 6 ) )
 370                 msg_Err( p_stream, "UDP is only valid with TS" );
 371             free( psz_ffmpeg_mux );
 372         }
 373         else if( strncmp( psz_mux, "ts", 2 ) )
 374         {
 375             msg_Err( p_stream, "UDP is only valid with TS" );
 376         }
 377     }
 378     else if( strncmp( psz_access, "file", 4 ) &&
 379              ( !strncmp( psz_mux, "mov", 3 ) ||
 380                !strncmp( psz_mux, "mp4", 3 ) ) )
 381     {
 382         msg_Err( p_stream, "mov and mp4 work only with file output" );
 383     }
 384
 385     msg_Dbg( p_this, "using `%s/%s://%s'", psz_access, psz_mux, psz_url );
 386
 387     /* *** find and open appropriate access module *** */
 388     p_access = sout_AccessOutNew( p_sout, psz_access, psz_url );
 389     if( p_access == NULL )
 390     {
 391         msg_Err( p_stream, "no suitable sout access module for `%s/%s://%s'",
 392                  psz_access, psz_mux, psz_url );
 393         free( psz_access );
 394         free( psz_mux );
 395         free( psz_bind );
 396         free( psz_url );
 397         free( p_sys );
 398         return VLC_EGENERIC;
 399     }
 400     msg_Dbg( p_stream, "access opened" );
 401
 402     /* *** find and open appropriate mux module *** */
 403     p_mux = sout_MuxNew( p_sout, psz_mux, p_access );
 404     if( p_mux == NULL )
 405     {
 406         msg_Err( p_stream, "no suitable sout mux module for `%s/%s://%s'",
 407                  psz_access, psz_mux, psz_url );
 408
 409         sout_AccessOutDelete( p_access );
 410         free( psz_access );
 411         free( psz_mux );
 412         free( psz_bind );
 413         free( psz_url );
 414         free( p_sys );
 415         return VLC_EGENERIC;
 416     }
 417     msg_Dbg( p_stream, "mux opened" );
 418
 419     /* *** Create the SAP Session structure *** */
 420     if( var_GetBool( p_stream, SOUT_CFG_PREFIX"sap" ) )
 421     {
 422         /* Create the SDP */
 423         static const struct addrinfo hints = {
 424             .ai_family = AF_UNSPEC,
 425             .ai_socktype = SOCK_DGRAM,
 426             .ai_protocol = 0,
 427             .ai_flags = AI_NUMERICHOST | AI_NUMERICSERV
 428         };
 429         char *shost = var_GetNonEmptyString (p_access, "src-addr");
 430         char *dhost = var_GetNonEmptyString (p_access, "dst-addr");
 431         int sport = var_GetInteger (p_access, "src-port");
 432         int dport = var_GetInteger (p_access, "dst-port");
 433         struct sockaddr_storage src, dst;
 434         socklen_t srclen = 0, dstlen = 0;
 435         struct addrinfo *res;
 436
 437         if ( vlc_getaddrinfo ( VLC_OBJECT(p_stream), dhost, dport, &hints, &res) == 0)
 438         {
 439             memcpy (&dst, res->ai_addr, dstlen = res->ai_addrlen);
 440             freeaddrinfo (res);
 441         }
 442
 443         if (vlc_getaddrinfo ( VLC_OBJECT(p_stream), shost, sport, &hints, &res) == 0)
 444         {
 445             memcpy (&src, res->ai_addr, srclen = res->ai_addrlen);
 446             freeaddrinfo (res);
 447         }
 448
 449         char *head = vlc_sdp_Start (VLC_OBJECT (p_stream), SOUT_CFG_PREFIX,
 450                                     (struct sockaddr *)&src, srclen,
 451                                     (struct sockaddr *)&dst, dstlen);
 452         free (shost);
 453
 454         char *psz_sdp = NULL;
 455         if (head != NULL)
 456         {
 457             if (asprintf (&psz_sdp, "%s"
 458                           "m=video %d udp mpeg\r\n", head, dport) == -1)
 459                 psz_sdp = NULL;
 460             free (head);
 461         }
 462
 463         /* Register the SDP with the SAP thread */
 464         if (psz_sdp != NULL)
 465         {
 466             announce_method_t *p_method = sout_SAPMethod ();
 467             msg_Dbg (p_stream, "Generated SDP:\n%s", psz_sdp);
 468
 469             p_sys->p_session =
 470                 sout_AnnounceRegisterSDP (p_sout, psz_sdp, dhost, p_method);
 471             sout_MethodRelease (p_method);
 472             free( psz_sdp );
 473         }
 474         free (dhost);
 475     }
 476
 477     p_stream->pf_add    = Add;
 478     p_stream->pf_del    = Del;
 479     p_stream->pf_send   = Send;
 480
 481     p_sys->p_mux = p_mux;
 482
 483     free( psz_access );
 484     free( psz_mux );
 485     free( psz_bind );
 486     free( psz_url );
 487
 488     if( !sout_AccessOutCanControlPace( p_access ) )
 489         p_sout->i_out_pace_nocontrol++;
 490
 491     return VLC_SUCCESS;
 492 }
 493
 494 /*****************************************************************************
 495  * Close:
 496  *****************************************************************************/
 497 static void Close( vlc_object_t * p_this )
 498 {
 499     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 500     sout_stream_sys_t *p_sys    = p_stream->p_sys;
 501     sout_access_out_t *p_access = p_sys->p_mux->p_access;
 502
 503     if( p_sys->p_session != NULL )
 504         sout_AnnounceUnRegister( p_stream->p_sout, p_sys->p_session );
 505
 506     sout_MuxDelete( p_sys->p_mux );
 507     if( !sout_AccessOutCanControlPace( p_access ) )
 508         p_stream->p_sout->i_out_pace_nocontrol--;
 509     sout_AccessOutDelete( p_access );
 510
 511     free( p_sys );
 512 }
 513
 514 struct sout_stream_id_t
 515 {
 516     sout_input_t *p_input;
 517 };
 518
 519
 520 static sout_stream_id_t * Add( sout_stream_t *p_stream, es_format_t *p_fmt )
 521 {
 522     sout_stream_sys_t *p_sys = p_stream->p_sys;
 523     sout_stream_id_t  *id;
 524
 525     id = malloc( sizeof( sout_stream_id_t ) );
 526     if( !id )
 527         return NULL;
 528
 529     if( ( id->p_input = sout_MuxAddStream( p_sys->p_mux, p_fmt ) ) == NULL )
 530     {
 531         free( id );
 532         return NULL;
 533     }
 534
 535     return id;
 536 }
 537
 538 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
 539 {
 540     sout_stream_sys_t *p_sys = p_stream->p_sys;
 541
 542     sout_MuxDeleteStream( p_sys->p_mux, id->p_input );
 543
 544     free( id );
 545
 546     return VLC_SUCCESS;
 547 }
 548
 549 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
 550                  block_t *p_buffer )
 551 {
 552     sout_stream_sys_t *p_sys = p_stream->p_sys;
 553
 554     sout_MuxSendBuffer( p_sys->p_mux, id->p_input, p_buffer );
 555
 556     return VLC_SUCCESS;
 557 }