Media type refractors, pep8, lint
[mediagoblin.git] / mediagoblin / media_types / video / processing.py
index d7a48caa6349300da82d0c5b008c3afb93374b51..4c44e65f593143a2f3c3367001f44606211dd9ca 100644 (file)
@@ -1,5 +1,5 @@
 # GNU MediaGoblin -- federated, autonomous media hosting
-# Copyright (C) 2011 MediaGoblin contributors.  See AUTHORS.
+# Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import Image
 import tempfile
-import pkg_resources
+import logging
 import os
 
-from celery.task import Task
-from celery import registry
-
-from mediagoblin.db.util import ObjectId
 from mediagoblin import mg_globals as mgg
-from mediagoblin.util import lazy_pass_to_ugettext as _
-from mediagoblin.process_media.errors import BaseProcessingFail, BadMediaFail
-from mediagoblin.process_media import mark_entry_failed
+from mediagoblin.processing import create_pub_filepath
 from . import transcoders
 
-import gobject
-gobject.threads_init()
+logging.basicConfig()
 
-import gst
-import arista
-import logging
+_log = logging.getLogger(__name__)
+_log.setLevel(logging.DEBUG)
 
-from arista.transcoder import TranscoderOptions
 
-THUMB_SIZE = 180, 180
-MEDIUM_SIZE = 640, 640
+def sniff_handler(media_file, **kw):
+    transcoder = transcoders.VideoTranscoder()
+    data = transcoder.discover(media_file.name)
 
-ARISTA_DEVICE = 'devices/web-advanced.json'
-ARISTA_PRESET = None
+    _log.debug('Discovered: {0}'.format(data))
 
-loop = None  # Is this even used?
+    if not data:
+        _log.error('Could not discover {0}'.format(
+                kw.get('media')))
+        return False
 
-logger = logging.getLogger(__name__)
-logging.basicConfig()
-logger.setLevel(logging.DEBUG)
+    if data['is_video'] == True:
+        return True
+
+    return False
 
 
 def process_video(entry):
     """
-    Code to process a video
-
-    Much of this code is derived from the arista-transcoder script in
-    the arista PyPI package and changed to match the needs of
-    MediaGoblin
-
-    This function sets up the arista video encoder in some kind of new thread
-    and attaches callbacks to that child process, hopefully, the
-    entry-complete callback will be called when the video is done.
+    Process a video entry, transcode the queued media files (originals) and
+    create a thumbnail for the entry.
     """
-
-    ''' Empty dict, will store data which will be passed to the callback
-    functions '''
-    info = {}
+    video_config = mgg.global_config['media_type:mediagoblin.media_types.video']
 
     workbench = mgg.workbench_manager.create_workbench()
 
-    queued_filepath = entry['queued_media_file']
+    queued_filepath = entry.queued_media_file
     queued_filename = workbench.localized_file(
         mgg.queue_store, queued_filepath,
         'source')
 
-    ''' Initialize arista '''
-    arista.init()
-
-    ''' Loads a preset file which specifies the format of the output video'''
-    device = arista.presets.load(
-        pkg_resources.resource_filename(
-            __name__,
-            ARISTA_DEVICE))
-
-    # FIXME: Is this needed since we only transcode one video?
-    queue = arista.queue.TranscodeQueue()
+    medium_filepath = create_pub_filepath(
+        entry,
+        '{original}-640p.webm'.format(
+            original=os.path.splitext(
+                queued_filepath[-1])[0]  # Select the file name without .ext
+            ))
 
