[FFmpeg-devel] [PATCH v14] avformat: add farbfeld muxer and demuxer

farbfeld is an uncompressed image format that is a part of suckless tools (https://tools.suckless.org). Its documentation is available at https://tools.suckless.org/farbfeld. Add support for this image format in avformat. Signed-off-by: Marcus B Spencer <marcus@marcusspencer.xyz> --- Changelog | 1 + doc/general_contents.texi | 4 + libavformat/Makefile | 2 + libavformat/allformats.c | 2 + libavformat/farbfelddec.c | 207 ++++++++++++++++++++++++++++++++++++++ libavformat/farbfeldenc.c | 153 ++++++++++++++++++++++++++++ libavformat/version.h | 2 +- 7 files changed, 370 insertions(+), 1 deletion(-) create mode 100644 libavformat/farbfelddec.c create mode 100644 libavformat/farbfeldenc.c diff --git a/Changelog b/Changelog index 2d3bd43336..2b382bbfbf 100644 --- a/Changelog +++ b/Changelog @@ -16,6 +16,7 @@ version <next>: - VVC encoding support via libvvenc - perlin video source - D3D12VA HEVC encoder +- farbfeld muxer and demuxer version 7.0: - DXV DXT1 encoder diff --git a/doc/general_contents.texi b/doc/general_contents.texi index e7cf4f8239..bbc49d3665 100644 --- a/doc/general_contents.texi +++ b/doc/general_contents.texi @@ -489,6 +489,8 @@ library: @item Electronic Arts Multimedia @tab @tab X @tab Used in various EA games; files have extensions like WVE and UV2. @item Ensoniq Paris Audio File @tab @tab X +@item FF @tab X @tab X + @tab farbfeld uncompressed image @item FFM (FFserver live feed) @tab X @tab X @item Flash (SWF) @tab X @tab X @item Flash 9 (AVM2) @tab X @tab X @@ -786,6 +788,8 @@ following image formats are supported: @tab Digital Picture Exchange @item EXR @tab @tab X @tab OpenEXR +@item FF @tab X @tab X + @tab farbfeld uncompressed image @item FITS @tab X @tab X @tab Flexible Image Transport System @item HDR @tab X @tab X diff --git a/libavformat/Makefile b/libavformat/Makefile index 7ca68a7036..ab8f8216ff 100644 --- a/libavformat/Makefile +++ b/libavformat/Makefile @@ -204,6 +204,8 @@ OBJS-$(CONFIG_EA_DEMUXER) += electronicarts.o OBJS-$(CONFIG_EAC3_DEMUXER) += ac3dec.o rawdec.o OBJS-$(CONFIG_EAC3_MUXER) += rawenc.o OBJS-$(CONFIG_EPAF_DEMUXER) += epafdec.o pcm.o +OBJS-$(CONFIG_FARBFELD_DEMUXER) += farbfelddec.o +OBJS-$(CONFIG_FARBFELD_MUXER) += farbfeldenc.o OBJS-$(CONFIG_FFMETADATA_DEMUXER) += ffmetadec.o OBJS-$(CONFIG_FFMETADATA_MUXER) += ffmetaenc.o OBJS-$(CONFIG_FIFO_MUXER) += fifo.o diff --git a/libavformat/allformats.c b/libavformat/allformats.c index 305fa46532..2cfbf1a648 100644 --- a/libavformat/allformats.c +++ b/libavformat/allformats.c @@ -162,6 +162,8 @@ extern const FFInputFormat ff_epaf_demuxer; extern const FFInputFormat ff_evc_demuxer; extern const FFOutputFormat ff_evc_muxer; extern const FFOutputFormat ff_f4v_muxer; +extern const FFInputFormat ff_farbfeld_demuxer; +extern const FFOutputFormat ff_farbfeld_muxer; extern const FFInputFormat ff_ffmetadata_demuxer; extern const FFOutputFormat ff_ffmetadata_muxer; extern const FFOutputFormat ff_fifo_muxer; diff --git a/libavformat/farbfelddec.c b/libavformat/farbfelddec.c new file mode 100644 index 0000000000..454f063ac1 --- /dev/null +++ b/libavformat/farbfelddec.c @@ -0,0 +1,207 @@ +/* + * Image format + * + * Copyright (c) 2000, 2001, 2002 Fabrice Bellard + * Copyright (c) 2004 Michael Niedermayer + * Copyright (c) 2024 Marcus B Spencer + * + * 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 + */ + +#include "avformat.h" +#include "avio.h" +#include "demux.h" +#include "internal.h" +#include "libavutil/opt.h" +#include "utils.h" + +typedef struct FarbfeldDemuxContext { + const AVClass *class; + int start_number, start_number_range, img_first, img_number, img_last; + AVRational framerate; + int loop; +} FarbfeldDemuxContext; + + +/** + * Get index range of image files matched by path. + * + * @param pfirst_index pointer to index updated with the first number in the range + * @param plast_index pointer to index updated with the last number in the range + * @param path path which has to be matched by the image files in the range + * @param start_index minimum accepted value for the first index in the range + * @return -1 if no image file could be found + */ +static int find_image_range(int *pfirst_index, int *plast_index, + const char *path, int start_index, int start_index_range) +{ + char buf[1024]; + int range, last_index, range1, first_index; + + /* find the first image */ + for (first_index = start_index; first_index < start_index + start_index_range; first_index++) { + if (av_get_frame_filename(buf, sizeof(buf), path, first_index) < 0) { + *pfirst_index = + *plast_index = 1; + if (avio_check(buf, AVIO_FLAG_READ) > 0) + return 0; + return -1; + } + if (avio_check(buf, AVIO_FLAG_READ) > 0) + break; + } + if (first_index == start_index + start_index_range) + goto fail; + + /* find the last image */ + last_index = first_index; + for (;;) { + range = 0; + for (;;) { + if (!range) + range1 = 1; + else + range1 = 2 * range; + if (av_get_frame_filename(buf, sizeof(buf), path, + last_index + range1) < 0) + goto fail; + if (avio_check(buf, AVIO_FLAG_READ) <= 0) + break; + range = range1; + /* just in case... */ + if (range >= (1 << 30)) + goto fail; + } + /* we are sure than image last_index + range exists */ + if (!range) + break; + last_index += range; + } + *pfirst_index = first_index; + *plast_index = last_index; + return 0; + + fail: + return -1; +} + +static int farbfeld_init(AVFormatContext *ctx) +{ + FarbfeldDemuxContext *priv = ctx->priv_data; + + ctx->ctx_flags |= AVFMTCTX_NOHEADER; + + if (find_image_range(&priv->img_first, &priv->img_last, ctx->url, + priv->start_number, priv->start_number_range) < 0) { + av_log(ctx, AV_LOG_ERROR, + "Could find no file with path '%s' and index in the range %d-%d\n", + ctx->url, priv->start_number, priv->start_number + + priv->start_number_range - 1); + return AVERROR(ENOENT); + } + + priv->img_number = priv->img_first; + + return 0; +} + +static int farbfeld_read_packet(AVFormatContext *ctx, AVPacket *pkt) +{ + FarbfeldDemuxContext *priv = ctx->priv_data; + unsigned char magic[8]; + char filename[1024]; + AVIOContext *pb; + AVStream *st; + int ret; + + if (priv->loop && priv->img_number > priv->img_last) + priv->img_number = priv->img_first; + else if (priv->img_number > priv->img_last) + return AVERROR_EOF; + + if (av_get_frame_filename2(filename, sizeof filename, ctx->url, + priv->img_number, + AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0 + && priv->img_number > 1) + return AVERROR(EIO); + + if ((ret = ctx->io_open(ctx, &pb, filename, AVIO_FLAG_READ, NULL)) < 0) { + av_log(ctx, AV_LOG_ERROR, "Could not open file : %s\n", filename); + return ret; + } + + if ((ret = avio_read(pb, magic, 8)) < 0) { + ff_format_io_close(ctx, &pb); + return ret; + } + + if (memcmp(magic, "farbfeld", 8)) { + ff_format_io_close(ctx, &pb); + return AVERROR_INVALIDDATA; + } + + if (!(st = avformat_new_stream(ctx, NULL))) { + ff_format_io_close(ctx, &pb); + return AVERROR(ENOMEM); + } + + st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO; + st->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO; + st->codecpar->format = AV_PIX_FMT_RGBA64BE; + + st->codecpar->width = avio_rb32(pb); + st->codecpar->height = avio_rb32(pb); + st->codecpar->framerate = + st->avg_frame_rate = + st->r_frame_rate = priv->framerate; + + if ((ret = av_get_packet(pb, pkt, avio_size(pb) - 16)) < 0) + return ret; + + priv->img_number++; + + return ff_format_io_close(ctx, &pb); +} + +#define OFFSET(x) offsetof(FarbfeldDemuxContext, x) +#define DEC AV_OPT_FLAG_DECODING_PARAM + +static const AVOption demuxoptions[] = { + { "framerate", "set the video framerate", OFFSET(framerate), AV_OPT_TYPE_VIDEO_RATE,{.str = "25"}, 0, INT_MAX, DEC }, + { "loop", "force loop over input file sequence", OFFSET(loop), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, DEC }, + { "start_number", "set first number in the sequence", OFFSET(start_number), AV_OPT_TYPE_INT, {.i64 = 0}, INT_MIN, INT_MAX, DEC }, + { "start_number_range", "set range for looking at the first sequence number", OFFSET(start_number_range), AV_OPT_TYPE_INT, {.i64 = 5}, 1, INT_MAX, DEC }, + { NULL }, +}; + +static const AVClass farbfeld_demux_class = { + .class_name = "FarbfeldDemuxContext", + .item_name = av_default_item_name, + .option = demuxoptions, + .version = LIBAVUTIL_VERSION_INT, +}; + +const FFInputFormat ff_farbfeld_demuxer = { + .p.name = "farbfeld", + .p.long_name = NULL_IF_CONFIG_SMALL("farbfeld uncompressed image"), + .p.extensions = "ff", + .p.flags = AVFMT_NOTIMESTAMPS | AVFMT_NOFILE, + .p.priv_class = &farbfeld_demux_class, + .priv_data_size = sizeof(FarbfeldDemuxContext), + .read_header = farbfeld_init, + .read_packet = farbfeld_read_packet, +}; diff --git a/libavformat/farbfeldenc.c b/libavformat/farbfeldenc.c new file mode 100644 index 0000000000..6d3c004400 --- /dev/null +++ b/libavformat/farbfeldenc.c @@ -0,0 +1,153 @@ +/* + * misc image utilities + * YUV4MPEG muxer + * Image format + * + * Modified by Marcus B Spencer to suit the farbfeld muxer on 30 June 2024 + * + * Copyright (c) 2001, 2002, 2003 Fabrice Bellard + * Copyright (c) 2000, 2001, 2002 Fabrice Bellard + * Copyright (c) 2004 Michael Niedermayer + * Copyright (c) 2024 Marcus B Spencer + * + * 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 + */ + +#include "avformat.h" +#include "internal.h" +#include "libavutil/avstring.h" +#include "libavutil/frame.h" +#include "libavutil/imgutils.h" +#include "libavutil/opt.h" +#include "libavutil/mem.h" +#include "mux.h" + +#define PLANE_COUNT 4 // required by av_image_copy_to_buffer + +typedef struct FarbfeldMuxContext { + const AVClass *class; + int start_number, img_number; + int update; +} FarbfeldMuxContext; + +static int farbfeld_init(AVFormatContext *ctx) +{ + FarbfeldMuxContext *priv = ctx->priv_data; + + if (ctx->streams[0]->codecpar->codec_id != AV_CODEC_ID_WRAPPED_AVFRAME && + ctx->streams[0]->codecpar->codec_id != AV_CODEC_ID_RAWVIDEO) { + av_log(ctx, AV_LOG_ERROR, "Codec not supported.\n"); + return AVERROR_INVALIDDATA; + } + + if (ctx->streams[0]->codecpar->format != AV_PIX_FMT_RGBA64BE) { + av_log(ctx, AV_LOG_ERROR, + "farbfeld only supports the rgba64be pixel format. " + "Add '-pix_fmt rgba64be' to your output options to resolve " + "this error.\n" + ); + return AVERROR_INVALIDDATA; + } + + priv->img_number = priv->start_number; + + return 0; +} + +static int farbfeld_write_packet(AVFormatContext *ctx, AVPacket *pkt) +{ + AVStream *st = ctx->streams[pkt->stream_index]; + int width = st->codecpar->width, height = st->codecpar->height; + FarbfeldMuxContext *priv = ctx->priv_data; + char filename[1024]; + const uint8_t *src; + const AVFrame *p; + AVIOContext *pb; + int ret; + + if (priv->update) + av_strlcpy(filename, ctx->url, sizeof filename); + else if (av_get_frame_filename2(filename, sizeof filename, ctx->url, + priv->img_number, AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) { + if (priv->img_number == priv->start_number) { + av_log(ctx, AV_LOG_WARNING, "The specified filename '%s' does not contain an image sequence pattern or a pattern is invalid.\n", ctx->url); + av_log(ctx, AV_LOG_WARNING, "Use a pattern such as %%03d for an image sequence.\n"); + av_strlcpy(filename, ctx->url, sizeof filename); + } else { + av_log(ctx, AV_LOG_ERROR, "Cannot write more than one file with the same name.\n"); + return AVERROR(EINVAL); + } + } + + if ((ret = ctx->io_open(ctx, &pb, filename, AVIO_FLAG_WRITE, NULL)) < 0) { + av_log(ctx, AV_LOG_ERROR, "Could not open file : %s\n", filename); + return ret; + } + + avio_write(pb, "farbfeld", 8); + + avio_wb32(pb, width); + avio_wb32(pb, height); + + if (st->codecpar->codec_id == AV_CODEC_ID_RAWVIDEO) + avio_write(pb, pkt->data, pkt->size); + else { + p = (const AVFrame *)pkt->data; + src = p->data[0]; + + for (int i = 0; i < height; i++) { + avio_write(pb, src, width * 8); // 8 bytes per pixel + src += p->linesize[0]; + } + } + + priv->img_number++; + + avio_flush(pb); + + return ff_format_io_close(ctx, &pb); +} + +#define OFFSET(x) offsetof(FarbfeldMuxContext, x) +#define ENC AV_OPT_FLAG_ENCODING_PARAM +static const AVOption muxoptions[] = { + { "update", "continuously overwrite one file", OFFSET(update), AV_OPT_TYPE_BOOL,{ .i64 = 0 }, 0, 1, ENC }, + { "start_number", "set first number in the sequence", OFFSET(start_number), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, INT_MAX, ENC }, + { NULL }, +}; + +static const AVClass farbfeld_mux_class = { + .class_name = "FarbfeldMuxContext", + .item_name = av_default_item_name, + .option = muxoptions, + .version = LIBAVUTIL_VERSION_INT, +}; + +const FFOutputFormat ff_farbfeld_muxer = { + .p.name = "farbfeld", + .p.long_name = NULL_IF_CONFIG_SMALL("farbfeld uncompressed image"), + .p.extensions = "ff", + .p.audio_codec = AV_CODEC_ID_NONE, + .p.video_codec = AV_CODEC_ID_WRAPPED_AVFRAME, + .p.subtitle_codec = AV_CODEC_ID_NONE, + .p.flags = AVFMT_NOTIMESTAMPS | AVFMT_NOFILE, + .p.priv_class = &farbfeld_mux_class, + .priv_data_size = sizeof(FarbfeldMuxContext), + .init = farbfeld_init, + .write_packet = farbfeld_write_packet, + .flags_internal = FF_OFMT_FLAG_MAX_ONE_OF_EACH, +}; diff --git a/libavformat/version.h b/libavformat/version.h index af7d0a1024..e2634b85ae 100644 --- a/libavformat/version.h +++ b/libavformat/version.h @@ -31,7 +31,7 @@ #include "version_major.h" -#define LIBAVFORMAT_VERSION_MINOR 4 +#define LIBAVFORMAT_VERSION_MINOR 5 #define LIBAVFORMAT_VERSION_MICRO 100 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \ -- 2.45.2