1 /*****************************************************************************
2 * smem.c: stream output to memory buffer module
3 *****************************************************************************
4 * Copyright (C) 2009 VLC authors and VideoLAN
7 * Authors: Christophe Courtaut <christophe.courtaut@gmail.com>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************
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.
32 * For example, you can use smem as it :
33 * --sout="#transcode{vcodec=RV24,acodec=s16l}:smem{smem-options}"
35 * Into each lock function (audio and video), you will have all the information
36 * you need to allocate a buffer, so that this module will copy data in it.
38 * the video-data and audio-data pointers will be passed to lock/unlock function
40 ******************************************************************************/
42 /*****************************************************************************
44 *****************************************************************************/
50 #include <vlc_common.h>
51 #include <vlc_plugin.h>
53 #include <vlc_block.h>
54 #include <vlc_codec.h>
57 /*****************************************************************************
59 *****************************************************************************/
61 #define T_VIDEO_PRERENDER_CALLBACK N_( "Video prerender callback" )
62 #define LT_VIDEO_PRERENDER_CALLBACK N_( "Address of the video prerender callback function. " \
63 "This function will set the buffer where render will be done." )
65 #define T_AUDIO_PRERENDER_CALLBACK N_( "Audio prerender callback" )
66 #define LT_AUDIO_PRERENDER_CALLBACK N_( "Address of the audio prerender callback function. " \
67 "This function will set the buffer where render will be done." )
69 #define T_VIDEO_POSTRENDER_CALLBACK N_( "Video postrender callback" )
70 #define LT_VIDEO_POSTRENDER_CALLBACK N_( "Address of the video postrender callback function. " \
71 "This function will be called when the render is into the buffer." )
73 #define T_AUDIO_POSTRENDER_CALLBACK N_( "Audio postrender callback" )
74 #define LT_AUDIO_POSTRENDER_CALLBACK N_( "Address of the audio postrender callback function. " \
75 "This function will be called when the render is into the buffer." )
77 #define T_VIDEO_DATA N_( "Video Callback data" )
78 #define LT_VIDEO_DATA N_( "Data for the video callback function." )
80 #define T_AUDIO_DATA N_( "Audio callback data" )
81 #define LT_AUDIO_DATA N_( "Data for the audio callback function." )
83 #define T_TIME_SYNC N_( "Time Synchronized output" )
84 #define LT_TIME_SYNC N_( "Time Synchronisation option for output. " \
85 "If true, stream will render as usual, else " \
86 "it will be rendered as fast as possible.")
88 static int Open ( vlc_object_t
* );
89 static void Close( vlc_object_t
* );
91 #define SOUT_CFG_PREFIX "sout-smem-"
92 #define SOUT_PREFIX_VIDEO SOUT_CFG_PREFIX"video-"
93 #define SOUT_PREFIX_AUDIO SOUT_CFG_PREFIX"audio-"
96 set_shortname( N_("Smem"))
97 set_description( N_("Stream output to memory buffer") )
98 set_capability( "sout stream", 0 )
99 add_shortcut( "smem" )
100 set_category( CAT_SOUT
)
101 set_subcategory( SUBCAT_SOUT_STREAM
)
102 add_string( SOUT_PREFIX_VIDEO
"prerender-callback", "0", T_VIDEO_PRERENDER_CALLBACK
, LT_VIDEO_PRERENDER_CALLBACK
, true )
104 add_string( SOUT_PREFIX_AUDIO
"prerender-callback", "0", T_AUDIO_PRERENDER_CALLBACK
, LT_AUDIO_PRERENDER_CALLBACK
, true )
106 add_string( SOUT_PREFIX_VIDEO
"postrender-callback", "0", T_VIDEO_POSTRENDER_CALLBACK
, LT_VIDEO_POSTRENDER_CALLBACK
, true )
108 add_string( SOUT_PREFIX_AUDIO
"postrender-callback", "0", T_AUDIO_POSTRENDER_CALLBACK
, LT_AUDIO_POSTRENDER_CALLBACK
, true )
110 add_string( SOUT_PREFIX_VIDEO
"data", "0", T_VIDEO_DATA
, LT_VIDEO_DATA
, true )
112 add_string( SOUT_PREFIX_AUDIO
"data", "0", T_AUDIO_DATA
, LT_VIDEO_DATA
, true )
114 add_bool( SOUT_CFG_PREFIX
"time-sync", true, T_TIME_SYNC
, LT_TIME_SYNC
, true )
116 set_callbacks( Open
, Close
)
120 /*****************************************************************************
121 * Exported prototypes
122 *****************************************************************************/
123 static const char *const ppsz_sout_options
[] = {
124 "video-prerender-callback", "audio-prerender-callback",
125 "video-postrender-callback", "audio-postrender-callback", "video-data", "audio-data", "time-sync", NULL
128 static sout_stream_id_sys_t
*Add( sout_stream_t
*, const es_format_t
* );
129 static void Del ( sout_stream_t
*, sout_stream_id_sys_t
* );
130 static int Send( sout_stream_t
*, sout_stream_id_sys_t
*, block_t
* );
132 static sout_stream_id_sys_t
*AddVideo( sout_stream_t
*p_stream
,
133 const es_format_t
*p_fmt
);
134 static sout_stream_id_sys_t
*AddAudio( sout_stream_t
*p_stream
,
135 const es_format_t
*p_fmt
);
137 static int SendVideo( sout_stream_t
*p_stream
, sout_stream_id_sys_t
*id
,
139 static int SendAudio( sout_stream_t
*p_stream
, sout_stream_id_sys_t
*id
,
142 struct sout_stream_id_sys_t
148 struct sout_stream_sys_t
151 void ( *pf_video_prerender_callback
) ( void* p_video_data
, uint8_t** pp_pixel_buffer
, size_t size
);
152 void ( *pf_audio_prerender_callback
) ( void* p_audio_data
, uint8_t** pp_pcm_buffer
, size_t size
);
153 void ( *pf_video_postrender_callback
) ( void* p_video_data
, uint8_t* p_pixel_buffer
, int width
, int height
, int pixel_pitch
, size_t size
, mtime_t pts
);
154 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
, size_t size
, mtime_t pts
);
158 void VideoPrerenderDefaultCallback( void* p_video_data
, uint8_t** pp_pixel_buffer
, size_t size
);
159 void AudioPrerenderDefaultCallback( void* p_audio_data
, uint8_t** pp_pcm_buffer
, size_t size
);
160 void VideoPostrenderDefaultCallback( void* p_video_data
, uint8_t* p_pixel_buffer
, int width
, int height
,
161 int pixel_pitch
, size_t size
, mtime_t pts
);
162 void AudioPostrenderDefaultCallback( void* p_audio_data
, uint8_t* p_pcm_buffer
, unsigned int channels
,
163 unsigned int rate
, unsigned int nb_samples
, unsigned int bits_per_sample
,
164 size_t size
, mtime_t pts
);
166 /*****************************************************************************
167 * Default empty callbacks
168 *****************************************************************************/
170 void VideoPrerenderDefaultCallback( void* p_video_data
, uint8_t** pp_pixel_buffer
, size_t size
)
172 VLC_UNUSED( p_video_data
); VLC_UNUSED( pp_pixel_buffer
); VLC_UNUSED( size
);
175 void AudioPrerenderDefaultCallback( void* p_audio_data
, uint8_t** pp_pcm_buffer
, size_t size
)
177 VLC_UNUSED( p_audio_data
); VLC_UNUSED( pp_pcm_buffer
); VLC_UNUSED( size
);
180 void VideoPostrenderDefaultCallback( void* p_video_data
, uint8_t* p_pixel_buffer
, int width
, int height
,
181 int pixel_pitch
, size_t size
, mtime_t pts
)
183 VLC_UNUSED( p_video_data
); VLC_UNUSED( p_pixel_buffer
);
184 VLC_UNUSED( width
); VLC_UNUSED( height
);
185 VLC_UNUSED( pixel_pitch
); VLC_UNUSED( size
); VLC_UNUSED( pts
);
188 void AudioPostrenderDefaultCallback( void* p_audio_data
, uint8_t* p_pcm_buffer
, unsigned int channels
,
189 unsigned int rate
, unsigned int nb_samples
, unsigned int bits_per_sample
,
190 size_t size
, mtime_t pts
)
192 VLC_UNUSED( p_audio_data
); VLC_UNUSED( p_pcm_buffer
);
193 VLC_UNUSED( channels
); VLC_UNUSED( rate
); VLC_UNUSED( nb_samples
);
194 VLC_UNUSED( bits_per_sample
); VLC_UNUSED( size
); VLC_UNUSED( pts
);
197 /*****************************************************************************
199 *****************************************************************************/
200 static int Open( vlc_object_t
*p_this
)
203 sout_stream_t
*p_stream
= (sout_stream_t
*)p_this
;
204 sout_stream_sys_t
*p_sys
;
206 p_sys
= calloc( 1, sizeof( sout_stream_sys_t
) );
209 p_stream
->p_sys
= p_sys
;
211 config_ChainParse( p_stream
, SOUT_CFG_PREFIX
, ppsz_sout_options
,
214 p_sys
->time_sync
= var_GetBool( p_stream
, SOUT_CFG_PREFIX
"time-sync" );
216 psz_tmp
= var_GetString( p_stream
, SOUT_PREFIX_VIDEO
"prerender-callback" );
217 p_sys
->pf_video_prerender_callback
= (void (*) (void *, uint8_t**, size_t))(intptr_t)atoll( psz_tmp
);
219 if (p_sys
->pf_video_prerender_callback
== NULL
)
220 p_sys
->pf_video_prerender_callback
= VideoPrerenderDefaultCallback
;
222 psz_tmp
= var_GetString( p_stream
, SOUT_PREFIX_AUDIO
"prerender-callback" );
223 p_sys
->pf_audio_prerender_callback
= (void (*) (void* , uint8_t**, size_t))(intptr_t)atoll( psz_tmp
);
225 if (p_sys
->pf_audio_prerender_callback
== NULL
)
226 p_sys
->pf_audio_prerender_callback
= AudioPrerenderDefaultCallback
;
228 psz_tmp
= var_GetString( p_stream
, SOUT_PREFIX_VIDEO
"postrender-callback" );
229 p_sys
->pf_video_postrender_callback
= (void (*) (void*, uint8_t*, int, int, int, size_t, mtime_t
))(intptr_t)atoll( psz_tmp
);
231 if (p_sys
->pf_video_postrender_callback
== NULL
)
232 p_sys
->pf_video_postrender_callback
= VideoPostrenderDefaultCallback
;
234 psz_tmp
= var_GetString( p_stream
, SOUT_PREFIX_AUDIO
"postrender-callback" );
235 p_sys
->pf_audio_postrender_callback
= (void (*) (void*, uint8_t*, unsigned int, unsigned int, unsigned int, unsigned int, size_t, mtime_t
))(intptr_t)atoll( psz_tmp
);
237 if (p_sys
->pf_audio_postrender_callback
== NULL
)
238 p_sys
->pf_audio_postrender_callback
= AudioPostrenderDefaultCallback
;
240 /* Setting stream out module callbacks */
241 p_stream
->pf_add
= Add
;
242 p_stream
->pf_del
= Del
;
243 p_stream
->pf_send
= Send
;
244 p_stream
->pace_nocontrol
= p_sys
->time_sync
;
249 /*****************************************************************************
251 *****************************************************************************/
252 static void Close( vlc_object_t
* p_this
)
254 sout_stream_t
*p_stream
= (sout_stream_t
*)p_this
;
255 free( p_stream
->p_sys
);
258 static sout_stream_id_sys_t
*Add( sout_stream_t
*p_stream
,
259 const es_format_t
*p_fmt
)
261 sout_stream_id_sys_t
*id
= NULL
;
263 if ( p_fmt
->i_cat
== VIDEO_ES
)
264 id
= AddVideo( p_stream
, p_fmt
);
265 else if ( p_fmt
->i_cat
== AUDIO_ES
)
266 id
= AddAudio( p_stream
, p_fmt
);
270 static sout_stream_id_sys_t
*AddVideo( sout_stream_t
*p_stream
,
271 const es_format_t
*p_fmt
)
274 sout_stream_id_sys_t
*id
;
275 int i_bits_per_pixel
;
277 switch( p_fmt
->i_codec
)
279 case VLC_CODEC_RGB32
:
282 i_bits_per_pixel
= 32;
285 case VLC_CODEC_RGB24
:
286 i_bits_per_pixel
= 24;
288 case VLC_CODEC_RGB16
:
289 case VLC_CODEC_RGB15
:
292 i_bits_per_pixel
= 16;
296 i_bits_per_pixel
= 12;
299 i_bits_per_pixel
= 8;
302 i_bits_per_pixel
= 0;
303 msg_Dbg( p_stream
, "non raw video format detected (%4.4s), buffers will contain compressed video", (char *)&p_fmt
->i_codec
);
307 id
= calloc( 1, sizeof( sout_stream_id_sys_t
) );
311 psz_tmp
= var_GetString( p_stream
, SOUT_PREFIX_VIDEO
"data" );
312 id
->p_data
= (void *)( intptr_t )atoll( psz_tmp
);
316 id
->format
->video
.i_bits_per_pixel
= i_bits_per_pixel
;
320 static sout_stream_id_sys_t
*AddAudio( sout_stream_t
*p_stream
,
321 const es_format_t
*p_fmt
)
324 sout_stream_id_sys_t
* id
;
325 int i_bits_per_sample
= aout_BitsPerSample( p_fmt
->i_codec
);
327 if( !i_bits_per_sample
)
329 msg_Err( p_stream
, "Smem does only support raw audio format" );
333 id
= calloc( 1, sizeof( sout_stream_id_sys_t
) );
337 psz_tmp
= var_GetString( p_stream
, SOUT_PREFIX_AUDIO
"data" );
338 id
->p_data
= (void *)( intptr_t )atoll( psz_tmp
);
342 id
->format
->audio
.i_bitspersample
= i_bits_per_sample
;
346 static void Del( sout_stream_t
*p_stream
, sout_stream_id_sys_t
*id
)
348 VLC_UNUSED( p_stream
);
352 static int Send( sout_stream_t
*p_stream
, sout_stream_id_sys_t
*id
,
355 if ( id
->format
->i_cat
== VIDEO_ES
)
356 return SendVideo( p_stream
, id
, p_buffer
);
357 else if ( id
->format
->i_cat
== AUDIO_ES
)
358 return SendAudio( p_stream
, id
, p_buffer
);
362 static int SendVideo( sout_stream_t
*p_stream
, sout_stream_id_sys_t
*id
,
365 sout_stream_sys_t
*p_sys
= p_stream
->p_sys
;
366 size_t i_size
= p_buffer
->i_buffer
;
367 uint8_t* p_pixels
= NULL
;
369 /* Calling the prerender callback to get user buffer */
370 p_sys
->pf_video_prerender_callback( id
->p_data
, &p_pixels
, i_size
);
374 msg_Err( p_stream
, "No buffer given!" );
375 block_ChainRelease( p_buffer
);
379 /* Copying data into user buffer */
380 memcpy( p_pixels
, p_buffer
->p_buffer
, i_size
);
381 /* Calling the postrender callback to tell the user his buffer is ready */
382 p_sys
->pf_video_postrender_callback( id
->p_data
, p_pixels
,
383 id
->format
->video
.i_width
, id
->format
->video
.i_height
,
384 id
->format
->video
.i_bits_per_pixel
, i_size
, p_buffer
->i_pts
);
385 block_ChainRelease( p_buffer
);
389 static int SendAudio( sout_stream_t
*p_stream
, sout_stream_id_sys_t
*id
,
392 sout_stream_sys_t
*p_sys
= p_stream
->p_sys
;
394 uint8_t* p_pcm_buffer
= NULL
;
397 i_size
= p_buffer
->i_buffer
;
398 if (id
->format
->audio
.i_channels
<= 0)
400 msg_Warn( p_stream
, "No buffer given!" );
401 block_ChainRelease( p_buffer
);
405 i_samples
= i_size
/ ( ( id
->format
->audio
.i_bitspersample
/ 8 ) * id
->format
->audio
.i_channels
);
406 /* Calling the prerender callback to get user buffer */
407 p_sys
->pf_audio_prerender_callback( id
->p_data
, &p_pcm_buffer
, i_size
);
410 msg_Err( p_stream
, "No buffer given!" );
411 block_ChainRelease( p_buffer
);
415 /* Copying data into user buffer */
416 memcpy( p_pcm_buffer
, p_buffer
->p_buffer
, i_size
);
417 /* Calling the postrender callback to tell the user his buffer is ready */
418 p_sys
->pf_audio_postrender_callback( id
->p_data
, p_pcm_buffer
,
419 id
->format
->audio
.i_channels
, id
->format
->audio
.i_rate
, i_samples
,
420 id
->format
->audio
.i_bitspersample
, i_size
, p_buffer
->i_pts
);
421 block_ChainRelease( p_buffer
);