git.sesse.net Git - vlc/blob - modules/access/qtcapture.m

   1 /*****************************************************************************
   2  * qtcapture.m: qtkit (Mac OS X) based capture module
   3  *****************************************************************************
   4  * Copyright © 2008-2011 VLC authors and VideoLAN
   5  *
   6  * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
   7  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  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>
  39
  40 #import <QTKit/QTKit.h>
  41 #import <CoreAudio/CoreAudio.h>
  42
  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")
  47
  48 /*****************************************************************************
  49 * Local prototypes
  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);
  55
  56 /*****************************************************************************
  57 * Module descriptor
  58 *****************************************************************************/
  59 vlc_module_begin ()
  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)
  71 vlc_module_end ()
  72
  73
  74 /*****************************************************************************
  75 * QTKit Bridge
  76 *****************************************************************************/
  77 @interface VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
  78 {
  79     CVImageBufferRef currentImageBuffer;
  80     mtime_t currentPts;
  81     mtime_t previousPts;
  82     long timeScale;
  83 }
  84 - (id)init;
  85 - (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection;
  86 - (mtime_t)copyCurrentFrameToBuffer:(void *)buffer;
  87 @end
  88
  89 /* Apple sample code */
  90 @implementation VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
  91
  92 - (id)init
  93 {
  94     if (self = [super init]) {
  95         currentImageBuffer = nil;
  96         currentPts = 0;
  97         previousPts = 0;
  98         timeScale = 0;
  99     }
 100     return self;
 101 }
 102
 103 - (void)dealloc
 104 {
 105     @synchronized (self) {
 106         CVBufferRelease(currentImageBuffer);
 107         currentImageBuffer = nil;
 108     }
 109     [super dealloc];
 110 }
 111
 112 - (long)timeScale
 113 {
 114     return timeScale;
 115 }
 116
 117 - (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection
 118 {
 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;
 122
 123     CVBufferRetain(videoFrame);
 124
 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);
 131
 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;
 135     }
 136     CVBufferRelease(imageBufferToRelease);
 137 }
 138
 139 - (mtime_t)copyCurrentFrameToBuffer:(void *)buffer
 140 {
 141     CVImageBufferRef imageBuffer;
 142     mtime_t pts;
 143
 144 void * pixels;
 145
 146     if (!currentImageBuffer || currentPts == previousPts)
 147         return 0;
 148
 149     @synchronized (self) {
 150         imageBuffer = CVBufferRetain(currentImageBuffer);
 151         if (imageBuffer) {
 152             pts = previousPts = currentPts;
 153             CVPixelBufferLockBaseAddress(imageBuffer, 0);
 154             pixels = CVPixelBufferGetBaseAddress(imageBuffer);
 155             if (pixels)
 156                 memcpy(buffer, pixels, CVPixelBufferGetBytesPerRow(imageBuffer) * CVPixelBufferGetHeight(imageBuffer));
 157             CVPixelBufferUnlockBaseAddress(imageBuffer, 0);
 158         }
 159
 160     }
 161     CVBufferRelease(imageBuffer);
 162
 163     if (pixels)
 164         return currentPts;
 165     else
 166         return 0;
 167 }
 168
 169 @end
 170
 171 /*****************************************************************************
 172 * Struct
 173 *****************************************************************************/
 174
 175 struct demux_sys_t {
 176     QTCaptureSession * session;
 177     QTCaptureDevice * device;
 178     VLCDecompressedVideoOutput * output;
 179     int height, width;
 180     es_out_id_t * p_es_video;
 181     BOOL b_es_setup;
 182     es_format_t fmt;
 183 };
 184
 185
 186 /*****************************************************************************
 187 * qtchroma_to_fourcc
 188 *****************************************************************************/
 189 static int qtchroma_to_fourcc(int i_qt)
 190 {
 191     static const struct
 192     {
 193         unsigned int i_qt;
 194         int i_fourcc;
 195     } qtchroma_to_fourcc[] =
 196     {
 197         /* Raw data types */
 198         { '2vuy',    VLC_CODEC_UYVY },
 199         { 'yuv2',VLC_CODEC_YUYV },
 200         { 'yuvs', VLC_CODEC_YUYV },
 201         { 0, 0 }
 202     };
 203
 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;
 207     }
 208     return 0;
 209 }
 210
 211 /*****************************************************************************
 212 * Open:
 213 *****************************************************************************/
 214 static int Open(vlc_object_t *p_this)
 215 {
 216     demux_t     *p_demux = (demux_t*)p_this;
 217     demux_sys_t *p_sys = NULL;
 218     int i;
 219     int i_width;
 220     int i_height;
 221     int result = 0;
 222     char *psz_uid = NULL;
 223
 224     /* Only when selected */
 225     if (*p_demux->psz_access == '\0')
 226         return VLC_EGENERIC;
 227
 228     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
 229
 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];
 234
 235     /* Set up p_demux */
 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;
 241
 242     p_demux->p_sys = p_sys = calloc(1, sizeof(demux_sys_t));
 243     if (!p_sys)
 244         return VLC_ENOMEM;
 245
 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");
 252
 253         goto error;
 254     }
 255     NSUInteger ivideo;
 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]) {
 262             break;
 263         }
 264     }
 265
 266     memset(&p_sys->fmt, 0, sizeof(es_format_t));
 267
 268     QTCaptureDeviceInput * input = nil;
 269     NSError *o_returnedError;
 270     if (ivideo < [myVideoDevices count])
 271         p_sys->device = [myVideoDevices objectAtIndex:ivideo];
 272     else {
 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];
 276     }
 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");
 282
 283         goto error;
 284     }
 285
 286     if (![p_sys->device open: &o_returnedError]) {
 287         msg_Err(p_demux, "Unable to open the capture device (%ld)", [o_returnedError code]);
 288         goto error;
 289     }
 290
 291     if ([p_sys->device isInUseByAnotherApplication] == YES) {
 292         msg_Err(p_demux, "default capture device is exclusively in use by another application");
 293         goto error;
 294     }
 295
 296     input = [[QTCaptureDeviceInput alloc] initWithDevice: p_sys->device];
 297     if (!input) {
 298         msg_Err(p_demux, "can't create a valid capture input facility");
 299         goto error;
 300     }
 301
 302     p_sys->output = [[VLCDecompressedVideoOutput alloc] init];
 303
 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];
 310
 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]);
 313     }
 314     if ([format_array count])
 315         camera_format = [format_array objectAtIndex: 0];
 316     else
 317         goto error;
 318
 319     int qtchroma = [camera_format formatType];
 320     int chroma = VLC_CODEC_UYVY;
 321
 322     /* Now we can init */
 323     es_format_Init(&p_sys->fmt, VIDEO_ES, chroma);
 324
 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];
 328
 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");
 333
 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;
 340     }
 341
 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);
 345
 346     [p_sys->output setPixelBufferAttributes: [NSDictionary dictionaryWithObjectsAndKeys:
 347         [NSNumber numberWithUnsignedInt:kCVPixelFormatType_422YpCbCr8], (id)kCVPixelBufferPixelFormatTypeKey,
 348         [NSNumber numberWithInt: p_sys->height], kCVPixelBufferHeightKey,
 349         [NSNumber numberWithInt: p_sys->width], kCVPixelBufferWidthKey,
 350         [NSNumber numberWithBool:YES], (id)kCVPixelBufferOpenGLCompatibilityKey,
 351         nil]];
 352     [p_sys->output setAutomaticallyDropsLateVideoFrames:YES];
 353     [p_sys->output setMinimumVideoFrameInterval: (1/25)]; // 25 fps
 354
 355     p_sys->session = [[QTCaptureSession alloc] init];
 356
 357     bool ret = [p_sys->session addInput:input error: &o_returnedError];
 358     if (!ret) {
 359         msg_Err(p_demux, "default video capture device could not be added to capture session (%ld)", [o_returnedError code]);
 360         goto error;
 361     }
 362
 363     ret = [p_sys->session addOutput:p_sys->output error: &o_returnedError];
 364     if (!ret) {
 365         msg_Err(p_demux, "output could not be added to capture session (%ld)", [o_returnedError code]);
 366         goto error;
 367     }
 368
 369     [p_sys->session startRunning];
 370
 371     [input release];
 372     [pool release];
 373
 374     msg_Dbg(p_demux, "QTCapture: We have a video device ready!");
 375
 376     return VLC_SUCCESS;
 377 error:
 378     [input release];
 379     [pool release];
 380
 381     free(p_sys);
 382
 383     return VLC_EGENERIC;
 384 }
 385
 386 /*****************************************************************************
 387 * Close:
 388 *****************************************************************************/
 389 static void Close(vlc_object_t *p_this)
 390 {
 391     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
 392
 393     demux_t     *p_demux = (demux_t*)p_this;
 394     demux_sys_t *p_sys = p_demux->p_sys;
 395
 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];
 405     }
 406     free(p_sys);
 407
 408     [pool release];
 409 }
 410
 411
 412 /*****************************************************************************
 413 * Demux:
 414 *****************************************************************************/
 415 static int Demux(demux_t *p_demux)
 416 {
 417     demux_sys_t *p_sys = p_demux->p_sys;
 418     block_t *p_block;
 419
 420     p_block = block_Alloc(p_sys->width * p_sys->height * 2 /* FIXME */);
 421     if (!p_block) {
 422         msg_Err(p_demux, "cannot get block");
 423         return 0;
 424     }
 425
 426     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
 427
 428     @synchronized (p_sys->output) {
 429         p_block->i_pts = [p_sys->output copyCurrentFrameToBuffer: p_block->p_buffer];
 430     }
 431
 432     if (!p_block->i_pts) {
 433         /* Nothing to display yet, just forget */
 434         block_Release(p_block);
 435         [pool release];
 436         msleep(10000);
 437         return 1;
 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;
 444     }
 445
 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);
 448
 449     [pool release];
 450     return 1;
 451 }
 452
 453 /*****************************************************************************
 454 * Control:
 455 *****************************************************************************/
 456 static int Control(demux_t *p_demux, int i_query, va_list args)
 457 {
 458     bool *pb;
 459     int64_t    *pi64;
 460
 461     switch(i_query)
 462     {
 463         /* Special for access_demux */
 464         case DEMUX_CAN_PAUSE:
 465         case DEMUX_CAN_SEEK:
 466         case DEMUX_SET_PAUSE_STATE:
 467         case DEMUX_CAN_CONTROL_PACE:
 468            pb = (bool*)va_arg(args, bool *);
 469            *pb = false;
 470            return VLC_SUCCESS;
 471
 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");
 475            return VLC_SUCCESS;
 476
 477         case DEMUX_GET_TIME:
 478             pi64 = (int64_t*)va_arg(args, int64_t *);
 479             *pi64 = mdate();
 480             return VLC_SUCCESS;
 481
 482         default:
 483            return VLC_EGENERIC;
 484     }
 485     return VLC_EGENERIC;
 486 }