qtcapture.m 17.4 KB
Newer Older
1
/*****************************************************************************
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 * qtcapture.m: qtkit (Mac OS X) based capture module
 *****************************************************************************
 * Copyright © 2008-2011 VLC authors and VideoLAN
 *
 * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
 *
 ****************************************************************************
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
18
19
20
21
22
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
23
24

/*****************************************************************************
25
26
 * Preamble
 *****************************************************************************/
27
28
29
30
31

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc_common.h>
33
34
35
#include <vlc_plugin.h>
#include <vlc_input.h>
#include <vlc_demux.h>
36
#include <vlc_interface.h>
ivoire's avatar
ivoire committed
37
#include <vlc_dialog.h>
38
#include <vlc_access.h>
39
40

#import <QTKit/QTKit.h>
41
#import <CoreAudio/CoreAudio.h>
42

43
44
45
46
#define QTKIT_WIDTH_TEXT N_("Video Capture width")
#define QTKIT_WIDTH_LONGTEXT N_("Video Capture width in pixel")
#define QTKIT_HEIGHT_TEXT N_("Video Capture height")
#define QTKIT_HEIGHT_LONGTEXT N_("Video Capture height in pixel")
47

48
49
50
/*****************************************************************************
* Local prototypes
*****************************************************************************/
51
52
53
54
static int Open(vlc_object_t *p_this);
static void Close(vlc_object_t *p_this);
static int Demux(demux_t *p_demux);
static int Control(demux_t *, int, va_list);
55
56
57
58

/*****************************************************************************
* Module descriptor
*****************************************************************************/
59
vlc_module_begin ()
60
61
62
63
64
65
66
   set_shortname(N_("Quicktime Capture"))
   set_description(N_("Quicktime Capture"))
   set_category(CAT_INPUT)
   set_subcategory(SUBCAT_INPUT_ACCESS)
   add_shortcut("qtcapture")
   set_capability("access_demux", 10)
   set_callbacks(Open, Close)
67
68
69
70
   add_integer("qtcapture-width", 640, QTKIT_WIDTH_TEXT, QTKIT_WIDTH_LONGTEXT, true)
      change_integer_range (80, 1280)
   add_integer("qtcapture-height", 480, QTKIT_HEIGHT_TEXT, QTKIT_HEIGHT_LONGTEXT, true)
      change_integer_range (60, 480)
71
vlc_module_end ()
72
73
74
75
76
77
78


/*****************************************************************************
* QTKit Bridge
*****************************************************************************/
@interface VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
{
79
80
    CVImageBufferRef currentImageBuffer;
    mtime_t currentPts;
81
    mtime_t previousPts;
82
    long timeScale;
83
84
85
}
- (id)init;
- (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection;
86
- (mtime_t)copyCurrentFrameToBuffer:(void *)buffer;
87
88
89
90
@end

/* Apple sample code */
@implementation VLCDecompressedVideoOutput : QTCaptureDecompressedVideoOutput
91

92
93
- (id)init
{
94
    if (self = [super init]) {
95
96
        currentImageBuffer = nil;
        currentPts = 0;
97
        previousPts = 0;
98
        timeScale = 0;
99
100
    }
    return self;
101
}
102

103
104
- (void)dealloc
{
105
    @synchronized (self) {
106
107
108
109
        CVBufferRelease(currentImageBuffer);
        currentImageBuffer = nil;
    }
    [super dealloc];
110
111
}

112
113
114
115
116
- (long)timeScale
{
    return timeScale;
}

117
118
- (void)outputVideoFrame:(CVImageBufferRef)videoFrame withSampleBuffer:(QTSampleBuffer *)sampleBuffer fromConnection:(QTCaptureConnection *)connection
{
119
120
121
    // Store the latest frame
    // This must be done in a @synchronized block because this delegate method is not called on the main thread
    CVImageBufferRef imageBufferToRelease;
122

123
    CVBufferRetain(videoFrame);
124

125
    @synchronized (self) {
126
127
        imageBufferToRelease = currentImageBuffer;
        currentImageBuffer = videoFrame;
128
129
130
        QTTime timeStamp = [sampleBuffer presentationTime];
        timeScale = timeStamp.timeScale;
        currentPts = (mtime_t)(1000000L / timeScale * timeStamp.timeValue);
131

132
133
        /* Try to use hosttime of the sample if available, because iSight Pts seems broken */
        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
142
    CVImageBufferRef imageBuffer;
    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
153
154
            pts = previousPts = currentPts;
            CVPixelBufferLockBaseAddress(imageBuffer, 0);
            pixels = CVPixelBufferGetBaseAddress(imageBuffer);
155
156
            if (pixels)
                memcpy(buffer, pixels, CVPixelBufferGetBytesPerRow(imageBuffer) * CVPixelBufferGetHeight(imageBuffer));
157
158
            CVPixelBufferUnlockBaseAddress(imageBuffer, 0);
        }
159

160
    }
161
162
    CVBufferRelease(imageBuffer);

163
    if (pixels)
164
165
166
        return currentPts;
    else
        return 0;
167
168
169
170
}

