libavdevice/decklink_enc.cpp
5965adeb
 /*
  * Blackmagic DeckLink output
  * Copyright (c) 2013-2014 Ramiro Polla
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
c395d230
 #include <atomic>
 using std::atomic;
 
7f7ee86d
 /* Include internal.h first to avoid conflict between winsock.h (used by
  * DeckLink headers) and winsock2.h (used by libavformat) in MSVC++ builds */
 extern "C" {
 #include "libavformat/internal.h"
 }
 
5965adeb
 #include <DeckLinkAPI.h>
 
 extern "C" {
ce36cb08
 #include "libavformat/avformat.h"
5965adeb
 #include "libavutil/imgutils.h"
278588cd
 #include "avdevice.h"
5965adeb
 }
 
a5e040ee
 #include "decklink_common.h"
5965adeb
 #include "decklink_enc.h"
 
 
 /* DeckLink callback class declaration */
 class decklink_frame : public IDeckLinkVideoFrame
 {
 public:
77f7d710
     decklink_frame(struct decklink_ctx *ctx, AVFrame *avframe, AVCodecID codec_id, int height, int width) :
         _ctx(ctx), _avframe(avframe), _avpacket(NULL), _codec_id(codec_id), _height(height), _width(width),  _refs(1) { }
     decklink_frame(struct decklink_ctx *ctx, AVPacket *avpacket, AVCodecID codec_id, int height, int width) :
         _ctx(ctx), _avframe(NULL), _avpacket(avpacket), _codec_id(codec_id), _height(height), _width(width), _refs(1) { }
 
     virtual long           STDMETHODCALLTYPE GetWidth      (void)          { return _width; }
     virtual long           STDMETHODCALLTYPE GetHeight     (void)          { return _height; }
     virtual long           STDMETHODCALLTYPE GetRowBytes   (void)
     {
       if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME)
           return _avframe->linesize[0] < 0 ? -_avframe->linesize[0] : _avframe->linesize[0];
       else
           return ((GetWidth() + 47) / 48) * 128;
     }
     virtual BMDPixelFormat STDMETHODCALLTYPE GetPixelFormat(void)
418ce915
     {
77f7d710
         if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME)
             return bmdFormat8BitYUV;
418ce915
         else
77f7d710
             return bmdFormat10BitYUV;
     }
     virtual BMDFrameFlags  STDMETHODCALLTYPE GetFlags      (void)
     {
        if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME)
            return _avframe->linesize[0] < 0 ? bmdFrameFlagFlipVertical : bmdFrameFlagDefault;
        else
            return bmdFrameFlagDefault;
     }
 
     virtual HRESULT        STDMETHODCALLTYPE GetBytes      (void **buffer)
     {
         if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME) {
             if (_avframe->linesize[0] < 0)
                 *buffer = (void *)(_avframe->data[0] + _avframe->linesize[0] * (_avframe->height - 1));
             else
                 *buffer = (void *)(_avframe->data[0]);
         } else {
             *buffer = (void *)(_avpacket->data);
         }
418ce915
         return S_OK;
     }
5965adeb
 
     virtual HRESULT STDMETHODCALLTYPE GetTimecode     (BMDTimecodeFormat format, IDeckLinkTimecode **timecode) { return S_FALSE; }
     virtual HRESULT STDMETHODCALLTYPE GetAncillaryData(IDeckLinkVideoFrameAncillary **ancillary)               { return S_FALSE; }
 
     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
c395d230
     virtual ULONG   STDMETHODCALLTYPE AddRef(void)                            { return ++_refs; }
418ce915
     virtual ULONG   STDMETHODCALLTYPE Release(void)
     {
c395d230
         int ret = --_refs;
418ce915
         if (!ret) {
             av_frame_free(&_avframe);
77f7d710
             av_packet_free(&_avpacket);
418ce915
             delete this;
         }
         return ret;
     }
5965adeb
 
     struct decklink_ctx *_ctx;
     AVFrame *_avframe;
77f7d710
     AVPacket *_avpacket;
     AVCodecID _codec_id;
     int _height;
     int _width;
5965adeb
 
 private:
c395d230
     std::atomic<int>  _refs;
5965adeb
 };
 
a5e040ee
 class decklink_output_callback : public IDeckLinkVideoOutputCallback
