1 /* BlackMagic SDI driver */
8 #define INT64_C(c) c ## LL
11 #include <vlc_common.h>
12 #include <vlc_plugin.h>
13 #include <vlc_input.h>
14 #include <vlc_demux.h>
15 #include <vlc_access.h>
16 #include <vlc_picture.h>
17 #include <vlc_charset.h>
20 #include <arpa/inet.h>
22 #include "DeckLinkAPI.h"
23 #include "DeckLinkAPIDispatch.cpp"
25 static int Open ( vlc_object_t * );
26 static void Close( vlc_object_t * );
28 #define MODE_TEXT N_("Desired input video mode")
29 #define MODE_LONGTEXT N_( \
30 "Desired input video mode for SDI captures. " \
31 "This value should be a FOURCC code in textual " \
32 "form, e.g. \"ntsc\"." )
34 #define CACHING_TEXT N_("Caching value in ms")
35 #define CACHING_LONGTEXT N_( \
36 "Caching value for SDI captures. This " \
37 "value should be set in milliseconds." )
39 #define RATE_TEXT N_("Audio sampling rate in Hz")
40 #define RATE_LONGTEXT N_( \
41 "Audio sampling rate (in hertz) for SDI captures. " \
42 "0 disables audio input." )
44 #define CHANNELS_TEXT N_("Number of audio channels")
45 #define CHANNELS_LONGTEXT N_( \
46 "Number of input audio channels for SDI captures. " \
47 "Must be 2, 8 or 16. 0 disables audio input." )
50 set_shortname( N_("SDI") )
51 set_description( N_("BlackMagic SDI input") )
52 set_category( CAT_INPUT )
53 set_subcategory( SUBCAT_INPUT_ACCESS )
55 add_string( "sdi-mode", "pal ", NULL,
56 MODE_TEXT, MODE_LONGTEXT, true )
57 add_integer( "sdi-caching", DEFAULT_PTS_DELAY / 1000, NULL,
58 CACHING_TEXT, CACHING_LONGTEXT, true )
59 add_integer( "sdi-audio-rate", 48000, NULL,
60 RATE_TEXT, RATE_LONGTEXT, true )
61 add_integer( "sdi-audio-channels", 2, NULL,
62 CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
65 set_capability( "access_demux", 10 )
66 set_callbacks( Open, Close )
69 static int Demux ( demux_t * );
70 static int Control( demux_t *, int, va_list );
72 class DeckLinkCaptureDelegate;
77 IDeckLinkInput *p_input;
78 DeckLinkCaptureDelegate *p_delegate;
80 es_out_id_t *p_video_es;
81 es_out_id_t *p_audio_es;
84 int i_width, i_height, i_fps_num, i_fps_den;
85 uint32_t i_dominance_flags;
87 int i_rate, i_channels;
89 vlc_mutex_t frame_lock;
90 block_t *p_video_frame; // protected by <frame_lock>
91 block_t *p_audio_frame; // protected by <frame_lock>
92 vlc_cond_t has_frame; // related to <frame_lock>
95 class DeckLinkCaptureDelegate : public IDeckLinkInputCallback
98 DeckLinkCaptureDelegate( demux_t *p_demux ) : p_demux_(p_demux) {}
100 // FIXME: These leak.
101 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
102 virtual ULONG STDMETHODCALLTYPE AddRef(void) { return 1; }
103 virtual ULONG STDMETHODCALLTYPE Release(void) { return 1; }
105 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents, IDeckLinkDisplayMode*, BMDDetectedVideoInputFormatFlags);
106 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame*, IDeckLinkAudioInputPacket*);
112 HRESULT DeckLinkCaptureDelegate::VideoInputFormatChanged(BMDVideoInputFormatChangedEvents events, IDeckLinkDisplayMode *mode, BMDDetectedVideoInputFormatFlags)
114 msg_Dbg( p_demux_, "Video input format changed" );
118 HRESULT DeckLinkCaptureDelegate::VideoInputFrameArrived(IDeckLinkVideoInputFrame* videoFrame, IDeckLinkAudioInputPacket* audioFrame)
120 demux_sys_t *p_sys = p_demux_->p_sys;
121 block_t *p_video_frame = NULL;
122 block_t *p_audio_frame = NULL;
126 if( videoFrame->GetFlags() & bmdFrameHasNoInputSource )
128 msg_Warn( p_demux_, "No input signal detected" );
132 const int i_width = videoFrame->GetWidth();
133 const int i_height = videoFrame->GetHeight();
134 const int i_stride = videoFrame->GetRowBytes();
137 p_video_frame = block_New( p_demux_, i_width * i_height * i_bpp );
140 msg_Err( p_demux_, "Could not allocate memory for video frame" );
145 videoFrame->GetBytes( &frame_bytes );
146 for( int y = 0; y < i_height; ++y )
148 const uint8_t *src = (const uint8_t *)frame_bytes + i_stride * y;
149 uint8_t *dst = (uint8_t *)p_video_frame->p_buffer + i_width * i_bpp * y;
150 memcpy( dst, src, i_width * i_bpp );
153 BMDTimeValue stream_time, frame_duration;
154 videoFrame->GetStreamTime( &stream_time, &frame_duration, CLOCK_FREQ );
155 p_video_frame->i_flags = BLOCK_FLAG_TYPE_I | p_sys->i_dominance_flags;
156 if( p_sys->b_first_frame )
158 p_video_frame->i_flags |= BLOCK_FLAG_DISCONTINUITY;
159 p_sys->b_first_frame = false;
161 p_video_frame->i_pts = VLC_TS_0 + stream_time;
166 const int i_bytes = audioFrame->GetSampleFrameCount() * sizeof(int16_t) * p_sys->i_channels;
168 p_audio_frame = block_New( p_demux_, i_bytes );
171 msg_Err( p_demux_, "Could not allocate memory for audio frame" );
176 audioFrame->GetBytes( &frame_bytes );
177 memcpy( p_audio_frame->p_buffer, frame_bytes, i_bytes );
179 BMDTimeValue packet_time;
180 audioFrame->GetPacketTime( &packet_time, CLOCK_FREQ );
181 p_audio_frame->i_pts = VLC_TS_0 + packet_time;
184 if( p_video_frame || p_audio_frame )
186 vlc_mutex_lock( &p_sys->frame_lock );
188 p_sys->p_video_frame = p_video_frame; // FIXME: leak
190 p_sys->p_audio_frame = p_audio_frame; // FIXME: leak
191 vlc_cond_signal( &p_sys->has_frame );
192 vlc_mutex_unlock( &p_sys->frame_lock );
198 static int Open( vlc_object_t *p_this )
200 demux_t *p_demux = (demux_t*)p_this;
203 /* Only when selected */
204 if( *p_demux->psz_access == '\0' )
208 p_demux->pf_demux = Demux;
209 p_demux->pf_control = Control;
210 p_demux->info.i_update = 0;
211 p_demux->info.i_title = 0;
212 p_demux->info.i_seekpoint = 0;
213 p_demux->p_sys = p_sys = (demux_sys_t*)calloc( 1, sizeof( demux_sys_t ) );
217 vlc_mutex_init( &p_sys->frame_lock );
218 vlc_cond_init( &p_sys->has_frame );
219 p_sys->p_video_frame = NULL;
221 IDeckLinkIterator *decklink_iterator = CreateDeckLinkIteratorInstance();
222 if( !decklink_iterator )
224 msg_Err( p_demux, "DeckLink drivers not found." );
225 // FIXME: Leak here and several other error paths.
230 result = decklink_iterator->Next( &p_sys->p_card );
234 msg_Err( p_demux, "No DeckLink PCI cards found" );
238 if( p_sys->p_card->QueryInterface( IID_IDeckLinkInput, (void**)&p_sys->p_input) != S_OK )
240 msg_Err( p_demux, "Card has no inputs" );
244 IDeckLinkDisplayModeIterator *p_display_iterator;
245 result = p_sys->p_input->GetDisplayModeIterator( &p_display_iterator );
248 msg_Err( p_demux, "Failed to enumerate display modes" );
252 char *mode_string = var_CreateGetString( p_demux, "sdi-mode" );
253 if( !mode_string || strlen( mode_string ) == 0 || strlen( mode_string ) > 4 ) {
254 msg_Err( p_demux, "Missing or invalid --sdi-mode string" );
258 // Pad the --sdi-mode string to four characters, so the user can specify e.g. "pal"
259 // without having to add the trailing space.
260 char mode_string_padded[5];
261 strcpy(mode_string_padded, " ");
262 for( int i = 0; i < strlen(mode_string); ++i )
263 mode_string_padded[i] = mode_string[i];
265 BMDDisplayMode wanted_mode_id;
266 memcpy( &wanted_mode_id, &mode_string_padded, sizeof(wanted_mode_id) );
268 bool b_found_mode = false;
272 IDeckLinkDisplayMode *p_display_mode;
273 result = p_display_iterator->Next( &p_display_mode );
274 if( result != S_OK || !p_display_mode )
279 char mode_id_text[5] = {0};
280 BMDDisplayMode mode_id = ntohl( p_display_mode->GetDisplayMode() );
281 memcpy( mode_id_text, &mode_id, sizeof(mode_id) );
283 const char *mode_name;
284 result = p_display_mode->GetName( &mode_name );
287 msg_Err( p_demux, "Failed to get display mode name" );
291 BMDTimeValue frame_duration, time_scale;
292 result = p_display_mode->GetFrameRate( &frame_duration, &time_scale );
295 msg_Err( p_demux, "Failed to get frame rate" );
299 const char *field_dominance;
300 uint32_t i_dominance_flags = 0;
301 switch( p_display_mode->GetFieldDominance() )
303 case bmdProgressiveFrame:
304 field_dominance = "";
306 case bmdProgressiveSegmentedFrame:
307 field_dominance = ", segmented";
309 case bmdLowerFieldFirst:
310 field_dominance = ", interlaced [BFF]";
311 i_dominance_flags = BLOCK_FLAG_BOTTOM_FIELD_FIRST;
313 case bmdUpperFieldFirst:
314 field_dominance = ", interlaced [TFF]";
315 i_dominance_flags = BLOCK_FLAG_TOP_FIELD_FIRST;
317 case bmdUnknownFieldDominance:
319 field_dominance = ", unknown field dominance";
324 sprintf( buf, "Found mode '%s': %s (%dx%d, %.3f fps%s)",
325 mode_id_text, mode_name,
326 p_display_mode->GetWidth(), p_display_mode->GetHeight(),
327 double(time_scale) / frame_duration, field_dominance );
328 msg_Dbg( p_demux, buf );
330 if( wanted_mode_id == mode_id )
333 p_sys->i_width = p_display_mode->GetWidth();
334 p_sys->i_height = p_display_mode->GetHeight();
335 p_sys->i_fps_num = time_scale;
336 p_sys->i_fps_den = frame_duration;
337 p_sys->i_dominance_flags = i_dominance_flags;
343 msg_Err( p_demux, "Unknown SDI mode specified. " \
344 "Run VLC with -v --verbose-objects=-all,+sdi " \
345 "to get a list of supported modes." );
349 result = p_sys->p_input->EnableVideoInput( htonl( wanted_mode_id ), bmdFormat8BitYUV, 0 );
352 msg_Err( p_demux, "Failed to enable video input" );
356 p_sys->i_rate = var_CreateGetInteger( p_demux, "sdi-audio-rate" );
357 p_sys->i_channels = var_CreateGetInteger( p_demux, "sdi-audio-channels" );
358 if( p_sys->i_rate > 0 && p_sys->i_channels > 0 )
360 result = p_sys->p_input->EnableAudioInput( p_sys->i_rate, bmdAudioSampleType16bitInteger, p_sys->i_channels );
363 msg_Err( p_demux, "Failed to enable audio input" );
368 p_sys->p_delegate = new DeckLinkCaptureDelegate( p_demux );
369 p_sys->p_input->SetCallback( p_sys->p_delegate );
371 result = p_sys->p_input->StartStreams();
374 msg_Err( p_demux, "Failed to start streams" );
378 /* Declare elementary streams */
379 es_format_t video_fmt;
380 es_format_Init( &video_fmt, VIDEO_ES, VLC_CODEC_UYVY );
381 video_fmt.video.i_width = p_sys->i_width;
382 video_fmt.video.i_height = p_sys->i_height;
383 video_fmt.video.i_sar_num = 16 * video_fmt.video.i_height;
384 video_fmt.video.i_sar_den = 9 * video_fmt.video.i_width;
385 video_fmt.video.i_frame_rate = p_sys->i_fps_num;
386 video_fmt.video.i_frame_rate_base = p_sys->i_fps_den;
387 video_fmt.i_bitrate = video_fmt.video.i_width * video_fmt.video.i_height * video_fmt.video.i_frame_rate * 2;
389 msg_Dbg( p_demux, "added new video es %4.4s %dx%d",
390 (char*)&video_fmt.i_codec, video_fmt.video.i_width, video_fmt.video.i_height );
391 p_sys->p_video_es = es_out_Add( p_demux->out, &video_fmt );
393 es_format_t audio_fmt;
394 es_format_Init( &audio_fmt, AUDIO_ES, VLC_CODEC_S16N );
395 audio_fmt.audio.i_channels = p_sys->i_channels;
396 audio_fmt.audio.i_rate = p_sys->i_rate;
397 audio_fmt.audio.i_bitspersample = 16;
398 audio_fmt.audio.i_blockalign = audio_fmt.audio.i_channels * audio_fmt.audio.i_bitspersample / 8;
399 audio_fmt.i_bitrate = audio_fmt.audio.i_channels * audio_fmt.audio.i_rate * audio_fmt.audio.i_bitspersample;
401 msg_Dbg( p_demux, "added new audio es %4.4s %dHz %dbpp %dch",
402 (char*)&audio_fmt.i_codec, audio_fmt.audio.i_rate, audio_fmt.audio.i_bitspersample, audio_fmt.audio.i_channels);
403 p_sys->p_audio_es = es_out_Add( p_demux->out, &audio_fmt );
405 p_sys->b_first_frame = true;
407 /* Update default_pts to a suitable value for access */
408 var_Create( p_demux, "sdi-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
413 static void Close( vlc_object_t *p_this )
415 demux_t *p_demux = (demux_t *)p_this;
416 demux_sys_t *p_sys = p_demux->p_sys;
421 static int Control( demux_t *p_demux, int i_query, va_list args )
428 /* Special for access_demux */
429 case DEMUX_CAN_PAUSE:
431 case DEMUX_CAN_CONTROL_PACE:
432 pb = (bool*)va_arg( args, bool * );
436 case DEMUX_GET_PTS_DELAY:
437 pi64 = (int64_t*)va_arg( args, int64_t * );
438 *pi64 = var_GetInteger( p_demux, "sdi-caching" ) * 1000;
442 pi64 = (int64_t*)va_arg( args, int64_t * );
443 *pi64 = mdate(); // FIXME
446 /* TODO implement others */
454 static int Demux( demux_t *p_demux )
456 demux_sys_t *p_sys = p_demux->p_sys;
457 block_t *p_video_block = NULL;
458 block_t *p_audio_block = NULL;
460 vlc_mutex_lock( &p_sys->frame_lock );
462 while( !p_sys->p_video_frame && !p_sys->p_audio_frame )
463 vlc_cond_wait( &p_sys->has_frame, &p_sys->frame_lock );
465 p_video_block = p_sys->p_video_frame;
466 p_sys->p_video_frame = NULL;
468 p_audio_block = p_sys->p_audio_frame;
469 p_sys->p_audio_frame = NULL;
471 vlc_mutex_unlock( &p_sys->frame_lock );
475 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_video_block->i_pts );
476 es_out_Send( p_demux->out, p_sys->p_video_es, p_video_block );
481 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_audio_block->i_pts );
482 es_out_Send( p_demux->out, p_sys->p_audio_es, p_audio_block );