]> git.sesse.net Git - nageru/blob - x264_encoder.cpp
Turn on filler bits to cap the x264 bitrate from below, to increase smoothness in...
[nageru] / x264_encoder.cpp
1 #include <string.h>
2 #include <unistd.h>
3
4 #include "defs.h"
5 #include "flags.h"
6 #include "mux.h"
7 #include "timebase.h"
8 #include "x264_encoder.h"
9 #include "x264_speed_control.h"
10
11 extern "C" {
12 #include <libavformat/avformat.h>
13 }
14
15 using namespace std;
16
17 X264Encoder::X264Encoder(AVOutputFormat *oformat)
18         : wants_global_headers(oformat->flags & AVFMT_GLOBALHEADER)
19 {
20         frame_pool.reset(new uint8_t[WIDTH * HEIGHT * 2 * X264_QUEUE_LENGTH]);
21         for (unsigned i = 0; i < X264_QUEUE_LENGTH; ++i) {
22                 free_frames.push(frame_pool.get() + i * (WIDTH * HEIGHT * 2));
23         }
24         encoder_thread = thread(&X264Encoder::encoder_thread_func, this);
25 }
26
27 X264Encoder::~X264Encoder()
28 {
29         should_quit = true;
30         queued_frames_nonempty.notify_all();
31         encoder_thread.join();
32 }
33
34 void X264Encoder::add_frame(int64_t pts, int64_t duration, const uint8_t *data)
35 {
36         QueuedFrame qf;
37         qf.pts = pts;
38         qf.duration = duration;
39
40         {
41                 lock_guard<mutex> lock(mu);
42                 if (free_frames.empty()) {
43                         fprintf(stderr, "WARNING: x264 queue full, dropping frame with pts %ld\n", pts);
44                         return;
45                 }
46
47                 qf.data = free_frames.front();
48                 free_frames.pop();
49         }
50
51         memcpy(qf.data, data, WIDTH * HEIGHT * 2);
52
53         {
54                 lock_guard<mutex> lock(mu);
55                 queued_frames.push(qf);
56                 queued_frames_nonempty.notify_all();
57         }
58 }
59         
60 void X264Encoder::init_x264()
61 {
62         x264_param_t param;
63         x264_param_default_preset(&param, global_flags.x264_preset.c_str(), global_flags.x264_tune.c_str());
64
65         param.i_width = WIDTH;
66         param.i_height = HEIGHT;
67         param.i_csp = X264_CSP_NV12;
68         param.b_vfr_input = 1;
69         param.i_timebase_num = 1;
70         param.i_timebase_den = TIMEBASE;
71         param.i_keyint_max = 50; // About one second.
72         if (global_flags.x264_speedcontrol) {
73                 param.i_frame_reference = 16;  // Because speedcontrol is never allowed to change this above what we set at start.
74         }
75
76         // NOTE: These should be in sync with the ones in h264encode.cpp (sbs_rbsp()).
77         param.vui.i_vidformat = 5;  // Unspecified.
78         param.vui.b_fullrange = 0;
79         param.vui.i_colorprim = 1;  // BT.709.
80         param.vui.i_transfer = 2;  // Unspecified (since we use sRGB).
81         param.vui.i_colmatrix = 6;  // BT.601/SMPTE 170M.
82
83
84         param.rc.i_rc_method = X264_RC_ABR;
85         param.rc.i_bitrate = global_flags.x264_bitrate;
86         if (global_flags.x264_vbv_buffer_size < 0) {
87                 param.rc.i_vbv_buffer_size = param.rc.i_bitrate;  // One-second VBV.
88         } else {
89                 param.rc.i_vbv_buffer_size = global_flags.x264_vbv_buffer_size;
90         }
91         if (global_flags.x264_vbv_max_bitrate < 0) {
92                 param.rc.i_vbv_max_bitrate = param.rc.i_bitrate;  // CBR.
93         } else {
94                 param.rc.i_vbv_max_bitrate = global_flags.x264_vbv_max_bitrate;
95         }
96         if (param.rc.i_vbv_max_bitrate > 0) {
97                 // If the user wants VBV control to cap the max rate, it is
98                 // also reasonable to assume that they are fine with the stream
99                 // constantly being around that rate even for very low-complexity
100                 // content; the obvious and extreme example being a static
101                 // black picture.
102                 //
103                 // One would think it's fine to have low-complexity codec use
104                 // less bitrate, but it seems to cause problems in practice;
105                 // e.g. VLC seems to often drop the stream (similar to a buffer
106                 // underrun) in such cases, but only when streaming from Nageru,
107                 // not when reading a dump of the same stream from disk.
108                 // I'm not 100% sure whether it's in VLC (possibly some buffering
109                 // in the HTTP layer), in microhttpd or somewhere in Nageru itself,
110                 // but it's a typical case of problems that can arise. Similarly,
111                 // TCP's congestion control is not always fond of the rate staying
112                 // low for a while and then rising quickly -- a variation on the same
113                 // problem.
114                 //
115                 // We solve this by simply asking x264 to fill in dummy bits
116                 // in these cases, so that the bitrate stays reasonable constant.
117                 // It's a waste of bandwidth, but it makes things go much more
118                 // smoothly in these cases. (We don't do it if VBV control is off
119                 // in general, not the least because it makes no sense and x264
120                 // thus ignores the parameter.)
121                 param.rc.b_filler = 1;
122         }
123
124         // Occasionally players have problem with extremely low quantizers;
125         // be on the safe side. Shouldn't affect quality in any meaningful way.
126         param.rc.i_qp_min = 5;
127
128         // TODO: more flags here, via x264_param_parse().
129
130         x264_param_apply_profile(&param, "high");
131
132         param.b_repeat_headers = !wants_global_headers;
133
134         x264 = x264_encoder_open(&param);
135         if (x264 == nullptr) {
136                 fprintf(stderr, "ERROR: x264 initialization failed.\n");
137                 exit(1);
138         }
139
140         if (global_flags.x264_speedcontrol) {
141                 speed_control.reset(new X264SpeedControl(x264, /*f_speed=*/1.0f, X264_QUEUE_LENGTH, /*f_buffer_init=*/1.0f));
142         }
143
144         if (wants_global_headers) {
145                 x264_nal_t *nal;
146                 int num_nal;
147
148                 x264_encoder_headers(x264, &nal, &num_nal);
149
150                 for (int i = 0; i < num_nal; ++i) {
151                         if (nal[i].i_type == NAL_SEI) {
152                                 // Don't put the SEI in extradata; make it part of the first frame instead.
153                                 buffered_sei += string((const char *)nal[i].p_payload, nal[i].i_payload);
154                         } else {
155                                 global_headers += string((const char *)nal[i].p_payload, nal[i].i_payload);
156                         }
157                 }
158         }
159 }
160
161 void X264Encoder::encoder_thread_func()
162 {
163         nice(5);  // Note that x264 further nices some of its threads.
164         init_x264();
165
166         bool frames_left;
167
168         do {
169                 QueuedFrame qf;
170
171                 // Wait for a queued frame, then dequeue it.
172                 {
173                         unique_lock<mutex> lock(mu);
174                         queued_frames_nonempty.wait(lock, [this]() { return !queued_frames.empty() || should_quit; });
175                         if (!queued_frames.empty()) {
176                                 qf = queued_frames.front();
177                                 queued_frames.pop();
178                         } else {
179                                 qf.pts = -1;
180                                 qf.duration = -1;
181                                 qf.data = nullptr;
182                         }
183
184                         frames_left = !queued_frames.empty();
185                 }
186
187                 encode_frame(qf);
188                 
189                 {
190                         lock_guard<mutex> lock(mu);
191                         free_frames.push(qf.data);
192                 }
193
194                 // We should quit only if the should_quit flag is set _and_ we have nothing
195                 // in either queue.
196         } while (!should_quit || frames_left || x264_encoder_delayed_frames(x264) > 0);
197
198         x264_encoder_close(x264);
199 }
200
201 void X264Encoder::encode_frame(X264Encoder::QueuedFrame qf)
202 {
203         x264_nal_t *nal = nullptr;
204         int num_nal = 0;
205         x264_picture_t pic;
206         x264_picture_t *input_pic = nullptr;
207
208         if (qf.data) {
209                 x264_picture_init(&pic);
210
211                 pic.i_pts = qf.pts;
212                 pic.img.i_csp = X264_CSP_NV12;
213                 pic.img.i_plane = 2;
214                 pic.img.plane[0] = qf.data;
215                 pic.img.i_stride[0] = WIDTH;
216                 pic.img.plane[1] = qf.data + WIDTH * HEIGHT;
217                 pic.img.i_stride[1] = WIDTH / 2 * sizeof(uint16_t);
218                 pic.opaque = reinterpret_cast<void *>(intptr_t(qf.duration));
219
220                 input_pic = &pic;
221         }
222
223         if (speed_control) {
224                 speed_control->before_frame(float(free_frames.size()) / X264_QUEUE_LENGTH, X264_QUEUE_LENGTH, 1e6 * qf.duration / TIMEBASE);
225         }
226         x264_encoder_encode(x264, &nal, &num_nal, input_pic, &pic);
227         if (speed_control) {
228                 speed_control->after_frame();
229         }
230
231         // We really need one AVPacket for the entire frame, it seems,
232         // so combine it all.
233         size_t num_bytes = buffered_sei.size();
234         for (int i = 0; i < num_nal; ++i) {
235                 num_bytes += nal[i].i_payload;
236         }
237
238         unique_ptr<uint8_t[]> data(new uint8_t[num_bytes]);
239         uint8_t *ptr = data.get();
240
241         if (!buffered_sei.empty()) {
242                 memcpy(ptr, buffered_sei.data(), buffered_sei.size());
243                 ptr += buffered_sei.size();
244                 buffered_sei.clear();
245         }
246         for (int i = 0; i < num_nal; ++i) {
247                 memcpy(ptr, nal[i].p_payload, nal[i].i_payload);
248                 ptr += nal[i].i_payload;
249         }
250
251         AVPacket pkt;
252         memset(&pkt, 0, sizeof(pkt));
253         pkt.buf = nullptr;
254         pkt.data = data.get();
255         pkt.size = num_bytes;
256         pkt.stream_index = 0;
257         if (pic.b_keyframe) {
258                 pkt.flags = AV_PKT_FLAG_KEY;
259         } else {
260                 pkt.flags = 0;
261         }
262         pkt.duration = reinterpret_cast<intptr_t>(pic.opaque);
263
264         mux->add_packet(pkt, pic.i_pts, pic.i_dts);
265 }