-    info['tmp_file'] = tempfile.NamedTemporaryFile(delete=False)
-
-    info['medium_filepath'] = create_pub_filepath(
-        entry, 'video.webm')
-
-    info['thumb_filepath'] = create_pub_filepath(
+    thumbnail_filepath = create_pub_filepath(
         entry, 'thumbnail.jpg')
 
-    # With the web-advanced.json device preset, this will select
-    # 480p WebM w/ OGG Vorbis
-    preset = device.presets[ARISTA_PRESET or device.default]
-
-    logger.debug('preset: {0}'.format(preset))
-
-    opts = TranscoderOptions(
-        'file://' + queued_filename,  # Arista did it this way, IIRC
-        preset,
-        info['tmp_file'].name)
+    # Create a temporary file for the video destination
+    tmp_dst = tempfile.NamedTemporaryFile()
 
-    queue.append(opts)
+    with tmp_dst:
+        # Transcode queued file to a VP8/vorbis file that fits in a 640x640 square
+        transcoder = transcoders.VideoTranscoder()
+        transcoder.transcode(queued_filename, tmp_dst.name)
 
-    info['entry'] = entry
+        # Push transcoded video to public storage
+        _log.debug('Saving medium...')
+        mgg.public_store.get_file(medium_filepath, 'wb').write(
+            tmp_dst.read())
+        _log.debug('Saved medium')
 
-    queue.connect("entry-start", _transcoding_start, info)
-    queue.connect("entry-pass-setup", _transcoding_pass_setup, info)
-    queue.connect("entry-error", _transcoding_error, info)
-    queue.connect("entry-complete", _transcoding_complete, info)
+        entry.media_files['webm_640'] = medium_filepath
 
-    # Add data to the info dict, making it available to the callbacks
-    info['loop'] = gobject.MainLoop()
-    info['queued_filename'] = queued_filename
-    info['queued_filepath'] = queued_filepath
-    info['workbench'] = workbench
-    info['preset'] = preset
+        # Save the width and height of the transcoded video
+        entry.media_data['video'] = {
+            u'width': transcoder.dst_data.videowidth,
+            u'height': transcoder.dst_data.videoheight}
 
-    info['loop'].run()
+    # Create a temporary file for the video thumbnail
+    tmp_thumb = tempfile.NamedTemporaryFile()
 
-    logger.debug('info: {0}'.format(info))
+    with tmp_thumb:
+        # Create a thumbnail.jpg that fits in a 180x180 square
+        transcoders.VideoThumbnailer(queued_filename, tmp_thumb.name)
 
+        # Push the thumbnail to public storage
+        _log.debug('Saving thumbnail...')
+        mgg.public_store.get_file(thumbnail_filepath, 'wb').write(
+            tmp_thumb.read())
+        _log.debug('Saved thumbnail')
 
-def __create_thumbnail(info):
-    thumbnail = tempfile.NamedTemporaryFile()
+        entry.media_files['thumb'] = thumbnail_filepath
 
-    logger.info('thumbnailing...')
-    transcoders.VideoThumbnailer(info['tmp_file'].name, thumbnail.name)
-    logger.debug('Done thumbnailing')
-
-    os.remove(info['tmp_file'].name)
-
-    mgg.public_store.get_file(info['thumb_filepath'], 'wb').write(
-        thumbnail.read())
-
-    info['entry']['media_files']['thumb'] = info['thumb_filepath']
-    info['entry'].save()
-
-
-def __close_processing(queue, qentry, info, **kwargs):
-    '''
-    Updates MediaEntry, moves files, handles errors
-    '''
-    if not kwargs.get('error'):
-        logger.info('Transcoding successful')
-
-        qentry.transcoder.stop()
-        gobject.idle_add(info['loop'].quit)
-        info['loop'].quit()  # Do I have to do this again?
-
-        logger.info('Saving files...')
-
-        # Write the transcoded media to the storage system
-        with info['tmp_file'] as tmp_file:
-            mgg.public_store.get_file(info['medium_filepath'], 'wb').write(
-                tmp_file.read())
-            info['entry']['media_files']['medium'] = info['medium_filepath']
-
-        # we have to re-read because unlike PIL, not everything reads
-        # things in string representation :)
-        queued_file = file(info['queued_filename'], 'rb')
+    if video_config['keep_original']:
+        # Push original file to public storage
+        queued_file = file(queued_filename, 'rb')
 
         with queued_file:
             original_filepath = create_pub_filepath(
-                info['entry'],
-                info['queued_filepath'][-1])
+                entry,
+                queued_filepath[-1])
 
             with mgg.public_store.get_file(original_filepath, 'wb') as \
                     original_file:
+                _log.debug('Saving original...')
                 original_file.write(queued_file.read())
+                _log.debug('Saved original')
 
