libavdevice/sdl.c
b2a6f25c
 /*
  * Copyright (c) 2011 Stefano Sabatini
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg 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.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * libSDL output device
  */
 
 #include <SDL.h>
7de3b139
 #include <SDL_thread.h>
 
b2a6f25c
 #include "libavutil/avstring.h"
228eb670
 #include "libavutil/imgutils.h"
b2a6f25c
 #include "libavutil/opt.h"
 #include "libavutil/parseutils.h"
 #include "libavutil/pixdesc.h"
7de3b139
 #include "libavutil/time.h"
b2a6f25c
 #include "avdevice.h"
 
 typedef struct {
     AVClass *class;
     SDL_Surface *surface;
     SDL_Overlay *overlay;
     char *window_title;
     char *icon_title;
3ff6b1a2
     int window_width,  window_height;  /**< size of the window */
fdca977a
     int window_fullscreen;
7467b4f7
 
     SDL_Rect overlay_rect;
b2a6f25c
     int overlay_fmt;
7467b4f7
 
b2a6f25c
     int sdl_was_already_inited;
7de3b139
     SDL_Thread *event_thread;
     SDL_mutex *mutex;
     SDL_cond *init_cond;
     int init_ret; /* return code used to signal initialization errors */
     int inited;
     int quit;
b2a6f25c
 } SDLContext;
 
91e7e6b7
 static const struct sdl_overlay_pix_fmt_entry {
ac627b3d
     enum AVPixelFormat pix_fmt; int overlay_fmt;
b2a6f25c
 } sdl_overlay_pix_fmt_map[] = {
ac627b3d
     { AV_PIX_FMT_YUV420P, SDL_IYUV_OVERLAY },
     { AV_PIX_FMT_YUYV422, SDL_YUY2_OVERLAY },
     { AV_PIX_FMT_UYVY422, SDL_UYVY_OVERLAY },
     { AV_PIX_FMT_NONE,    0                },
b2a6f25c
 };
 
 static int sdl_write_trailer(AVFormatContext *s)
 {
     SDLContext *sdl = s->priv_data;
 
7de3b139
     sdl->quit = 1;
 
     if (sdl->overlay)
b2a6f25c
         SDL_FreeYUVOverlay(sdl->overlay);
20fe316e
     sdl->overlay = NULL;
7de3b139
     if (sdl->event_thread)
         SDL_WaitThread(sdl->event_thread, NULL);
20fe316e
     sdl->event_thread = NULL;
7de3b139
     if (sdl->mutex)
         SDL_DestroyMutex(sdl->mutex);
20fe316e
     sdl->mutex = NULL;
7de3b139
     if (sdl->init_cond)
         SDL_DestroyCond(sdl->init_cond);
20fe316e
     sdl->init_cond = NULL;
7de3b139
 
b2a6f25c
     if (!sdl->sdl_was_already_inited)
         SDL_Quit();
 
     return 0;
 }
 
0464d272
 static void compute_overlay_rect(AVFormatContext *s)
 {
     AVRational sar, dar; /* sample and display aspect ratios */
     SDLContext *sdl = s->priv_data;
     AVStream *st = s->streams[0];
     AVCodecContext *encctx = st->codec;
     SDL_Rect *overlay_rect = &sdl->overlay_rect;
 
     /* compute overlay width and height from the codec context information */
     sar = st->sample_aspect_ratio.num ? st->sample_aspect_ratio : (AVRational){ 1, 1 };
     dar = av_mul_q(sar, (AVRational){ encctx->width, encctx->height });
 
     /* we suppose the screen has a 1/1 sample aspect ratio */
     if (sdl->window_width && sdl->window_height) {
         /* fit in the window */
         if (av_cmp_q(dar, (AVRational){ sdl->window_width, sdl->window_height }) > 0) {
             /* fit in width */
             overlay_rect->w = sdl->window_width;
             overlay_rect->h = av_rescale(overlay_rect->w, dar.den, dar.num);
         } else {
             /* fit in height */
             overlay_rect->h = sdl->window_height;
             overlay_rect->w = av_rescale(overlay_rect->h, dar.num, dar.den);
         }
     } else {
         if (sar.num > sar.den) {
             overlay_rect->w = encctx->width;
             overlay_rect->h = av_rescale(overlay_rect->w, dar.den, dar.num);
         } else {
             overlay_rect->h = encctx->height;
             overlay_rect->w = av_rescale(overlay_rect->h, dar.num, dar.den);
         }
         sdl->window_width  = overlay_rect->w;
         sdl->window_height = overlay_rect->h;
     }
 
     overlay_rect->x = (sdl->window_width  - overlay_rect->w) / 2;
     overlay_rect->y = (sdl->window_height - overlay_rect->h) / 2;
 }
 