@end

171
172
173
174
/*****************************************************************************
* Struct
*****************************************************************************/

175
struct demux_sys_t {
176
177
178
179
180
    QTCaptureSession * session;
    QTCaptureDevice * device;
    VLCDecompressedVideoOutput * output;
    int height, width;
    es_out_id_t * p_es_video;
181
182
    BOOL b_es_setup;
    es_format_t fmt;
183
184
185
};


186
187
188
/*****************************************************************************
* qtchroma_to_fourcc
*****************************************************************************/
189
static int qtchroma_to_fourcc(int i_qt)
190
{
hartman's avatar
hartman committed
191
    static const struct
192
193
194
195
196
197
    {
        unsigned int i_qt;
        int i_fourcc;
    } qtchroma_to_fourcc[] =
    {
        /* Raw data types */
198
199
200
        { '2vuy',    VLC_CODEC_UYVY },
        { 'yuv2',VLC_CODEC_YUYV },
        { 'yuvs', VLC_CODEC_YUYV },
201
202
        { 0, 0 }
    };
203
204
205

    for (int i = 0; qtchroma_to_fourcc[i].i_qt; i++) {
        if (qtchroma_to_fourcc[i].i_qt == i_qt)
206
207
208
209
210
211
212
213
            return qtchroma_to_fourcc[i].i_fourcc;
    }
    return 0;
}

/*****************************************************************************
* Open:
*****************************************************************************/
214
static int Open(vlc_object_t *p_this)
215
216
217
218
219
220
221
{
    demux_t     *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys = NULL;
    int i;
    int i_width;
    int i_height;
    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
229
    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
234
    NSString *qtk_currdevice_uid = [[NSString alloc] initWithFormat:@"%s", psz_uid];

235
236
237
238
239
240
    /* Set up p_demux */
    p_demux->pf_demux = Demux;
    p_demux->pf_control = Control;
    p_demux->info.i_update = 0;
    p_demux->info.i_title = 0;
    p_demux->info.i_seekpoint = 0;
241

242
243
    p_demux->p_sys = p_sys = calloc(1, sizeof(demux_sys_t));
    if (!p_sys)
ivoire's avatar
ivoire committed
244
        return VLC_ENOMEM;
245

246
    NSArray *myVideoDevices = [[[QTCaptureDevice inputDevicesWithMediaType:QTMediaTypeVideo] arrayByAddingObjectsFromArray:[QTCaptureDevice inputDevicesWithMediaType:QTMediaTypeMuxed]] retain];
247
248
    if ([myVideoDevices count] == 0) {
        dialog_FatalWait(p_demux, _("No Input device found"),
249
                         _("Your Mac does not seem to be equipped with a suitable input device. "
250
251
                           "Please check your connectors and drivers."));
        msg_Err(p_demux, "Can't find any Video device");
252
253
254

        goto error;
    }
Felix Paul Kühne's avatar
Felix Paul Kühne committed
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
261
        msg_Dbg(p_demux, "qtcapture %lu/%lu %s %s", ivideo, deviceCount, [[qtk_device localizedDisplayName] UTF8String], [[qtk_device uniqueID] UTF8String]);
        if ([[[qtk_device uniqueID]stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]] isEqualToString:qtk_currdevice_uid]) {
262
263
264
265
            break;
        }
    }

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
274
275
276
        /* cannot found designated device, fall back to open default device */
        msg_Dbg(p_demux, "Cannot find designated uid device as %s, falling back to default.", [qtk_currdevice_uid UTF8String]);
        p_sys->device = [QTCaptureDevice defaultInputDeviceWithMediaType: QTMediaTypeVideo];
    }
