diff --git a/genindex.html b/genindex.html index 5db8f57..c39ba30 100644 --- a/genindex.html +++ b/genindex.html @@ -81,6 +81,10 @@ +
diff --git a/index.html b/index.html index 634d1f7..c7717a6 100644 --- a/index.html +++ b/index.html @@ -141,6 +141,152 @@ video with inverted luma.

Official documentation: drawbox

+
+
+ffmpeg.drawtext(stream, text=None, x=0, y=0, escape_text=True, **kwargs)
+

Draw a text string or text from a specified file on top of a video, using the libfreetype library.

+

To enable compilation of this filter, you need to configure FFmpeg with --enable-libfreetype. To enable default +font fallback and the font option you need to configure FFmpeg with --enable-libfontconfig. To enable the +text_shaping option, you need to configure FFmpeg with --enable-libfribidi.

+ +++ + + + +
Parameters:
    +
  • box – Used to draw a box around text using the background color. The value must be either 1 (enable) or 0 +(disable). The default value of box is 0.
    • +
  • boxborderw – Set the width of the border to be drawn around the box using boxcolor. The default value of +boxborderw is 0.
    • +
  • boxcolor – The color to be used for drawing box around text. For the syntax of this option, check the “Color” +section in the ffmpeg-utils manual. The default value of boxcolor is “white”.
    • +
  • line_spacing – Set the line spacing in pixels of the border to be drawn around the box using box. The default +value of line_spacing is 0.
    • +
  • borderw – Set the width of the border to be drawn around the text using bordercolor. The default value of +borderw is 0.
    • +
  • bordercolor – Set the color to be used for drawing border around text. For the syntax of this option, check the +“Color” section in the ffmpeg-utils manual. The default value of bordercolor is “black”.
    • +
  • expansion – Select how the text is expanded. Can be either none, strftime (deprecated) or normal (default). See +the Text expansion section below for details.
    • +
  • basetime – Set a start time for the count. Value is in microseconds. Only applied in the deprecated strftime +expansion mode. To emulate in normal expansion mode use the pts function, supplying the start time (in +seconds) as the second argument.
    • +
  • fix_bounds – If true, check and fix text coords to avoid clipping.
    • +
  • fontcolor – The color to be used for drawing fonts. For the syntax of this option, check the “Color” section in +the ffmpeg-utils manual. The default value of fontcolor is “black”.
    • +
  • fontcolor_expr – String which is expanded the same way as text to obtain dynamic fontcolor value. By default +this option has empty value and is not processed. When this option is set, it overrides fontcolor option.
    • +
  • font – The font family to be used for drawing text. By default Sans.
    • +
  • fontfile – The font file to be used for drawing text. The path must be included. This parameter is mandatory if +the fontconfig support is disabled.
    • +
  • alpha – Draw the text applying alpha blending. The value can be a number between 0.0 and 1.0. The expression +accepts the same variables x, y as well. The default value is 1. Please see fontcolor_expr.
    • +
  • fontsize – The font size to be used for drawing text. The default value of fontsize is 16.
    • +
  • text_shaping – If set to 1, attempt to shape the text (for example, reverse the order of right-to-left text and +join Arabic characters) before drawing it. Otherwise, just draw the text exactly as given. By default 1 (if +supported).
    • +
  • ft_load_flags –

    The flags to be used for loading the fonts. The flags map the corresponding flags supported by +libfreetype, and are a combination of the following values:

    +
      +
    • default
      • +
    • no_scale
      • +
    • no_hinting
      • +
    • render
      • +
    • no_bitmap
      • +
    • vertical_layout
      • +
    • force_autohint
      • +
    • crop_bitmap
      • +
    • pedantic
      • +
    • ignore_global_advance_width
      • +
    • no_recurse
      • +
    • ignore_transform
      • +
    • monochrome
      • +
    • linear_design
      • +
    • no_autohint
      • +
    +

    Default value is “default”. For more information consult the documentation for the FT_LOAD_* libfreetype +flags.

    +
    • +
  • shadowcolor – The color to be used for drawing a shadow behind the drawn text. For the syntax of this option, +check the “Color” section in the ffmpeg-utils manual. The default value of shadowcolor is “black”.
    • +
  • shadowx – The x offset for the text shadow position with respect to the position of the text. It can be either +positive or negative values. The default value is “0”.
    • +
  • shadowy – The y offset for the text shadow position with respect to the position of the text. It can be either +positive or negative values. The default value is “0”.
    • +
  • start_number – The starting frame number for the n/frame_num variable. The default value is “0”.
    • +
  • tabsize – The size in number of spaces to use for rendering the tab. Default value is 4.
    • +
  • timecode – Set the initial timecode representation in “hh:mm:ss[:;.]ff” format. It can be used with or without +text parameter. timecode_rate option must be specified.
    • +
  • rate – Set the timecode frame rate (timecode only).
    • +
  • timecode_rate – Alias for rate.
    • +
  • r – Alias for rate.
    • +
  • tc24hmax – If set to 1, the output of the timecode option will wrap around at 24 hours. Default is 0 (disabled).
    • +
  • text – The text string to be drawn. The text must be a sequence of UTF-8 encoded characters. This parameter is +mandatory if no file is specified with the parameter textfile.
    • +
  • textfile – A text file containing text to be drawn. The text must be a sequence of UTF-8 encoded characters. +This parameter is mandatory if no text string is specified with the parameter text. If both text and +textfile are specified, an error is thrown.
    • +
  • reload – If set to 1, the textfile will be reloaded before each frame. Be sure to update it atomically, or it +may be read partially, or even fail.
    • +
  • x – The expression which specifies the offset where text will be drawn within the video frame. It is relative to +the left border of the output image. The default value is “0”.
    • +
  • y – The expression which specifies the offset where text will be drawn within the video frame. It is relative to +the top border of the output image. The default value is “0”. See below for the list of accepted constants +and functions.
    • +
