avpacket: Replace av_free_packet with av_packet_unref
[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 "libavutil/internal.h"
23 #include "libavutil/log.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/parseutils.h"
26
27 #include "libavformat/avformat.h"
28 #include "libavformat/internal.h"
29
30 // windows.h must no be included before winsock2.h, and libavformat internal
31 // headers may include winsock2.h
32 #include <windows.h>
33 // windows.h needs to be included before vfw.h
34 #include <vfw.h>
35
36 /* Some obsolete versions of MinGW32 before 4.0.0 lack this. */
37 #ifndef HWND_MESSAGE
38 #define HWND_MESSAGE ((HWND) -3)
39 #endif
40
41 struct vfw_ctx {
42     const AVClass *class;
43     HWND hwnd;
44     HANDLE mutex;
45     HANDLE event;
46     AVPacketList *pktl;
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. */
51 };
52
53 static enum AVPixelFormat vfw_pixfmt(DWORD biCompression, WORD biBitCount)
54 {
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;
62     case BI_RGB:
63         switch(biBitCount) { /* 1-8 are untested */
64             case 1:
65                 return AV_PIX_FMT_MONOWHITE;
66             case 4:
67                 return AV_PIX_FMT_RGB4;
68             case 8:
69                 return AV_PIX_FMT_RGB8;
70             case 16:
71                 return AV_PIX_FMT_RGB555;
72             case 24:
73                 return AV_PIX_FMT_BGR24;
74             case 32:
75                 return AV_PIX_FMT_RGB32;
76         }
77     }
78     return AV_PIX_FMT_NONE;
79 }
80
81 static enum AVCodecID vfw_codecid(DWORD biCompression)
82 {
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;
89     }
90     return AV_CODEC_ID_NONE;
91 }
92
93 #define dstruct(pctx, sname, var, type) \
94     av_log(pctx, AV_LOG_DEBUG, #var":\t%"type"\n", sname->var)
95
96 static void dump_captureparms(AVFormatContext *s, CAPTUREPARMS *cparms)
97 {
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");
123 }
124
125 static void dump_videohdr(AVFormatContext *s, VIDEOHDR *vhdr)
126 {
127 #ifdef DEBUG
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");
139 #endif
140 }
141
142 static void dump_bih(AVFormatContext *s, BITMAPINFOHEADER *bih)
143 {
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");
158 }
159
160 static int shall_we_drop(AVFormatContext *s)
161 {
162     struct vfw_ctx *ctx = s->priv_data;
163     const uint8_t dropscore[] = {62, 75, 87, 100};
164     const int ndropscores = FF_ARRAY_ELEMS(dropscore);
165     unsigned int buffer_fullness = (ctx->curbufsize*100)/s->max_picture_buffer;
166
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);
170         return 1;
171     }
172
173     return 0;
174 }
175
176 static LRESULT CALLBACK videostream_cb(HWND hwnd, LPVIDEOHDR vdhdr)
177 {
178     AVFormatContext *s;
179     struct vfw_ctx *ctx;
180     AVPacketList **ppktl, *pktl_next;
181
182     s = (AVFormatContext *) GetWindowLongPtr(hwnd, GWLP_USERDATA);
183     ctx = s->priv_data;
184
185     dump_videohdr(s, vdhdr);
186
187     if(shall_we_drop(s))
188         return FALSE;
189
190     WaitForSingleObject(ctx->mutex, INFINITE);
191
192     pktl_next = av_mallocz(sizeof(AVPacketList));
193     if(!pktl_next)
194         goto fail;
195
196     if(av_new_packet(&pktl_next->pkt, vdhdr->dwBytesUsed) < 0) {
197         av_free(pktl_next);
198         goto fail;
199     }
200
201     pktl_next->pkt.pts = vdhdr->dwTimeCaptured;
202     memcpy(pktl_next->pkt.data, vdhdr->lpData, vdhdr->dwBytesUsed);
203
204     for(ppktl = &ctx->pktl ; *ppktl ; ppktl = &(*ppktl)->next);
205     *ppktl = pktl_next;
206
207     ctx->curbufsize += vdhdr->dwBytesUsed;
208
209     SetEvent(ctx->event);
210     ReleaseMutex(ctx->mutex);
211
212     return TRUE;
213 fail:
214     ReleaseMutex(ctx->mutex);
215     return FALSE;
216 }
217
218 static int vfw_read_close(AVFormatContext *s)
219 {
220     struct vfw_ctx *ctx = s->priv_data;
221     AVPacketList *pktl;
222
223     if(ctx->hwnd) {
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);
227     }
228     if(ctx->mutex)
229         CloseHandle(ctx->mutex);
230     if(ctx->event)
231         CloseHandle(ctx->event);
232
233     pktl = ctx->pktl;
234     while (pktl) {
235         AVPacketList *next = pktl->next;
236         av_packet_unref(&pktl->pkt);
237         av_free(pktl);
238         pktl = next;
239     }
240
241     return 0;
242 }
243
244 static int vfw_read_header(AVFormatContext *s)
245 {
246     struct vfw_ctx *ctx = s->priv_data;
247     AVCodecContext *codec;
248     AVStream *st;
249     int devnum;
250     int bisize;
251     BITMAPINFO *bi;
252     CAPTUREPARMS cparms;
253     DWORD biCompression;
254     WORD biBitCount;
255     int ret;
256     AVRational framerate_q;
257
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));
265             if (ret) {
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);
269             }
270         }
271         return AVERROR(EIO);
272     }
273
274     ctx->hwnd = capCreateCaptureWindow(NULL, 0, 0, 0, 0, 0, HWND_MESSAGE, 0);
275     if(!ctx->hwnd) {
276         av_log(s, AV_LOG_ERROR, "Could not create capture window.\n");
277         return AVERROR(EIO);
278     }
279
280     /* If atoi fails, devnum==0 and the default device is used */
281     devnum = atoi(s->filename);
282
283     ret = SendMessage(ctx->hwnd, WM_CAP_DRIVER_CONNECT, devnum, 0);
284     if(!ret) {
285         av_log(s, AV_LOG_ERROR, "Could not connect to device.\n");
286         DestroyWindow(ctx->hwnd);
287         return AVERROR(ENODEV);
288     }
289
290     SendMessage(ctx->hwnd, WM_CAP_SET_OVERLAY, 0, 0);
291     SendMessage(ctx->hwnd, WM_CAP_SET_PREVIEW, 0, 0);
292
293     ret = SendMessage(ctx->hwnd, WM_CAP_SET_CALLBACK_VIDEOSTREAM, 0,
294                       (LPARAM) videostream_cb);
295     if(!ret) {
296         av_log(s, AV_LOG_ERROR, "Could not set video stream callback.\n");
297         goto fail_io;
298     }
299
300     SetWindowLongPtr(ctx->hwnd, GWLP_USERDATA, (LONG_PTR) s);
301
302     st = avformat_new_stream(s, NULL);
303     if(!st) {
304         vfw_read_close(s);
305         return AVERROR(ENOMEM);
306     }
307
308     /* Set video format */
309     bisize = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, 0, 0);
310     if(!bisize)
311         goto fail_io;
312     bi = av_malloc(bisize);
313     if(!bi) {
314         vfw_read_close(s);
315         return AVERROR(ENOMEM);
316     }
317     ret = SendMessage(ctx->hwnd, WM_CAP_GET_VIDEOFORMAT, bisize, (LPARAM) bi);
318     if(!ret)
319         goto fail_bi;
320
321     dump_bih(s, &bi->bmiHeader);
322
323
324     if (ctx->video_size) {
325         ret = av_parse_video_size(&bi->bmiHeader.biWidth, &bi->bmiHeader.biHeight, ctx->video_size);
326         if (ret < 0) {
327             av_log(s, AV_LOG_ERROR, "Couldn't parse video size.\n");
328             goto fail_bi;
329         }
330     }
331
332     if (0) {
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);
342     }
343
344     ret = SendMessage(ctx->hwnd, WM_CAP_SET_VIDEOFORMAT, bisize, (LPARAM) bi);
345     if(!ret) {
346         av_log(s, AV_LOG_ERROR, "Could not set Video Format.\n");
347         goto fail_bi;
348     }
349
350     biCompression = bi->bmiHeader.biCompression;
351     biBitCount = bi->bmiHeader.biBitCount;
352
353     av_free(bi);
354
355     /* Set sequence setup */
356     ret = SendMessage(ctx->hwnd, WM_CAP_GET_SEQUENCE_SETUP, sizeof(cparms),
357                       (LPARAM) &cparms);
358     if(!ret)
359         goto fail_io;
360
361     dump_captureparms(s, &cparms);
362
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;
370
371     ret = SendMessage(ctx->hwnd, WM_CAP_SET_SEQUENCE_SETUP, sizeof(cparms),
372                       (LPARAM) &cparms);
373     if(!ret)
374         goto fail_io;
375
376     codec = st->codec;
377     codec->time_base = (AVRational){framerate_q.den, framerate_q.num};
378     codec->codec_type = AVMEDIA_TYPE_VIDEO;
379     codec->width  = bi->bmiHeader.biWidth;
380     codec->height = bi->bmiHeader.biHeight;
381     codec->pix_fmt = vfw_pixfmt(biCompression, biBitCount);
382     if(codec->pix_fmt == AV_PIX_FMT_NONE) {
383         codec->codec_id = vfw_codecid(biCompression);
384         if(codec->codec_id == AV_CODEC_ID_NONE) {
385             av_log(s, AV_LOG_ERROR, "Unknown compression type. "
386                              "Please report verbose (-v 9) debug information.\n");
387             vfw_read_close(s);
388             return AVERROR_PATCHWELCOME;
389         }
390         codec->bits_per_coded_sample = biBitCount;
391     } else {
392         codec->codec_id = AV_CODEC_ID_RAWVIDEO;
393         if(biCompression == BI_RGB) {
394             codec->bits_per_coded_sample = biBitCount;
395             codec->extradata = av_malloc(9 + AV_INPUT_BUFFER_PADDING_SIZE);
396             if (codec->extradata) {
397                 codec->extradata_size = 9;
398                 memcpy(codec->extradata, "BottomUp", 9);
399             }
400         }
401     }
402
403     avpriv_set_pts_info(st, 32, 1, 1000);
404
405     ctx->mutex = CreateMutex(NULL, 0, NULL);
406     if(!ctx->mutex) {
407         av_log(s, AV_LOG_ERROR, "Could not create Mutex.\n" );
408         goto fail_io;
409     }
410     ctx->event = CreateEvent(NULL, 1, 0, NULL);
411     if(!ctx->event) {
412         av_log(s, AV_LOG_ERROR, "Could not create Event.\n" );
413         goto fail_io;
414     }
415
416     ret = SendMessage(ctx->hwnd, WM_CAP_SEQUENCE_NOFILE, 0, 0);
417     if(!ret) {
418         av_log(s, AV_LOG_ERROR, "Could not start capture sequence.\n" );
419         goto fail_io;
420     }
421
422     return 0;
423
424 fail_bi:
425     av_free(bi);
426
427 fail_io:
428     vfw_read_close(s);
429     return AVERROR(EIO);
430 }
431
432 static int vfw_read_packet(AVFormatContext *s, AVPacket *pkt)
433 {
434     struct vfw_ctx *ctx = s->priv_data;
435     AVPacketList *pktl = NULL;
436
437     while(!pktl) {
438         WaitForSingleObject(ctx->mutex, INFINITE);
439         pktl = ctx->pktl;
440         if(ctx->pktl) {
441             *pkt = ctx->pktl->pkt;
442             ctx->pktl = ctx->pktl->next;
443             av_free(pktl);
444         }
445         ResetEvent(ctx->event);
446         ReleaseMutex(ctx->mutex);
447         if(!pktl) {
448             if(s->flags & AVFMT_FLAG_NONBLOCK) {
449                 return AVERROR(EAGAIN);
450             } else {
451                 WaitForSingleObject(ctx->event, INFINITE);
452             }
453         }
454     }
455
456     ctx->curbufsize -= pkt->size;
457
458     return pkt->size;
459 }
460
461 #define OFFSET(x) offsetof(struct vfw_ctx, x)
462 #define DEC AV_OPT_FLAG_DECODING_PARAM
463 static const AVOption options[] = {
464     { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, DEC },
465     { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc"}, 0, 0, DEC },
466     { NULL },
467 };
468
469 static const AVClass vfw_class = {
470     .class_name = "VFW indev",
471     .item_name  = av_default_item_name,
472     .option     = options,
473     .version    = LIBAVUTIL_VERSION_INT,
474 };
475
476 AVInputFormat ff_vfwcap_demuxer = {
477     .name           = "vfwcap",
478     .long_name      = NULL_IF_CONFIG_SMALL("VfW video capture"),
479     .priv_data_size = sizeof(struct vfw_ctx),
480     .read_header    = vfw_read_header,
481     .read_packet    = vfw_read_packet,
482     .read_close     = vfw_read_close,
483     .flags          = AVFMT_NOFILE,
484     .priv_class     = &vfw_class,
485 };