diff --git a/docs/_images/Screenshot-print_formated-single.png b/docs/_images/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docs/_images/Screenshot-print_formated-single.png differ diff --git a/docs/_images/Screenshot-print_list-single.png b/docs/_images/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docs/_images/Screenshot-print_list-single.png differ diff --git a/docs/_sources/usage/manual.rst.txt b/docs/_sources/usage/manual.rst.txt index 603544e..8b4893e 100644 --- a/docs/_sources/usage/manual.rst.txt +++ b/docs/_sources/usage/manual.rst.txt @@ -19,6 +19,18 @@ Synopsis [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] + +**for multiple files or filenames use double comma separated values ",,"** + +default options are: + +.. code-block:: bash + + -in:any + -filters: + -out:mkv,x265 + -print:list + Description ----------- @@ -33,37 +45,81 @@ Options list ==== - Print information +Search and list videos filtered by the parameters passed by the user. convert ======= +Search and convert all videos filtered by the parameters passed by the user. -del: ===== +Delete all original videos once selected operations have been done succefully. + +See :doc:`warnings` -in: ==== - [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] +[**any**,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] + +Search all videos of the selected container **extensions** in the directories. By default it will include any file format. -filters: ========= - [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] +[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] + +Filter the selected videos for parameters: + +* fferror: Select all videos with encoding errors (See :doc:`errors`) +* old: Select all videos using old codecs (Everything except hevc or av1) +* hd: 720p, 1080p, uhd +* lowres: Everything not hd +* uhd: if width >= 2160 or height >= 2160 +* 1080p: if less than uhd and width >= 1440 or height >= 1080 +* 720p: if less than 1080p and width >= 1280 or height >= 720: +* sd: if less than 720p and if height >= 480 +* subsd: Substandard definitions: Everything under 480p +* mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec -out: ===== - [mkv/mp4,x265/av1] +[**mkv**/mp4,x265/av1] + +Select the outputs for the video conversions + +* mkv: (**Default**) Package the resulting video in a `Matroska `_ container. +* mp4: Package the resulting video in a container. +* x265/hevc: (**Default**) Encode the video using the `x265 `_ compression format. +* av1: Encode the video using the `AOMedia Video 1 `_ compression format. This will be used as default once the developpers at FFmpeg move it out of `experimental `_ . -print: ======= - [list,formated,verbose] +[**list**,formated,verbose] + +* list: (**Default**) Print the information about the videos on a single line + +.. image:: ../_static/Screenshot-print_list-single.png + :width: 600 + :alt: Deleting videos + + +* formated: Print the information + +.. image:: ../_static/Screenshot-print_formated-single.png + :width: 400 + :alt: Deleting videos -dir: ===== - ["/mnt/media/",,"/mnt/media2/"] +["/mnt/media/",,"/mnt/media2/"] + +The directories to scan as a **double comma** separated values list. + -files: ======= - ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] +["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Specific videos to include as a **double comma** separated values list. Examples -------- @@ -88,37 +144,3 @@ Author ------ Fabrice Quenneville - - - - - - -**for multiple files or filenames use double comma separated values ",,"** - -default options are: - -.. code-block:: bash - - -in:any - -filters: - -out:mkv,x265 - -print:list - -Examples: - -.. code-block:: bash - - ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt - ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" - ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ - - - -Synopsis - - - -Description - - diff --git a/docs/_static/Screenshot-print_formated-single.png b/docs/_static/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docs/_static/Screenshot-print_formated-single.png differ diff --git a/docs/_static/Screenshot-print_formated.png b/docs/_static/Screenshot-print_formated.png new file mode 100644 index 0000000..c4e54d2 Binary files /dev/null and b/docs/_static/Screenshot-print_formated.png differ diff --git a/docs/_static/Screenshot-print_list-single.png b/docs/_static/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docs/_static/Screenshot-print_list-single.png differ diff --git a/docs/_static/Screenshot-print_list.png b/docs/_static/Screenshot-print_list.png new file mode 100644 index 0000000..9435934 Binary files /dev/null and b/docs/_static/Screenshot-print_list.png differ diff --git a/docs/searchindex.js b/docs/searchindex.js index 3a91b8f..3cd6e0f 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":[0,3,4],"default":[3,4],"try":1,"while":1,For:2,The:0,Use:[0,3,4],acquaint:6,activ:1,after:1,again:[1,6],all:[0,3,4,6],also:[0,1],ani:[3,4],audio:1,author:0,av1:[0,3,4],avi:[3,4],base:[0,3],bash:[],batch:[0,3],befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,3,4],com:2,comma:[3,4],command:[0,3,6],content:0,convert:[0,4,6],curat:[3,4,6],damag:[1,6],databas:[0,3],decod:1,del:[4,6],delet:[3,4,6],depend:1,descript:0,detect:1,dir:[4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,3,6],error:[0,3,6],exampl:[0,1,4],expect:6,experi:1,extens:[3,4],extent:[0,3],fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:[0,3,4],file:[4,6],filenam:[3,4],filter:[0,4,6],find:[0,3],flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,includ:[3,4],index:[],inform:[0,1,3],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:[0,3],linux:2,list:[0,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:[0,3],manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:[0,3],modul:[],more:[0,3,4],most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[0,1,4],origin:[3,4],other:0,out:4,output:[1,3,4],packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,4],project:1,properli:6,python:[0,3],quennevil:3,quickstart:0,quit:1,raw:1,recod:[0,3],recur:1,referenc:1,repair:[0,3,6],report:1,repositori:1,requir:2,resolut:[0,3],run:[1,6],search:[],see:0,segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,synopsi:0,take:1,text:[3,4],thi:2,too:1,tool:[0,3],track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,3,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:0,when:[1,6],wich:1,without:[0,3],wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,also:3,author:3,bug:1,convert:3,del:3,descript:3,dir:3,document:0,encod:1,error:1,exampl:3,ffmpeg:[1,2],file:3,filter:3,from:2,github:2,indic:[],instal:2,issu:1,list:3,manual:3,mediacur:0,name:3,option:3,other:1,out:3,print:3,quickstart:4,repair:1,see:3,synopsi:3,tabl:[],warn:6,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080":3,"1080p":[3,4],"1280":3,"1440":3,"2160":3,"480":3,"480p":3,"720":3,"720p":[3,4],"case":[0,3,4],"default":[3,4],"try":1,"while":1,For:2,The:[0,3],Use:[0,3,4],about:3,acquaint:6,activ:1,after:1,again:[1,6],all:[0,3,4,6],also:[0,1],ani:[3,4],aomedia:3,audio:1,author:0,av1:[0,3,4],avi:[3,4],base:[0,3],bash:[],batch:[0,3],been:3,befor:6,behavior:6,between:[],big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,3,4],com:2,comma:[3,4],command:[0,3,6],compress:3,contain:3,content:0,convers:3,convert:[0,4,6],curat:[3,4,6],damag:[1,6],databas:[0,3],decod:1,definit:3,del:[4,6],delet:[3,4,6],depend:1,descript:0,detect:1,developp:3,dir:[4,6],directori:3,distribut:[1,2],don:1,done:[3,6],doubl:[3,4],download:2,dry:6,encod:[0,3,6],error:[0,3,6],everyth:3,exampl:[0,1,4],except:3,expect:6,experi:1,experiment:3,extens:[3,4],extent:[0,3],fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:[0,3,4],file:[4,6],filenam:[3,4],filter:[0,4,6],find:[0,3],flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:[3,6],header:1,height:3,here:[1,6],hevc:3,http:2,includ:[3,4],index:[],inform:[0,1,3],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,less:3,librari:6,like:1,line:[0,3],linux:2,list:[0,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:[0,3],manual:0,matroska:3,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:[0,3],modul:[],more:[0,3,4],most:1,move:[1,3],movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onc:3,onli:2,open:1,oper:3,option:[0,1,4],origin:[3,4],other:0,out:4,output:[1,3,4],packag:[2,3],page:[],paramet:3,pass:3,pip:2,pleas:6,possibl:1,print:[1,4],project:1,properli:6,python:[0,3],quennevil:3,quickstart:0,quit:1,raw:1,recod:[0,3],recur:1,referenc:1,repair:[0,3,6],report:1,repositori:1,request:3,requir:2,resolut:[0,3],result:3,run:[1,6],scan:3,search:3,see:0,segfault:1,sei:1,select:3,separ:[3,4],serv:1,singl:3,some:1,sourc:[0,1],specif:3,step:1,subsd:[3,6],substandard:[3,6],succefulli:3,suggest:1,synopsi:0,take:1,text:[3,4],than:3,thi:[2,3],too:1,tool:[0,3],track:1,txt:[2,3,4],type:1,uhd:[3,4],under:3,unintend:6,until:6,updat:1,use:[3,4,6],used:[1,3,6],user:3,using:[1,3,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:[0,3],when:[1,6],wich:1,width:3,without:[0,3],wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,also:3,author:3,bug:1,convert:3,del:3,descript:3,dir:3,document:0,encod:1,error:1,exampl:3,ffmpeg:[1,2],file:3,filter:3,from:2,github:2,indic:[],instal:2,issu:1,list:3,manual:3,mediacur:0,name:3,option:3,other:1,out:3,print:3,quickstart:4,repair:1,see:3,synopsi:3,tabl:[],warn:6,welcom:0}}) \ No newline at end of file diff --git a/docs/usage/manual.html b/docs/usage/manual.html index 92069df..7972108 100644 --- a/docs/usage/manual.html +++ b/docs/usage/manual.html @@ -50,6 +50,14 @@ [-dir/-files:"/mnt/media/",,"/mnt/media2/"] +

