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

   1 /*****************************************************************************
   2 * qtcapture.m: qtkit (Mac OS X) based capture module
   3 *****************************************************************************
   4 * Copyright (C) 2008-2011 the VideoLAN team
   5 *
   6 * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
   7 *
   8 *****************************************************************************
   9 * This library is free software; you can redistribute it and/or
  10 * modify it under the terms of the GNU Lesser General Public
  11 * License as published by the Free Software Foundation;
  12 * version 2 of the License.
  13 *
  14 * This library 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 GNU
  17 * Lesser General Public License for more details.
  18 *
  19 * You should have received a copy of the GNU Lesser General Public
  20 * License along with this library; if not, write to the Free Software
  21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22 *
  23 *****************************************************************************/
  24
  25 /*****************************************************************************
  26 * Preamble
  27 *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_input.h>
  36 #include <vlc_demux.h>
  37 #include <vlc_interface.h>
  38 #include <vlc_dialog.h>
  39 #include <vlc_access.h>
  40
  41 #import <QTKit/QTKit.h>
  42 #import <CoreAudio/CoreAudio.h>
  43
  44 #define QTKIT_WIDTH_TEXT N_("Video Capture width")
  45 #define QTKIT_WIDTH_LONGTEXT N_("Video Capture width in pixel")
  46 #define QTKIT_HEIGHT_TEXT N_("Video Capture height")
  47 #define QTKIT_HEIGHT_LONGTEXT N_("Video Capture height in pixel")
  48
  49 /*****************************************************************************
  50 * Local prototypes
  51 *****************************************************************************/
  52 static int Open( vlc_object_t *p_this );
  53 static void Close( vlc_object_t *p_this );
  54 static int Demux( demux_t *p_demux );
  55 static int Control( demux_t *, int, va_list );
  56
  57 /*****************************************************************************
  58 * Module descriptor
  59 *****************************************************************************/
  60 vlc_module_begin ()
  61    set_shortname( N_("Quicktime Capture") )
  62    set_description( N_("Quicktime Capture") )
  63    set_category( CAT_INPUT )
  64    set_subcategory( SUBCAT_INPUT_ACCESS )
  65    add_shortcut( "qtcapture" )
  66    set_capability( "access_demux", 10 )
  67    set_callbacks( Open, Close )
  68    add_integer("qtcapture-width", 640, QTKIT_WIDTH_TEXT, QTKIT_WIDTH_LONGTEXT, true)
  69       change_integer_range (80, 1280)
  70    add_integer("qtcapture-height", 480, QTKIT_HEIGHT_TEXT, QTKIT_HEIGHT_LONGTEXT, true)
  71       change_integer_range (60, 480)
  72 vlc_module_end ()
  73
  74
  75 /*****************************************************************************
  76 * QTKit Bridge
  77 *****************************************************************************/
  78 @interface VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
  79 {
  80     CVImageBufferRef currentImageBuffer;
  81     mtime_t currentPts;
  82     mtime_t previousPts;
  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 - (id)init
  92 {
  93     if( self = [super init] )
  94     {
  95         currentImageBuffer = nil;
  96         currentPts = 0;
  97         previousPts = 0;
  98     }
  99     return self;
 100 }
 101 - (void)dealloc
 102 {
 103     @synchronized (self)
 104     {
 105         CVBufferRelease(currentImageBuffer);
 106         currentImageBuffer = nil;
 107     }
 108     [super dealloc];
 109 }
 110
 111 - (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection
 112 {
 113     // Store the latest frame
 114     // This must be done in a @synchronized block because this delegate method is not called on the main thread
 115     CVImageBufferRef imageBufferToRelease;
 116
 117     CVBufferRetain(videoFrame);
 118
 119     @synchronized (self)
 120     {
 121         imageBufferToRelease = currentImageBuffer;
 122         currentImageBuffer = videoFrame;
 123         currentPts = (mtime_t)(1000000L / [sampleBuffer presentationTime].timeScale * [sampleBuffer presentationTime].timeValue);
 124
 125         /* Try to use hosttime of the sample if available, because iSight Pts seems broken */
 126         NSNumber *hosttime = (NSNumber *)[sampleBuffer attributeForKey:QTSampleBufferHostTimeAttribute];
 127         if( hosttime ) currentPts = (mtime_t)AudioConvertHostTimeToNanos([hosttime unsignedLongLongValue])/1000;
 128     }
 129     CVBufferRelease(imageBufferToRelease);
 130 }
 131
 132 - (mtime_t)copyCurrentFrameToBuffer:(void *)buffer
 133 {
 134     CVImageBufferRef imageBuffer;
 135     mtime_t pts;
 136         void * pixels;
 137
 138     if(!currentImageBuffer || currentPts == previousPts )
 139         return 0;
 140
 141     @synchronized (self)
 142     {
 143         imageBuffer = CVBufferRetain(currentImageBuffer);
 144         if(imageBuffer){
 145             pts = previousPts = currentPts;
 146             CVPixelBufferLockBaseAddress(imageBuffer, 0);
 147             pixels = CVPixelBufferGetBaseAddress(imageBuffer);
 148             if(pixels)
 149                 memcpy( buffer, pixels, CVPixelBufferGetBytesPerRow(imageBuffer) * CVPixelBufferGetHeight(imageBuffer));
 150             CVPixelBufferUnlockBaseAddress(imageBuffer, 0);
 151         }
 152
 153     }
 154     CVBufferRelease(imageBuffer);
 155
 156         if(pixels)
 157                 return currentPts;
 158         else
 159                 return 0;
 160 }
 161
 162 @end
 163
 164 /*****************************************************************************
 165 * Struct
 166 *****************************************************************************/
 167
 168 struct demux_sys_t {
 169     QTCaptureSession * session;
 170     QTCaptureDevice * device;
 171     VLCDecompressedVideoOutput * output;
 172     int height, width;
 173     es_out_id_t * p_es_video;
 174 };
 175
 176
 177 /*****************************************************************************
 178 * qtchroma_to_fourcc
 179 *****************************************************************************/
 180 static int qtchroma_to_fourcc( int i_qt )
 181 {
 182     static const struct
 183     {
 184         unsigned int i_qt;
 185         int i_fourcc;
 186     } qtchroma_to_fourcc[] =
 187     {
 188         /* Raw data types */
 189         { '2vuy',    VLC_CODEC_UYVY },
 190         { 'yuv2',VLC_CODEC_YUYV },
 191         { 'yuvs', VLC_CODEC_YUYV },
 192         { 0, 0 }
 193     };
 194     int i;
 195     for( i = 0; qtchroma_to_fourcc[i].i_qt; i++ )
 196     {
 197         if( qtchroma_to_fourcc[i].i_qt == i_qt )
 198             return qtchroma_to_fourcc[i].i_fourcc;
 199     }
 200     return 0;
 201 }
 202
 203 /*****************************************************************************
 204 * Open:
 205 *****************************************************************************/
 206 static int Open( vlc_object_t *p_this )
 207 {
 208     demux_t     *p_demux = (demux_t*)p_this;
 209     demux_sys_t *p_sys = NULL;
 210     es_format_t fmt;
 211     int i;
 212     int i_width;
 213     int i_height;
 214     int result = 0;
 215     char *psz_uid = NULL;
 216
 217     /* Only when selected */
 218     if( *p_demux->psz_access == '\0' )
 219         return VLC_EGENERIC;
 220
 221     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
 222
 223     if( p_demux->psz_location && *p_demux->psz_location )
 224         psz_uid = strdup(p_demux->psz_location);
 225     msg_Dbg( p_demux, "qtcapture uid = %s", psz_uid );
 226     NSString *qtk_currdevice_uid = [[NSString alloc] initWithFormat:@"%s", psz_uid];
 227
 228     /* Set up p_demux */
 229     p_demux->pf_demux = Demux;
 230     p_demux->pf_control = Control;
 231     p_demux->info.i_update = 0;
 232     p_demux->info.i_title = 0;
 233     p_demux->info.i_seekpoint = 0;
 234
 235     p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
 236     if( !p_sys )
 237         return VLC_ENOMEM;
 238
 239     NSArray *myVideoDevices = [[[QTCaptureDevice inputDevicesWithMediaType:QTMediaTypeVideo] arrayByAddingObjectsFromArray:[QTCaptureDevice inputDevicesWithMediaType:QTMediaTypeMuxed]] retain];
 240     if([myVideoDevices count] == 0)
 241     {
 242         dialog_FatalWait( p_demux, _("No Input device found"),
 243                          _("Your Mac does not seem to be equipped with a suitable input device. "
 244                            "Please check your connectors and drivers.") );
 245         msg_Err( p_demux, "Can't find any Video device" );
 246
 247         goto error;
 248     }
 249     NSUInteger ivideo;
 250     NSUInteger deviceCount = [myVideoDevices count];
 251     for(ivideo = 0; ivideo < deviceCount; ivideo++){
 252         QTCaptureDevice *qtk_device;
 253         qtk_device = [myVideoDevices objectAtIndex:ivideo];
 254         msg_Dbg( p_demux, "qtcapture %lu/%lu %s %s", ivideo, deviceCount, [[qtk_device localizedDisplayName] UTF8String], [[qtk_device uniqueID] UTF8String]);
 255         if([[[qtk_device uniqueID]stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]] isEqualToString:qtk_currdevice_uid]){
 256             break;
 257         }
 258     }
 259
 260     memset( &fmt, 0, sizeof( es_format_t ) );
 261
 262     QTCaptureDeviceInput * input = nil;
 263     NSError *o_returnedError;
 264     if( ivideo < [myVideoDevices count] )
 265         p_sys->device = [myVideoDevices objectAtIndex:ivideo];
 266     else
 267     {
 268         /* cannot found designated device, fall back to open default device */
 269         msg_Dbg(p_demux, "Cannot find designated uid device as %s, falling back to default.", [qtk_currdevice_uid UTF8String]);
 270         p_sys->device = [QTCaptureDevice defaultInputDeviceWithMediaType: QTMediaTypeVideo];
 271     }
 272     if( !p_sys->device )
 273     {
 274         dialog_FatalWait( p_demux, _("No Input device found"),
 275                         _("Your Mac does not seem to be equipped with a suitable input device. "
 276                           "Please check your connectors and drivers.") );
 277         msg_Err( p_demux, "Can't find any Video device" );
 278
 279         goto error;
 280     }
 281
 282     if( ![p_sys->device open: &o_returnedError] )
 283     {
 284         msg_Err( p_demux, "Unable to open the capture device (%ld)", [o_returnedError code] );
 285         goto error;
 286     }
 287
 288     if( [p_sys->device isInUseByAnotherApplication] == YES )
 289     {
 290         msg_Err( p_demux, "default capture device is exclusively in use by another application" );
 291         goto error;
 292     }
 293
 294     input = [[QTCaptureDeviceInput alloc] initWithDevice: p_sys->device];
 295     if( !input )
 296     {
 297         msg_Err( p_demux, "can't create a valid capture input facility" );
 298         goto error;
 299     }
 300
 301     p_sys->output = [[VLCDecompressedVideoOutput alloc] init];
 302
 303     /* Get the formats */
 304     NSArray *format_array = [p_sys->device formatDescriptions];
 305     QTFormatDescription* camera_format = NULL;
 306     NSUInteger formatCount = [format_array count];
 307     for( NSUInteger k = 0; k < formatCount; k++ )
 308     {
 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 goto error;
 317
 318     int qtchroma = [camera_format formatType];
 319     int chroma = VLC_CODEC_UYVY;
 320
 321     /* Now we can init */
 322     es_format_Init( &fmt, VIDEO_ES, chroma );
 323
 324     NSSize encoded_size = [[camera_format attributeForKey:QTFormatDescriptionVideoEncodedPixelsSizeAttribute] sizeValue];
 325     NSSize display_size = [[camera_format attributeForKey:QTFormatDescriptionVideoCleanApertureDisplaySizeAttribute] sizeValue];
 326     NSSize par_size = [[camera_format attributeForKey:QTFormatDescriptionVideoProductionApertureDisplaySizeAttribute] sizeValue];
 327
 328     par_size.width = display_size.width = encoded_size.width
 329         = var_InheritInteger (p_this, "qtcapture-width");
 330     par_size.height = display_size.height = encoded_size.height
 331         = var_InheritInteger (p_this, "qtcapture-height");
 332
 333     fmt.video.i_width = p_sys->width = encoded_size.width;
 334     fmt.video.i_height = p_sys->height = encoded_size.height;
 335     if( par_size.width != encoded_size.width )
 336     {
 337         fmt.video.i_sar_num = (int64_t)encoded_size.height * par_size.width / encoded_size.width;
 338         fmt.video.i_sar_den = encoded_size.width;
 339     }
 340
 341     msg_Dbg(p_demux, "encoded_size %i %i", (int)encoded_size.width, (int)encoded_size.height );
 342     msg_Dbg(p_demux, "display_size %i %i", (int)display_size.width, (int)display_size.height );
 343     msg_Dbg(p_demux, "PAR size %i %i", (int)par_size.width, (int)par_size.height );
 344
 345     [p_sys->output setPixelBufferAttributes: [NSDictionary dictionaryWithObjectsAndKeys:
 346         [NSNumber numberWithUnsignedInt:kCVPixelFormatType_422YpCbCr8], (id)kCVPixelBufferPixelFormatTypeKey,
 347         [NSNumber numberWithInt: p_sys->height], kCVPixelBufferHeightKey,
 348         [NSNumber numberWithInt: p_sys->width], kCVPixelBufferWidthKey,
 349         [NSNumber numberWithBool:YES], (id)kCVPixelBufferOpenGLCompatibilityKey,
 350         nil]];
 351
 352     p_sys->session = [[QTCaptureSession alloc] init];
 353
 354     bool ret = [p_sys->session addInput:input error: &o_returnedError];
 355     if( !ret )
 356     {
 357         msg_Err( p_demux, "default video capture device could not be added to capture session (%ld)", [o_returnedError code] );
 358         goto error;
 359     }
 360
 361     ret = [p_sys->session addOutput:p_sys->output error: &o_returnedError];
 362     if( !ret )
 363     {
 364         msg_Err( p_demux, "output could not be added to capture session (%ld)", [o_returnedError code] );
 365         goto error;
 366     }
 367
 368     [p_sys->session startRunning];
 369
 370     msg_Dbg( p_demux, "added new video es %4.4s %dx%d",
 371             (char*)&fmt.i_codec, fmt.video.i_width, fmt.video.i_height );
 372
 373     p_sys->p_es_video = es_out_Add( p_demux->out, &fmt );
 374
 375     [input release];
 376     [pool release];
 377
 378     msg_Dbg( p_demux, "QTCapture: We have a video device ready!" );
 379
 380     return VLC_SUCCESS;
 381 error:
 382     [input release];
 383     [pool release];
 384
 385     free( p_sys );
 386
 387     return VLC_EGENERIC;
 388 }
 389
 390 /*****************************************************************************
 391 * Close:
 392 *****************************************************************************/
 393 static void Close( vlc_object_t *p_this )
 394 {
 395     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
 396
 397     demux_t     *p_demux = (demux_t*)p_this;
 398     demux_sys_t *p_sys = p_demux->p_sys;
 399
 400     /* Hack: if libvlc was killed, main interface thread was,
 401      * and poor QTKit needs it, so don't tell him.
 402      * Else we dead lock. */
 403     if( vlc_object_alive(p_this->p_libvlc))
 404     {
 405         // Perform this on main thread, as the framework itself will sometimes try to synchronously
 406         // work on main thread. And this will create a dead lock.
 407         [p_sys->session performSelectorOnMainThread:@selector(stopRunning) withObject:nil waitUntilDone:NO];
 408         [p_sys->output performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
 409         [p_sys->session performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
 410     }
 411     free( p_sys );
 412
 413     [pool release];
 414 }
 415
 416
 417 /*****************************************************************************
 418 * Demux:
 419 *****************************************************************************/
 420 static int Demux( demux_t *p_demux )
 421 {
 422     demux_sys_t *p_sys = p_demux->p_sys;
 423     block_t *p_block;
 424
 425     p_block = block_New( p_demux, p_sys->width *
 426                             p_sys->height * 2 /* FIXME */ );
 427     if( !p_block )
 428     {
 429         msg_Err( p_demux, "cannot get block" );
 430         return 0;
 431     }
 432
 433     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
 434
 435     @synchronized (p_sys->output)
 436     {
 437     p_block->i_pts = [p_sys->output copyCurrentFrameToBuffer: p_block->p_buffer];
 438     }
 439
 440     if( !p_block->i_pts )
 441     {
 442         /* Nothing to display yet, just forget */
 443         block_Release( p_block );
 444         [pool release];
 445         msleep( 10000 );
 446         return 1;
 447     }
 448
 449     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
 450     es_out_Send( p_demux->out, p_sys->p_es_video, p_block );
 451
 452     [pool release];
 453     return 1;
 454 }
 455
 456 /*****************************************************************************
 457 * Control:
 458 *****************************************************************************/
 459 static int Control( demux_t *p_demux, int i_query, va_list args )
 460 {
 461     bool *pb;
 462     int64_t    *pi64;
 463
 464     switch( i_query )
 465     {
 466         /* Special for access_demux */
 467         case DEMUX_CAN_PAUSE:
 468         case DEMUX_CAN_SEEK:
 469         case DEMUX_SET_PAUSE_STATE:
 470         case DEMUX_CAN_CONTROL_PACE:
 471            pb = (bool*)va_arg( args, bool * );
 472            *pb = false;
 473            return VLC_SUCCESS;
 474
 475         case DEMUX_GET_PTS_DELAY:
 476            pi64 = (int64_t*)va_arg( args, int64_t * );
 477            *pi64 = (int64_t)DEFAULT_PTS_DELAY;
 478            return VLC_SUCCESS;
 479
 480         default:
 481            return VLC_EGENERIC;
 482     }
 483     return VLC_EGENERIC;
 484 }