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 AUDIO_CONNECTION_TEXT N_("Audio connection")
40 #define AUDIO_CONNECTION_LONGTEXT N_( \
41 "Audio connection to use for SDI captures. " \
42 "Valid choices: embedded, aesebu, analog. " \
43 "Leave blank for card default." )
45 #define RATE_TEXT N_("Audio sampling rate in Hz")
46 #define RATE_LONGTEXT N_( \
47 "Audio sampling rate (in hertz) for SDI captures. " \
48 "0 disables audio input." )
50 #define CHANNELS_TEXT N_("Number of audio channels")
51 #define CHANNELS_LONGTEXT N_( \
52 "Number of input audio channels for SDI captures. " \
53 "Must be 2, 8 or 16. 0 disables audio input." )
55 #define VIDEO_CONNECTION_TEXT N_("Video connection")
56 #define VIDEO_CONNECTION_LONGTEXT N_( \
57 "Video connection to use for SDI captures. " \
58 "Valid choices: sdi, hdmi, opticalsdi, component, " \
59 "composite, svideo. " \
60 "Leave blank for card default." )
62 #define ASPECT_RATIO_TEXT N_("Aspect ratio")
63 #define ASPECT_RATIO_LONGTEXT N_( \
64 "Aspect ratio (4:3, 16:9). Default assumes square pixels." )
67 set_shortname( N_("SDI") )
68 set_description( N_("BlackMagic SDI input") )
69 set_category( CAT_INPUT )
70 set_subcategory( SUBCAT_INPUT_ACCESS )
72 add_string( "sdi-mode", "pal ", NULL,
73 MODE_TEXT, MODE_LONGTEXT, true )
74 add_integer( "sdi-caching", DEFAULT_PTS_DELAY / 1000, NULL,
75 CACHING_TEXT, CACHING_LONGTEXT, true )
76 add_string( "sdi-audio-connection", 0, NULL,
77 AUDIO_CONNECTION_TEXT, AUDIO_CONNECTION_LONGTEXT, true )
78 add_integer( "sdi-audio-rate", 48000, NULL,
79 RATE_TEXT, RATE_LONGTEXT, true )
80 add_integer( "sdi-audio-channels", 2, NULL,
81 CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
82 add_string( "sdi-video-connection", 0, NULL,
83 VIDEO_CONNECTION_TEXT, VIDEO_CONNECTION_LONGTEXT, true )
84 add_string( "sdi-aspect-ratio", NULL, NULL,
85 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, true )
88 set_capability( "access_demux", 10 )
89 set_callbacks( Open, Close )
92 static int Demux ( demux_t * );
93 static int Control( demux_t *, int, va_list );
95 class DeckLinkCaptureDelegate;
100 IDeckLinkInput *p_input;
101 DeckLinkCaptureDelegate *p_delegate;
103 es_out_id_t *p_video_es;
104 es_out_id_t *p_audio_es;
107 int i_width, i_height, i_fps_num, i_fps_den;
108 uint32_t i_dominance_flags;
110 int i_rate, i_channels;
112 vlc_mutex_t frame_lock;
113 block_t *p_video_frame; // protected by <frame_lock>
114 block_t *p_audio_frame; // protected by <frame_lock>
115 vlc_cond_t has_frame; // related to <frame_lock>
118 class DeckLinkCaptureDelegate : public IDeckLinkInputCallback
121 DeckLinkCaptureDelegate( demux_t *p_demux ) : p_demux_(p_demux) {}
123 // FIXME: These leak.
124 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
125 virtual ULONG STDMETHODCALLTYPE AddRef(void) { return 1; }
126 virtual ULONG STDMETHODCALLTYPE Release(void) { return 1; }
128 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents, IDeckLinkDisplayMode*, BMDDetectedVideoInputFormatFlags);
129 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame*, IDeckLinkAudioInputPacket*);
135 HRESULT DeckLinkCaptureDelegate::VideoInputFormatChanged(BMDVideoInputFormatChangedEvents events, IDeckLinkDisplayMode *mode, BMDDetectedVideoInputFormatFlags)
137 msg_Dbg( p_demux_, "Video input format changed" );
141 HRESULT DeckLinkCaptureDelegate::VideoInputFrameArrived(IDeckLinkVideoInputFrame* videoFrame, IDeckLinkAudioInputPacket* audioFrame)
143 demux_sys_t *p_sys = p_demux_->p_sys;
144 block_t *p_video_frame = NULL;
145 block_t *p_audio_frame = NULL;
149 if( videoFrame->GetFlags() & bmdFrameHasNoInputSource )
151 msg_Warn( p_demux_, "No input signal detected" );
155 const int i_width = videoFrame->GetWidth();
156 const int i_height = videoFrame->GetHeight();
157 const int i_stride = videoFrame->GetRowBytes();
160 p_video_frame = block_New( p_demux_, i_width * i_height * i_bpp );
163 msg_Err( p_demux_, "Could not allocate memory for video frame" );
168 videoFrame->GetBytes( &frame_bytes );
169 for( int y = 0; y < i_height; ++y )
171 const uint8_t *src = (const uint8_t *)frame_bytes + i_stride * y;
172 uint8_t *dst = (uint8_t *)p_video_frame->p_buffer + i_width * i_bpp * y;
173 memcpy( dst, src, i_width * i_bpp );
176 BMDTimeValue stream_time, frame_duration;
177 videoFrame->GetStreamTime( &stream_time, &frame_duration, CLOCK_FREQ );
178 p_video_frame->i_flags = BLOCK_FLAG_TYPE_I | p_sys->i_dominance_flags;
179 if( p_sys->b_first_frame )
181 p_video_frame->i_flags |= BLOCK_FLAG_DISCONTINUITY;
182 p_sys->b_first_frame = false;
184 p_video_frame->i_pts = p_video_frame->i_dts = VLC_TS_0 + stream_time;
189 const int i_bytes = audioFrame->GetSampleFrameCount() * sizeof(int16_t) * p_sys->i_channels;
191 p_audio_frame = block_New( p_demux_, i_bytes );
194 msg_Err( p_demux_, "Could not allocate memory for audio frame" );
199 audioFrame->GetBytes( &frame_bytes );
200 memcpy( p_audio_frame->p_buffer, frame_bytes, i_bytes );
202 BMDTimeValue packet_time;
203 audioFrame->GetPacketTime( &packet_time, CLOCK_FREQ );
204 p_audio_frame->i_pts = p_audio_frame->i_dts = VLC_TS_0 + packet_time;
207 if( p_video_frame || p_audio_frame )
209 vlc_mutex_lock( &p_sys->frame_lock );
211 p_sys->p_video_frame = p_video_frame; // FIXME: leak
213 p_sys->p_audio_frame = p_audio_frame; // FIXME: leak
214 vlc_cond_signal( &p_sys->has_frame );
215 vlc_mutex_unlock( &p_sys->frame_lock );
221 static int Open( vlc_object_t *p_this )
223 demux_t *p_demux = (demux_t*)p_this;
226 /* Only when selected */
227 if( *p_demux->psz_access == '\0' )
231 p_demux->pf_demux = Demux;
232 p_demux->pf_control = Control;
233 p_demux->info.i_update = 0;
234 p_demux->info.i_title = 0;
235 p_demux->info.i_seekpoint = 0;
236 p_demux->p_sys = p_sys = (demux_sys_t*)calloc( 1, sizeof( demux_sys_t ) );
240 vlc_mutex_init( &p_sys->frame_lock );
241 vlc_cond_init( &p_sys->has_frame );
242 p_sys->p_video_frame = NULL;
244 IDeckLinkIterator *decklink_iterator = CreateDeckLinkIteratorInstance();
245 if( !decklink_iterator )
247 msg_Err( p_demux, "DeckLink drivers not found." );
248 // FIXME: Leak here and several other error paths.
253 result = decklink_iterator->Next( &p_sys->p_card );
257 msg_Err( p_demux, "No DeckLink PCI cards found" );
261 if( p_sys->p_card->QueryInterface( IID_IDeckLinkInput, (void**)&p_sys->p_input) != S_OK )
263 msg_Err( p_demux, "Card has no inputs" );
267 // Set up the video and audio sources.
268 IDeckLinkConfiguration *p_config;
269 if( p_sys->p_card->QueryInterface( IID_IDeckLinkConfiguration, (void**)&p_config) != S_OK )
271 msg_Err( p_demux, "Failed to get configuration interface" );
275 char *psz_tmp = var_CreateGetNonEmptyString( p_demux, "sdi-video-connection" );
278 BMDVideoConnection conn;
279 if ( !strcmp( psz_tmp, "sdi" ) )
280 conn = bmdVideoConnectionSDI;
281 else if ( !strcmp( psz_tmp, "hdmi" ) )
282 conn = bmdVideoConnectionHDMI;
283 else if ( !strcmp( psz_tmp, "opticalsdi" ) )
284 conn = bmdVideoConnectionOpticalSDI;
285 else if ( !strcmp( psz_tmp, "component" ) )
286 conn = bmdVideoConnectionComponent;
287 else if ( !strcmp( psz_tmp, "composite" ) )
288 conn = bmdVideoConnectionComposite;
289 else if ( !strcmp( psz_tmp, "svideo" ) )
290 conn = bmdVideoConnectionSVideo;
293 msg_Err( p_demux, "Invalid --sdi-video-connection specified; choose one of " \
294 "sdi, hdmi, opticalsdi, component, composite, or svideo." );
299 msg_Dbg( p_demux, "Setting video input format to 0x%x", conn);
300 result = p_config->SetVideoInputFormat( conn );
303 msg_Err( p_demux, "Failed to set video input connection" );
308 psz_tmp = var_CreateGetNonEmptyString( p_demux, "sdi-audio-connection" );
311 BMDAudioConnection conn;
312 if ( !strcmp( psz_tmp, "embedded" ) )
313 conn = bmdAudioConnectionEmbedded;
314 else if ( !strcmp( psz_tmp, "aesebu" ) )
315 conn = bmdAudioConnectionAESEBU;
316 else if ( !strcmp( psz_tmp, "analog" ) )
317 conn = bmdAudioConnectionAnalog;
320 msg_Err( p_demux, "Invalid --sdi-audio-connection specified; choose one of " \
321 "embedded, aesebu, or analog." );
326 msg_Dbg( p_demux, "Setting audio input format to 0x%x", conn);
327 result = p_config->SetAudioInputFormat( conn );
330 msg_Err( p_demux, "Failed to set audio input connection" );
335 // Get the list of display modes.
336 IDeckLinkDisplayModeIterator *p_display_iterator;
337 result = p_sys->p_input->GetDisplayModeIterator( &p_display_iterator );
340 msg_Err( p_demux, "Failed to enumerate display modes" );
344 char *psz_display_mode = var_CreateGetString( p_demux, "sdi-mode" );
345 if( !psz_display_mode || strlen( psz_display_mode ) == 0 || strlen( psz_display_mode ) > 4 ) {
346 msg_Err( p_demux, "Missing or invalid --sdi-mode string" );
350 // Pad the --sdi-mode string to four characters, so the user can specify e.g. "pal"
351 // without having to add the trailing space.
352 char sz_display_mode_padded[5];
353 strcpy(sz_display_mode_padded, " ");
354 for( int i = 0; i < strlen( psz_display_mode ); ++i )
355 sz_display_mode_padded[i] = psz_display_mode[i];
357 BMDDisplayMode wanted_mode_id;
358 memcpy( &wanted_mode_id, &sz_display_mode_padded, sizeof(wanted_mode_id) );
360 bool b_found_mode = false;
364 IDeckLinkDisplayMode *p_display_mode;
365 result = p_display_iterator->Next( &p_display_mode );
366 if( result != S_OK || !p_display_mode )
371 char sz_mode_id_text[5] = {0};
372 BMDDisplayMode mode_id = ntohl( p_display_mode->GetDisplayMode() );
373 memcpy( sz_mode_id_text, &mode_id, sizeof(mode_id) );
375 const char *psz_mode_name;
376 result = p_display_mode->GetName( &psz_mode_name );
379 msg_Err( p_demux, "Failed to get display mode name" );
383 BMDTimeValue frame_duration, time_scale;
384 result = p_display_mode->GetFrameRate( &frame_duration, &time_scale );
387 msg_Err( p_demux, "Failed to get frame rate" );
391 const char *psz_field_dominance;
392 uint32_t i_dominance_flags = 0;
393 switch( p_display_mode->GetFieldDominance() )
395 case bmdProgressiveFrame:
396 psz_field_dominance = "";
398 case bmdProgressiveSegmentedFrame:
399 psz_field_dominance = ", segmented";
401 case bmdLowerFieldFirst:
402 psz_field_dominance = ", interlaced [BFF]";
403 i_dominance_flags = BLOCK_FLAG_BOTTOM_FIELD_FIRST;
405 case bmdUpperFieldFirst:
406 psz_field_dominance = ", interlaced [TFF]";
407 i_dominance_flags = BLOCK_FLAG_TOP_FIELD_FIRST;
409 case bmdUnknownFieldDominance:
411 psz_field_dominance = ", unknown field dominance";
415 msg_Dbg( p_demux, "Found mode '%s': %s (%dx%d, %.3f fps%s)",
416 sz_mode_id_text, psz_mode_name,
417 p_display_mode->GetWidth(), p_display_mode->GetHeight(),
418 double(time_scale) / frame_duration, psz_field_dominance );
420 if( wanted_mode_id == mode_id )
423 p_sys->i_width = p_display_mode->GetWidth();
424 p_sys->i_height = p_display_mode->GetHeight();
425 p_sys->i_fps_num = time_scale;
426 p_sys->i_fps_den = frame_duration;
427 p_sys->i_dominance_flags = i_dominance_flags;
433 msg_Err( p_demux, "Unknown SDI mode specified. " \
434 "Run VLC with -v --verbose-objects=-all,+sdi " \
435 "to get a list of supported modes." );
439 result = p_sys->p_input->EnableVideoInput( htonl( wanted_mode_id ), bmdFormat8BitYUV, 0 );
442 msg_Err( p_demux, "Failed to enable video input" );
447 p_sys->i_rate = var_CreateGetInteger( p_demux, "sdi-audio-rate" );
448 p_sys->i_channels = var_CreateGetInteger( p_demux, "sdi-audio-channels" );
449 if( p_sys->i_rate > 0 && p_sys->i_channels > 0 )
451 result = p_sys->p_input->EnableAudioInput( p_sys->i_rate, bmdAudioSampleType16bitInteger, p_sys->i_channels );
454 msg_Err( p_demux, "Failed to enable audio input" );
459 p_sys->p_delegate = new DeckLinkCaptureDelegate( p_demux );
460 p_sys->p_input->SetCallback( p_sys->p_delegate );
462 result = p_sys->p_input->StartStreams();
465 msg_Err( p_demux, "Failed to start streams" );
469 /* Declare elementary streams */
470 es_format_t video_fmt;
471 es_format_Init( &video_fmt, VIDEO_ES, VLC_CODEC_UYVY );
472 video_fmt.video.i_width = p_sys->i_width;
473 video_fmt.video.i_height = p_sys->i_height;
474 video_fmt.video.i_sar_num = 1;
475 video_fmt.video.i_sar_den = 1;
476 video_fmt.video.i_frame_rate = p_sys->i_fps_num;
477 video_fmt.video.i_frame_rate_base = p_sys->i_fps_den;
478 video_fmt.i_bitrate = video_fmt.video.i_width * video_fmt.video.i_height * video_fmt.video.i_frame_rate * 2 * 8;
480 psz_tmp = var_CreateGetNonEmptyString( p_demux, "sdi-aspect-ratio" );
483 char *psz_denominator = strchr( psz_tmp, ':' );
484 if( psz_denominator )
486 *psz_denominator++ = '\0';
487 video_fmt.video.i_sar_num = atoi( psz_tmp ) * video_fmt.video.i_height;
488 video_fmt.video.i_sar_den = atoi( psz_denominator ) * video_fmt.video.i_width;
493 msg_Dbg( p_demux, "added new video es %4.4s %dx%d",
494 (char*)&video_fmt.i_codec, video_fmt.video.i_width, video_fmt.video.i_height );
495 p_sys->p_video_es = es_out_Add( p_demux->out, &video_fmt );
497 es_format_t audio_fmt;
498 es_format_Init( &audio_fmt, AUDIO_ES, VLC_CODEC_S16N );
499 audio_fmt.audio.i_channels = p_sys->i_channels;
500 audio_fmt.audio.i_rate = p_sys->i_rate;
501 audio_fmt.audio.i_bitspersample = 16;
502 audio_fmt.audio.i_blockalign = audio_fmt.audio.i_channels * audio_fmt.audio.i_bitspersample / 8;
503 audio_fmt.i_bitrate = audio_fmt.audio.i_channels * audio_fmt.audio.i_rate * audio_fmt.audio.i_bitspersample;
505 msg_Dbg( p_demux, "added new audio es %4.4s %dHz %dbpp %dch",
506 (char*)&audio_fmt.i_codec, audio_fmt.audio.i_rate, audio_fmt.audio.i_bitspersample, audio_fmt.audio.i_channels);
507 p_sys->p_audio_es = es_out_Add( p_demux->out, &audio_fmt );
509 p_sys->b_first_frame = true;
511 /* Update default_pts to a suitable value for access */
512 var_Create( p_demux, "sdi-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
517 static void Close( vlc_object_t *p_this )
519 demux_t *p_demux = (demux_t *)p_this;
520 demux_sys_t *p_sys = p_demux->p_sys;
525 static int Control( demux_t *p_demux, int i_query, va_list args )
532 /* Special for access_demux */
533 case DEMUX_CAN_PAUSE:
535 case DEMUX_CAN_CONTROL_PACE:
536 pb = (bool*)va_arg( args, bool * );
540 case DEMUX_GET_PTS_DELAY:
541 pi64 = (int64_t*)va_arg( args, int64_t * );
542 *pi64 = var_GetInteger( p_demux, "sdi-caching" ) * 1000;
546 pi64 = (int64_t*)va_arg( args, int64_t * );
547 *pi64 = mdate(); // FIXME
550 /* TODO implement others */
558 static int Demux( demux_t *p_demux )
560 demux_sys_t *p_sys = p_demux->p_sys;
561 block_t *p_video_block = NULL;
562 block_t *p_audio_block = NULL;
564 vlc_mutex_lock( &p_sys->frame_lock );
566 while( !p_sys->p_video_frame && !p_sys->p_audio_frame )
567 vlc_cond_wait( &p_sys->has_frame, &p_sys->frame_lock );
569 p_video_block = p_sys->p_video_frame;
570 p_sys->p_video_frame = NULL;
572 p_audio_block = p_sys->p_audio_frame;
573 p_sys->p_audio_frame = NULL;
575 vlc_mutex_unlock( &p_sys->frame_lock );
579 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_video_block->i_pts );
580 es_out_Send( p_demux->out, p_sys->p_video_es, p_video_block );
585 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_audio_block->i_pts );
586 es_out_Send( p_demux->out, p_sys->p_audio_es, p_audio_block );