for multiple files or filenames use double comma separated values “,,”

+

default options are:

+
-in:any
+-filters:
+-out:mkv,x265
+-print:list
+
+

Description

@@ -64,51 +72,71 @@

Options

list

-
-

Print information

-
+

Search and list videos filtered by the parameters passed by the user.

convert

+

Search and convert all videos filtered by the parameters passed by the user.

-del:

+

Delete all original videos once selected operations have been done succefully.

+

See Warnings

-in:

-
-

[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]

-
+

[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]

+

Search all videos of the selected container extensions in the directories. By default it will include any file format.

-filters:

-
-

[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]

-
+

[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]

+

Filter the selected videos for parameters:

+
    +

  • fferror: Select all videos with encoding errors (See Errors)

    • +

  • old: Select all videos using old codecs (Everything except hevc or av1)

    • +

  • hd: 720p, 1080p, uhd

    • +

  • lowres: Everything not hd

    • +

  • uhd: if width >= 2160 or height >= 2160

    • +

  • 1080p: if less than uhd and width >= 1440 or height >= 1080

    • +

  • 720p: if less than 1080p and width >= 1280 or height >= 720:

    • +

  • sd: if less than 720p and if height >= 480

    • +

  • subsd: Substandard definitions: Everything under 480p

    • +

  • mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec

    • +

