]> git.sesse.net Git - vlc/blob - modules/stream_out/standard.c
Typos spotted by Philipp Weissenbacher.
[vlc] / 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 #include <vlc/vlc.h>
28 #include <vlc_sout.h>
29
30
31 #include <vlc_network.h>
32 #include "vlc_url.h"
33
34 /*****************************************************************************
35  * Module descriptor
36  *****************************************************************************/
37 #define ACCESS_TEXT N_("Output access method")
38 #define ACCESS_LONGTEXT N_( \
39     "Output method to use for the stream." )
40 #define MUX_TEXT N_("Output muxer")
41 #define MUX_LONGTEXT N_( \
42     "Muxer to use for the stream." )
43 #define DST_TEXT N_("Output destination")
44 #define DST_LONGTEXT N_( \
45     "Destination (URL) to use for the stream." )
46 #define NAME_TEXT N_("Session name")
47 #define NAME_LONGTEXT N_( \
48   "This allows you to specify a name for the session, that will be announced "\
49   "if you choose to use SAP." )
50
51 #define GROUP_TEXT N_("Session groupname")
52 #define GROUP_LONGTEXT N_( \
53   "This allows you to specify a group for the session, that will be announced "\
54   "if you choose to use SAP." )
55
56 #define DESC_TEXT N_("Session description")
57 #define DESC_LONGTEXT N_( \
58     "This allows you to give a short description with details about the stream, " \
59     "that will be announced in the SDP (Session Descriptor)." )
60 #define URL_TEXT N_("Session URL")
61 #define URL_LONGTEXT N_( \
62     "This allows you to give an URL with more details about the stream " \
63     "(often the website of the streaming organization), that will " \
64     "be announced in the SDP (Session Descriptor)." )
65 #define EMAIL_TEXT N_("Session email")
66 #define EMAIL_LONGTEXT N_( \
67     "This allows you to give a contact mail address for the stream, that will " \
68     "be announced in the SDP (Session Descriptor)." )
69 #define PHONE_TEXT N_("Session phone number")
70 #define PHONE_LONGTEXT N_( \
71     "This allows you to give a contact telephone number for the stream, that will " \
72     "be announced in the SDP (Session Descriptor)." )
73
74
75 #define SAP_TEXT N_("SAP announcing")
76 #define SAP_LONGTEXT N_("Announce this session with SAP.")
77
78 static int      Open    ( vlc_object_t * );
79 static void     Close   ( vlc_object_t * );
80
81 #define SOUT_CFG_PREFIX "sout-standard-"
82
83 vlc_module_begin();
84     set_shortname( _("Standard"));
85     set_description( _("Standard stream output") );
86     set_capability( "sout stream", 50 );
87     add_shortcut( "standard" );
88     add_shortcut( "std" );
89     set_category( CAT_SOUT );
90     set_subcategory( SUBCAT_SOUT_STREAM );
91
92     add_string( SOUT_CFG_PREFIX "access", "", NULL, ACCESS_TEXT,
93                 ACCESS_LONGTEXT, VLC_FALSE );
94     add_string( SOUT_CFG_PREFIX "mux", "", NULL, MUX_TEXT,
95                 MUX_LONGTEXT, VLC_FALSE );
96     add_string( SOUT_CFG_PREFIX "dst", "", NULL, DST_TEXT,
97                 DST_LONGTEXT, VLC_FALSE );
98
99     add_bool( SOUT_CFG_PREFIX "sap", VLC_FALSE, NULL, SAP_TEXT, SAP_LONGTEXT,
100               VLC_TRUE );
101     add_string( SOUT_CFG_PREFIX "name", "", NULL, NAME_TEXT, NAME_LONGTEXT,
102                                         VLC_TRUE );
103     add_string( SOUT_CFG_PREFIX "group", "", NULL, GROUP_TEXT, GROUP_LONGTEXT,
104                                         VLC_TRUE );
105     add_string( SOUT_CFG_PREFIX "description", "", NULL, DESC_TEXT, DESC_LONGTEXT,
106                                         VLC_TRUE );
107     add_string( SOUT_CFG_PREFIX "url", "", NULL, URL_TEXT, URL_LONGTEXT,
108                                         VLC_TRUE );
109     add_string( SOUT_CFG_PREFIX "email", "", NULL, EMAIL_TEXT, EMAIL_LONGTEXT,
110                                         VLC_TRUE );
111     add_string( SOUT_CFG_PREFIX "phone", "", NULL, PHONE_TEXT, PHONE_LONGTEXT,
112                                         VLC_TRUE );
113     add_obsolete_bool( SOUT_CFG_PREFIX "sap-ipv6" );
114
115     set_callbacks( Open, Close );
116 vlc_module_end();
117
118
119 /*****************************************************************************
120  * Exported prototypes
121  *****************************************************************************/
122 static const char *ppsz_sout_options[] = {
123     "access", "mux", "url", "dst",
124     "sap", "name", "group", "description", "url", "email", "phone", NULL
125 };
126
127 #define DEFAULT_PORT 1234
128
129 static sout_stream_id_t *Add ( sout_stream_t *, es_format_t * );
130 static int               Del ( sout_stream_t *, sout_stream_id_t * );
131 static int               Send( sout_stream_t *, sout_stream_id_t *, block_t* );
132
133 struct sout_stream_sys_t
134 {
135     sout_mux_t           *p_mux;
136     session_descriptor_t *p_session;
137 };
138
139 /*****************************************************************************
140  * Open:
141  *****************************************************************************/
142 static int Open( vlc_object_t *p_this )
143 {
144     sout_stream_t       *p_stream = (sout_stream_t*)p_this;
145     sout_instance_t     *p_sout = p_stream->p_sout;
146     sout_stream_sys_t   *p_sys;
147
148     char *psz_mux;
149     char *psz_access;
150     char *psz_url;
151
152     vlc_value_t val;
153
154     sout_access_out_t   *p_access;
155     sout_mux_t          *p_mux;
156
157     const char          *psz_mux_byext = NULL;
158
159     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
160                    p_stream->p_cfg );
161
162     var_Get( p_stream, SOUT_CFG_PREFIX "access", &val );
163     psz_access = *val.psz_string ? val.psz_string : NULL;
164     if( !*val.psz_string ) free( val.psz_string );
165
166     var_Get( p_stream, SOUT_CFG_PREFIX "mux", &val );
167     psz_mux = *val.psz_string ? val.psz_string : NULL;
168     if( !*val.psz_string ) free( val.psz_string );
169
170
171     var_Get( p_stream, SOUT_CFG_PREFIX "dst", &val );
172     psz_url = *val.psz_string ? val.psz_string : NULL;
173     if( !*val.psz_string ) free( val.psz_string );
174
175     p_sys = p_stream->p_sys = malloc( sizeof( sout_stream_sys_t) );
176     p_stream->p_sys->p_session = NULL;
177
178     msg_Dbg( p_this, "creating `%s/%s://%s'", psz_access, psz_mux, psz_url );
179
180     /* ext -> muxer name */
181     if( psz_url && strrchr( psz_url, '.' ) )
182     {
183         /* by extension */
184         static struct { const char ext[6]; const char mux[32]; } exttomux[] =
185         {
186             { "avi", "avi" },
187             { "ogg", "ogg" },
188             { "ogm", "ogg" },
189             { "mp4", "mp4" },
190             { "mov", "mov" },
191             { "moov","mov" },
192             { "asf", "asf" },
193             { "wma", "asf" },
194             { "wmv", "asf" },
195             { "trp", "ts" },
196             { "ts",  "ts" },
197             { "mpg", "ps" },
198             { "mpeg","ps" },
199             { "ps",  "ps" },
200             { "mpeg1","mpeg1" },
201             { "wav", "wav" },
202             { "flv", "ffmpeg{mux=flv}" },
203             { "mkv", "ffmpeg{mux=matroska}"},
204             { "",    "" }
205         };
206         const char *psz_ext = strrchr( psz_url, '.' ) + 1;
207         int  i;
208
209         msg_Dbg( p_this, "extension is %s", psz_ext );
210         for( i = 0; exttomux[i].ext[0]; i++ )
211         {
212             if( !strcasecmp( psz_ext, exttomux[i].ext ) )
213             {
214                 psz_mux_byext = exttomux[i].mux;
215                 break;
216             }
217         }
218         msg_Dbg( p_this, "extension -> mux=%s", psz_mux_byext );
219     }
220
221     /* We fix access/mux to valid couple */
222
223     if( !psz_access && !psz_mux )
224     {
225         if( psz_mux_byext )
226         {
227             msg_Warn( p_stream,
228                       "no access _and_ no muxer, extension gives file/%s",
229                       psz_mux_byext );
230             psz_access = strdup("file");
231             psz_mux    = strdup(psz_mux_byext);
232         }
233         else
234         {
235             msg_Err( p_stream, "no access _and_ no muxer (fatal error)" );
236             return VLC_EGENERIC;
237         }
238     }
239
240     if( psz_access && !psz_mux )
241     {
242         /* access given, no mux */
243         if( !strncmp( psz_access, "mmsh", 4 ) )
244         {
245             psz_mux = strdup("asfh");
246         }
247         else if (!strcmp (psz_access, "udp")
248               || !strcmp (psz_access, "rtp"))
249         {
250             psz_mux = strdup("ts");
251         }
252         else if( psz_mux_byext )
253         {
254             psz_mux = strdup(psz_mux_byext);
255         }
256         else
257         {
258             msg_Err( p_stream, "no mux specified or found by extension" );
259             return VLC_EGENERIC;
260         }
261     }
262     else if( psz_mux && !psz_access )
263     {
264         /* mux given, no access */
265         if( !strncmp( psz_mux, "asfh", 4 ) )
266         {
267             psz_access = strdup("mmsh");
268         }
269         else
270         {
271             /* default file */
272             psz_access = strdup("file");
273         }
274     }
275
276     /* fix or warn of incompatible couple */
277     if( !strncmp( psz_access, "mmsh", 4 ) &&
278         strncmp( psz_mux, "asfh", 4 ) )
279     {
280         char *p = strchr( psz_mux,'{' );
281
282         msg_Warn( p_stream, "fixing to mmsh/asfh" );
283         if( p )
284         {
285             if( asprintf( &p, "asfh%s", p ) == -1 )
286                 p = NULL;
287             free( psz_mux );
288             psz_mux = p;
289         }
290         else
291         {
292             free( psz_mux );
293             psz_mux = strdup("asfh");
294         }
295     }
296     else if( ( !strncmp( psz_access, "rtp", 3 ) ||
297                !strncmp( psz_access, "udp", 3 ) ) &&
298              strncmp( psz_mux, "ts", 2 ) )
299     {
300         msg_Err( p_stream, "UDP and RTP are only valid with TS" );
301     }
302     else if( strncmp( psz_access, "file", 4 ) &&
303              ( !strncmp( psz_mux, "mov", 3 ) ||
304                !strncmp( psz_mux, "mp4", 3 ) ) )
305     {
306         msg_Err( p_stream, "mov and mp4 work only with file output" );
307     }
308
309     msg_Dbg( p_this, "using `%s/%s://%s'", psz_access, psz_mux, psz_url );
310
311     /* *** find and open appropriate access module *** */
312     p_access = sout_AccessOutNew( p_sout, psz_access, psz_url );
313     if( p_access == NULL )
314     {
315         msg_Err( p_stream, "no suitable sout access module for `%s/%s://%s'",
316                  psz_access, psz_mux, psz_url );
317         free( psz_access );
318         free( psz_mux );
319         return VLC_EGENERIC;
320     }
321     msg_Dbg( p_stream, "access opened" );
322
323     /* *** find and open appropriate mux module *** */
324     p_mux = sout_MuxNew( p_sout, psz_mux, p_access );
325     if( p_mux == NULL )
326     {
327         msg_Err( p_stream, "no suitable sout mux module for `%s/%s://%s'",
328                  psz_access, psz_mux, psz_url );
329
330         sout_AccessOutDelete( p_access );
331         free( psz_access );
332         free( psz_mux );
333         return VLC_EGENERIC;
334     }
335     msg_Dbg( p_stream, "mux opened" );
336
337     /* *** Create the SAP Session structure *** */
338     if( var_GetBool( p_stream, SOUT_CFG_PREFIX"sap" ) )
339     {
340         /* Create the SDP */
341         char *shost = var_GetNonEmptyString (p_access, "src-addr");
342         char *dhost = var_GetNonEmptyString (p_access, "dst-addr");
343         int sport = var_GetInteger (p_access, "src-port");
344         int dport = var_GetInteger (p_access, "dst-port");
345         struct sockaddr_storage src, dst;
346         socklen_t srclen = 0, dstlen = 0;
347
348         struct addrinfo *res;
349         if (vlc_getaddrinfo (VLC_OBJECT (p_stream), dhost, dport, NULL, &res) == 0)
350         {
351             memcpy (&dst, res->ai_addr, dstlen = res->ai_addrlen);
352             vlc_freeaddrinfo (res);
353         }
354
355         if (vlc_getaddrinfo (VLC_OBJECT (p_stream), shost, sport, NULL, &res) == 0)
356         {
357             memcpy (&src, res->ai_addr, srclen = res->ai_addrlen);
358             vlc_freeaddrinfo (res);
359         }
360
361         char *head = vlc_sdp_Start (VLC_OBJECT (p_stream), SOUT_CFG_PREFIX,
362                                     (struct sockaddr *)&src, srclen,
363                                     (struct sockaddr *)&dst, dstlen);
364         free (shost);
365
366         char *psz_sdp = NULL;
367         if (head != NULL)
368         {
369             if (asprintf (&psz_sdp, "%s"
370                           "m=video %d udp mpeg\r\n", head, dport) == -1)
371                 psz_sdp = NULL;
372             free (head);
373         }
374
375         /* Register the SDP with the SAP thread */
376         if (psz_sdp != NULL)
377         {
378             announce_method_t *p_method = sout_SAPMethod ();
379             msg_Dbg (p_stream, "Generated SDP:\n%s", psz_sdp);
380
381             p_sys->p_session =
382                 sout_AnnounceRegisterSDP (p_sout, SOUT_CFG_PREFIX, psz_sdp,
383                                           dhost, p_method);
384             sout_MethodRelease (p_method);
385         }
386         free (dhost);
387     }
388
389     p_stream->pf_add    = Add;
390     p_stream->pf_del    = Del;
391     p_stream->pf_send   = Send;
392
393     p_sys->p_mux = p_mux;
394
395     free( psz_access );
396     free( psz_mux );
397     free( psz_url );
398
399     return VLC_SUCCESS;
400 }
401
402 /*****************************************************************************
403  * Close:
404  *****************************************************************************/
405 static void Close( vlc_object_t * p_this )
406 {
407     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
408     sout_stream_sys_t *p_sys    = p_stream->p_sys;
409     sout_access_out_t *p_access = p_sys->p_mux->p_access;
410
411     if( p_sys->p_session != NULL )
412         sout_AnnounceUnRegister( p_stream->p_sout, p_sys->p_session );
413
414     sout_MuxDelete( p_sys->p_mux );
415     sout_AccessOutDelete( p_access );
416
417     free( p_sys );
418 }
419
420 struct sout_stream_id_t
421 {
422     sout_input_t *p_input;
423 };
424
425
426 static sout_stream_id_t * Add( sout_stream_t *p_stream, es_format_t *p_fmt )
427 {
428     sout_stream_sys_t *p_sys = p_stream->p_sys;
429     sout_stream_id_t  *id;
430
431     id = malloc( sizeof( sout_stream_id_t ) );
432     if( ( id->p_input = sout_MuxAddStream( p_sys->p_mux, p_fmt ) ) == NULL )
433     {
434         free( id );
435
436         return NULL;
437     }
438
439     return id;
440 }
441
442 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
443 {
444     sout_stream_sys_t *p_sys = p_stream->p_sys;
445
446     sout_MuxDeleteStream( p_sys->p_mux, id->p_input );
447
448     free( id );
449
450     return VLC_SUCCESS;
451 }
452
453 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
454                  block_t *p_buffer )
455 {
456     sout_stream_sys_t *p_sys = p_stream->p_sys;
457
458     sout_MuxSendBuffer( p_sys->p_mux, id->p_input, p_buffer );
459
460     return VLC_SUCCESS;
461 }