move docs

.bzrignore

@@ -0,0 +1 @@
+media/*

README

@@ -0,0 +1,42 @@
+ on ubuntu/debian:
+   apt-get install python-twisted
+ else
+    easy_install twisted
+ twisted available on os x since 10.5
+
+api overview:
+
+/files?since=timestamp
+{
+    archive: {
+        new
+        updated
+        deleted
+    }
+}
+
+/extract?oshash=abc&media=stills
+/extract?oshash=abc&media=profile.webm
+{
+  status: 'extracting|available|failed',
+}
+
+/get?oshash=abc
+{
+  info: {}
+  stills: [],
+  video: [],
+}
+/get?oshash=abc
+{
+  stills: [
+    "/media/../../12.png",
+    "/media/../../123.png",
+    "/media/../../321.png",
+  ],
+  video: [
+    "/media/../../96p.webm"
+  ],
+  info: {}
+}
+

TODO

@@ -0,0 +1,29 @@
+VIDEO PROFILES:
+    sync profiles with Firefogg, there should be base profiles for
+        96p, 360p, 480p, 720p, 1080p for ogv and webm
+
+FRAME extraction:
+    - vlc hangs on some files, mpg but also some avis
+    - ffmpeg decodes full video, so it takes to long extracting frames at the end
+    - oxframe only support ogv and webm (adding av* as option might work)
+    - mplayer seams to work. might be an issue installing/bundling it
+
+FIREFOX integration:
+   possible ways:
+     - launch oxbackend on localhost and connect to it
+     - way to add/configure backends + launch one localy
+       adding folders in remote backends is a bit complicated
+       beeing able to manage a backend remotely would be nice(security questions though)
+       also makes it a bit more complicated, than again ideal for situations with
+       media servers hosting the actuall videos and clients to access them
+     - rewrite large parts in javascript + sqlite bundled with firefox (requires js subprocess to work)
+
+TODO:
+    add fields:
+        make archive / file link via id?
+        
+        is extracted field enough or requires frames/video thingy
+
+    cache location, should cache be inside of archive, home folder or whats a good default.
+    must be a config option in
+

oxd.py

@@ -2,75 +2,7 @@
 # vi:si:et:sw=4:sts=4:ts=4
 # GPL 2010
 from __future__ import division, with_statement
-"""
- on ubuntu/debian:
-   apt-get install python-twisted
- else
-    easy_install twisted
- twisted available on os x since 10.5
 
-FRAME extraction:
-    - vlc hangs on some files, mpg but also some avis
-    - ffmpeg decodes full video, so it takes to long extracting frames at the end
-    - oxframe only support ogv and webm (adding av* as option might work)
-    - mplayer seams to work. might be an issue installing/bundling it
-
-FIREFOX integration:
-   possible ways:
-     - launch oxbackend on localhost and connect to it
-     - way to add/configure backends + launch one localy
-       adding folders in remote backends is a bit complicated
-       beeing able to manage a backend remotely would be nice(security questions though)
-       also makes it a bit more complicated, than again ideal for situations with
-       media servers hosting the actuall videos and clients to access them
-     - rewrite large parts in javascript + sqlite bundled with firefox (requires js subprocess to work)
-
-TODO:
-    security, add auth framework, DIGEST might be good enough
-    add fields:
-        make archive / file link via id?
-        
-        is extracted field enough or requires frames/video thingy
-
-    cache location, should cache be inside of archive, home folder or whats a good default.
-    must be a config option in
-"""
-
-"""
-/files?since=timestamp
-{
-    archive: {
-        new
-        updated
-        deleted
-    }
-}
-
-/extract?oshash=abc&media=stills
-/extract?oshash=abc&media=profile.webm
-{
-  status: 'extracting|available|failed',
-}
-
-/get?oshash=abc
-{
-  info: {}
-  stills: [],
-  video: [],
-}
-/get?oshash=abc
-{
-  stills: [
-    "/media/../../12.png",
-    "/media/../../123.png",
-    "/media/../../321.png",
-  ],
-  video: [
-    "/media/../../96p.webm"
-  ],
-  info: {}
-}
-"""
 import fractions
 from glob import glob
 import json