-out:

-
-

[mkv/mp4,x265/av1]

-
+

[mkv/mp4,x265/av1]

+

Select the outputs for the video conversions

+
    +

  • mkv: (Default) Package the resulting video in a Matroska container.

    • +

  • mp4: Package the resulting video in a container.

    • +

  • x265/hevc: (Default) Encode the video using the x265 compression format.

    • +

  • av1: Encode the video using the AOMedia Video 1 compression format. This will be used as default once the developpers at FFmpeg move it out of experimental .

    • +

-print:

-
-

[list,formated,verbose]

-
+

[list,formated,verbose]

+
    +

  • list: (Default) Print the information about the videos on a single line

    • +
+Deleting videos +
    +

  • formated: Print the information

    • +
+Deleting videos

-dir:

-
-

[“/mnt/media/”,,”/mnt/media2/”]

-
+

[“/mnt/media/”,,”/mnt/media2/”]

+

The directories to scan as a double comma separated values list.

-files:

-
-

[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]

-
+

[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]

+

Specific videos to include as a double comma separated values list.

@@ -130,22 +158,6 @@

Author

Fabrice Quenneville

-

for multiple files or filenames use double comma separated values “,,”

-

default options are:

-
-in:any
--filters:
--out:mkv,x265
--print:list
-
-
-

Examples:

-
./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
-./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
-./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
-
-
-

Synopsis

-

Description

