]> git.sesse.net Git - vlc/blob - modules/codec/dirac.c
Use var_InheritString for --decklink-video-connection.
[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                                    " separately 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 separate 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     change_integer_range(-1, INT_MAX);
253
254     add_integer( ENC_CFG_PREFIX ENC_MCBLK_HEIGHT, -1, NULL,
255                  ENC_MCBLK_HEIGHT, ENC_MCBLK_HEIGHT_LONGTEXT, false )
256     change_integer_range(-1, INT_MAX);
257
258     add_integer( ENC_CFG_PREFIX ENC_MCBLK_OVERLAP, -1, NULL,
259                  ENC_MCBLK_OVERLAP_TEXT, ENC_MCBLK_OVERLAP_LONGTEXT, false )
260     change_integer_range(-1, 100);
261
262     /* advanced option only */
263     add_integer( ENC_CFG_PREFIX ENC_MCBLK_XBLEN, -1, NULL,
264                  ENC_MCBLK_XBLEN_TEXT, ENC_MCBLK_XBLEN_LONGTEXT, true )
265     change_integer_range(-1, INT_MAX);
266     /* advanced option only */
267     add_integer( ENC_CFG_PREFIX ENC_MCBLK_YBLEN, -1, NULL,
268                  ENC_MCBLK_YBLEN_TEXT, ENC_MCBLK_YBLEN_LONGTEXT, true )
269     change_integer_range(-1, INT_MAX);
270
271     add_string( ENC_CFG_PREFIX ENC_ME_SIMPLESEARCH, "", NULL,
272               ENC_ME_SIMPLESEARCH_TEXT, ENC_ME_SIMPLESEARCH_LONGTEXT, false )
273
274 #if DIRAC_RESEARCH_VERSION_ATLEAST(1,0,1)
275     add_bool( ENC_CFG_PREFIX ENC_ME_COMBINED, true, NULL,
276               ENC_ME_COMBINED_TEXT, ENC_ME_COMBINED_LONGTEXT, false )
277 #endif
278
279     add_integer( ENC_CFG_PREFIX ENC_DWTINTRA, -1, NULL,
280                  ENC_DWTINTRA_TEXT, ENC_DWTINTRA_LONGTEXT, false )
281     change_integer_range(-1, 6);
282
283     add_integer( ENC_CFG_PREFIX ENC_DWTINTER, -1, NULL,
284                  ENC_DWTINTER_TEXT, ENC_DWTINTER_LONGTEXT, false )
285     change_integer_range(-1, 6);
286
287     add_integer( ENC_CFG_PREFIX ENC_DWTDEPTH, -1, NULL,
288                  ENC_DWTDEPTH_TEXT, ENC_DWTDEPTH_LONGTEXT, false )
289     change_integer_range(-1, 4);
290
291     /* advanced option only */
292     /* NB, unforunately vlc doesn't have a concept of 'dont care' */
293     add_integer( ENC_CFG_PREFIX ENC_MULTIQUANT, -1, NULL,
294                  ENC_MULTIQUANT_TEXT, ENC_MULTIQUANT_LONGTEXT, true )
295     change_integer_range(-1, 1);
296
297     /* advanced option only */
298     /* NB, unforunately vlc doesn't have a concept of 'dont care' */
299     add_integer( ENC_CFG_PREFIX ENC_SPARTITION, -1, NULL,
300                  ENC_SPARTITION_TEXT, ENC_SPARTITION_LONGTEXT, true )
301     change_integer_range(-1, 1);
302
303     add_bool( ENC_CFG_PREFIX ENC_NOAC, false, NULL,
304               ENC_NOAC_TEXT, ENC_NOAC_LONGTEXT, false )
305
306     /* advanced option only */
307     add_float( ENC_CFG_PREFIX ENC_CPD, -1, NULL,
308                ENC_CPD_TEXT, ENC_CPD_LONGTEXT, true )
309     change_integer_range(-1, INT_MAX);
310 vlc_module_end()
311
312 /*****************************************************************************
313  * picture_pts_t : store pts alongside picture number, not carried through
314  * encoder
315  *****************************************************************************/
316 struct picture_pts_t
317 {
318    bool b_empty;      /* entry is invalid */
319    uint32_t u_pnum;  /* dirac picture number */
320    mtime_t i_pts;    /* associated pts */
321 };
322
323 /*****************************************************************************
324  * encoder_sys_t : dirac encoder descriptor
325  *****************************************************************************/
326 #define PTS_TLB_SIZE 256
327 struct encoder_sys_t
328 {
329     dirac_encoder_t *p_dirac;
330     dirac_encoder_context_t ctx;
331     bool b_auto_field_coding;
332
333     uint8_t *p_buffer_in;
334     int i_buffer_in;
335     uint32_t i_input_picnum;
336     block_fifo_t *p_dts_fifo;
337
338     int i_buffer_out;
339     uint8_t *p_buffer_out;
340     block_t *p_chain;
341
342     struct picture_pts_t pts_tlb[PTS_TLB_SIZE];
343     mtime_t i_pts_offset;
344     mtime_t i_field_time;
345 };
346
347 static struct
348 {
349     unsigned int i_height;
350     int i_approx_fps;
351     VideoFormat i_vf;
352 } dirac_format_guess[] = {
353     /* Important: Keep this list ordered in ascending picture height */
354     {1, 0, VIDEO_FORMAT_CUSTOM},
355     {120, 15, VIDEO_FORMAT_QSIF525},
356     {144, 12, VIDEO_FORMAT_QCIF},
357     {240, 15, VIDEO_FORMAT_SIF525},
358     {288, 12, VIDEO_FORMAT_CIF},
359     {480, 30, VIDEO_FORMAT_SD_480I60},
360     {480, 15, VIDEO_FORMAT_4SIF525},
361     {576, 12, VIDEO_FORMAT_4CIF},
362     {576, 25, VIDEO_FORMAT_SD_576I50},
363     {720, 50, VIDEO_FORMAT_HD_720P50},
364     {720, 60, VIDEO_FORMAT_HD_720P60},
365     {1080, 24, VIDEO_FORMAT_DIGI_CINEMA_2K24},
366     {1080, 25, VIDEO_FORMAT_HD_1080I50},
367     {1080, 30, VIDEO_FORMAT_HD_1080I60},
368     {1080, 50, VIDEO_FORMAT_HD_1080P50},
369     {1080, 60, VIDEO_FORMAT_HD_1080P60},
370     {2160, 24, VIDEO_FORMAT_DIGI_CINEMA_4K24},
371     {2160, 50, VIDEO_FORMAT_UHDTV_4K50},
372     {2160, 60, VIDEO_FORMAT_UHDTV_4K60},
373     {3840, 50, VIDEO_FORMAT_UHDTV_8K50},
374     {3840, 60, VIDEO_FORMAT_UHDTV_8K60},
375     {0, 0, 0},
376 };
377
378 /*****************************************************************************
379  * ResetPTStlb: Purge all entries in @p_dec@'s PTS-tlb
380  *****************************************************************************/
381 static void ResetPTStlb( encoder_t *p_enc )
382 {
383     encoder_sys_t *p_sys = p_enc->p_sys;
384     for( int i=0; i<PTS_TLB_SIZE; i++)
385     {
386         p_sys->pts_tlb[i].b_empty = true;
387     }
388 }
389
390 /*****************************************************************************
391  * StorePicturePTS: Store the PTS value for a particular picture number
392  *****************************************************************************/
393 static void StorePicturePTS( encoder_t *p_enc, uint32_t u_pnum, mtime_t i_pts )
394 {
395     encoder_sys_t *p_sys = p_enc->p_sys;
396
397     for( int i=0; i<PTS_TLB_SIZE; i++ )
398     {
399         if( p_sys->pts_tlb[i].b_empty )
400         {
401             p_sys->pts_tlb[i].u_pnum = u_pnum;
402             p_sys->pts_tlb[i].i_pts = i_pts;
403             p_sys->pts_tlb[i].b_empty = false;
404
405             return;
406         }
407     }
408
409     msg_Err( p_enc, "Could not store PTS %"PRId64" for frame %u", i_pts, u_pnum );
410 }
411
412 /*****************************************************************************
413  * GetPicturePTS: Retrieve the PTS value for a particular picture number
414  *****************************************************************************/
415 static mtime_t GetPicturePTS( encoder_t *p_enc, uint32_t u_pnum )
416 {
417     encoder_sys_t *p_sys = p_enc->p_sys;
418
419     for( int i=0; i<PTS_TLB_SIZE; i++ )
420     {
421         if( !p_sys->pts_tlb[i].b_empty &&
422             p_sys->pts_tlb[i].u_pnum == u_pnum )
423         {
424              p_sys->pts_tlb[i].b_empty = true;
425              return p_sys->pts_tlb[i].i_pts;
426         }
427     }
428
429     msg_Err( p_enc, "Could not retrieve PTS for picture %u", u_pnum );
430     return 0;
431 }
432
433 /*****************************************************************************
434  * OpenEncoder: probe the encoder and return score
435  *****************************************************************************/
436 static int OpenEncoder( vlc_object_t *p_this )
437 {
438     encoder_t *p_enc = (encoder_t *)p_this;
439     encoder_sys_t *p_sys = p_enc->p_sys;
440     int i_tmp;
441     float f_tmp;
442     char *psz_tmp;
443
444     if( p_enc->fmt_out.i_codec != VLC_CODEC_DIRAC &&
445         !p_enc->b_force )
446     {
447         return VLC_EGENERIC;
448     }
449
450     if( !p_enc->fmt_in.video.i_frame_rate || !p_enc->fmt_in.video.i_frame_rate_base ||
451         !p_enc->fmt_in.video.i_height || !p_enc->fmt_in.video.i_width )
452     {
453         msg_Err( p_enc, "Framerate and picture dimensions must be non-zero" );
454         return VLC_EGENERIC;
455     }
456
457     /* Allocate the memory needed to store the decoder's structure */
458     if( ( p_sys = calloc( 1, sizeof(*p_sys) ) ) == NULL )
459         return VLC_ENOMEM;
460
461     p_enc->p_sys = p_sys;
462     p_enc->pf_encode_video = Encode;
463     p_enc->fmt_out.i_codec = VLC_CODEC_DIRAC;
464     p_enc->fmt_out.i_cat = VIDEO_ES;
465
466     if( ( p_sys->p_dts_fifo = block_FifoNew() ) == NULL )
467     {
468         CloseEncoder( p_this );
469         return VLC_ENOMEM;
470     }
471
472     ResetPTStlb( p_enc );
473
474     /* guess the video format based upon number of lines and picture height */
475     int i = 0;
476     VideoFormat guessed_video_fmt = VIDEO_FORMAT_CUSTOM;
477     /* Pick the dirac_video_format in this order of preference:
478      *  1. an exact match in frame height and an approximate fps match
479      *  2. the previous preset with a smaller number of lines.
480      */
481     do
482     {
483         if( dirac_format_guess[i].i_height > p_enc->fmt_in.video.i_height )
484         {
485             guessed_video_fmt = dirac_format_guess[i-1].i_vf;
486             break;
487         }
488         if( dirac_format_guess[i].i_height != p_enc->fmt_in.video.i_height )
489             continue;
490         int src_fps = p_enc->fmt_in.video.i_frame_rate / p_enc->fmt_in.video.i_frame_rate_base;
491         int delta_fps = abs( dirac_format_guess[i].i_approx_fps - src_fps );
492         if( delta_fps > 2 )
493             continue;
494
495         guessed_video_fmt = dirac_format_guess[i].i_vf;
496         break;
497     } while( dirac_format_guess[++i].i_height );
498
499     dirac_encoder_context_init( &p_sys->ctx, guessed_video_fmt );
500
501     /* constants set from the input video format */
502     p_sys->ctx.src_params.width = p_enc->fmt_in.video.i_width;
503     p_sys->ctx.src_params.height = p_enc->fmt_in.video.i_height;
504     p_sys->ctx.src_params.frame_rate.numerator = p_enc->fmt_in.video.i_frame_rate;
505     p_sys->ctx.src_params.frame_rate.denominator = p_enc->fmt_in.video.i_frame_rate_base;
506     unsigned u_asr_num, u_asr_den;
507     vlc_ureduce( &u_asr_num, &u_asr_den,
508                  p_enc->fmt_in.video.i_sar_num,
509                  p_enc->fmt_in.video.i_sar_den, 0 );
510     p_sys->ctx.src_params.pix_asr.numerator = u_asr_num;
511     p_sys->ctx.src_params.pix_asr.denominator = u_asr_den;
512
513     config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
514
515     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_CHROMAFMT );
516     if( !psz_tmp )
517         goto error;
518     else if( !strcmp( psz_tmp, "420" ) ) {
519         p_enc->fmt_in.i_codec = VLC_CODEC_I420;
520         p_enc->fmt_in.video.i_bits_per_pixel = 12;
521         p_sys->ctx.src_params.chroma = format420;
522         p_sys->i_buffer_in = p_enc->fmt_in.video.i_width * p_enc->fmt_in.video.i_height * 3 / 2;
523     }
524     else if( !strcmp( psz_tmp, "422" ) ) {
525         p_enc->fmt_in.i_codec = VLC_CODEC_I422;
526         p_enc->fmt_in.video.i_bits_per_pixel = 16;
527         p_sys->ctx.src_params.chroma = format422;
528         p_sys->i_buffer_in = p_enc->fmt_in.video.i_width * p_enc->fmt_in.video.i_height * 2;
529     }
530     else if( !strcmp( psz_tmp, "444" ) ) {
531         p_enc->fmt_in.i_codec = VLC_CODEC_I444;
532         p_enc->fmt_in.video.i_bits_per_pixel = 24;
533         p_sys->ctx.src_params.chroma = format444;
534         p_sys->i_buffer_in = p_enc->fmt_in.video.i_width * p_enc->fmt_in.video.i_height * 3;
535     }
536     else {
537         msg_Err( p_enc, "Invalid chroma format: %s", psz_tmp );
538         free( psz_tmp );
539         goto error;
540     }
541     free( psz_tmp );
542
543     p_sys->ctx.enc_params.qf = var_GetFloat( p_enc, ENC_CFG_PREFIX ENC_QUALITY_FACTOR );
544
545     /* use bitrate from sout-transcode-vb in kbps */
546     p_sys->ctx.enc_params.trate = p_enc->fmt_out.i_bitrate / 1000;
547     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_TARGETRATE );
548     if( i_tmp > -1 )
549         p_sys->ctx.enc_params.trate = i_tmp;
550     p_enc->fmt_out.i_bitrate = p_sys->ctx.enc_params.trate * 1000;
551
552     p_sys->ctx.enc_params.lossless = var_GetBool( p_enc, ENC_CFG_PREFIX ENC_LOSSLESS );
553
554     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_PREFILTER );
555     if( !psz_tmp )
556         goto error;
557     else if( !strcmp( psz_tmp, "none" ) ) {
558         p_sys->ctx.enc_params.prefilter = NO_PF;
559     }
560     else if( !strcmp( psz_tmp, "cwm" ) ) {
561         p_sys->ctx.enc_params.prefilter = CWM;
562     }
563     else if( !strcmp( psz_tmp, "rectlp" ) ) {
564         p_sys->ctx.enc_params.prefilter = RECTLP;
565     }
566     else if( !strcmp( psz_tmp, "diaglp" ) ) {
567         p_sys->ctx.enc_params.prefilter = DIAGLP;
568     }
569     else {
570         msg_Err( p_enc, "Invalid prefilter: %s", psz_tmp );
571         free( psz_tmp );
572         goto error;
573     }
574     free( psz_tmp );
575
576     p_sys->ctx.enc_params.prefilter_strength =
577         var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_PREFILTER_STRENGTH );
578
579     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_L1SEP );
580     if( i_tmp > -1 )
581         p_sys->ctx.enc_params.L1_sep = i_tmp;
582
583     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_L1NUM );
584     if( i_tmp > -1 )
585         p_sys->ctx.enc_params.num_L1 = i_tmp;
586
587     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_CODINGMODE );
588     if( !psz_tmp )
589         goto error;
590     else if( !strcmp( psz_tmp, "auto" ) ) {
591         p_sys->b_auto_field_coding = true;
592     }
593     else if( !strcmp( psz_tmp, "progressive" ) ) {
594         p_sys->b_auto_field_coding = false;
595         p_sys->ctx.enc_params.picture_coding_mode = 0;
596     }
597     else if( !strcmp( psz_tmp, "field" ) ) {
598         p_sys->b_auto_field_coding = false;
599         p_sys->ctx.enc_params.picture_coding_mode = 1;
600     }
601     else {
602         msg_Err( p_enc, "Invalid codingmode: %s", psz_tmp );
603         free( psz_tmp );
604         goto error;
605     }
606     free( psz_tmp );
607
608     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_MVPREC );
609     if( !psz_tmp )
610         goto error;
611     else if( !strcmp( psz_tmp, "1" ) ) {
612         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_PIXEL;
613     }
614     else if( !strcmp( psz_tmp, "1/2" ) ) {
615         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_HALF_PIXEL;
616     }
617     else if( !strcmp( psz_tmp, "1/4" ) ) {
618         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_QUARTER_PIXEL;
619     }
620     else if( !strcmp( psz_tmp, "1/8" ) ) {
621         p_sys->ctx.enc_params.mv_precision = MV_PRECISION_EIGHTH_PIXEL;
622     }
623     else {
624         msg_Err( p_enc, "Invalid mv-prec: %s", psz_tmp );
625         free( psz_tmp );
626         goto error;
627     }
628     free( psz_tmp );
629
630     /*
631      * {x,y}b{len,sep} must be multiples of 4
632      */
633     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_WIDTH );
634     if( i_tmp > -1 )
635         p_sys->ctx.enc_params.xbsep = i_tmp / 4 * 4;
636
637     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_HEIGHT );
638     if( i_tmp > -1 )
639         p_sys->ctx.enc_params.ybsep = i_tmp / 4 * 4;
640
641     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_OVERLAP );
642     if( i_tmp > -1 ) {
643         p_sys->ctx.enc_params.xblen = p_sys->ctx.enc_params.xbsep * (100 + i_tmp) / 400 * 4;
644         p_sys->ctx.enc_params.yblen = p_sys->ctx.enc_params.ybsep * (100 + i_tmp) / 400 * 4;
645     }
646
647     /*
648      * {x,y}blen >= {x,y}bsep
649      * {x,y}blen <= 2* {x,y}bsep
650      */
651     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_XBLEN );
652     if( i_tmp > -1 ) {
653         int xblen = __MAX( i_tmp, p_sys->ctx.enc_params.xbsep );
654         xblen = __MIN( xblen, 2 * p_sys->ctx.enc_params.xbsep );
655         p_sys->ctx.enc_params.xblen = xblen;
656     }
657
658     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MCBLK_YBLEN );
659     if( i_tmp > -1 ) {
660         int yblen = __MAX( i_tmp, p_sys->ctx.enc_params.ybsep );
661         yblen = __MIN( yblen, 2 * p_sys->ctx.enc_params.ybsep );
662         p_sys->ctx.enc_params.yblen = yblen;
663     }
664
665     psz_tmp = var_GetString( p_enc, ENC_CFG_PREFIX ENC_ME_SIMPLESEARCH );
666     if( !psz_tmp )
667         goto error;
668     if( *psz_tmp != '\0' ) {
669         /* of the form [0-9]+:[0-9]+ */
670         char *psz_start = psz_tmp;
671         char *psz_end = psz_tmp;
672         p_sys->ctx.enc_params.x_range_me = strtol(psz_start, &psz_end, 10);
673         if( *psz_end != ':'  || psz_end == psz_start ) {
674             msg_Err( p_enc, "Invalid simple search range: %s", psz_tmp );
675             free( psz_tmp );
676             goto error;
677         }
678         psz_start = ++psz_end;
679         p_sys->ctx.enc_params.y_range_me = strtol(psz_start, &psz_end, 10);
680         if( *psz_end != '\0'  || psz_end == psz_start ) {
681             msg_Err( p_enc, "Invalid simple search range: %s", psz_tmp );
682             free( psz_tmp );
683             goto error;
684         }
685         if( p_sys->ctx.enc_params.x_range_me < 0 ||
686             p_sys->ctx.enc_params.y_range_me < 0 )
687         {
688             msg_Err( p_enc, "Invalid negative simple search range: %s", psz_tmp );
689             free( psz_tmp );
690             goto error;
691         }
692         p_sys->ctx.enc_params.full_search = 1;
693     }
694     free( psz_tmp );
695
696 #if DIRAC_RESEARCH_VERSION_ATLEAST(1,0,1)
697     p_sys->ctx.enc_params.combined_me = var_GetBool( p_enc, ENC_CFG_PREFIX ENC_ME_COMBINED );
698 #endif
699
700     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_DWTINTRA );
701     if( i_tmp > -1 )
702         p_sys->ctx.enc_params.intra_wlt_filter = i_tmp;
703
704     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_DWTINTER );
705     if( i_tmp > -1 )
706         p_sys->ctx.enc_params.inter_wlt_filter = i_tmp;
707
708     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_DWTDEPTH );
709     if( i_tmp > -1 )
710         p_sys->ctx.enc_params.wlt_depth = i_tmp;
711
712     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_MULTIQUANT );
713     if( i_tmp > -1 )
714         p_sys->ctx.enc_params.multi_quants = i_tmp;
715
716     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX ENC_SPARTITION );
717     if( i_tmp > -1 )
718         p_sys->ctx.enc_params.spatial_partition = i_tmp;
719
720     p_sys->ctx.enc_params.using_ac = !var_GetBool( p_enc, ENC_CFG_PREFIX ENC_NOAC );
721
722     f_tmp = var_GetFloat( p_enc, ENC_CFG_PREFIX ENC_CPD );
723     if( f_tmp > -1 )
724         p_sys->ctx.enc_params.cpd = f_tmp;
725
726     /* Allocate the buffer for inputing frames into the encoder */
727     if( ( p_sys->p_buffer_in = malloc( p_sys->i_buffer_in ) ) == NULL )
728     {
729         CloseEncoder( p_this );
730         return VLC_ENOMEM;
731     }
732
733     /* Set up output buffer */
734     /* Unfortunately it isn't possible to determine if the buffer
735      * is too small (and then reallocate it) */
736     p_sys->i_buffer_out = 4096 + p_sys->i_buffer_in;
737     if( ( p_sys->p_buffer_out = malloc( p_sys->i_buffer_out ) ) == NULL )
738     {
739         CloseEncoder( p_this );
740         return VLC_ENOMEM;
741     }
742
743     return VLC_SUCCESS;
744 error:
745     CloseEncoder( p_this );
746     return VLC_EGENERIC;
747 }
748
749 /* Attempt to find dirac picture number in an encapsulation unit */
750 static int ReadDiracPictureNumber( uint32_t *p_picnum, block_t *p_block )
751 {
752     uint32_t u_pos = 4;
753     /* protect against falling off the edge */
754     while( u_pos + 13 < p_block->i_buffer )
755     {
756         /* find the picture startcode */
757         if( p_block->p_buffer[u_pos] & 0x08 )
758         {
759             *p_picnum = GetDWBE( p_block->p_buffer + u_pos + 9 );
760             return 1;
761         }
762         /* skip to the next dirac data unit */
763         uint32_t u_npo = GetDWBE( p_block->p_buffer + u_pos + 1 );
764         assert( u_npo <= UINT32_MAX - u_pos );
765         if( u_npo == 0 )
766             u_npo = 13;
767         u_pos += u_npo;
768     }
769     return 0;
770 }
771
772 /****************************************************************************
773  * Encode: the whole thing
774  ****************************************************************************
775  * This function spits out encapsulation units.
776  ****************************************************************************/
777 static block_t *Encode( encoder_t *p_enc, picture_t *p_pic )
778 {
779     encoder_sys_t *p_sys = p_enc->p_sys;
780     block_t *p_block, *p_output_chain = NULL;
781     int i_plane, i_line, i_width, i_src_stride;
782     uint8_t *p_dst;
783
784     if( !p_pic ) return NULL;
785     /* we only know if the sequence is interlaced when the first
786      * picture arrives, so final setup is done here */
787     /* XXX todo, detect change of interlace */
788     p_sys->ctx.src_params.topfieldfirst = p_pic->b_top_field_first;
789     p_sys->ctx.src_params.source_sampling = !p_pic->b_progressive;
790
791     if( p_sys->b_auto_field_coding )
792         p_sys->ctx.enc_params.picture_coding_mode = !p_pic->b_progressive;
793
794     if( !p_sys->p_dirac )
795     {
796         date_t date;
797         /* Initialise the encoder with the encoder context */
798         p_sys->p_dirac = dirac_encoder_init( &p_sys->ctx, 0 );
799         if( !p_sys->p_dirac )
800         {
801             msg_Err( p_enc, "Failed to initialize dirac encoder" );
802             return NULL;
803         }
804         date_Init( &date, p_enc->fmt_in.video.i_frame_rate, p_enc->fmt_in.video.i_frame_rate_base );
805 #if DIRAC_RESEARCH_VERSION_ATLEAST(1,0,2)
806         int i_delayinpics = dirac_encoder_pts_offset( p_sys->p_dirac );
807         i_delayinpics /= p_sys->ctx.enc_params.picture_coding_mode + 1;
808         date_Increment( &date, i_delayinpics );
809 #else
810         date_Increment( &date, 1 );
811 #endif
812         p_sys->i_pts_offset = date_Get( &date );
813
814         /* picture_coding_mode = 1 == FIELD_CODING, two pictures are produced
815          * for each frame input. Calculate time between fields for offsetting
816          * the second field later. */
817         if( 1 == p_sys->ctx.enc_params.picture_coding_mode )
818         {
819             date_Set( &date, 0 );
820             date_Increment( &date, 1 );
821             p_sys->i_field_time = date_Get( &date ) / 2;
822         }
823     }
824
825     /* Copy input picture into encoder input buffer (stride by stride) */
826     /* Would be lovely to just pass the picture in, but there is noway for the
827      * library to free it */
828     p_dst = p_sys->p_buffer_in;
829     for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
830     {
831         uint8_t *p_src = p_pic->p[i_plane].p_pixels;
832         i_width = p_pic->p[i_plane].i_visible_pitch;
833         i_src_stride = p_pic->p[i_plane].i_pitch;
834
835         for( i_line = 0; i_line < p_pic->p[i_plane].i_visible_lines; i_line++ )
836         {
837             vlc_memcpy( p_dst, p_src, i_width );
838             p_dst += i_width;
839             p_src += i_src_stride;
840         }
841     }
842
843     /* Load one frame of data into encoder */
844     if( dirac_encoder_load( p_sys->p_dirac, p_sys->p_buffer_in,
845                             p_sys->i_buffer_in ) < 0 )
846     {
847         msg_Dbg( p_enc, "dirac_encoder_load() error" );
848         return NULL;
849     }
850
851     /* store pts in a lookaside buffer, so that the same pts may
852      * be used for the picture in coded order */
853     StorePicturePTS( p_enc, p_sys->i_input_picnum, p_pic->date );
854     p_sys->i_input_picnum++;
855
856     /* store dts in a queue, so that they appear in order in
857      * coded order */
858     p_block = block_New( p_enc, 1 );
859     if( !p_block )
860         return NULL;
861     p_block->i_dts = p_pic->date - p_sys->i_pts_offset;
862     block_FifoPut( p_sys->p_dts_fifo, p_block );
863     p_block = NULL;
864
865     /* for field coding mode, insert an extra value into both the
866      * pts lookaside buffer and dts queue, offset to correspond
867      * to a one field delay. */
868     if( 1 == p_sys->ctx.enc_params.picture_coding_mode )
869     {
870         StorePicturePTS( p_enc, p_sys->i_input_picnum, p_pic->date + p_sys->i_field_time );
871         p_sys->i_input_picnum++;
872
873         p_block = block_New( p_enc, 1 );
874         if( !p_block )
875             return NULL;
876         p_block->i_dts = p_pic->date - p_sys->i_pts_offset + p_sys->i_field_time;
877         block_FifoPut( p_sys->p_dts_fifo, p_block );
878         p_block = NULL;
879     }
880
881     dirac_encoder_state_t state;
882     /* Retrieve encoded frames from encoder */
883     do
884     {
885         p_sys->p_dirac->enc_buf.buffer = p_sys->p_buffer_out;
886         p_sys->p_dirac->enc_buf.size = p_sys->i_buffer_out;
887         state = dirac_encoder_output( p_sys->p_dirac );
888         switch( state )
889         {
890         case ENC_STATE_AVAIL: {
891             uint32_t pic_num;
892
893             /* extract data from encoder temporary buffer. */
894             p_block = block_New( p_enc, p_sys->p_dirac->enc_buf.size );
895             if( !p_block )
896                 return NULL;
897             memcpy( p_block->p_buffer, p_sys->p_dirac->enc_buf.buffer,
898                     p_sys->p_dirac->enc_buf.size );
899
900             /* if some flags were set for a previous block, prevent
901              * them from getting lost */
902             if( p_sys->p_chain )
903                 p_block->i_flags |= p_sys->p_chain->i_flags;
904
905             /* store all extracted blocks in a chain and gather up when an
906              * entire encapsulation unit is avaliable (ends with a picture) */
907             block_ChainAppend( &p_sys->p_chain, p_block );
908
909             /* Presence of a Sequence header indicates a seek point */
910             if( 0 == p_block->p_buffer[4] )
911             {
912                 p_block->i_flags |= BLOCK_FLAG_TYPE_I;
913
914                 if( !p_enc->fmt_out.p_extra ) {
915                     const uint8_t eos[] = { 'B','B','C','D',0x10,0,0,0,13,0,0,0,0 };
916                     uint32_t len = GetDWBE( p_block->p_buffer + 5 );
917                     /* if it hasn't been done so far, stash a copy of the
918                      * sequence header for muxers such as ogg */
919                     /* The OggDirac spec advises that a Dirac EOS DataUnit
920                      * is appended to the sequence header to allow guard
921                      * against poor streaming servers */
922                     /* XXX, should this be done using the packetizer ? */
923                     p_enc->fmt_out.p_extra = malloc( len + sizeof(eos) );
924                     if( !p_enc->fmt_out.p_extra )
925                         return NULL;
926                     memcpy( p_enc->fmt_out.p_extra, p_block->p_buffer, len);
927                     memcpy( (uint8_t*)p_enc->fmt_out.p_extra + len, eos, sizeof(eos) );
928                     SetDWBE( (uint8_t*)p_enc->fmt_out.p_extra + len + 10, len );
929                     p_enc->fmt_out.i_extra = len + sizeof(eos);
930                 }
931             }
932
933             if( ReadDiracPictureNumber( &pic_num, p_block ) )
934             {
935                 /* Finding a picture terminates an ecapsulation unit, gather
936                  * all data and output; use the next dts value queued up
937                  * and find correct pts in the tlb */
938                 p_block = block_FifoGet( p_sys->p_dts_fifo );
939                 p_sys->p_chain->i_dts = p_block->i_dts;
940                 p_sys->p_chain->i_pts = GetPicturePTS( p_enc, pic_num );
941                 block_Release( p_block );
942                 block_ChainAppend( &p_output_chain, block_ChainGather( p_sys->p_chain ) );
943                 p_sys->p_chain = NULL;
944             } else {
945                 p_block = NULL;
946             }
947             break;
948             }
949
950         case ENC_STATE_BUFFER:
951             break;
952         case ENC_STATE_INVALID:
953         default:
954             break;
955         }
956     } while( state == ENC_STATE_AVAIL );
957
958     return p_output_chain;
959 }
960
961 /*****************************************************************************
962  * CloseEncoder: dirac encoder destruction
963  *****************************************************************************/
964 static void CloseEncoder( vlc_object_t *p_this )
965 {
966     encoder_t *p_enc = (encoder_t *)p_this;
967     encoder_sys_t *p_sys = p_enc->p_sys;
968
969     /* Free the encoder resources */
970     if( p_sys->p_dirac )
971         dirac_encoder_close( p_sys->p_dirac );
972
973     free( p_sys->p_buffer_in );
974     free( p_sys->p_buffer_out );
975
976     if( p_sys->p_dts_fifo )
977         block_FifoRelease( p_sys->p_dts_fifo );
978     block_ChainRelease( p_sys->p_chain );
979
980     free( p_sys );
981 }