Working on doc errors

This commit is contained in:
Fabrice Quenneville 2020-11-21 14:38:36 -05:00
parent 17fcb1fd2b
commit 6595d6d476
11 changed files with 171 additions and 41 deletions

View File

@ -3,12 +3,34 @@
Errors Errors
====== ======
FFmpeg can detect quite a few errors in the encoding of your source video's encoding. It can also be used to repair errors.
Repairable encoding errors
--------------------------
"Referenced QT chapter track not found", Here are some example errors that mediacurator will print and can possibly repair by re-encoding:
"Error, header damaged or not MPEG-4 header",
"Header missing", * "Referenced QT chapter track not found"
"SEI type", * "Error, header damaged or not MPEG-4 header"
"no frame!", * "Header missing"
"Error while decoding MPEG audio frame.", * "SEI type"
"big_values too big" * "no frame!"
* "Error while decoding MPEG audio frame."
* "big_values too big"
* ...
FFmpeg issues
-------------
While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.
If that happens there are a few steps you can take:
* Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories
* Run MediaCurator with the verbose print option wich will print the raw FFmpeg output
* Try again: In my experience some errors don't necessarly recur...
Other bugs
----------
If you face other bugs, issues or want to suggest features feel free to open a bug report on `GitHub <https://github.com/fabquenneville/MediaCurator/issues>`_

View File

@ -51,7 +51,12 @@
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#repairable-encoding-errors">Repairable encoding errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#ffmpeg-issues">FFmpeg issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#other-bugs">Other bugs</a></li>
</ul>
</li>
</ul> </ul>
</div> </div>
</div> </div>

View File

@ -1 +1 @@
Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],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/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":3,"720p":3,"case":0,"default":3,"while":1,For:2,The:0,Use:0,all:0,ani:3,audio:1,av1:[0,3],avi:3,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,comma:3,command:0,content:0,convert:3,curat:3,damag:1,databas:0,decod:1,del:3,dir:3,distribut:2,doubl:3,download:2,error:0,exampl:3,extent:0,fabquennevil:2,fferror:3,ffmpeg:0,file:3,filenam:3,filter:[0,3],flv:3,format:3,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:[0,3],lowr:3,m4v:3,manag:0,media2:3,media:[0,3],mediacur:2,medlist:3,miss:1,mkv:3,mnt:3,modern:0,modul:[],more:0,movi:3,mp4:3,mpeg4:3,mpeg:[1,3],mpg:3,multipl:3,now:2,old:3,onli:2,option:3,out:3,packag:2,page:[],pip:2,print:3,python:0,quickstart:0,recod:0,referenc:1,requir:2,search:[],sei:1,separ:3,sourc:0,thi:2,too:1,tool:0,track:1,txt:[2,3],type:1,uhd:3,use:3,valu:3,verbos:3,vid:3,video:0,without:0,wmv3:3,wmv:3,work:2,x264:3,x265:[0,3]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:3,tabl:[],welcom:0}}) Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],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/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":3,"720p":3,"case":0,"default":3,"try":1,"while":1,For:2,The:0,Use:0,activ:1,after:1,again:1,all:0,also:1,ani:3,audio:1,av1:[0,3],avi:3,base:0,bash:[],batch:0,big:1,big_valu:1,bug:0,can:[0,1],chapter:1,clean:1,clone:2,code:0,codec:0,com:2,comma:3,command:0,content:0,convert:3,curat:3,damag:1,databas:0,decod:1,del:3,depend:1,detect:1,dir:3,distribut:[1,2],don:1,doubl:3,download:2,encod:0,error:0,exampl:[1,3],experi:1,extent:0,fabquennevil:2,face:1,failur:1,featur:1,feel:1,few:1,fferror:3,ffmpeg:0,file:3,filenam:3,filter:[0,3],flv:3,format:3,found:[0,1],frame:1,free:1,from:0,git:2,github:[0,1],gnu:2,happen:1,header:1,here:1,http:2,index:[],inform:1,instal:0,issu:0,its:1,latest:1,like:1,line:0,linux:2,list:[0,3],lowr:3,m4v:3,mai:1,manag:0,media2:3,media:[0,3],mediacur:[1,2],medlist:3,miss:1,mkv:3,mnt:3,modern:0,modul:[],more:0,most:1,move:1,movi:3,mp4:3,mpeg4:3,mpeg:[1,3],mpg:3,multipl:3,necessarli:1,next:1,now:2,occur:1,old:[1,3],onli:2,open:1,option:[1,3],other:0,out:3,output:1,packag:2,page:[],pip:2,possibl:1,print:[1,3],project:1,python:0,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:0,report:1,repositori:1,requir:2,run:1,search:[],segfault:1,sei:1,separ:3,serv:1,some:1,sourc:[0,1],step:1,suggest:1,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3],type:1,uhd:3,updat:1,use:3,used:1,using:1,valu:3,verbos:[1,3],veri:1,version:1,vid:3,video:[0,1],want:1,when:1,wich:1,without:0,wmv3:3,wmv:3,work:2,x264:3,x265:[0,3],you:1,your:1},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,bug:1,document:0,encod:1,error:1,ffmpeg:[1,2],from:2,github:2,indic:[],instal:2,issu:1,mediacur:0,other:1,quickstart:3,repair:1,tabl:[],welcom:0}})