+
+
+
Expression constants:
+
+
The parameters for x and y are expressions containing the following constants and functions:
+
    +
  • dar: input display aspect ratio, it is the same as (w / h) * sar
    • +
  • hsub: horizontal chroma subsample values. For example for the pixel format “yuv422p” hsub is 2 and vsub +is 1.
    • +
  • vsub: vertical chroma subsample values. For example for the pixel format “yuv422p” hsub is 2 and vsub +is 1.
    • +
  • line_h: the height of each text line
    • +
  • lh: Alias for line_h.
    • +
  • main_h: the input height
    • +
  • h: Alias for main_h.
    • +
  • H: Alias for main_h.
    • +
  • main_w: the input width
    • +
  • w: Alias for main_w.
    • +
  • W: Alias for main_w.
    • +
  • ascent: the maximum distance from the baseline to the highest/upper grid coordinate used to place a glyph +outline point, for all the rendered glyphs. It is a positive value, due to the grid’s orientation with the Y +axis upwards.
    • +
  • max_glyph_a: Alias for ascent.
    • +
  • descent: the maximum distance from the baseline to the lowest grid coordinate used to place a glyph outline +point, for all the rendered glyphs. This is a negative value, due to the grid’s orientation, with the Y axis +upwards.
    • +
  • max_glyph_d: Alias for descent.
    • +
  • max_glyph_h: maximum glyph height, that is the maximum height for all the glyphs contained in the rendered +text, it is equivalent to ascent - descent.
    • +
  • max_glyph_w: maximum glyph width, that is the maximum width for all the glyphs contained in the rendered +text.
    • +
  • n: the number of input frame, starting from 0
    • +
  • rand(min, max): return a random number included between min and max
    • +
  • sar: The input sample aspect ratio.
    • +
  • t: timestamp expressed in seconds, NAN if the input timestamp is unknown
    • +
  • text_h: the height of the rendered text
    • +
  • th: Alias for text_h.
    • +
  • text_w: the width of the rendered text
    • +
  • tw: Alias for text_w.
    • +
  • x: the x offset coordinates where the text is drawn.
    • +
  • y: the y offset coordinates where the text is drawn.
    • +
+
+
+

These parameters allow the x and y expressions to refer each other, so you can for example specify +y=x/dar.

+
+
+

Official documentation: drawtext

