Renamed playlist "playlist-current" to "item-current".
[vlc.git] / modules / stream_out / record.c
1 /*****************************************************************************
2  * record.c: record stream output module
3  *****************************************************************************
4  * Copyright (C) 2008 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
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <limits.h>
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_block.h>
37 #include <vlc_sout.h>
38 #include <vlc_charset.h>
39 #include <assert.h>
40
41 /*****************************************************************************
42  * Exported prototypes
43  *****************************************************************************/
44 static int      Open    ( vlc_object_t * );
45 static void     Close   ( vlc_object_t * );
46
47 /*****************************************************************************
48  * Module descriptor
49  *****************************************************************************/
50 #define DST_PREFIX_TEXT N_("Destination prefix")
51 #define DST_PREFIX_LONGTEXT N_( \
52     "Prefix of the destination file automatically generated" )
53
54 #define SOUT_CFG_PREFIX "sout-record-"
55
56 vlc_module_begin ()
57     set_description( N_("Record stream output") )
58     set_capability( "sout stream", 0 )
59     add_shortcut( "record" )
60     set_shortname( N_("Record") )
61
62     set_category( CAT_SOUT )
63     set_subcategory( SUBCAT_SOUT_STREAM )
64
65     add_string( SOUT_CFG_PREFIX "dst-prefix", "", NULL, DST_PREFIX_TEXT,
66                 DST_PREFIX_LONGTEXT, true )
67
68     set_callbacks( Open, Close )
69 vlc_module_end ()
70
71 /* */
72 static const char *const ppsz_sout_options[] = {
73     "dst-prefix",
74     NULL
75 };
76
77 /* */
78 static sout_stream_id_t *Add ( sout_stream_t *, es_format_t * );
79 static int               Del ( sout_stream_t *, sout_stream_id_t * );
80 static int               Send( sout_stream_t *, sout_stream_id_t *, block_t* );
81
82 /* */
83 struct sout_stream_id_t
84 {
85     es_format_t fmt;
86
87     block_t *p_first;
88     block_t **pp_last;
89
90     sout_stream_id_t *id;
91
92     bool b_wait_key;
93     bool b_wait_start;
94 };
95
96 struct sout_stream_sys_t
97 {
98     char *psz_prefix;
99
100     sout_stream_t *p_out;
101
102     mtime_t     i_date_start;
103     size_t      i_size;
104
105     mtime_t     i_max_wait;
106     size_t      i_max_size;
107
108     bool        b_drop;
109
110     int              i_id;
111     sout_stream_id_t **id;
112     mtime_t     i_dts_start;
113 };
114
115 static void OutputStart( sout_stream_t *p_stream );
116 static void OutputSend( sout_stream_t *p_stream, sout_stream_id_t *id, block_t * );
117
118 /*****************************************************************************
119  * Open:
120  *****************************************************************************/
121 static int Open( vlc_object_t *p_this )
122 {
123     sout_stream_t *p_stream = (sout_stream_t*)p_this;
124     sout_stream_sys_t *p_sys;
125
126     p_stream->pf_add    = Add;
127     p_stream->pf_del    = Del;
128     p_stream->pf_send   = Send;
129
130     p_stream->p_sys = p_sys = malloc( sizeof(*p_sys) );
131     if( !p_sys )
132         return VLC_ENOMEM;
133
134     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options, p_stream->p_cfg );
135
136     p_sys->p_out = NULL;
137     p_sys->psz_prefix = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "dst-prefix" );
138     if( !p_sys->psz_prefix  )
139     {
140         p_sys->psz_prefix = strdup( "sout-record-" );
141         if( !p_sys->psz_prefix )
142         {
143             free( p_sys );
144             return VLC_ENOMEM;
145         }
146     }
147
148     p_sys->i_date_start = -1;
149     p_sys->i_size = 0;
150 #ifdef OPTIMIZE_MEMORY
151     p_sys->i_max_wait = 5*1000000; /* 5s */
152     p_sys->i_max_size = 1*1000000; /* 1 Mbyte */
153 #else
154     p_sys->i_max_wait = 30*1000000; /* 30s */
155     p_sys->i_max_size = 20*1000000; /* 20 Mbyte */
156 #endif
157     p_sys->b_drop = false;
158     p_sys->i_dts_start = 0;
159     TAB_INIT( p_sys->i_id, p_sys->id );
160
161     return VLC_SUCCESS;
162 }
163
164 /*****************************************************************************
165  * Close:
166  *****************************************************************************/
167 static void Close( vlc_object_t * p_this )
168 {
169     sout_stream_t *p_stream = (sout_stream_t*)p_this;
170     sout_stream_sys_t *p_sys = p_stream->p_sys;
171
172     if( p_sys->p_out )
173         sout_StreamDelete( p_sys->p_out );
174
175     TAB_CLEAN( p_sys->i_id, p_sys->id );
176     free( p_sys->psz_prefix );
177     free( p_sys );
178 }
179
180 /*****************************************************************************
181  *
182  *****************************************************************************/
183 static sout_stream_id_t *Add( sout_stream_t *p_stream, es_format_t *p_fmt )
184 {
185     sout_stream_sys_t *p_sys = p_stream->p_sys;
186     sout_stream_id_t *id;
187
188     id = malloc( sizeof(*id) );
189     if( !id )
190         return NULL;
191
192     es_format_Copy( &id->fmt, p_fmt );
193     id->p_first = NULL;
194     id->pp_last = &id->p_first;
195     id->id = NULL;
196     id->b_wait_key = true;
197     id->b_wait_start = true;
198
199     TAB_APPEND( p_sys->i_id, p_sys->id, id );
200
201     return id;
202 }
203
204 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
205 {
206     sout_stream_sys_t *p_sys = p_stream->p_sys;
207
208     if( !p_sys->p_out )
209         OutputStart( p_stream );
210
211     if( id->p_first )
212         block_ChainRelease( id->p_first );
213     es_format_Clean( &id->fmt );
214
215     assert( !id->id || p_sys->p_out );
216     if( id->id )
217         sout_StreamIdDel( p_sys->p_out, id->id );
218
219     TAB_REMOVE( p_sys->i_id, p_sys->id, id );
220
221     if( p_sys->i_id <= 0 )
222     {
223         if( !p_sys->p_out )
224             p_sys->b_drop = false;
225     }
226
227     free( id );
228
229     return VLC_SUCCESS;
230 }
231
232 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
233                  block_t *p_buffer )
234 {
235     sout_stream_sys_t *p_sys = p_stream->p_sys;
236
237     if( p_sys->i_date_start < 0 )
238         p_sys->i_date_start = mdate();
239     if( !p_sys->p_out &&
240         ( mdate() - p_sys->i_date_start > p_sys->i_max_wait ||
241           p_sys->i_size > p_sys->i_max_size ) )
242     {
243         msg_Dbg( p_stream, "Staring recording, waited %ds and %dbyte",
244                  (int)((mdate() - p_sys->i_date_start)/1000000), (int)p_sys->i_size );
245         OutputStart( p_stream );
246     }
247
248     OutputSend( p_stream, id, p_buffer );
249
250     return VLC_SUCCESS;
251 }
252
253 /*****************************************************************************
254  *
255  *****************************************************************************/
256 typedef struct
257 {
258     const char  *psz_muxer;
259     const char  *psz_extension;
260     int         i_es_max;
261     vlc_fourcc_t codec[128];
262 } muxer_properties_t;
263
264 #define M(muxer, ext, count, ... ) { .psz_muxer = muxer, .psz_extension = ext, .i_es_max = count, .codec = { __VA_ARGS__, 0 } }
265 /* Table of native codec support,
266  * Do not do non native and non standard association !
267  * Muxer will be probe if no entry found */
268 static const muxer_properties_t p_muxers[] = {
269     M( "raw", "mp3", 1,         VLC_FOURCC('m','p','g','a') ),
270     M( "raw", "a52", 1,         VLC_FOURCC('a','5','2',' ') ),
271     M( "raw", "dts", 1,         VLC_FOURCC('d','t','s',' ') ),
272     M( "raw", "mpc", 1,         VLC_FOURCC('m','p','c',' ') ),
273     M( "raw", "ape", 1,         VLC_FOURCC('A','P','E',' ') ),
274
275     M( "wav", "wav", 1,         VLC_FOURCC('a','r','a','w'), VLC_FOURCC('u','8',' ',' '), VLC_FOURCC('s','1','6','l'),
276                                 VLC_FOURCC('s','2','4','l'), VLC_FOURCC('s','3','2','l'), VLC_FOURCC('f','l','3','2') ),
277
278     //M( "ffmpeg{mux=flac}", "flac", 1, VLC_FOURCC('f','l','a','c') ), BROKEN
279
280     M( "ogg", "ogg", INT_MAX,   VLC_FOURCC('v','o','r','b'), VLC_FOURCC('s','p','x',' '), VLC_FOURCC('f','l','a','c'),
281                                 VLC_FOURCC('s','u','b','t'), VLC_FOURCC('t','h','e','o'), VLC_FOURCC('d','r','a','c')  ),
282
283     M( "asf", "asf", 127,       VLC_FOURCC('w','m','a','1'), VLC_FOURCC('w','m','a','2'), VLC_FOURCC('w','m','a',' '),
284                                 VLC_FOURCC('w','m','a','p'), VLC_FOURCC('w','m','a','l'),
285                                 VLC_FOURCC('W','M','V','1'), VLC_FOURCC('W','M','V','2'), VLC_FOURCC('W','M','V','3') ),
286
287     M( "mp4", "mp4", INT_MAX,   VLC_FOURCC('m','p','4','a'), VLC_FOURCC('h','2','6','4'), VLC_FOURCC('m','p','4','v'),
288                                 VLC_FOURCC('s','u','b','t') ),
289
290     M( "ps", "ps", 16/* FIXME*/,VLC_FOURCC('m','p','g','v'), VLC_FOURCC('m','p','1','v'), VLC_FOURCC('m','p','2','v'),
291                                 VLC_FOURCC('m','p','g','a'), VLC_FOURCC('l','p','c','m'), VLC_FOURCC('a','5','2',' '),
292                                 VLC_FOURCC('d','t','s',' '),
293                                 VLC_FOURCC('s','p','u',' ') ),
294
295     M( "ts", "ts", 8000,        VLC_FOURCC('m','p','g','v'), VLC_FOURCC('m','p','1','v'), VLC_FOURCC('m','p','2','v'),
296                                 VLC_FOURCC('h','2','6','4'),
297                                 VLC_FOURCC('m','p','g','a'), VLC_FOURCC('l','p','c','m'), VLC_FOURCC('a','5','2',' '),
298                                 VLC_FOURCC('d','t','s',' '), VLC_FOURCC('m','p','4','a'),
299                                 VLC_FOURCC('d','v','b','s'), VLC_FOURCC('t','e','l','x') ),
300
301     M( NULL, NULL, 0, 0 )
302 };
303 #undef M
304
305 static int OutputNew( sout_stream_t *p_stream,
306                       const char *psz_muxer, const char *psz_prefix, const char *psz_extension  )
307 {
308     sout_stream_sys_t *p_sys = p_stream->p_sys;
309     char *psz_output;
310     int i_count;
311
312     if( asprintf( &psz_output, "std{access=file,mux='%s',dst='%s%s%s'}",
313                   psz_muxer, psz_prefix, psz_extension ? "." : "", psz_extension ? psz_extension : "" ) < 0 )
314         return -1;
315
316     /* Create the output */
317     msg_Dbg( p_stream, "Using record output `%s'", psz_output );
318     p_sys->p_out = sout_StreamNew( p_stream->p_sout, psz_output );
319
320     free( psz_output );
321
322     if( !p_sys->p_out )
323         return -1;
324
325     /* Add es */
326     i_count = 0;
327     for( int i = 0; i < p_sys->i_id; i++ )
328     {
329         sout_stream_id_t *id = p_sys->id[i];
330
331         id->id = sout_StreamIdAdd( p_sys->p_out, &id->fmt );
332         if( id->id )
333             i_count++;
334     }
335
336     return i_count;
337 }
338
339 static void OutputStart( sout_stream_t *p_stream )
340 {
341     sout_stream_sys_t *p_sys = p_stream->p_sys;
342
343     /* */
344     if( p_sys->b_drop )
345         return;
346
347     /* From now on drop packet that cannot be handled */
348     p_sys->b_drop = true;
349
350     /* Detect streams to smart select muxer */
351     const char *psz_muxer = NULL;
352     const char *psz_extension = NULL;
353
354     /* Look for prefered muxer
355      * TODO we could insert transcode in a few cases like
356      * s16l <-> s16b
357      */
358     for( int i = 0; p_muxers[i].psz_muxer != NULL; i++ )
359     {
360         bool b_ok;
361         if( p_sys->i_id > p_muxers[i].i_es_max )
362             continue;
363
364         b_ok = true;
365         for( int j = 0; j < p_sys->i_id; j++ )
366         {
367             es_format_t *p_fmt = &p_sys->id[j]->fmt;
368
369             b_ok = false;
370             for( int k = 0; p_muxers[i].codec[k] != 0; k++ )
371             {
372                 if( p_fmt->i_codec == p_muxers[i].codec[k] )
373                 {
374                     b_ok = true;
375                     break;
376                 }
377             }
378             if( !b_ok )
379                 break;
380         }
381         if( !b_ok )
382             continue;
383
384         psz_muxer = p_muxers[i].psz_muxer;
385         psz_extension = p_muxers[i].psz_extension;
386         break;
387     }
388
389     /* If failed, brute force our demuxers and select the one that
390      * keeps most of our stream */
391     if( !psz_muxer || !psz_extension )
392     {
393         static const char *ppsz_muxers[][2] = {
394             { "avi", "avi" }, { "mp4", "mp4" }, { "ogg", "ogg" },
395             { "asf", "asf" }, {  "ts",  "ts" }, {  "ps",  "ps" },
396 #if 0
397             // XXX ffmpeg sefault really easily if you try an unsupported codec
398             // mov and avi at least segfault
399             { "ffmpeg{mux=avi}", "avi" },
400             { "ffmpeg{mux=mov}", "mov" },
401             { "ffmpeg{mux=mp4}", "mp4" },
402             { "ffmpeg{mux=nsv}", "nsv" },
403             { "ffmpeg{mux=flv}", "flv" },
404 #endif
405             { NULL, NULL }
406         };
407         int i_best = 0;
408         int i_best_es = 0;
409
410         msg_Warn( p_stream, "failed to find an adequate muxer, probing muxers" );
411         for( int i = 0; ppsz_muxers[i][0] != NULL; i++ )
412         {
413             char *psz_file;
414             int i_es;
415
416             psz_file = tempnam( NULL, "vlc" );
417             if( !psz_file )
418                 continue;
419
420             msg_Dbg( p_stream, "probing muxer %s", ppsz_muxers[i][0] );
421             i_es = OutputNew( p_stream, ppsz_muxers[i][0], psz_file, NULL );
422
423             if( i_es < 0 )
424             {
425                 utf8_unlink( psz_file );
426                 free( psz_file );
427                 continue;
428             }
429
430             /* */
431             for( int i = 0; i < p_sys->i_id; i++ )
432             {
433                 sout_stream_id_t *id = p_sys->id[i];
434
435                 if( id->id )
436                     sout_StreamIdDel( p_sys->p_out, id->id );
437                 id->id = NULL;
438             }
439             if( p_sys->p_out )
440                 sout_StreamDelete( p_sys->p_out );
441             p_sys->p_out = NULL;
442
443             if( i_es > i_best_es )
444             {
445                 i_best_es = i_es;
446                 i_best = i;
447
448                 if( i_best_es >= p_sys->i_id )
449                     break;
450             }
451             utf8_unlink( psz_file );
452             free( psz_file );
453         }
454
455         /* */
456         psz_muxer = ppsz_muxers[i_best][0];
457         psz_extension = ppsz_muxers[i_best][1];
458         msg_Dbg( p_stream, "using muxer %s with extension %s (%d/%d streams accepted)",
459                  psz_muxer, psz_extension, i_best_es, p_sys->i_id );
460     }
461
462     /* Create the output */
463     if( OutputNew( p_stream, psz_muxer, p_sys->psz_prefix, psz_extension ) < 0 )
464     {
465         msg_Err( p_stream, "failed to open output");
466         return;
467     }
468
469     /* Compute highest timestamp of first I over all streams */
470     p_sys->i_dts_start = 0;
471     for( int i = 0; i < p_sys->i_id; i++ )
472     {
473         sout_stream_id_t *id = p_sys->id[i];
474         block_t *p_block;
475
476         if( !id->id || !id->p_first )
477             continue;
478
479         mtime_t i_dts = id->p_first->i_dts;
480         for( p_block = id->p_first; p_block != NULL; p_block = p_block->p_next )
481         {
482             if( p_block->i_flags & BLOCK_FLAG_TYPE_I )
483             {
484                 i_dts = p_block->i_dts;
485                 break;
486             }
487         }
488
489         if( i_dts > p_sys->i_dts_start )
490             p_sys->i_dts_start = i_dts;
491     }
492
493     /* Send buffered data */
494     for( int i = 0; i < p_sys->i_id; i++ )
495     {
496         sout_stream_id_t *id = p_sys->id[i];
497
498         if( !id->id )
499             continue;
500
501         block_t *p_block = id->p_first;
502         while( p_block )
503         {
504             block_t *p_next = p_block->p_next;
505
506             p_block->p_next = NULL;
507
508             OutputSend( p_stream, id, p_block );
509
510             p_block = p_next;
511         }
512
513         id->p_first = NULL;
514         id->pp_last = &id->p_first;
515     }
516 }
517
518 static void OutputSend( sout_stream_t *p_stream, sout_stream_id_t *id, block_t *p_block )
519 {
520     sout_stream_sys_t *p_sys = p_stream->p_sys;
521
522     if( id->id )
523     {
524         /* We wait until the first key frame (if needed) and
525          * to be beyong i_dts_start (for stream without key frame) */
526         if( id->b_wait_key )
527         {
528             if( p_block->i_flags & BLOCK_FLAG_TYPE_I )
529             {
530                 id->b_wait_key = false;
531                 id->b_wait_start = false;
532             }
533
534             if( ( p_block->i_flags & BLOCK_FLAG_TYPE_MASK ) == 0 )
535                 id->b_wait_key = false;
536         }
537         if( id->b_wait_start )
538         {
539             if( p_block->i_dts >=p_sys->i_dts_start )
540                 id->b_wait_start = false;
541         }
542         if( id->b_wait_key || id->b_wait_start )
543             block_ChainRelease( p_block );
544         else
545             sout_StreamIdSend( p_sys->p_out, id->id, p_block );
546     }
547     else if( p_sys->b_drop )
548     {
549         block_ChainRelease( p_block );
550     }
551     else
552     {
553         size_t i_size;
554
555         block_ChainProperties( p_block, NULL, &i_size, NULL );
556         p_sys->i_size += i_size;
557         block_ChainLastAppend( &id->pp_last, p_block );
558     }
559 }
560