2 * Copyright (c) 2013 Jeff Moguillansky
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 * XVideo output device
26 * - add support to more formats
27 * - add support to window id specification
31 #include <X11/extensions/Xv.h>
32 #include <X11/extensions/XShm.h>
33 #include <X11/extensions/Xvlib.h>
36 #include "libavutil/opt.h"
37 #include "libavutil/pixdesc.h"
38 #include "libavutil/imgutils.h"
39 #include "libavformat/internal.h"
48 int window_width, window_height;
49 int window_x, window_y;
55 enum AVPixelFormat image_format;
56 int image_width, image_height;
57 XShmSegmentInfo yuv_shminfo;
61 typedef struct XVTagFormatMap
64 enum AVPixelFormat format;
67 static XVTagFormatMap tag_codec_map[] = {
68 { MKTAG('I','4','2','0'), AV_PIX_FMT_YUV420P },
69 { MKTAG('U','Y','V','Y'), AV_PIX_FMT_UYVY422 },
70 { MKTAG('Y','U','Y','2'), AV_PIX_FMT_YUYV422 },
71 { 0, AV_PIX_FMT_NONE }
74 static int xv_get_tag_from_format(enum AVPixelFormat format)
76 XVTagFormatMap *m = tag_codec_map;
78 for (i = 0; m->tag; m = &tag_codec_map[++i]) {
79 if (m->format == format)
85 static int xv_write_trailer(AVFormatContext *s)
87 XVContext *xv = s->priv_data;
89 XShmDetach(xv->display, &xv->yuv_shminfo);
91 shmdt(xv->yuv_image->data);
94 XFreeGC(xv->display, xv->gc);
95 XCloseDisplay(xv->display);
100 static int xv_write_header(AVFormatContext *s)
102 XVContext *xv = s->priv_data;
103 unsigned int num_adaptors;
105 XvImageFormatValues *fv;
106 int num_formats = 0, j, tag, ret;
107 AVCodecContext *encctx = s->streams[0]->codec;
109 if ( s->nb_streams > 1
110 || encctx->codec_type != AVMEDIA_TYPE_VIDEO
111 || encctx->codec_id != AV_CODEC_ID_RAWVIDEO) {
112 av_log(s, AV_LOG_ERROR, "Only supports one rawvideo stream\n");
113 return AVERROR(EINVAL);
116 if (!(tag = xv_get_tag_from_format(encctx->pix_fmt))) {
117 av_log(s, AV_LOG_ERROR,
118 "Unsupported pixel format '%s', only yuv420p, uyvy422, yuyv422 are currently supported\n",
119 av_get_pix_fmt_name(encctx->pix_fmt));
120 return AVERROR_PATCHWELCOME;
122 xv->image_format = encctx->pix_fmt;
124 xv->display = XOpenDisplay(xv->display_name);
126 av_log(s, AV_LOG_ERROR, "Could not open the X11 display '%s'\n", xv->display_name);
127 return AVERROR(EINVAL);
130 xv->image_width = encctx->width;
131 xv->image_height = encctx->height;
132 if (!xv->window_width && !xv->window_height) {
133 AVRational sar = encctx->sample_aspect_ratio;
134 xv->window_width = encctx->width;
135 xv->window_height = encctx->height;
137 if (sar.num > sar.den)
138 xv->window_width = av_rescale(xv->window_width, sar.num, sar.den);
139 if (sar.num < sar.den)
140 xv->window_height = av_rescale(xv->window_height, sar.den, sar.num);
143 xv->window = XCreateSimpleWindow(xv->display, DefaultRootWindow(xv->display),
144 xv->window_x, xv->window_y,
145 xv->window_width, xv->window_height,
147 if (!xv->window_title) {
148 if (!(xv->window_title = av_strdup(s->filename))) {
149 ret = AVERROR(ENOMEM);
153 XStoreName(xv->display, xv->window, xv->window_title);
154 XMapWindow(xv->display, xv->window);
156 if (XvQueryAdaptors(xv->display, DefaultRootWindow(xv->display), &num_adaptors, &ai) != Success) {
157 ret = AVERROR_EXTERNAL;
161 av_log(s, AV_LOG_ERROR, "No X-Video adaptors present\n");
162 return AVERROR(ENODEV);
164 xv->xv_port = ai[0].base_id;
165 XvFreeAdaptorInfo(ai);
167 fv = XvListImageFormats(xv->display, xv->xv_port, &num_formats);
169 ret = AVERROR_EXTERNAL;
172 for (j = 0; j < num_formats; j++) {
173 if (fv[j].id == tag) {
179 if (j >= num_formats) {
180 av_log(s, AV_LOG_ERROR,
181 "Device does not support pixel format %s, aborting\n",
182 av_get_pix_fmt_name(encctx->pix_fmt));
183 ret = AVERROR(EINVAL);
187 xv->gc = XCreateGC(xv->display, xv->window, 0, 0);
188 xv->image_width = encctx->width;
189 xv->image_height = encctx->height;
190 xv->yuv_image = XvShmCreateImage(xv->display, xv->xv_port, tag, 0,
191 xv->image_width, xv->image_height, &xv->yuv_shminfo);
192 xv->yuv_shminfo.shmid = shmget(IPC_PRIVATE, xv->yuv_image->data_size,
194 xv->yuv_shminfo.shmaddr = (char *)shmat(xv->yuv_shminfo.shmid, 0, 0);
195 xv->yuv_image->data = xv->yuv_shminfo.shmaddr;
196 xv->yuv_shminfo.readOnly = False;
198 XShmAttach(xv->display, &xv->yuv_shminfo);
199 XSync(xv->display, False);
200 shmctl(xv->yuv_shminfo.shmid, IPC_RMID, 0);
208 static int write_picture(AVFormatContext *s, AVPicture *pict)
210 XVContext *xv = s->priv_data;
211 XvImage *img = xv->yuv_image;
212 XWindowAttributes window_attrs;
214 img->data + img->offsets[0],
215 img->data + img->offsets[1],
216 img->data + img->offsets[2]
219 av_image_copy(data, img->pitches, (const uint8_t **)pict->data, pict->linesize,
220 xv->image_format, img->width, img->height);
221 XGetWindowAttributes(xv->display, xv->window, &window_attrs);
222 if (XvShmPutImage(xv->display, xv->xv_port, xv->window, xv->gc,
223 xv->yuv_image, 0, 0, xv->image_width, xv->image_height, 0, 0,
224 window_attrs.width, window_attrs.height, True) != Success) {
225 av_log(s, AV_LOG_ERROR, "Could not copy image to XV shared memory buffer\n");
226 return AVERROR_EXTERNAL;
231 static int xv_write_packet(AVFormatContext *s, AVPacket *pkt)
234 AVCodecContext *ctx = s->streams[0]->codec;
236 avpicture_fill(&pict, pkt->data, ctx->pix_fmt, ctx->width, ctx->height);
237 return write_picture(s, &pict);
240 static int xv_write_frame(AVFormatContext *s, int stream_index, AVFrame **frame,
243 /* xv_write_header() should have accepted only supported formats */
244 if ((flags & AV_WRITE_UNCODED_FRAME_QUERY))
246 return write_picture(s, (AVPicture *)*frame);
249 #define OFFSET(x) offsetof(XVContext, x)
250 static const AVOption options[] = {
251 { "display_name", "set display name", OFFSET(display_name), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
252 { "window_size", "set window forced size", OFFSET(window_width), AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
253 { "window_title", "set window title", OFFSET(window_title), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
254 { "window_x", "set window x offset", OFFSET(window_x), AV_OPT_TYPE_INT, {.i64 = 0 }, -INT_MAX, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
255 { "window_y", "set window y offset", OFFSET(window_y), AV_OPT_TYPE_INT, {.i64 = 0 }, -INT_MAX, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
260 static const AVClass xv_class = {
261 .class_name = "xvideo outdev",
262 .item_name = av_default_item_name,
264 .version = LIBAVUTIL_VERSION_INT,
265 .category = AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT,
268 AVOutputFormat ff_xv_muxer = {
270 .long_name = NULL_IF_CONFIG_SMALL("XV (XVideo) output device"),
271 .priv_data_size = sizeof(XVContext),
272 .audio_codec = AV_CODEC_ID_NONE,
273 .video_codec = AV_CODEC_ID_RAWVIDEO,
274 .write_header = xv_write_header,
275 .write_packet = xv_write_packet,
276 .write_uncoded_frame = xv_write_frame,
277 .write_trailer = xv_write_trailer,
278 .flags = AVFMT_NOFILE | AVFMT_VARIABLE_FPS | AVFMT_NOTIMESTAMPS,
279 .priv_class = &xv_class,