b23dea27
 #define SDL_BASE_FLAGS (SDL_SWSURFACE|SDL_RESIZABLE)
 
7de3b139
 static int event_thread(void *arg)
 {
     AVFormatContext *s = arg;
     SDLContext *sdl = s->priv_data;
b23dea27
     int flags = SDL_BASE_FLAGS | (sdl->window_fullscreen ? SDL_FULLSCREEN : 0);
7de3b139
     AVStream *st = s->streams[0];
     AVCodecContext *encctx = st->codec;
 
     /* initialization */
     if (SDL_Init(SDL_INIT_VIDEO) != 0) {
         av_log(s, AV_LOG_ERROR, "Unable to initialize SDL: %s\n", SDL_GetError());
         sdl->init_ret = AVERROR(EINVAL);
         goto init_end;
     }
 
     SDL_WM_SetCaption(sdl->window_title, sdl->icon_title);
     sdl->surface = SDL_SetVideoMode(sdl->window_width, sdl->window_height,
                                     24, flags);
     if (!sdl->surface) {
         av_log(sdl, AV_LOG_ERROR, "Unable to set video mode: %s\n", SDL_GetError());
         sdl->init_ret = AVERROR(EINVAL);
         goto init_end;
     }
 
     sdl->overlay = SDL_CreateYUVOverlay(encctx->width, encctx->height,
                                         sdl->overlay_fmt, sdl->surface);
     if (!sdl->overlay || sdl->overlay->pitches[0] < encctx->width) {
         av_log(s, AV_LOG_ERROR,
                "SDL does not support an overlay with size of %dx%d pixels\n",
                encctx->width, encctx->height);
         sdl->init_ret = AVERROR(EINVAL);
         goto init_end;
     }
 
     sdl->init_ret = 0;
     av_log(s, AV_LOG_VERBOSE, "w:%d h:%d fmt:%s -> w:%d h:%d\n",
            encctx->width, encctx->height, av_get_pix_fmt_name(encctx->pix_fmt),
7467b4f7
            sdl->overlay_rect.w, sdl->overlay_rect.h);
7de3b139
 
 init_end:
     SDL_LockMutex(sdl->mutex);
     sdl->inited = 1;
     SDL_UnlockMutex(sdl->mutex);
     SDL_CondSignal(sdl->init_cond);
 
     if (sdl->init_ret < 0)
         return sdl->init_ret;
 
     /* event loop */
     while (!sdl->quit) {
         int ret;
         SDL_Event event;
         SDL_PumpEvents();
         ret = SDL_PeepEvents(&event, 1, SDL_GETEVENT, SDL_ALLEVENTS);
70433119
         if (ret < 0) {
7de3b139
             av_log(s, AV_LOG_ERROR, "Error when getting SDL event: %s\n", SDL_GetError());
             continue;
70433119
         }
         if (ret == 0) {
             SDL_Delay(10);
             continue;
         }
7de3b139
 
         switch (event.type) {
         case SDL_KEYDOWN:
             switch (event.key.keysym.sym) {
             case SDLK_ESCAPE:
             case SDLK_q:
                 sdl->quit = 1;
                 break;
             }
             break;
         case SDL_QUIT:
             sdl->quit = 1;
             break;
b23dea27
 
         case SDL_VIDEORESIZE:
             sdl->window_width  = event.resize.w;
             sdl->window_height = event.resize.h;
 
             SDL_LockMutex(sdl->mutex);
             sdl->surface = SDL_SetVideoMode(sdl->window_width, sdl->window_height, 24, SDL_BASE_FLAGS);
             if (!sdl->surface) {
                 av_log(s, AV_LOG_ERROR, "Failed to set SDL video mode: %s\n", SDL_GetError());
                 sdl->quit = 1;
             } else {
                 compute_overlay_rect(s);
             }
             SDL_UnlockMutex(sdl->mutex);
             break;
 
7de3b139
         default:
             break;
         }
     }
 
     return 0;
 }
 
