lavd/avfoundation: Split adding a device and getting the device configuration into...
[ffmpeg.git] / libavdevice / avfoundation.m
1 /*
2  * AVFoundation input device
3  * Copyright (c) 2014 Thilo Borgmann <thilo.borgmann@mail.de>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * AVFoundation input device
25  * @author Thilo Borgmann <thilo.borgmann@mail.de>
26  */
27
28 #import <AVFoundation/AVFoundation.h>
29 #include <pthread.h>
30
31 #include "libavutil/pixdesc.h"
32 #include "libavutil/opt.h"
33 #include "libavformat/internal.h"
34 #include "libavutil/internal.h"
35 #include "libavutil/time.h"
36 #include "avdevice.h"
37
38 static const int avf_time_base = 100;
39
40 static const AVRational avf_time_base_q = {
41     .num = 1,
42     .den = avf_time_base
43 };
44
45 struct AVFPixelFormatSpec {
46     enum AVPixelFormat ff_id;
47     OSType avf_id;
48 };
49
50 static const struct AVFPixelFormatSpec avf_pixel_formats[] = {
51     { AV_PIX_FMT_MONOBLACK,    kCVPixelFormatType_1Monochrome },
52     { AV_PIX_FMT_RGB555BE,     kCVPixelFormatType_16BE555 },
53     { AV_PIX_FMT_RGB555LE,     kCVPixelFormatType_16LE555 },
54     { AV_PIX_FMT_RGB565BE,     kCVPixelFormatType_16BE565 },
55     { AV_PIX_FMT_RGB565LE,     kCVPixelFormatType_16LE565 },
56     { AV_PIX_FMT_RGB24,        kCVPixelFormatType_24RGB },
57     { AV_PIX_FMT_BGR24,        kCVPixelFormatType_24BGR },
58     { AV_PIX_FMT_0RGB,         kCVPixelFormatType_32ARGB },
59     { AV_PIX_FMT_BGR0,         kCVPixelFormatType_32BGRA },
60     { AV_PIX_FMT_0BGR,         kCVPixelFormatType_32ABGR },
61     { AV_PIX_FMT_RGB0,         kCVPixelFormatType_32RGBA },
62     { AV_PIX_FMT_BGR48BE,      kCVPixelFormatType_48RGB },
63     { AV_PIX_FMT_UYVY422,      kCVPixelFormatType_422YpCbCr8 },
64     { AV_PIX_FMT_YUVA444P,     kCVPixelFormatType_4444YpCbCrA8R },
65     { AV_PIX_FMT_YUVA444P16LE, kCVPixelFormatType_4444AYpCbCr16 },
66     { AV_PIX_FMT_YUV444P,      kCVPixelFormatType_444YpCbCr8 },
67     { AV_PIX_FMT_YUV422P16,    kCVPixelFormatType_422YpCbCr16 },
68     { AV_PIX_FMT_YUV422P10,    kCVPixelFormatType_422YpCbCr10 },
69     { AV_PIX_FMT_YUV444P10,    kCVPixelFormatType_444YpCbCr10 },
70     { AV_PIX_FMT_YUV420P,      kCVPixelFormatType_420YpCbCr8Planar },
71     { AV_PIX_FMT_NV12,         kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange },
72     { AV_PIX_FMT_YUYV422,      kCVPixelFormatType_422YpCbCr8_yuvs },
73 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080
74     { AV_PIX_FMT_GRAY8,        kCVPixelFormatType_OneComponent8 },
75 #endif
76     { AV_PIX_FMT_NONE, 0 }
77 };
78
79 typedef struct
80 {
81     AVClass*        class;
82
83     float           frame_rate;
84     int             frames_captured;
85     int64_t         first_pts;
86     pthread_mutex_t frame_lock;
87     pthread_cond_t  frame_wait_cond;
88     id              avf_delegate;
89
90     int             list_devices;
91     int             video_device_index;
92     enum AVPixelFormat pixel_format;
93
94     AVCaptureSession         *capture_session;
95     AVCaptureVideoDataOutput *video_output;
96     CMSampleBufferRef         current_frame;
97 } AVFContext;
98
99 static void lock_frames(AVFContext* ctx)
100 {
101     pthread_mutex_lock(&ctx->frame_lock);
102 }
103
104 static void unlock_frames(AVFContext* ctx)
105 {
106     pthread_mutex_unlock(&ctx->frame_lock);
107 }
108
109 /** FrameReciever class - delegate for AVCaptureSession
110  */
111 @interface AVFFrameReceiver : NSObject
112 {
113     AVFContext* _context;
114 }
115
116 - (id)initWithContext:(AVFContext*)context;
117
118 - (void)  captureOutput:(AVCaptureOutput *)captureOutput
119   didOutputSampleBuffer:(CMSampleBufferRef)videoFrame
120          fromConnection:(AVCaptureConnection *)connection;
121
122 @end
123
124 @implementation AVFFrameReceiver
125
126 - (id)initWithContext:(AVFContext*)context
127 {
128     if (self = [super init]) {
129         _context = context;
130     }
131     return self;
132 }
133
134 - (void)  captureOutput:(AVCaptureOutput *)captureOutput
135   didOutputSampleBuffer:(CMSampleBufferRef)videoFrame
136          fromConnection:(AVCaptureConnection *)connection
137 {
138     lock_frames(_context);
139
140     if (_context->current_frame != nil) {
141         CFRelease(_context->current_frame);
142     }
143
144     _context->current_frame = (CMSampleBufferRef)CFRetain(videoFrame);
145
146     pthread_cond_signal(&_context->frame_wait_cond);
147
148     unlock_frames(_context);
149
150     ++_context->frames_captured;
151 }
152
153 @end
154
155 static void destroy_context(AVFContext* ctx)
156 {
157     [ctx->capture_session stopRunning];
158
159     [ctx->capture_session release];
160     [ctx->video_output    release];
161     [ctx->avf_delegate    release];
162
163     ctx->capture_session = NULL;
164     ctx->video_output    = NULL;
165     ctx->avf_delegate    = NULL;
166
167     pthread_mutex_destroy(&ctx->frame_lock);
168     pthread_cond_destroy(&ctx->frame_wait_cond);
169
170     if (ctx->current_frame) {
171         CFRelease(ctx->current_frame);
172     }
173 }
174
175 static int add_video_device(AVFormatContext *s, AVCaptureDevice *video_device)
176 {
177     AVFContext *ctx = (AVFContext*)s->priv_data;
178     NSError *error  = nil;
179     AVCaptureDeviceInput* capture_dev_input = [[[AVCaptureDeviceInput alloc] initWithDevice:video_device error:&error] autorelease];
180
181     if (!capture_dev_input) {
182         av_log(s, AV_LOG_ERROR, "Failed to create AV capture input device: %s\n",
183                [[error localizedDescription] UTF8String]);
184         return 1;
185     }
186
187     if ([ctx->capture_session canAddInput:capture_dev_input]) {
188         [ctx->capture_session addInput:capture_dev_input];
189     } else {
190         av_log(s, AV_LOG_ERROR, "can't add video input to capture session\n");
191         return 1;
192     }
193
194     // Attaching output
195     ctx->video_output = [[AVCaptureVideoDataOutput alloc] init];
196
197     if (!ctx->video_output) {
198         av_log(s, AV_LOG_ERROR, "Failed to init AV video output\n");
199         return 1;
200     }
201
202     // select pixel format
203     struct AVFPixelFormatSpec pxl_fmt_spec;
204     pxl_fmt_spec.ff_id = AV_PIX_FMT_NONE;
205
206     for (int i = 0; avf_pixel_formats[i].ff_id != AV_PIX_FMT_NONE; i++) {
207         if (ctx->pixel_format == avf_pixel_formats[i].ff_id) {
208             pxl_fmt_spec = avf_pixel_formats[i];
209             break;
210         }
211     }
212
213     // check if selected pixel format is supported by AVFoundation
214     if (pxl_fmt_spec.ff_id == AV_PIX_FMT_NONE) {
215         av_log(s, AV_LOG_ERROR, "Selected pixel format (%s) is not supported by AVFoundation.\n",
216                av_get_pix_fmt_name(pxl_fmt_spec.ff_id));
217         return 1;
218     }
219
220     // check if the pixel format is available for this device
221     if ([[ctx->video_output availableVideoCVPixelFormatTypes] indexOfObject:[NSNumber numberWithInt:pxl_fmt_spec.avf_id]] == NSNotFound) {
222         av_log(s, AV_LOG_ERROR, "Selected pixel format (%s) is not supported by the input device.\n",
223                av_get_pix_fmt_name(pxl_fmt_spec.ff_id));
224
225         pxl_fmt_spec.ff_id = AV_PIX_FMT_NONE;
226
227         av_log(s, AV_LOG_ERROR, "Supported pixel formats:\n");
228         for (NSNumber *pxl_fmt in [ctx->video_output availableVideoCVPixelFormatTypes]) {
229             struct AVFPixelFormatSpec pxl_fmt_dummy;
230             pxl_fmt_dummy.ff_id = AV_PIX_FMT_NONE;
231             for (int i = 0; avf_pixel_formats[i].ff_id != AV_PIX_FMT_NONE; i++) {
232                 if ([pxl_fmt intValue] == avf_pixel_formats[i].avf_id) {
233                     pxl_fmt_dummy = avf_pixel_formats[i];
234                     break;
235                 }
236             }
237
238             if (pxl_fmt_dummy.ff_id != AV_PIX_FMT_NONE) {
239                 av_log(s, AV_LOG_ERROR, "  %s\n", av_get_pix_fmt_name(pxl_fmt_dummy.ff_id));
240
241                 // select first supported pixel format instead of user selected (or default) pixel format
242                 if (pxl_fmt_spec.ff_id == AV_PIX_FMT_NONE) {
243                     pxl_fmt_spec = pxl_fmt_dummy;
244                 }
245             }
246         }
247
248         // fail if there is no appropriate pixel format or print a warning about overriding the pixel format
249         if (pxl_fmt_spec.ff_id == AV_PIX_FMT_NONE) {
250             return 1;
251         } else {
252             av_log(s, AV_LOG_WARNING, "Overriding selected pixel format to use %s instead.\n",
253                    av_get_pix_fmt_name(pxl_fmt_spec.ff_id));
254         }
255     }
256
257     ctx->pixel_format          = pxl_fmt_spec.ff_id;
258     NSNumber     *pixel_format = [NSNumber numberWithUnsignedInt:pxl_fmt_spec.avf_id];
259     NSDictionary *capture_dict = [NSDictionary dictionaryWithObject:pixel_format
260                                                forKey:(id)kCVPixelBufferPixelFormatTypeKey];
261
262     [ctx->video_output setVideoSettings:capture_dict];
263     [ctx->video_output setAlwaysDiscardsLateVideoFrames:YES];
264
265     ctx->avf_delegate = [[AVFFrameReceiver alloc] initWithContext:ctx];
266
267     dispatch_queue_t queue = dispatch_queue_create("avf_queue", NULL);
268     [ctx->video_output setSampleBufferDelegate:ctx->avf_delegate queue:queue];
269     dispatch_release(queue);
270
271     if ([ctx->capture_session canAddOutput:ctx->video_output]) {
272         [ctx->capture_session addOutput:ctx->video_output];
273     } else {
274         av_log(s, AV_LOG_ERROR, "can't add video output to capture session\n");
275         return 1;
276     }
277
278     return 0;
279 }
280
281 static int get_video_config(AVFormatContext *s)
282 {
283     AVFContext *ctx = (AVFContext*)s->priv_data;
284
285     // Take stream info from the first frame.
286     while (ctx->frames_captured < 1) {
287         CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, YES);
288     }
289
290     lock_frames(ctx);
291
292     AVStream* stream = avformat_new_stream(s, NULL);
293
294     if (!stream) {
295         return 1;
296     }
297
298     avpriv_set_pts_info(stream, 64, 1, avf_time_base);
299
300     CVImageBufferRef image_buffer = CMSampleBufferGetImageBuffer(ctx->current_frame);
301     CGSize image_buffer_size      = CVImageBufferGetEncodedSize(image_buffer);
302
303     stream->codec->codec_id   = AV_CODEC_ID_RAWVIDEO;
304     stream->codec->codec_type = AVMEDIA_TYPE_VIDEO;
305     stream->codec->width      = (int)image_buffer_size.width;
306     stream->codec->height     = (int)image_buffer_size.height;
307     stream->codec->pix_fmt    = ctx->pixel_format;
308
309     CFRelease(ctx->current_frame);
310     ctx->current_frame = nil;
311
312     unlock_frames(ctx);
313
314     return 0;
315 }
316
317 static int avf_read_header(AVFormatContext *s)
318 {
319     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
320     AVFContext *ctx         = (AVFContext*)s->priv_data;
321     ctx->first_pts          = av_gettime();
322
323     pthread_mutex_init(&ctx->frame_lock, NULL);
324     pthread_cond_init(&ctx->frame_wait_cond, NULL);
325
326     // List devices if requested
327     if (ctx->list_devices) {
328         av_log(ctx, AV_LOG_INFO, "AVFoundation video devices:\n");
329         NSArray *devices = [AVCaptureDevice devicesWithMediaType:AVMediaTypeVideo];
330         for (AVCaptureDevice *device in devices) {
331             const char *name = [[device localizedName] UTF8String];
332             int index  = [devices indexOfObject:device];
333             av_log(ctx, AV_LOG_INFO, "[%d] %s\n", index, name);
334         }
335         goto fail;
336     }
337
338     // Find capture device
339     AVCaptureDevice *video_device = nil;
340
341     // check for device index given in filename
342     if (ctx->video_device_index == -1) {
343         sscanf(s->filename, "%d", &ctx->video_device_index);
344     }
345
346     if (ctx->video_device_index >= 0) {
347         NSArray *devices = [AVCaptureDevice devicesWithMediaType:AVMediaTypeVideo];
348
349         if (ctx->video_device_index >= [devices count]) {
350             av_log(ctx, AV_LOG_ERROR, "Invalid device index\n");
351             goto fail;
352         }
353
354         video_device = [devices objectAtIndex:ctx->video_device_index];
355     } else if (strncmp(s->filename, "",        1) &&
356                strncmp(s->filename, "default", 7)) {
357         NSArray *devices = [AVCaptureDevice devicesWithMediaType:AVMediaTypeVideo];
358
359         for (AVCaptureDevice *device in devices) {
360             if (!strncmp(s->filename, [[device localizedName] UTF8String], strlen(s->filename))) {
361                 video_device = device;
362                 break;
363             }
364         }
365
366         if (!video_device) {
367             av_log(ctx, AV_LOG_ERROR, "Video device not found\n");
368             goto fail;
369         }
370     } else {
371         video_device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
372     }
373
374     // Video capture device not found, looking for AVMediaTypeVideo
375     if (!video_device) {
376         video_device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
377
378         if (!video_device) {
379             av_log(s, AV_LOG_ERROR, "No AV capture device found\n");
380             goto fail;
381         }
382     }
383
384     NSString* dev_display_name = [video_device localizedName];
385     av_log(s, AV_LOG_DEBUG, "'%s' opened\n", [dev_display_name UTF8String]);
386
387     // Initialize capture session
388     ctx->capture_session = [[AVCaptureSession alloc] init];
389
390     if (add_video_device(s, video_device)) {
391         goto fail;
392     }
393
394     [ctx->capture_session startRunning];
395
396     if (get_video_config(s)) {
397         goto fail;
398     }
399
400     [pool release];
401     return 0;
402
403 fail:
404     [pool release];
405     destroy_context(ctx);
406     return AVERROR(EIO);
407 }
408
409 static int avf_read_packet(AVFormatContext *s, AVPacket *pkt)
410 {
411     AVFContext* ctx = (AVFContext*)s->priv_data;
412
413     do {
414         lock_frames(ctx);
415
416         CVImageBufferRef image_buffer = CMSampleBufferGetImageBuffer(ctx->current_frame);
417
418         if (ctx->current_frame != nil) {
419             if (av_new_packet(pkt, (int)CVPixelBufferGetDataSize(image_buffer)) < 0) {
420                 return AVERROR(EIO);
421             }
422
423             pkt->pts = pkt->dts = av_rescale_q(av_gettime() - ctx->first_pts,
424                                                AV_TIME_BASE_Q,
425                                                avf_time_base_q);
426             pkt->stream_index  = 0;
427             pkt->flags        |= AV_PKT_FLAG_KEY;
428
429             CVPixelBufferLockBaseAddress(image_buffer, 0);
430
431             void* data = CVPixelBufferGetBaseAddress(image_buffer);
432             memcpy(pkt->data, data, pkt->size);
433
434             CVPixelBufferUnlockBaseAddress(image_buffer, 0);
435             CFRelease(ctx->current_frame);
436             ctx->current_frame = nil;
437         } else {
438             pkt->data = NULL;
439             pthread_cond_wait(&ctx->frame_wait_cond, &ctx->frame_lock);
440         }
441
442         unlock_frames(ctx);
443     } while (!pkt->data);
444
445     return 0;
446 }
447
448 static int avf_close(AVFormatContext *s)
449 {
450     AVFContext* ctx = (AVFContext*)s->priv_data;
451     destroy_context(ctx);
452     return 0;
453 }
454
455 static const AVOption options[] = {
456     { "frame_rate", "set frame rate", offsetof(AVFContext, frame_rate), AV_OPT_TYPE_FLOAT, { .dbl = 30.0 }, 0.1, 30.0, AV_OPT_TYPE_VIDEO_RATE, NULL },
457     { "list_devices", "list available devices", offsetof(AVFContext, list_devices), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
458     { "true", "", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
459     { "false", "", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
460     { "video_device_index", "select video device by index for devices with same name (starts at 0)", offsetof(AVFContext, video_device_index), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
461     { "pixel_format", "set pixel format", offsetof(AVFContext, pixel_format), AV_OPT_TYPE_PIXEL_FMT, {.i64 = AV_PIX_FMT_YUV420P}, 0, INT_MAX, AV_OPT_FLAG_DECODING_PARAM},
462     { NULL },
463 };
464
465 static const AVClass avf_class = {
466     .class_name = "AVFoundation input device",
467     .item_name  = av_default_item_name,
468     .option     = options,
469     .version    = LIBAVUTIL_VERSION_INT,
470     .category   = AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
471 };
472
473 AVInputFormat ff_avfoundation_demuxer = {
474     .name           = "avfoundation",
475     .long_name      = NULL_IF_CONFIG_SMALL("AVFoundation input device"),
476     .priv_data_size = sizeof(AVFContext),
477     .read_header    = avf_read_header,
478     .read_packet    = avf_read_packet,
479     .read_close     = avf_close,
480     .flags          = AVFMT_NOFILE,
481     .priv_class     = &avf_class,
482 };