]> git.sesse.net Git - vlc/blob - modules/codec/ffmpeg/ffmpeg.h
string review
[vlc] / modules / codec / ffmpeg / ffmpeg.h
1 /*****************************************************************************
2  * ffmpeg.h: decoder using the ffmpeg library
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id: ffmpeg.h,v 1.32 2004/01/25 18:20:12 bigben Exp $
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 #include "codecs.h"                                      /* BITMAPINFOHEADER */
25
26 #if LIBAVCODEC_BUILD >= 4663
27 #   define LIBAVCODEC_PP
28 #else
29 #   undef  LIBAVCODEC_PP
30 #endif
31
32 struct picture_t;
33 struct AVFrame;
34 struct AVCodecContext;
35 struct AVCodec;
36
37 void E_(InitLibavcodec)( vlc_object_t * );
38 int E_(GetFfmpegCodec) ( vlc_fourcc_t, int *, int *, char ** );
39 int E_(GetVlcFourcc)   ( int, int *, vlc_fourcc_t *, char ** );
40 int E_(GetFfmpegChroma)( vlc_fourcc_t );
41
42 /* Video decoder module */
43 int  E_( InitVideoDec )( decoder_t *, AVCodecContext *, AVCodec *,
44                          int, char * );
45 void E_( EndVideoDec ) ( decoder_t * );
46 picture_t *E_( DecodeVideo ) ( decoder_t *, block_t ** );
47
48 /* Audio decoder module */
49 int  E_( InitAudioDec )( decoder_t *, AVCodecContext *, AVCodec *,
50                          int, char * );
51 void E_( EndAudioDec ) ( decoder_t * );
52 aout_buffer_t *E_( DecodeAudio ) ( decoder_t *, block_t ** );
53
54 /* Chroma conversion module */
55 int  E_(OpenChroma)( vlc_object_t * );
56 void E_(CloseChroma)( vlc_object_t * );
57
58 /* Video encoder module */
59 int  E_(OpenEncoder) ( vlc_object_t * );
60 void E_(CloseEncoder)( vlc_object_t * );
61
62 /* Audio encoder module */
63 int  E_(OpenAudioEncoder) ( vlc_object_t * );
64 void E_(CloseAudioEncoder)( vlc_object_t * );
65
66 /* Demux module */
67 int  E_(OpenDemux) ( vlc_object_t * );
68 void E_(CloseDemux)( vlc_object_t * );
69
70 /* Postprocessing module */
71 void *E_(OpenPostproc)( decoder_t *, vlc_bool_t * );
72 int E_(InitPostproc)( decoder_t *, void *, int, int, int );
73 int E_(PostprocPict)( decoder_t *, void *, picture_t *, AVFrame * );
74 void E_(ClosePostproc)( decoder_t *, void * );
75
76 /*****************************************************************************
77  * Module descriptor help strings
78  *****************************************************************************/
79 #define DR_TEXT N_("Direct rendering")
80
81 #define ERROR_TEXT N_("Error resilience")
82 #define ERROR_LONGTEXT N_( \
83     "ffmpeg can make error resiliences.          \n" \
84     "Nevertheless, with a buggy encoder (like ISO MPEG-4 encoder from M$) " \
85     "this will produce a lot of errors.\n" \
86     "Valid range is -1 to 99 (-1 disables all errors resiliences).")
87
88 #define BUGS_TEXT N_("Workaround bugs")
89 #define BUGS_LONGTEXT N_( \
90     "Try to fix some bugs\n" \
91     "1  autodetect\n" \
92     "2  old msmpeg4\n" \
93     "4  xvid interlaced\n" \
94     "8  ump4 \n" \
95     "16 no padding\n" \
96     "32 ac vlc\n" \
97     "64 Qpel chroma")
98
99 #define HURRYUP_TEXT N_("Hurry up")
100 #define HURRYUP_LONGTEXT N_( \
101     "Allow the decoder to partially decode or skip frame(s) " \
102     "when there is not enough time. It's useful with low CPU power " \
103     "but it can produce distorted pictures.")
104
105 #define TRUNC_TEXT N_("Truncated stream")
106 #define TRUNC_LONGTEXT N_("Truncated stream -1:auto,0:disable,:1:enable")
107
108 #define PP_Q_TEXT N_("Post processing quality")
109 #define PP_Q_LONGTEXT N_( \
110     "Quality of post processing. Valid range is 0 to 6\n" \
111     "Higher levels require considerable more CPU power, but produce " \
112     "better looking pictures." )
113
114 #define LIBAVCODEC_PP_TEXT N_("ffmpeg postproc filter chains")
115 /* FIXME (cut/past from ffmpeg */
116 #define LIBAVCODEC_PP_LONGTEXT \
117 "<filterName>[:<option>[:<option>...]][[,|/][-]<filterName>[:<option>...]]...\n" \
118 "long form example:\n" \
119 "vdeblock:autoq/hdeblock:autoq/linblenddeint    default,-vdeblock\n" \
120 "short form example:\n" \
121 "vb:a/hb:a/lb de,-vb\n" \
122 "more examples:\n" \
123 "tn:64:128:256\n" \
124 "Filters                        Options\n" \
125 "short  long name       short   long option     Description\n" \
126 "*      *               a       autoq           cpu power dependant enabler\n" \
127 "                       c       chrom           chrominance filtring enabled\n" \
128 "                       y       nochrom         chrominance filtring disabled\n" \
129 "hb     hdeblock        (2 Threshold)           horizontal deblocking filter\n" \
130 "       1. difference factor: default=64, higher -> more deblocking\n" \
131 "       2. flatness threshold: default=40, lower -> more deblocking\n" \
132 "                       the h & v deblocking filters share these\n" \
133 "                       so u cant set different thresholds for h / v\n" \
134 "vb     vdeblock        (2 Threshold)           vertical deblocking filter\n" \
135 "h1     x1hdeblock                              Experimental h deblock filter 1\n" \
136 "v1     x1vdeblock                              Experimental v deblock filter 1\n" \
137 "dr     dering                                  Deringing filter\n" \
138 "al     autolevels                              automatic brightness / contrast\n" \
139 "                       f       fullyrange      stretch luminance to (0..255)\n" \
140 "lb     linblenddeint                           linear blend deinterlacer\n" \
141 "li     linipoldeint                            linear interpolating deinterlace\n" \
142 "ci     cubicipoldeint                          cubic interpolating deinterlacer\n" \
143 "md     mediandeint                             median deinterlacer\n" \
144 "fd     ffmpegdeint                             ffmpeg deinterlacer\n" \
145 "de     default                                 hb:a,vb:a,dr:a,al\n" \
146 "fa     fast                                    h1:a,v1:a,dr:a,al\n" \
147 "tn     tmpnoise        (3 Thresholds)          Temporal Noise Reducer\n" \
148 "                       1. <= 2. <= 3.          larger -> stronger filtering\n" \
149 "fq     forceQuant      <quantizer>             Force quantizer\n"