5965adeb
 {
 public:
     virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted(IDeckLinkVideoFrame *_frame, BMDOutputFrameCompletionResult result)
     {
         decklink_frame *frame = static_cast<decklink_frame *>(_frame);
         struct decklink_ctx *ctx = frame->_ctx;
 
77f7d710
         if (frame->_avframe)
             av_frame_unref(frame->_avframe);
         if (frame->_avpacket)
             av_packet_unref(frame->_avpacket);
5965adeb
 
9e86a618
         pthread_mutex_lock(&ctx->mutex);
         ctx->frames_buffer_available_spots++;
         pthread_cond_broadcast(&ctx->cond);
         pthread_mutex_unlock(&ctx->mutex);
5965adeb
 
         return S_OK;
     }
     virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped(void)       { return S_OK; }
     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
     virtual ULONG   STDMETHODCALLTYPE AddRef(void)                            { return 1; }
     virtual ULONG   STDMETHODCALLTYPE Release(void)                           { return 1; }
 };
 
 static int decklink_setup_video(AVFormatContext *avctx, AVStream *st)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
e0eb0bda
     AVCodecParameters *c = st->codecpar;
5965adeb
 
     if (ctx->video) {
         av_log(avctx, AV_LOG_ERROR, "Only one video stream is supported!\n");
         return -1;
     }
 
77f7d710
     if (c->codec_id == AV_CODEC_ID_WRAPPED_AVFRAME) {
         if (c->format != AV_PIX_FMT_UYVY422) {
             av_log(avctx, AV_LOG_ERROR, "Unsupported pixel format!"
                    " Only AV_PIX_FMT_UYVY422 is supported.\n");
             return -1;
         }
     } else if (c->codec_id != AV_CODEC_ID_V210) {
         av_log(avctx, AV_LOG_ERROR, "Unsupported codec type!"
                " Only V210 and wrapped frame with AV_PIX_FMT_UYVY422 are supported.\n");
5965adeb
         return -1;
     }
77f7d710
 
a5e040ee
     if (ff_decklink_set_format(avctx, c->width, c->height,
48f8ad32
                             st->time_base.num, st->time_base.den, c->field_order)) {
         av_log(avctx, AV_LOG_ERROR, "Unsupported video size, framerate or field order!"
5965adeb
                " Check available formats with -list_formats 1.\n");
         return -1;
     }
     if (ctx->dlo->EnableVideoOutput(ctx->bmd_mode,
                                     bmdVideoOutputFlagDefault) != S_OK) {
         av_log(avctx, AV_LOG_ERROR, "Could not enable video output!\n");
         return -1;
     }
 
     /* Set callback. */
a5e040ee
     ctx->output_callback = new decklink_output_callback();
     ctx->dlo->SetScheduledFrameCompletionCallback(ctx->output_callback);
5965adeb
 
e0eb0bda
     ctx->frames_preroll = st->time_base.den * ctx->preroll;
     if (st->time_base.den > 1000)
5965adeb
         ctx->frames_preroll /= 1000;
 
     /* Buffer twice as many frames as the preroll. */
     ctx->frames_buffer = ctx->frames_preroll * 2;
     ctx->frames_buffer = FFMIN(ctx->frames_buffer, 60);
9e86a618
     pthread_mutex_init(&ctx->mutex, NULL);
     pthread_cond_init(&ctx->cond, NULL);
     ctx->frames_buffer_available_spots = ctx->frames_buffer;
5965adeb
 
     /* The device expects the framerate to be fixed. */
e0eb0bda
     avpriv_set_pts_info(st, 64, st->time_base.num, st->time_base.den);
5965adeb
 
     ctx->video = 1;
 
     return 0;
 }
 
 static int decklink_setup_audio(AVFormatContext *avctx, AVStream *st)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
e0eb0bda
     AVCodecParameters *c = st->codecpar;
5965adeb
 
     if (ctx->audio) {
         av_log(avctx, AV_LOG_ERROR, "Only one audio stream is supported!\n");
         return -1;
     }
     if (c->sample_rate != 48000) {
         av_log(avctx, AV_LOG_ERROR, "Unsupported sample rate!"
                " Only 48kHz is supported.\n");
         return -1;
     }
84ee6512
     if (c->channels != 2 && c->channels != 8 && c->channels != 16) {
5965adeb
         av_log(avctx, AV_LOG_ERROR, "Unsupported number of channels!"
84ee6512
                " Only 2, 8 or 16 channels are supported.\n");
5965adeb
         return -1;
     }
     if (ctx->dlo->EnableAudioOutput(bmdAudioSampleRate48kHz,
                                     bmdAudioSampleType16bitInteger,
                                     c->channels,
                                     bmdAudioOutputStreamTimestamped) != S_OK) {
         av_log(avctx, AV_LOG_ERROR, "Could not enable audio output!\n");
         return -1;
     }
     if (ctx->dlo->BeginAudioPreroll() != S_OK) {
         av_log(avctx, AV_LOG_ERROR, "Could not begin audio preroll!\n");
         return -1;
     }
 
     /* The device expects the sample rate to be fixed. */
     avpriv_set_pts_info(st, 64, 1, c->sample_rate);
     ctx->channels = c->channels;
 
     ctx->audio = 1;
 
     return 0;
 }
 
 av_cold int ff_decklink_write_trailer(AVFormatContext *avctx)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
