Commit | Line | Data |
---|---|---|
473a4431 CAW |
1 | .. MediaGoblin Documentation |
2 | ||
3 | Written in 2011, 2012 by MediaGoblin contributors | |
4 | ||
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 | |
8 | any warranty. | |
9 | ||
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/>. | |
13 | ||
9bc2fc6c CAW |
14 | .. _media-types-chapter: |
15 | ||
16 | ==================== | |
d34757dc | 17 | Media Types |
9bc2fc6c CAW |
18 | ==================== |
19 | ||
20 | In the future, there will be all sorts of media types you can enable, | |
d34757dc JW |
21 | but in the meanwhile there are three additional media types: video, audio |
22 | and ascii art. | |
9bc2fc6c CAW |
23 | |
24 | First, you should probably read ":doc:`configuration`" to make sure | |
25 | you know how to modify the mediagoblin config file. | |
26 | ||
d34757dc JW |
27 | |
28 | Enabling Media Types | |
29 | ==================== | |
30 | ||
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. | |
35 | ||
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 | |
38 | on this page. | |
39 | ||
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:: | |
43 | ||
44 | media_types = mediagoblin.media_types.image, mediagoblin.media_types.video | |
45 | ||
9d5cd0b9 CAW |
46 | Note that after enabling new media types, you must run dbupdate like so:: |
47 | ||
48 | ./bin/gmg dbupdate | |
49 | ||
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). | |
53 | ||
54 | ||
d34757dc JW |
55 | How does MediaGoblin decide which media type to use for a file? |
56 | =============================================================== | |
57 | ||
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 | |
62 | will accept it. | |
63 | ||
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. | |
67 | ||
68 | ||
9bc2fc6c CAW |
69 | Video |
70 | ===== | |
71 | ||
72 | To enable video, first install gstreamer and the python-gstreamer | |
73 | bindings (as well as whatever gstremaer extensions you want, | |
e91a4dcb | 74 | good/bad/ugly). On Debianoid systems:: |
9bc2fc6c | 75 | |
7798f911 WKG |
76 | sudo apt-get install python-gst0.10 gstreamer0.10-plugins-{base,bad,good,ugly} \ |
77 | gstreamer0.10-ffmpeg | |
582958e3 | 78 | |
9bc2fc6c CAW |
79 | |
80 | Now you should be able to submit videos, and mediagoblin should | |
81 | transcode them. | |
82 | ||
7798f911 WKG |
83 | .. note:: |
84 | ||
85 | You almost certainly want to separate Celery from the normal | |
86 | paste process or your users will probably find that their connections | |
87 | time out as the video transcodes. To set that up, check out the | |
88 | ":doc:`production-deployments`" section of this manual. | |
efd69313 CAW |
89 | |
90 | ||
d34757dc JW |
91 | Audio |
92 | ===== | |
93 | ||
94 | To enable audio, install the gstreamer and python-gstreamer bindings (as well | |
95 | as whatever gstreamer plugins you want, good/bad/ugly), scipy and numpy are | |
96 | also needed for the audio spectrograms. | |
97 | To install these on Debianoid systems, run:: | |
98 | ||
99 | sudo apt-get install python-gst0.10 gstreamer0.10-plugins-{base,bad,good,ugly} \ | |
100 | gstreamer0.10-ffmpeg python-numpy python-scipy | |
101 | ||
102 | The ``scikits.audiolab`` package you will install in the next step depends on the | |
103 | ``libsndfile1-dev`` package, so we should install it. | |
104 | On Debianoid systems, run:: | |
105 | ||
106 | sudo apt-get install libsndfile1-dev | |
107 | ||
34a85313 | 108 | .. note:: |
8518e95e | 109 | scikits.audiolab will display a warning every time it's imported if you do |
34a85313 | 110 | not compile it with alsa support. Alsa support is not necessary for the GNU |
8518e95e JW |
111 | MediaGoblin application but if you do not wish the alsa warnings from |
112 | audiolab you should also install ``libasound2-dev`` before installing | |
113 | scikits.audiolab. | |
34a85313 | 114 | |
d34757dc JW |
115 | Then install ``scikits.audiolab`` for the spectrograms:: |
116 | ||
117 | ./bin/pip install scikits.audiolab | |
118 | ||
119 | Add ``mediagoblin.media_types.audio`` to the ``media_types`` list in your | |
120 | ``mediagoblin_local.ini`` and restart MediaGoblin. You should now be able to | |
121 | upload and listen to audio files! | |
122 | ||
123 | ||
efd69313 CAW |
124 | Ascii art |
125 | ========= | |
126 | ||
127 | To enable ascii art support, first install the | |
128 | `chardet <http://pypi.python.org/pypi/chardet>`_ | |
129 | library, which is necessary for creating thumbnails of ascii art:: | |
130 | ||
131 | ./bin/easy_install chardet | |
132 | ||
133 | ||
134 | Next, modify (and possibly copy over from ``mediagoblin.ini``) your | |
7798f911 WKG |
135 | ``mediagoblin_local.ini``. In the ``[mediagoblin]`` section, add |
136 | ``mediagoblin.media_types.ascii`` to the ``media_types`` list. | |
137 | ||
138 | For example, if your system supported image and ascii art media types, then | |
139 | the list would look like this:: | |
efd69313 CAW |
140 | |
141 | media_types = mediagoblin.media_types.image, mediagoblin.media_types.ascii | |
142 | ||
143 | Now any .txt file you uploaded will be processed as ascii art! |