]> git.sesse.net Git - vlc/blob - modules/codec/dirac.c
Correctly test for picture compatibility with avcodec direct rendering requirements.
[vlc] / modules / codec / dirac.c
1 /*****************************************************************************
2  * dirac.c: Dirac encoder module making use of libdirac (dirac-research).
3  *          (http://www.bbc.co.uk/rd/projects/dirac/index.shtml)
4  *          ##
5  *          ## NB, this is a temporary encoder only module until schroedinger
6  *          ## offers superior encoding quality than dirac-research
7  *          ##
8  *****************************************************************************
9  * Copyright (C) 2004-2008 the VideoLAN team
10  * $Id$
11  *
12  * Authors: Gildas Bazin <gbazin@videolan.org>
13  * Rewritten: David Flynn <davidf at rd.bbc.co.uk>
14  *
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28  *****************************************************************************/
29
30 /*****************************************************************************
31  * Preamble
32  *****************************************************************************/
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
36
37 #include <limits.h>
38 #include <assert.h>
39
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
42 #include <vlc_codec.h>
43 #include <vlc_sout.h>
44
45 #include <libdirac_encoder/dirac_encoder.h>
46
47 #ifndef DIRAC_RESEARCH_VERSION_ATLEAST
48 # define DIRAC_RESEARCH_VERSION_ATLEAST(x,y,z) 0
49 #endif
50
51 /*****************************************************************************
52  * Local prototypes
53  *****************************************************************************/
54 static int  OpenEncoder( vlc_object_t *p_this );
55 static void CloseEncoder( vlc_object_t *p_this );
56 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict );
57
58 #define ENC_CFG_PREFIX "sout-dirac-"
59
60 #define ENC_QUALITY_FACTOR "quality"
61 #define ENC_QUALITY_FACTOR_TEXT N_("Constant quality factor")
62 #define ENC_QUALITY_FACTOR_LONGTEXT N_("If bitrate=0, use this value for constant quality")
63
64 #define ENC_TARGETRATE "bitrate"
65 #define ENC_TARGETRATE_TEXT N_("CBR bitrate (kbps)")
66 #define ENC_TARGETRATE_LONGTEXT N_("A value > 0 enables constant bitrate mode")
67
68 #define ENC_LOSSLESS "lossless"
69 #define ENC_LOSSLESS_TEXT N_("Enable lossless coding")
70 #define ENC_LOSSLESS_LONGTEXT N_("Lossless coding ignores bitrate and quality settings, " \
71                                  "allowing for perfect reproduction of the original")
72
73 #define ENC_PREFILTER "prefilter"
74 #define ENC_PREFILTER_TEXT N_("Prefilter")
75 #define ENC_PREFILTER_LONGTEXT N_("Enable adaptive prefiltering")
76 static const char *const enc_prefilter_list[] =
77   { "none", "cwm", "rectlp", "diaglp" };
78 static const char *const enc_prefilter_list_text[] =
79   { N_("none"), N_("Centre Weighted Median"),
80     N_("Rectangular Linear Phase"), N_("Diagonal Linear Phase") };
81
82 #define ENC_PREFILTER_STRENGTH "prefilter-strength"
83 #define ENC_PREFILTER_STRENGTH_TEXT N_("Amount of prefiltering")
84 #define ENC_PREFILTER_STRENGTH_LONGTEXT N_("Higher value implies more prefiltering")
85
86 #define ENC_CHROMAFMT "chroma-fmt"
87 #define ENC_CHROMAFMT_TEXT N_("Chroma format")
88 #define ENC_CHROMAFMT_LONGTEXT N_("Picking chroma format will force a " \
89                                   "conversion of the video into that format")
90 static const char *const enc_chromafmt_list[] =
91   { "420", "422", "444" };
92 static const char *const enc_chromafmt_list_text[] =
93   { N_("4:2:0"), N_("4:2:2"), N_("4:4:4") };
94
95 #define ENC_L1SEP "l1-sep"
96 #define ENC_L1SEP_TEXT N_("Distance between 'P' frames")
97 #define ENC_L1SEP_LONGTEXT ENC_L1SEP_TEXT
98
99 #define ENC_L1NUM "num-l1"
100 #define ENC_L1NUM_TEXT N_("Number of 'P' frames per GOP")
101 #define ENC_L1NUM_LONGTEXT ENC_L1NUM_TEXT
102
103 #define ENC_CODINGMODE "coding-mode"
104 #define ENC_CODINGMODE_TEXT N_("Picture coding mode")
105 #define ENC_CODINGMODE_LONGTEXT N_("Field coding is where interlaced fields are coded" \
106                                    " seperately as opposed to a pseudo-progressive frame")
107 static const char *const enc_codingmode_list[] =
108   { "auto", "progressive", "field" };
109 static const char *const enc_codingmode_list_text[] =
110   { N_("auto - let encoder decide based upon input (Best)"),
111     N_("force coding frame as single picture"),
112     N_("force coding frame as seperate interlaced fields"),
113   };
114
115 #define ENC_MCBLK_WIDTH "mc-blk-width"
116 #define ENC_MCBLK_WIDTH_TEXT N_("Width of motion compensation blocks")
117 #define ENC_MCBLK_WIDTH_LONGTEXT ""
118
119 #define ENC_MCBLK_HEIGHT "mc-blk-height"
120 #define ENC_MCBLK_HEIGHT_TEXT N_("Height of motion compensation blocks")
121 #define ENC_MCBLK_HEIGHT_LONGTEXT ""
122
123 /* also known as XBSEP and YBSEP */
124 #define ENC_MCBLK_OVERLAP "mc-blk-overlap"
125 #define ENC_MCBLK_OVERLAP_TEXT N_("Block overlap (%)")
126 #define ENC_MCBLK_OVERLAP_LONGTEXT N_("Amount that each motion block should " \
127                                        "be overlapped by its neighbours")
128
129 /* advanced option only */
130 #define ENC_MCBLK_XBLEN "mc-blk-xblen"
131 #define ENC_MCBLK_XBLEN_TEXT N_("xblen")
132 #define ENC_MCBLK_XBLEN_LONGTEXT N_("Total horizontal block length including overlaps")
133
134 /* advanded option only */
135 #define ENC_MCBLK_YBLEN "mc-blk-yblen"
136 #define ENC_MCBLK_YBLEN_TEXT N_("yblen")
137 #define ENC_MCBLK_YBLEN_LONGTEXT N_("Total vertical block length including overlaps")
138
139 #define ENC_MVPREC "mv-prec"
140 #define ENC_MVPREC_TEXT N_("Motion vector precision")
141 #define ENC_MVPREC_LONGTEXT N_("Motion vector precision in pels.")
142 static const char *const enc_mvprec_list[] =
143   { "1", "1/2", "1/4", "1/8" };
144
145 #define ENC_ME_SIMPLESEARCH "me-simple-search"
146 #define ENC_ME_SIMPLESEARCH_TEXT N_("Simple ME search area x:y")
147 #define ENC_ME_SIMPLESEARCH_LONGTEXT N_("(Not recommended) Perform a simple (non hierarchical " \
148                                         "block matching motion vector search with search range " \
149                                         "of +/-x, +/-y")
150
151 #define ENC_ME_COMBINED "me-combined"
152 #define ENC_ME_COMBINED_TEXT N_("Three component motion estimation")
153 #define ENC_ME_COMBINED_LONGTEXT N_("Use chroma as part of the motion estimation process")
154
155 #define ENC_DWTINTRA "dwt-intra"
156 #define ENC_DWTINTRA_TEXT N_("Intra picture DWT filter")
157 #define ENC_DWTINTRA_LONGTEXT ENC_DWTINTRA_TEXT
158
159 #define ENC_DWTINTER "dwt-inter"
160 #define ENC_DWTINTER_TEXT N_("Inter picture DWT filter")
161 #define ENC_DWTINTER_LONGTEXT ENC_DWTINTER_TEXT
162
163 #define ENC_DWTDEPTH "dwt-depth"
164 #define ENC_DWTDEPTH_TEXT N_("Number of DWT iterations")
165 #define ENC_DWTDEPTH_LONGTEXT N_("Also known as DWT levels")
166
167 /* advanced option only */
168 #define ENC_MULTIQUANT "multi-quant"
169 #define ENC_MULTIQUANT_TEXT N_("Enable multiple quantizers")
170 #define ENC_MULTIQUANT_LONGTEXT N_("Enable multiple quantizers per subband (one per codeblock)")
171
172 /* advanced option only */
173 #define ENC_SPARTITION "spartition"
174 #define ENC_SPARTITION_TEXT N_("Enable spatial partitioning")
175 #define ENC_SPARTITION_LONGTEXT ENC_SPARTITION_TEXT
176
177 #define ENC_NOAC "noac"
178 #define ENC_NOAC_TEXT N_("Disable arithmetic coding")
179 #define ENC_NOAC_LONGTEXT N_("Use variable length codes instead, useful for very high bitrates")
180
181 /* visual modelling */
182 /* advanced option only */
183 #define ENC_CPD "cpd"
184 #define ENC_CPD_TEXT N_("cycles per degree")
185 #define ENC_CPD_LONGTEXT ENC_CPD_TEXT
186
187 static const char *const ppsz_enc_options[] = {
188     ENC_QUALITY_FACTOR, ENC_TARGETRATE, ENC_LOSSLESS, ENC_PREFILTER, ENC_PREFILTER_STRENGTH,
189     ENC_CHROMAFMT, ENC_L1SEP, ENC_L1NUM, ENC_CODINGMODE,
190     ENC_MCBLK_WIDTH, ENC_MCBLK_HEIGHT, ENC_MCBLK_OVERLAP,
191     ENC_MVPREC, ENC_ME_SIMPLESEARCH, ENC_ME_COMBINED,
192     ENC_DWTINTRA, ENC_DWTINTER, ENC_DWTDEPTH,
193     ENC_MULTIQUANT, ENC_SPARTITION, ENC_NOAC,
194     ENC_CPD,
195     NULL
196 };
197
198
199 /*****************************************************************************
200  * Module descriptor
201  *****************************************************************************/
202
203 vlc_module_begin()
204     set_category( CAT_INPUT )
205     set_subcategory( SUBCAT_INPUT_VCODEC )
206     set_description( N_("Dirac video encoder using dirac-research library") )
207     set_shortname( "Dirac" )
208     set_capability( "encoder", 100 )
209     set_callbacks( OpenEncoder, CloseEncoder )
210
211     add_float( ENC_CFG_PREFIX ENC_QUALITY_FACTOR, 5.5, NULL,
212                ENC_QUALITY_FACTOR_TEXT, ENC_QUALITY_FACTOR_LONGTEXT, false )
213     change_float_range(0., 10.);
214
215     add_integer( ENC_CFG_PREFIX ENC_TARGETRATE, -1, NULL,
216                  ENC_TARGETRATE_TEXT, ENC_TARGETRATE_LONGTEXT, false )
217     change_integer_range(-1, INT_MAX);
218
219     add_bool( ENC_CFG_PREFIX ENC_LOSSLESS, false, NULL,
220               ENC_LOSSLESS_TEXT, ENC_LOSSLESS_LONGTEXT, false )
221
222     add_string( ENC_CFG_PREFIX ENC_PREFILTER, "diaglp", NULL,
223                 ENC_PREFILTER_TEXT, ENC_PREFILTER_LONGTEXT, false )
224     change_string_list( enc_prefilter_list, enc_prefilter_list_text, 0 );
225
226     add_integer( ENC_CFG_PREFIX ENC_PREFILTER_STRENGTH, 1, NULL,
227                  ENC_PREFILTER_STRENGTH_TEXT, ENC_PREFILTER_STRENGTH_LONGTEXT, false )
228     change_integer_range(0, 10);
229
230     add_string( ENC_CFG_PREFIX ENC_CHROMAFMT, "420", NULL,
231                 ENC_CHROMAFMT_TEXT, ENC_CHROMAFMT_LONGTEXT, false )
232     change_string_list( enc_chromafmt_list, enc_chromafmt_list_text, 0 );
233
234     add_integer( ENC_CFG_PREFIX ENC_L1SEP, -1, NULL,
235                  ENC_L1SEP_TEXT, ENC_L1SEP_LONGTEXT, false )
236     change_integer_range(-1, INT_MAX);
237
238     add_integer( ENC_CFG_PREFIX ENC_L1NUM, -1, NULL,
239                  ENC_L1NUM_TEXT, ENC_L1NUM_LONGTEXT, false )
240     change_integer_range(-1, INT_MAX);
241
242     add_string( ENC_CFG_PREFIX ENC_CODINGMODE, "auto", NULL,
243                 ENC_CODINGMODE_TEXT, ENC_CODINGMODE_LONGTEXT, false )
244     change_string_list( enc_codingmode_list, enc_codingmode_list_text, 0 );
245
246     add_string( ENC_CFG_PREFIX ENC_MVPREC, "1/2", NULL,
247                 ENC_MVPREC_TEXT, ENC_MVPREC_LONGTEXT, false )
248     change_string_list( enc_mvprec_list, enc_mvprec_list, 0 );
249
250     add_integer( ENC_CFG_PREFIX ENC_MCBLK_WIDTH, -1, NULL,
251                  ENC_MCBLK_WIDTH_TEXT, ENC_MCBLK_WIDTH_LONGTEXT, false )
252     add_deprecated_alias( ENC_CFG_PREFIX ENC_MCBLK_XBLEN );
253     change_integer_range(-1, INT_MAX);
254
255     add_integer( ENC_CFG_PREFIX ENC_MCBLK_HEIGHT, -1, NULL,
256                  ENC_MCBLK_HEIGHT, ENC_MCBLK_HEIGHT_LONGTEXT, false )
257     add_deprecated_alias( ENC_CFG_PREFIX ENC_MCBLK_YBLEN );
258     change_integer_range(-1, INT_MAX);
259
260     add_integer( ENC_CFG_PREFIX ENC_MCBLK_OVERLAP, -1, NULL,
261                  ENC_MCBLK_OVERLAP_TEXT, ENC_MCBLK_OVERLAP_LONGTEXT, false )
262     change_integer_range(-1, 100);
263
264     /* advanced option only */
265     add_integer( ENC_CFG_PREFIX ENC_MCBLK_XBLEN, -1, NULL,
266                  ENC_MCBLK_XBLEN_TEXT, ENC_MCBLK_XBLEN_LONGTEXT, true )
267     change_integer_range(-1, INT_MAX);
268     /* advanced option only */
269     add_integer( ENC_CFG_PREFIX ENC_MCBLK_YBLEN, -1, NULL,
270                  ENC_MCBLK_YBLEN_TEXT, ENC_MCBLK_YBLEN_LONGTEXT, true )
271     change_integer_range(-1, INT_MAX);
272
273     add_string( ENC_CFG_PREFIX ENC_ME_SIMPLESEARCH, "", NULL,
274               ENC_ME_SIMPLESEARCH_TEXT, ENC_ME_SIMPLESEARCH_LONGTEXT, false )
275
276 #if DIRAC_RESEARCH_VERSION_ATLEAST(1,0,1)
277     add_bool( ENC_CFG_PREFIX ENC_ME_COMBINED, true, NULL,
278               ENC_ME_COMBINED_TEXT, ENC_ME_COMBINED_LONGTEXT, false )
279 #endif
280
281     add_integer( ENC_CFG_PREFIX ENC_DWTINTRA, -1, NULL,
282                  ENC_DWTINTRA_TEXT, ENC_DWTINTRA_LONGTEXT, false )
283     change_integer_range(-1, 6);
284
285     add_integer( ENC_CFG_PREFIX ENC_DWTINTER, -1, NULL,
286                  ENC_DWTINTER_TEXT, ENC_DWTINTER_LONGTEXT, false )
287     change_integer_range(-1, 6);
288
289     add_integer( ENC_CFG_PREFIX ENC_DWTDEPTH, -1, NULL,
290                  ENC_DWTDEPTH_TEXT, ENC_DWTDEPTH_LONGTEXT, false )
291     change_integer_range(-1, 4);
292
293     /* advanced option only */
294     /* NB, unforunately vlc doesn't have a concept of 'dont care' */
295     add_integer( ENC_CFG_PREFIX ENC_MULTIQUANT, -1, NULL,
296                  ENC_MULTIQUANT_TEXT, ENC_MULTIQUANT_LONGTEXT, true )
297     change_integer_range(-1, 1);
298
299     /* advanced option only */
300     /* NB, unforunately vlc doesn't have a concept of 'dont care' */
301     add_integer( ENC_CFG_PREFIX ENC_SPARTITION, -1, NULL,
302                  ENC_SPARTITION_TEXT, ENC_SPARTITION_LONGTEXT, true )
303     change_integer_range(-1, 1);
304
305     add_bool( ENC_CFG_PREFIX ENC_NOAC, false, NULL,
306               ENC_NOAC_TEXT, ENC_NOAC_LONGTEXT, false )
307
308     /* advanced option only */
309     add_float( ENC_CFG_PREFIX ENC_CPD, -1, NULL,
310                ENC_CPD_TEXT, ENC_CPD_LONGTEXT, true )
311     change_integer_range(-1, INT_MAX);
312 vlc_module_end()
313
314 /*****************************************************************************
315  * picture_pts_t : store pts alongside picture number, not carried through
316  * encoder
317  *****************************************************************************/
318 struct picture_pts_t
319 {
320    bool b_empty;      /* entry is invalid */
321    uint32_t u_pnum;  /* dirac picture number */
322    mtime_t i_pts;    /* associated pts */
323 };
324
325 /*****************************************************************************
326  * encoder_sys_t : dirac encoder descriptor
327  *****************************************************************************/
328 #define PTS_TLB_SIZE 256
329 struct encoder_sys_t
330 {
331     dirac_encoder_t *p_dirac;
332     dirac_encoder_context_t ctx;
333     bool b_auto_field_coding;
334
335     uint8_t *p_buffer_in;
336     int i_buffer_in;
337     uint32_t i_input_picnum;
338     block_fifo_t *p_dts_fifo;
339
340     int i_buffer_out;
341     uint8_t *p_buffer_out;
342     block_t *p_chain;
343
344     struct picture_pts_t pts_tlb[PTS_TLB_SIZE];
345     mtime_t i_pts_offset;
346     mtime_t i_field_time;
347 };
348
349 static struct
350 {
351     unsigned int i_height;
352     int i_approx_fps;
353     VideoFormat i_vf;
354 } dirac_format_guess[] = {
355     /* Important: Keep this list ordered in ascending picture height */
356     {1, 0, VIDEO_FORMAT_CUSTOM},
357     {120, 15, VIDEO_FORMAT_QSIF525},
358     {144, 12, VIDEO_FORMAT_QCIF},
359     {240, 15, VIDEO_FORMAT_SIF525},
360     {288, 12, VIDEO_FORMAT_CIF},
361     {480, 30, VIDEO_FORMAT_SD_480I60},
362     {480, 15, VIDEO_FORMAT_4SIF525},
363     {576, 12, VIDEO_FORMAT_4CIF},
364     {576, 25, VIDEO_FORMAT_SD_576I50},
365     {720, 50, VIDEO_FORMAT_HD_720P50},
366     {720, 60, VIDEO_FORMAT_HD_720P60},
367     {1080, 24, VIDEO_FORMAT_DIGI_CINEMA_2K24},
368     {1080, 25, VIDEO_FORMAT_HD_1080I50},
369     {1080, 30, VIDEO_FORMAT_HD_1080I60},
370     {1080, 50, VIDEO_FORMAT_HD_1080P50},
371     {1080, 60, VIDEO_FORMAT_HD_1080P60},
372     {2160, 24, VIDEO_FORMAT_DIGI_CINEMA_4K24},
373     {2160, 50, VIDEO_FORMAT_UHDTV_4K50},
374     {2160, 60, VIDEO_FORMAT_UHDTV_4K60},
375     {3840, 50, VIDEO_FORMAT_UHDTV_8K50},
376     {3840, 60, VIDEO_FORMAT_UHDTV_8K60},
377     {0, 0, 0},
378 };
379
380 /*****************************************************************************
381  * ResetPTStlb: Purge all entries in @p_dec@'s PTS-tlb
382  *****************************************************************************/
383 static void ResetPTStlb( encoder_t *p_enc )
384 {
385     encoder_sys_t *p_sys = p_enc->p_sys;
386     for( int i=0; i<PTS_TLB_SIZE; i++)
387     {
388         p_sys->pts_tlb[i].b_empty = true;
389     }
390 }
391
392 /*****************************************************************************
393  * StorePicturePTS: Store the PTS value for a particular picture number
394  *****************************************************************************/
395 static void StorePicturePTS( encoder_t *p_enc, uint32_t u_pnum, mtime_t i_pts )
396 {
397     encoder_sys_t *p_sys = p_enc->p_sys;
398
399     for( int i=0; i<PTS_TLB_SIZE; i++ )
400     {
401         if( p_sys->pts_tlb[i].b_empty )
402         {
403             p_sys->pts_tlb[i].u_pnum = u_pnum;
404             p_sys->pts_tlb[i].i_pts = i_pts;
405             p_sys->pts_tlb[i].b_empty = false;
406
407             return;
408         }
409     }
410
411     msg_Err( p_enc, "Could not store PTS %"PRId64" for frame %u", i_pts, u_pnum );
412 }
413
414 /*****************************************************************************
415  * GetPicturePTS: Retrieve the PTS value for a particular picture number
416  *****************************************************************************/
417 static mtime_t GetPicturePTS( encoder_t *p_enc, uint32_t u_pnum )
418 {
419     encoder_sys_t *p_sys = p_enc->p_sys;
420
421     for( int i=0; i<PTS_TLB_SIZE; i++ )
422     {
423         if( !p_sys->pts_tlb[i].b_empty &&
424             p_sys->pts_tlb[i].u_pnum == u_pnum )
425         {
426              p_sys->pts_tlb[i].b_empty = true;
427              return p_sys->pts_tlb[i].i_pts;
428         }
429     }
430
431     msg_Err( p_enc, "Could not retrieve PTS for picture %u", u_pnum );
432     return 0;
433 }
434
435 /*****************************************************************************
436  * OpenEncoder: probe the encoder and return score
437  *****************************************************************************/
438 static int OpenEncoder( vlc_object_t *p_this )
439 {
440     encoder_t *p_enc = (encoder_t *)p_this;
441     encoder_sys_t *p_sys = p_enc->p_sys;
442     int i_tmp;
443     float f_tmp;
444     char *psz_tmp;
445
446     if( p_enc->fmt_out.i_codec != VLC_CODEC_DIRAC &&
447         !p_enc->b_force )
448     {
449         return VLC_EGENERIC;
450     }
451
452     if( !p_enc->fmt_in.video.i_frame_rate || !p_enc->fmt_in.video.i_frame_rate_base ||
453         !p_enc->fmt_in.video.i_height || !p_enc->fmt_in.video.i_width )
454     {
455         msg_Err( p_enc, "Framerate and picture dimensions must be non-zero" );
456         return VLC_EGENERIC;
457     }
458
459     /* Allocate the memory needed to store the decoder's structure */
460     if( ( p_sys = calloc( 1, sizeof(*p_sys) ) ) == NULL )
461         return VLC_ENOMEM;
462
463     p_enc->p_sys = p_sys;
464     p_enc->pf_encode_video = Encode;
465     p_enc->fmt_out.i_codec = VLC_CODEC_DIRAC;
466     p_enc->fmt_out.i_cat = VIDEO_ES;
467
468     if( ( p_sys->p_dts_fifo = block_FifoNew() ) == NULL )
469     {
470         CloseEncoder( p_this );
471         return VLC_ENOMEM;
472     }
473
474     ResetPTStlb( p_enc );
475
476     /* guess the video format based upon number of lines and picture height */
477     int i = 0;
478     VideoFormat guessed_video_fmt = VIDEO_FORMAT_CUSTOM;
479     /* Pick the dirac_video_format in this order of preference:
480      *  1. an exact match in frame height and an approximate fps match
481      *  2. the previous preset with a smaller number of lines.
482      */
483     do
484     {
485         if( dirac_format_guess[i].i_height > p_enc->fmt_in.video.i_height )
486         {
487             guessed_video_fmt = dirac_format_guess[i-1].i_vf;
488             break;
489         }
490         if( dirac_format_guess[i].i_height != p_enc->fmt_in.video.i_height )
491             continue;
492         int src_fps = p_enc->fmt_in.video.i_frame_rate / p_enc->fmt_in.video.i_frame_rate_base;
493         int delta_fps = abs( dirac_format_guess[i].i_approx_fps - src_fps );
494         if( delta_fps > 2 )
495             continue;
496
497         guessed_video_fmt = dirac_format_guess[i].i_vf;
498         break;
499     } while( dirac_format_guess[++i].i_height );
500
501     dirac_encoder_context_init( &p_sys->ctx, guessed_video_fmt );
502
503     /* constants set from the input video format */
504     p_sys->ctx.src_params.width = p_enc->fmt_in.video.i_width;
505     p_sys->ctx.src_params.height = p_enc->fmt_in.video.i_height;
506     p_sys->ctx.src_params.frame_rate.numerator = p_enc->fmt_in.video.i_frame_rate;
507     p_sys->ctx.src_params.frame_rate.denominator = p_enc->fmt_in.video.i_frame_rate_base;
508     unsigned u_asr_num, u_asr_den;
509     vlc_ureduce( &u_asr_num, &u_asr_den,
510                  p_enc->fmt_in.video.i_sar_num,
511                  p_enc->fmt_in.video.i_sar_den, 0 );
512     p_sys->ctx.src_params.pix_asr.numerator = u_asr_num;
513     p_sys->ctx.src_params.pix_asr.denominator = u_asr_den;
514
515     config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
516
517     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_CHROMAFMT );
518     if( !psz_tmp )
519         goto error;
520     else if( !strcmp( psz_tmp, "420" ) ) {
521         p_enc->fmt_in.i_codec = VLC_CODEC_I420;
522         p_enc->fmt_in.video.i_bits_per_pixel = 12;
523         p_sys->ctx.src_params.chroma = format420;
524         p_sys->i_buffer_in = p_enc->fmt_in.video.i_width * p_enc->fmt_in.video.i_height * 3 / 2;
525     }
526     else if( !strcmp( psz_tmp, "422" ) ) {
527         p_enc->fmt_in.i_codec = VLC_CODEC_I422;
528         p_enc->fmt_in.video.i_bits_per_pixel = 16;
529         p_sys->ctx.src_params.chroma = format422;
530         p_sys->i_buffer_in = p_enc->fmt_in.video.i_width * p_enc->fmt_in.video.i_height * 2;
531     }
532     else if( !strcmp( psz_tmp, "444" ) ) {
533         p_enc->fmt_in.i_codec = VLC_CODEC_I444;
534         p_enc->fmt_in.video.i_bits_per_pixel = 24;
535         p_sys->ctx.src_params.chroma = format444;
536         p_sys->i_buffer_in = p_enc->fmt_in.video.i_width * p_enc->fmt_in.video.i_height * 3;
537     }
538     else {
539         msg_Err( p_enc, "Invalid chroma format: %s", psz_tmp );
540         free( psz_tmp );
541         goto error;
542     }
543     free( psz_tmp );
544
545     p_sys->ctx.enc_params.qf = var_GetFloat( p_enc, ENC_CFG_PREFIX ENC_QUALITY_FACTOR );
546
547     /* use bitrate from sout-transcode-vb in kbps */
548     p_sys->ctx.enc_params.trate = p_enc->fmt_out.i_bitrate / 1000;
549     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_TARGETRATE );
550     if( i_tmp > -1 )
551         p_sys->ctx.enc_params.trate = i_tmp;
552     p_enc->fmt_out.i_bitrate = p_sys->ctx.enc_params.trate * 1000;
553
554     p_sys->ctx.enc_params.lossless = var_GetBool( p_enc, ENC_CFG_PREFIX ENC_LOSSLESS );
555
556     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_PREFILTER );
557     if( !psz_tmp )
558         goto error;
559     else if( !strcmp( psz_tmp, "none" ) ) {
560         p_sys->ctx.enc_params.prefilter = NO_PF;
561     }
562     else if( !strcmp( psz_tmp, "cwm" ) ) {
563         p_sys->ctx.enc_params.prefilter = CWM;
564     }
565     else if( !strcmp( psz_tmp, "rectlp" ) ) {
566         p_sys->ctx.enc_params.prefilter = RECTLP;
567     }
568     else if( !strcmp( psz_tmp, "diaglp" ) ) {
569         p_sys->ctx.enc_params.prefilter = DIAGLP;
570     }
571     else {
572         msg_Err( p_enc, "Invalid prefilter: %s", psz_tmp );
573         free( psz_tmp );
574         goto error;
575     }
576     free( psz_tmp );
577
578     p_sys->ctx.enc_params.prefilter_strength =
579         var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_PREFILTER_STRENGTH );
580
581     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_L1SEP );
582     if( i_tmp > -1 )
583         p_sys->ctx.enc_params.L1_sep = i_tmp;
584
585     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_L1NUM );
586     if( i_tmp > -1 )
587         p_sys->ctx.enc_params.num_L1 = i_tmp;
588
589     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_CODINGMODE );
590     if( !psz_tmp )
591         goto error;
592     else if( !strcmp( psz_tmp, "auto" ) ) {
593         p_sys->b_auto_field_coding = true;
594     }
595     else if( !strcmp( psz_tmp, "progressive" ) ) {
596         p_sys->b_auto_field_coding = false;
597         p_sys->ctx.enc_params.picture_coding_mode = 0;
598     }
599     else if( !strcmp( psz_tmp, "field" ) ) {
600         p_sys->b_auto_field_coding = false;
601         p_sys->ctx.enc_params.picture_coding_mode = 1;
602     }
603     else {
604         msg_Err( p_enc, "Invalid codingmode: %s", psz_tmp );
605         free( psz_tmp );
606         goto error;
607     }
608     free( psz_tmp );
609
610     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_MVPREC );
611     if( !psz_tmp )
612         goto error;
613     else if( !strcmp( psz_tmp, "1" ) ) {
614         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_PIXEL;
615     }
616     else if( !strcmp( psz_tmp, "1/2" ) ) {
617         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_HALF_PIXEL;
618     }
619     else if( !strcmp( psz_tmp, "1/4" ) ) {
620         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_QUARTER_PIXEL;
621     }
622     else if( !strcmp( psz_tmp, "1/8" ) ) {
623         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_EIGHTH_PIXEL;
624     }
625     else {
626         msg_Err( p_enc, "Invalid mv-prec: %s", psz_tmp );
627         free( psz_tmp );
628         goto error;
629     }
630     free( psz_tmp );
631
632     /*
633      * {x,y}b{len,sep} must be multiples of 4
634      */
635     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_WIDTH );
636     if( i_tmp > -1 )
637         p_sys->ctx.enc_params.xbsep = i_tmp / 4 * 4;
638
639     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_HEIGHT );
640     if( i_tmp > -1 )
641         p_sys->ctx.enc_params.ybsep = i_tmp / 4 * 4;
642
643     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_OVERLAP );
644     if( i_tmp > -1 ) {
645         p_sys->ctx.enc_params.xblen = p_sys->ctx.enc_params.xbsep * (100 + i_tmp) / 400 * 4;
646         p_sys->ctx.enc_params.yblen = p_sys->ctx.enc_params.ybsep * (100 + i_tmp) / 400 * 4;
647     }
648
649     /*
650      * {x,y}blen >= {x,y}bsep
651      * {x,y}blen <= 2* {x,y}bsep
652      */
653     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_XBLEN );
654     if( i_tmp > -1 ) {
655         int xblen = __MAX( i_tmp, p_sys->ctx.enc_params.xbsep );
656         xblen = __MIN( xblen, 2 * p_sys->ctx.enc_params.xbsep );
657         p_sys->ctx.enc_params.xblen = xblen;
658     }
659
660     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_YBLEN );
661     if( i_tmp > -1 ) {
662         int yblen = __MAX( i_tmp, p_sys->ctx.enc_params.ybsep );
663         yblen = __MIN( yblen, 2 * p_sys->ctx.enc_params.ybsep );
664         p_sys->ctx.enc_params.yblen = yblen;
665     }
666
667     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_ME_SIMPLESEARCH );
668     if( !psz_tmp )
669         goto error;
670     if( *psz_tmp != '\0' ) {
671         /* of the form [0-9]+:[0-9]+ */
672         char *psz_start = psz_tmp;
673         char *psz_end = psz_tmp;
674         p_sys->ctx.enc_params.x_range_me = strtol(psz_start, &psz_end, 10);
675         if( *psz_end != ':'  || psz_end == psz_start ) {
676             msg_Err( p_enc, "Invalid simple search range: %s", psz_tmp );
677             free( psz_tmp );
678             goto error;
679         }
680         psz_start = ++psz_end;
681         p_sys->ctx.enc_params.y_range_me = strtol(psz_start, &psz_end, 10);
682         if( *psz_end != '\0'  || psz_end == psz_start ) {
683             msg_Err( p_enc, "Invalid simple search range: %s", psz_tmp );
684             free( psz_tmp );
685             goto error;
686         }
687         if( p_sys->ctx.enc_params.x_range_me < 0 ||
688             p_sys->ctx.enc_params.y_range_me < 0 )
689         {
690             msg_Err( p_enc, "Invalid negative simple search range: %s", psz_tmp );
691             free( psz_tmp );
692             goto error;
693         }
694         p_sys->ctx.enc_params.full_search = 1;
695     }
696     free( psz_tmp );
697
698 #if DIRAC_RESEARCH_VERSION_ATLEAST(1,0,1)
699     p_sys->ctx.enc_params.combined_me = var_GetBool( p_enc, ENC_CFG_PREFIX ENC_ME_COMBINED );
700 #endif
701
702     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_DWTINTRA );
703     if( i_tmp > -1 )
704         p_sys->ctx.enc_params.intra_wlt_filter = i_tmp;
705
706     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_DWTINTER );
707     if( i_tmp > -1 )
708         p_sys->ctx.enc_params.inter_wlt_filter = i_tmp;
709
710     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_DWTDEPTH );
711     if( i_tmp > -1 )
712         p_sys->ctx.enc_params.wlt_depth = i_tmp;
713
714     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MULTIQUANT );
715     if( i_tmp > -1 )
716         p_sys->ctx.enc_params.multi_quants = i_tmp;
717
718     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_SPARTITION );
719     if( i_tmp > -1 )
720         p_sys->ctx.enc_params.spatial_partition = i_tmp;
721
722     p_sys->ctx.enc_params.using_ac = !var_GetBool( p_enc, ENC_CFG_PREFIX ENC_NOAC );
723
724     f_tmp = var_GetFloat( p_enc, ENC_CFG_PREFIX ENC_CPD );
725     if( f_tmp > -1 )
726         p_sys->ctx.enc_params.cpd = f_tmp;
727
728     /* Allocate the buffer for inputing frames into the encoder */
729     if( ( p_sys->p_buffer_in = malloc( p_sys->i_buffer_in ) ) == NULL )
730     {
731         CloseEncoder( p_this );
732         return VLC_ENOMEM;
733     }
734
735     /* Set up output buffer */
736     /* Unfortunately it isn't possible to determine if the buffer
737      * is too small (and then reallocate it) */
738     p_sys->i_buffer_out = 4096 + p_sys->i_buffer_in;
739     if( ( p_sys->p_buffer_out = malloc( p_sys->i_buffer_out ) ) == NULL )
740     {
741         CloseEncoder( p_this );
742         return VLC_ENOMEM;
743     }
744
745     return VLC_SUCCESS;
746 error:
747     CloseEncoder( p_this );
748     return VLC_EGENERIC;
749 }
750
751 /* Attempt to find dirac picture number in an encapsulation unit */
752 static int ReadDiracPictureNumber( uint32_t *p_picnum, block_t *p_block )
753 {
754     uint32_t u_pos = 4;
755     /* protect against falling off the edge */
756     while( u_pos + 13 < p_block->i_buffer )
757     {
758         /* find the picture startcode */
759         if( p_block->p_buffer[u_pos] & 0x08 )
760         {
761             *p_picnum = GetDWBE( p_block->p_buffer + u_pos + 9 );
762             return 1;
763         }
764         /* skip to the next dirac data unit */
765         uint32_t u_npo = GetDWBE( p_block->p_buffer + u_pos + 1 );
766         assert( u_npo <= UINT32_MAX - u_pos );
767         if( u_npo == 0 )
768             u_npo = 13;
769         u_pos += u_npo;
770     }
771     return 0;
772 }
773
774 /****************************************************************************
775  * Encode: the whole thing
776  ****************************************************************************
777  * This function spits out encapsulation units.
778  ****************************************************************************/
779 static block_t *Encode( encoder_t *p_enc, picture_t *p_pic )
780 {
781     encoder_sys_t *p_sys = p_enc->p_sys;
782     block_t *p_block, *p_output_chain = NULL;
783     int i_plane, i_line, i_width, i_src_stride;
784     uint8_t *p_dst;
785
786     /* we only know if the sequence is interlaced when the first
787      * picture arrives, so final setup is done here */
788     /* XXX todo, detect change of interlace */
789     p_sys->ctx.src_params.topfieldfirst = p_pic->b_top_field_first;
790     p_sys->ctx.src_params.source_sampling = !p_pic->b_progressive;
791
792     if( p_sys->b_auto_field_coding )
793         p_sys->ctx.enc_params.picture_coding_mode = !p_pic->b_progressive;
794
795     if( !p_sys->p_dirac )
796     {
797         date_t date;
798         /* Initialise the encoder with the encoder context */
799         p_sys->p_dirac = dirac_encoder_init( &p_sys->ctx, 0 );
800         if( !p_sys->p_dirac )
801         {
802             msg_Err( p_enc, "Failed to initialize dirac encoder" );
803             return NULL;
804         }
805         date_Init( &date, p_enc->fmt_in.video.i_frame_rate, p_enc->fmt_in.video.i_frame_rate_base );
806 #if DIRAC_RESEARCH_VERSION_ATLEAST(1,0,2)
807         int i_delayinpics = dirac_encoder_pts_offset( p_sys->p_dirac );
808         i_delayinpics /= p_sys->ctx.enc_params.picture_coding_mode + 1;
809         date_Increment( &date, i_delayinpics );
810 #else
811         date_Increment( &date, 1 );
812 #endif
813         p_sys->i_pts_offset = date_Get( &date );
814
815         /* picture_coding_mode = 1 == FIELD_CODING, two pictures are produced
816          * for each frame input. Calculate time between fields for offsetting
817          * the second field later. */
818         if( 1 == p_sys->ctx.enc_params.picture_coding_mode )
819         {
820             date_Set( &date, 0 );
821             date_Increment( &date, 1 );
822             p_sys->i_field_time = date_Get( &date ) / 2;
823         }
824     }
825
826     /* Copy input picture into encoder input buffer (stride by stride) */
827     /* Would be lovely to just pass the picture in, but there is noway for the
828      * library to free it */
829     p_dst = p_sys->p_buffer_in;
830     for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
831     {
832         uint8_t *p_src = p_pic->p[i_plane].p_pixels;
833         i_width = p_pic->p[i_plane].i_visible_pitch;
834         i_src_stride = p_pic->p[i_plane].i_pitch;
835
836         for( i_line = 0; i_line < p_pic->p[i_plane].i_visible_lines; i_line++ )
837         {
838             vlc_memcpy( p_dst, p_src, i_width );
839             p_dst += i_width;
840             p_src += i_src_stride;
841         }
842     }
843
844     /* Load one frame of data into encoder */
845     if( dirac_encoder_load( p_sys->p_dirac, p_sys->p_buffer_in,
846                             p_sys->i_buffer_in ) < 0 )
847     {
848         msg_Dbg( p_enc, "dirac_encoder_load() error" );
849         return NULL;
850     }
851
852     /* store pts in a lookaside buffer, so that the same pts may
853      * be used for the picture in coded order */
854     StorePicturePTS( p_enc, p_sys->i_input_picnum, p_pic->date );
855     p_sys->i_input_picnum++;
856
857     /* store dts in a queue, so that they appear in order in
858      * coded order */
859     p_block = block_New( p_enc, 1 );
860     if( !p_block )
861         return NULL;
862     p_block->i_dts = p_pic->date - p_sys->i_pts_offset;
863     block_FifoPut( p_sys->p_dts_fifo, p_block );
864     p_block = NULL;
865
866     /* for field coding mode, insert an extra value into both the
867      * pts lookaside buffer and dts queue, offset to correspond
868      * to a one field delay. */
869     if( 1 == p_sys->ctx.enc_params.picture_coding_mode )
870     {
871         StorePicturePTS( p_enc, p_sys->i_input_picnum, p_pic->date + p_sys->i_field_time );
872         p_sys->i_input_picnum++;
873
874         p_block = block_New( p_enc, 1 );
875         if( !p_block )
876             return NULL;
877         p_block->i_dts = p_pic->date - p_sys->i_pts_offset + p_sys->i_field_time;
878         block_FifoPut( p_sys->p_dts_fifo, p_block );
879         p_block = NULL;
880     }
881
882     dirac_encoder_state_t state;
883     /* Retrieve encoded frames from encoder */
884     do
885     {
886         p_sys->p_dirac->enc_buf.buffer = p_sys->p_buffer_out;
887         p_sys->p_dirac->enc_buf.size = p_sys->i_buffer_out;
888         state = dirac_encoder_output( p_sys->p_dirac );
889         switch( state )
890         {
891         case ENC_STATE_AVAIL: {
892             uint32_t pic_num;
893
894             /* extract data from encoder temporary buffer. */
895             p_block = block_New( p_enc, p_sys->p_dirac->enc_buf.size );
896             if( !p_block )
897                 return NULL;
898             memcpy( p_block->p_buffer, p_sys->p_dirac->enc_buf.buffer,
899                     p_sys->p_dirac->enc_buf.size );
900
901             /* if some flags were set for a previous block, prevent
902              * them from getting lost */
903             if( p_sys->p_chain )
904                 p_block->i_flags |= p_sys->p_chain->i_flags;
905
906             /* store all extracted blocks in a chain and gather up when an
907              * entire encapsulation unit is avaliable (ends with a picture) */
908             block_ChainAppend( &p_sys->p_chain, p_block );
909
910             /* Presence of a Sequence header indicates a seek point */
911             if( 0 == p_block->p_buffer[4] )
912             {
913                 p_block->i_flags |= BLOCK_FLAG_TYPE_I;
914
915                 if( !p_enc->fmt_out.p_extra ) {
916                     const uint8_t eos[] = { 'B','B','C','D',0x10,0,0,0,13,0,0,0,0 };
917                     uint32_t len = GetDWBE( p_block->p_buffer + 5 );
918                     /* if it hasn't been done so far, stash a copy of the
919                      * sequence header for muxers such as ogg */
920                     /* The OggDirac spec advises that a Dirac EOS DataUnit
921                      * is appended to the sequence header to allow guard
922                      * against poor streaming servers */
923                     /* XXX, should this be done using the packetizer ? */
924                     p_enc->fmt_out.p_extra = malloc( len + sizeof(eos) );
925                     if( !p_enc->fmt_out.p_extra )
926                         return NULL;
927                     memcpy( p_enc->fmt_out.p_extra, p_block->p_buffer, len);
928                     memcpy( (uint8_t*)p_enc->fmt_out.p_extra + len, eos, sizeof(eos) );
929                     SetDWBE( (uint8_t*)p_enc->fmt_out.p_extra + len + 10, len );
930                     p_enc->fmt_out.i_extra = len + sizeof(eos);
931                 }
932             }
933
934             if( ReadDiracPictureNumber( &pic_num, p_block ) )
935             {
936                 /* Finding a picture terminates an ecapsulation unit, gather
937                  * all data and output; use the next dts value queued up
938                  * and find correct pts in the tlb */
939                 p_block = block_FifoGet( p_sys->p_dts_fifo );
940                 p_sys->p_chain->i_dts = p_block->i_dts;
941                 p_sys->p_chain->i_pts = GetPicturePTS( p_enc, pic_num );
942                 block_Release( p_block );
943                 block_ChainAppend( &p_output_chain, block_ChainGather( p_sys->p_chain ) );
944                 p_sys->p_chain = NULL;
945             } else {
946                 p_block = NULL;
947             }
948             break;
949             }
950
951         case ENC_STATE_BUFFER:
952             break;
953         case ENC_STATE_INVALID:
954         default:
955             break;
956         }
957     } while( state == ENC_STATE_AVAIL );
958
959     return p_output_chain;
960 }
961
962 /*****************************************************************************
963  * CloseEncoder: dirac encoder destruction
964  *****************************************************************************/
965 static void CloseEncoder( vlc_object_t *p_this )
966 {
967     encoder_t *p_enc = (encoder_t *)p_this;
968     encoder_sys_t *p_sys = p_enc->p_sys;
969
970     /* Free the encoder resources */
971     if( p_sys->p_dirac )
972         dirac_encoder_close( p_sys->p_dirac );
973
974     free( p_sys->p_buffer_in );
975     free( p_sys->p_buffer_out );
976
977     if( p_sys->p_dts_fifo )
978         block_FifoRelease( p_sys->p_dts_fifo );
979     block_ChainRelease( p_sys->p_chain );
980
981     free( p_sys );
982 }