Flumotion manual
Murray Cumming, Flumotion Documentation Team Thomas Vander Stichele, Flumotion Documentation Team Christian Fredrik Kalager Schaller, Flumotion Documentation Team
Flumotion manual by Murray Cumming, Thomas Vander Stichele, and Christian Fredrik Kalager Schaller Copyright © 2004,2005,2006,2007,2008 Fluendo
Abstract User manual for Flumotion. Flumotion is a trademark of Fluendo.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this link [ghelp:fdl] or in the file COPYING-DOCS distributed distributed with this manual. Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any documentation, and the authors are made aware of those trademarks, then the names a re in capital letters or initial capital letters. Some versions of this document appear with navigation icons from the Tango project. These are licensed under the Creative Commons Attribution Share-Alike license. DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT: 1. DOCUMENT IS PROVIDED PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY WARRANTY OF ANY KIND, EITHER EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.
Flumotion manual by Murray Cumming, Thomas Vander Stichele, and Christian Fredrik Kalager Schaller Copyright © 2004,2005,2006,2007,2008 Fluendo
Abstract User manual for Flumotion. Flumotion is a trademark of Fluendo.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this link [ghelp:fdl] or in the file COPYING-DOCS distributed distributed with this manual. Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any documentation, and the authors are made aware of those trademarks, then the names a re in capital letters or initial capital letters. Some versions of this document appear with navigation icons from the Tango project. These are licensed under the Creative Commons Attribution Share-Alike license. DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT: 1. DOCUMENT IS PROVIDED PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY WARRANTY OF ANY KIND, EITHER EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.
Table of Contents I. Usin Using g Flum Flumot otio ion n ..... ....................................................... ................................................. 1 1. Intro Introdu duct ctio ion n ........................................................ ................................................... 4 Intr Introd oduc ucti tion on To Stre Stream amin ing g ...... ..... ...... ..... ...... ...... ..... ...... ..... ...... ...... ..... ...... ..... ..... 4 Intr Introd oduc ucti tion on To Flum Flumot otio ion n ...... ..... ...... ..... ..... ...... ..... ...... ..... ...... ...... ..... ...... ..... ..... . 4 2. Quick Start ...................................... ............................................................................................. ....................................................... ............... 5 Installation .................................................. ........ ........................................................................................... ................................................. ..... 5 Starting Flumotion Flumotio n .............................................................................................. .............................................................................................. 6 3. Using The Assistant ............................................................................................... ............................................................................................... 16 Detailed Example Example .............................................................................................. .............................................................................................. 16 Summary .......................................... ......................................................................................................... ............................................................... 28 4. Architecture ............................................. ... ............................................................................................ .................................................. .......... 30 30 Introduction ................................. ...... ................................................................................ ..................................................... ............... 30 30 Components ................................... ...... ............................................................................. ................................................ .................. 30 30 Managers And And Work Worker erss .... ...... ..... ..................................................... ..................................................... ................. 32 32 5. Deployment ...................... .......................................................................................................... .................................................................................... 33 Service scripts For Fo r Startup .................................................................................. . ................................................................................. 33 Configuration Configuration File Filess .... ...... .......................................................... .... ...................................................... ....................... 34 34 System Users ............................................. .... ......................................................................................... ................................................ ...... 44 44 Multiple Servers .......................................................................................... .......................................................................................... ..... 45 45 6. Usage Scenarios ......................................... ..... ............................................................................................... ........................................................... 46 Live Streaming Stream ing of a Conference ................................................................ ................................................................ .......... 46 46 On Demand Demand Streaming Of Files ........................................................................... .......... ................................................................. 50 7. Security ..................................................... ....................................................................................................... .................................................. ........ 53 53 Authentication of Connections Connections ............................................................... ............................................................... ............. 53 53 Transport Protocol Protocol Between Processes ............................................................ ........... ................................................. ...... 53 53 Firewall Issues .. ...................................................................................... ...................................................................................... ......... 54 54 8. Optimization and Performance Pe rformance ................................................................................. ................................................................................. 56 Component Locations Locations ............................................................................ ............................................................................ ............ 56 56 Limiting Bandwidth Ba ndwidth ................................................................................... ................................................................................... ....... 56 56 System Configuration Configura tion ................................................................... ................................................................... ..................... 57 57 9. Debugging and Troubleshooting Troubleshooting ............................................................................... ............................................................................... 60 Debugging Flumoti Flumotion on . ................................................................................... ................................................................................... .... 60 60 Troubleshooting Troubleshooting Flumot Flumotio ion n .................................................... ............................. 65 A. Flumotion Services S.A. S.A. ......... ............................................................................... ............................................................................... 67 B. Installing Extra Dependencies Dep endencies ................................................................................. ................................................................................. 68 Installing Python Python Modules ......................................................... ..... .................................................... ......................... 68 68 Testing Python Mod Modul ules es ..... ..... ........................................................................... ........................................................................... 69 Installing GStreamer GStrea mer plug-ins .. ............................................................................ 70 C. Under the hood ................................ ..... ........................................................................... ................................................ .................... 73 73 GStrea GStreamer mer ... ... ....................................... .. ...................................................................................... ................................................. ......... 73 73 Twisted ........................ .... ................................................................... ............................................... .................................... 73 73 D. Command-line Option Opti onss .......................................................................................... .......................................................................................... 74 Starting the manager mana ger .................................................................... .................................................................... ..................... 74 74 Starting the work er e r ............................................................... ............................................................... ............................ 74 74 E. The Configuration Configuration Assistant . ................................................................................... 75 Flumotion Connections Connections ........................................................... .... ....................................................... ........................... 75 75 The Welcome Page Page ........................................................................ ........................................................................ ................... 81 81 The Scenario Scenario Page ........................................................................... ........................................................................... ................. 82 82 The Production Pag Pagee ............................................................................ ............................................................................ ............. 83 83 The Test Video Producer Producer Page Page ........................................................ .................... 84 The Webcam Webcam Page ........................................................ ........................................................ .................................... 85 85
Flumotion manual
The The TV Card Card Page Page .......................................................... .................................. 86 The The Fire Firewi wire re Vide Video o Page Page ...... ..... ..... ...... ..... ...... ..... ...... ...... ..... ...... ..... ...... ...... ..... 87 The The Over Overla lay y Page Page ........................................ ..................................................... 88 The Test Audio Producer Page ............................................................................ 89 The Sound Card Page ........................................................................................ 90 The The Fire Firewi wire re Audi Audio o Page Page ...... ..... ..... ...... ..... ...... ..... ...... ...... ..... ...... ..... ..... ...... ..... . 91 The Encoding Page Page ........................................................................ ........................................................................ ................... 92 92 The Theora Encoder Encoder Page .............................................................. .............................................................. .................... 93 93 The Dirac Encoder Encoder Page ................................................................. ................................................................. ................... 94 94 The Smoke Encoder Encoder Page ................................................................................... ................................................................................... 95 The JPEG Encoder Encoder Page ....................................................... ....................................................... ............................. 96 96 The Vorbis Encoder Encoder Page ................................................................................... ...... ............................................................................. 97 The Speex Encoder Page .................................................................................... .................................................................................... 98 The Mulaw Encoder Encoder Page ...................................................................... ...................................................................... ............ 99 99 The Consumption Consumption Page ..................................................................... ..................................................................... ............... 100 100 The HTTP Streaming Streaming Page ............................................................................. ............................................................................. .. 101 101 The HTTP Streamer (Audio and Video) Video ) Page Page ....................................................... 102 102 The HTTP Streamer Streamer (Audio Only) Page Page .............................................................. 103 103 The HTTP Streamer Streamer (Video (Video Only Only)) Page Page ....................... ....................................... 104 104 The Disk (Audio (Audio and Video) Page .................................................... .... ................................................ ................. 105 105 The Disk (Audio Only) Page ............................................................................. ........ ..................................................................... 106 The Disk (Audio Only) Page ............................................................................. ........ ..................................................................... 107 The Icecast Streamer Strea mer (Audio and Video) Page ...................................................... 108 The Icecast Streamer Streamer (Audio Only) Pag Pagee ............................................................. 109 109 The Icecast Streamer Streamer (Video Onl Only) y) Page Page ............................................................. 110 110 The Content License License Page ............................................................. ............................................................. ................... 111 111 The On Demand Page ...................................................................................... ...................................................................................... 112 The Summary Page Page ........................................................................ ........................................................................ ................. 113 113 The Administration Administration Window ............................................................. ......... .................................................... ................ 114 114 Glossary ...................................................... ... .................................................................................................... ................................................. ......... 116 116 II. Flumotion Components Compone nts Referen Reference ce .............................................................................. .... 118 118 I. Producer Components Component s ........................................................................................ ........................................................................................ ... 120 120 audiotest-producer audiotest-producer ......................................................................... ......................................................................... .................. 121 121 firewire-producer ............................................................................................. ............................................................................................. 122 icecast-producer . .................................................................................... .................................................................................... ......... 124 124 loop-produ loop-producer cer . .. . ............................................................................................. . ..................................... 125 125 soundcard-producer soundcard-producer ................................................ .......................................... . ..................................... 126 126 tvcard-producer .. ............................................................................................. . .............................. 128 videotest-producer videotest-producer ........................................................................................... ........................................................................................... 130 130 webcam-producer webcam-producer ...................................................................................... . .............................................. ...... 132 132 II. Converter Component Componentss ................. ........................................................................ ........................................................................ 134 repeater .................................................................. ......................................................................................................... . ...................................... 135 135 overlay-converter overlay-converter ............................................................................................ . ..................................... 136 136 III. Combiner Component Compone ntss ...................... .................................................................. . ............................... 138 av-basic-watchdogav-basic-watchdog-co comb mbin iner er .. ...... ..... ...... ........................................................ ........................................................ .. 139 139 av-switch-combiner av-switch-combiner .......................................................................................... .......................................................................................... 141 single-switch-combiner single-switch-combiner ..................................................................................... ..................................................................................... 143 IV. Encoder Components Components .......................................................................................... .......................................................................................... 144 dirac-encoder ........................................ ..... ............................................................................................. .......................................................... 145 jpeg-encoder . .. .. .............................................................................................. .............................................................................................. 146 mulaw-encoder ...................................... .. ........................................................................................ .................................................... ..... 147 147 smoke-encoder .................................... ... ............................................................................................. ............................................................ 148 speex-enc speex-encoder oder .. .. ............................................................................................. ............................................................................................. 149 theora-encoder .............................. ... ................................................................................. ...................................................... ............ 150 150