diff --git a/docsource/build/doctrees/environment.pickle b/docsource/build/doctrees/environment.pickle index 4ade313..3d15a31 100644 Binary files a/docsource/build/doctrees/environment.pickle and b/docsource/build/doctrees/environment.pickle differ diff --git a/docsource/build/doctrees/usage/manual.doctree b/docsource/build/doctrees/usage/manual.doctree index 407d1e5..af90069 100644 Binary files a/docsource/build/doctrees/usage/manual.doctree and b/docsource/build/doctrees/usage/manual.doctree differ diff --git a/docsource/build/html/_images/Screenshot-print_formated-single.png b/docsource/build/html/_images/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docsource/build/html/_images/Screenshot-print_formated-single.png differ diff --git a/docsource/build/html/_images/Screenshot-print_list-single.png b/docsource/build/html/_images/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docsource/build/html/_images/Screenshot-print_list-single.png differ diff --git a/docsource/build/html/_sources/usage/manual.rst.txt b/docsource/build/html/_sources/usage/manual.rst.txt index 603544e..8b4893e 100644 --- a/docsource/build/html/_sources/usage/manual.rst.txt +++ b/docsource/build/html/_sources/usage/manual.rst.txt @@ -19,6 +19,18 @@ Synopsis [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] + +**for multiple files or filenames use double comma separated values ",,"** + +default options are: + +.. code-block:: bash + + -in:any + -filters: + -out:mkv,x265 + -print:list + Description ----------- @@ -33,37 +45,81 @@ Options list ==== - Print information +Search and list videos filtered by the parameters passed by the user. convert ======= +Search and convert all videos filtered by the parameters passed by the user. -del: ===== +Delete all original videos once selected operations have been done succefully. + +See :doc:`warnings` -in: ==== - [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] +[**any**,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] + +Search all videos of the selected container **extensions** in the directories. By default it will include any file format. -filters: ========= - [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] +[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] + +Filter the selected videos for parameters: + +* fferror: Select all videos with encoding errors (See :doc:`errors`) +* old: Select all videos using old codecs (Everything except hevc or av1) +* hd: 720p, 1080p, uhd +* lowres: Everything not hd +* uhd: if width >= 2160 or height >= 2160 +* 1080p: if less than uhd and width >= 1440 or height >= 1080 +* 720p: if less than 1080p and width >= 1280 or height >= 720: +* sd: if less than 720p and if height >= 480 +* subsd: Substandard definitions: Everything under 480p +* mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec -out: ===== - [mkv/mp4,x265/av1] +[**mkv**/mp4,x265/av1] + +Select the outputs for the video conversions + +* mkv: (**Default**) Package the resulting video in a `Matroska `_ container. +* mp4: Package the resulting video in a container. +* x265/hevc: (**Default**) Encode the video using the `x265 `_ compression format. +* av1: Encode the video using the `AOMedia Video 1 `_ compression format. This will be used as default once the developpers at FFmpeg move it out of `experimental `_ . -print: ======= - [list,formated,verbose] +[**list**,formated,verbose] + +* list: (**Default**) Print the information about the videos on a single line + +.. image:: ../_static/Screenshot-print_list-single.png + :width: 600 + :alt: Deleting videos + + +* formated: Print the information + +.. image:: ../_static/Screenshot-print_formated-single.png + :width: 400 + :alt: Deleting videos -dir: ===== - ["/mnt/media/",,"/mnt/media2/"] +["/mnt/media/",,"/mnt/media2/"] + +The directories to scan as a **double comma** separated values list. + -files: ======= - ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] +["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Specific videos to include as a **double comma** separated values list. Examples -------- @@ -88,37 +144,3 @@ Author ------ Fabrice Quenneville - - - - - - -**for multiple files or filenames use double comma separated values ",,"** - -default options are: - -.. code-block:: bash - - -in:any - -filters: - -out:mkv,x265 - -print:list - -Examples: - -.. code-block:: bash - - ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt - ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" - ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ - - - -Synopsis - - - -Description - - diff --git a/docsource/build/html/_static/Screenshot-print_formated-single.png b/docsource/build/html/_static/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docsource/build/html/_static/Screenshot-print_formated-single.png differ diff --git a/docsource/build/html/_static/Screenshot-print_formated.png b/docsource/build/html/_static/Screenshot-print_formated.png new file mode 100644 index 0000000..c4e54d2 Binary files /dev/null and b/docsource/build/html/_static/Screenshot-print_formated.png differ diff --git a/docsource/build/html/_static/Screenshot-print_list-single.png b/docsource/build/html/_static/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docsource/build/html/_static/Screenshot-print_list-single.png differ diff --git a/docsource/build/html/_static/Screenshot-print_list.png b/docsource/build/html/_static/Screenshot-print_list.png new file mode 100644 index 0000000..9435934 Binary files /dev/null and b/docsource/build/html/_static/Screenshot-print_list.png differ diff --git a/docsource/build/html/searchindex.js b/docsource/build/html/searchindex.js index 3a91b8f..3cd6e0f 100644 --- a/docsource/build/html/searchindex.js +++ b/docsource/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":[0,3,4],"default":[3,4],"try":1,"while":1,For:2,The:0,Use:[0,3,4],acquaint:6,activ:1,after:1,again:[1,6],all:[0,3,4,6],also:[0,1],ani:[3,4],audio:1,author:0,av1:[0,3,4],avi:[3,4],base:[0,3],bash:[],batch:[0,3],befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,3,4],com:2,comma:[3,4],command:[0,3,6],content:0,convert:[0,4,6],curat:[3,4,6],damag:[1,6],databas:[0,3],decod:1,del:[4,6],delet:[3,4,6],depend:1,descript:0,detect:1,dir:[4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,3,6],error:[0,3,6],exampl:[0,1,4],expect:6,experi:1,extens:[3,4],extent:[0,3],fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:[0,3,4],file:[4,6],filenam:[3,4],filter:[0,4,6],find:[0,3],flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,includ:[3,4],index:[],inform:[0,1,3],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:[0,3],linux:2,list:[0,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:[0,3],manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:[0,3],modul:[],more:[0,3,4],most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[0,1,4],origin:[3,4],other:0,out:4,output:[1,3,4],packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,4],project:1,properli:6,python:[0,3],quennevil:3,quickstart:0,quit:1,raw:1,recod:[0,3],recur:1,referenc:1,repair:[0,3,6],report:1,repositori:1,requir:2,resolut:[0,3],run:[1,6],search:[],see:0,segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,synopsi:0,take:1,text:[3,4],thi:2,too:1,tool:[0,3],track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,3,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:0,when:[1,6],wich:1,without:[0,3],wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,also:3,author:3,bug:1,convert:3,del:3,descript:3,dir:3,document:0,encod:1,error:1,exampl:3,ffmpeg:[1,2],file:3,filter:3,from:2,github:2,indic:[],instal:2,issu:1,list:3,manual:3,mediacur:0,name:3,option:3,other:1,out:3,print:3,quickstart:4,repair:1,see:3,synopsi:3,tabl:[],warn:6,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080":3,"1080p":[3,4],"1280":3,"1440":3,"2160":3,"480":3,"480p":3,"720":3,"720p":[3,4],"case":[0,3,4],"default":[3,4],"try":1,"while":1,For:2,The:[0,3],Use:[0,3,4],about:3,acquaint:6,activ:1,after:1,again:[1,6],all:[0,3,4,6],also:[0,1],ani:[3,4],aomedia:3,audio:1,author:0,av1:[0,3,4],avi:[3,4],base:[0,3],bash:[],batch:[0,3],been:3,befor:6,behavior:6,between:[],big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,3,4],com:2,comma:[3,4],command:[0,3,6],compress:3,contain:3,content:0,convers:3,convert:[0,4,6],curat:[3,4,6],damag:[1,6],databas:[0,3],decod:1,definit:3,del:[4,6],delet:[3,4,6],depend:1,descript:0,detect:1,developp:3,dir:[4,6],directori:3,distribut:[1,2],don:1,done:[3,6],doubl:[3,4],download:2,dry:6,encod:[0,3,6],error:[0,3,6],everyth:3,exampl:[0,1,4],except:3,expect:6,experi:1,experiment:3,extens:[3,4],extent:[0,3],fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:[0,3,4],file:[4,6],filenam:[3,4],filter:[0,4,6],find:[0,3],flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:[3,6],header:1,height:3,here:[1,6],hevc:3,http:2,includ:[3,4],index:[],inform:[0,1,3],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,less:3,librari:6,like:1,line:[0,3],linux:2,list:[0,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:[0,3],manual:0,matroska:3,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:[0,3],modul:[],more:[0,3,4],most:1,move:[1,3],movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onc:3,onli:2,open:1,oper:3,option:[0,1,4],origin:[3,4],other:0,out:4,output:[1,3,4],packag:[2,3],page:[],paramet:3,pass:3,pip:2,pleas:6,possibl:1,print:[1,4],project:1,properli:6,python:[0,3],quennevil:3,quickstart:0,quit:1,raw:1,recod:[0,3],recur:1,referenc:1,repair:[0,3,6],report:1,repositori:1,request:3,requir:2,resolut:[0,3],result:3,run:[1,6],scan:3,search:3,see:0,segfault:1,sei:1,select:3,separ:[3,4],serv:1,singl:3,some:1,sourc:[0,1],specif:3,step:1,subsd:[3,6],substandard:[3,6],succefulli:3,suggest:1,synopsi:0,take:1,text:[3,4],than:3,thi:[2,3],too:1,tool:[0,3],track:1,txt:[2,3,4],type:1,uhd:[3,4],under:3,unintend:6,until:6,updat:1,use:[3,4,6],used:[1,3,6],user:3,using:[1,3,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:[0,3],when:[1,6],wich:1,width:3,without:[0,3],wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,also:3,author:3,bug:1,convert:3,del:3,descript:3,dir:3,document:0,encod:1,error:1,exampl:3,ffmpeg:[1,2],file:3,filter:3,from:2,github:2,indic:[],instal:2,issu:1,list:3,manual:3,mediacur:0,name:3,option:3,other:1,out:3,print:3,quickstart:4,repair:1,see:3,synopsi:3,tabl:[],warn:6,welcom:0}}) \ No newline at end of file diff --git a/docsource/build/html/usage/manual.html b/docsource/build/html/usage/manual.html index 92069df..7972108 100644 --- a/docsource/build/html/usage/manual.html +++ b/docsource/build/html/usage/manual.html @@ -50,6 +50,14 @@ [-dir/-files:"/mnt/media/",,"/mnt/media2/"] +

