2 * consumer_decklink.c -- output through Blackmagic Design DeckLink
3 * Copyright (C) 2010 Dan Dennedy <dan@dennedy.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with consumer library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #define __STDC_FORMAT_MACROS /* see inttypes.h */
21 #include <framework/mlt.h>
31 static const unsigned PREROLL_MINIMUM = 3;
33 class DeckLinkConsumer
34 : public IDeckLinkVideoOutputCallback
37 mlt_consumer_s m_consumer;
38 IDeckLink* m_deckLink;
39 IDeckLinkOutput* m_deckLinkOutput;
40 IDeckLinkDisplayMode* m_displayMode;
43 BMDTimeValue m_duration;
44 BMDTimeScale m_timescale;
49 IDeckLinkMutableVideoFrame* m_decklinkFrame;
52 IDeckLinkKeyer* m_deckLinkKeyer;
53 bool m_terminate_on_pause;
57 pthread_t m_prerollThread;
59 IDeckLinkDisplayMode* getDisplayMode()
61 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( getConsumer() ) );
62 IDeckLinkDisplayModeIterator* iter = NULL;
63 IDeckLinkDisplayMode* mode = NULL;
64 IDeckLinkDisplayMode* result = 0;
66 if ( m_deckLinkOutput->GetDisplayModeIterator( &iter ) == S_OK )
68 while ( !result && iter->Next( &mode ) == S_OK )
70 m_width = mode->GetWidth();
71 m_height = mode->GetHeight();
72 mode->GetFrameRate( &m_duration, &m_timescale );
73 m_fps = (double) m_timescale / m_duration;
74 int p = mode->GetFieldDominance() == bmdProgressiveFrame;
75 mlt_log_verbose( getConsumer(), "BMD mode %dx%d %.3f fps prog %d\n", m_width, m_height, m_fps, p );
77 if ( m_width == profile->width && p == profile->progressive
78 && m_fps == mlt_profile_fps( profile )
79 && ( m_height == profile->height || ( m_height == 486 && profile->height == 480 ) ) )
91 mlt_consumer getConsumer()
92 { return &m_consumer; }
97 m_deckLinkKeyer = NULL;
98 m_deckLinkOutput = NULL;
100 m_decklinkFrame = NULL;
105 SAFE_RELEASE( m_displayMode );
106 SAFE_RELEASE( m_deckLinkKeyer );
107 SAFE_RELEASE( m_deckLinkOutput );
108 SAFE_RELEASE( m_deckLink );
111 bool open( unsigned card = 0 )
115 IDeckLinkIterator* deckLinkIterator = NULL;
116 HRESULT result = CoInitialize( NULL );
117 if ( FAILED( result ) )
119 mlt_log_error( getConsumer(), "COM initialization failed\n" );
122 result = CoCreateInstance( CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL, IID_IDeckLinkIterator, (void**) &deckLinkIterator );
123 if ( FAILED( result ) )
125 mlt_log_error( getConsumer(), "The DeckLink drivers not installed.\n" );
129 IDeckLinkIterator* deckLinkIterator = CreateDeckLinkIteratorInstance();
131 if ( !deckLinkIterator )
133 mlt_log_error( getConsumer(), "The DeckLink drivers not installed.\n" );
138 // Connect to the Nth DeckLink instance
139 for ( i = 0; deckLinkIterator->Next( &m_deckLink ) == S_OK ; i++)
144 SAFE_RELEASE( m_deckLink );
146 SAFE_RELEASE( deckLinkIterator );
149 mlt_log_error( getConsumer(), "DeckLink card not found\n" );
153 // Obtain the audio/video output interface (IDeckLinkOutput)
154 if ( m_deckLink->QueryInterface( IID_IDeckLinkOutput, (void**)&m_deckLinkOutput ) != S_OK )
156 mlt_log_error( getConsumer(), "No DeckLink cards support output\n" );
157 SAFE_RELEASE( m_deckLink );
161 // Get the keyer interface
162 IDeckLinkAttributes *deckLinkAttributes = 0;
163 if ( m_deckLink->QueryInterface( IID_IDeckLinkAttributes, (void**) &deckLinkAttributes ) == S_OK )
170 if ( deckLinkAttributes->GetFlag( BMDDeckLinkSupportsInternalKeying, &flag ) == S_OK && flag )
172 if ( m_deckLink->QueryInterface( IID_IDeckLinkKeyer, (void**) &m_deckLinkKeyer ) != S_OK )
174 mlt_log_error( getConsumer(), "Failed to get keyer\n" );
175 SAFE_RELEASE( m_deckLinkOutput );
176 SAFE_RELEASE( m_deckLink );
180 SAFE_RELEASE( deckLinkAttributes );
183 // Provide this class as a delegate to the audio and video output interfaces
184 m_deckLinkOutput->SetScheduledFrameCompletionCallback( this );
190 void* preroll_thread()
193 for ( unsigned i = 0; i < m_preroll; i++ )
194 ScheduleNextFrame( true );
196 // start scheduled playback
197 m_deckLinkOutput->StartScheduledPlayback( 0, m_timescale, 1.0 );
202 static void* preroll_thread_proxy( void* arg )
204 DeckLinkConsumer* self = static_cast< DeckLinkConsumer* >( arg );
205 return self->preroll_thread();
208 bool start( unsigned preroll )
210 mlt_properties properties = MLT_CONSUMER_PROPERTIES( getConsumer() );
212 // Initialize members
215 m_decklinkFrame = NULL;
216 preroll = preroll < PREROLL_MINIMUM ? PREROLL_MINIMUM : preroll;
217 m_channels = mlt_properties_get_int( properties, "channels" );
218 m_isAudio = !mlt_properties_get_int( properties, "audio_off" );
219 m_terminate_on_pause = mlt_properties_get_int( properties, "terminate_on_pause" );
222 m_displayMode = getDisplayMode();
223 if ( !m_displayMode )
225 mlt_log_error( getConsumer(), "Profile is not compatible with decklink.\n" );
230 if ( m_deckLinkKeyer && ( m_isKeyer = mlt_properties_get_int( properties, "keyer" ) ) )
232 bool external = ( m_isKeyer == 2 );
233 double level = mlt_properties_get_double( properties, "keyer_level" );
235 if ( m_deckLinkKeyer->Enable( external ) != S_OK )
236 mlt_log_error( getConsumer(), "Failed to enable %s keyer\n",
237 external ? "external" : "internal" );
238 m_deckLinkKeyer->SetLevel( level <= 1 ? ( level > 0 ? 255 * level : 255 ) : 255 );
240 else if ( m_deckLinkKeyer )
242 m_deckLinkKeyer->Disable();
245 // Set the video output mode
246 if ( S_OK != m_deckLinkOutput->EnableVideoOutput( m_displayMode->GetDisplayMode(), bmdVideoOutputFlagDefault ) )
248 mlt_log_error( getConsumer(), "Failed to enable video output\n" );
252 // Set the audio output mode
255 m_deckLinkOutput->DisableAudioOutput();
258 if ( S_OK != m_deckLinkOutput->EnableAudioOutput( bmdAudioSampleRate48kHz, bmdAudioSampleType16bitInteger,
259 m_channels, bmdAudioOutputStreamTimestamped ) )
261 mlt_log_error( getConsumer(), "Failed to enable audio output\n" );
269 // Do preroll in thread to ensure asynchronicity of mlt_consumer_start().
270 pthread_create( &m_prerollThread, NULL, preroll_thread_proxy, this );
272 // Set the running state
273 mlt_properties_set_int( properties, "running", 1 );
280 mlt_properties properties = MLT_CONSUMER_PROPERTIES( getConsumer() );
281 bool wasRunning = !!mlt_properties_get_int( properties, "running" );
283 // set running state is 0
284 mlt_properties_set_int( properties, "running", 0 );
285 mlt_consumer_stopped( getConsumer() );
287 // Stop the audio and video output streams immediately
288 if ( m_deckLinkOutput )
290 m_deckLinkOutput->StopScheduledPlayback( 0, 0, 0 );
291 m_deckLinkOutput->DisableAudioOutput();
292 m_deckLinkOutput->DisableVideoOutput();
295 // release decklink frame
296 SAFE_RELEASE( m_decklinkFrame );
299 pthread_join( m_prerollThread, NULL );
304 void renderAudio( mlt_frame frame )
306 mlt_audio_format format = mlt_audio_s16;
307 int frequency = bmdAudioSampleRate48kHz;
308 int samples = mlt_sample_calculator( m_fps, frequency, m_count );
311 if ( !mlt_frame_get_audio( frame, (void**) &pcm, &format, &frequency, &m_channels, &samples ) )
314 unsigned long written = 0;
316 uint32_t written = 0;
318 BMDTimeValue streamTime = m_count * frequency * m_duration / m_timescale;
319 m_deckLinkOutput->GetBufferedAudioSampleFrameCount( &written );
320 if ( written > (m_preroll + 1) * samples )
322 mlt_log_verbose( getConsumer(), "renderAudio: will flush %lu audiosamples\n", written );
323 m_deckLinkOutput->FlushBufferedAudioSamples();
326 m_deckLinkOutput->ScheduleAudioSamples( pcm, samples, streamTime, frequency, (unsigned long*) &written );
328 m_deckLinkOutput->ScheduleAudioSamples( pcm, samples, streamTime, frequency, &written );
331 if ( written != (uint32_t) samples )
332 mlt_log_verbose( getConsumer(), "renderAudio: samples=%d, written=%lu\n", samples, written );
336 bool createFrame( IDeckLinkMutableVideoFrame** decklinkFrame )
338 BMDPixelFormat format = m_isKeyer? bmdFormat8BitARGB : bmdFormat8BitYUV;
339 IDeckLinkMutableVideoFrame* frame = 0;
341 int stride = m_width * ( m_isKeyer? 4 : 2 );
343 *decklinkFrame = NULL;
345 // Generate a DeckLink video frame
346 if ( S_OK != m_deckLinkOutput->CreateVideoFrame( m_width, m_height,
347 stride, format, bmdFrameFlagDefault, &frame ) )
349 mlt_log_verbose( getConsumer(), "Failed to create video frame\n" );
354 // Make the first line black for field order correction.
355 if ( S_OK == frame->GetBytes( (void**) &buffer ) && buffer )
359 memset( buffer, 0, stride );
361 else for ( int i = 0; i < m_width; i++ )
368 *decklinkFrame = frame;
373 void renderVideo( mlt_frame frame )
375 mlt_image_format format = m_isKeyer? mlt_image_rgb24a : mlt_image_yuv422;
377 int rendered = mlt_properties_get_int( MLT_FRAME_PROPERTIES(frame), "rendered");
378 int height = m_height;
380 if ( rendered && !mlt_frame_get_image( frame, &image, &format, &m_width, &height, 0 ) )
383 int stride = m_width * ( m_isKeyer? 4 : 2 );
385 SAFE_RELEASE( m_decklinkFrame );
386 if ( createFrame( &m_decklinkFrame ) )
387 m_decklinkFrame->GetBytes( (void**) &buffer );
391 int progressive = mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "progressive" );
393 // NTSC SDI is always 486 lines
394 if ( m_height == 486 && height == 480 )
396 // blank first 6 lines
399 memset( buffer, 0, stride * 6 );
400 buffer += stride * 6;
402 else for ( int i = 0; i < m_width * 6; i++ )
410 // Normal non-keyer playout - needs byte swapping
411 if ( !progressive && m_displayMode->GetFieldDominance() == bmdUpperFieldFirst )
412 // convert lower field first to top field first
413 swab( (char*) image, (char*) buffer + stride, stride * ( height - 1 ) );
415 swab( (char*) image, (char*) buffer, stride * height );
417 else if ( !mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "test_image" ) )
419 // Normal keyer output
421 uint32_t* s = (uint32_t*) image;
422 uint32_t* d = (uint32_t*) buffer;
424 if ( !progressive && m_displayMode->GetFieldDominance() == bmdUpperFieldFirst )
426 // Correct field order
432 // Need to relocate alpha channel RGBA => ARGB
438 *d++ = ( *s << 8 ) | ( *s >> 24 );
445 // Keying blank frames - nullify alpha
446 memset( buffer, 0, stride * height );
450 if ( m_decklinkFrame )
451 m_deckLinkOutput->ScheduleVideoFrame( m_decklinkFrame, m_count * m_duration, m_duration, m_timescale );
454 mlt_log_verbose( getConsumer(), "dropped video frame %u\n", ++m_dropped );
457 HRESULT render( mlt_frame frame )
459 HRESULT result = S_OK;
462 double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES(frame), "_speed" );
463 if ( m_isAudio && speed == 1.0 )
464 renderAudio( frame );
467 renderVideo( frame );
473 // *** DeckLink API implementation of IDeckLinkVideoOutputCallback IDeckLinkAudioOutputCallback *** //
475 // IUnknown needs only a dummy implementation
476 virtual HRESULT STDMETHODCALLTYPE QueryInterface( REFIID iid, LPVOID *ppv )
477 { return E_NOINTERFACE; }
478 virtual ULONG STDMETHODCALLTYPE AddRef()
480 virtual ULONG STDMETHODCALLTYPE Release()
483 /************************* DeckLink API Delegate Methods *****************************/
485 virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted( IDeckLinkVideoFrame* completedFrame, BMDOutputFrameCompletionResult completed )
489 mlt_properties properties = MLT_CONSUMER_PROPERTIES( getConsumer() );
491 if ( mlt_properties_get( properties, "priority" ) )
495 pthread_attr_t tattr;
496 struct sched_param param;
498 pthread_attr_init(&tattr);
499 pthread_attr_setschedpolicy(&tattr, SCHED_FIFO);
501 if ( !strcmp( "max", mlt_properties_get( properties, "priority" ) ) )
502 param.sched_priority = sched_get_priority_max(SCHED_FIFO) - 1;
503 else if ( !strcmp( "min", mlt_properties_get( properties, "priority" ) ) )
504 param.sched_priority = sched_get_priority_min(SCHED_FIFO) + 1;
506 param.sched_priority = mlt_properties_get_int( properties, "priority" );
508 pthread_attr_setschedparam(&tattr, ¶m);
510 thread = pthread_self();
512 r = pthread_setschedparam(thread, SCHED_FIFO, ¶m);
514 mlt_log_verbose( getConsumer(),
515 "ScheduledFrameCompleted: pthread_setschedparam returned %d\n", r);
517 mlt_log_verbose( getConsumer(),
518 "ScheduledFrameCompleted: param.sched_priority=%d\n", param.sched_priority);
529 m_deckLinkOutput->GetBufferedAudioSampleFrameCount( &cnt );
532 mlt_log_debug( getConsumer(),
533 "ScheduledFrameCompleted: GetBufferedAudioSampleFrameCount %u -> %lu, m_count=%"PRIu64"\n",
534 m_acnt, cnt, m_count );
538 // When a video frame has been released by the API, schedule another video frame to be output
540 // ignore handler if frame was flushed
541 if ( bmdOutputFrameFlushed == completed )
544 // schedule next frame
545 ScheduleNextFrame( false );
547 // step forward frames counter if underrun
548 if ( bmdOutputFrameDisplayedLate == completed )
550 mlt_log_verbose( getConsumer(), "ScheduledFrameCompleted: bmdOutputFrameDisplayedLate == completed\n" );
553 if ( bmdOutputFrameDropped == completed )
555 mlt_log_verbose( getConsumer(), "ScheduledFrameCompleted: bmdOutputFrameDropped == completed\n" );
562 virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped()
564 return mlt_consumer_is_stopped( getConsumer() ) ? S_FALSE : S_OK;
568 void ScheduleNextFrame( bool preroll )
571 mlt_consumer consumer = getConsumer();
573 // Get the properties
574 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
577 mlt_frame frame = NULL;
579 if( mlt_properties_get_int( properties, "running" ) || preroll )
581 frame = mlt_consumer_rt_frame( consumer );
586 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
588 // terminate on pause
589 if ( m_terminate_on_pause &&
590 mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" ) == 0.0 )
593 mlt_frame_close( frame );
599 /** Start the consumer.
602 static int start( mlt_consumer consumer )
604 // Get the properties
605 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
606 DeckLinkConsumer* decklink = (DeckLinkConsumer*) consumer->child;
607 return decklink->start( mlt_properties_get_int( properties, "preroll" ) ) ? 0 : 1;
610 /** Stop the consumer.
613 static int stop( mlt_consumer consumer )
615 // Get the properties
616 DeckLinkConsumer* decklink = (DeckLinkConsumer*) consumer->child;
617 return decklink->stop();
620 /** Determine if the consumer is stopped.
623 static int is_stopped( mlt_consumer consumer )
625 // Get the properties
626 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
627 return !mlt_properties_get_int( properties, "running" );
630 /** Close the consumer.
633 static void close( mlt_consumer consumer )
636 mlt_consumer_stop( consumer );
639 consumer->close = NULL;
640 mlt_consumer_close( consumer );
643 delete (DeckLinkConsumer*) consumer->child;
648 // Listen for the list_devices property to be set
649 static void on_property_changed( void*, mlt_properties properties, const char *name )
651 IDeckLinkIterator* decklinkIterator = NULL;
652 IDeckLink* decklink = NULL;
653 IDeckLinkInput* decklinkOutput = NULL;
656 if ( name && !strcmp( name, "list_devices" ) )
657 mlt_event_block( (mlt_event) mlt_properties_get_data( properties, "list-devices-event", NULL ) );
662 if ( FAILED( CoInitialize( NULL ) ) )
664 if ( FAILED( CoCreateInstance( CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL, IID_IDeckLinkIterator, (void**) &decklinkIterator ) ) )
667 if ( !( decklinkIterator = CreateDeckLinkIteratorInstance() ) )
670 for ( ; decklinkIterator->Next( &decklink ) == S_OK; i++ )
672 if ( decklink->QueryInterface( IID_IDeckLinkOutput, (void**) &decklinkOutput ) == S_OK )
674 DLString name = NULL;
675 if ( decklink->GetModelName( &name ) == S_OK )
677 char *name_cstr = getCString( name );
678 const char *format = "device.%d";
679 char *key = (char*) calloc( 1, strlen( format ) + 1 );
681 sprintf( key, format, i );
682 mlt_properties_set( properties, key, name_cstr );
684 freeDLString( name );
685 freeCString( name_cstr );
687 SAFE_RELEASE( decklinkOutput );
689 SAFE_RELEASE( decklink );
691 SAFE_RELEASE( decklinkIterator );
692 mlt_properties_set_int( properties, "devices", i );
695 /** Initialise the consumer.
698 mlt_consumer consumer_decklink_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
700 // Allocate the consumer
701 DeckLinkConsumer* decklink = new DeckLinkConsumer();
702 mlt_consumer consumer = NULL;
705 if ( decklink && !mlt_consumer_init( decklink->getConsumer(), decklink, profile ) )
707 // If initialises without error
708 if ( decklink->open( arg? atoi(arg) : 0 ) )
710 consumer = decklink->getConsumer();
711 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
714 consumer->close = close;
715 consumer->start = start;
716 consumer->stop = stop;
717 consumer->is_stopped = is_stopped;
718 mlt_properties_set( properties, "deinterlace_method", "onefield" );
720 mlt_event event = mlt_events_listen( properties, properties, "property-changed", (mlt_listener) on_property_changed );
721 mlt_properties_set_data( properties, "list-devices-event", event, 0, NULL, NULL );
729 extern mlt_producer producer_decklink_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg );
731 static mlt_properties metadata( mlt_service_type type, const char *id, void *data )
733 char file[ PATH_MAX ];
734 const char *service_type = NULL;
738 service_type = "consumer";
741 service_type = "producer";
746 snprintf( file, PATH_MAX, "%s/decklink/%s_%s.yml", mlt_environment( "MLT_DATA" ), service_type, id );
747 return mlt_properties_parse_yaml( file );
752 MLT_REGISTER( consumer_type, "decklink", consumer_decklink_init );
753 MLT_REGISTER( producer_type, "decklink", producer_decklink_init );
754 MLT_REGISTER_METADATA( consumer_type, "decklink", metadata, NULL );
755 MLT_REGISTER_METADATA( producer_type, "decklink", metadata, NULL );