home-assistant.github.io/components/camera.ffmpeg/index.html
2016-08-31 07:03:24 +00:00

241 lines
No EOL
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>FFmpeg Camera - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate a Video fees with FFmpeg as cameras within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/camera.ffmpeg/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="FFmpeg Camera">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/camera.ffmpeg/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate a Video fees with FFmpeg as cameras within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="FFmpeg Camera">
<meta name="twitter:description" content="Instructions how to integrate a Video fees with FFmpeg as cameras within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
FFmpeg Camera
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">ffmpeg</code> platform allows you to use every video feed with <a href="http://www.ffmpeg.org/">FFmpeg</a> as camera in Home Assistant.</p>
<p class="note">
You need a ffmpeg binary in your system path. On debain 8 you can install it from backports. If you want HW support on raspberry you need self build from source. Windows binary are avilable on ffmpeg homepage.
</p>
<p>To enable your FFmpeg feed in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">camera</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ffmpeg</span>
<span class="s">input</span><span class="pi">:</span> <span class="s">FFMPEG_SUPPORTED_INPUT</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">FFmpeg</span>
<span class="s">ffmpeg_bin</span><span class="pi">:</span> <span class="s">/usr/bin/ffmpeg</span>
<span class="s">extra_arguments</span><span class="pi">:</span> <span class="s">-q:v 2</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>input</strong> (<em>Required</em>): A ffmpeg compatible input file, stream or feed.</li>
<li><strong>name</strong> (<em>Optional</em>): This parameter allows you to override the name of your camera.</li>
<li><strong>ffmpeg_bin</strong> (<em>Optional</em>): Default ffmpeg.</li>
<li><strong>extra_arguments</strong> (<em>Optional</em>): Extra option they will pass to ffmpeg. i.e. image quality or video filter options.</li>
</ul>
<h3><a class="title-link" name="image-quality" href="#image-quality"></a> Image quality</h3>
<p>You can control the <code class="highlighter-rouge">image quality</code> with <a href="https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000"><code class="highlighter-rouge">extra_arguments</code></a> <code class="highlighter-rouge">-q:v 2-32</code> or with lossless option <code class="highlighter-rouge">-pred 1</code>.</p>
<h3><a class="title-link" name="troubleshooting" href="#troubleshooting"></a> Troubleshooting</h3>
<p>In most of case, ffmpeg autodetect all needed options to read a video/audio stream or file. But it is possible in rare cases thats needed to set a option to help ffmpeg. Default ffmpeg use 5 seconds to detect all options or abord.</p>
<p>First check, if your stream playable by ffmpeg with (use option <code class="highlighter-rouge">-an</code> or <code class="highlighter-rouge">-vn</code> to disable video or audio stream):</p>
<div class="highlighter-rouge"><pre class="highlight"><code>ffmpeg -i INPUT -an -f null -
</code></pre>
</div>
<p>Now you can see what going wrong. Following list could be help to solve your trouble:</p>
<ul>
<li><code class="highlighter-rouge">[rtsp @ ...] UDP timeout, retrying with TCP</code>: You need to set rtsp transport in config with: <code class="highlighter-rouge">input: -rtsp_transport tcp -i INPUT</code></li>
<li><code class="highlighter-rouge">[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size</code>: FFmpeg need more data or time for autodetect. You can set the analyzeduration and/or probesize option, play with this value. If you know the needed value you can set it to config with: <code class="highlighter-rouge">input: -analyzeduration xy -probesize xy tcp -i INPUT</code>. More info about that on <a href="https://www.ffmpeg.org/ffmpeg-formats.html#Description">ffmpeg</a>.</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/camera.ffmpeg.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/ffmpeg.png' />
</div>
<div class='section'>
Introduced in release: 0.26
</div>
<div class='section'>
This is a platform for
<a href='/components/camera/'>the Camera component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/binary_sensor.ffmpeg/'>
FFmpeg Binary Sensor
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Camera</h1>
<ul class='divided'>
<li>
<a href='/components/camera.bloomsky/'>BloomSky Camera</a>
</li>
<li>
FFmpeg Camera
</li>
<li>
<a href='/components/camera.foscam/'>Foscam IP Camera</a>
</li>
<li>
<a href='/components/camera.generic/'>Generic IP Camera</a>
</li>
<li>
<a href='/components/camera.mjpeg/'>Generic MJPEG IP Camera</a>
</li>
<li>
<a href='/components/camera.local_file/'>Local File</a>
</li>
<li>
<a href='/components/ifttt.manything/'>ManyThing</a>
</li>
<li>
<a href='/components/camera.netatmo/'>Netatmo Camera</a>
</li>
<li>
<a href='/components/camera.rpi_camera/'>Raspberry Pi Camera</a>
</li>
<li>
<a href='/components/camera.uvc/'>UniFi Video Camera</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>