View File

@ -35,13 +35,35 @@
<div class="section" id="errors"> <div class="section" id="errors">
<h1>Errors<a class="headerlink" href="#errors" title="Permalink to this headline"></a></h1> <h1>Errors<a class="headerlink" href="#errors" title="Permalink to this headline"></a></h1>
<p>“Referenced QT chapter track not found”, <p>FFmpeg can detect quite a few errors in the encoding of your source videos encoding. It can also be used to repair errors.</p>
“Error, header damaged or not MPEG-4 header”, <div class="section" id="repairable-encoding-errors">
“Header missing”, <h2>Repairable encoding errors<a class="headerlink" href="#repairable-encoding-errors" title="Permalink to this headline"></a></h2>
“SEI type”, <p>Here are some example errors that mediacurator will print and can possibly repair by re-encoding:</p>
“no frame!”, <ul class="simple">
“Error while decoding MPEG audio frame.”, <li><p>“Referenced QT chapter track not found”</p></li>
“big_values too big”</p> <li><p>“Error, header damaged or not MPEG-4 header”</p></li>
<li><p>“Header missing”</p></li>
<li><p>“SEI type”</p></li>
<li><p>“no frame!”</p></li>
<li><p>“Error while decoding MPEG audio frame.”</p></li>
<li><p>“big_values too big”</p></li>
<li><p></p></li>
</ul>
</div>
<div class="section" id="ffmpeg-issues">
<h2>FFmpeg issues<a class="headerlink" href="#ffmpeg-issues" title="Permalink to this headline"></a></h2>
<p>While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.</p>
<p>If that happens there are a few steps you can take:</p>
<ul class="simple">
<li><p>Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories</p></li>
<li><p>Run MediaCurator with the verbose print option wich will print the raw FFmpeg output</p></li>
<li><p>Try again: In my experience some errors dont necessarly recur…</p></li>
</ul>
</div>
<div class="section" id="other-bugs">
<h2>Other bugs<a class="headerlink" href="#other-bugs" title="Permalink to this headline"></a></h2>
<p>If you face other bugs, issues or want to suggest features feel free to open a bug report on <a class="reference external" href="https://github.com/fabquenneville/MediaCurator/issues">GitHub</a></p>
</div>
</div> </div>
@ -69,7 +91,12 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li> <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Errors</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#repairable-encoding-errors">Repairable encoding errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ffmpeg-issues">FFmpeg issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="#other-bugs">Other bugs</a></li>
</ul>
</li>
</ul> </ul>
<div class="relations"> <div class="relations">

View File

