lavd/sdl: add event handler thread
[ffmpeg.git] / libavdevice / sdl.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * libSDL output device
24  */
25
26 #include <SDL.h>
27 #include <SDL_thread.h>
28
29 #include "libavutil/avstring.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavutil/time.h"
34 #include "avdevice.h"
35
36 typedef struct {
37     AVClass *class;
38     SDL_Surface *surface;
39     SDL_Overlay *overlay;
40     char *window_title;
41     char *icon_title;
42     int window_width,  window_height;  /**< size of the window */
43     int window_fullscreen;
44     int overlay_width, overlay_height; /**< size of the video in the window */
45     int overlay_x, overlay_y;
46     int overlay_fmt;
47     int sdl_was_already_inited;
48     SDL_Thread *event_thread;
49     SDL_mutex *mutex;
50     SDL_cond *init_cond;
51     int init_ret; /* return code used to signal initialization errors */
52     int inited;
53     int quit;
54 } SDLContext;
55
56 static const struct sdl_overlay_pix_fmt_entry {
57     enum AVPixelFormat pix_fmt; int overlay_fmt;
58 } sdl_overlay_pix_fmt_map[] = {
59     { AV_PIX_FMT_YUV420P, SDL_IYUV_OVERLAY },
60     { AV_PIX_FMT_YUYV422, SDL_YUY2_OVERLAY },
61     { AV_PIX_FMT_UYVY422, SDL_UYVY_OVERLAY },
62     { AV_PIX_FMT_NONE,    0                },
63 };
64
65 static int sdl_write_trailer(AVFormatContext *s)
66 {
67     SDLContext *sdl = s->priv_data;
68
69     sdl->quit = 1;
70
71     if (sdl->overlay)
72         SDL_FreeYUVOverlay(sdl->overlay);
73     if (sdl->event_thread)
74         SDL_WaitThread(sdl->event_thread, NULL);
75     if (sdl->mutex)
76         SDL_DestroyMutex(sdl->mutex);
77     if (sdl->init_cond)
78         SDL_DestroyCond(sdl->init_cond);
79
80     if (!sdl->sdl_was_already_inited)
81         SDL_Quit();
82
83     return 0;
84 }
85
86 static int event_thread(void *arg)
87 {
88     AVFormatContext *s = arg;
89     SDLContext *sdl = s->priv_data;
90     int flags = SDL_SWSURFACE | (sdl->window_fullscreen ? SDL_FULLSCREEN : 0);
91     AVStream *st = s->streams[0];
92     AVCodecContext *encctx = st->codec;
93
94     /* initialization */
95     if (SDL_Init(SDL_INIT_VIDEO) != 0) {
96         av_log(s, AV_LOG_ERROR, "Unable to initialize SDL: %s\n", SDL_GetError());
97         sdl->init_ret = AVERROR(EINVAL);
98         goto init_end;
99     }
100
101     SDL_WM_SetCaption(sdl->window_title, sdl->icon_title);
102     sdl->surface = SDL_SetVideoMode(sdl->window_width, sdl->window_height,
103                                     24, flags);
104     if (!sdl->surface) {
105         av_log(sdl, AV_LOG_ERROR, "Unable to set video mode: %s\n", SDL_GetError());
106         sdl->init_ret = AVERROR(EINVAL);
107         goto init_end;
108     }
109
110     sdl->overlay = SDL_CreateYUVOverlay(encctx->width, encctx->height,
111                                         sdl->overlay_fmt, sdl->surface);
112     if (!sdl->overlay || sdl->overlay->pitches[0] < encctx->width) {
113         av_log(s, AV_LOG_ERROR,
114                "SDL does not support an overlay with size of %dx%d pixels\n",
115                encctx->width, encctx->height);
116         sdl->init_ret = AVERROR(EINVAL);
117         goto init_end;
118     }
119
120     sdl->init_ret = 0;
121     av_log(s, AV_LOG_VERBOSE, "w:%d h:%d fmt:%s -> w:%d h:%d\n",
122            encctx->width, encctx->height, av_get_pix_fmt_name(encctx->pix_fmt),
123            sdl->overlay_width, sdl->overlay_height);
124
125 init_end:
126     SDL_LockMutex(sdl->mutex);
127     sdl->inited = 1;
128     SDL_UnlockMutex(sdl->mutex);
129     SDL_CondSignal(sdl->init_cond);
130
131     if (sdl->init_ret < 0)
132         return sdl->init_ret;
133
134     /* event loop */
135     while (!sdl->quit) {
136         int ret;
137         SDL_Event event;
138         SDL_PumpEvents();
139         ret = SDL_PeepEvents(&event, 1, SDL_GETEVENT, SDL_ALLEVENTS);
140         if (ret < 0)
141             av_log(s, AV_LOG_ERROR, "Error when getting SDL event: %s\n", SDL_GetError());
142         if (ret <= 0)
143             continue;
144
145         switch (event.type) {
146         case SDL_KEYDOWN:
147             switch (event.key.keysym.sym) {
148             case SDLK_ESCAPE:
149             case SDLK_q:
150                 sdl->quit = 1;
151                 break;
152             }
153             break;
154         case SDL_QUIT:
155             sdl->quit = 1;
156             break;
157         default:
158             break;
159         }
160     }
161
162     return 0;
163 }
164
165 static int sdl_write_header(AVFormatContext *s)
166 {
167     SDLContext *sdl = s->priv_data;
168     AVStream *st = s->streams[0];
169     AVCodecContext *encctx = st->codec;
170     AVRational sar, dar; /* sample and display aspect ratios */
171     int i, ret;
172
173     if (!sdl->window_title)
174         sdl->window_title = av_strdup(s->filename);
175     if (!sdl->icon_title)
176         sdl->icon_title = av_strdup(sdl->window_title);
177
178     if (SDL_WasInit(SDL_INIT_VIDEO)) {
179         av_log(s, AV_LOG_ERROR,
180                "SDL video subsystem was already inited, aborting\n");
181         sdl->sdl_was_already_inited = 1;
182         ret = AVERROR(EINVAL);
183         goto fail;
184     }
185
186     if (   s->nb_streams > 1
187         || encctx->codec_type != AVMEDIA_TYPE_VIDEO
188         || encctx->codec_id   != AV_CODEC_ID_RAWVIDEO) {
189         av_log(s, AV_LOG_ERROR, "Only supports one rawvideo stream\n");
190         ret = AVERROR(EINVAL);
191         goto fail;
192     }
193
194     for (i = 0; sdl_overlay_pix_fmt_map[i].pix_fmt != AV_PIX_FMT_NONE; i++) {
195         if (sdl_overlay_pix_fmt_map[i].pix_fmt == encctx->pix_fmt) {
196             sdl->overlay_fmt = sdl_overlay_pix_fmt_map[i].overlay_fmt;
197             break;
198         }
199     }
200
201     if (!sdl->overlay_fmt) {
202         av_log(s, AV_LOG_ERROR,
203                "Unsupported pixel format '%s', choose one of yuv420p, yuyv422, or uyvy422\n",
204                av_get_pix_fmt_name(encctx->pix_fmt));
205         ret = AVERROR(EINVAL);
206         goto fail;
207     }
208
209     /* compute overlay width and height from the codec context information */
210     sar = st->sample_aspect_ratio.num ? st->sample_aspect_ratio : (AVRational){ 1, 1 };
211     dar = av_mul_q(sar, (AVRational){ encctx->width, encctx->height });
212
213     /* we suppose the screen has a 1/1 sample aspect ratio */
214     if (sdl->window_width && sdl->window_height) {
215         /* fit in the window */
216         if (av_cmp_q(dar, (AVRational){ sdl->window_width, sdl->window_height }) > 0) {
217             /* fit in width */
218             sdl->overlay_width  = sdl->window_width;
219             sdl->overlay_height = av_rescale(sdl->overlay_width, dar.den, dar.num);
220         } else {
221             /* fit in height */
222             sdl->overlay_height = sdl->window_height;
223             sdl->overlay_width  = av_rescale(sdl->overlay_height, dar.num, dar.den);
224         }
225     } else {
226         if (sar.num > sar.den) {
227             sdl->overlay_width  = encctx->width;
228             sdl->overlay_height = av_rescale(sdl->overlay_width, dar.den, dar.num);
229         } else {
230             sdl->overlay_height = encctx->height;
231             sdl->overlay_width  = av_rescale(sdl->overlay_height, dar.num, dar.den);
232         }
233         sdl->window_width  = sdl->overlay_width;
234         sdl->window_height = sdl->overlay_height;
235     }
236     sdl->overlay_x = (sdl->window_width  - sdl->overlay_width ) / 2;
237     sdl->overlay_y = (sdl->window_height - sdl->overlay_height) / 2;
238
239     sdl->init_cond = SDL_CreateCond();
240     if (!sdl->init_cond) {
241         av_log(s, AV_LOG_ERROR, "Could not create SDL condition variable: %s\n", SDL_GetError());
242         ret = AVERROR_EXTERNAL;
243         goto fail;
244     }
245     sdl->mutex = SDL_CreateMutex();
246     if (!sdl->mutex) {
247         av_log(s, AV_LOG_ERROR, "Could not create SDL mutex: %s\n", SDL_GetError());
248         ret = AVERROR_EXTERNAL;
249         goto fail;
250     }
251     sdl->event_thread = SDL_CreateThread(event_thread, s);
252     if (!sdl->event_thread) {
253         av_log(s, AV_LOG_ERROR, "Could not create SDL event thread: %s\n", SDL_GetError());
254         ret = AVERROR_EXTERNAL;
255         goto fail;
256     }
257
258     /* wait until the video system has been inited */
259     SDL_LockMutex(sdl->mutex);
260     if (!sdl->inited) {
261         SDL_CondWait(sdl->init_cond, sdl->mutex);
262     }
263     SDL_UnlockMutex(sdl->mutex);
264     if (sdl->init_ret < 0) {
265         ret = sdl->init_ret;
266         goto fail;
267     }
268     return 0;
269
270 fail:
271     sdl_write_trailer(s);
272     return ret;
273 }
274
275 static int sdl_write_packet(AVFormatContext *s, AVPacket *pkt)
276 {
277     SDLContext *sdl = s->priv_data;
278     AVCodecContext *encctx = s->streams[0]->codec;
279     SDL_Rect rect = { sdl->overlay_x, sdl->overlay_y, sdl->overlay_width, sdl->overlay_height };
280     AVPicture pict;
281     int i;
282
283     if (sdl->quit)
284         return AVERROR(EIO);
285     avpicture_fill(&pict, pkt->data, encctx->pix_fmt, encctx->width, encctx->height);
286
287     SDL_LockMutex(sdl->mutex);
288     SDL_FillRect(sdl->surface, &sdl->surface->clip_rect,
289                  SDL_MapRGB(sdl->surface->format, 0, 0, 0));
290     SDL_UnlockMutex(sdl->mutex);
291
292     SDL_LockYUVOverlay(sdl->overlay);
293     for (i = 0; i < 3; i++) {
294         sdl->overlay->pixels [i] = pict.data    [i];
295         sdl->overlay->pitches[i] = pict.linesize[i];
296     }
297     SDL_DisplayYUVOverlay(sdl->overlay, &rect);
298     SDL_UnlockYUVOverlay(sdl->overlay);
299
300     SDL_UpdateRect(sdl->surface, rect.x, rect.y, rect.w, rect.h);
301
302     return 0;
303 }
304
305 #define OFFSET(x) offsetof(SDLContext,x)
306
307 static const AVOption options[] = {
308     { "window_title", "set SDL window title",           OFFSET(window_title), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
309     { "icon_title",   "set SDL iconified window title", OFFSET(icon_title)  , AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
310     { "window_size",  "set SDL window forced size",     OFFSET(window_width), AV_OPT_TYPE_IMAGE_SIZE,{.str=NULL}, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
311     { "window_fullscreen", "set SDL window fullscreen", OFFSET(window_fullscreen), AV_OPT_TYPE_INT,{.i64=0}, INT_MIN, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
312     { NULL },
313 };
314
315 static const AVClass sdl_class = {
316     .class_name = "sdl outdev",
317     .item_name  = av_default_item_name,
318     .option     = options,
319     .version    = LIBAVUTIL_VERSION_INT,
320 };
321
322 AVOutputFormat ff_sdl_muxer = {
323     .name           = "sdl",
324     .long_name      = NULL_IF_CONFIG_SMALL("SDL output device"),
325     .priv_data_size = sizeof(SDLContext),
326     .audio_codec    = AV_CODEC_ID_NONE,
327     .video_codec    = AV_CODEC_ID_RAWVIDEO,
328     .write_header   = sdl_write_header,
329     .write_packet   = sdl_write_packet,
330     .write_trailer  = sdl_write_trailer,
331     .flags          = AVFMT_NOFILE | AVFMT_VARIABLE_FPS | AVFMT_NOTIMESTAMPS,
332     .priv_class     = &sdl_class,
333 };