5965adeb
 
     if (ctx->playback_started) {
         BMDTimeValue actual;
         ctx->dlo->StopScheduledPlayback(ctx->last_pts * ctx->bmd_tb_num,
                                         &actual, ctx->bmd_tb_den);
         ctx->dlo->DisableVideoOutput();
         if (ctx->audio)
             ctx->dlo->DisableAudioOutput();
     }
 
1fc85d85
     ff_decklink_cleanup(avctx);
5965adeb
 
a5e040ee
     if (ctx->output_callback)
         delete ctx->output_callback;
5965adeb
 
9e86a618
     pthread_mutex_destroy(&ctx->mutex);
     pthread_cond_destroy(&ctx->cond);
5965adeb
 
     av_freep(&cctx->ctx);
 
     return 0;
 }
 
 static int decklink_write_video_packet(AVFormatContext *avctx, AVPacket *pkt)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
77f7d710
     AVStream *st = avctx->streams[pkt->stream_index];
     AVFrame *avframe = NULL, *tmp = (AVFrame *)pkt->data;
     AVPacket *avpacket = NULL;
5965adeb
     decklink_frame *frame;
     buffercount_type buffered;
     HRESULT hr;
 
77f7d710
     if (st->codecpar->codec_id == AV_CODEC_ID_WRAPPED_AVFRAME) {
         if (tmp->format != AV_PIX_FMT_UYVY422 ||
             tmp->width  != ctx->bmd_width ||
             tmp->height != ctx->bmd_height) {
             av_log(avctx, AV_LOG_ERROR, "Got a frame with invalid pixel format or dimension.\n");
             return AVERROR(EINVAL);
         }
 
         avframe = av_frame_clone(tmp);
         if (!avframe) {
             av_log(avctx, AV_LOG_ERROR, "Could not clone video frame.\n");
             return AVERROR(EIO);
         }
 
         frame = new decklink_frame(ctx, avframe, st->codecpar->codec_id, avframe->height, avframe->width);
     } else {
         avpacket = av_packet_clone(pkt);
         if (!avpacket) {
             av_log(avctx, AV_LOG_ERROR, "Could not clone video frame.\n");
             return AVERROR(EIO);
         }
 
         frame = new decklink_frame(ctx, avpacket, st->codecpar->codec_id, ctx->bmd_height, ctx->bmd_width);
5965adeb
     }
 
     if (!frame) {
         av_log(avctx, AV_LOG_ERROR, "Could not create new frame.\n");
418ce915
         av_frame_free(&avframe);
77f7d710
         av_packet_free(&avpacket);
5965adeb
         return AVERROR(EIO);
     }
 
     /* Always keep at most one second of frames buffered. */
9e86a618
     pthread_mutex_lock(&ctx->mutex);
     while (ctx->frames_buffer_available_spots == 0) {
         pthread_cond_wait(&ctx->cond, &ctx->mutex);
     }
     ctx->frames_buffer_available_spots--;
     pthread_mutex_unlock(&ctx->mutex);
5965adeb
 
     /* Schedule frame for playback. */
     hr = ctx->dlo->ScheduleVideoFrame((struct IDeckLinkVideoFrame *) frame,
                                       pkt->pts * ctx->bmd_tb_num,
                                       ctx->bmd_tb_num, ctx->bmd_tb_den);
418ce915
     /* Pass ownership to DeckLink, or release on failure */
     frame->Release();
5965adeb
     if (hr != S_OK) {
         av_log(avctx, AV_LOG_ERROR, "Could not schedule video frame."
                 " error %08x.\n", (uint32_t) hr);
         return AVERROR(EIO);
     }
 
     ctx->dlo->GetBufferedVideoFrameCount(&buffered);
     av_log(avctx, AV_LOG_DEBUG, "Buffered video frames: %d.\n", (int) buffered);
     if (pkt->pts > 2 && buffered <= 2)
         av_log(avctx, AV_LOG_WARNING, "There are not enough buffered video frames."
                " Video may misbehave!\n");
 
     /* Preroll video frames. */
     if (!ctx->playback_started && pkt->pts > ctx->frames_preroll) {
         av_log(avctx, AV_LOG_DEBUG, "Ending audio preroll.\n");
         if (ctx->audio && ctx->dlo->EndAudioPreroll() != S_OK) {
             av_log(avctx, AV_LOG_ERROR, "Could not end audio preroll!\n");
             return AVERROR(EIO);
         }
         av_log(avctx, AV_LOG_DEBUG, "Starting scheduled playback.\n");
         if (ctx->dlo->StartScheduledPlayback(0, ctx->bmd_tb_den, 1.0) != S_OK) {
             av_log(avctx, AV_LOG_ERROR, "Could not start scheduled playback!\n");
             return AVERROR(EIO);
         }
         ctx->playback_started = 1;
     }
 
     return 0;
 }
 
 static int decklink_write_audio_packet(AVFormatContext *avctx, AVPacket *pkt)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
