diff --git a/README.md b/README.md index fc97d3f..0ead1da 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,18 @@ Flip a video horizontally: ``` import ffmpeg ffmpeg \ - .file_input('input.mp4') \ + .input('input.mp4') \ .hflip() \ - .file_output('output.mp4') \ + .output('output.mp4') \ .run() ``` Or if you prefer a non-fluent interface: ``` import ffmpeg -in = ffmpeg.file_input('input.mp4') +in = ffmpeg.input('input.mp4') flipped = ffmpeg.hflip(in) -out = ffmpeg.file_output(flipped) +out = ffmpeg.output(flipped) ffmpeg.run(out) ``` @@ -54,8 +54,8 @@ If you're like me and find Python to be powerful and readable, it's easy with `f ``` import ffmpeg -in_file = ffmpeg.file_input('input.mp4') -overlay_file = ffmpeg.file_input('overlay.png') +in_file = ffmpeg.input('input.mp4') +overlay_file = ffmpeg.input('overlay.png') ffmpeg \ .concat( in_file.trim(10, 20), @@ -63,7 +63,7 @@ ffmpeg \ ) \ .overlay(overlay_file.hflip()) \ .drawbox(50, 50, 120, 120, color='red', thickness=5) \ - .file_output(TEST_OUTPUT_FILE) \ + .output(TEST_OUTPUT_FILE) \ .run() ``` diff --git a/doc/html/_sources/index.rst.txt b/doc/html/_sources/index.rst.txt index 55876f1..bc0ae8c 100644 --- a/doc/html/_sources/index.rst.txt +++ b/doc/html/_sources/index.rst.txt @@ -2,7 +2,6 @@ ffmpeg-python: Python bindings for FFmpeg ========================================= :Github: https://github.com/kkroening/ffmpeg-python ------------------------------------------------------------ .. toctree:: :maxdepth: 2 diff --git a/doc/html/genindex.html b/doc/html/genindex.html index 9c33673..cb0047b 100644 --- a/doc/html/genindex.html +++ b/doc/html/genindex.html @@ -90,12 +90,6 @@ -
diff --git a/doc/html/index.html b/doc/html/index.html index 727e905..f22edb8 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -56,7 +56,6 @@ -
@@ -284,24 +283,11 @@ for single input image.

Official documentation: zoompan

-
-
-ffmpeg.file_input(filename)
-

Input file URL (ffmpeg -i option)

-

Official documentation: Main options

-
- -
-
-ffmpeg.file_output(parent_node, filename)
-

Output file URL

-

Official documentation: Synopsis

-
-
ffmpeg.input(filename)
-

Shorthand for file_input

+

Input file URL (ffmpeg -i option)

+

Official documentation: Main options

@@ -312,7 +298,8 @@ for single input image.
ffmpeg.output(parent_node, filename)
-

Shorthand for file_output

+

Output file URL

+

Official documentation: Synopsis

diff --git a/doc/html/objects.inv b/doc/html/objects.inv index 3152618..286e4a4 100644 Binary files a/doc/html/objects.inv and b/doc/html/objects.inv differ diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js index b27e027..74ba6b2 100644 --- a/doc/html/searchindex.js +++ b/doc/html/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,""],drawbox:[0,1,1,""],file_input:[0,1,1,""],file_output:[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,""],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,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,behavior:0,both:0,box:0,bright: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,construct:0,contain:0,continu:0,convert:0,coordin:0,corner:0,correctli:0,correspond:0,degre:0,deprec:0,differ: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,except:0,explicitli:0,expr:0,express:0,fail:0,file:0,file_input:0,file_output:0,filenam:0,filter:0,first:0,flip:0,follow:0,forc:0,format:0,fps:0,frame:0,gbrp:0,gener:0,get:0,get_arg:0,github:0,graph:0,handl:0,have:0,hd720:0,height:0,heigth:0,hflip:0,horizont:0,how:0,http:0,hue:0,huge:0,imag:0,immedi: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,kkroen:0,kwarg:0,last:0,layout:0,left:0,line:0,longest:0,luma:0,main:0,main_parent_nod:0,mani:0,manual:0,maximum:0,mean:0,merge_output:0,mix:0,mode:0,modifi:0,modul:0,must:0,necessari:0,node:0,none:0,number:0,offici:0,onc:0,one:0,onli:0,option:0,other: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,parent_nod:0,pass:0,pixel:0,planar: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,shorthand:0,should:0,silenc:0,singl:0,size:0,sloppi:0,space:0,special:0,specifi:0,start:0,start_fram:0,start_pt:0,stream:0,subpart:0,sure:0,synchron:0,synopsi:0,syntax:0,system:0,take:0,termin: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,vertic:0,vflip:0,video:0,visibl:0,when:0,which:0,width:0,within:0,without:0,work:0,write: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,""],drawbox:[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,""],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,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,behavior:0,both:0,box:0,bright: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,construct:0,contain:0,continu:0,convert:0,coordin:0,corner:0,correctli:0,correspond:0,degre:0,deprec:0,differ: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,except:0,explicitli:0,expr:0,express:0,fail:0,file:0,filenam:0,filter:0,first:0,flip:0,follow:0,forc:0,format:0,fps:0,frame:0,gbrp:0,gener:0,get:0,get_arg:0,github:0,graph:0,handl:0,have:0,hd720:0,height:0,heigth:0,hflip:0,horizont:0,how:0,http:0,hue:0,huge:0,imag:0,immedi: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,kkroen:0,kwarg:0,last:0,layout:0,left:0,line:0,longest:0,luma:0,main:0,main_parent_nod:0,mani:0,manual:0,maximum:0,mean:0,merge_output:0,mix:0,mode:0,modifi:0,modul:0,must:0,necessari:0,node:0,none:0,number:0,offici:0,onc:0,one:0,onli:0,option:0,other: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,parent_nod:0,pass:0,pixel:0,planar: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,start:0,start_fram:0,start_pt:0,stream:0,subpart:0,sure:0,synchron:0,synopsi:0,syntax:0,system:0,take:0,termin: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,vertic:0,vflip:0,video:0,visibl:0,when:0,which:0,width:0,within:0,without:0,work:0,write: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 diff --git a/doc/src/index.rst b/doc/src/index.rst index 55876f1..bc0ae8c 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -2,7 +2,6 @@ ffmpeg-python: Python bindings for FFmpeg ========================================= :Github: https://github.com/kkroening/ffmpeg-python ------------------------------------------------------------ .. toctree:: :maxdepth: 2 diff --git a/ffmpeg/_ffmpeg.py b/ffmpeg/_ffmpeg.py index 0bf28be..c9c7f19 100644 --- a/ffmpeg/_ffmpeg.py +++ b/ffmpeg/_ffmpeg.py @@ -7,17 +7,12 @@ from .nodes import ( ) -def file_input(filename): +def input(filename): """Input file URL (ffmpeg ``-i`` option) Official documentation: `Main options `__ """ - return InputNode(file_input.__name__, filename=filename) - - -def input(filename): - """Shorthand for ``file_input``""" - return file_input(filename) + return InputNode(input.__name__, filename=filename) @operator(node_classes={OutputNode, GlobalNode}) @@ -35,24 +30,16 @@ def merge_outputs(*parent_nodes): @operator(node_classes={InputNode, FilterNode}) -def file_output(parent_node, filename): +def output(parent_node, filename): """Output file URL Official documentation: `Synopsis `__ """ - return OutputNode([parent_node], file_output.__name__, filename=filename) - - -@operator(node_classes={InputNode, FilterNode}) -def output(parent_node, filename): - """Shorthand for ``file_output``""" - return file_output(parent_node, filename) + return OutputNode([parent_node], output.__name__, filename=filename) __all__ = [ - 'file_input', - 'file_output', 'input', 'merge_outputs', 'output', diff --git a/ffmpeg/_run.py b/ffmpeg/_run.py index 8048abf..28a3e46 100644 --- a/ffmpeg/_run.py +++ b/ffmpeg/_run.py @@ -2,9 +2,9 @@ import operator as _operator import subprocess as _subprocess from ._ffmpeg import ( - file_input, - file_output, + input, merge_outputs, + output, overwrite_output, ) from .nodes import ( @@ -19,7 +19,7 @@ def _get_stream_name(name): def _get_input_args(input_node): - if input_node._name == file_input.__name__: + if input_node._name == input.__name__: args = ['-i', input_node._kwargs['filename']] else: assert False, 'Unsupported input node: {}'.format(input_node) @@ -73,7 +73,7 @@ def _get_output_args(node, stream_name_map): stream_name = stream_name_map[node._parents[0]] if stream_name != '[0]': args += ['-map', stream_name] - if node._name == file_output.__name__: + if node._name == output.__name__: args += [node._kwargs['filename']] else: assert False, 'Unsupported output node: {}'.format(node) diff --git a/ffmpeg/tests/test_ffmpeg.py b/ffmpeg/tests/test_ffmpeg.py index e32c5c6..99426e0 100644 --- a/ffmpeg/tests/test_ffmpeg.py +++ b/ffmpeg/tests/test_ffmpeg.py @@ -15,9 +15,9 @@ subprocess.check_call(['ffmpeg', '-version']) def test_fluent_equality(): - base1 = ffmpeg.file_input('dummy1.mp4') - base2 = ffmpeg.file_input('dummy1.mp4') - base3 = ffmpeg.file_input('dummy2.mp4') + base1 = ffmpeg.input('dummy1.mp4') + base2 = ffmpeg.input('dummy1.mp4') + base3 = ffmpeg.input('dummy2.mp4') t1 = base1.trim(start_frame=10, end_frame=20) t2 = base1.trim(start_frame=10, end_frame=20) t3 = base1.trim(start_frame=10, end_frame=30) @@ -30,7 +30,7 @@ def test_fluent_equality(): def test_fluent_concat(): - base = ffmpeg.file_input('dummy.mp4') + base = ffmpeg.input('dummy.mp4') trimmed1 = base.trim(start_frame=10, end_frame=20) trimmed2 = base.trim(start_frame=30, end_frame=40) trimmed3 = base.trim(start_frame=50, end_frame=60) @@ -46,45 +46,45 @@ def test_fluent_concat(): def test_fluent_output(): ffmpeg \ - .file_input('dummy.mp4') \ + .input('dummy.mp4') \ .trim(start_frame=10, end_frame=20) \ - .file_output('dummy2.mp4') + .output('dummy2.mp4') def test_fluent_complex_filter(): - in_file = ffmpeg.file_input('dummy.mp4') + in_file = ffmpeg.input('dummy.mp4') return ffmpeg \ .concat( in_file.trim(start_frame=10, end_frame=20), in_file.trim(start_frame=30, end_frame=40), in_file.trim(start_frame=50, end_frame=60) ) \ - .file_output('dummy2.mp4') + .output('dummy2.mp4') def test_repr(): - in_file = ffmpeg.file_input('dummy.mp4') + in_file = ffmpeg.input('dummy.mp4') trim1 = ffmpeg.trim(in_file, start_frame=10, end_frame=20) trim2 = ffmpeg.trim(in_file, start_frame=30, end_frame=40) trim3 = ffmpeg.trim(in_file, start_frame=50, end_frame=60) concatted = ffmpeg.concat(trim1, trim2, trim3) - output = ffmpeg.file_output(concatted, 'dummy2.mp4') - assert repr(in_file) == "file_input(filename='dummy.mp4')" + output = ffmpeg.output(concatted, 'dummy2.mp4') + assert repr(in_file) == "input(filename='dummy.mp4')" assert repr(trim1) == "trim(end_frame=20,start_frame=10)" assert repr(trim2) == "trim(end_frame=40,start_frame=30)" assert repr(trim3) == "trim(end_frame=60,start_frame=50)" assert repr(concatted) == "concat(n=3)" - assert repr(output) == "file_output(filename='dummy2.mp4')" + assert repr(output) == "output(filename='dummy2.mp4')" def test_get_args_simple(): - out_file = ffmpeg.file_input('dummy.mp4').file_output('dummy2.mp4') + out_file = ffmpeg.input('dummy.mp4').output('dummy2.mp4') assert out_file.get_args() == ['-i', 'dummy.mp4', 'dummy2.mp4'] def _get_complex_filter_example(): - in_file = ffmpeg.file_input(TEST_INPUT_FILE) - overlay_file = ffmpeg.file_input(TEST_OVERLAY_FILE) + in_file = ffmpeg.input(TEST_INPUT_FILE) + overlay_file = ffmpeg.input(TEST_OVERLAY_FILE) return ffmpeg \ .concat( in_file.trim(start_frame=10, end_frame=20), @@ -92,7 +92,7 @@ def _get_complex_filter_example(): ) \ .overlay(overlay_file.hflip()) \ .drawbox(50, 50, 120, 120, color='red', thickness=5) \ - .file_output(TEST_OUTPUT_FILE) \ + .output(TEST_OUTPUT_FILE) \ .overwrite_output()