277
278
    if (!p_sys->device) {
        dialog_FatalWait(p_demux, _("No Input device found"),
279
                        _("Your Mac does not seem to be equipped with a suitable input device. "
280
281
                          "Please check your connectors and drivers."));
        msg_Err(p_demux, "Can't find any Video device");
282

283
284
285
        goto error;
    }

286
287
    if (![p_sys->device open: &o_returnedError]) {
        msg_Err(p_demux, "Unable to open the capture device (%ld)", [o_returnedError code]);
288
289
290
        goto error;
    }

291
292
    if ([p_sys->device isInUseByAnotherApplication] == YES) {
        msg_Err(p_demux, "default capture device is exclusively in use by another application");
293
294
295
        goto error;
    }

296
    input = [[QTCaptureDeviceInput alloc] initWithDevice: p_sys->device];
297
298
    if (!input) {
        msg_Err(p_demux, "can't create a valid capture input facility");
299
300
301
        goto error;
    }

302
    p_sys->output = [[VLCDecompressedVideoOutput alloc] init];
303

304
305
306
    /* Get the formats */
    NSArray *format_array = [p_sys->device formatDescriptions];
    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
312
        msg_Dbg(p_demux, "localized Format: %s", [[camera_format localizedFormatSummary] UTF8String]);
        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
317
    else
        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
326
327
328

    NSSize encoded_size = [[camera_format attributeForKey:QTFormatDescriptionVideoEncodedPixelsSizeAttribute] sizeValue];
    NSSize display_size = [[camera_format attributeForKey:QTFormatDescriptionVideoCleanApertureDisplaySizeAttribute] sizeValue];
    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");
333

334
335
336
    p_sys->fmt.video.i_width = p_sys->width = encoded_size.width;
    p_sys->fmt.video.i_height = p_sys->height = encoded_size.height;
    p_sys->fmt.video.i_frame_rate = 25.0; // cave: check with setMinimumVideoFrameInterval (see below)
337
    if (par_size.width != encoded_size.width) {
338
339
        p_sys->fmt.video.i_sar_num = (int64_t)encoded_size.height * par_size.width / encoded_size.width;
        p_sys->fmt.video.i_sar_den = encoded_size.width;
340
341
    }

342
343
344
    msg_Dbg(p_demux, "encoded_size %i %i", (int)encoded_size.width, (int)encoded_size.height);
    msg_Dbg(p_demux, "display_size %i %i", (int)display_size.width, (int)display_size.height);
    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
348
349
350
351
                                              [NSNumber numberWithInt:kCVPixelFormatType_422YpCbCr8], (id)kCVPixelBufferPixelFormatTypeKey,
                                              [NSNumber numberWithInt:p_sys->height], kCVPixelBufferHeightKey,
                                              [NSNumber numberWithInt:p_sys->width], kCVPixelBufferWidthKey,
                                              [NSNumber numberWithBool:YES], (id)kCVPixelBufferOpenGLCompatibilityKey,
                                              nil]];