+
+
ffmpeg.filter_(stream_spec, filter_name, *args, **kwargs)
diff --git a/objects.inv b/objects.inv index 86d1fd5..49e13ed 100644 --- a/objects.inv +++ b/objects.inv @@ -2,5 +2,5 @@ # Project: ffmpeg-python # Version: # The remainder of this file is compressed using zlib. -xڍj0O1^]W`B@N4d˜O_5Hw9)ߙ!.Y02Dgr|dAy֙yh92Dc5766""cٸCB3>$ٛr=֔MNVb;0'/r# ^dDp,"?[cWYՠ -gpvGO"w,܏+40~m51n;)GB~W>j;߯\;Uz \ No newline at end of file +xڍj0O1^]W`B@N4/ƉUt +2 jv{kB,rٷ\+ߡ,/mAy֙i[69bE#57a[Em,#"#׊Qml!l(con ɪUlg2|nFEnDI&>BpQ3R]eU+~[.;zcW~\لgb\D<DeL' \ No newline at end of file diff --git a/searchindex.js b/searchindex.js index 2ddc399..cfde87c 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index"],envversion:52,filenames:["index.rst"],objects:{"":{ffmpeg:[0,0,0,"-"]},ffmpeg:{colorchannelmixer:[0,1,1,""],concat:[0,1,1,""],crop:[0,1,1,""],drawbox:[0,1,1,""],filter_:[0,1,1,""],get_args:[0,1,1,""],hflip:[0,1,1,""],hue:[0,1,1,""],input:[0,1,1,""],merge_outputs:[0,1,1,""],output:[0,1,1,""],overlay:[0,1,1,""],overwrite_output:[0,1,1,""],run:[0,1,1,""],setpts:[0,1,1,""],trim:[0,1,1,""],vflip:[0,1,1,""],view:[0,1,1,""],zoompan:[0,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"case":0,"default":0,"function":0,"true":0,For:0,PTS:0,The:0,accept:0,action:0,activ:0,adjust:0,after:0,alia:0,all:0,also:0,alwai:0,angl:0,anoth:0,appli:0,area:0,arg:0,argument:0,asetpt:0,ask:0,audio:0,author:0,automat:0,avoid:0,behavior:0,both:0,box:0,bright:0,call:0,can:0,chang:0,channel:0,check:0,cmd:0,codec:0,color:0,colorchannelmix:0,com:0,command:0,common:0,concat:0,concaten:0,configur:0,confus:0,construct:0,contain:0,continu:0,convert:0,coordin:0,corner:0,correctli:0,correspond:0,crop:0,custom:0,degre:0,deprec:0,dictionari:0,differ:0,directli:0,disabl:0,displai:0,document:0,draw:0,drawbox:0,drop:0,durat:0,dure:0,each:0,edg:0,effect:0,encount:0,end:0,end_fram:0,end_pt:0,endal:0,eof:0,eof_act:0,eval:0,evalu:0,exactli:0,exampl:0,except:0,explicitli:0,expr:0,express:0,fail:0,fals:0,file:0,filenam:0,filter:0,filter_:0,filter_nam:0,first:0,flip:0,fmpeg:0,follow:0,forc:0,format:0,fps:0,frame:0,from:0,gbrp:0,gener:0,get:0,get_arg:0,github:0,given:0,graph:0,greater:0,handl:0,have:0,hd720:0,height:0,heigth:0,hflip:0,higher:0,horizont:0,how:0,http:0,hue:0,huge:0,imag:0,immedi:0,implement:0,includ:0,incom:0,index:0,init:0,initi:0,input:0,instead:0,interpret:0,invalid:0,invert:0,its:0,join:0,kept:0,keyword:0,kkroen:0,kwarg:0,label:0,last:0,layout:0,left:0,level:0,line:0,list:0,longest:0,luma:0,main:0,main_parent_nod:0,mani:0,manual:0,map:0,maximum:0,mean:0,merge_output:0,miss:0,mix:0,mode:0,modifi:0,modul:0,mp4:0,must:0,name:0,necessari:0,node:0,none:0,normal:0,number:0,offici:0,onc:0,one:0,onli:0,option:0,order:0,other:0,out:0,output:0,over:0,overlai:0,overlaid:0,overlay_parent_nod:0,overwrit:0,overwrite_output:0,pack:0,pad:0,page:0,pan:0,paramet:0,pass:0,pixel:0,planar:0,posit:0,preced:0,present:0,process:0,radian:0,rang:0,rate:0,reason:0,relat:0,repeat:0,repeatlast:0,resolut:0,result:0,rgb:0,run:0,same:0,sampl:0,satur:0,search:0,second:0,secondari:0,section:0,segment:0,select:0,set:0,setpt:0,shorter:0,shortest:0,should:0,silenc:0,singl:0,size:0,sloppi:0,space:0,special:0,specifi:0,standard:0,start:0,start_fram:0,start_pt:0,stream:0,stream_spec:0,subpart:0,suffix:0,sure:0,synchron:0,synopsi:0,syntax:0,system:0,take:0,termin:0,than:0,them:0,thi:0,thick:0,through:0,time:0,timebas:0,timestamp:0,togeth:0,top:0,track:0,trim:0,type:0,unit:0,unsaf:0,until:0,url:0,use:0,used:0,user:0,util:0,valu:0,variabl:0,variou:0,verbatim:0,vertic:0,vflip:0,video:0,view:0,visibl:0,when:0,which:0,width:0,within:0,without:0,work:0,write:0,you:0,yuv420:0,yuv422:0,yuv444:0,zoom:0,zoompan:0},titles:["ffmpeg-python: Python bindings for FFmpeg"],titleterms:{bind:0,ffmpeg:0,indic:0,python:0,tabl:0}}) \ No newline at end of file +Search.setIndex({docnames:["index"],envversion:52,filenames:["index.rst"],objects:{"":{ffmpeg:[0,0,0,"-"]},ffmpeg:{colorchannelmixer:[0,1,1,""],concat:[0,1,1,""],crop:[0,1,1,""],drawbox:[0,1,1,""],drawtext:[0,1,1,""],filter_:[0,1,1,""],get_args:[0,1,1,""],hflip:[0,1,1,""],hue:[0,1,1,""],input:[0,1,1,""],merge_outputs:[0,1,1,""],output:[0,1,1,""],overlay:[0,1,1,""],overwrite_output:[0,1,1,""],run:[0,1,1,""],setpts:[0,1,1,""],trim:[0,1,1,""],vflip:[0,1,1,""],view:[0,1,1,""],zoompan:[0,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"case":0,"default":0,"function":0,"return":0,"true":0,For:0,PTS:0,The:0,These:0,Used:0,accept:0,action:0,activ:0,adjust:0,after:0,alia:0,all:0,allow:0,alpha:0,also:0,alwai:0,angl:0,anoth:0,appli:0,arab:0,area:0,arg:0,argument:0,around:0,ascent:0,asetpt:0,ask:0,aspect:0,atom:0,attempt:0,audio:0,author:0,automat:0,avoid:0,axi:0,background:0,baselin:0,basetim:0,befor:0,behavior:0,behind:0,below:0,between:0,black:0,blend:0,border:0,bordercolor:0,borderw:0,both:0,box:0,boxborderw:0,boxcolor:0,bright:0,call:0,can:0,chang:0,channel:0,charact:0,check:0,chroma:0,clip:0,cmd:0,codec:0,color:0,colorchannelmix:0,com:0,combin:0,command:0,common:0,compil:0,concat:0,concaten:0,configur:0,confus:0,constant:0,construct:0,consult:0,contain:0,continu:0,convert:0,coord:0,coordin:0,corner:0,correctli:0,correspond:0,count:0,crop:0,crop_bitmap:0,custom:0,dar:0,degre:0,deprec:0,descent:0,detail:0,dictionari:0,differ:0,directli:0,disabl:0,displai:0,distanc:0,document:0,draw:0,drawbox:0,drawn:0,drawtext:0,drop:0,due:0,durat:0,dure:0,dynam:0,each:0,edg:0,effect:0,either:0,empti:0,emul:0,enabl:0,encod:0,encount:0,end:0,end_fram:0,end_pt:0,endal:0,eof:0,eof_act:0,equival:0,error:0,escape_text:0,eval:0,evalu:0,even:0,exactli:0,exampl:0,except:0,expand:0,expans:0,explicitli:0,expr:0,express:0,fail:0,fallback:0,fals:0,famili:0,file:0,filenam:0,filter:0,filter_:0,filter_nam:0,first:0,fix:0,fix_bound:0,flag:0,flip:0,fmpeg:0,follow:0,font:0,fontcolor:0,fontcolor_expr:0,fontconfig:0,fontfil:0,fontsiz:0,forc:0,force_autohint:0,format:0,fps:0,frame:0,frame_num:0,from:0,ft_load_:0,ft_load_flag:0,gbrp:0,gener:0,get:0,get_arg:0,github:0,given:0,glyph:0,graph:0,greater:0,grid:0,handl:0,has:0,have:0,hd720:0,height:0,heigth:0,hflip:0,higher:0,highest:0,horizont:0,hour:0,how:0,hsub:0,http:0,hue:0,huge:0,ignore_global_advance_width:0,ignore_transform:0,imag:0,immedi:0,implement:0,includ:0,incom:0,index:0,inform:0,init:0,initi:0,input:0,instead:0,interpret:0,invalid:0,invert:0,its:0,join:0,just:0,kept:0,keyword:0,kkroen:0,kwarg:0,label:0,last:0,layout:0,left:0,level:0,libfontconfig:0,libfreetyp:0,libfribidi:0,librari:0,line:0,line_h:0,line_spac:0,linear_design:0,list:0,load:0,longest:0,lowest:0,luma:0,mai:0,main:0,main_h:0,main_parent_nod:0,main_w:0,mandatori:0,mani:0,manual:0,map:0,max:0,max_glyph_a:0,max_glyph_d:0,max_glyph_h:0,max_glyph_w:0,maximum:0,mean:0,merge_output:0,microsecond:0,min:0,miss:0,mix:0,mode:0,modifi:0,modul:0,monochrom:0,more:0,mp4:0,must:0,name:0,nan:0,necessari:0,need:0,neg:0,no_autohint:0,no_bitmap:0,no_hint:0,no_recurs:0,no_scal:0,node:0,none:0,normal:0,number:0,obtain:0,offici:0,offset:0,onc:0,one:0,onli:0,option:0,order:0,orient:0,other:0,otherwis:0,out:0,outlin:0,output:0,over:0,overlai:0,overlaid:0,overlay_parent_nod:0,overrid:0,overwrit:0,overwrite_output:0,pack:0,pad:0,page:0,pan:0,paramet:0,partial:0,pass:0,path:0,pedant:0,pixel:0,place:0,planar:0,pleas:0,point:0,posit:0,preced:0,present:0,process:0,pts:0,radian:0,rand:0,random:0,rang:0,rate:0,ratio:0,read:0,reason:0,refer:0,rel:0,relat:0,reload:0,render:0,repeat:0,repeatlast:0,represent:0,resolut:0,respect:0,result:0,revers:0,rgb:0,right:0,run:0,same:0,sampl:0,san:0,sar:0,satur:0,search:0,second:0,secondari:0,section:0,see:0,segment:0,select:0,sequenc:0,set:0,setpt:0,shadow:0,shadowcolor:0,shadowi:0,shadowx:0,shape:0,shorter:0,shortest:0,should:0,silenc:0,singl:0,size:0,sloppi:0,space:0,special:0,specifi:0,standard:0,start:0,start_fram:0,start_numb:0,start_pt:0,stream:0,stream_spec:0,strftime:0,string:0,subpart:0,subsampl:0,suffix:0,suppli:0,support:0,sure:0,synchron:0,synopsi:0,syntax:0,system:0,tab:0,tabsiz:0,take:0,tc24hmax:0,termin:0,text:0,text_h:0,text_shap:0,text_w:0,textfil:0,than:0,them:0,thi:0,thick:0,through:0,thrown:0,time:0,timebas:0,timecod:0,timecode_r:0,timestamp:0,togeth:0,top:0,track:0,trim:0,type:0,unit:0,unknown:0,unsaf:0,until:0,updat:0,upper:0,upward:0,url:0,use:0,used:0,user:0,using:0,utf:0,util:0,valu:0,variabl:0,variou:0,verbatim:0,vertic:0,vertical_layout:0,vflip:0,video:0,view:0,visibl:0,vsub:0,wai:0,well:0,when:0,where:0,which:0,white:0,width:0,within:0,without:0,work:0,wrap:0,write:0,you:0,yuv420:0,yuv422:0,yuv422p:0,yuv444:0,zoom:0,zoompan:0},titles:["ffmpeg-python: Python bindings for FFmpeg"],titleterms:{bind:0,ffmpeg:0,indic:0,python:0,tabl:0}}) \ No newline at end of file