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 CARD_INDEX_TEXT N_("Input card to use")
29 #define CARD_INDEX_LONGTEXT N_( \
30 "SDI capture card to use, if multiple exist. " \
31 "The cards are numbered from 0." )
33 #define MODE_TEXT N_("Desired input video mode")
34 #define MODE_LONGTEXT N_( \
35 "Desired input video mode for SDI captures. " \
36 "This value should be a FOURCC code in textual " \
37 "form, e.g. \"ntsc\"." )
39 #define CACHING_TEXT N_("Caching value in ms")
40 #define CACHING_LONGTEXT N_( \
41 "Caching value for SDI captures. This " \
42 "value should be set in milliseconds." )
44 #define AUDIO_CONNECTION_TEXT N_("Audio connection")
45 #define AUDIO_CONNECTION_LONGTEXT N_( \
46 "Audio connection to use for SDI captures. " \
47 "Valid choices: embedded, aesebu, analog. " \
48 "Leave blank for card default." )
50 #define RATE_TEXT N_("Audio sampling rate in Hz")
51 #define RATE_LONGTEXT N_( \
52 "Audio sampling rate (in hertz) for SDI captures. " \
53 "0 disables audio input." )
55 #define CHANNELS_TEXT N_("Number of audio channels")
56 #define CHANNELS_LONGTEXT N_( \
57 "Number of input audio channels for SDI captures. " \
58 "Must be 2, 8 or 16. 0 disables audio input." )
60 #define VIDEO_CONNECTION_TEXT N_("Video connection")
61 #define VIDEO_CONNECTION_LONGTEXT N_( \
62 "Video connection to use for SDI captures. " \
63 "Valid choices: sdi, hdmi, opticalsdi, component, " \
64 "composite, svideo. " \
65 "Leave blank for card default." )
67 #define ASPECT_RATIO_TEXT N_("Aspect ratio")
68 #define ASPECT_RATIO_LONGTEXT N_( \
69 "Aspect ratio (4:3, 16:9). Default assumes square pixels." )
72 set_shortname( N_("SDI") )
73 set_description( N_("BlackMagic SDI input") )
74 set_category( CAT_INPUT )
75 set_subcategory( SUBCAT_INPUT_ACCESS )
77 add_integer( "sdi-card-index", 0, NULL,
78 CARD_INDEX_TEXT, CARD_INDEX_LONGTEXT, true )
79 add_string( "sdi-mode", "pal ", NULL,
80 MODE_TEXT, MODE_LONGTEXT, true )
81 add_integer( "sdi-caching", DEFAULT_PTS_DELAY / 1000, NULL,
82 CACHING_TEXT, CACHING_LONGTEXT, true )
83 add_string( "sdi-audio-connection", 0, NULL,
84 AUDIO_CONNECTION_TEXT, AUDIO_CONNECTION_LONGTEXT, true )
85 add_integer( "sdi-audio-rate", 48000, NULL,
86 RATE_TEXT, RATE_LONGTEXT, true )
87 add_integer( "sdi-audio-channels", 2, NULL,
88 CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
89 add_string( "sdi-video-connection", 0, NULL,
90 VIDEO_CONNECTION_TEXT, VIDEO_CONNECTION_LONGTEXT, true )
91 add_string( "sdi-aspect-ratio", NULL, NULL,
92 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, true )
95 set_capability( "access_demux", 10 )
96 set_callbacks( Open, Close )
99 static int Demux ( demux_t * );
100 static int Control( demux_t *, int, va_list );
102 class DeckLinkCaptureDelegate;
107 IDeckLinkInput *p_input;
108 DeckLinkCaptureDelegate *p_delegate;
110 es_out_id_t *p_video_es;
111 es_out_id_t *p_audio_es;
115 int i_width, i_height, i_fps_num, i_fps_den;
116 uint32_t i_dominance_flags;
118 int i_rate, i_channels;
120 vlc_mutex_t frame_lock;
121 block_t *p_video_frame; /* protected by <frame_lock> */
122 block_t *p_audio_frame; /* protected by <frame_lock> */
123 vlc_cond_t has_frame; /* related to <frame_lock> */
126 class DeckLinkCaptureDelegate : public IDeckLinkInputCallback
129 DeckLinkCaptureDelegate( demux_t *p_demux ) : m_ref_(1), p_demux_(p_demux) {}
131 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
133 /* Note: AddRef() and Release() here are not thread safe. */
135 virtual ULONG STDMETHODCALLTYPE AddRef(void)
140 virtual ULONG STDMETHODCALLTYPE Release(void)
150 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents, IDeckLinkDisplayMode*, BMDDetectedVideoInputFormatFlags);
151 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame*, IDeckLinkAudioInputPacket*);
158 HRESULT DeckLinkCaptureDelegate::VideoInputFormatChanged(BMDVideoInputFormatChangedEvents events, IDeckLinkDisplayMode *mode, BMDDetectedVideoInputFormatFlags)
160 msg_Dbg( p_demux_, "Video input format changed" );
164 HRESULT DeckLinkCaptureDelegate::VideoInputFrameArrived(IDeckLinkVideoInputFrame* videoFrame, IDeckLinkAudioInputPacket* audioFrame)
166 demux_sys_t *p_sys = p_demux_->p_sys;
167 block_t *p_video_frame = NULL;
168 block_t *p_audio_frame = NULL;
172 if( videoFrame->GetFlags() & bmdFrameHasNoInputSource )
174 msg_Warn( p_demux_, "No input signal detected" );
178 const int i_width = videoFrame->GetWidth();
179 const int i_height = videoFrame->GetHeight();
180 const int i_stride = videoFrame->GetRowBytes();
183 p_video_frame = block_New( p_demux_, i_width * i_height * i_bpp );
186 msg_Err( p_demux_, "Could not allocate memory for video frame" );
191 videoFrame->GetBytes( &frame_bytes );
192 for( int y = 0; y < i_height; ++y )
194 const uint8_t *src = (const uint8_t *)frame_bytes + i_stride * y;
195 uint8_t *dst = (uint8_t *)p_video_frame->p_buffer + i_width * i_bpp * y;
196 memcpy( dst, src, i_width * i_bpp );
199 BMDTimeValue stream_time, frame_duration;
200 videoFrame->GetStreamTime( &stream_time, &frame_duration, CLOCK_FREQ );
201 p_video_frame->i_flags = BLOCK_FLAG_TYPE_I | p_sys->i_dominance_flags;
202 if( p_sys->b_first_frame )
204 p_video_frame->i_flags |= BLOCK_FLAG_DISCONTINUITY;
205 p_sys->b_first_frame = false;
207 p_video_frame->i_pts = p_video_frame->i_dts = VLC_TS_0 + stream_time;
212 const int i_bytes = audioFrame->GetSampleFrameCount() * sizeof(int16_t) * p_sys->i_channels;
214 p_audio_frame = block_New( p_demux_, i_bytes );
217 msg_Err( p_demux_, "Could not allocate memory for audio frame" );
222 audioFrame->GetBytes( &frame_bytes );
223 memcpy( p_audio_frame->p_buffer, frame_bytes, i_bytes );
225 BMDTimeValue packet_time;
226 audioFrame->GetPacketTime( &packet_time, CLOCK_FREQ );
227 p_audio_frame->i_pts = p_audio_frame->i_dts = VLC_TS_0 + packet_time;
230 if( p_video_frame || p_audio_frame )
232 vlc_mutex_lock( &p_sys->frame_lock );
235 if( p_sys->p_video_frame )
236 block_Release( p_sys->p_video_frame );
237 p_sys->p_video_frame = p_video_frame;
241 if( p_sys->p_audio_frame )
242 block_Release( p_sys->p_audio_frame );
243 p_sys->p_audio_frame = p_audio_frame;
245 vlc_cond_signal( &p_sys->has_frame );
246 vlc_mutex_unlock( &p_sys->frame_lock );
252 static int Open( vlc_object_t *p_this )
254 demux_t *p_demux = (demux_t*)p_this;
257 /* Only when selected */
258 if( *p_demux->psz_access == '\0' )
262 p_demux->pf_demux = Demux;
263 p_demux->pf_control = Control;
264 p_demux->info.i_update = 0;
265 p_demux->info.i_title = 0;
266 p_demux->info.i_seekpoint = 0;
267 p_demux->p_sys = p_sys = (demux_sys_t*)calloc( 1, sizeof( demux_sys_t ) );
271 vlc_mutex_init( &p_sys->frame_lock );
272 vlc_cond_init( &p_sys->has_frame );
273 p_sys->p_video_frame = NULL;
275 IDeckLinkIterator *decklink_iterator = CreateDeckLinkIteratorInstance();
276 if( !decklink_iterator )
278 msg_Err( p_demux, "DeckLink drivers not found." );
279 decklink_iterator->Release();
286 int i_card_index = var_CreateGetInteger( p_demux, "sdi-card-index" );
287 for( int i = 0; i <= i_card_index; ++i )
290 p_sys->p_card->Release();
291 result = decklink_iterator->Next( &p_sys->p_card );
296 decklink_iterator->Release();
300 msg_Err( p_demux, "DeckLink PCI card %d not found", i_card_index );
305 const char *psz_model_name;
306 result = p_sys->p_card->GetModelName( &psz_model_name );
310 msg_Err( p_demux, "Could not get model name" );
315 msg_Dbg( p_demux, "Opened DeckLink PCI card %d (%s)", i_card_index, psz_model_name );
317 if( p_sys->p_card->QueryInterface( IID_IDeckLinkInput, (void**)&p_sys->p_input) != S_OK )
319 msg_Err( p_demux, "Card has no inputs" );
324 /* Set up the video and audio sources. */
325 IDeckLinkConfiguration *p_config;
326 if( p_sys->p_card->QueryInterface( IID_IDeckLinkConfiguration, (void**)&p_config) != S_OK )
328 msg_Err( p_demux, "Failed to get configuration interface" );
333 char *psz_tmp = var_CreateGetNonEmptyString( p_demux, "sdi-video-connection" );
336 BMDVideoConnection conn;
337 if ( !strcmp( psz_tmp, "sdi" ) )
338 conn = bmdVideoConnectionSDI;
339 else if ( !strcmp( psz_tmp, "hdmi" ) )
340 conn = bmdVideoConnectionHDMI;
341 else if ( !strcmp( psz_tmp, "opticalsdi" ) )
342 conn = bmdVideoConnectionOpticalSDI;
343 else if ( !strcmp( psz_tmp, "component" ) )
344 conn = bmdVideoConnectionComponent;
345 else if ( !strcmp( psz_tmp, "composite" ) )
346 conn = bmdVideoConnectionComposite;
347 else if ( !strcmp( psz_tmp, "svideo" ) )
348 conn = bmdVideoConnectionSVideo;
351 msg_Err( p_demux, "Invalid --sdi-video-connection specified; choose one of " \
352 "sdi, hdmi, opticalsdi, component, composite, or svideo." );
360 msg_Dbg( p_demux, "Setting video input format to 0x%x", conn);
361 result = p_config->SetVideoInputFormat( conn );
364 msg_Err( p_demux, "Failed to set video input connection" );
371 psz_tmp = var_CreateGetNonEmptyString( p_demux, "sdi-audio-connection" );
374 BMDAudioConnection conn;
375 if ( !strcmp( psz_tmp, "embedded" ) )
376 conn = bmdAudioConnectionEmbedded;
377 else if ( !strcmp( psz_tmp, "aesebu" ) )
378 conn = bmdAudioConnectionAESEBU;
379 else if ( !strcmp( psz_tmp, "analog" ) )
380 conn = bmdAudioConnectionAnalog;
383 msg_Err( p_demux, "Invalid --sdi-audio-connection specified; choose one of " \
384 "embedded, aesebu, or analog." );
392 msg_Dbg( p_demux, "Setting audio input format to 0x%x", conn);
393 result = p_config->SetAudioInputFormat( conn );
396 msg_Err( p_demux, "Failed to set audio input connection" );
405 /* Get the list of display modes. */
406 IDeckLinkDisplayModeIterator *p_display_iterator;
407 result = p_sys->p_input->GetDisplayModeIterator( &p_display_iterator );
410 msg_Err( p_demux, "Failed to enumerate display modes" );
411 p_display_iterator->Release();
416 char *psz_display_mode = var_CreateGetString( p_demux, "sdi-mode" );
417 if( !psz_display_mode || strlen( psz_display_mode ) == 0 || strlen( psz_display_mode ) > 4 ) {
418 msg_Err( p_demux, "Missing or invalid --sdi-mode string" );
419 free( psz_display_mode );
420 p_display_iterator->Release();
426 * Pad the --sdi-mode string to four characters, so the user can specify e.g. "pal"
427 * without having to add the trailing space.
429 char sz_display_mode_padded[5];
430 strcpy(sz_display_mode_padded, " ");
431 for( int i = 0; i < strlen( psz_display_mode ); ++i )
432 sz_display_mode_padded[i] = psz_display_mode[i];
434 free( psz_display_mode );
436 BMDDisplayMode wanted_mode_id;
437 memcpy( &wanted_mode_id, &sz_display_mode_padded, sizeof(wanted_mode_id) );
439 bool b_found_mode = false;
443 IDeckLinkDisplayMode *p_display_mode;
444 result = p_display_iterator->Next( &p_display_mode );
445 if( result != S_OK || !p_display_mode )
448 char sz_mode_id_text[5] = {0};
449 BMDDisplayMode mode_id = ntohl( p_display_mode->GetDisplayMode() );
450 memcpy( sz_mode_id_text, &mode_id, sizeof(mode_id) );
452 const char *psz_mode_name;
453 result = p_display_mode->GetName( &psz_mode_name );
456 msg_Err( p_demux, "Failed to get display mode name" );
457 p_display_mode->Release();
458 p_display_iterator->Release();
463 BMDTimeValue frame_duration, time_scale;
464 result = p_display_mode->GetFrameRate( &frame_duration, &time_scale );
467 msg_Err( p_demux, "Failed to get frame rate" );
468 p_display_mode->Release();
469 p_display_iterator->Release();
474 const char *psz_field_dominance;
475 uint32_t i_dominance_flags = 0;
476 switch( p_display_mode->GetFieldDominance() )
478 case bmdProgressiveFrame:
479 psz_field_dominance = "";
481 case bmdProgressiveSegmentedFrame:
482 psz_field_dominance = ", segmented";
484 case bmdLowerFieldFirst:
485 psz_field_dominance = ", interlaced [BFF]";
486 i_dominance_flags = BLOCK_FLAG_BOTTOM_FIELD_FIRST;
488 case bmdUpperFieldFirst:
489 psz_field_dominance = ", interlaced [TFF]";
490 i_dominance_flags = BLOCK_FLAG_TOP_FIELD_FIRST;
492 case bmdUnknownFieldDominance:
494 psz_field_dominance = ", unknown field dominance";
498 msg_Dbg( p_demux, "Found mode '%s': %s (%dx%d, %.3f fps%s)",
499 sz_mode_id_text, psz_mode_name,
500 p_display_mode->GetWidth(), p_display_mode->GetHeight(),
501 double(time_scale) / frame_duration, psz_field_dominance );
503 if( wanted_mode_id == mode_id )
506 p_sys->i_width = p_display_mode->GetWidth();
507 p_sys->i_height = p_display_mode->GetHeight();
508 p_sys->i_fps_num = time_scale;
509 p_sys->i_fps_den = frame_duration;
510 p_sys->i_dominance_flags = i_dominance_flags;
513 p_display_mode->Release();
516 p_display_iterator->Release();
520 msg_Err( p_demux, "Unknown SDI mode specified. " \
521 "Run VLC with -v --verbose-objects=-all,+sdi " \
522 "to get a list of supported modes." );
527 result = p_sys->p_input->EnableVideoInput( htonl( wanted_mode_id ), bmdFormat8BitYUV, 0 );
530 msg_Err( p_demux, "Failed to enable video input" );
536 p_sys->i_rate = var_CreateGetInteger( p_demux, "sdi-audio-rate" );
537 p_sys->i_channels = var_CreateGetInteger( p_demux, "sdi-audio-channels" );
538 if( p_sys->i_rate > 0 && p_sys->i_channels > 0 )
540 result = p_sys->p_input->EnableAudioInput( p_sys->i_rate, bmdAudioSampleType16bitInteger, p_sys->i_channels );
543 msg_Err( p_demux, "Failed to enable audio input" );
549 p_sys->p_delegate = new DeckLinkCaptureDelegate( p_demux );
550 p_sys->p_input->SetCallback( p_sys->p_delegate );
552 result = p_sys->p_input->StartStreams();
555 msg_Err( p_demux, "Failed to start streams" );
560 /* Declare elementary streams */
561 es_format_t video_fmt;
562 es_format_Init( &video_fmt, VIDEO_ES, VLC_CODEC_UYVY );
563 video_fmt.video.i_width = p_sys->i_width;
564 video_fmt.video.i_height = p_sys->i_height;
565 video_fmt.video.i_sar_num = 1;
566 video_fmt.video.i_sar_den = 1;
567 video_fmt.video.i_frame_rate = p_sys->i_fps_num;
568 video_fmt.video.i_frame_rate_base = p_sys->i_fps_den;
569 video_fmt.i_bitrate = video_fmt.video.i_width * video_fmt.video.i_height * video_fmt.video.i_frame_rate * 2 * 8;
571 psz_tmp = var_CreateGetNonEmptyString( p_demux, "sdi-aspect-ratio" );
574 char *psz_denominator = strchr( psz_tmp, ':' );
575 if( psz_denominator )
577 *psz_denominator++ = '\0';
578 video_fmt.video.i_sar_num = atoi( psz_tmp ) * video_fmt.video.i_height;
579 video_fmt.video.i_sar_den = atoi( psz_denominator ) * video_fmt.video.i_width;
584 msg_Dbg( p_demux, "added new video es %4.4s %dx%d",
585 (char*)&video_fmt.i_codec, video_fmt.video.i_width, video_fmt.video.i_height );
586 p_sys->p_video_es = es_out_Add( p_demux->out, &video_fmt );
588 es_format_t audio_fmt;
589 es_format_Init( &audio_fmt, AUDIO_ES, VLC_CODEC_S16N );
590 audio_fmt.audio.i_channels = p_sys->i_channels;
591 audio_fmt.audio.i_rate = p_sys->i_rate;
592 audio_fmt.audio.i_bitspersample = 16;
593 audio_fmt.audio.i_blockalign = audio_fmt.audio.i_channels * audio_fmt.audio.i_bitspersample / 8;
594 audio_fmt.i_bitrate = audio_fmt.audio.i_channels * audio_fmt.audio.i_rate * audio_fmt.audio.i_bitspersample;
596 msg_Dbg( p_demux, "added new audio es %4.4s %dHz %dbpp %dch",
597 (char*)&audio_fmt.i_codec, audio_fmt.audio.i_rate, audio_fmt.audio.i_bitspersample, audio_fmt.audio.i_channels);
598 p_sys->p_audio_es = es_out_Add( p_demux->out, &audio_fmt );
600 p_sys->b_first_frame = true;
602 /* Update default_pts to a suitable value for access */
603 var_Create( p_demux, "sdi-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
608 static void Close( vlc_object_t *p_this )
610 demux_t *p_demux = (demux_t *)p_this;
611 demux_sys_t *p_sys = p_demux->p_sys;
615 p_sys->p_input->StopStreams();
616 p_sys->p_input->Release();
620 p_sys->p_card->Release();
622 if( p_sys->p_delegate )
623 p_sys->p_delegate->Release();
625 if( p_sys->p_video_frame )
626 block_Release( p_sys->p_video_frame );
628 if( p_sys->p_audio_frame )
629 block_Release( p_sys->p_audio_frame );
634 static int Control( demux_t *p_demux, int i_query, va_list args )
636 demux_sys_t *p_sys = p_demux->p_sys;
642 /* Special for access_demux */
643 case DEMUX_CAN_PAUSE:
645 case DEMUX_CAN_CONTROL_PACE:
646 pb = (bool*)va_arg( args, bool * );
650 case DEMUX_GET_PTS_DELAY:
651 pi64 = (int64_t*)va_arg( args, int64_t * );
652 *pi64 = var_GetInteger( p_demux, "sdi-caching" ) * 1000;
656 pi64 = (int64_t*)va_arg( args, int64_t * );
657 *pi64 = p_sys->i_last_pts;
660 /* TODO implement others */
668 static int Demux( demux_t *p_demux )
670 demux_sys_t *p_sys = p_demux->p_sys;
671 block_t *p_video_block = NULL;
672 block_t *p_audio_block = NULL;
674 vlc_mutex_lock( &p_sys->frame_lock );
676 while( !p_sys->p_video_frame && !p_sys->p_audio_frame )
677 vlc_cond_wait( &p_sys->has_frame, &p_sys->frame_lock );
679 p_video_block = p_sys->p_video_frame;
680 p_sys->p_video_frame = NULL;
682 p_audio_block = p_sys->p_audio_frame;
683 p_sys->p_audio_frame = NULL;
685 vlc_mutex_unlock( &p_sys->frame_lock );
689 if( p_video_block->i_pts > p_sys->i_last_pts )
690 p_sys->i_last_pts = p_video_block->i_pts;
691 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_video_block->i_pts );
692 es_out_Send( p_demux->out, p_sys->p_video_es, p_video_block );
697 if( p_audio_block->i_pts > p_sys->i_last_pts )
698 p_sys->i_last_pts = p_audio_block->i_pts;
699 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_audio_block->i_pts );
700 es_out_Send( p_demux->out, p_sys->p_audio_es, p_audio_block );