for multiple files or filenames use double comma separated values “,,”

+

default options are:

+
-in:any
+-filters:
+-out:mkv,x265
+-print:list
+
+

Description

@@ -64,51 +72,71 @@

Options

list

-
-

Print information

-
+

Search and list videos filtered by the parameters passed by the user.

convert

+

Search and convert all videos filtered by the parameters passed by the user.

-del:

+

Delete all original videos once selected operations have been done succefully.

+

See Warnings

-in:

-
-

[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]

-
+

[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]

+

Search all videos of the selected container extensions in the directories. By default it will include any file format.

-filters:

-
-

[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]

-
+

[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]

+

Filter the selected videos for parameters:

+
    +

  • fferror: Select all videos with encoding errors (See Errors)

    • +

  • old: Select all videos using old codecs (Everything except hevc or av1)

    • +

  • hd: 720p, 1080p, uhd

    • +

  • lowres: Everything not hd

    • +

  • uhd: if width >= 2160 or height >= 2160

    • +

  • 1080p: if less than uhd and width >= 1440 or height >= 1080

    • +

  • 720p: if less than 1080p and width >= 1280 or height >= 720:

    • +

  • sd: if less than 720p and if height >= 480

    • +

  • subsd: Substandard definitions: Everything under 480p

    • +

  • mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec

    • +

-out:

-
-

[mkv/mp4,x265/av1]

-
+

[mkv/mp4,x265/av1]

+

Select the outputs for the video conversions

+
    +

  • mkv: (Default) Package the resulting video in a Matroska container.

    • +

  • mp4: Package the resulting video in a container.

    • +

  • x265/hevc: (Default) Encode the video using the x265 compression format.

    • +

  • av1: Encode the video using the AOMedia Video 1 compression format. This will be used as default once the developpers at FFmpeg move it out of experimental .

    • +

-print:

-
-

[list,formated,verbose]

-
+

[list,formated,verbose]

+
    +

  • list: (Default) Print the information about the videos on a single line

    • +
+Deleting videos +
    +

  • formated: Print the information

    • +
+Deleting videos

-dir:

-
-

[“/mnt/media/”,,”/mnt/media2/”]

-
+

[“/mnt/media/”,,”/mnt/media2/”]

+

The directories to scan as a double comma separated values list.

-files:

-
-

[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]

-
+

[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]

+

Specific videos to include as a double comma separated values list.

@@ -130,22 +158,6 @@

Author

Fabrice Quenneville

-

for multiple files or filenames use double comma separated values “,,”

-

default options are:

-
-in:any
--filters:
--out:mkv,x265
--print:list
-
-
-

Examples:

-
./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
-./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
-./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
-
-
-

Synopsis

-

Description

