]> git.sesse.net Git - vlc/blob - modules/codec/x265.c
x265: default to 25fps if frame rate is not set
[vlc] / modules / codec / x265.c
1 /*****************************************************************************
2  * x265.c: HEVC/H.265 video encoder
3  *****************************************************************************
4  * Copyright (C) 2013 Rafaël Carré
5  *
6  * Authors: Rafaël Carré <funman@videolanorg>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_threads.h>
33 #include <vlc_sout.h>
34 #include <vlc_codec.h>
35
36 #include <x265.h>
37
38 /*****************************************************************************
39  * Module descriptor
40  *****************************************************************************/
41 static int  Open (vlc_object_t *);
42 static void Close(vlc_object_t *);
43
44 vlc_module_begin ()
45     set_description(N_("H.265/HEVC encoder (x265)"))
46     set_capability("encoder", 200)
47     set_callbacks(Open, Close)
48     set_category(CAT_INPUT)
49     set_subcategory(SUBCAT_INPUT_VCODEC)
50 vlc_module_end ()
51
52 struct encoder_sys_t
53 {
54     x265_encoder    *h;
55     x265_param      param;
56
57     bool            write_headers;
58
59     mtime_t         i_initial_delay;
60
61     mtime_t         dts;
62     mtime_t         initial_date;
63 #ifndef NDEBUG
64     mtime_t         start;
65 #endif
66 };
67
68 static block_t *Encode(encoder_t *p_enc, picture_t *p_pict)
69 {
70     encoder_sys_t *p_sys = p_enc->p_sys;
71     x265_picture pic;
72
73     x265_picture_init(&p_sys->param, &pic);
74
75     if (likely(p_pict)) {
76         pic.pts = p_pict->date;
77         if (unlikely(p_sys->initial_date == 0)) {
78             p_sys->initial_date = p_pict->date;
79 #ifndef NDEBUG
80             p_sys->start = mdate();
81 #endif
82         }
83
84         for (int i = 0; i < p_pict->i_planes; i++) {
85             pic.planes[i] = p_pict->p[i].p_pixels;
86             pic.stride[i] = p_pict->p[i].i_pitch;
87         }
88     }
89
90     x265_nal *nal;
91     uint32_t i_nal = 0;
92     x265_encoder_encode(p_sys->h, &nal, &i_nal,
93             likely(p_pict) ? &pic : NULL, &pic);
94
95     if (!i_nal)
96         return NULL;
97
98     int i_out = 0;
99     for (uint32_t i = 0; i < i_nal; i++)
100         i_out += nal[i].sizeBytes;
101
102     int i_extra = 0;
103     if (unlikely(p_sys->write_headers)) {
104         i_extra = p_enc->fmt_out.i_extra;
105         p_sys->write_headers = false;
106     }
107
108     block_t *p_block = block_Alloc(i_extra + i_out);
109     if (!p_block)
110         return NULL;
111
112     if (unlikely(i_extra))
113        memcpy(p_block->p_buffer, p_enc->fmt_out.p_extra, i_extra);
114
115     /* all payloads are sequentially laid out in memory */
116     memcpy(p_block->p_buffer + i_extra, nal[0].payload, i_out);
117
118     /* This isn't really valid for streams with B-frames */
119     p_block->i_length = CLOCK_FREQ *
120         p_enc->fmt_in.video.i_frame_rate_base /
121             p_enc->fmt_in.video.i_frame_rate;
122
123     p_block->i_pts = p_sys->initial_date + pic.poc * p_block->i_length;
124     p_block->i_dts = p_sys->initial_date + p_sys->dts++ * p_block->i_length;
125
126     switch (pic.sliceType)
127     {
128     case X265_TYPE_I:
129         p_block->i_flags |= BLOCK_FLAG_TYPE_I;
130         break;
131     case X265_TYPE_P:
132         p_block->i_flags |= BLOCK_FLAG_TYPE_P;
133         break;
134     case X265_TYPE_B:
135         p_block->i_flags |= BLOCK_FLAG_TYPE_B;
136         break;
137     }
138
139 #ifndef NDEBUG
140     msg_Dbg(p_enc, "%zu bytes (frame %"PRId64", %.2ffps)", p_block->i_buffer,
141         p_sys->dts, (float)p_sys->dts * CLOCK_FREQ / (mdate() - p_sys->start));
142 #endif
143
144     return p_block;
145 }
146
147 static int  Open (vlc_object_t *p_this)
148 {
149     encoder_t     *p_enc = (encoder_t *)p_this;
150     encoder_sys_t *p_sys;
151
152     if (p_enc->fmt_out.i_codec != VLC_CODEC_HEVC && !p_enc->b_force)
153         return VLC_EGENERIC;
154
155     p_enc->fmt_out.i_cat = VIDEO_ES;
156     p_enc->fmt_out.i_codec = VLC_CODEC_HEVC;
157     p_enc->p_sys = p_sys = malloc(sizeof(encoder_sys_t));
158     if (!p_sys)
159         return VLC_ENOMEM;
160
161     p_enc->fmt_in.i_codec = VLC_CODEC_I420;
162
163     x265_param *param = &p_sys->param;
164     x265_param_default(param);
165
166     param->frameNumThreads = vlc_GetCPUCount();
167     param->bEnableWavefront = 0; // buggy in x265, use frame threading for now
168     param->maxCUSize = 16; /* use smaller macroblock */
169
170 #if X265_BUILD >= 6
171     param->fpsNum = p_enc->fmt_in.video.i_frame_rate;
172     param->fpsDenom = p_enc->fmt_in.video.i_frame_rate_base;
173     if (!param->fpsNum) {
174         param->fpsNum = 25;
175         param->fpsDenom = 1;
176     }
177 #else
178     if (p_enc->fmt_in.video.i_frame_rate_base) {
179         param->frameRate = p_enc->fmt_in.video.i_frame_rate /
180             p_enc->fmt_in.video.i_frame_rate_base;
181     } else {
182         param->frameRate = 25;
183     }
184 #endif
185     param->sourceWidth = p_enc->fmt_in.video.i_visible_width;
186     param->sourceHeight = p_enc->fmt_in.video.i_visible_height;
187
188     if (param->sourceWidth & (param->maxCUSize - 1)) {
189         msg_Err(p_enc, "Width (%d) must be a multiple of %d",
190             param->sourceWidth, param->maxCUSize);
191         free(p_sys);
192         return VLC_EGENERIC;
193     }
194     if (param->sourceHeight & 7) {
195         msg_Err(p_enc, "Height (%d) must be a multiple of 8", param->sourceHeight);
196         free(p_sys);
197         return VLC_EGENERIC;
198     }
199
200     if (p_enc->fmt_out.i_bitrate > 0) {
201         param->rc.bitrate = p_enc->fmt_out.i_bitrate / 1000;
202         param->rc.rateControlMode = X265_RC_ABR;
203     }
204
205     p_sys->h = x265_encoder_open(param);
206     if (p_sys->h == NULL) {
207         msg_Err(p_enc, "cannot open x265 encoder");
208         free(p_sys);
209         return VLC_EGENERIC;
210     }
211
212     x265_nal *nal;
213     uint32_t i_nal;
214     if (x265_encoder_headers(p_sys->h, &nal, &i_nal) < 0) {
215         msg_Err(p_enc, "cannot get x265 headers");
216         Close(VLC_OBJECT(p_enc));
217         return VLC_EGENERIC;
218     }
219
220     size_t i_extra = 0;
221     for (uint32_t i = 0; i < i_nal; i++)
222         i_extra += nal[i].sizeBytes;
223
224     p_enc->fmt_out.i_extra = i_extra;
225
226     uint8_t *p_extra = p_enc->fmt_out.p_extra = malloc(i_extra);
227     if (!p_extra) {
228         Close(VLC_OBJECT(p_enc));
229         return VLC_ENOMEM;
230     }
231
232     for (uint32_t i = 0; i < i_nal; i++) {
233         memcpy(p_extra, nal[i].payload, nal[i].sizeBytes);
234         p_extra += nal[i].sizeBytes;
235     }
236
237     p_sys->dts = 0;
238     p_sys->initial_date = 0;
239     p_sys->i_initial_delay = 0;
240     p_sys->write_headers = true;
241
242     p_enc->pf_encode_video = Encode;
243     p_enc->pf_encode_audio = NULL;
244
245     return VLC_SUCCESS;
246 }
247
248 static void Close(vlc_object_t *p_this)
249 {
250     encoder_t     *p_enc = (encoder_t *)p_this;
251     encoder_sys_t *p_sys = p_enc->p_sys;
252
253     x265_encoder_close(p_sys->h);
254
255     free(p_sys);
256 }