KPipewire

pipewirerecord.cpp
1/*
2 SPDX-FileCopyrightText: 2022 Aleix Pol Gonzalez <aleixpol@kde.org>
3
4 SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
5*/
6
7#include "pipewirerecord.h"
8#include "encoder_p.h"
9#include "glhelpers.h"
10#include "pipewirerecord_p.h"
11#include <logging_record.h>
12
13#include <QGuiApplication>
14#include <QImage>
15#include <QPainter>
16
17#include <KShell>
18
19#include <unistd.h>
20extern "C" {
21#include <libavcodec/avcodec.h>
22#include <libavformat/avformat.h>
23#include <libavutil/timestamp.h>
24}
25
26#undef av_err2str
27
28#ifdef av_ts2str
29#undef av_ts2str
30char buf[AV_TS_MAX_STRING_SIZE];
31#define av_ts2str(ts) av_ts_make_string(buf, ts)
32#endif // av_ts2str
33
34#ifdef av_ts2timestr
35#undef av_ts2timestr
36char timebuf[AV_TS_MAX_STRING_SIZE];
37#define av_ts2timestr(ts, tb) av_ts_make_time_string(timebuf, ts, tb)
38#endif // av_ts2timestr
39
40static void log_packet(const AVFormatContext *fmt_ctx, const AVPacket *pkt)
41{
42 AVRational *time_base = &fmt_ctx->streams[pkt->stream_index]->time_base;
43
44 qCDebug(PIPEWIRERECORD_LOGGING,
45 "pts:%s pts_time:%s dts:%s dts_time:%s duration:%s duration_time:%s "
46 "stream_index:%d",
47 av_ts2str(pkt->pts),
48 av_ts2timestr(pkt->pts, time_base),
49 av_ts2str(pkt->dts),
50 av_ts2timestr(pkt->dts, time_base),
51 av_ts2str(pkt->duration),
52 av_ts2timestr(pkt->duration, time_base),
53 pkt->stream_index);
54}
55
56PipeWireRecord::PipeWireRecord(QObject *parent)
57 : PipeWireBaseEncodedStream(parent)
58 , d(new PipeWireRecordPrivate)
59{
60}
61
62PipeWireRecord::~PipeWireRecord() = default;
63
64void PipeWireRecord::setOutput(const QString &_output)
65{
66 const QString output = KShell::tildeExpand(_output);
67
68 if (d->m_output == output)
69 return;
70
71 d->m_output = output;
72 Q_EMIT outputChanged(output);
73}
74
75QString PipeWireRecord::output() const
76{
77 return d->m_output;
78}
79
80QString PipeWireRecord::extension() const
81{
82 static QHash<PipeWireBaseEncodedStream::Encoder, QString> s_extensions = {
83 {PipeWireBaseEncodedStream::H264Main, QStringLiteral("mp4")},
84 {PipeWireBaseEncodedStream::H264Baseline, QStringLiteral("mp4")},
85 {PipeWireBaseEncodedStream::VP8, QStringLiteral("webm")},
86 {PipeWireBaseEncodedStream::VP9, QStringLiteral("webm")},
87 {PipeWireBaseEncodedStream::WebP, QStringLiteral("webp")},
88 {PipeWireBaseEncodedStream::Gif, QStringLiteral("gif")},
89 };
90 return s_extensions.value(encoder());
91}
92
93PipeWireRecordProduce::PipeWireRecordProduce(PipeWireBaseEncodedStream::Encoder encoder, uint nodeId, uint fd, const Fraction &framerate, const QString &output)
94 : PipeWireProduce(encoder, nodeId, fd, framerate)
95 , m_output(output)
96{
97}
98
99bool PipeWireRecordProduce::setupFormat()
100{
101 avformat_alloc_output_context2(&m_avFormatContext, nullptr, nullptr, m_output.toUtf8().constData());
102 if (!m_avFormatContext) {
103 qCWarning(PIPEWIRERECORD_LOGGING) << "Could not deduce output format from file: using WebM." << m_output;
104 avformat_alloc_output_context2(&m_avFormatContext, nullptr, "webm", m_output.toUtf8().constData());
105 }
106 if (!m_avFormatContext) {
107 qCDebug(PIPEWIRERECORD_LOGGING) << "could not set stream up";
108 return false;
109 }
110
111 const Fraction framerate = m_stream->framerate();
112 int ret = avio_open(&m_avFormatContext->pb, QFile::encodeName(m_output).constData(), AVIO_FLAG_WRITE);
113 if (ret < 0) {
114 qCWarning(PIPEWIRERECORD_LOGGING) << "Could not open" << m_output << av_err2str(ret);
115 return false;
116 }
117
118 auto avStream = avformat_new_stream(m_avFormatContext, nullptr);
119 avStream->start_time = 0;
120 if (framerate) {
121 avStream->r_frame_rate.num = framerate.numerator;
122 avStream->r_frame_rate.den = framerate.denominator;
123 avStream->avg_frame_rate.num = framerate.numerator;
124 avStream->avg_frame_rate.den = framerate.denominator;
125 }
126
127 ret = avcodec_parameters_from_context(avStream->codecpar, m_encoder->avCodecContext());
128 if (ret < 0) {
129 qCWarning(PIPEWIRERECORD_LOGGING) << "Error occurred when passing the codec:" << av_err2str(ret);
130 return false;
131 }
132
133 AVDictionary *options = nullptr;
134 const auto codecId = m_avFormatContext->oformat->video_codec;
135 if (codecId == AV_CODEC_ID_GIF || codecId == AV_CODEC_ID_WEBP) {
136 av_dict_set_int(&options, "loop", 0, 0);
137 }
138 ret = avformat_write_header(m_avFormatContext, &options);
139 if (ret < 0) {
140 qCWarning(PIPEWIRERECORD_LOGGING) << "Error occurred when writing header:" << av_err2str(ret);
141 return false;
142 }
143
144 return true;
145}
146
147void PipeWireRecordProduce::processFrame(const PipeWireFrame &frame)
148{
149 PipeWireProduce::processFrame(frame);
150 if (frame.cursor && !frame.dmabuf && !frame.dataFrame && m_frameWithoutMetadataCursor.dataFrame) {
151 m_encoder->filterFrame(m_frameWithoutMetadataCursor);
152 }
153}
154
155void PipeWireRecordProduce::aboutToEncode(PipeWireFrame &frame)
156{
157 if (!frame.dataFrame) {
158 return;
159 }
160
161 if (m_cursor.position && !m_cursor.texture.isNull()) {
162 auto image = frame.dataFrame->toImage();
163 // Do not copy the image if it's already ours
164 if (m_frameWithoutMetadataCursor.dataFrame->cleanup != frame.dataFrame->cleanup) {
165 m_frameWithoutMetadataCursor.dataFrame = frame.dataFrame->copy();
166 }
167 QPainter p(&image);
168 p.drawImage(*m_cursor.position, m_cursor.texture);
169 }
170}
171
172void PipeWireRecordProduce::processPacket(AVPacket *packet)
173{
174 packet->stream_index = (*m_avFormatContext->streams)->index;
175 av_packet_rescale_ts(packet, m_encoder->avCodecContext()->time_base, (*m_avFormatContext->streams)->time_base);
176 log_packet(m_avFormatContext, packet);
177 auto ret = av_interleaved_write_frame(m_avFormatContext, packet);
178 if (ret < 0) {
179 qCWarning(PIPEWIRERECORD_LOGGING) << "Error while writing output packet:" << av_err2str(ret);
180 }
181}
182
183std::unique_ptr<PipeWireProduce> PipeWireRecord::makeProduce()
184{
185 return std::make_unique<PipeWireRecordProduce>(encoder(), nodeId(), fd(), maxFramerate(), d->m_output);
186}
187
188int64_t PipeWireRecordProduce::framePts(const std::optional<std::chrono::nanoseconds> &presentationTimestamp)
189{
190 const auto current = std::chrono::duration_cast<std::chrono::milliseconds>(*presentationTimestamp).count();
191 if ((*m_avFormatContext->streams)->start_time == 0) {
192 (*m_avFormatContext->streams)->start_time = current;
193 }
194
195 return current - (*m_avFormatContext->streams)->start_time;
196}
197
198void PipeWireRecordProduce::cleanup()
199{
200 if (m_avFormatContext) {
201 if (auto result = av_write_trailer(m_avFormatContext); result < 0) {
202 qCWarning(PIPEWIRERECORD_LOGGING) << "Could not write trailer";
203 }
204
205 avio_closep(&m_avFormatContext->pb);
206 avformat_free_context(m_avFormatContext);
207 }
208}
209
210#include "moc_pipewirerecord.cpp"
211
212#include "moc_pipewirerecord_p.cpp"
KCOREADDONS_EXPORT QString tildeExpand(const QString &path)
QByteArray encodeName(const QString &fileName)
T value(const Key &key) const const
Q_EMITQ_EMIT
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 12:00:27 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.