diff --git a/docsource/source/_build/html/.doctrees/environment.pickle b/docsource/source/_build/html/.doctrees/environment.pickle index b677320..0dda3f4 100644 Binary files a/docsource/source/_build/html/.doctrees/environment.pickle and b/docsource/source/_build/html/.doctrees/environment.pickle differ diff --git a/docsource/source/_build/html/.doctrees/usage/manual.doctree b/docsource/source/_build/html/.doctrees/usage/manual.doctree index e8a41f1..af90069 100644 Binary files a/docsource/source/_build/html/.doctrees/usage/manual.doctree and b/docsource/source/_build/html/.doctrees/usage/manual.doctree differ diff --git a/docsource/source/_build/html/_images/Screenshot-print_formated-single.png b/docsource/source/_build/html/_images/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docsource/source/_build/html/_images/Screenshot-print_formated-single.png differ diff --git a/docsource/source/_build/html/_images/Screenshot-print_list-single.png b/docsource/source/_build/html/_images/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docsource/source/_build/html/_images/Screenshot-print_list-single.png differ diff --git a/docsource/source/_build/html/_sources/usage/manual.rst.txt b/docsource/source/_build/html/_sources/usage/manual.rst.txt index 45b1c1b..8b4893e 100644 --- a/docsource/source/_build/html/_sources/usage/manual.rst.txt +++ b/docsource/source/_build/html/_sources/usage/manual.rst.txt @@ -45,37 +45,81 @@ Options list ==== - Print information +Search and list videos filtered by the parameters passed by the user. convert ======= +Search and convert all videos filtered by the parameters passed by the user. -del: ===== +Delete all original videos once selected operations have been done succefully. + +See :doc:`warnings` -in: ==== - [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] +[**any**,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] + +Search all videos of the selected container **extensions** in the directories. By default it will include any file format. -filters: ========= - [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] +[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] + +Filter the selected videos for parameters: + +* fferror: Select all videos with encoding errors (See :doc:`errors`) +* old: Select all videos using old codecs (Everything except hevc or av1) +* hd: 720p, 1080p, uhd +* lowres: Everything not hd +* uhd: if width >= 2160 or height >= 2160 +* 1080p: if less than uhd and width >= 1440 or height >= 1080 +* 720p: if less than 1080p and width >= 1280 or height >= 720: +* sd: if less than 720p and if height >= 480 +* subsd: Substandard definitions: Everything under 480p +* mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec -out: ===== - [mkv/mp4,x265/av1] +[**mkv**/mp4,x265/av1] + +Select the outputs for the video conversions + +* mkv: (**Default**) Package the resulting video in a `Matroska `_ container. +* mp4: Package the resulting video in a container. +* x265/hevc: (**Default**) Encode the video using the `x265 `_ compression format. +* av1: Encode the video using the `AOMedia Video 1 `_ compression format. This will be used as default once the developpers at FFmpeg move it out of `experimental `_ . -print: ======= - [list,formated,verbose] +[**list**,formated,verbose] + +* list: (**Default**) Print the information about the videos on a single line + +.. image:: ../_static/Screenshot-print_list-single.png + :width: 600 + :alt: Deleting videos + + +* formated: Print the information + +.. image:: ../_static/Screenshot-print_formated-single.png + :width: 400 + :alt: Deleting videos -dir: ===== - ["/mnt/media/",,"/mnt/media2/"] +["/mnt/media/",,"/mnt/media2/"] + +The directories to scan as a **double comma** separated values list. + -files: ======= - ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] +["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Specific videos to include as a **double comma** separated values list. Examples -------- diff --git a/docsource/source/_build/html/_static/Screenshot-print_formated-single.png b/docsource/source/_build/html/_static/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docsource/source/_build/html/_static/Screenshot-print_formated-single.png differ diff --git a/docsource/source/_build/html/_static/Screenshot-print_formated.png b/docsource/source/_build/html/_static/Screenshot-print_formated.png new file mode 100644 index 0000000..c4e54d2 Binary files /dev/null and b/docsource/source/_build/html/_static/Screenshot-print_formated.png differ diff --git a/docsource/source/_build/html/_static/Screenshot-print_list-single.png b/docsource/source/_build/html/_static/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docsource/source/_build/html/_static/Screenshot-print_list-single.png differ diff --git a/docsource/source/_build/html/_static/Screenshot-print_list.png b/docsource/source/_build/html/_static/Screenshot-print_list.png new file mode 100644 index 0000000..9435934 Binary files /dev/null and b/docsource/source/_build/html/_static/Screenshot-print_list.png differ diff --git a/docsource/source/_build/html/searchindex.js b/docsource/source/_build/html/searchindex.js index 00d7a43..7b71580 100644 --- a/docsource/source/_build/html/searchindex.js +++ b/docsource/source/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":[0,3,4],"default":[3,4],"try":1,"while":1,For:2,The:0,Use:[0,3,4],acquaint:6,activ:1,after:1,again:[1,6],all:[0,3,4,6],also:[0,1],ani:[3,4],audio:1,author:0,av1:[0,3,4],avi:[3,4],base:[0,3],bash:[],batch:[0,3],befor:6,behavior:6,big:1,big_valu:1,block:[],bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,3,4],com:2,comma:[3,4],command:[0,3,6],content:0,convert:[0,4,6],curat:[3,4,6],damag:[1,6],databas:[0,3],decod:1,del:[4,6],delet:[3,4,6],depend:1,descript:0,detect:1,dir:[4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,3,6],error:[0,3,6],exampl:[0,1,4],expect:6,experi:1,extens:[3,4],extent:[0,3],fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:[0,3,4],file:[4,6],filenam:[3,4],filter:[0,4,6],find:[0,3],flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,includ:[3,4],index:[],inform:[0,1,3],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:[0,3],linux:2,list:[0,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:[0,3],manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:[0,3],modul:[],more:[0,3,4],most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[0,1,4],origin:[3,4],other:0,out:4,output:[1,3,4],packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,4],project:1,properli:6,python:[0,3],quennevil:3,quickstart:0,quit:1,raw:1,recod:[0,3],recur:1,referenc:1,repair:[0,3,6],report:1,repositori:1,requir:2,resolut:[0,3],run:[1,6],search:[],see:0,segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,synopsi:0,take:1,text:[3,4],thi:2,too:1,tool:[0,3],track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,3,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:0,when:[1,6],wich:1,without:[0,3],wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,For:[],Use:5,also:3,author:3,bug:1,convert:3,del:3,descript:3,dir:3,distribut:[],document:0,download:[],encod:1,error:1,exampl:3,ffmpeg:[1,2],file:3,filter:3,from:2,github:2,gnu:[],indic:[],instal:2,issu:1,linux:[],list:3,manual:3,mediacur:0,name:3,now:[],onli:[],option:3,other:1,out:3,packag:[],print:3,quickstart:4,repair:1,requir:[],see:3,synopsi:3,tabl:[],thi:[],warn:6,welcom:0,work:[]}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080":3,"1080p":[3,4],"1280":3,"1440":3,"2160":3,"480":3,"480p":3,"600":[],"720":3,"720p":[3,4],"case":[0,3,4],"default":[3,4],"try":1,"while":1,For:2,The:[0,3],Use:[0,3,4],_static:[],about:3,acquaint:6,activ:1,after:1,again:[1,6],all:[0,3,4,6],also:[0,1],alt:[],ani:[3,4],aomedia:3,audio:1,author:0,av1:[0,3,4],avi:[3,4],base:[0,3],bash:[],batch:[0,3],been:3,befor:6,behavior:6,between:[],big:1,big_valu:1,block:[],bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,3,4],com:2,comma:[3,4],command:[0,3,6],compress:3,contain:3,content:0,convers:3,convert:[0,4,6],curat:[3,4,6],damag:[1,6],databas:[0,3],decod:1,definit:3,del:[4,6],delet:[3,4,6],depend:1,descript:0,detect:1,developp:3,dir:[4,6],directori:3,distribut:[1,2],don:1,done:[3,6],doubl:[3,4],download:2,dry:6,either:[],encod:[0,3,6],error:[0,3,6],everyth:3,exampl:[0,1,4],except:3,expect:6,experi:1,experiment:3,extens:[3,4],extent:[0,3],fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:[0,3,4],file:[4,6],filenam:[3,4],filter:[0,4,6],find:[0,3],flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:[3,6],header:1,height:3,here:[1,6],hevc:3,http:2,imag:[],includ:[3,4],index:[],inform:[0,1,3],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,less:3,librari:6,like:1,line:[0,3],linux:2,list:[0,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:[0,3],manual:0,matroska:3,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:[0,3],modul:[],more:[0,3,4],most:1,move:[1,3],movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onc:3,onli:2,open:1,oper:3,option:[0,1,4],origin:[3,4],other:0,out:4,output:[1,3,4],packag:[2,3],page:[],paramet:3,part:[],pass:3,pip:2,pleas:6,png:[],possibl:1,print:[1,4],project:1,properli:6,python:[0,3],quennevil:3,quickstart:0,quit:1,raw:1,recod:[0,3],recur:1,referenc:1,repair:[0,3,6],report:1,repositori:1,request:3,requir:2,resolut:[0,3],result:3,run:[1,6],scan:3,screenshot:[],search:3,see:0,segfault:1,sei:1,select:3,separ:[3,4],serv:1,singl:3,some:1,sourc:[0,1],specif:3,step:1,subsd:[3,6],substandard:[3,6],succefulli:3,suggest:1,synopsi:0,take:1,text:[3,4],than:3,thi:[2,3],too:1,tool:[0,3],track:1,txt:[2,3,4],type:1,uhd:[3,4],under:3,unintend:6,until:6,updat:1,use:[3,4,6],used:[1,3,6],user:3,using:[1,3,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:[0,3],when:[1,6],wich:1,width:3,without:[0,3],wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"1080p":[],"720p":[],"case":5,For:[],Use:5,also:3,ani:[],author:3,av1:[],avi:[],bug:1,convert:3,del:3,descript:3,dir:3,distribut:[],document:0,download:[],encod:1,error:1,exampl:3,fferror:[],ffmpeg:[1,2],file:3,filter:3,flv:[],format:[],from:2,github:2,gnu:[],indic:[],instal:2,issu:1,linux:[],list:3,lowr:[],m4v:[],manual:3,mediacur:0,mkv:[],mp4:[],mpeg4:[],mpeg:[],mpg:[],name:3,now:[],old:[],onli:[],option:3,other:1,out:3,packag:[],print:3,quickstart:4,repair:1,requir:[],see:3,synopsi:3,tabl:[],thi:[],uhd:[],verbos:[],vid:[],warn:6,welcom:0,wmv3:[],wmv:[],work:[],x264:[],x265:[]}}) \ No newline at end of file diff --git a/docsource/source/_build/html/usage/manual.html b/docsource/source/_build/html/usage/manual.html index df40373..7972108 100644 --- a/docsource/source/_build/html/usage/manual.html +++ b/docsource/source/_build/html/usage/manual.html @@ -72,51 +72,71 @@