5965adeb
     int sample_count = pkt->size / (ctx->channels << 1);
     buffercount_type buffered;
 
     ctx->dlo->GetBufferedAudioSampleFrameCount(&buffered);
     if (pkt->pts > 1 && !buffered)
         av_log(avctx, AV_LOG_WARNING, "There's no buffered audio."
                " Audio will misbehave!\n");
 
     if (ctx->dlo->ScheduleAudioSamples(pkt->data, sample_count, pkt->pts,
                                        bmdAudioSampleRate48kHz, NULL) != S_OK) {
         av_log(avctx, AV_LOG_ERROR, "Could not schedule audio samples.\n");
         return AVERROR(EIO);
     }
 
     return 0;
 }
 
 extern "C" {
 
 av_cold int ff_decklink_write_header(AVFormatContext *avctx)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
5965adeb
     struct decklink_ctx *ctx;
     unsigned int n;
38d75fe9
     int ret;
5965adeb
 
     ctx = (struct decklink_ctx *) av_mallocz(sizeof(struct decklink_ctx));
     if (!ctx)
         return AVERROR(ENOMEM);
     ctx->list_devices = cctx->list_devices;
     ctx->list_formats = cctx->list_formats;
     ctx->preroll      = cctx->preroll;
     cctx->ctx = ctx;
 
278588cd
     /* List available devices and exit. */
5965adeb
     if (ctx->list_devices) {
278588cd
         ff_decklink_list_devices_legacy(avctx, 0, 1);
5965adeb
         return AVERROR_EXIT;
     }
 
38d75fe9
     ret = ff_decklink_init_device(avctx, avctx->filename);
     if (ret < 0)
         return ret;
5965adeb
 
     /* Get output device. */
     if (ctx->dl->QueryInterface(IID_IDeckLinkOutput, (void **) &ctx->dlo) != S_OK) {
         av_log(avctx, AV_LOG_ERROR, "Could not open output device from '%s'\n",
                avctx->filename);
e22760aa
         ret = AVERROR(EIO);
         goto error;
5965adeb
     }
 
     /* List supported formats. */
     if (ctx->list_formats) {
a5e040ee
         ff_decklink_list_formats(avctx);
e22760aa
         ret = AVERROR_EXIT;
         goto error;
5965adeb
     }
 
     /* Setup streams. */
e22760aa
     ret = AVERROR(EIO);
5965adeb
     for (n = 0; n < avctx->nb_streams; n++) {
         AVStream *st = avctx->streams[n];
e0eb0bda
         AVCodecParameters *c = st->codecpar;
5965adeb
         if        (c->codec_type == AVMEDIA_TYPE_AUDIO) {
             if (decklink_setup_audio(avctx, st))
                 goto error;
         } else if (c->codec_type == AVMEDIA_TYPE_VIDEO) {
             if (decklink_setup_video(avctx, st))
                 goto error;
         } else {
             av_log(avctx, AV_LOG_ERROR, "Unsupported stream type.\n");
             goto error;
         }
     }
 
     return 0;
 
 error:
1fc85d85
     ff_decklink_cleanup(avctx);
e22760aa
     return ret;
5965adeb
 }
 
 int ff_decklink_write_packet(AVFormatContext *avctx, AVPacket *pkt)
 {
e9659d1a
     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
5965adeb
     AVStream *st = avctx->streams[pkt->stream_index];
 
     ctx->last_pts = FFMAX(ctx->last_pts, pkt->pts);
 
e0eb0bda
     if      (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
5965adeb
         return decklink_write_video_packet(avctx, pkt);
e0eb0bda
     else if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
5965adeb
         return decklink_write_audio_packet(avctx, pkt);
 
     return AVERROR(EIO);
 }
 
278588cd
 int ff_decklink_list_output_devices(AVFormatContext *avctx, struct AVDeviceInfoList *device_list)
 {
     return ff_decklink_list_devices(avctx, device_list, 0, 1);
 }
 
5965adeb
 } /* extern "C" */