libavdevice/vfwcap.c

   1 /*
   2  * VFW capture interface
   3  * Copyright (c) 2006-2008 Ramiro Polla
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #include "libavformat/avformat.h"
  23 #include <vfw.h>
  24 #include <windows.h>
  25
  26 //#define DEBUG_VFW
  27
  28 /* Defines for VFW missing from MinGW.
  29  * Remove this when MinGW incorporates them. */
  30 #define HWND_MESSAGE                ((HWND)-3)
  31
  32 #define BI_RGB                      0
  33
  34 /* End of missing MinGW defines */
  35
  36 struct vfw_ctx {
  37     HWND hwnd;
  38     HANDLE mutex;
  39     HANDLE event;
  40     AVPacketList *pktl;
  41     AVFormatContext *s;
  42     unsigned int curbufsize;
  43     unsigned int frame_num;
  44 };
  45
  46 static enum PixelFormat vfw_pixfmt(DWORD biCompression, WORD biBitCount)
  47 {
  48     switch(biCompression) {
  49     case MKTAG('Y', 'U', 'Y', '2'):
  50         return PIX_FMT_YUYV422;
  51     case MKTAG('I', '4', '2', '0'):
  52         return PIX_FMT_YUV420P;
  53     case BI_RGB:
  54         switch(biBitCount) { /* 1-8 are untested */
  55             case 1:
  56                 return PIX_FMT_MONOWHITE;
  57             case 4:
  58                 return PIX_FMT_RGB4;
  59             case 8:
  60                 return PIX_FMT_RGB8;
  61             case 16:
  62                 return PIX_FMT_RGB555;
  63             case 24:
  64                 return PIX_FMT_BGR24;
  65             case 32:
  66                 return PIX_FMT_RGB32;
  67         }
  68     }
  69     return PIX_FMT_NONE;
  70 }
  71
  72 static enum CodecID vfw_codecid(DWORD biCompression)
  73 {
  74     switch(biCompression) {
  75     case MKTAG('d', 'v', 's', 'd'):
  76         return CODEC_ID_DVVIDEO;
  77     }
  78     return CODEC_ID_NONE;
  79 }
  80
  81 #define dstruct(pctx, sname, var, type) \
  82     av_log(pctx, AV_LOG_DEBUG, #var":\t%"type"\n", sname->var)
  83
  84 static void dump_captureparms(AVFormatContext *s, CAPTUREPARMS *cparms)
  85 {
  86     av_log(s, AV_LOG_DEBUG, "CAPTUREPARMS\n");
  87     dstruct(s, cparms, dwRequestMicroSecPerFrame, "lu");
  88     dstruct(s, cparms, fMakeUserHitOKToCapture, "d");
  89     dstruct(s, cparms, wPercentDropForError, "u");
  90     dstruct(s, cparms, fYield, "d");
  91     dstruct(s, cparms, dwIndexSize, "lu");
  92     dstruct(s, cparms, wChunkGranularity, "u");
  93     dstruct(s, cparms, fUsingDOSMemory, "d");
  94     dstruct(s, cparms, wNumVideoRequested, "u");
  95     dstruct(s, cparms, fCaptureAudio, "d");
  96     dstruct(s, cparms, wNumAudioRequested, "u");
  97     dstruct(s, cparms, vKeyAbort, "u");
  98     dstruct(s, cparms, fAbortLeftMouse, "d");
  99     dstruct(s, cparms, fAbortRightMouse, "d");
 100     dstruct(s, cparms, fLimitEnabled, "d");
 101     dstruct(s, cparms, wTimeLimit, "u");
 102     dstruct(s, cparms, fMCIControl, "d");
 103     dstruct(s, cparms, fStepMCIDevice, "d");
 104     dstruct(s, cparms, dwMCIStartTime, "lu");
 105     dstruct(s, cparms, dwMCIStopTime, "lu");
 106     dstruct(s, cparms, fStepCaptureAt2x, "d");
 107     dstruct(s, cparms, wStepCaptureAverageFrames, "u");
 108     dstruct(s, cparms, dwAudioBufferSize, "lu");
 109     dstruct(s, cparms, fDisableWriteCache, "d");
 110     dstruct(s, cparms, AVStreamMaster, "u");
 111 }
 112
 113 static void dump_videohdr(AVFormatContext *s, VIDEOHDR *vhdr)
 114 {
 115 #ifdef DEBUG_VFW
 116     av_log(s, AV_LOG_DEBUG, "VIDEOHDR\n");
 117     dstruct(s, vhdr, lpData, "p");
 118     dstruct(s, vhdr, dwBufferLength, "lu");
 119     dstruct(s, vhdr, dwBytesUsed, "lu");
 120     dstruct(s, vhdr, dwTimeCaptured, "lu");
 121     dstruct(s, vhdr, dwUser, "lu");
 122     dstruct(s, vhdr, dwFlags, "lu");
 123     dstruct(s, vhdr, dwReserved[0], "lu");
 124     dstruct(s, vhdr, dwReserved[1], "lu");
 125     dstruct(s, vhdr, dwReserved[2], "lu");
 126     dstruct(s, vhdr, dwReserved[3], "lu");
 127 #endif
 128 }
 129
 130 static void dump_bih(AVFormatContext *s, BITMAPINFOHEADER *bih)
 131 {
 132     av_log(s, AV_LOG_DEBUG, "BITMAPINFOHEADER\n");
 133     dstruct(s, bih, biSize, "lu");
 134     dstruct(s, bih, biWidth, "ld");
 135     dstruct(s, bih, biHeight, "ld");
 136     dstruct(s, bih, biPlanes, "d");
 137     dstruct(s, bih, biBitCount, "d");
 138     dstruct(s, bih, biCompression, "lu");
 139     av_log(s, AV_LOG_DEBUG, "    biCompression:\t\"%.4s\"\n",
 140                    (char*) &bih->biCompression);
 141     dstruct(s, bih, biSizeImage, "lu");
 142     dstruct(s, bih, biXPelsPerMeter, "lu");
 143     dstruct(s, bih, biYPelsPerMeter, "lu");
 144     dstruct(s, bih, biClrUsed, "lu");
 145     dstruct(s, bih, biClrImportant, "lu");
 146 }
 147
 148 static int shall_we_drop(struct vfw_ctx *ctx)
 149 {
 150     AVFormatContext *s = ctx->s;
 151     const uint8_t dropscore[] = {62, 75, 87, 100};
 152     const int ndropscores = FF_ARRAY_ELEMS(dropscore);
 153     unsigned int buffer_fullness = (ctx->curbufsize*100)/s->max_picture_buffer;
 154
 155     if(dropscore[++ctx->frame_num%ndropscores] <= buffer_fullness) {
 156         av_log(ctx->s, AV_LOG_ERROR,
 157               "real-time buffer %d%% full! frame dropped!\n", buffer_fullness);
 158         return 1;
 159     }
 160
 161     return 0;
 162 }
 163
 164 static LRESULT CALLBACK videostream_cb(HWND hwnd, LPVIDEOHDR vdhdr)
 165 {
 166     struct vfw_ctx *ctx;
 167     AVPacketList **ppktl, *pktl_next;
 168
 169     ctx = (struct vfw_ctx *) GetWindowLongPtr(hwnd, GWLP_USERDATA);
 170
 171     dump_videohdr(ctx->s, vdhdr);
 172
 173     if(shall_we_drop(ctx))
 174         return FALSE;
 175
 176     WaitForSingleObject(ctx->mutex, INFINITE);
 177
 178     pktl_next = av_mallocz(sizeof(AVPacketList));
 179     if(!pktl_next)
 180         goto fail;
 181
 182     if(av_new_packet(&pktl_next->pkt, vdhdr->dwBytesUsed) < 0) {
 183         av_free(pktl_next);
 184         goto fail;
 185     }
 186
 187     pktl_next->pkt.pts = vdhdr->dwTimeCaptured;
 188     memcpy(pktl_next->pkt.data, vdhdr->lpData, vdhdr->dwBytesUsed);
 189
 190     for(ppktl = &ctx->pktl ; *ppktl ; ppktl = &(*ppktl)->next);
 191     *ppktl = pktl_next;
 192
 193     ctx->curbufsize += vdhdr->dwBytesUsed;
 194
 195     SetEvent(ctx->event);
 196     ReleaseMutex(ctx->mutex);
 197
 198     return TRUE;
 199 fail:
 200     ReleaseMutex(ctx->mutex);
 201     return FALSE;
 202 }
 203
 204 static int vfw_read_close(AVFormatContext *s)
 205 {
 206     struct vfw_ctx *ctx = s->priv_data;
 207
 208     if(ctx->hwnd) {
 209         SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0, 0);
 210         SendMessage(ctx->hwnd, WM_CAP_DRIVER_DISCONNECT, 0, 0);
 211         DestroyWindow(ctx->hwnd);
 212     }
 213     if(ctx->mutex)
 214         CloseHandle(ctx->mutex);
 215     if(ctx->event)
 216         CloseHandle(ctx->event);
 217
 218     return 0;
 219 }
 220
 221 static int vfw_read_header(AVFormatContext *s, AVFormatParameters *ap)
 222 {
 223     struct vfw_ctx *ctx = s->priv_data;
 224     AVCodecContext *codec;
 225     AVStream *st;
 226     int devnum;
 227     int bisize;
 228     BITMAPINFO *bi;
 229     CAPTUREPARMS cparms;
 230     DWORD biCompression;
 231     WORD biBitCount;
 232     int width;
 233     int height;
 234     int ret;
 235
 236     if(!ap->time_base.den) {
 237         av_log(s, AV_LOG_ERROR, "A time base must be specified.\n");
 238         return AVERROR_IO;
 239     }
 240
 241     ctx->s = s;
 242
 243     ctx->hwnd = capCreateCaptureWindow(NULL, 0, 0, 0, 0, 0, HWND_MESSAGE, 0);
 244     if(!ctx->hwnd) {
 245         av_log(s, AV_LOG_ERROR, "Could not create capture window.\n");
 246         return AVERROR_IO;
 247     }
 248
 249     /* If atoi fails, devnum==0 and the default device is used */
 250     devnum = atoi(s->filename);
 251
 252     ret = SendMessage(ctx->hwnd, WM_CAP_DRIVER_CONNECT, devnum, 0);
 253     if(!ret) {
 254         av_log(s, AV_LOG_ERROR, "Could not connect to device.\n");
 255         DestroyWindow(ctx->hwnd);
 256         return AVERROR(ENODEV);
 257     }
 258
 259     SendMessage(ctx->hwnd, WM_CAP_SET_OVERLAY, 0, 0);
 260     SendMessage(ctx->hwnd, WM_CAP_SET_PREVIEW, 0, 0);
 261
 262     ret = SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0,
 263                       (LPARAM) videostream_cb);
 264     if(!ret) {
 265         av_log(s, AV_LOG_ERROR, "Could not set video stream callback.\n");
 266         goto fail_io;
 267     }
 268
 269     SetWindowLongPtr(ctx->hwnd, GWLP_USERDATA, (LONG_PTR) ctx);
 270
 271     st = av_new_stream(s, 0);
 272     if(!st) {
 273         vfw_read_close(s);
 274         return AVERROR_NOMEM;
 275     }
 276
 277     /* Set video format */
 278     bisize = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, 0, 0);
 279     if(!bisize)
 280         goto fail_io;
 281     bi = av_malloc(bisize);
 282     if(!bi) {
 283         vfw_read_close(s);
 284         return AVERROR_NOMEM;
 285     }
 286     ret = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, bisize, (LPARAM) bi);
 287     if(!ret)
 288         goto fail_bi;
 289
 290     dump_bih(s, &bi->bmiHeader);
 291
 292     width  = ap->width  ? ap->width  : bi->bmiHeader.biWidth ;
 293     height = ap->height ? ap->height : bi->bmiHeader.biHeight;
 294     bi->bmiHeader.biWidth  = width ;
 295     bi->bmiHeader.biHeight = height;
 296
 297     if (0) {
 298         /* For testing yet unsupported compressions
 299          * Copy these values from user-supplied verbose information */
 300         bi->bmiHeader.biWidth       = 320;
 301         bi->bmiHeader.biHeight      = 240;
 302         bi->bmiHeader.biPlanes      = 1;
 303         bi->bmiHeader.biBitCount    = 12;
 304         bi->bmiHeader.biCompression = MKTAG('I','4','2','0');
 305         bi->bmiHeader.biSizeImage   = 115200;
 306         dump_bih(s, &bi->bmiHeader);
 307     }
 308
 309     ret = SendMessage(ctx->hwnd, WM_CAP_SET_VIDEOFORMAT, bisize, (LPARAM) bi);
 310     if(!ret) {
 311         av_log(s, AV_LOG_ERROR, "Could not set Video Format.\n");
 312         goto fail_bi;
 313     }
 314
 315     biCompression = bi->bmiHeader.biCompression;
 316     biBitCount = bi->bmiHeader.biBitCount;
 317
 318     av_free(bi);
 319
 320     /* Set sequence setup */
 321     ret = SendMessage(ctx->hwnd, WM_CAP_GET_SEQUENCE_SETUP, sizeof(cparms),
 322                       (LPARAM) &cparms);
 323     if(!ret)
 324         goto fail_io;
 325
 326     dump_captureparms(s, &cparms);
 327
 328     cparms.fYield = 1; // Spawn a background thread
 329     cparms.dwRequestMicroSecPerFrame =
 330                                (ap->time_base.num*1000000) / ap->time_base.den;
 331     cparms.fAbortLeftMouse = 0;
 332     cparms.fAbortRightMouse = 0;
 333     cparms.fCaptureAudio = 0;
 334     cparms.vKeyAbort = 0;
 335
 336     ret = SendMessage(ctx->hwnd, WM_CAP_SET_SEQUENCE_SETUP, sizeof(cparms),
 337                       (LPARAM) &cparms);
 338     if(!ret)
 339         goto fail_io;
 340
 341     codec = st->codec;
 342     codec->time_base = ap->time_base;
 343     codec->codec_type = CODEC_TYPE_VIDEO;
 344     codec->width = width;
 345     codec->height = height;
 346     codec->pix_fmt = vfw_pixfmt(biCompression, biBitCount);
 347     if(codec->pix_fmt == PIX_FMT_NONE) {
 348         codec->codec_id = vfw_codecid(biCompression);
 349         if(codec->codec_id == CODEC_ID_NONE) {
 350             av_log(s, AV_LOG_ERROR, "Unknown compression type. "
 351                              "Please report verbose (-v 9) debug information.\n");
 352             vfw_read_close(s);
 353             return AVERROR_PATCHWELCOME;
 354         }
 355         codec->bits_per_coded_sample = biBitCount;
 356     } else {
 357         codec->codec_id = CODEC_ID_RAWVIDEO;
 358         if(biCompression == BI_RGB)
 359             codec->bits_per_coded_sample = biBitCount;
 360     }
 361
 362     av_set_pts_info(st, 32, 1, 1000);
 363
 364     ctx->mutex = CreateMutex(NULL, 0, NULL);
 365     if(!ctx->mutex) {
 366         av_log(s, AV_LOG_ERROR, "Could not create Mutex.\n" );
 367         goto fail_io;
 368     }
 369     ctx->event = CreateEvent(NULL, 1, 0, NULL);
 370     if(!ctx->event) {
 371         av_log(s, AV_LOG_ERROR, "Could not create Event.\n" );
 372         goto fail_io;
 373     }
 374
 375     ret = SendMessage(ctx->hwnd, WM_CAP_SEQUENCE_NOFILE, 0, 0);
 376     if(!ret) {
 377         av_log(s, AV_LOG_ERROR, "Could not start capture sequence.\n" );
 378         goto fail_io;
 379     }
 380
 381     return 0;
 382
 383 fail_bi:
 384     av_free(bi);
 385
 386 fail_io:
 387     vfw_read_close(s);
 388     return AVERROR_IO;
 389 }
 390
 391 static int vfw_read_packet(AVFormatContext *s, AVPacket *pkt)
 392 {
 393     struct vfw_ctx *ctx = s->priv_data;
 394     AVPacketList *pktl = NULL;
 395
 396     while(!pktl) {
 397         WaitForSingleObject(ctx->mutex, INFINITE);
 398         pktl = ctx->pktl;
 399         if(ctx->pktl) {
 400             *pkt = ctx->pktl->pkt;
 401             ctx->pktl = ctx->pktl->next;
 402             av_free(pktl);
 403         }
 404         ResetEvent(ctx->event);
 405         ReleaseMutex(ctx->mutex);
 406         if(!pktl) {
 407             if(s->flags & AVFMT_FLAG_NONBLOCK) {
 408                 return AVERROR(EAGAIN);
 409             } else {
 410                 WaitForSingleObject(ctx->event, INFINITE);
 411             }
 412         }
 413     }
 414
 415     ctx->curbufsize -= pkt->size;
 416
 417     return pkt->size;
 418 }
 419
 420 AVInputFormat vfwcap_demuxer = {
 421     "vfwcap",
 422     NULL_IF_CONFIG_SMALL("VFW video capture"),
 423     sizeof(struct vfw_ctx),
 424     NULL,
 425     vfw_read_header,
 426     vfw_read_packet,
 427     vfw_read_close,
 428     .flags = AVFMT_NOFILE,
 429 };