1 /*****************************************************************************
2 * qtcapture.m: qtkit (Mac OS X) based capture module
3 *****************************************************************************
4 * Copyright © 2008-2011 VLC authors and VideoLAN
6 * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
8 ****************************************************************************
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_input.h>
35 #include <vlc_demux.h>
36 #include <vlc_interface.h>
37 #include <vlc_dialog.h>
38 #include <vlc_access.h>
40 #import <QTKit/QTKit.h>
41 #import <CoreAudio/CoreAudio.h>
43 #define QTKIT_WIDTH_TEXT N_("Video Capture width")
44 #define QTKIT_WIDTH_LONGTEXT N_("Video Capture width in pixel")
45 #define QTKIT_HEIGHT_TEXT N_("Video Capture height")
46 #define QTKIT_HEIGHT_LONGTEXT N_("Video Capture height in pixel")
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Open(vlc_object_t *p_this);
52 static void Close(vlc_object_t *p_this);
53 static int Demux(demux_t *p_demux);
54 static int Control(demux_t *, int, va_list);
56 /*****************************************************************************
58 *****************************************************************************/
60 set_shortname(N_("Quicktime Capture"))
61 set_description(N_("Quicktime Capture"))
62 set_category(CAT_INPUT)
63 set_subcategory(SUBCAT_INPUT_ACCESS)
64 add_shortcut("qtcapture")
65 set_capability("access_demux", 10)
66 set_callbacks(Open, Close)
67 add_integer("qtcapture-width", 640, QTKIT_WIDTH_TEXT, QTKIT_WIDTH_LONGTEXT, true)
68 change_integer_range (80, 1280)
69 add_integer("qtcapture-height", 480, QTKIT_HEIGHT_TEXT, QTKIT_HEIGHT_LONGTEXT, true)
70 change_integer_range (60, 480)
74 /*****************************************************************************
76 *****************************************************************************/
77 @interface VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
79 CVImageBufferRef currentImageBuffer;
85 - (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection;
86 - (mtime_t)copyCurrentFrameToBuffer:(void *)buffer;
89 /* Apple sample code */
90 @implementation VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
94 if (self = [super init]) {
95 currentImageBuffer = nil;
105 @synchronized (self) {
106 CVBufferRelease(currentImageBuffer);
107 currentImageBuffer = nil;
117 - (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection
119 // Store the latest frame
120 // This must be done in a @synchronized block because this delegate method is not called on the main thread
121 CVImageBufferRef imageBufferToRelease;
123 CVBufferRetain(videoFrame);
125 @synchronized (self) {
126 imageBufferToRelease = currentImageBuffer;
127 currentImageBuffer = videoFrame;
128 QTTime timeStamp = [sampleBuffer presentationTime];
129 timeScale = timeStamp.timeScale;
130 currentPts = (mtime_t)(1000000L / timeScale * timeStamp.timeValue);
132 /* Try to use hosttime of the sample if available, because iSight Pts seems broken */
133 NSNumber *hosttime = (NSNumber *)[sampleBuffer attributeForKey:QTSampleBufferHostTimeAttribute];
134 if (hosttime) currentPts = (mtime_t)AudioConvertHostTimeToNanos([hosttime unsignedLongLongValue])/1000;
136 CVBufferRelease(imageBufferToRelease);
139 - (mtime_t)copyCurrentFrameToBuffer:(void *)buffer
141 CVImageBufferRef imageBuffer;
146 if (!currentImageBuffer || currentPts == previousPts)
149 @synchronized (self) {
150 imageBuffer = CVBufferRetain(currentImageBuffer);
152 pts = previousPts = currentPts;
153 CVPixelBufferLockBaseAddress(imageBuffer, 0);
154 pixels = CVPixelBufferGetBaseAddress(imageBuffer);
156 memcpy(buffer, pixels, CVPixelBufferGetBytesPerRow(imageBuffer) * CVPixelBufferGetHeight(imageBuffer));
157 CVPixelBufferUnlockBaseAddress(imageBuffer, 0);
161 CVBufferRelease(imageBuffer);
171 /*****************************************************************************
173 *****************************************************************************/
176 QTCaptureSession * session;
177 QTCaptureDevice * device;
178 VLCDecompressedVideoOutput * output;
180 es_out_id_t * p_es_video;
186 /*****************************************************************************
188 *****************************************************************************/
189 static int qtchroma_to_fourcc(int i_qt)
195 } qtchroma_to_fourcc[] =
198 { '2vuy', VLC_CODEC_UYVY },
199 { 'yuv2',VLC_CODEC_YUYV },
200 { 'yuvs', VLC_CODEC_YUYV },
204 for (int i = 0; qtchroma_to_fourcc[i].i_qt; i++) {
205 if (qtchroma_to_fourcc[i].i_qt == i_qt)
206 return qtchroma_to_fourcc[i].i_fourcc;
211 /*****************************************************************************
213 *****************************************************************************/
214 static int Open(vlc_object_t *p_this)
216 demux_t *p_demux = (demux_t*)p_this;
217 demux_sys_t *p_sys = NULL;
222 char *psz_uid = NULL;
224 /* Only when selected */
225 if (*p_demux->psz_access == '\0')
228 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
230 if (p_demux->psz_location && *p_demux->psz_location)
231 psz_uid = strdup(p_demux->psz_location);
232 msg_Dbg(p_demux, "qtcapture uid = %s", psz_uid);
233 NSString *qtk_currdevice_uid = [[NSString alloc] initWithFormat:@"%s", psz_uid];
236 p_demux->pf_demux = Demux;
237 p_demux->pf_control = Control;
238 p_demux->info.i_update = 0;
239 p_demux->info.i_title = 0;
240 p_demux->info.i_seekpoint = 0;
242 p_demux->p_sys = p_sys = calloc(1, sizeof(demux_sys_t));
246 NSArray *myVideoDevices = [[[QTCaptureDevice inputDevicesWithMediaType:QTMediaTypeVideo] arrayByAddingObjectsFromArray:[QTCaptureDevice inputDevicesWithMediaType:QTMediaTypeMuxed]] retain];
247 if ([myVideoDevices count] == 0) {
248 dialog_FatalWait(p_demux, _("No Input device found"),
249 _("Your Mac does not seem to be equipped with a suitable input device. "
250 "Please check your connectors and drivers."));
251 msg_Err(p_demux, "Can't find any Video device");
256 NSUInteger deviceCount = [myVideoDevices count];
257 for (ivideo = 0; ivideo < deviceCount; ivideo++) {
258 QTCaptureDevice *qtk_device;
259 qtk_device = [myVideoDevices objectAtIndex:ivideo];
260 msg_Dbg(p_demux, "qtcapture %lu/%lu %s %s", ivideo, deviceCount, [[qtk_device localizedDisplayName] UTF8String], [[qtk_device uniqueID] UTF8String]);
261 if ([[[qtk_device uniqueID]stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]] isEqualToString:qtk_currdevice_uid]) {
266 memset(&p_sys->fmt, 0, sizeof(es_format_t));
268 QTCaptureDeviceInput * input = nil;
269 NSError *o_returnedError;
270 if (ivideo < [myVideoDevices count])
271 p_sys->device = [myVideoDevices objectAtIndex:ivideo];
273 /* cannot found designated device, fall back to open default device */
274 msg_Dbg(p_demux, "Cannot find designated uid device as %s, falling back to default.", [qtk_currdevice_uid UTF8String]);
275 p_sys->device = [QTCaptureDevice defaultInputDeviceWithMediaType: QTMediaTypeVideo];
277 if (!p_sys->device) {
278 dialog_FatalWait(p_demux, _("No Input device found"),
279 _("Your Mac does not seem to be equipped with a suitable input device. "
280 "Please check your connectors and drivers."));
281 msg_Err(p_demux, "Can't find any Video device");
286 if (![p_sys->device open: &o_returnedError]) {
287 msg_Err(p_demux, "Unable to open the capture device (%ld)", [o_returnedError code]);
291 if ([p_sys->device isInUseByAnotherApplication] == YES) {
292 msg_Err(p_demux, "default capture device is exclusively in use by another application");
296 input = [[QTCaptureDeviceInput alloc] initWithDevice: p_sys->device];
298 msg_Err(p_demux, "can't create a valid capture input facility");
302 p_sys->output = [[VLCDecompressedVideoOutput alloc] init];
304 /* Get the formats */
305 NSArray *format_array = [p_sys->device formatDescriptions];
306 QTFormatDescription* camera_format = NULL;
307 NSUInteger formatCount = [format_array count];
308 for (NSUInteger k = 0; k < formatCount; k++) {
309 camera_format = [format_array objectAtIndex:k];
311 msg_Dbg(p_demux, "localized Format: %s", [[camera_format localizedFormatSummary] UTF8String]);
312 msg_Dbg(p_demux, "format description: %s", [[[camera_format formatDescriptionAttributes] description] UTF8String]);
314 if ([format_array count])
315 camera_format = [format_array objectAtIndex:0];
319 int qtchroma = [camera_format formatType];
320 int chroma = VLC_CODEC_UYVY;
322 /* Now we can init */
323 es_format_Init(&p_sys->fmt, VIDEO_ES, chroma);
325 NSSize encoded_size = [[camera_format attributeForKey:QTFormatDescriptionVideoEncodedPixelsSizeAttribute] sizeValue];
326 NSSize display_size = [[camera_format attributeForKey:QTFormatDescriptionVideoCleanApertureDisplaySizeAttribute] sizeValue];
327 NSSize par_size = [[camera_format attributeForKey:QTFormatDescriptionVideoProductionApertureDisplaySizeAttribute] sizeValue];
329 par_size.width = display_size.width = encoded_size.width
330 = var_InheritInteger (p_this, "qtcapture-width");
331 par_size.height = display_size.height = encoded_size.height
332 = var_InheritInteger (p_this, "qtcapture-height");
334 p_sys->fmt.video.i_width = p_sys->width = encoded_size.width;
335 p_sys->fmt.video.i_height = p_sys->height = encoded_size.height;
336 p_sys->fmt.video.i_frame_rate = 25.0; // cave: check with setMinimumVideoFrameInterval (see below)
337 if (par_size.width != encoded_size.width) {
338 p_sys->fmt.video.i_sar_num = (int64_t)encoded_size.height * par_size.width / encoded_size.width;
339 p_sys->fmt.video.i_sar_den = encoded_size.width;
342 msg_Dbg(p_demux, "encoded_size %i %i", (int)encoded_size.width, (int)encoded_size.height);
343 msg_Dbg(p_demux, "display_size %i %i", (int)display_size.width, (int)display_size.height);
344 msg_Dbg(p_demux, "PAR size %i %i", (int)par_size.width, (int)par_size.height);
346 [p_sys->output setPixelBufferAttributes: [NSDictionary dictionaryWithObjectsAndKeys:
347 [NSNumber numberWithInt:kCVPixelFormatType_422YpCbCr8], (id)kCVPixelBufferPixelFormatTypeKey,
348 [NSNumber numberWithInt:p_sys->height], kCVPixelBufferHeightKey,
349 [NSNumber numberWithInt:p_sys->width], kCVPixelBufferWidthKey,
350 [NSNumber numberWithBool:YES], (id)kCVPixelBufferOpenGLCompatibilityKey,
352 [p_sys->output setAutomaticallyDropsLateVideoFrames:YES];
353 [p_sys->output setMinimumVideoFrameInterval: (1/25)]; // 25 fps
355 p_sys->session = [[QTCaptureSession alloc] init];
357 bool ret = [p_sys->session addInput:input error: &o_returnedError];
359 msg_Err(p_demux, "default video capture device could not be added to capture session (%ld)", [o_returnedError code]);
363 ret = [p_sys->session addOutput:p_sys->output error: &o_returnedError];
365 msg_Err(p_demux, "output could not be added to capture session (%ld)", [o_returnedError code]);
369 [p_sys->session startRunning];
374 msg_Dbg(p_demux, "QTCapture: We have a video device ready!");
386 /*****************************************************************************
388 *****************************************************************************/
389 static void Close(vlc_object_t *p_this)
391 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
393 demux_t *p_demux = (demux_t*)p_this;
394 demux_sys_t *p_sys = p_demux->p_sys;
396 /* Hack: if libvlc was killed, main interface thread was,
397 * and poor QTKit needs it, so don't tell him.
398 * Else we dead lock. */
399 if (vlc_object_alive(p_this->p_libvlc)) {
400 // Perform this on main thread, as the framework itself will sometimes try to synchronously
401 // work on main thread. And this will create a dead lock.
402 [p_sys->session performSelectorOnMainThread:@selector(stopRunning) withObject:nil waitUntilDone:NO];
403 [p_sys->output performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
404 [p_sys->session performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
412 /*****************************************************************************
414 *****************************************************************************/
415 static int Demux(demux_t *p_demux)
417 demux_sys_t *p_sys = p_demux->p_sys;
420 p_block = block_Alloc(p_sys->width * p_sys->height * 2 /* FIXME */);
422 msg_Err(p_demux, "cannot get block");
426 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
428 @synchronized (p_sys->output) {
429 p_block->i_pts = [p_sys->output copyCurrentFrameToBuffer: p_block->p_buffer];
432 if (!p_block->i_pts) {
433 /* Nothing to display yet, just forget */
434 block_Release(p_block);
438 } else if (!p_sys->b_es_setup) {
439 p_sys->fmt.video.i_frame_rate_base = [p_sys->output timeScale];
440 msg_Dbg(p_demux, "using frame rate base: %i", p_sys->fmt.video.i_frame_rate_base);
441 p_sys->p_es_video = es_out_Add(p_demux->out, &p_sys->fmt);
442 msg_Dbg(p_demux, "added new video es %4.4s %dx%d", (char*)&p_sys->fmt.i_codec, p_sys->fmt.video.i_width, p_sys->fmt.video.i_height);
443 p_sys->b_es_setup = YES;
446 es_out_Control(p_demux->out, ES_OUT_SET_PCR, p_block->i_pts);
447 es_out_Send(p_demux->out, p_sys->p_es_video, p_block);
453 /*****************************************************************************
455 *****************************************************************************/
456 static int Control(demux_t *p_demux, int i_query, va_list args)
463 /* Special for access_demux */
464 case DEMUX_CAN_PAUSE:
466 case DEMUX_SET_PAUSE_STATE:
467 case DEMUX_CAN_CONTROL_PACE:
468 pb = (bool*)va_arg(args, bool *);
472 case DEMUX_GET_PTS_DELAY:
473 pi64 = (int64_t*)va_arg(args, int64_t *);
474 *pi64 = INT64_C(1000) * var_InheritInteger(p_demux, "live-caching");
478 pi64 = (int64_t*)va_arg(args, int64_t *);