@ -3,12 +3,34 @@
Errors Errors
====== ======
FFmpeg can detect quite a few errors in the encoding of your source video's encoding. It can also be used to repair errors.
Repairable encoding errors
--------------------------
"Referenced QT chapter track not found", Here are some example errors that mediacurator will print and can possibly repair by re-encoding:
"Error, header damaged or not MPEG-4 header",
"Header missing", * "Referenced QT chapter track not found"
"SEI type", * "Error, header damaged or not MPEG-4 header"
"no frame!", * "Header missing"
"Error while decoding MPEG audio frame.", * "SEI type"
"big_values too big" * "no frame!"
* "Error while decoding MPEG audio frame."
* "big_values too big"
* ...
FFmpeg issues
-------------
While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.
If that happens there are a few steps you can take:
* Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories
* Run MediaCurator with the verbose print option wich will print the raw FFmpeg output
* Try again: In my experience some errors don't necessarly recur...
Other bugs
----------
If you face other bugs, issues or want to suggest features feel free to open a bug report on `GitHub <https://github.com/fabquenneville/MediaCurator/issues>`_

View File

@ -51,7 +51,12 @@
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#repairable-encoding-errors">Repairable encoding errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#ffmpeg-issues">FFmpeg issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#other-bugs">Other bugs</a></li>
</ul>
</li>
</ul> </ul>
</div> </div>
</div> </div>

View File

@ -1 +1 @@
Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],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/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":3,"720p":3,"case":0,"default":3,"while":1,For:2,The:0,Use:0,all:0,ani:3,audio:1,av1:[0,3],avi:3,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,comma:3,command:0,content:0,convert:3,curat:3,damag:1,databas:0,decod:1,del:3,dir:3,distribut:2,doubl:3,download:2,error:0,exampl:3,extent:0,fabquennevil:2,fferror:3,ffmpeg:0,file:3,filenam:3,filter:[0,3],flv:3,format:3,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:[0,3],lowr:3,m4v:3,manag:0,media2:3,media:[0,3],mediacur:2,medlist:3,miss:1,mkv:3,mnt:3,modern:0,modul:[],more:0,movi:3,mp4:3,mpeg4:3,mpeg:[1,3],mpg:3,multipl:3,now:2,old:3,onli:2,option:3,out:3,packag:2,page:[],pip:2,print:3,python:0,quickstart:0,recod:0,referenc:1,requir:2,search:[],sei:1,separ:3,sourc:0,thi:2,too:1,tool:0,track:1,txt:[2,3],type:1,uhd:3,use:3,valu:3,verbos:3,vid:3,video:0,without:0,wmv3:3,wmv:3,work:2,x264:3,x265:[0,3]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:3,tabl:[],welcom:0}}) Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],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/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":3,"720p":3,"case":0,"default":3,"try":1,"while":1,For:2,The:0,Use:0,activ:1,after:1,again:1,all:0,also:1,ani:3,audio:1,av1:[0,3],avi:3,base:0,bash:[],batch:0,big:1,big_valu:1,bug:0,can:[0,1],chapter:1,clean:1,clone:2,code:0,codec:0,com:2,comma:3,command:0,content:0,convert:3,curat:3,damag:1,databas:0,decod:1,del:3,depend:1,detect:1,dir:3,distribut:[1,2],don:1,doubl:3,download:2,encod:0,error:0,exampl:[1,3],experi:1,extent:0,fabquennevil:2,face:1,failur:1,featur:1,feel:1,few:1,fferror:3,ffmpeg:0,file:3,filenam:3,filter:[0,3],flv:3,format:3,found:[0,1],frame:1,free:1,from:0,git:2,github:[0,1],gnu:2,happen:1,header:1,here:1,http:2,index:[],inform:1,instal:0,issu:0,its:1,latest:1,like:1,line:0,linux:2,list:[0,3],lowr:3,m4v:3,mai:1,manag:0,media2:3,media:[0,3],mediacur:[1,2],medlist:3,miss:1,mkv:3,mnt:3,modern:0,modul:[],more:0,most:1,move:1,movi:3,mp4:3,mpeg4:3,mpeg:[1,3],mpg:3,multipl:3,necessarli:1,next:1,now:2,occur:1,old:[1,3],onli:2,open:1,option:[1,3],other:0,out:3,output:1,packag:2,page:[],pip:2,possibl:1,print:[1,3],project:1,python:0,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:0,report:1,repositori:1,requir:2,run:1,search:[],segfault:1,sei:1,separ:3,serv:1,some:1,sourc:[0,1],step:1,suggest:1,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3],type:1,uhd:3,updat:1,use:3,used:1,using:1,valu:3,verbos:[1,3],veri:1,version:1,vid:3,video:[0,1],want:1,when:1,wich:1,without:0,wmv3:3,wmv:3,work:2,x264:3,x265:[0,3],you:1,your:1},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,bug:1,document:0,encod:1,error:1,ffmpeg:[1,2],from:2,github:2,indic:[],instal:2,issu:1,mediacur:0,other:1,quickstart:3,repair:1,tabl:[],welcom:0}})

