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