Options

list

-
-

Print information

-
+

Search and list videos filtered by the parameters passed by the user.

convert

+

Search and convert all videos filtered by the parameters passed by the user.

-del:

+

Delete all original videos once selected operations have been done succefully.

+

See Warnings

-in:

-
-

[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]

-
+

[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]

+

Search all videos of the selected container extensions in the directories. By default it will include any file format.

-filters:

-
-

[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]

-
+

[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]

+

Filter the selected videos for parameters:

+
    +

  • fferror: Select all videos with encoding errors (See Errors)

    • +

  • old: Select all videos using old codecs (Everything except hevc or av1)

    • +

  • hd: 720p, 1080p, uhd

    • +

  • lowres: Everything not hd

    • +

  • uhd: if width >= 2160 or height >= 2160

    • +

  • 1080p: if less than uhd and width >= 1440 or height >= 1080

    • +

  • 720p: if less than 1080p and width >= 1280 or height >= 720:

    • +

  • sd: if less than 720p and if height >= 480

    • +

  • subsd: Substandard definitions: Everything under 480p

    • +

  • mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec

    • +

-out:

-
-

[mkv/mp4,x265/av1]

-
+

[mkv/mp4,x265/av1]

+

Select the outputs for the video conversions

+
    +

  • mkv: (Default) Package the resulting video in a Matroska container.

    • +

  • mp4: Package the resulting video in a container.

    • +

  • x265/hevc: (Default) Encode the video using the x265 compression format.

    • +

  • av1: Encode the video using the AOMedia Video 1 compression format. This will be used as default once the developpers at FFmpeg move it out of experimental .

    • +

