2 * AVFoundation input device
3 * Copyright (c) 2014 Thilo Borgmann <thilo.borgmann@mail.de>
5 * This file is part of FFmpeg.
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.
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.
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
24 * AVFoundation input device
25 * @author Thilo Borgmann <thilo.borgmann@mail.de>
28 #import <AVFoundation/AVFoundation.h>
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"
38 static const int avf_time_base = 100;
40 static const AVRational avf_time_base_q = {
45 struct AVFPixelFormatSpec {
46 enum AVPixelFormat ff_id;
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 { AV_PIX_FMT_GRAY8, kCVPixelFormatType_OneComponent8 },
74 { AV_PIX_FMT_NONE, 0 }
84 pthread_mutex_t frame_lock;
85 pthread_cond_t frame_wait_cond;
89 int video_device_index;
90 enum AVPixelFormat pixel_format;
92 AVCaptureSession *capture_session;
93 AVCaptureVideoDataOutput *video_output;
94 CMSampleBufferRef current_frame;
97 static void lock_frames(AVFContext* ctx)
99 pthread_mutex_lock(&ctx->frame_lock);
102 static void unlock_frames(AVFContext* ctx)
104 pthread_mutex_unlock(&ctx->frame_lock);
107 /** FrameReciever class - delegate for AVCaptureSession
109 @interface AVFFrameReceiver : NSObject
111 AVFContext* _context;
114 - (id)initWithContext:(AVFContext*)context;
116 - (void) captureOutput:(AVCaptureOutput *)captureOutput
117 didOutputSampleBuffer:(CMSampleBufferRef)videoFrame
118 fromConnection:(AVCaptureConnection *)connection;
122 @implementation AVFFrameReceiver
124 - (id)initWithContext:(AVFContext*)context
126 if (self = [super init]) {
132 - (void) captureOutput:(AVCaptureOutput *)captureOutput
133 didOutputSampleBuffer:(CMSampleBufferRef)videoFrame
134 fromConnection:(AVCaptureConnection *)connection
136 lock_frames(_context);
138 if (_context->current_frame != nil) {
139 CFRelease(_context->current_frame);
142 _context->current_frame = (CMSampleBufferRef)CFRetain(videoFrame);
144 pthread_cond_signal(&_context->frame_wait_cond);
146 unlock_frames(_context);
148 ++_context->frames_captured;
153 static void destroy_context(AVFContext* ctx)
155 [ctx->capture_session stopRunning];
157 [ctx->capture_session release];
158 [ctx->video_output release];
159 [ctx->avf_delegate release];
161 ctx->capture_session = NULL;
162 ctx->video_output = NULL;
163 ctx->avf_delegate = NULL;
165 pthread_mutex_destroy(&ctx->frame_lock);
166 pthread_cond_destroy(&ctx->frame_wait_cond);
168 if (ctx->current_frame) {
169 CFRelease(ctx->current_frame);
173 static int avf_read_header(AVFormatContext *s)
175 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
176 AVFContext *ctx = (AVFContext*)s->priv_data;
177 ctx->first_pts = av_gettime();
179 pthread_mutex_init(&ctx->frame_lock, NULL);
180 pthread_cond_init(&ctx->frame_wait_cond, NULL);
182 // List devices if requested
183 if (ctx->list_devices) {
184 av_log(ctx, AV_LOG_INFO, "AVFoundation video devices:\n");
185 NSArray *devices = [AVCaptureDevice devicesWithMediaType:AVMediaTypeVideo];
186 for (AVCaptureDevice *device in devices) {
187 const char *name = [[device localizedName] UTF8String];
188 int index = [devices indexOfObject:device];
189 av_log(ctx, AV_LOG_INFO, "[%d] %s\n", index, name);
194 // Find capture device
195 AVCaptureDevice *video_device = nil;
197 // check for device index given in filename
198 if (ctx->video_device_index == -1) {
199 sscanf(s->filename, "%d", &ctx->video_device_index);
202 if (ctx->video_device_index >= 0) {
203 NSArray *devices = [AVCaptureDevice devicesWithMediaType:AVMediaTypeVideo];
205 if (ctx->video_device_index >= [devices count]) {
206 av_log(ctx, AV_LOG_ERROR, "Invalid device index\n");
210 video_device = [devices objectAtIndex:ctx->video_device_index];
211 } else if (strncmp(s->filename, "", 1) &&
212 strncmp(s->filename, "default", 7)) {
213 NSArray *devices = [AVCaptureDevice devicesWithMediaType:AVMediaTypeVideo];
215 for (AVCaptureDevice *device in devices) {
216 if (!strncmp(s->filename, [[device localizedName] UTF8String], strlen(s->filename))) {
217 video_device = device;
223 av_log(ctx, AV_LOG_ERROR, "Video device not found\n");
227 video_device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeMuxed];
230 // Video capture device not found, looking for AVMediaTypeVideo
232 video_device = [AVCaptureDevice defaultDeviceWithMediaType:AVMediaTypeVideo];
235 av_log(s, AV_LOG_ERROR, "No AV capture device found\n");
240 NSString* dev_display_name = [video_device localizedName];
241 av_log(s, AV_LOG_DEBUG, "'%s' opened\n", [dev_display_name UTF8String]);
243 // Initialize capture session
244 ctx->capture_session = [[AVCaptureSession alloc] init];
246 NSError *error = nil;
247 AVCaptureDeviceInput* capture_dev_input = [[[AVCaptureDeviceInput alloc] initWithDevice:video_device error:&error] autorelease];
249 if (!capture_dev_input) {
250 av_log(s, AV_LOG_ERROR, "Failed to create AV capture input device: %s\n",
251 [[error localizedDescription] UTF8String]);
255 if (!capture_dev_input) {
256 av_log(s, AV_LOG_ERROR, "Failed to add AV capture input device to session: %s\n",
257 [[error localizedDescription] UTF8String]);
261 if ([ctx->capture_session canAddInput:capture_dev_input]) {
262 [ctx->capture_session addInput:capture_dev_input];
264 av_log(s, AV_LOG_ERROR, "can't add video input to capture session\n");
269 ctx->video_output = [[AVCaptureVideoDataOutput alloc] init];
271 if (!ctx->video_output) {
272 av_log(s, AV_LOG_ERROR, "Failed to init AV video output\n");
276 // select pixel format
277 struct AVFPixelFormatSpec pxl_fmt_spec;
278 pxl_fmt_spec.ff_id = AV_PIX_FMT_NONE;
280 for (int i = 0; avf_pixel_formats[i].ff_id != AV_PIX_FMT_NONE; i++) {
281 if (ctx->pixel_format == avf_pixel_formats[i].ff_id) {
282 pxl_fmt_spec = avf_pixel_formats[i];
287 // check if selected pixel format is supported by AVFoundation
288 if (pxl_fmt_spec.ff_id == AV_PIX_FMT_NONE) {
289 av_log(s, AV_LOG_ERROR, "Selected pixel format (%s) is not supported by AVFoundation.\n",
290 av_get_pix_fmt_name(pxl_fmt_spec.ff_id));
294 // check if the pixel format is available for this device
295 if ([[ctx->video_output availableVideoCVPixelFormatTypes] indexOfObject:[NSNumber numberWithInt:pxl_fmt_spec.avf_id]] == NSNotFound) {
296 av_log(s, AV_LOG_ERROR, "Selected pixel format (%s) is not supported by the input device.\n",
297 av_get_pix_fmt_name(pxl_fmt_spec.ff_id));
299 pxl_fmt_spec.ff_id = AV_PIX_FMT_NONE;
301 av_log(s, AV_LOG_ERROR, "Supported pixel formats:\n");
302 for (NSNumber *pxl_fmt in [ctx->video_output availableVideoCVPixelFormatTypes]) {
303 struct AVFPixelFormatSpec pxl_fmt_dummy;
304 pxl_fmt_dummy.ff_id = AV_PIX_FMT_NONE;
305 for (int i = 0; avf_pixel_formats[i].ff_id != AV_PIX_FMT_NONE; i++) {
306 if ([pxl_fmt intValue] == avf_pixel_formats[i].avf_id) {
307 pxl_fmt_dummy = avf_pixel_formats[i];
312 if (pxl_fmt_dummy.ff_id != AV_PIX_FMT_NONE) {
313 av_log(s, AV_LOG_ERROR, " %s\n", av_get_pix_fmt_name(pxl_fmt_dummy.ff_id));
315 // select first supported pixel format instead of user selected (or default) pixel format
316 if (pxl_fmt_spec.ff_id == AV_PIX_FMT_NONE) {
317 pxl_fmt_spec = pxl_fmt_dummy;
322 // fail if there is no appropriate pixel format or print a warning about overriding the pixel format
323 if (pxl_fmt_spec.ff_id == AV_PIX_FMT_NONE) {
326 av_log(s, AV_LOG_WARNING, "Overriding selected pixel format to use %s instead.\n",
327 av_get_pix_fmt_name(pxl_fmt_spec.ff_id));
332 NSNumber *pixel_format = [NSNumber numberWithUnsignedInt:pxl_fmt_spec.avf_id];
333 NSDictionary *capture_dict = [NSDictionary dictionaryWithObject:pixel_format
334 forKey:(id)kCVPixelBufferPixelFormatTypeKey];
336 [ctx->video_output setVideoSettings:capture_dict];
337 [ctx->video_output setAlwaysDiscardsLateVideoFrames:YES];
339 ctx->avf_delegate = [[AVFFrameReceiver alloc] initWithContext:ctx];
341 dispatch_queue_t queue = dispatch_queue_create("avf_queue", NULL);
342 [ctx->video_output setSampleBufferDelegate:ctx->avf_delegate queue:queue];
343 dispatch_release(queue);
345 if ([ctx->capture_session canAddOutput:ctx->video_output]) {
346 [ctx->capture_session addOutput:ctx->video_output];
348 av_log(s, AV_LOG_ERROR, "can't add video output to capture session\n");
352 [ctx->capture_session startRunning];
354 // Take stream info from the first frame.
355 while (ctx->frames_captured < 1) {
356 CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, YES);
361 AVStream* stream = avformat_new_stream(s, NULL);
367 avpriv_set_pts_info(stream, 64, 1, avf_time_base);
369 CVImageBufferRef image_buffer = CMSampleBufferGetImageBuffer(ctx->current_frame);
370 CGSize image_buffer_size = CVImageBufferGetEncodedSize(image_buffer);
372 stream->codec->codec_id = AV_CODEC_ID_RAWVIDEO;
373 stream->codec->codec_type = AVMEDIA_TYPE_VIDEO;
374 stream->codec->width = (int)image_buffer_size.width;
375 stream->codec->height = (int)image_buffer_size.height;
376 stream->codec->pix_fmt = pxl_fmt_spec.ff_id;
378 CFRelease(ctx->current_frame);
379 ctx->current_frame = nil;
387 destroy_context(ctx);
391 static int avf_read_packet(AVFormatContext *s, AVPacket *pkt)
393 AVFContext* ctx = (AVFContext*)s->priv_data;
398 CVImageBufferRef image_buffer = CMSampleBufferGetImageBuffer(ctx->current_frame);
400 if (ctx->current_frame != nil) {
401 if (av_new_packet(pkt, (int)CVPixelBufferGetDataSize(image_buffer)) < 0) {
405 pkt->pts = pkt->dts = av_rescale_q(av_gettime() - ctx->first_pts,
408 pkt->stream_index = 0;
409 pkt->flags |= AV_PKT_FLAG_KEY;
411 CVPixelBufferLockBaseAddress(image_buffer, 0);
413 void* data = CVPixelBufferGetBaseAddress(image_buffer);
414 memcpy(pkt->data, data, pkt->size);
416 CVPixelBufferUnlockBaseAddress(image_buffer, 0);
417 CFRelease(ctx->current_frame);
418 ctx->current_frame = nil;
421 pthread_cond_wait(&ctx->frame_wait_cond, &ctx->frame_lock);
425 } while (!pkt->data);
430 static int avf_close(AVFormatContext *s)
432 AVFContext* ctx = (AVFContext*)s->priv_data;
433 destroy_context(ctx);
437 static const AVOption options[] = {
438 { "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 },
439 { "list_devices", "list available devices", offsetof(AVFContext, list_devices), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
440 { "true", "", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
441 { "false", "", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
442 { "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 },
443 { "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},
447 static const AVClass avf_class = {
448 .class_name = "AVFoundation input device",
449 .item_name = av_default_item_name,
451 .version = LIBAVUTIL_VERSION_INT,
454 AVInputFormat ff_avfoundation_demuxer = {
455 .name = "avfoundation",
456 .long_name = NULL_IF_CONFIG_SMALL("AVFoundation input device"),
457 .priv_data_size = sizeof(AVFContext),
458 .read_header = avf_read_header,
459 .read_packet = avf_read_packet,
460 .read_close = avf_close,
461 .flags = AVFMT_NOFILE,
462 .priv_class = &avf_class,