vfwcap: add video_size private option.
[ffmpeg.git] / libavdevice / vfwcap.c
1 /*
2  * VFW capture interface
3  * Copyright (c) 2006-2008 Ramiro Polla
4  *
5  * This file is part of Libav.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "libavformat/avformat.h"
23 #include "libavutil/log.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/parseutils.h"
26 #include <windows.h>
27 #include <vfw.h>
28
29 //#define DEBUG_VFW
30
31 /* Defines for VFW missing from MinGW.
32  * Remove this when MinGW incorporates them. */
33 #define HWND_MESSAGE                ((HWND)-3)
34
35 #define BI_RGB                      0
36
37 /* End of missing MinGW defines */
38
39 struct vfw_ctx {
40     const AVClass *class;
41     HWND hwnd;
42     HANDLE mutex;
43     HANDLE event;
44     AVPacketList *pktl;
45     unsigned int curbufsize;
46     unsigned int frame_num;
47     char *video_size;       /**< A string describing video size, set by a private option. */
48 };
49
50 static enum PixelFormat vfw_pixfmt(DWORD biCompression, WORD biBitCount)
51 {
52     switch(biCompression) {
53     case MKTAG('U', 'Y', 'V', 'Y'):
54         return PIX_FMT_UYVY422;
55     case MKTAG('Y', 'U', 'Y', '2'):
56         return PIX_FMT_YUYV422;
57     case MKTAG('I', '4', '2', '0'):
58         return PIX_FMT_YUV420P;
59     case BI_RGB:
60         switch(biBitCount) { /* 1-8 are untested */
61             case 1:
62                 return PIX_FMT_MONOWHITE;
63             case 4:
64                 return PIX_FMT_RGB4;
65             case 8:
66                 return PIX_FMT_RGB8;
67             case 16:
68                 return PIX_FMT_RGB555;
69             case 24:
70                 return PIX_FMT_BGR24;
71             case 32:
72                 return PIX_FMT_RGB32;
73         }
74     }
75     return PIX_FMT_NONE;
76 }
77
78 static enum CodecID vfw_codecid(DWORD biCompression)
79 {
80     switch(biCompression) {
81     case MKTAG('d', 'v', 's', 'd'):
82         return CODEC_ID_DVVIDEO;
83     case MKTAG('M', 'J', 'P', 'G'):
84     case MKTAG('m', 'j', 'p', 'g'):
85         return CODEC_ID_MJPEG;
86     }
87     return CODEC_ID_NONE;
88 }
89
90 #define dstruct(pctx, sname, var, type) \
91     av_log(pctx, AV_LOG_DEBUG, #var":\t%"type"\n", sname->var)
92
93 static void dump_captureparms(AVFormatContext *s, CAPTUREPARMS *cparms)
94 {
95     av_log(s, AV_LOG_DEBUG, "CAPTUREPARMS\n");
96     dstruct(s, cparms, dwRequestMicroSecPerFrame, "lu");
97     dstruct(s, cparms, fMakeUserHitOKToCapture, "d");
98     dstruct(s, cparms, wPercentDropForError, "u");
99     dstruct(s, cparms, fYield, "d");
100     dstruct(s, cparms, dwIndexSize, "lu");
101     dstruct(s, cparms, wChunkGranularity, "u");
102     dstruct(s, cparms, fUsingDOSMemory, "d");
103     dstruct(s, cparms, wNumVideoRequested, "u");
104     dstruct(s, cparms, fCaptureAudio, "d");
105     dstruct(s, cparms, wNumAudioRequested, "u");
106     dstruct(s, cparms, vKeyAbort, "u");
107     dstruct(s, cparms, fAbortLeftMouse, "d");
108     dstruct(s, cparms, fAbortRightMouse, "d");
109     dstruct(s, cparms, fLimitEnabled, "d");
110     dstruct(s, cparms, wTimeLimit, "u");
111     dstruct(s, cparms, fMCIControl, "d");
112     dstruct(s, cparms, fStepMCIDevice, "d");
113     dstruct(s, cparms, dwMCIStartTime, "lu");
114     dstruct(s, cparms, dwMCIStopTime, "lu");
115     dstruct(s, cparms, fStepCaptureAt2x, "d");
116     dstruct(s, cparms, wStepCaptureAverageFrames, "u");
117     dstruct(s, cparms, dwAudioBufferSize, "lu");
118     dstruct(s, cparms, fDisableWriteCache, "d");
119     dstruct(s, cparms, AVStreamMaster, "u");
120 }
121
122 static void dump_videohdr(AVFormatContext *s, VIDEOHDR *vhdr)
123 {
124 #ifdef DEBUG_VFW
125     av_log(s, AV_LOG_DEBUG, "VIDEOHDR\n");
126     dstruct(s, vhdr, lpData, "p");
127     dstruct(s, vhdr, dwBufferLength, "lu");
128     dstruct(s, vhdr, dwBytesUsed, "lu");
129     dstruct(s, vhdr, dwTimeCaptured, "lu");
130     dstruct(s, vhdr, dwUser, "lu");
131     dstruct(s, vhdr, dwFlags, "lu");
132     dstruct(s, vhdr, dwReserved[0], "lu");
133     dstruct(s, vhdr, dwReserved[1], "lu");
134     dstruct(s, vhdr, dwReserved[2], "lu");
135     dstruct(s, vhdr, dwReserved[3], "lu");
136 #endif
137 }
138
139 static void dump_bih(AVFormatContext *s, BITMAPINFOHEADER *bih)
140 {
141     av_log(s, AV_LOG_DEBUG, "BITMAPINFOHEADER\n");
142     dstruct(s, bih, biSize, "lu");
143     dstruct(s, bih, biWidth, "ld");
144     dstruct(s, bih, biHeight, "ld");
145     dstruct(s, bih, biPlanes, "d");
146     dstruct(s, bih, biBitCount, "d");
147     dstruct(s, bih, biCompression, "lu");
148     av_log(s, AV_LOG_DEBUG, "    biCompression:\t\"%.4s\"\n",
149                    (char*) &bih->biCompression);
150     dstruct(s, bih, biSizeImage, "lu");
151     dstruct(s, bih, biXPelsPerMeter, "lu");
152     dstruct(s, bih, biYPelsPerMeter, "lu");
153     dstruct(s, bih, biClrUsed, "lu");
154     dstruct(s, bih, biClrImportant, "lu");
155 }
156
157 static int shall_we_drop(AVFormatContext *s)
158 {
159     struct vfw_ctx *ctx = s->priv_data;
160     const uint8_t dropscore[] = {62, 75, 87, 100};
161     const int ndropscores = FF_ARRAY_ELEMS(dropscore);
162     unsigned int buffer_fullness = (ctx->curbufsize*100)/s->max_picture_buffer;
163
164     if(dropscore[++ctx->frame_num%ndropscores] <= buffer_fullness) {
165         av_log(s, AV_LOG_ERROR,
166               "real-time buffer %d%% full! frame dropped!\n", buffer_fullness);
167         return 1;
168     }
169
170     return 0;
171 }
172
173 static LRESULT CALLBACK videostream_cb(HWND hwnd, LPVIDEOHDR vdhdr)
174 {
175     AVFormatContext *s;
176     struct vfw_ctx *ctx;
177     AVPacketList **ppktl, *pktl_next;
178
179     s = (AVFormatContext *) GetWindowLongPtr(hwnd, GWLP_USERDATA);
180     ctx = s->priv_data;
181
182     dump_videohdr(s, vdhdr);
183
184     if(shall_we_drop(s))
185         return FALSE;
186
187     WaitForSingleObject(ctx->mutex, INFINITE);
188
189     pktl_next = av_mallocz(sizeof(AVPacketList));
190     if(!pktl_next)
191         goto fail;
192
193     if(av_new_packet(&pktl_next->pkt, vdhdr->dwBytesUsed) < 0) {
194         av_free(pktl_next);
195         goto fail;
196     }
197
198     pktl_next->pkt.pts = vdhdr->dwTimeCaptured;
199     memcpy(pktl_next->pkt.data, vdhdr->lpData, vdhdr->dwBytesUsed);
200
201     for(ppktl = &ctx->pktl ; *ppktl ; ppktl = &(*ppktl)->next);
202     *ppktl = pktl_next;
203
204     ctx->curbufsize += vdhdr->dwBytesUsed;
205
206     SetEvent(ctx->event);
207     ReleaseMutex(ctx->mutex);
208
209     return TRUE;
210 fail:
211     ReleaseMutex(ctx->mutex);
212     return FALSE;
213 }
214
215 static int vfw_read_close(AVFormatContext *s)
216 {
217     struct vfw_ctx *ctx = s->priv_data;
218     AVPacketList *pktl;
219
220     if(ctx->hwnd) {
221         SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0, 0);
222         SendMessage(ctx->hwnd, WM_CAP_DRIVER_DISCONNECT, 0, 0);
223         DestroyWindow(ctx->hwnd);
224     }
225     if(ctx->mutex)
226         CloseHandle(ctx->mutex);
227     if(ctx->event)
228         CloseHandle(ctx->event);
229
230     pktl = ctx->pktl;
231     while (pktl) {
232         AVPacketList *next = pktl->next;
233         av_destruct_packet(&pktl->pkt);
234         av_free(pktl);
235         pktl = next;
236     }
237
238     av_freep(&ctx->video_size);
239
240     return 0;
241 }
242
243 static int vfw_read_header(AVFormatContext *s, AVFormatParameters *ap)
244 {
245     struct vfw_ctx *ctx = s->priv_data;
246     AVCodecContext *codec;
247     AVStream *st;
248     int devnum;
249     int bisize;
250     BITMAPINFO *bi;
251     CAPTUREPARMS cparms;
252     DWORD biCompression;
253     WORD biBitCount;
254     int ret;
255
256     if (!strcmp(s->filename, "list")) {
257         for (devnum = 0; devnum <= 9; devnum++) {
258             char driver_name[256];
259             char driver_ver[256];
260             ret = capGetDriverDescription(devnum,
261                                           driver_name, sizeof(driver_name),
262                                           driver_ver, sizeof(driver_ver));
263             if (ret) {
264                 av_log(s, AV_LOG_INFO, "Driver %d\n", devnum);
265                 av_log(s, AV_LOG_INFO, " %s\n", driver_name);
266                 av_log(s, AV_LOG_INFO, " %s\n", driver_ver);
267             }
268         }
269         return AVERROR(EIO);
270     }
271
272     if(!ap->time_base.den) {
273         av_log(s, AV_LOG_ERROR, "A time base must be specified.\n");
274         return AVERROR(EIO);
275     }
276
277     ctx->hwnd = capCreateCaptureWindow(NULL, 0, 0, 0, 0, 0, HWND_MESSAGE, 0);
278     if(!ctx->hwnd) {
279         av_log(s, AV_LOG_ERROR, "Could not create capture window.\n");
280         return AVERROR(EIO);
281     }
282
283     /* If atoi fails, devnum==0 and the default device is used */
284     devnum = atoi(s->filename);
285
286     ret = SendMessage(ctx->hwnd, WM_CAP_DRIVER_CONNECT, devnum, 0);
287     if(!ret) {
288         av_log(s, AV_LOG_ERROR, "Could not connect to device.\n");
289         DestroyWindow(ctx->hwnd);
290         return AVERROR(ENODEV);
291     }
292
293     SendMessage(ctx->hwnd, WM_CAP_SET_OVERLAY, 0, 0);
294     SendMessage(ctx->hwnd, WM_CAP_SET_PREVIEW, 0, 0);
295
296     ret = SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0,
297                       (LPARAM) videostream_cb);
298     if(!ret) {
299         av_log(s, AV_LOG_ERROR, "Could not set video stream callback.\n");
300         goto fail_io;
301     }
302
303     SetWindowLongPtr(ctx->hwnd, GWLP_USERDATA, (LONG_PTR) s);
304
305     st = av_new_stream(s, 0);
306     if(!st) {
307         vfw_read_close(s);
308         return AVERROR(ENOMEM);
309     }
310
311     /* Set video format */
312     bisize = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, 0, 0);
313     if(!bisize)
314         goto fail_io;
315     bi = av_malloc(bisize);
316     if(!bi) {
317         vfw_read_close(s);
318         return AVERROR(ENOMEM);
319     }
320     ret = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, bisize, (LPARAM) bi);
321     if(!ret)
322         goto fail_bi;
323
324     dump_bih(s, &bi->bmiHeader);
325
326
327     if (ctx->video_size) {
328         ret = av_parse_video_size(&bi->bmiHeader.biWidth, &bi->bmiHeader.biHeight, ctx->video_size);
329         if (ret < 0) {
330             av_log(s, AV_LOG_ERROR, "Couldn't parse video size.\n");
331             goto fail_bi;
332         }
333     }
334 #if FF_API_FORMAT_PARAMETERS
335     if (ap->width > 0)
336         bi->bmiHeader.biWidth = ap->width;
337     if (ap->height > 0)
338         bi->bmiHeader.biHeight = ap->height;
339 #endif
340
341     if (0) {
342         /* For testing yet unsupported compressions
343          * Copy these values from user-supplied verbose information */
344         bi->bmiHeader.biWidth       = 320;
345         bi->bmiHeader.biHeight      = 240;
346         bi->bmiHeader.biPlanes      = 1;
347         bi->bmiHeader.biBitCount    = 12;
348         bi->bmiHeader.biCompression = MKTAG('I','4','2','0');
349         bi->bmiHeader.biSizeImage   = 115200;
350         dump_bih(s, &bi->bmiHeader);
351     }
352
353     ret = SendMessage(ctx->hwnd, WM_CAP_SET_VIDEOFORMAT, bisize, (LPARAM) bi);
354     if(!ret) {
355         av_log(s, AV_LOG_ERROR, "Could not set Video Format.\n");
356         goto fail_bi;
357     }
358
359     biCompression = bi->bmiHeader.biCompression;
360     biBitCount = bi->bmiHeader.biBitCount;
361
362     av_free(bi);
363
364     /* Set sequence setup */
365     ret = SendMessage(ctx->hwnd, WM_CAP_GET_SEQUENCE_SETUP, sizeof(cparms),
366                       (LPARAM) &cparms);
367     if(!ret)
368         goto fail_io;
369
370     dump_captureparms(s, &cparms);
371
372     cparms.fYield = 1; // Spawn a background thread
373     cparms.dwRequestMicroSecPerFrame =
374                                (ap->time_base.num*1000000) / ap->time_base.den;
375     cparms.fAbortLeftMouse = 0;
376     cparms.fAbortRightMouse = 0;
377     cparms.fCaptureAudio = 0;
378     cparms.vKeyAbort = 0;
379
380     ret = SendMessage(ctx->hwnd, WM_CAP_SET_SEQUENCE_SETUP, sizeof(cparms),
381                       (LPARAM) &cparms);
382     if(!ret)
383         goto fail_io;
384
385     codec = st->codec;
386     codec->time_base = ap->time_base;
387     codec->codec_type = AVMEDIA_TYPE_VIDEO;
388     codec->width  = bi->bmiHeader.biWidth;
389     codec->height = bi->bmiHeader.biHeight;
390     codec->pix_fmt = vfw_pixfmt(biCompression, biBitCount);
391     if(codec->pix_fmt == PIX_FMT_NONE) {
392         codec->codec_id = vfw_codecid(biCompression);
393         if(codec->codec_id == CODEC_ID_NONE) {
394             av_log(s, AV_LOG_ERROR, "Unknown compression type. "
395                              "Please report verbose (-v 9) debug information.\n");
396             vfw_read_close(s);
397             return AVERROR_PATCHWELCOME;
398         }
399         codec->bits_per_coded_sample = biBitCount;
400     } else {
401         codec->codec_id = CODEC_ID_RAWVIDEO;
402         if(biCompression == BI_RGB) {
403             codec->bits_per_coded_sample = biBitCount;
404             codec->extradata = av_malloc(9 + FF_INPUT_BUFFER_PADDING_SIZE);
405             if (codec->extradata) {
406                 codec->extradata_size = 9;
407                 memcpy(codec->extradata, "BottomUp", 9);
408             }
409         }
410     }
411
412     av_set_pts_info(st, 32, 1, 1000);
413
414     ctx->mutex = CreateMutex(NULL, 0, NULL);
415     if(!ctx->mutex) {
416         av_log(s, AV_LOG_ERROR, "Could not create Mutex.\n" );
417         goto fail_io;
418     }
419     ctx->event = CreateEvent(NULL, 1, 0, NULL);
420     if(!ctx->event) {
421         av_log(s, AV_LOG_ERROR, "Could not create Event.\n" );
422         goto fail_io;
423     }
424
425     ret = SendMessage(ctx->hwnd, WM_CAP_SEQUENCE_NOFILE, 0, 0);
426     if(!ret) {
427         av_log(s, AV_LOG_ERROR, "Could not start capture sequence.\n" );
428         goto fail_io;
429     }
430
431     return 0;
432
433 fail_bi:
434     av_free(bi);
435
436 fail_io:
437     vfw_read_close(s);
438     return AVERROR(EIO);
439 }
440
441 static int vfw_read_packet(AVFormatContext *s, AVPacket *pkt)
442 {
443     struct vfw_ctx *ctx = s->priv_data;
444     AVPacketList *pktl = NULL;
445
446     while(!pktl) {
447         WaitForSingleObject(ctx->mutex, INFINITE);
448         pktl = ctx->pktl;
449         if(ctx->pktl) {
450             *pkt = ctx->pktl->pkt;
451             ctx->pktl = ctx->pktl->next;
452             av_free(pktl);
453         }
454         ResetEvent(ctx->event);
455         ReleaseMutex(ctx->mutex);
456         if(!pktl) {
457             if(s->flags & AVFMT_FLAG_NONBLOCK) {
458                 return AVERROR(EAGAIN);
459             } else {
460                 WaitForSingleObject(ctx->event, INFINITE);
461             }
462         }
463     }
464
465     ctx->curbufsize -= pkt->size;
466
467     return pkt->size;
468 }
469
470 #define OFFSET(x) offsetof(struct vfw_ctx, x)
471 #define DEC AV_OPT_FLAG_DECODING_PARAM
472 static const AVOption options[] = {
473     { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), FF_OPT_TYPE_STRING, {.str = NULL}, 0, 0, DEC },
474     { NULL },
475 };
476
477 static const AVClass vfw_class = {
478     .class_name = "VFW indev",
479     .item_name  = av_default_item_name,
480     .option     = options,
481     .version    = LIBAVUTIL_VERSION_INT,
482 };
483
484 AVInputFormat ff_vfwcap_demuxer = {
485     "vfwcap",
486     NULL_IF_CONFIG_SMALL("VFW video capture"),
487     sizeof(struct vfw_ctx),
488     NULL,
489     vfw_read_header,
490     vfw_read_packet,
491     vfw_read_close,
492     .flags = AVFMT_NOFILE,
493     .priv_class = &vfw_class,
494 };