Permalink
Browse files

writing some docs

  • Loading branch information...
1 parent 04735b5 commit d0768b753f404bba6f046098c6da63271cc414ca Unknown committed Apr 4, 2011
Showing with 60 additions and 2 deletions.
  1. +60 −2 README.rst
View
@@ -1,6 +1,6 @@
django-multimedia
=================
-coming soon...
+A django app used to encode video from the django admin. Uses ffmpeg to encode the video and django-celery to process it in a queue. Supports any video profile you can write an ffmpeg command to accomplish.
Dependancies
============
@@ -14,4 +14,62 @@ Dependancies
Getting Started
=============
-coming soon...
+To get started simply install using ''pip'':
+::
+ pip install django-multimedia
+
+Add ''multimedia'' to your installed apps and ''syncdb''. If you are using ''south'' you might want to ''syncdb --all'' and ''migrate --fake''
+
+Next, you'll need to configure you settings. See ''configuration'' below.
+
+Please refer to the documentation for each dependency on instructions on how to install them.
+
+Configuration
+==============
+
+You'll need to configure your media profiles and tell the app where to upload the encoded file to after completion. You can use any ffmpeg command as long as you have the codecs needed installed. Use the settings ''MULTIMEDIA_VIDEO_PROFILES'' and ''MULTIMEDIA_AUDIO_PROFILES'' to accomplish this. The following are the default profiles.
+
+::
+ MULTIMEDIA_VIDEO_PROFILES = {
+ 'f4v': {
+ 'encode_cmd': 'ffmpeg -y -i "%(input)s" -f mp4 -acodec libfaac -ab 128k -vcodec libx264 -vpre slow -b 690k -ac 2 -crf 22 -s 620x350 -r 30 %(output)s"',
+ 'encode':True,
+ 'name':'Flash Video',
+ 'container':'f4v',
+ 'thumbnail_cmd': 'ffmpeg -y -itsoffset -%(offset)s -i "%(input)s" -vcodec mjpeg -vframes 1 -an -f rawvideo -s 620x350 "%(output)s"'
+ },
+}
+
+::
+
+MULTIMEDIA_AUDIO_PROFILES = {
+ 'audio': {
+ 'encode_cmd': 'ffmpeg -y -i "%(input)s" "%(output)s"',
+ 'encode':True,
+ 'name':'MP3 Audio',
+ 'container':'mp3',
+ },
+}
+
+The following settings are used to upload the media after encoding:
+
+::
+MEDIA_SERVER_HOST = "some.host.here"
+MEDIA_SERVER_USER = "host_user"
+MEDIA_SERVER_PASSWORD = "user_pwd"
+MEDIA_SERVER_PORT = 22
+MEDIA_SERVER_VIDEO_BUCKET = "videobucket"
+MEDIA_SERVER_AUDIO_BUCKET = "audiobucket"
+MEDIA_SERVER_AUDIO_PATH = "path/on/some/server" % (MEDIA_SERVER_AUDIO_BUCKET,)
+MEDIA_SERVER_VIDEO_PATH = "path/on/some/server" % (MEDIA_SERVER_VIDEO_BUCKET,)
+
+Installing FFMPEG
+===============
+On Mac OS X you should be able to install ffmpeg using homebrew:
+
+::
+ brew install ffmpeg
+
+You might need to brew install other codecs you want to use as well.
+
+On Ubuntu, here is a link to a helpful guide with instructions on how to install on different Ubuntu versions: <<http://ubuntuforums.org/showthread.php?t=786095>>

0 comments on commit d0768b7

Please sign in to comment.