1 .. MediaGoblin Documentation
3 Written in 2011, 2012 by MediaGoblin contributors
5 To the extent possible under law, the author(s) have dedicated all
6 copyright and related and neighboring rights to this software to
7 the public domain worldwide. This software is distributed without
10 You should have received a copy of the CC0 Public Domain
11 Dedication along with this software. If not, see
12 <http://creativecommons.org/publicdomain/zero/1.0/>.
14 .. _media-types-chapter:
20 In the future, there will be all sorts of media types you can enable,
21 but in the meanwhile there are three additional media types: video, audio
24 First, you should probably read ":doc:`configuration`" to make sure
25 you know how to modify the mediagoblin config file.
31 Media types are enabled in your mediagoblin configuration file, typically it is
32 created by copying ``mediagoblin.ini`` to ``mediagoblin_local.ini`` and then
33 applying your changes to ``mediagoblin_local.ini``. If you don't already have a
34 ``mediagoblin_local.ini``, create one in the way described.
36 Most media types have additional dependencies that you will have to install.
37 You will find descriptions on how to satisfy the requirements of each media type
40 To enable a media type, edit the ``media_types`` list in your
41 ``mediagoblin_local.ini``. For example, if your system supported image and
42 video media types, then the list would look like this::
44 media_types = mediagoblin.media_types.image, mediagoblin.media_types.video
46 Note that after enabling new media types, you must run dbupdate like so::
50 If you are running an active site, depending on your server
51 configuration, you may need to stop it first (and it's certainly a
52 good idea to restart it after the update).
55 How does MediaGoblin decide which media type to use for a file?
56 ===============================================================
58 MediaGoblin has two methods for finding the right media type for an uploaded
59 file. One is based on the file extension of the uploaded file; every media type
60 maintains a list of supported file extensions. The second is based on a sniffing
61 handler, where every media type may inspect the uploaded file and tell if it
64 The file-extension-based approach is used before the sniffing-based approach,
65 if the file-extension-based approach finds a match, the sniffing-based approach
66 will be skipped as it uses far more processing power.
72 To enable video, first install gstreamer and the python-gstreamer
73 bindings (as well as whatever gstremaer extensions you want,
74 good/bad/ugly). On Debianoid systems
78 sudo apt-get install python-gst0.10 \
79 gstreamer0.10-plugins-base \
80 gstreamer0.10-plugins-bad \
81 gstreamer0.10-plugins-good \
82 gstreamer0.10-plugins-ugly \
86 Add ``mediagoblin.media_types.video`` to the ``media_types`` list in your
87 ``mediagoblin_local.ini`` and restart MediaGoblin.
95 Now you should be able to submit videos, and mediagoblin should
100 You almost certainly want to separate Celery from the normal
101 paste process or your users will probably find that their connections
102 time out as the video transcodes. To set that up, check out the
103 ":doc:`production-deployments`" section of this manual.
109 To enable audio, install the gstreamer and python-gstreamer bindings (as well
110 as whatever gstreamer plugins you want, good/bad/ugly), scipy and numpy are
111 also needed for the audio spectrograms.
112 To install these on Debianoid systems, run::
114 sudo apt-get install python-gst0.10 gstreamer0.10-plugins-{base,bad,good,ugly} \
115 gstreamer0.10-ffmpeg python-numpy python-scipy
117 The ``scikits.audiolab`` package you will install in the next step depends on the
118 ``libsndfile1-dev`` package, so we should install it.
119 On Debianoid systems, run
123 sudo apt-get install libsndfile1-dev
126 scikits.audiolab will display a warning every time it's imported if you do
127 not compile it with alsa support. Alsa support is not necessary for the GNU
128 MediaGoblin application but if you do not wish the alsa warnings from
129 audiolab you should also install ``libasound2-dev`` before installing
132 Then install ``scikits.audiolab`` for the spectrograms::
134 ./bin/pip install scikits.audiolab
136 Add ``mediagoblin.media_types.audio`` to the ``media_types`` list in your
137 ``mediagoblin_local.ini`` and restart MediaGoblin.
145 You should now be able to upload and listen to audio files!
151 To enable ascii art support, first install the
152 `chardet <http://pypi.python.org/pypi/chardet>`_
153 library, which is necessary for creating thumbnails of ascii art
157 ./bin/easy_install chardet
160 Next, modify (and possibly copy over from ``mediagoblin.ini``) your
161 ``mediagoblin_local.ini``. In the ``[mediagoblin]`` section, add
162 ``mediagoblin.media_types.ascii`` to the ``media_types`` list.
164 For example, if your system supported image and ascii art media types, then
165 the list would look like this::
167 media_types = mediagoblin.media_types.image, mediagoblin.media_types.ascii
175 Now any .txt file you uploaded will be processed as ascii art!
178 STL / 3d model support
179 ======================
181 To enable the "STL" 3d model support plugin, first make sure you have
182 a recentish `Blender <http://blender.org>`_ installed and available on
183 your execution path. This feature has been tested with Blender 2.63.
184 It may work on some earlier versions, but that is not guaranteed (and
185 is surely not to work prior to Blender 2.5X).
187 Add ``mediagoblin.media_types.stl`` to the ``media_types`` list in your
188 ``mediagoblin_local.ini`` and restart MediaGoblin.
196 You should now be able to upload .obj and .stl files and MediaGoblin
197 will be able to present them to your wide audience of admirers!
202 To enable the "PDF and Document" support plugin, you need pdftocairo, pdfinfo,
203 unoconv with headless support. All executables must be on your execution path.
205 To install this on Fedora:
209 sudo yum install -y ppoppler-utils unoconv libreoffice-headless
211 pdf.js relies on git submodules, so be sure you have fetched them:
218 This feature has been tested on Fedora with:
219 poppler-utils-0.20.2-9.fc18.x86_64
220 unoconv-0.5-2.fc18.noarch
221 libreoffice-headless-3.6.5.2-8.fc18.x86_64
223 It may work on some earlier versions, but that is not guaranteed.
225 Add ``mediagoblin.media_types.pdf`` to the ``media_types`` list in your
226 ``mediagoblin_local.ini`` and restart MediaGoblin.