-        mgg.queue_store.delete_file(info['queued_filepath'])
-
-
-        logger.debug('...Done')
-
-        info['entry']['queued_media_file'] = []
-        media_files_dict = info['entry'].setdefault('media_files', {})
-        media_files_dict['original'] = original_filepath
-
-        info['entry']['state'] = u'processed'
-        info['entry']['media_data'][u'preset'] = info['preset'].name
-        __create_thumbnail(info)
-        info['entry'].save()
-
-    else:
-        qentry.transcoder.stop()
-        gobject.idle_add(info['loop'].quit)
-        info['loop'].quit()
-        info['entry']['state'] = u'failed'
-        info['entry'].save()
-
-    # clean up workbench
-    info['workbench'].destroy_self()
+                entry.media_files['original'] = original_filepath
 
+    mgg.queue_store.delete_file(queued_filepath)
 
-def _transcoding_start(queue, qentry, info):
-    logger.info('-> Starting transcoding')
-    logger.debug((queue, qentry, info))
-
-
-def _transcoding_complete(*args):
-    __close_processing(*args)
-    logger.debug(*args)
-
-
-def _transcoding_error(queue, qentry, arg, info):
-    logger.info('Error')
-    __close_processing(queue, qentry, info, error=True)
-    logger.debug((queue, quentry, info, arg))
-
-
-def _transcoding_pass_setup(queue, qentry, options):
-    logger.info('Pass setup')
-    logger.debug((queue, qentry, options))
-
-
-def check_interrupted():
-    """
-        Check whether we have been interrupted by Ctrl-C and stop the
-        transcoder.
-    """
-    if interrupted:
-        try:
-            source = transcoder.pipe.get_by_name("source")
-            source.send_event(gst.event_new_eos())
-        except:
-            # Something pretty bad happened... just exit!
-            gobject.idle_add(loop.quit)
-
-        return False
-    return True
-
-
-def create_pub_filepath(entry, filename):
-    return mgg.public_store.get_unique_filepath(
-            ['media_entries',
-             unicode(entry['_id']),
-             filename])
-
-
-################################
-# Media processing initial steps
-################################
-
-class ProcessMedia(Task):
-    """
-    Pass this entry off for processing.
-    """
-    def run(self, media_id):
-        """
-        Pass the media entry off to the appropriate processing function
-        (for now just process_image...)
-        """
-        entry = mgg.database.MediaEntry.one(
-            {'_id': ObjectId(media_id)})
-
-        # Try to process, and handle expected errors.
-        try:
-            process_video(entry)
-        except BaseProcessingFail, exc:
-            mark_entry_failed(entry[u'_id'], exc)
-            return
-
-    def on_failure(self, exc, task_id, args, kwargs, einfo):
-        """
-        If the processing failed we should mark that in the database.
-
-        Assuming that the exception raised is a subclass of BaseProcessingFail,
-        we can use that to get more information about the failure and store that
-        for conveying information to users about the failure, etc.
-        """
-        entry_id = args[0]
-        mark_entry_failed(entry_id, exc)
-
-
-process_media = registry.tasks[ProcessMedia.name]
-
-
-def mark_entry_failed(entry_id, exc):
-    """
-    Mark a media entry as having failed in its conversion.
-
-    Uses the exception that was raised to mark more information.  If the
-    exception is a derivative of BaseProcessingFail then we can store extra
-    information that can be useful for users telling them why their media failed
-    to process.
-
-    Args:
-     - entry_id: The id of the media entry
-
-    """
-    # Was this a BaseProcessingFail?  In other words, was this a
-    # type of error that we know how to handle?
-    if isinstance(exc, BaseProcessingFail):
-        # Looks like yes, so record information about that failure and any
-        # metadata the user might have supplied.
-        mgg.database['media_entries'].update(
-            {'_id': entry_id},
-            {'$set': {u'state': u'failed',
-                      u'fail_error': exc.exception_path,
-                      u'fail_metadata': exc.metadata}})
-    else:
-        # Looks like no, so just mark it as failed and don't record a
-        # failure_error (we'll assume it wasn't handled) and don't record
-        # metadata (in fact overwrite it if somehow it had previous info
-        # here)
-        mgg.database['media_entries'].update(
-            {'_id': entry_id},
-            {'$set': {u'state': u'failed',
-                      u'fail_error': None,
-                      u'fail_metadata': {}}})
+    # Save the MediaEntry
+    entry.save()