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 #include "DeckLinkAPI_h.h"
33 #include "DeckLinkAPI.h"
36 #define SAFE_RELEASE(V) if (V) { V->Release(); V = NULL; }
38 static const unsigned PREROLL_MINIMUM = 3;
40 class DeckLinkConsumer
41 : public IDeckLinkVideoOutputCallback
44 mlt_consumer_s m_consumer;
45 IDeckLink* m_deckLink;
46 IDeckLinkOutput* m_deckLinkOutput;
47 IDeckLinkDisplayMode* m_displayMode;
50 BMDTimeValue m_duration;
51 BMDTimeScale m_timescale;
56 IDeckLinkMutableVideoFrame* m_decklinkFrame;
59 IDeckLinkKeyer* m_deckLinkKeyer;
60 bool m_terminate_on_pause;
64 pthread_t m_prerollThread;
66 IDeckLinkDisplayMode* getDisplayMode()
68 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( getConsumer() ) );
69 IDeckLinkDisplayModeIterator* iter = NULL;
70 IDeckLinkDisplayMode* mode = NULL;
71 IDeckLinkDisplayMode* result = 0;
73 if ( m_deckLinkOutput->GetDisplayModeIterator( &iter ) == S_OK )
75 while ( !result && iter->Next( &mode ) == S_OK )
77 m_width = mode->GetWidth();
78 m_height = mode->GetHeight();
79 mode->GetFrameRate( &m_duration, &m_timescale );
80 m_fps = (double) m_timescale / m_duration;
81 int p = mode->GetFieldDominance() == bmdProgressiveFrame;
82 mlt_log_verbose( getConsumer(), "BMD mode %dx%d %.3f fps prog %d\n", m_width, m_height, m_fps, p );
84 if ( m_width == profile->width && p == profile->progressive
85 && m_fps == mlt_profile_fps( profile )
86 && ( m_height == profile->height || ( m_height == 486 && profile->height == 480 ) ) )
98 mlt_consumer getConsumer()
99 { return &m_consumer; }
103 m_displayMode = NULL;
104 m_deckLinkKeyer = NULL;
105 m_deckLinkOutput = NULL;
111 SAFE_RELEASE( m_displayMode );
112 SAFE_RELEASE( m_deckLinkKeyer );
113 SAFE_RELEASE( m_deckLinkOutput );
114 SAFE_RELEASE( m_deckLink );
117 bool listDevices( mlt_properties properties )
119 IDeckLinkIterator* decklinkIterator = NULL;
124 HRESULT result = CoInitialize( NULL );
125 if ( FAILED( result ) )
126 throw "COM initialization failed";
127 result = CoCreateInstance( CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL, IID_IDeckLinkIterator, (void**) &decklinkIterator );
128 if ( FAILED( result ) )
129 throw "The DeckLink drivers are not installed.";
131 decklinkIterator = CreateDeckLinkIteratorInstance();
132 if ( !decklinkIterator )
133 throw "The DeckLink drivers are not installed.";
135 for ( ; decklinkIterator->Next( &m_deckLink ) == S_OK; i++ )
137 if ( m_deckLink->QueryInterface( IID_IDeckLinkOutput, (void**) &m_deckLinkOutput ) == S_OK )
140 if ( m_deckLink->GetModelName( (const char**) &name ) == S_OK )
142 const char *format = "device.%d";
143 char *key = (char*) calloc( 1, strlen( format ) + 1 );
145 sprintf( key, format, i );
146 mlt_properties_set( properties, key, name );
147 mlt_log_verbose( NULL, "[consumer decklink] %s = %s\n", key, name );
151 SAFE_RELEASE( m_deckLinkOutput );
153 SAFE_RELEASE( m_deckLink );
155 SAFE_RELEASE( decklinkIterator );
156 mlt_properties_set_int( properties, "devices", i );
157 mlt_log_verbose( NULL, "[consumer decklink] devices = %d\n", i );
161 catch ( const char *error )
163 SAFE_RELEASE( decklinkIterator );
164 mlt_log_error( getConsumer(), "%s\n", error );
169 bool open( unsigned card = 0 )
173 IDeckLinkIterator* deckLinkIterator = NULL;
174 HRESULT result = CoInitialize( NULL );
175 if ( FAILED( result ) )
177 mlt_log_error( getConsumer(), "COM initialization failed\n" );
180 result = CoCreateInstance( CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL, IID_IDeckLinkIterator, (void**) &deckLinkIterator );
181 if ( FAILED( result ) )
183 mlt_log_error( getConsumer(), "The DeckLink drivers not installed.\n" );
187 IDeckLinkIterator* deckLinkIterator = CreateDeckLinkIteratorInstance();
189 if ( !deckLinkIterator )
191 mlt_log_error( getConsumer(), "The DeckLink drivers not installed.\n" );
196 // Connect to the Nth DeckLink instance
197 for ( i = 0; deckLinkIterator->Next( &m_deckLink ) == S_OK ; i++)
202 SAFE_RELEASE( m_deckLink );
204 SAFE_RELEASE( deckLinkIterator );
207 mlt_log_error( getConsumer(), "DeckLink card not found\n" );
211 // Obtain the audio/video output interface (IDeckLinkOutput)
212 if ( m_deckLink->QueryInterface( IID_IDeckLinkOutput, (void**)&m_deckLinkOutput ) != S_OK )
214 mlt_log_error( getConsumer(), "No DeckLink cards support output\n" );
215 SAFE_RELEASE( m_deckLink );
219 // Get the keyer interface
220 IDeckLinkAttributes *deckLinkAttributes = 0;
221 if ( m_deckLink->QueryInterface( IID_IDeckLinkAttributes, (void**) &deckLinkAttributes ) == S_OK )
228 if ( deckLinkAttributes->GetFlag( BMDDeckLinkSupportsInternalKeying, &flag ) == S_OK && flag )
230 if ( m_deckLink->QueryInterface( IID_IDeckLinkKeyer, (void**) &m_deckLinkKeyer ) != S_OK )
232 mlt_log_error( getConsumer(), "Failed to get keyer\n" );
233 SAFE_RELEASE( m_deckLinkOutput );
234 SAFE_RELEASE( m_deckLink );
238 SAFE_RELEASE( deckLinkAttributes );
241 // Provide this class as a delegate to the audio and video output interfaces
242 m_deckLinkOutput->SetScheduledFrameCompletionCallback( this );
248 void* preroll_thread()
251 for ( unsigned i = 0; i < m_preroll; i++ )
252 ScheduleNextFrame( true );
254 // start scheduled playback
255 m_deckLinkOutput->StartScheduledPlayback( 0, m_timescale, 1.0 );
260 static void* preroll_thread_proxy( void* arg )
262 DeckLinkConsumer* self = static_cast< DeckLinkConsumer* >( arg );
263 return self->preroll_thread();
266 bool start( unsigned preroll )
268 mlt_properties properties = MLT_CONSUMER_PROPERTIES( getConsumer() );
270 // Initialize members
273 m_decklinkFrame = NULL;
274 preroll = preroll < PREROLL_MINIMUM ? PREROLL_MINIMUM : preroll;
275 m_channels = mlt_properties_get_int( properties, "channels" );
276 m_isAudio = !mlt_properties_get_int( properties, "audio_off" );
277 m_terminate_on_pause = mlt_properties_get_int( properties, "terminate_on_pause" );
280 m_displayMode = getDisplayMode();
281 if ( !m_displayMode )
283 mlt_log_error( getConsumer(), "Profile is not compatible with decklink.\n" );
288 if ( m_deckLinkKeyer && ( m_isKeyer = mlt_properties_get_int( properties, "keyer" ) ) )
290 bool external = ( m_isKeyer == 2 );
291 double level = mlt_properties_get_double( properties, "keyer_level" );
293 if ( m_deckLinkKeyer->Enable( external ) != S_OK )
294 mlt_log_error( getConsumer(), "Failed to enable %s keyer\n",
295 external ? "external" : "internal" );
296 m_deckLinkKeyer->SetLevel( level <= 1 ? ( level > 0 ? 255 * level : 255 ) : 255 );
298 else if ( m_deckLinkKeyer )
300 m_deckLinkKeyer->Disable();
303 // Set the video output mode
304 if ( S_OK != m_deckLinkOutput->EnableVideoOutput( m_displayMode->GetDisplayMode(), bmdVideoOutputFlagDefault ) )
306 mlt_log_error( getConsumer(), "Failed to enable video output\n" );
310 // Set the audio output mode
313 m_deckLinkOutput->DisableAudioOutput();
316 if ( S_OK != m_deckLinkOutput->EnableAudioOutput( bmdAudioSampleRate48kHz, bmdAudioSampleType16bitInteger,
317 m_channels, bmdAudioOutputStreamTimestamped ) )
319 mlt_log_error( getConsumer(), "Failed to enable audio output\n" );
327 // Do preroll in thread to ensure asynchronicity of mlt_consumer_start().
328 pthread_create( &m_prerollThread, NULL, preroll_thread_proxy, this );
330 // Set the running state
331 mlt_properties_set_int( properties, "running", 1 );
338 mlt_properties properties = MLT_CONSUMER_PROPERTIES( getConsumer() );
339 bool wasRunning = !!mlt_properties_get_int( properties, "running" );
341 // set running state is 0
342 mlt_properties_set_int( properties, "running", 0 );
343 mlt_consumer_stopped( getConsumer() );
345 // Stop the audio and video output streams immediately
346 if ( m_deckLinkOutput )
348 m_deckLinkOutput->StopScheduledPlayback( 0, 0, 0 );
349 m_deckLinkOutput->DisableAudioOutput();
350 m_deckLinkOutput->DisableVideoOutput();
353 // release decklink frame
354 SAFE_RELEASE( m_decklinkFrame );
357 pthread_join( m_prerollThread, NULL );
362 void renderAudio( mlt_frame frame )
364 mlt_audio_format format = mlt_audio_s16;
365 int frequency = bmdAudioSampleRate48kHz;
366 int samples = mlt_sample_calculator( m_fps, frequency, m_count );
369 if ( !mlt_frame_get_audio( frame, (void**) &pcm, &format, &frequency, &m_channels, &samples ) )
372 unsigned long written = 0;
374 uint32_t written = 0;
376 BMDTimeValue streamTime = m_count * frequency * m_duration / m_timescale;
377 m_deckLinkOutput->GetBufferedAudioSampleFrameCount( &written );
378 if ( written > (m_preroll + 1) * samples )
380 mlt_log_verbose( getConsumer(), "renderAudio: will flush %lu audiosamples\n", written );
381 m_deckLinkOutput->FlushBufferedAudioSamples();
384 m_deckLinkOutput->ScheduleAudioSamples( pcm, samples, streamTime, frequency, (unsigned long*) &written );
386 m_deckLinkOutput->ScheduleAudioSamples( pcm, samples, streamTime, frequency, &written );
389 if ( written != (uint32_t) samples )
390 mlt_log_verbose( getConsumer(), "renderAudio: samples=%d, written=%lu\n", samples, written );
394 bool createFrame( IDeckLinkMutableVideoFrame** decklinkFrame )
396 BMDPixelFormat format = m_isKeyer? bmdFormat8BitARGB : bmdFormat8BitYUV;
397 IDeckLinkMutableVideoFrame* frame = 0;
399 int stride = m_width * ( m_isKeyer? 4 : 2 );
401 *decklinkFrame = NULL;
403 // Generate a DeckLink video frame
404 if ( S_OK != m_deckLinkOutput->CreateVideoFrame( m_width, m_height,
405 stride, format, bmdFrameFlagDefault, &frame ) )
407 mlt_log_verbose( getConsumer(), "Failed to create video frame\n" );
412 // Make the first line black for field order correction.
413 if ( S_OK == frame->GetBytes( (void**) &buffer ) && buffer )
417 memset( buffer, 0, stride );
419 else for ( int i = 0; i < m_width; i++ )
426 *decklinkFrame = frame;
431 void renderVideo( mlt_frame frame )
433 mlt_image_format format = m_isKeyer? mlt_image_rgb24a : mlt_image_yuv422;
435 int rendered = mlt_properties_get_int( MLT_FRAME_PROPERTIES(frame), "rendered");
436 int height = m_height;
438 if ( rendered && !mlt_frame_get_image( frame, &image, &format, &m_width, &height, 0 ) )
441 int stride = m_width * ( m_isKeyer? 4 : 2 );
443 SAFE_RELEASE( m_decklinkFrame );
444 if ( createFrame( &m_decklinkFrame ) )
445 m_decklinkFrame->GetBytes( (void**) &buffer );
449 int progressive = mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "progressive" );
451 // NTSC SDI is always 486 lines
452 if ( m_height == 486 && height == 480 )
454 // blank first 6 lines
457 memset( buffer, 0, stride * 6 );
458 buffer += stride * 6;
460 else for ( int i = 0; i < m_width * 6; i++ )
468 // Normal non-keyer playout - needs byte swapping
469 if ( !progressive && m_displayMode->GetFieldDominance() == bmdUpperFieldFirst )
470 // convert lower field first to top field first
471 swab( (char*) image, (char*) buffer + stride, stride * ( height - 1 ) );
473 swab( (char*) image, (char*) buffer, stride * height );
475 else if ( !mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "test_image" ) )
477 // Normal keyer output
479 uint32_t* s = (uint32_t*) image;
480 uint32_t* d = (uint32_t*) buffer;
482 if ( !progressive && m_displayMode->GetFieldDominance() == bmdUpperFieldFirst )
484 // Correct field order
490 // Need to relocate alpha channel RGBA => ARGB
496 *d++ = ( *s << 8 ) | ( *s >> 24 );
503 // Keying blank frames - nullify alpha
504 memset( buffer, 0, stride * height );
508 if ( m_decklinkFrame )
509 m_deckLinkOutput->ScheduleVideoFrame( m_decklinkFrame, m_count * m_duration, m_duration, m_timescale );
512 mlt_log_verbose( getConsumer(), "dropped video frame %u\n", ++m_dropped );
515 HRESULT render( mlt_frame frame )
517 HRESULT result = S_OK;
520 double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES(frame), "_speed" );
521 if ( m_isAudio && speed == 1.0 )
522 renderAudio( frame );
525 renderVideo( frame );
531 // *** DeckLink API implementation of IDeckLinkVideoOutputCallback IDeckLinkAudioOutputCallback *** //
533 // IUnknown needs only a dummy implementation
534 virtual HRESULT STDMETHODCALLTYPE QueryInterface( REFIID iid, LPVOID *ppv )
535 { return E_NOINTERFACE; }
536 virtual ULONG STDMETHODCALLTYPE AddRef()
538 virtual ULONG STDMETHODCALLTYPE Release()
541 /************************* DeckLink API Delegate Methods *****************************/
543 virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted( IDeckLinkVideoFrame* completedFrame, BMDOutputFrameCompletionResult completed )
547 mlt_properties properties = MLT_CONSUMER_PROPERTIES( getConsumer() );
549 if ( mlt_properties_get( properties, "priority" ) )
553 pthread_attr_t tattr;
554 struct sched_param param;
556 pthread_attr_init(&tattr);
557 pthread_attr_setschedpolicy(&tattr, SCHED_FIFO);
559 if ( !strcmp( "max", mlt_properties_get( properties, "priority" ) ) )
560 param.sched_priority = sched_get_priority_max(SCHED_FIFO) - 1;
561 else if ( !strcmp( "min", mlt_properties_get( properties, "priority" ) ) )
562 param.sched_priority = sched_get_priority_min(SCHED_FIFO) + 1;
564 param.sched_priority = mlt_properties_get_int( properties, "priority" );
566 pthread_attr_setschedparam(&tattr, ¶m);
568 thread = pthread_self();
570 r = pthread_setschedparam(thread, SCHED_FIFO, ¶m);
572 mlt_log_verbose( getConsumer(),
573 "ScheduledFrameCompleted: pthread_setschedparam returned %d\n", r);
575 mlt_log_verbose( getConsumer(),
576 "ScheduledFrameCompleted: param.sched_priority=%d\n", param.sched_priority);
587 m_deckLinkOutput->GetBufferedAudioSampleFrameCount( &cnt );
590 mlt_log_debug( getConsumer(),
591 "ScheduledFrameCompleted: GetBufferedAudioSampleFrameCount %u -> %lu, m_count=%"PRIu64"\n",
592 m_acnt, cnt, m_count );
596 // When a video frame has been released by the API, schedule another video frame to be output
598 // ignore handler if frame was flushed
599 if ( bmdOutputFrameFlushed == completed )
602 // schedule next frame
603 ScheduleNextFrame( false );
605 // step forward frames counter if underrun
606 if ( bmdOutputFrameDisplayedLate == completed )
608 mlt_log_verbose( getConsumer(), "ScheduledFrameCompleted: bmdOutputFrameDisplayedLate == completed\n" );
611 if ( bmdOutputFrameDropped == completed )
613 mlt_log_verbose( getConsumer(), "ScheduledFrameCompleted: bmdOutputFrameDropped == completed\n" );
620 virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped()
622 return mlt_consumer_is_stopped( getConsumer() ) ? S_FALSE : S_OK;
626 void ScheduleNextFrame( bool preroll )
629 mlt_consumer consumer = getConsumer();
631 // Get the properties
632 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
635 mlt_frame frame = NULL;
637 if( mlt_properties_get_int( properties, "running" ) || preroll )
639 frame = mlt_consumer_rt_frame( consumer );
644 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
646 // terminate on pause
647 if ( m_terminate_on_pause &&
648 mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" ) == 0.0 )
651 mlt_frame_close( frame );
657 /** Start the consumer.
660 static int start( mlt_consumer consumer )
662 // Get the properties
663 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
664 DeckLinkConsumer* decklink = (DeckLinkConsumer*) consumer->child;
665 return decklink->start( mlt_properties_get_int( properties, "preroll" ) ) ? 0 : 1;
668 /** Stop the consumer.
671 static int stop( mlt_consumer consumer )
673 // Get the properties
674 DeckLinkConsumer* decklink = (DeckLinkConsumer*) consumer->child;
675 return decklink->stop();
678 /** Determine if the consumer is stopped.
681 static int is_stopped( mlt_consumer consumer )
683 // Get the properties
684 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
685 return !mlt_properties_get_int( properties, "running" );
688 /** Close the consumer.
691 static void close( mlt_consumer consumer )
694 mlt_consumer_stop( consumer );
697 consumer->close = NULL;
698 mlt_consumer_close( consumer );
701 delete (DeckLinkConsumer*) consumer->child;
706 /** Initialise the consumer.
709 mlt_consumer consumer_decklink_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
711 // Allocate the consumer
712 DeckLinkConsumer* decklink = new DeckLinkConsumer();
713 mlt_consumer consumer = NULL;
716 if ( decklink && !mlt_consumer_init( decklink->getConsumer(), decklink, profile ) )
718 // If initialises without error
719 if ( decklink->listDevices( MLT_CONSUMER_PROPERTIES( decklink->getConsumer() ) ) &&
720 decklink->open( arg? atoi(arg) : 0 ) )
722 consumer = decklink->getConsumer();
725 consumer->close = close;
726 consumer->start = start;
727 consumer->stop = stop;
728 consumer->is_stopped = is_stopped;
729 mlt_properties_set( MLT_CONSUMER_PROPERTIES(consumer), "deinterlace_method", "onefield" );
737 extern mlt_producer producer_decklink_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg );
739 static mlt_properties metadata( mlt_service_type type, const char *id, void *data )
741 char file[ PATH_MAX ];
742 const char *service_type = NULL;
746 service_type = "consumer";
749 service_type = "producer";
754 snprintf( file, PATH_MAX, "%s/decklink/%s_%s.yml", mlt_environment( "MLT_DATA" ), service_type, id );
755 return mlt_properties_parse_yaml( file );
760 MLT_REGISTER( consumer_type, "decklink", consumer_decklink_init );
761 MLT_REGISTER( producer_type, "decklink", producer_decklink_init );
762 MLT_REGISTER_METADATA( consumer_type, "decklink", metadata, NULL );
763 MLT_REGISTER_METADATA( producer_type, "decklink", metadata, NULL );