2 * Copyright (c) 2016 Josh de Kock
4 * This file is part of FFmpeg.
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.
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.
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
23 * libSDL2 output device
27 #include <SDL_thread.h>
29 #include "libavutil/avstring.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/parseutils.h"
33 #include "libavutil/pixdesc.h"
34 #include "libavutil/time.h"
40 SDL_Renderer *renderer;
42 int window_width, window_height; /**< size of the window */
43 int window_x, window_y; /**< position of the window */
44 int window_fullscreen;
45 int window_borderless;
46 int enable_quit_action;
50 SDL_Rect texture_rect;
55 static const struct sdl_texture_format_entry {
56 enum AVPixelFormat format; int texture_fmt;
57 } sdl_texture_format_map[] = {
59 * Not implemented in FFmpeg, but leaving here for completeness.
60 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_ARGB4444 },
61 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_RGBA4444 },
62 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_ABGR4444 },
63 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_BGRA4444 },
64 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_ARGB1555 },
65 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_RGBA5551 },
66 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_ABGR1555 },
67 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_BGRA5551 },
68 * { AV_PIX_FMT_NONE, SDL_PIXELFORMAT_ARGB2101010 },
70 { AV_PIX_FMT_RGB8, SDL_PIXELFORMAT_RGB332 },
71 { AV_PIX_FMT_RGB444, SDL_PIXELFORMAT_RGB444 },
72 { AV_PIX_FMT_RGB555, SDL_PIXELFORMAT_RGB555 },
73 { AV_PIX_FMT_BGR555, SDL_PIXELFORMAT_BGR555 },
74 { AV_PIX_FMT_RGB565, SDL_PIXELFORMAT_RGB565 },
75 { AV_PIX_FMT_BGR565, SDL_PIXELFORMAT_BGR565 },
76 { AV_PIX_FMT_RGB24, SDL_PIXELFORMAT_RGB24 },
77 { AV_PIX_FMT_BGR24, SDL_PIXELFORMAT_BGR24 },
78 { AV_PIX_FMT_0RGB32, SDL_PIXELFORMAT_RGB888 },
79 { AV_PIX_FMT_0BGR32, SDL_PIXELFORMAT_BGR888 },
81 { AV_PIX_FMT_RGB0, SDL_PIXELFORMAT_RGBX8888 },
82 { AV_PIX_FMT_BGR0, SDL_PIXELFORMAT_BGRX8888 },
84 { AV_PIX_FMT_0BGR, SDL_PIXELFORMAT_RGBX8888 },
85 { AV_PIX_FMT_0RGB, SDL_PIXELFORMAT_BGRX8888 },
87 { AV_PIX_FMT_RGB32, SDL_PIXELFORMAT_ARGB8888 },
88 { AV_PIX_FMT_RGB32_1, SDL_PIXELFORMAT_RGBA8888 },
89 { AV_PIX_FMT_BGR32, SDL_PIXELFORMAT_ABGR8888 },
90 { AV_PIX_FMT_BGR32_1, SDL_PIXELFORMAT_BGRA8888 },
91 { AV_PIX_FMT_YUV420P, SDL_PIXELFORMAT_IYUV },
92 { AV_PIX_FMT_YUYV422, SDL_PIXELFORMAT_YUY2 },
93 { AV_PIX_FMT_UYVY422, SDL_PIXELFORMAT_UYVY },
94 { AV_PIX_FMT_NONE, 0 },
97 static void compute_texture_rect(AVFormatContext *s)
99 AVRational sar, dar; /* sample and display aspect ratios */
100 SDLContext *sdl = s->priv_data;
101 AVStream *st = s->streams[0];
102 AVCodecParameters *codecpar = st->codecpar;
103 SDL_Rect *texture_rect = &sdl->texture_rect;
105 /* compute texture width and height from the codec context information */
106 sar = st->sample_aspect_ratio.num ? st->sample_aspect_ratio : (AVRational){ 1, 1 };
107 dar = av_mul_q(sar, (AVRational){ codecpar->width, codecpar->height });
109 /* we suppose the screen has a 1/1 sample aspect ratio */
110 if (sdl->window_width && sdl->window_height) {
111 /* fit in the window */
112 if (av_cmp_q(dar, (AVRational){ sdl->window_width, sdl->window_height }) > 0) {
114 texture_rect->w = sdl->window_width;
115 texture_rect->h = av_rescale(texture_rect->w, dar.den, dar.num);
118 texture_rect->h = sdl->window_height;
119 texture_rect->w = av_rescale(texture_rect->h, dar.num, dar.den);
122 if (sar.num > sar.den) {
123 texture_rect->w = codecpar->width;
124 texture_rect->h = av_rescale(texture_rect->w, dar.den, dar.num);
126 texture_rect->h = codecpar->height;
127 texture_rect->w = av_rescale(texture_rect->h, dar.num, dar.den);
129 sdl->window_width = texture_rect->w;
130 sdl->window_height = texture_rect->h;
133 texture_rect->x = (sdl->window_width - texture_rect->w) / 2;
134 texture_rect->y = (sdl->window_height - texture_rect->h) / 2;
137 static int sdl2_write_trailer(AVFormatContext *s)
139 SDLContext *sdl = s->priv_data;
142 SDL_DestroyTexture(sdl->texture);
146 SDL_DestroyRenderer(sdl->renderer);
147 sdl->renderer = NULL;
150 SDL_DestroyWindow(sdl->window);
159 static int sdl2_write_header(AVFormatContext *s)
161 SDLContext *sdl = s->priv_data;
162 AVStream *st = s->streams[0];
163 AVCodecParameters *codecpar = st->codecpar;
167 if (!sdl->window_title)
168 sdl->window_title = av_strdup(s->url);
170 if (SDL_WasInit(SDL_INIT_VIDEO)) {
171 av_log(s, AV_LOG_WARNING,
172 "SDL video subsystem was already inited, you could have multiple SDL outputs. This may cause unknown behaviour.\n");
176 if ( s->nb_streams > 1
177 || codecpar->codec_type != AVMEDIA_TYPE_VIDEO
178 || codecpar->codec_id != AV_CODEC_ID_RAWVIDEO) {
179 av_log(s, AV_LOG_ERROR, "Only supports one rawvideo stream\n");
183 for (i = 0; sdl_texture_format_map[i].format != AV_PIX_FMT_NONE; i++) {
184 if (sdl_texture_format_map[i].format == codecpar->format) {
185 sdl->texture_fmt = sdl_texture_format_map[i].texture_fmt;
190 if (!sdl->texture_fmt) {
191 av_log(s, AV_LOG_ERROR,
192 "Unsupported pixel format '%s'.\n",
193 av_get_pix_fmt_name(codecpar->format));
197 /* resize texture to width and height from the codec context information */
198 flags = SDL_WINDOW_HIDDEN |
199 (sdl->window_fullscreen ? SDL_WINDOW_FULLSCREEN : 0) |
200 (sdl->window_borderless ? SDL_WINDOW_BORDERLESS : SDL_WINDOW_RESIZABLE);
204 if (SDL_Init(SDL_INIT_VIDEO) != 0) {
205 av_log(s, AV_LOG_ERROR, "Unable to initialize SDL: %s\n", SDL_GetError());
210 compute_texture_rect(s);
212 if (SDL_CreateWindowAndRenderer(sdl->window_width, sdl->window_height,
213 flags, &sdl->window, &sdl->renderer) != 0){
214 av_log(sdl, AV_LOG_ERROR, "Couldn't create window and renderer: %s\n", SDL_GetError());
218 SDL_SetWindowTitle(sdl->window, sdl->window_title);
219 SDL_SetWindowPosition(sdl->window, sdl->window_x, sdl->window_y);
220 SDL_ShowWindow(sdl->window);
222 sdl->texture = SDL_CreateTexture(sdl->renderer, sdl->texture_fmt, SDL_TEXTUREACCESS_STREAMING,
223 codecpar->width, codecpar->height);
226 av_log(sdl, AV_LOG_ERROR, "Unable to set create mode: %s\n", SDL_GetError());
230 av_log(s, AV_LOG_VERBOSE, "w:%d h:%d fmt:%s -> w:%d h:%d\n",
231 codecpar->width, codecpar->height, av_get_pix_fmt_name(codecpar->format),
232 sdl->window_width, sdl->window_height);
238 sdl2_write_trailer(s);
242 static int sdl2_write_packet(AVFormatContext *s, AVPacket *pkt)
245 SDLContext *sdl = s->priv_data;
246 AVCodecParameters *codecpar = s->streams[0]->codecpar;
251 if (SDL_PollEvent(&event)){
252 switch (event.type) {
254 switch (event.key.keysym.sym) {
266 case SDL_WINDOWEVENT:
267 switch(event.window.event){
268 case SDL_WINDOWEVENT_RESIZED:
269 case SDL_WINDOWEVENT_SIZE_CHANGED:
270 sdl->window_width = event.window.data1;
271 sdl->window_height = event.window.data2;
272 compute_texture_rect(s);
283 if (quit && sdl->enable_quit_action) {
284 sdl2_write_trailer(s);
288 av_image_fill_arrays(data, linesize, pkt->data, codecpar->format, codecpar->width, codecpar->height, 1);
289 switch (sdl->texture_fmt) {
290 /* case SDL_PIXELFORMAT_ARGB4444:
291 * case SDL_PIXELFORMAT_RGBA4444:
292 * case SDL_PIXELFORMAT_ABGR4444:
293 * case SDL_PIXELFORMAT_BGRA4444:
294 * case SDL_PIXELFORMAT_ARGB1555:
295 * case SDL_PIXELFORMAT_RGBA5551:
296 * case SDL_PIXELFORMAT_ABGR1555:
297 * case SDL_PIXELFORMAT_BGRA5551:
298 * case SDL_PIXELFORMAT_ARGB2101010:
300 case SDL_PIXELFORMAT_IYUV:
301 case SDL_PIXELFORMAT_YUY2:
302 case SDL_PIXELFORMAT_UYVY:
303 ret = SDL_UpdateYUVTexture(sdl->texture, NULL,
304 data[0], linesize[0],
305 data[1], linesize[1],
306 data[2], linesize[2]);
308 case SDL_PIXELFORMAT_RGB332:
309 case SDL_PIXELFORMAT_RGB444:
310 case SDL_PIXELFORMAT_RGB555:
311 case SDL_PIXELFORMAT_BGR555:
312 case SDL_PIXELFORMAT_RGB565:
313 case SDL_PIXELFORMAT_BGR565:
314 case SDL_PIXELFORMAT_RGB24:
315 case SDL_PIXELFORMAT_BGR24:
316 case SDL_PIXELFORMAT_RGB888:
317 case SDL_PIXELFORMAT_RGBX8888:
318 case SDL_PIXELFORMAT_BGR888:
319 case SDL_PIXELFORMAT_BGRX8888:
320 case SDL_PIXELFORMAT_ARGB8888:
321 case SDL_PIXELFORMAT_RGBA8888:
322 case SDL_PIXELFORMAT_ABGR8888:
323 case SDL_PIXELFORMAT_BGRA8888:
324 ret = SDL_UpdateTexture(sdl->texture, NULL, data[0], linesize[0]);
327 av_log(NULL, AV_LOG_FATAL, "Unsupported pixel format\n");
331 SDL_RenderClear(sdl->renderer);
332 SDL_RenderCopy(sdl->renderer, sdl->texture, NULL, &sdl->texture_rect);
333 SDL_RenderPresent(sdl->renderer);
337 #define OFFSET(x) offsetof(SDLContext,x)
339 static const AVOption options[] = {
340 { "window_title", "set SDL window title", OFFSET(window_title), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
341 { "window_size", "set SDL window forced size", OFFSET(window_width), AV_OPT_TYPE_IMAGE_SIZE, { .str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
342 { "window_x", "set SDL window x position", OFFSET(window_x), AV_OPT_TYPE_INT, { .i64 = SDL_WINDOWPOS_CENTERED }, INT_MIN, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
343 { "window_y", "set SDL window y position", OFFSET(window_y), AV_OPT_TYPE_INT, { .i64 = SDL_WINDOWPOS_CENTERED }, INT_MIN, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
344 { "window_fullscreen", "set SDL window fullscreen", OFFSET(window_fullscreen), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_ENCODING_PARAM },
345 { "window_borderless", "set SDL window border off", OFFSET(window_borderless), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_ENCODING_PARAM },
346 { "window_enable_quit", "set if quit action is available", OFFSET(enable_quit_action), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM },
350 static const AVClass sdl2_class = {
351 .class_name = "sdl2 outdev",
352 .item_name = av_default_item_name,
354 .version = LIBAVUTIL_VERSION_INT,
355 .category = AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT,
358 AVOutputFormat ff_sdl2_muxer = {
360 .long_name = NULL_IF_CONFIG_SMALL("SDL2 output device"),
361 .priv_data_size = sizeof(SDLContext),
362 .audio_codec = AV_CODEC_ID_NONE,
363 .video_codec = AV_CODEC_ID_RAWVIDEO,
364 .write_header = sdl2_write_header,
365 .write_packet = sdl2_write_packet,
366 .write_trailer = sdl2_write_trailer,
367 .flags = AVFMT_NOFILE | AVFMT_VARIABLE_FPS | AVFMT_NOTIMESTAMPS,
368 .priv_class = &sdl2_class,