2 * VFW capture interface
3 * Copyright (c) 2006-2008 Ramiro Polla
5 * This file is part of Libav.
7 * Libav 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.
12 * Libav 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.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/internal.h"
23 #include "libavutil/log.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/parseutils.h"
27 #include "libavformat/avformat.h"
28 #include "libavformat/internal.h"
30 // windows.h must no be included before winsock2.h, and libavformat internal
31 // headers may include winsock2.h
33 // windows.h needs to be included before vfw.h
36 /* Some obsolete versions of MinGW32 before 4.0.0 lack this. */
38 #define HWND_MESSAGE ((HWND) -3)
47 unsigned int curbufsize;
48 unsigned int frame_num;
49 char *video_size; /**< A string describing video size, set by a private option. */
50 char *framerate; /**< Set by a private option. */
53 static enum AVPixelFormat vfw_pixfmt(DWORD biCompression, WORD biBitCount)
55 switch(biCompression) {
56 case MKTAG('U', 'Y', 'V', 'Y'):
57 return AV_PIX_FMT_UYVY422;
58 case MKTAG('Y', 'U', 'Y', '2'):
59 return AV_PIX_FMT_YUYV422;
60 case MKTAG('I', '4', '2', '0'):
61 return AV_PIX_FMT_YUV420P;
63 switch(biBitCount) { /* 1-8 are untested */
65 return AV_PIX_FMT_MONOWHITE;
67 return AV_PIX_FMT_RGB4;
69 return AV_PIX_FMT_RGB8;
71 return AV_PIX_FMT_RGB555;
73 return AV_PIX_FMT_BGR24;
75 return AV_PIX_FMT_RGB32;
78 return AV_PIX_FMT_NONE;
81 static enum AVCodecID vfw_codecid(DWORD biCompression)
83 switch(biCompression) {
84 case MKTAG('d', 'v', 's', 'd'):
85 return AV_CODEC_ID_DVVIDEO;
86 case MKTAG('M', 'J', 'P', 'G'):
87 case MKTAG('m', 'j', 'p', 'g'):
88 return AV_CODEC_ID_MJPEG;
90 return AV_CODEC_ID_NONE;
93 #define dstruct(pctx, sname, var, type) \
94 av_log(pctx, AV_LOG_DEBUG, #var":\t%"type"\n", sname->var)
96 static void dump_captureparms(AVFormatContext *s, CAPTUREPARMS *cparms)
98 av_log(s, AV_LOG_DEBUG, "CAPTUREPARMS\n");
99 dstruct(s, cparms, dwRequestMicroSecPerFrame, "lu");
100 dstruct(s, cparms, fMakeUserHitOKToCapture, "d");
101 dstruct(s, cparms, wPercentDropForError, "u");
102 dstruct(s, cparms, fYield, "d");
103 dstruct(s, cparms, dwIndexSize, "lu");
104 dstruct(s, cparms, wChunkGranularity, "u");
105 dstruct(s, cparms, fUsingDOSMemory, "d");
106 dstruct(s, cparms, wNumVideoRequested, "u");
107 dstruct(s, cparms, fCaptureAudio, "d");
108 dstruct(s, cparms, wNumAudioRequested, "u");
109 dstruct(s, cparms, vKeyAbort, "u");
110 dstruct(s, cparms, fAbortLeftMouse, "d");
111 dstruct(s, cparms, fAbortRightMouse, "d");
112 dstruct(s, cparms, fLimitEnabled, "d");
113 dstruct(s, cparms, wTimeLimit, "u");
114 dstruct(s, cparms, fMCIControl, "d");
115 dstruct(s, cparms, fStepMCIDevice, "d");
116 dstruct(s, cparms, dwMCIStartTime, "lu");
117 dstruct(s, cparms, dwMCIStopTime, "lu");
118 dstruct(s, cparms, fStepCaptureAt2x, "d");
119 dstruct(s, cparms, wStepCaptureAverageFrames, "u");
120 dstruct(s, cparms, dwAudioBufferSize, "lu");
121 dstruct(s, cparms, fDisableWriteCache, "d");
122 dstruct(s, cparms, AVStreamMaster, "u");
125 static void dump_videohdr(AVFormatContext *s, VIDEOHDR *vhdr)
128 av_log(s, AV_LOG_DEBUG, "VIDEOHDR\n");
129 dstruct(s, vhdr, lpData, "p");
130 dstruct(s, vhdr, dwBufferLength, "lu");
131 dstruct(s, vhdr, dwBytesUsed, "lu");
132 dstruct(s, vhdr, dwTimeCaptured, "lu");
133 dstruct(s, vhdr, dwUser, "lu");
134 dstruct(s, vhdr, dwFlags, "lu");
135 dstruct(s, vhdr, dwReserved[0], "lu");
136 dstruct(s, vhdr, dwReserved[1], "lu");
137 dstruct(s, vhdr, dwReserved[2], "lu");
138 dstruct(s, vhdr, dwReserved[3], "lu");
142 static void dump_bih(AVFormatContext *s, BITMAPINFOHEADER *bih)
144 av_log(s, AV_LOG_DEBUG, "BITMAPINFOHEADER\n");
145 dstruct(s, bih, biSize, "lu");
146 dstruct(s, bih, biWidth, "ld");
147 dstruct(s, bih, biHeight, "ld");
148 dstruct(s, bih, biPlanes, "d");
149 dstruct(s, bih, biBitCount, "d");
150 dstruct(s, bih, biCompression, "lu");
151 av_log(s, AV_LOG_DEBUG, " biCompression:\t\"%.4s\"\n",
152 (char*) &bih->biCompression);
153 dstruct(s, bih, biSizeImage, "lu");
154 dstruct(s, bih, biXPelsPerMeter, "lu");
155 dstruct(s, bih, biYPelsPerMeter, "lu");
156 dstruct(s, bih, biClrUsed, "lu");
157 dstruct(s, bih, biClrImportant, "lu");
160 static int shall_we_drop(AVFormatContext *s)
162 struct vfw_ctx *ctx = s->priv_data;
163 static const uint8_t dropscore[4] = { 62, 75, 87, 100 };
164 const int ndropscores = FF_ARRAY_ELEMS(dropscore);
165 unsigned int buffer_fullness = (ctx->curbufsize*100)/s->max_picture_buffer;
167 if(dropscore[++ctx->frame_num%ndropscores] <= buffer_fullness) {
168 av_log(s, AV_LOG_ERROR,
169 "real-time buffer %d%% full! frame dropped!\n", buffer_fullness);
176 static LRESULT CALLBACK videostream_cb(HWND hwnd, LPVIDEOHDR vdhdr)
180 AVPacketList **ppktl, *pktl_next;
182 s = (AVFormatContext *) GetWindowLongPtr(hwnd, GWLP_USERDATA);
185 dump_videohdr(s, vdhdr);
190 WaitForSingleObject(ctx->mutex, INFINITE);
192 pktl_next = av_mallocz(sizeof(AVPacketList));
196 if(av_new_packet(&pktl_next->pkt, vdhdr->dwBytesUsed) < 0) {
201 pktl_next->pkt.pts = vdhdr->dwTimeCaptured;
202 memcpy(pktl_next->pkt.data, vdhdr->lpData, vdhdr->dwBytesUsed);
204 for(ppktl = &ctx->pktl ; *ppktl ; ppktl = &(*ppktl)->next);
207 ctx->curbufsize += vdhdr->dwBytesUsed;
209 SetEvent(ctx->event);
210 ReleaseMutex(ctx->mutex);
214 ReleaseMutex(ctx->mutex);
218 static int vfw_read_close(AVFormatContext *s)
220 struct vfw_ctx *ctx = s->priv_data;
224 SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0, 0);
225 SendMessage(ctx->hwnd, WM_CAP_DRIVER_DISCONNECT, 0, 0);
226 DestroyWindow(ctx->hwnd);
229 CloseHandle(ctx->mutex);
231 CloseHandle(ctx->event);
235 AVPacketList *next = pktl->next;
236 av_packet_unref(&pktl->pkt);
244 static int vfw_read_header(AVFormatContext *s)
246 struct vfw_ctx *ctx = s->priv_data;
247 AVCodecParameters *par;
256 AVRational framerate_q;
258 if (!strcmp(s->filename, "list")) {
259 for (devnum = 0; devnum <= 9; devnum++) {
260 char driver_name[256];
261 char driver_ver[256];
262 ret = capGetDriverDescription(devnum,
263 driver_name, sizeof(driver_name),
264 driver_ver, sizeof(driver_ver));
266 av_log(s, AV_LOG_INFO, "Driver %d\n", devnum);
267 av_log(s, AV_LOG_INFO, " %s\n", driver_name);
268 av_log(s, AV_LOG_INFO, " %s\n", driver_ver);
274 ctx->hwnd = capCreateCaptureWindow(NULL, 0, 0, 0, 0, 0, HWND_MESSAGE, 0);
276 av_log(s, AV_LOG_ERROR, "Could not create capture window.\n");
280 /* If atoi fails, devnum==0 and the default device is used */
281 devnum = atoi(s->filename);
283 ret = SendMessage(ctx->hwnd, WM_CAP_DRIVER_CONNECT, devnum, 0);
285 av_log(s, AV_LOG_ERROR, "Could not connect to device.\n");
286 DestroyWindow(ctx->hwnd);
287 return AVERROR(ENODEV);
290 SendMessage(ctx->hwnd, WM_CAP_SET_OVERLAY, 0, 0);
291 SendMessage(ctx->hwnd, WM_CAP_SET_PREVIEW, 0, 0);
293 ret = SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0,
294 (LPARAM) videostream_cb);
296 av_log(s, AV_LOG_ERROR, "Could not set video stream callback.\n");
300 SetWindowLongPtr(ctx->hwnd, GWLP_USERDATA, (LONG_PTR) s);
302 st = avformat_new_stream(s, NULL);
305 return AVERROR(ENOMEM);
308 /* Set video format */
309 bisize = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, 0, 0);
312 bi = av_malloc(bisize);
315 return AVERROR(ENOMEM);
317 ret = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, bisize, (LPARAM) bi);
321 dump_bih(s, &bi->bmiHeader);
324 if (ctx->video_size) {
325 ret = av_parse_video_size(&bi->bmiHeader.biWidth, &bi->bmiHeader.biHeight, ctx->video_size);
327 av_log(s, AV_LOG_ERROR, "Couldn't parse video size.\n");
333 /* For testing yet unsupported compressions
334 * Copy these values from user-supplied verbose information */
335 bi->bmiHeader.biWidth = 320;
336 bi->bmiHeader.biHeight = 240;
337 bi->bmiHeader.biPlanes = 1;
338 bi->bmiHeader.biBitCount = 12;
339 bi->bmiHeader.biCompression = MKTAG('I','4','2','0');
340 bi->bmiHeader.biSizeImage = 115200;
341 dump_bih(s, &bi->bmiHeader);
344 ret = SendMessage(ctx->hwnd, WM_CAP_SET_VIDEOFORMAT, bisize, (LPARAM) bi);
346 av_log(s, AV_LOG_ERROR, "Could not set Video Format.\n");
350 biCompression = bi->bmiHeader.biCompression;
351 biBitCount = bi->bmiHeader.biBitCount;
355 /* Set sequence setup */
356 ret = SendMessage(ctx->hwnd, WM_CAP_GET_SEQUENCE_SETUP, sizeof(cparms),
361 dump_captureparms(s, &cparms);
363 cparms.fYield = 1; // Spawn a background thread
364 cparms.dwRequestMicroSecPerFrame =
365 (framerate_q.den*1000000) / framerate_q.num;
366 cparms.fAbortLeftMouse = 0;
367 cparms.fAbortRightMouse = 0;
368 cparms.fCaptureAudio = 0;
369 cparms.vKeyAbort = 0;
371 ret = SendMessage(ctx->hwnd, WM_CAP_SET_SEQUENCE_SETUP, sizeof(cparms),
376 st->avg_frame_rate = framerate_q;
379 par->codec_type = AVMEDIA_TYPE_VIDEO;
380 par->width = bi->bmiHeader.biWidth;
381 par->height = bi->bmiHeader.biHeight;
382 par->format = vfw_pixfmt(biCompression, biBitCount);
383 if (par->format == AV_PIX_FMT_NONE) {
384 par->codec_id = vfw_codecid(biCompression);
385 if (par->codec_id == AV_CODEC_ID_NONE) {
386 av_log(s, AV_LOG_ERROR, "Unknown compression type. "
387 "Please report verbose (-v 9) debug information.\n");
389 return AVERROR_PATCHWELCOME;
391 par->bits_per_coded_sample = biBitCount;
393 par->codec_id = AV_CODEC_ID_RAWVIDEO;
394 if(biCompression == BI_RGB) {
395 par->bits_per_coded_sample = biBitCount;
396 par->extradata = av_malloc(9 + AV_INPUT_BUFFER_PADDING_SIZE);
397 if (par->extradata) {
398 par->extradata_size = 9;
399 memcpy(par->extradata, "BottomUp", 9);
404 avpriv_set_pts_info(st, 32, 1, 1000);
406 ctx->mutex = CreateMutex(NULL, 0, NULL);
408 av_log(s, AV_LOG_ERROR, "Could not create Mutex.\n" );
411 ctx->event = CreateEvent(NULL, 1, 0, NULL);
413 av_log(s, AV_LOG_ERROR, "Could not create Event.\n" );
417 ret = SendMessage(ctx->hwnd, WM_CAP_SEQUENCE_NOFILE, 0, 0);
419 av_log(s, AV_LOG_ERROR, "Could not start capture sequence.\n" );
433 static int vfw_read_packet(AVFormatContext *s, AVPacket *pkt)
435 struct vfw_ctx *ctx = s->priv_data;
436 AVPacketList *pktl = NULL;
439 WaitForSingleObject(ctx->mutex, INFINITE);
442 *pkt = ctx->pktl->pkt;
443 ctx->pktl = ctx->pktl->next;
446 ResetEvent(ctx->event);
447 ReleaseMutex(ctx->mutex);
449 if(s->flags & AVFMT_FLAG_NONBLOCK) {
450 return AVERROR(EAGAIN);
452 WaitForSingleObject(ctx->event, INFINITE);
457 ctx->curbufsize -= pkt->size;
462 #define OFFSET(x) offsetof(struct vfw_ctx, x)
463 #define DEC AV_OPT_FLAG_DECODING_PARAM
464 static const AVOption options[] = {
465 { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, DEC },
466 { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc"}, 0, 0, DEC },
470 static const AVClass vfw_class = {
471 .class_name = "VFW indev",
472 .item_name = av_default_item_name,
474 .version = LIBAVUTIL_VERSION_INT,
477 AVInputFormat ff_vfwcap_demuxer = {
479 .long_name = NULL_IF_CONFIG_SMALL("VfW video capture"),
480 .priv_data_size = sizeof(struct vfw_ctx),
481 .read_header = vfw_read_header,
482 .read_packet = vfw_read_packet,
483 .read_close = vfw_read_close,
484 .flags = AVFMT_NOFILE,
485 .priv_class = &vfw_class,