View File

@ -35,13 +35,35 @@
<div class="section" id="errors"> <div class="section" id="errors">
<h1>Errors<a class="headerlink" href="#errors" title="Permalink to this headline"></a></h1> <h1>Errors<a class="headerlink" href="#errors" title="Permalink to this headline"></a></h1>
<p>“Referenced QT chapter track not found”, <p>FFmpeg can detect quite a few errors in the encoding of your source videos encoding. It can also be used to repair errors.</p>
“Error, header damaged or not MPEG-4 header”, <div class="section" id="repairable-encoding-errors">
“Header missing”, <h2>Repairable encoding errors<a class="headerlink" href="#repairable-encoding-errors" title="Permalink to this headline"></a></h2>
“SEI type”, <p>Here are some example errors that mediacurator will print and can possibly repair by re-encoding:</p>
“no frame!”, <ul class="simple">
“Error while decoding MPEG audio frame.”, <li><p>“Referenced QT chapter track not found”</p></li>
“big_values too big”</p> <li><p>“Error, header damaged or not MPEG-4 header”</p></li>
<li><p>“Header missing”</p></li>
<li><p>“SEI type”</p></li>
<li><p>“no frame!”</p></li>
<li><p>“Error while decoding MPEG audio frame.”</p></li>
<li><p>“big_values too big”</p></li>
<li><p></p></li>
</ul>
</div>
<div class="section" id="ffmpeg-issues">
<h2>FFmpeg issues<a class="headerlink" href="#ffmpeg-issues" title="Permalink to this headline"></a></h2>
<p>While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.</p>
<p>If that happens there are a few steps you can take:</p>
<ul class="simple">
<li><p>Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories</p></li>
<li><p>Run MediaCurator with the verbose print option wich will print the raw FFmpeg output</p></li>
<li><p>Try again: In my experience some errors dont necessarly recur…</p></li>
</ul>
</div>
<div class="section" id="other-bugs">
<h2>Other bugs<a class="headerlink" href="#other-bugs" title="Permalink to this headline"></a></h2>
<p>If you face other bugs, issues or want to suggest features feel free to open a bug report on <a class="reference external" href="https://github.com/fabquenneville/MediaCurator/issues">GitHub</a></p>
</div>
</div> </div>
@ -69,7 +91,12 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li> <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Errors</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#repairable-encoding-errors">Repairable encoding errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ffmpeg-issues">FFmpeg issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="#other-bugs">Other bugs</a></li>
</ul>
</li>
</ul> </ul>
<div class="relations"> <div class="relations">

View File

@ -3,12 +3,34 @@
Errors Errors
====== ======
FFmpeg can detect quite a few errors in the encoding of your source video's encoding. It can also be used to repair errors.
Repairable encoding errors
--------------------------
"Referenced QT chapter track not found", Here are some example errors that mediacurator will print and can possibly repair by re-encoding:
"Error, header damaged or not MPEG-4 header",
"Header missing", * "Referenced QT chapter track not found"
"SEI type", * "Error, header damaged or not MPEG-4 header"
"no frame!", * "Header missing"
"Error while decoding MPEG audio frame.", * "SEI type"
"big_values too big" * "no frame!"
* "Error while decoding MPEG audio frame."
* "big_values too big"
* ...
FFmpeg issues
-------------
While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.
If that happens there are a few steps you can take:
* Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories
* Run MediaCurator with the verbose print option wich will print the raw FFmpeg output
* Try again: In my experience some errors don't necessarly recur...
Other bugs
----------
If you face other bugs, issues or want to suggest features feel free to open a bug report on `GitHub <https://github.com/fabquenneville/MediaCurator/issues>`_