1 /*****************************************************************************
2 * decklink.cpp: BlackMagic DeckLink SDI input module
3 *****************************************************************************
4 * Copyright (C) 2010 Steinar H. Gunderson
6 * Authors: Steinar H. Gunderson <steinar+vlc@gunderson.no>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 *****************************************************************************/
24 #define __STDC_CONSTANT_MACROS 1
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_demux.h>
33 #include <vlc_atomic.h>
35 #include <arpa/inet.h>
37 #include <DeckLinkAPI.h>
38 #include <DeckLinkAPIDispatch.cpp>
40 static int Open ( vlc_object_t * );
41 static void Close( vlc_object_t * );
43 #define CARD_INDEX_TEXT N_("Input card to use")
44 #define CARD_INDEX_LONGTEXT N_( \
45 "DeckLink capture card to use, if multiple exist. " \
46 "The cards are numbered from 0." )
48 #define MODE_TEXT N_("Desired input video mode")
49 #define MODE_LONGTEXT N_( \
50 "Desired input video mode for DeckLink captures. " \
51 "This value should be a FOURCC code in textual " \
52 "form, e.g. \"ntsc\"." )
54 #define CACHING_TEXT N_("Caching value in ms")
55 #define CACHING_LONGTEXT N_( \
56 "Caching value for DeckLink captures. This " \
57 "value should be set in milliseconds." )
59 #define AUDIO_CONNECTION_TEXT N_("Audio connection")
60 #define AUDIO_CONNECTION_LONGTEXT N_( \
61 "Audio connection to use for DeckLink captures. " \
62 "Valid choices: embedded, aesebu, analog. " \
63 "Leave blank for card default." )
65 #define RATE_TEXT N_("Audio sampling rate in Hz")
66 #define RATE_LONGTEXT N_( \
67 "Audio sampling rate (in hertz) for DeckLink captures. " \
68 "0 disables audio input." )
70 #define CHANNELS_TEXT N_("Number of audio channels")
71 #define CHANNELS_LONGTEXT N_( \
72 "Number of input audio channels for DeckLink captures. " \
73 "Must be 2, 8 or 16. 0 disables audio input." )
75 #define VIDEO_CONNECTION_TEXT N_("Video connection")
76 #define VIDEO_CONNECTION_LONGTEXT N_( \
77 "Video connection to use for DeckLink captures. " \
78 "Valid choices: sdi, hdmi, opticalsdi, component, " \
79 "composite, svideo. " \
80 "Leave blank for card default." )
82 static const char *const ppsz_videoconns[] = {
83 "sdi", "hdmi", "opticalsdi", "component", "composite", "svideo"
85 static const char *const ppsz_videoconns_text[] = {
86 N_("SDI"), N_("HDMI"), N_("Optical SDI"), N_("Component"), N_("Composite"), N_("S-video")
89 static const char *const ppsz_audioconns[] = {
90 "embedded", "aesebu", "analog"
92 static const char *const ppsz_audioconns_text[] = {
93 N_("Embedded"), N_("AES/EBU"), N_("Analog")
96 #define ASPECT_RATIO_TEXT N_("Aspect ratio")
97 #define ASPECT_RATIO_LONGTEXT N_( \
98 "Aspect ratio (4:3, 16:9). Default assumes square pixels." )
101 set_shortname( N_("DeckLink") )
102 set_description( N_("Blackmagic DeckLink SDI input") )
103 set_category( CAT_INPUT )
104 set_subcategory( SUBCAT_INPUT_ACCESS )
106 add_integer( "decklink-card-index", 0,
107 CARD_INDEX_TEXT, CARD_INDEX_LONGTEXT, true )
108 add_string( "decklink-mode", "pal ",
109 MODE_TEXT, MODE_LONGTEXT, true )
110 add_integer( "decklink-caching", DEFAULT_PTS_DELAY / 1000,
111 CACHING_TEXT, CACHING_LONGTEXT, true )
112 add_string( "decklink-audio-connection", 0,
113 AUDIO_CONNECTION_TEXT, AUDIO_CONNECTION_LONGTEXT, true )
114 change_string_list( ppsz_audioconns, ppsz_audioconns_text, 0 )
115 add_integer( "decklink-audio-rate", 48000,
116 RATE_TEXT, RATE_LONGTEXT, true )
117 add_integer( "decklink-audio-channels", 2,
118 CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
119 add_string( "decklink-video-connection", 0,
120 VIDEO_CONNECTION_TEXT, VIDEO_CONNECTION_LONGTEXT, true )
121 change_string_list( ppsz_videoconns, ppsz_videoconns_text, 0 )
122 add_string( "decklink-aspect-ratio", NULL,
123 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, true )
125 add_shortcut( "decklink" )
126 set_capability( "access_demux", 10 )
127 set_callbacks( Open, Close )
130 static int Control( demux_t *, int, va_list );
132 class DeckLinkCaptureDelegate;
137 IDeckLinkInput *p_input;
138 DeckLinkCaptureDelegate *p_delegate;
140 /* We need to hold onto the IDeckLinkConfiguration object, or our settings will not apply.
141 See section 2.4.15 of the Blackmagic Decklink SDK documentation. */
142 IDeckLinkConfiguration *p_config;
144 es_out_id_t *p_video_es;
145 es_out_id_t *p_audio_es;
147 vlc_mutex_t pts_lock;
148 int i_last_pts; /* protected by <pts_lock> */
150 uint32_t i_dominance_flags;
154 class DeckLinkCaptureDelegate : public IDeckLinkInputCallback
157 DeckLinkCaptureDelegate( demux_t *p_demux ) : p_demux_(p_demux)
159 vlc_atomic_set( &m_ref_, 1 );
162 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
164 virtual ULONG STDMETHODCALLTYPE AddRef(void)
166 return vlc_atomic_inc( &m_ref_ );
169 virtual ULONG STDMETHODCALLTYPE Release(void)
171 uintptr_t new_ref = vlc_atomic_dec( &m_ref_ );
177 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents, IDeckLinkDisplayMode*, BMDDetectedVideoInputFormatFlags)
179 msg_Dbg( p_demux_, "Video input format changed" );
183 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame*, IDeckLinkAudioInputPacket*);
190 HRESULT DeckLinkCaptureDelegate::VideoInputFrameArrived(IDeckLinkVideoInputFrame* videoFrame, IDeckLinkAudioInputPacket* audioFrame)
192 demux_sys_t *p_sys = p_demux_->p_sys;
193 block_t *p_video_frame = NULL;
194 block_t *p_audio_frame = NULL;
198 if( videoFrame->GetFlags() & bmdFrameHasNoInputSource )
200 msg_Warn( p_demux_, "No input signal detected" );
204 const int i_width = videoFrame->GetWidth();
205 const int i_height = videoFrame->GetHeight();
206 const int i_stride = videoFrame->GetRowBytes();
209 p_video_frame = block_New( p_demux_, i_width * i_height * i_bpp );
212 msg_Err( p_demux_, "Could not allocate memory for video frame" );
217 videoFrame->GetBytes( &frame_bytes );
218 for( int y = 0; y < i_height; ++y )
220 const uint8_t *src = (const uint8_t *)frame_bytes + i_stride * y;
221 uint8_t *dst = p_video_frame->p_buffer + i_width * i_bpp * y;
222 memcpy( dst, src, i_width * i_bpp );
225 BMDTimeValue stream_time, frame_duration;
226 videoFrame->GetStreamTime( &stream_time, &frame_duration, CLOCK_FREQ );
227 p_video_frame->i_flags = BLOCK_FLAG_TYPE_I | p_sys->i_dominance_flags;
228 p_video_frame->i_pts = p_video_frame->i_dts = VLC_TS_0 + stream_time;
230 vlc_mutex_lock( &p_sys->pts_lock );
231 if( p_video_frame->i_pts > p_sys->i_last_pts )
232 p_sys->i_last_pts = p_video_frame->i_pts;
233 vlc_mutex_unlock( &p_sys->pts_lock );
235 es_out_Control( p_demux_->out, ES_OUT_SET_PCR, p_video_frame->i_pts );
236 es_out_Send( p_demux_->out, p_sys->p_video_es, p_video_frame );
241 const int i_bytes = audioFrame->GetSampleFrameCount() * sizeof(int16_t) * p_sys->i_channels;
243 p_audio_frame = block_New( p_demux_, i_bytes );
246 msg_Err( p_demux_, "Could not allocate memory for audio frame" );
248 block_Release( p_video_frame );
253 audioFrame->GetBytes( &frame_bytes );
254 memcpy( p_audio_frame->p_buffer, frame_bytes, i_bytes );
256 BMDTimeValue packet_time;
257 audioFrame->GetPacketTime( &packet_time, CLOCK_FREQ );
258 p_audio_frame->i_pts = p_audio_frame->i_dts = VLC_TS_0 + packet_time;
260 vlc_mutex_lock( &p_sys->pts_lock );
261 if( p_audio_frame->i_pts > p_sys->i_last_pts )
262 p_sys->i_last_pts = p_audio_frame->i_pts;
263 vlc_mutex_unlock( &p_sys->pts_lock );
264 if( p_audio_frame->i_pts > p_sys->i_last_pts )
266 es_out_Control( p_demux_->out, ES_OUT_SET_PCR, p_audio_frame->i_pts );
267 es_out_Send( p_demux_->out, p_sys->p_audio_es, p_audio_frame );
273 static int Open( vlc_object_t *p_this )
275 demux_t *p_demux = (demux_t*)p_this;
277 int ret = VLC_EGENERIC;
279 char *psz_display_mode = NULL;
280 char *psz_video_connection = NULL;
281 char *psz_audio_connection = NULL;
284 int i_width, i_height, i_fps_num, i_fps_den;
286 unsigned u_aspect_num, u_aspect_den;
288 /* Only when selected */
289 if( *p_demux->psz_access == '\0' )
293 p_demux->pf_demux = NULL;
294 p_demux->pf_control = Control;
295 p_demux->info.i_update = 0;
296 p_demux->info.i_title = 0;
297 p_demux->info.i_seekpoint = 0;
298 p_demux->p_sys = p_sys = (demux_sys_t*)calloc( 1, sizeof( demux_sys_t ) );
302 vlc_mutex_init( &p_sys->pts_lock );
304 IDeckLinkDisplayModeIterator *p_display_iterator = NULL;
306 IDeckLinkIterator *decklink_iterator = CreateDeckLinkIteratorInstance();
307 if( !decklink_iterator )
309 msg_Err( p_demux, "DeckLink drivers not found." );
315 i_card_index = var_InheritInteger( p_demux, "decklink-card-index" );
316 if( i_card_index < 0 )
318 msg_Err( p_demux, "Invalid card index %d", i_card_index );
322 for( int i = 0; i <= i_card_index; ++i )
325 p_sys->p_card->Release();
326 result = decklink_iterator->Next( &p_sys->p_card );
333 msg_Err( p_demux, "DeckLink PCI card %d not found", i_card_index );
337 const char *psz_model_name;
338 result = p_sys->p_card->GetModelName( &psz_model_name );
342 msg_Err( p_demux, "Could not get model name" );
346 msg_Dbg( p_demux, "Opened DeckLink PCI card %d (%s)", i_card_index, psz_model_name );
348 if( p_sys->p_card->QueryInterface( IID_IDeckLinkInput, (void**)&p_sys->p_input) != S_OK )
350 msg_Err( p_demux, "Card has no inputs" );
354 /* Set up the video and audio sources. */
355 if( p_sys->p_card->QueryInterface( IID_IDeckLinkConfiguration, (void**)&p_sys->p_config) != S_OK )
357 msg_Err( p_demux, "Failed to get configuration interface" );
361 psz_video_connection = var_InheritString( p_demux, "decklink-video-connection" );
362 if( psz_video_connection )
364 BMDVideoConnection conn;
365 if ( !strcmp( psz_video_connection, "sdi" ) )
366 conn = bmdVideoConnectionSDI;
367 else if ( !strcmp( psz_video_connection, "hdmi" ) )
368 conn = bmdVideoConnectionHDMI;
369 else if ( !strcmp( psz_video_connection, "opticalsdi" ) )
370 conn = bmdVideoConnectionOpticalSDI;
371 else if ( !strcmp( psz_video_connection, "component" ) )
372 conn = bmdVideoConnectionComponent;
373 else if ( !strcmp( psz_video_connection, "composite" ) )
374 conn = bmdVideoConnectionComposite;
375 else if ( !strcmp( psz_video_connection, "svideo" ) )
376 conn = bmdVideoConnectionSVideo;
379 msg_Err( p_demux, "Invalid --decklink-video-connection specified; choose one of " \
380 "sdi, hdmi, opticalsdi, component, composite, or svideo." );
384 msg_Dbg( p_demux, "Setting video input connection to 0x%x", conn);
385 result = p_sys->p_config->SetInt( bmdDeckLinkConfigVideoInputConnection, conn );
388 msg_Err( p_demux, "Failed to set video input connection" );
393 psz_audio_connection = var_CreateGetNonEmptyString( p_demux, "decklink-audio-connection" );
394 if( psz_audio_connection )
396 BMDAudioConnection conn;
397 if ( !strcmp( psz_audio_connection, "embedded" ) )
398 conn = bmdAudioConnectionEmbedded;
399 else if ( !strcmp( psz_audio_connection, "aesebu" ) )
400 conn = bmdAudioConnectionAESEBU;
401 else if ( !strcmp( psz_audio_connection, "analog" ) )
402 conn = bmdAudioConnectionAnalog;
405 msg_Err( p_demux, "Invalid --decklink-audio-connection specified; choose one of " \
406 "embedded, aesebu, or analog." );
410 msg_Dbg( p_demux, "Setting audio input format to 0x%x", conn);
411 result = p_sys->p_config->SetInt( bmdDeckLinkConfigAudioInputConnection, conn );
414 msg_Err( p_demux, "Failed to set audio input connection" );
419 /* Get the list of display modes. */
420 result = p_sys->p_input->GetDisplayModeIterator( &p_display_iterator );
423 msg_Err( p_demux, "Failed to enumerate display modes" );
427 psz_display_mode = var_CreateGetNonEmptyString( p_demux, "decklink-mode" );
428 if( !psz_display_mode || strlen( psz_display_mode ) > 4 ) {
429 msg_Err( p_demux, "Missing or invalid --decklink-mode string" );
434 * Pad the --decklink-mode string to four characters, so the user can specify e.g. "pal"
435 * without having to add the trailing space.
437 char sz_display_mode_padded[5];
438 strcpy(sz_display_mode_padded, " ");
439 for( int i = 0; i < strlen( psz_display_mode ); ++i )
440 sz_display_mode_padded[i] = psz_display_mode[i];
442 BMDDisplayMode wanted_mode_id;
443 memcpy( &wanted_mode_id, &sz_display_mode_padded, sizeof(wanted_mode_id) );
445 b_found_mode = false;
449 IDeckLinkDisplayMode *p_display_mode;
450 result = p_display_iterator->Next( &p_display_mode );
451 if( result != S_OK || !p_display_mode )
454 char sz_mode_id_text[5] = {0};
455 BMDDisplayMode mode_id = ntohl( p_display_mode->GetDisplayMode() );
456 memcpy( sz_mode_id_text, &mode_id, sizeof(mode_id) );
458 const char *psz_mode_name;
459 result = p_display_mode->GetName( &psz_mode_name );
462 msg_Err( p_demux, "Failed to get display mode name" );
463 p_display_mode->Release();
467 BMDTimeValue frame_duration, time_scale;
468 result = p_display_mode->GetFrameRate( &frame_duration, &time_scale );
471 msg_Err( p_demux, "Failed to get frame rate" );
472 p_display_mode->Release();
476 const char *psz_field_dominance;
477 uint32_t i_dominance_flags = 0;
478 switch( p_display_mode->GetFieldDominance() )
480 case bmdProgressiveFrame:
481 psz_field_dominance = "";
483 case bmdProgressiveSegmentedFrame:
484 psz_field_dominance = ", segmented";
486 case bmdLowerFieldFirst:
487 psz_field_dominance = ", interlaced [BFF]";
488 i_dominance_flags = BLOCK_FLAG_BOTTOM_FIELD_FIRST;
490 case bmdUpperFieldFirst:
491 psz_field_dominance = ", interlaced [TFF]";
492 i_dominance_flags = BLOCK_FLAG_TOP_FIELD_FIRST;
494 case bmdUnknownFieldDominance:
496 psz_field_dominance = ", unknown field dominance";
500 msg_Dbg( p_demux, "Found mode '%s': %s (%dx%d, %.3f fps%s)",
501 sz_mode_id_text, psz_mode_name,
502 p_display_mode->GetWidth(), p_display_mode->GetHeight(),
503 double(time_scale) / frame_duration, psz_field_dominance );
505 if( wanted_mode_id == mode_id )
508 i_width = p_display_mode->GetWidth();
509 i_height = p_display_mode->GetHeight();
510 i_fps_num = time_scale;
511 i_fps_den = frame_duration;
512 p_sys->i_dominance_flags = i_dominance_flags;
515 p_display_mode->Release();
520 msg_Err( p_demux, "Unknown video mode specified. " \
521 "Run VLC with -v --verbose-objects=-all,+decklink " \
522 "to get a list of supported modes." );
526 result = p_sys->p_input->EnableVideoInput( htonl( wanted_mode_id ), bmdFormat8BitYUV, 0 );
529 msg_Err( p_demux, "Failed to enable video input" );
534 p_sys->i_channels = var_InheritInteger( p_demux, "decklink-audio-channels" );
535 i_rate = var_InheritInteger( p_demux, "decklink-audio-rate" );
536 if( i_rate > 0 && p_sys->i_channels > 0 )
538 result = p_sys->p_input->EnableAudioInput( i_rate, bmdAudioSampleType16bitInteger, p_sys->i_channels );
541 msg_Err( p_demux, "Failed to enable audio input" );
546 p_sys->p_delegate = new DeckLinkCaptureDelegate( p_demux );
547 p_sys->p_input->SetCallback( p_sys->p_delegate );
549 result = p_sys->p_input->StartStreams();
552 msg_Err( p_demux, "Could not start streaming from SDI card. This could be caused "
553 "by invalid video mode or flags, access denied, or card already in use." );
557 /* Declare elementary streams */
558 es_format_t video_fmt;
559 es_format_Init( &video_fmt, VIDEO_ES, VLC_CODEC_UYVY );
560 video_fmt.video.i_width = i_width;
561 video_fmt.video.i_height = i_height;
562 video_fmt.video.i_sar_num = 1;
563 video_fmt.video.i_sar_den = 1;
564 video_fmt.video.i_frame_rate = i_fps_num;
565 video_fmt.video.i_frame_rate_base = i_fps_den;
566 video_fmt.i_bitrate = video_fmt.video.i_width * video_fmt.video.i_height * video_fmt.video.i_frame_rate * 2 * 8;
568 if ( !var_InheritURational( p_demux, &u_aspect_num, &u_aspect_den, "decklink-aspect-ratio" ) &&
569 u_aspect_num > 0 && u_aspect_den > 0 ) {
570 video_fmt.video.i_sar_num = u_aspect_num * video_fmt.video.i_height;
571 video_fmt.video.i_sar_den = u_aspect_den * video_fmt.video.i_width;
574 msg_Dbg( p_demux, "added new video es %4.4s %dx%d",
575 (char*)&video_fmt.i_codec, video_fmt.video.i_width, video_fmt.video.i_height );
576 p_sys->p_video_es = es_out_Add( p_demux->out, &video_fmt );
578 es_format_t audio_fmt;
579 es_format_Init( &audio_fmt, AUDIO_ES, VLC_CODEC_S16N );
580 audio_fmt.audio.i_channels = p_sys->i_channels;
581 audio_fmt.audio.i_rate = i_rate;
582 audio_fmt.audio.i_bitspersample = 16;
583 audio_fmt.audio.i_blockalign = audio_fmt.audio.i_channels * audio_fmt.audio.i_bitspersample / 8;
584 audio_fmt.i_bitrate = audio_fmt.audio.i_channels * audio_fmt.audio.i_rate * audio_fmt.audio.i_bitspersample;
586 msg_Dbg( p_demux, "added new audio es %4.4s %dHz %dbpp %dch",
587 (char*)&audio_fmt.i_codec, audio_fmt.audio.i_rate, audio_fmt.audio.i_bitspersample, audio_fmt.audio.i_channels);
588 p_sys->p_audio_es = es_out_Add( p_demux->out, &audio_fmt );
593 if( decklink_iterator )
594 decklink_iterator->Release();
596 free( psz_video_connection );
597 free( psz_audio_connection );
598 free( psz_display_mode );
600 if( p_display_iterator )
601 p_display_iterator->Release();
603 if( ret != VLC_SUCCESS )
609 static void Close( vlc_object_t *p_this )
611 demux_t *p_demux = (demux_t *)p_this;
612 demux_sys_t *p_sys = p_demux->p_sys;
614 if( p_sys->p_config )
615 p_sys->p_config->Release();
619 p_sys->p_input->StopStreams();
620 p_sys->p_input->Release();
624 p_sys->p_card->Release();
626 if( p_sys->p_delegate )
627 p_sys->p_delegate->Release();
629 vlc_mutex_destroy( &p_sys->pts_lock );
633 static int Control( demux_t *p_demux, int i_query, va_list args )
635 demux_sys_t *p_sys = p_demux->p_sys;
641 /* Special for access_demux */
642 case DEMUX_CAN_PAUSE:
644 case DEMUX_CAN_CONTROL_PACE:
645 pb = (bool*)va_arg( args, bool * );
649 case DEMUX_GET_PTS_DELAY:
650 pi64 = (int64_t*)va_arg( args, int64_t * );
651 *pi64 = var_InheritInteger( p_demux, "decklink-caching" ) * 1000;
655 pi64 = (int64_t*)va_arg( args, int64_t * );
656 vlc_mutex_lock( &p_sys->pts_lock );
657 *pi64 = p_sys->i_last_pts;
658 vlc_mutex_unlock( &p_sys->pts_lock );