-print:

-
-

[list,formated,verbose]

-
+

[list,formated,verbose]

+
    +

  • list: (Default) Print the information about the videos on a single line

    • +
+Deleting videos +
    +

  • formated: Print the information

    • +
+Deleting videos

-dir:

-
-

[“/mnt/media/”,,”/mnt/media2/”]

-
+

[“/mnt/media/”,,”/mnt/media2/”]

+

The directories to scan as a double comma separated values list.

-files:

-
-

[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]

-
+

[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]

+

Specific videos to include as a double comma separated values list.

diff --git a/docsource/source/_static/Screenshot-print_formated-single.png b/docsource/source/_static/Screenshot-print_formated-single.png new file mode 100644 index 0000000..34095e2 Binary files /dev/null and b/docsource/source/_static/Screenshot-print_formated-single.png differ diff --git a/docsource/source/_static/Screenshot-print_formated.png b/docsource/source/_static/Screenshot-print_formated.png new file mode 100644 index 0000000..c4e54d2 Binary files /dev/null and b/docsource/source/_static/Screenshot-print_formated.png differ diff --git a/docsource/source/_static/Screenshot-print_list-single.png b/docsource/source/_static/Screenshot-print_list-single.png new file mode 100644 index 0000000..057ec60 Binary files /dev/null and b/docsource/source/_static/Screenshot-print_list-single.png differ diff --git a/docsource/source/_static/Screenshot-print_list.png b/docsource/source/_static/Screenshot-print_list.png new file mode 100644 index 0000000..9435934 Binary files /dev/null and b/docsource/source/_static/Screenshot-print_list.png differ diff --git a/docsource/source/usage/manual.rst b/docsource/source/usage/manual.rst index 45b1c1b..8b4893e 100644 --- a/docsource/source/usage/manual.rst +++ b/docsource/source/usage/manual.rst @@ -45,37 +45,81 @@ Options list ==== - Print information +Search and list videos filtered by the parameters passed by the user. convert ======= +Search and convert all videos filtered by the parameters passed by the user. -del: ===== +Delete all original videos once selected operations have been done succefully. + +See :doc:`warnings` -in: ==== - [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] +[**any**,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] + +Search all videos of the selected container **extensions** in the directories. By default it will include any file format. -filters: ========= - [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] +[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] + +Filter the selected videos for parameters: + +* fferror: Select all videos with encoding errors (See :doc:`errors`) +* old: Select all videos using old codecs (Everything except hevc or av1) +* hd: 720p, 1080p, uhd +* lowres: Everything not hd +* uhd: if width >= 2160 or height >= 2160 +* 1080p: if less than uhd and width >= 1440 or height >= 1080 +* 720p: if less than 1080p and width >= 1280 or height >= 720: +* sd: if less than 720p and if height >= 480 +* subsd: Substandard definitions: Everything under 480p +* mpeg,mpeg4,x264,wmv3,wmv: Filter for videos encoded in the requested video codec -out: ===== - [mkv/mp4,x265/av1] +[**mkv**/mp4,x265/av1] + +Select the outputs for the video conversions + +* mkv: (**Default**) Package the resulting video in a `Matroska `_ container. +* mp4: Package the resulting video in a container. +* x265/hevc: (**Default**) Encode the video using the `x265 `_ compression format. +* av1: Encode the video using the `AOMedia Video 1 `_ compression format. This will be used as default once the developpers at FFmpeg move it out of `experimental `_ . -print: ======= - [list,formated,verbose] +[**list**,formated,verbose] + +* list: (**Default**) Print the information about the videos on a single line + +.. image:: ../_static/Screenshot-print_list-single.png + :width: 600 + :alt: Deleting videos + + +* formated: Print the information + +.. image:: ../_static/Screenshot-print_formated-single.png + :width: 400 + :alt: Deleting videos -dir: ===== - ["/mnt/media/",,"/mnt/media2/"] +["/mnt/media/",,"/mnt/media2/"] + +The directories to scan as a **double comma** separated values list. + -files: ======= - ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] +["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Specific videos to include as a **double comma** separated values list. Examples --------