]> git.sesse.net Git - vlc/blob - modules/stream_out/smem.c
smem: mark options private or volatile as needed
[vlc] / modules / stream_out / smem.c
1 /*****************************************************************************
2  * smem.c: stream output to memory buffer module
3  *****************************************************************************
4  * Copyright (C) 2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Courtaut <christophe.courtaut@gmail.com>
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  * How to use it
26  *****************************************************************************
27  *
28  * You should use this module in combination with the transcode module, to get
29  * raw datas from it. This module does not make any conversion at all, so you
30  * need to use the transcode module for this purpose.
31  *
32  * For example, you can use smem as it :
33  * --sout="#transcode{vcodec=RV24,acodec=s16l}:smem{smem-options}"
34  *
35  * Into each lock function (audio and video), you will have all the informations
36  * you need to allocate a buffer, so that this module will copy data in it.
37  *
38  * the video-data and audio-data pointers will be passed to lock/unlock function
39  *
40  * For now, audio is NOT IMPLEMENTED.
41  *
42  ******************************************************************************/
43
44 /*****************************************************************************
45  * Preamble
46  *****************************************************************************/
47
48 #ifdef HAVE_CONFIG_H
49 # include "config.h"
50 #endif
51
52 #include <vlc_common.h>
53 #include <vlc_plugin.h>
54 #include <vlc_sout.h>
55 #include <vlc_block.h>
56 #include <vlc_codec.h>
57
58 /*****************************************************************************
59  * Module descriptor
60  *****************************************************************************/
61
62 #define T_VIDEO_PRERENDER_CALLBACK N_( "Video prerender callback" )
63 #define LT_VIDEO_PRERENDER_CALLBACK N_( "Address of the video prerender callback function" \
64                                 "this function will set the buffer where render will be done" )
65
66 #define T_AUDIO_PRERENDER_CALLBACK N_( "Audio prerender callback" )
67 #define LT_AUDIO_PRERENDER_CALLBACK N_( "Address of the audio prerender callback function." \
68                                         "this function will set the buffer where render will be done" )
69
70 #define T_VIDEO_POSTRENDER_CALLBACK N_( "Video postrender callback" )
71 #define LT_VIDEO_POSTRENDER_CALLBACK N_( "Address of the video postrender callback function." \
72                                         "this function will be called when the render is into the buffer" )
73
74 #define T_AUDIO_POSTRENDER_CALLBACK N_( "Audio postrender callback" )
75 #define LT_AUDIO_POSTRENDER_CALLBACK N_( "Address of the audio postrender callback function." \
76                                         "this function will be called when the render is into the buffer" )
77
78 #define T_VIDEO_DATA N_( "Video Callback data" )
79 #define LT_VIDEO_DATA N_( "Data for the video callback function." )
80
81 #define T_AUDIO_DATA N_( "Audio callback data" )
82 #define LT_AUDIO_DATA N_( "Data for the audio callback function." )
83
84 #define T_TIME_SYNC N_( "Time Synchronized output" )
85 #define LT_TIME_SYNC N_( "Time Synchronisation option for output. " \
86                         "If true, stream will render as usual, else " \
87                         "it will be rendered as fast as possible.")
88
89 static int  Open ( vlc_object_t * );
90 static void Close( vlc_object_t * );
91
92 #define SOUT_CFG_PREFIX "sout-smem-"
93 #define SOUT_PREFIX_VIDEO SOUT_CFG_PREFIX"video-"
94 #define SOUT_PREFIX_AUDIO SOUT_CFG_PREFIX"audio-"
95
96 vlc_module_begin ()
97     set_shortname( N_("Smem"))
98     set_description( N_("Stream output to memory buffer") )
99     set_capability( "sout stream", 0 )
100     add_shortcut( "smem" )
101     set_category( CAT_SOUT )
102     set_subcategory( SUBCAT_SOUT_STREAM )
103     add_string( SOUT_PREFIX_VIDEO "prerender-callback", "0", NULL, T_VIDEO_PRERENDER_CALLBACK, LT_VIDEO_PRERENDER_CALLBACK, true )
104         change_volatile()
105     add_string( SOUT_PREFIX_AUDIO "prerender-callback", "0", NULL, T_AUDIO_PRERENDER_CALLBACK, LT_AUDIO_PRERENDER_CALLBACK, true )
106         change_volatile()
107     add_string( SOUT_PREFIX_VIDEO "postrender-callback", "0", NULL, T_VIDEO_POSTRENDER_CALLBACK, LT_VIDEO_POSTRENDER_CALLBACK, true )
108         change_volatile()
109     add_string( SOUT_PREFIX_AUDIO "postrender-callback", "0", NULL, T_AUDIO_POSTRENDER_CALLBACK, LT_AUDIO_POSTRENDER_CALLBACK, true )
110         change_volatile()
111     add_string( SOUT_PREFIX_VIDEO "data", "0", NULL, T_VIDEO_DATA, LT_VIDEO_DATA, true )
112         change_volatile()
113     add_string( SOUT_PREFIX_AUDIO "data", "0", NULL, T_AUDIO_DATA, LT_VIDEO_DATA, true )
114         change_volatile()
115     add_bool( SOUT_CFG_PREFIX "time-sync", true, NULL, T_TIME_SYNC, LT_TIME_SYNC, true )
116         change_private()
117     set_callbacks( Open, Close )
118 vlc_module_end ()
119
120
121 /*****************************************************************************
122  * Exported prototypes
123  *****************************************************************************/
124 static const char *const ppsz_sout_options[] = {
125     "video-prerender-callback", "audio-prerender-callback",
126     "video-postrender-callback", "audio-postrender-callback", "video-data", "audio-data", "time-sync", NULL
127 };
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 static sout_stream_id_t *AddVideo( sout_stream_t *p_stream, es_format_t *p_fmt );
134 static sout_stream_id_t *AddAudio( sout_stream_t *p_stream, es_format_t *p_fmt );
135
136 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_t *id,
137                       block_t *p_buffer );
138 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_t *id,
139                       block_t *p_buffer );
140
141 struct sout_stream_id_t
142 {
143     es_format_t* format;
144     void *p_data;
145 };
146
147 struct sout_stream_sys_t
148 {
149     vlc_mutex_t *p_lock;
150     void ( *pf_video_prerender_callback ) ( void* p_video_data, uint8_t** pp_pixel_buffer , int size );
151     void ( *pf_audio_prerender_callback ) ( void* p_audio_data, uint8_t** pp_pcm_buffer , unsigned int size );
152     void ( *pf_video_postrender_callback ) ( void* p_video_data, uint8_t* p_pixel_buffer, int width, int height, int pixel_pitch, int size, mtime_t pts );
153     void ( *pf_audio_postrender_callback ) ( void* p_audio_data, uint8_t* p_pcm_buffer, unsigned int channels, unsigned int rate, unsigned int nb_samples, unsigned int bits_per_sample, unsigned int size, mtime_t pts );
154     bool time_sync;
155 };
156
157 /*****************************************************************************
158  * Open:
159  *****************************************************************************/
160 static int Open( vlc_object_t *p_this )
161 {
162     char* psz_tmp;
163     sout_stream_t *p_stream = (sout_stream_t*)p_this;
164     sout_stream_sys_t *p_sys;
165
166     p_sys = calloc( 1, sizeof( sout_stream_sys_t ) );
167     if( !p_sys )
168         return VLC_ENOMEM;
169     p_stream->p_sys = p_sys;
170
171     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
172                        p_stream->p_cfg );
173
174     p_sys->time_sync = var_GetBool( p_stream, SOUT_CFG_PREFIX "time-sync" );
175
176     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "prerender-callback" );
177     p_sys->pf_video_prerender_callback = (void (*) (void *, uint8_t**, int))(intptr_t)atoll( psz_tmp );
178     free( psz_tmp );
179
180     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "prerender-callback" );
181     p_sys->pf_audio_prerender_callback = (void (*) (void* , uint8_t**, unsigned int))(intptr_t)atoll( psz_tmp );
182     free( psz_tmp );
183
184     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "postrender-callback" );
185     p_sys->pf_video_postrender_callback = (void (*) (void*, uint8_t*, int, int, int, int, mtime_t))(intptr_t)atoll( psz_tmp );
186     free( psz_tmp );
187
188     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "postrender-callback" );
189     p_sys->pf_audio_postrender_callback = (void (*) (void*, uint8_t*, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, mtime_t))(intptr_t)atoll( psz_tmp );
190     free( psz_tmp );
191
192     /* Setting stream out module callbacks */
193     p_stream->pf_add    = Add;
194     p_stream->pf_del    = Del;
195     p_stream->pf_send   = Send;
196
197     /* Does the module need out_pace_control? */
198     if ( p_sys->time_sync )
199         p_stream->p_sout->i_out_pace_nocontrol++;
200
201     return VLC_SUCCESS;
202 }
203
204 /*****************************************************************************
205  * Close:
206  *****************************************************************************/
207 static void Close( vlc_object_t * p_this )
208 {
209     sout_stream_t *p_stream = (sout_stream_t*)p_this;
210     if ( p_stream->p_sys->time_sync )
211         p_stream->p_sout->i_out_pace_nocontrol--;
212     free( p_stream->p_sys );
213 }
214
215 static sout_stream_id_t *Add( sout_stream_t *p_stream, es_format_t *p_fmt )
216 {
217     sout_stream_id_t *id = NULL;
218
219     if ( p_fmt->i_cat == VIDEO_ES )
220         id = AddVideo( p_stream, p_fmt );
221     else if ( p_fmt->i_cat == AUDIO_ES )
222         id = AddAudio( p_stream, p_fmt );
223     return id;
224 }
225
226 static sout_stream_id_t *AddVideo( sout_stream_t *p_stream, es_format_t *p_fmt )
227 {
228     char* psz_tmp;
229     sout_stream_id_t    *id;
230     int i_bits_per_pixel;
231
232     switch( p_fmt->i_codec )
233     {
234         case VLC_CODEC_RGB32:
235             i_bits_per_pixel = 32;
236             break;
237         case VLC_CODEC_I444:
238         case VLC_CODEC_RGB24:
239             i_bits_per_pixel = 24;
240             break;
241         case VLC_CODEC_RGB16:
242         case VLC_CODEC_RGB15:
243         case VLC_CODEC_RGB8:
244         case VLC_CODEC_I422:
245             i_bits_per_pixel = 16;
246             break;
247         case VLC_CODEC_YV12:
248         case VLC_CODEC_I420:
249             i_bits_per_pixel = 12;
250             break;
251         case VLC_CODEC_RGBP:
252             i_bits_per_pixel = 8;
253             break;
254         default:
255             msg_Err( p_stream, "Smem does only support raw video format" );
256             return NULL;
257     }
258
259     id = calloc( 1, sizeof( sout_stream_id_t ) );
260     if( !id )
261         return NULL;
262
263     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "data" );
264     id->p_data = (void *)( intptr_t )atoll( psz_tmp );
265     free( psz_tmp );
266
267     id->format = p_fmt;
268     id->format->video.i_bits_per_pixel = i_bits_per_pixel;
269     return id;
270 }
271
272 static sout_stream_id_t *AddAudio( sout_stream_t *p_stream, es_format_t *p_fmt )
273 {
274     char* psz_tmp;
275     sout_stream_id_t* id;
276     int i_bits_per_sample;
277
278     switch( p_fmt->i_codec )
279     {
280     case VLC_CODEC_U8:
281     case VLC_CODEC_S8:
282         i_bits_per_sample = 8;
283         break;
284     case VLC_CODEC_U16L:
285     case VLC_CODEC_S16L:
286     case VLC_CODEC_U16B:
287     case VLC_CODEC_S16B:
288         i_bits_per_sample =  16;
289         break;
290     case VLC_CODEC_U24L:
291     case VLC_CODEC_S24L:
292     case VLC_CODEC_U24B:
293     case VLC_CODEC_S24B:
294         i_bits_per_sample = 24;
295         break;
296     case VLC_CODEC_S32L:
297     case VLC_CODEC_S32B:
298     case VLC_CODEC_FL32:
299     case VLC_CODEC_FI32:
300         i_bits_per_sample = 32;
301         break;
302     case VLC_CODEC_FL64:
303         i_bits_per_sample = 64;
304         break;
305     default:
306         msg_Err( p_stream, "Smem does only support raw audio format" );
307         return NULL;
308     }
309
310     id = calloc( 1, sizeof( sout_stream_id_t ) );
311     if( !id )
312         return NULL;
313
314     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "data" );
315     id->p_data = (void *)( intptr_t )atoll( psz_tmp );
316     free( psz_tmp );
317
318     id->format = p_fmt;
319     id->format->audio.i_bitspersample = i_bits_per_sample;
320     return id;
321 }
322
323 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
324 {
325     VLC_UNUSED( p_stream );
326     free( id );
327     return VLC_SUCCESS;
328 }
329
330 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
331                  block_t *p_buffer )
332 {
333     if ( id->format->i_cat == VIDEO_ES )
334         return SendVideo( p_stream, id, p_buffer );
335     else if ( id->format->i_cat == AUDIO_ES )
336         return SendAudio( p_stream, id, p_buffer );
337     return VLC_SUCCESS;
338 }
339
340 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_t *id,
341                       block_t *p_buffer )
342 {
343     sout_stream_sys_t *p_sys = p_stream->p_sys;
344     int i_line, i_line_size, i_size, i_pixel_pitch;
345     uint8_t* p_pixels;
346
347     i_line = id->format->video.i_height;
348     i_pixel_pitch = id->format->video.i_bits_per_pixel / 8;
349     i_line_size = i_pixel_pitch * id->format->video.i_width;
350     i_size = i_line * i_line_size;
351     /* Calling the prerender callback to get user buffer */
352     p_sys->pf_video_prerender_callback( id->p_data, &p_pixels , i_size );
353     /* Copying data into user buffer */
354     for ( int line = 0; line < i_line; line++, p_pixels += i_line_size )
355         vlc_memcpy( p_pixels, p_buffer->p_buffer + i_line_size * line , i_line_size );
356     /* Calling the postrender callback to tell the user his buffer is ready */
357     p_sys->pf_video_postrender_callback( id->p_data, p_pixels,
358                                          id->format->video.i_width, id->format->video.i_height,
359                                          id->format->video.i_bits_per_pixel, i_size, p_buffer->i_pts );
360     block_ChainRelease( p_buffer );
361     return VLC_SUCCESS;
362 }
363
364 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_t *id,
365                       block_t *p_buffer )
366 {
367     sout_stream_sys_t *p_sys = p_stream->p_sys;
368     int i_size;
369     uint8_t* p_pcm_buffer;
370     int i_samples = 0;
371
372     i_size = p_buffer->i_buffer;
373     i_samples = i_size / ( ( id->format->audio.i_bitspersample / 8 ) * id->format->audio.i_channels );
374     /* Calling the prerender callback to get user buffer */
375     p_sys->pf_audio_prerender_callback( id->p_data, &p_pcm_buffer, i_size );
376     /* Copying data into user buffer */
377     vlc_memcpy( p_pcm_buffer, p_buffer->p_buffer, i_size );
378     /* Calling the postrender callback to tell the user his buffer is ready */
379     p_sys->pf_audio_postrender_callback( id->p_data, p_pcm_buffer,
380                                          id->format->audio.i_channels, id->format->audio.i_rate, i_samples,
381                                          id->format->audio.i_bitspersample, i_size, p_buffer->i_pts );
382     block_ChainRelease( p_buffer );
383     return VLC_SUCCESS;
384 }