b2a6f25c
 static int sdl_write_header(AVFormatContext *s)
 {
     SDLContext *sdl = s->priv_data;
     AVStream *st = s->streams[0];
     AVCodecContext *encctx = st->codec;
     int i, ret;
 
0d0fdb0a
     if (!sdl->window_title)
         sdl->window_title = av_strdup(s->filename);
b2a6f25c
     if (!sdl->icon_title)
         sdl->icon_title = av_strdup(sdl->window_title);
 
     if (SDL_WasInit(SDL_INIT_VIDEO)) {
         av_log(s, AV_LOG_ERROR,
a7c7b34d
                "SDL video subsystem was already inited, aborting\n");
b2a6f25c
         sdl->sdl_was_already_inited = 1;
         ret = AVERROR(EINVAL);
         goto fail;
     }
 
     if (   s->nb_streams > 1
         || encctx->codec_type != AVMEDIA_TYPE_VIDEO
7a72695c
         || encctx->codec_id   != AV_CODEC_ID_RAWVIDEO) {
b2a6f25c
         av_log(s, AV_LOG_ERROR, "Only supports one rawvideo stream\n");
         ret = AVERROR(EINVAL);
         goto fail;
     }
 
ac627b3d
     for (i = 0; sdl_overlay_pix_fmt_map[i].pix_fmt != AV_PIX_FMT_NONE; i++) {
b2a6f25c
         if (sdl_overlay_pix_fmt_map[i].pix_fmt == encctx->pix_fmt) {
             sdl->overlay_fmt = sdl_overlay_pix_fmt_map[i].overlay_fmt;
             break;
         }
     }
 
     if (!sdl->overlay_fmt) {
         av_log(s, AV_LOG_ERROR,
a7c7b34d
                "Unsupported pixel format '%s', choose one of yuv420p, yuyv422, or uyvy422\n",
b2a6f25c
                av_get_pix_fmt_name(encctx->pix_fmt));
         ret = AVERROR(EINVAL);
         goto fail;
     }
 
     /* compute overlay width and height from the codec context information */
7467b4f7
     compute_overlay_rect(s);
b2a6f25c
 
7de3b139
     sdl->init_cond = SDL_CreateCond();
     if (!sdl->init_cond) {
         av_log(s, AV_LOG_ERROR, "Could not create SDL condition variable: %s\n", SDL_GetError());
         ret = AVERROR_EXTERNAL;
b2a6f25c
         goto fail;
     }
7de3b139
     sdl->mutex = SDL_CreateMutex();
     if (!sdl->mutex) {
         av_log(s, AV_LOG_ERROR, "Could not create SDL mutex: %s\n", SDL_GetError());
         ret = AVERROR_EXTERNAL;
         goto fail;
     }
     sdl->event_thread = SDL_CreateThread(event_thread, s);
     if (!sdl->event_thread) {
         av_log(s, AV_LOG_ERROR, "Could not create SDL event thread: %s\n", SDL_GetError());
         ret = AVERROR_EXTERNAL;
b2a6f25c
         goto fail;
     }
 
7de3b139
     /* wait until the video system has been inited */
     SDL_LockMutex(sdl->mutex);
18c3313e
     while (!sdl->inited) {
7de3b139
         SDL_CondWait(sdl->init_cond, sdl->mutex);
     }
     SDL_UnlockMutex(sdl->mutex);
     if (sdl->init_ret < 0) {
         ret = sdl->init_ret;
         goto fail;
     }
b2a6f25c
     return 0;
 
 fail:
     sdl_write_trailer(s);
     return ret;
 }
 
 static int sdl_write_packet(AVFormatContext *s, AVPacket *pkt)
 {
     SDLContext *sdl = s->priv_data;
     AVCodecContext *encctx = s->streams[0]->codec;
228eb670
     uint8_t *data[4];
     int linesize[4];
b2a6f25c
     int i;
 
b23dea27
     if (sdl->quit) {
         sdl_write_trailer(s);
7de3b139
         return AVERROR(EIO);
b23dea27
     }
228eb670
     av_image_fill_arrays(data, linesize, pkt->data, encctx->pix_fmt, encctx->width, encctx->height, 1);
b2a6f25c
 
7de3b139
     SDL_LockMutex(sdl->mutex);
b2a6f25c
     SDL_FillRect(sdl->surface, &sdl->surface->clip_rect,
                  SDL_MapRGB(sdl->surface->format, 0, 0, 0));
     SDL_LockYUVOverlay(sdl->overlay);
     for (i = 0; i < 3; i++) {
228eb670
         sdl->overlay->pixels [i] = data    [i];
         sdl->overlay->pitches[i] = linesize[i];
b2a6f25c
     }
7467b4f7
     SDL_DisplayYUVOverlay(sdl->overlay, &sdl->overlay_rect);
b2a6f25c
     SDL_UnlockYUVOverlay(sdl->overlay);
 
7467b4f7
     SDL_UpdateRect(sdl->surface,
                    sdl->overlay_rect.x, sdl->overlay_rect.y,
                    sdl->overlay_rect.w, sdl->overlay_rect.h);
b23dea27
     SDL_UnlockMutex(sdl->mutex);
b2a6f25c
 
     return 0;
 }
 
 #define OFFSET(x) offsetof(SDLContext,x)
 
 static const AVOption options[] = {
35349bbb
     { "window_title", "set SDL window title",           OFFSET(window_title), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
     { "icon_title",   "set SDL iconified window title", OFFSET(icon_title)  , AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
     { "window_size",  "set SDL window forced size",     OFFSET(window_width), AV_OPT_TYPE_IMAGE_SIZE, { .str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
     { "window_fullscreen", "set SDL window fullscreen", OFFSET(window_fullscreen), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
b2a6f25c
     { NULL },
 };
 
 static const AVClass sdl_class = {
     .class_name = "sdl outdev",
     .item_name  = av_default_item_name,
     .option     = options,
     .version    = LIBAVUTIL_VERSION_INT,
f607767d
     .category   = AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT,
b2a6f25c
 };
 
 AVOutputFormat ff_sdl_muxer = {
     .name           = "sdl",
     .long_name      = NULL_IF_CONFIG_SMALL("SDL output device"),
     .priv_data_size = sizeof(SDLContext),
7a72695c
     .audio_codec    = AV_CODEC_ID_NONE,
     .video_codec    = AV_CODEC_ID_RAWVIDEO,
b2a6f25c
     .write_header   = sdl_write_header,
     .write_packet   = sdl_write_packet,
     .write_trailer  = sdl_write_trailer,
2f9907be
     .flags          = AVFMT_NOFILE | AVFMT_VARIABLE_FPS | AVFMT_NOTIMESTAMPS,
b2a6f25c
     .priv_class     = &sdl_class,
 };