352
353
    [p_sys->output setAutomaticallyDropsLateVideoFrames:YES];
    [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
359
    if (!ret) {
        msg_Err(p_demux, "default video capture device could not be added to capture session (%ld)", [o_returnedError code]);
360
361
362
        goto error;
    }

363
    ret = [p_sys->session addOutput:p_sys->output error: &o_returnedError];
364
365
    if (!ret) {
        msg_Err(p_demux, "output could not be added to capture session (%ld)", [o_returnedError code]);
366
367
368
        goto error;
    }

369
    [p_sys->session startRunning];
370
371
372
373

    [input release];
    [pool release];

374
    msg_Dbg(p_demux, "QTCapture: We have a video device ready!");
375
376
377
378
379
380

    return VLC_SUCCESS;
error:
    [input release];
    [pool release];

381
    free(p_sys);
382
383
384
385
386
387
388

    return VLC_EGENERIC;
}

/*****************************************************************************
* Close:
*****************************************************************************/
389
static void Close(vlc_object_t *p_this)
390
391
392
393
394
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    demux_t     *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys = p_demux->p_sys;
395

396
397
398
    /* Hack: if libvlc was killed, main interface thread was,
     * and poor QTKit needs it, so don't tell him.
     * Else we dead lock. */
399
    if (vlc_object_alive(p_this->p_libvlc)) {
400
401
402
403
404
        // Perform this on main thread, as the framework itself will sometimes try to synchronously
        // work on main thread. And this will create a dead lock.
        [p_sys->session performSelectorOnMainThread:@selector(stopRunning) withObject:nil waitUntilDone:NO];
        [p_sys->output performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
        [p_sys->session performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
405
    }
406
    free(p_sys);
407
408
409
410
411
412
413
414

    [pool release];
}


/*****************************************************************************
* Demux:
*****************************************************************************/
415
static int Demux(demux_t *p_demux)
416
417
418
419
{
    demux_sys_t *p_sys = p_demux->p_sys;
    block_t *p_block;

420
    p_block = block_Alloc(p_sys->width * p_sys->height * 2 /* FIXME */);
421
422
    if (!p_block) {
        msg_Err(p_demux, "cannot get block");
423
424
425
        return 0;
    }

426
427
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

428
429
    @synchronized (p_sys->output) {
        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
441
442
        msg_Dbg(p_demux, "using frame rate base: %i", p_sys->fmt.video.i_frame_rate_base);
        p_sys->p_es_video = es_out_Add(p_demux->out, &p_sys->fmt);
        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
444
        p_sys->b_es_setup = YES;
    }
445

446
447
    es_out_Control(p_demux->out, ES_OUT_SET_PCR, p_block->i_pts);
    es_out_Send(p_demux->out, p_sys->p_es_video, p_block);
448
449
450
451
452
453
454
455

    [pool release];
    return 1;
}

/*****************************************************************************
* Control:
*****************************************************************************/
456
static int Control(demux_t *p_demux, int i_query, va_list args)
457
458
459
460
{
    bool *pb;
    int64_t    *pi64;

461
    switch(i_query)
462
463
464
465
466
467
    {
        /* Special for access_demux */
        case DEMUX_CAN_PAUSE:
        case DEMUX_CAN_SEEK:
        case DEMUX_SET_PAUSE_STATE:
        case DEMUX_CAN_CONTROL_PACE:
468
           pb = (bool*)va_arg(args, bool *);
469
470
471
472
           *pb = false;
           return VLC_SUCCESS;

        case DEMUX_GET_PTS_DELAY:
473
474
           pi64 = (int64_t*)va_arg(args, int64_t *);
           *pi64 = INT64_C(1000) * var_InheritInteger(p_demux, "live-caching");
475
476
           return VLC_SUCCESS;

477
        case DEMUX_GET_TIME:
478
            pi64 = (int64_t*)va_arg(args, int64_t *);
479
480
481
            *pi64 = mdate();
            return VLC_SUCCESS;

482
483
484
485
486
        default:
           return VLC_EGENERIC;
    }
    return VLC_EGENERIC;
}