Overview¶

This is the documentation for django-encode 1.0.3, generated on November 25, 2015.

Developer Guide¶

Models¶

Models.

class MediaFile(*args, **kwargs)¶: Model for media files.

class Encoder(*args, **kwargs)¶

Encoder model for tool like FFmpeg or ImageMagick.

encode_cmd¶

The full command for the encoder, eg. ffmpeg -loglevel fatal -y.

Returns:	A list of options that represent the encoder base command.
Return type:	list

class EncodingProfile(*args, **kwargs)¶

Job data for encoding a file.

encode_cmd¶

The command for the encoder without the vars injected, eg. ffmpeg -y -i "{input}" "{output}".

Returns:	A string that represents the command that the encoder should execute.
Return type:	str

class MediaBase(*args, **kwargs)¶

Base model for media objects.

ready¶

Indicates if all output files have completed encoding.

Returns:	Boolean indicating if all output files have completed encoding.
Return type:	boolean

encodable¶

Indicates if the input file has not completed encoding yet.

Returns:	Boolean indicating if the input file has not completed encoding yet.
Return type:	boolean

input_path¶

The path to the input file uploaded by the user.

Returns:	For example: `[MEDIA_ROOT]/user/video/IMG001.MPEG`.
Return type:	str or `None`

output_path(profile)¶

The path of the encoded output file.

Parameters:	profile (`EncodingProfile`) – The `EncodingProfile` instance that contains the encoding data.
Returns:	For example: `[ENCODE_MEDIA_ROOT]/[ENCODE_MEDIA_PATH_NAME]/audio/51.mp3`.
Return type:	str

get_media()¶

The media type. Either VIDEO, SNAPSHOT, or AUDIO.

Return type:	`MediaBase` subclass.
Returns:	The media subclass.

store_file(profile)¶

Add the encoded input file to the output_files field.

Parameters:	profile (`EncodingProfile`) – The `EncodingProfile` instance that contains the encoding data.
Raises:	`UploadError`: Something went wrong while uploading the file or the file does not exist.

remove_file(profile)¶

Remove the input (and possible local encoded) file.

Parameters:	profile (`EncodingProfile`) – The `EncodingProfile` instance that contains the encoding data.

save(profiles=[], *args, **kwargs)¶

Set the encoding status to True and save the model.

Parameters:	profiles (list) – List of primary keys of encoding profiles.

class Video(*args, **kwargs)¶

Model for video files.

save(*args, **kwargs)¶: Encode and upload the video.

class Audio(*args, **kwargs)¶

Model for audio files.

save(*args, **kwargs)¶: Encode and upload the audio clip.

class Snapshot(*args, **kwargs)¶

Model for snapshot files.

save(*args, **kwargs)¶: Encode and upload the snapshot file.

Tasks¶

Tasks.

class EncodeMedia¶

Encode a MediaBase model’s input_file.

run(profile, media_id, input_path, output_path)¶

Execute the task.

Parameters:	profile (`EncodingProfile`) – The `EncodingProfile` instance. media_id (int) – The primary key of the `MediaBase` model. input_path (str) – output_path –
Return type:	dict
Returns:	Dictionary with `id` (media object’s id) and `profile` (encoding profile instance).

class StoreMedia¶

Upload an instance MediaBase model’s output_files m2m field.

ignore_result = True¶: If enabled the worker will not store task state and return values for this task.

run(data)¶

Execute the task.

Parameters:	data (dict) –

Encoders¶

Encoders.

get_encoder_class(import_path=None)¶

Get the encoder class by supplying a fully qualified path to import_path.

If import_path is None the default encoder class specified in the ENCODE_DEFAULT_ENCODER_CLASS is returned.

Parameters:	import_path (str) – Fully qualified path of the encoder class, for example: `encode.encoders.BasicEncoder`.
Returns:	The encoder class.
Return type:	class

class BaseEncoder(profile, input_path=None, output_path=None)¶

The base encoder.

Parameters:	profile (`EncodingProfile`) – The encoding profile that configures this encoder. input_path (str) – output_path (str) –

command¶

The command for the encoder with the vars injected, eg. convert "/path/to/input.gif" "/path/to/output.png".

Return type:	str
Returns:	The command.

class BasicEncoder(profile, input_path=None, output_path=None)¶

Encoder that uses the subprocess module.

start()¶

Start encoding.

Raises:	`EncodeError` if something goes wrong during encoding.

class FFMpegEncoder(profile, input_path=None, output_path=None)¶

Encoder that uses the FFMpeg tool.

start()¶

Start encoding.

Raises:	`EncodeError` if something goes wrong during encoding.

Utilities¶

Utilities.

fqn(obj)¶

Get fully qualified name of obj, eg. encode.util.fqn.

Parameters:	obj –
Return type:	str

get_random_filename(file_extension=u'png', length=12)¶

Returns a random filename with an optional length and file-extension.

Parameters:	file_extension (str) – File extension for the file, e.g. ‘gif’. length (int) – Number of random characters the filename should contain.
Return type:	str
Returns:	A random filename, e.g. `4AwV8Ckn65a3.png`.

get_media_upload_to(instance, filename)¶

Get target path for user file uploads.

Parameters:	instance (`django.db.models.Model`) – Model instance. filename (str) – The filename for the file being uploaded, eg. ‘test.png’.
Return type:	str

parseMedia(data)¶

Decode base64-encoded media data and return result.

Parameters:	data (str) – base64-encoded string
Return type:	str

storeMedia(model, inputFileField, title, profiles, fpath)¶

Encode and store MediaBase object.

Parameters:	model (class) – A model object or instance, e.g. `Video`. title (str) – Name of the file, e.g. test.png. profiles (list) – List of `EncodingProfile` names. fpath (str) – Location of media file.
Variables:	inputFileField – Name of the model field where the file will be stored.
Return type:	`MediaBase` subclass.

class TemporaryMediaFile(prefix, model, inputFileField, profiles, extension=u'media')¶

Container to store a temporary media file for encoding.

Parameters:

prefix (str) – The prefix to use for the temporary filename, e.g. video_.
model (django.db.models.Model) – The model to store the file on, e.g. a subclass of MediaBase.
inputFileField (str) – Name of the model field where the file will be stored.
profiles (list) – List of EncodingProfile names, e.g. [u"MP4", u"WebM Audio/Video"]
extension (str) – The extension to use for the temporary filename. Defaults to media.

save(fileData)¶

Save fileData in temporary file and start encoding.

Parameters:	fileData (`io.BytesIO`) – The media bytes.
Return type:	`MediaBase`
Returns:	A new instance of type `self.model`.

Settings¶

Configuration options.

class EncodeConf(**kwargs)¶

Configuration settings.

MEDIA_PATH_NAME = 'encode_test'¶: Name of the root directory holding the user-uploaded files.

MEDIA_ROOT = '/home/docs/checkouts/readthedocs.org/user_builds/django-encode/checkouts/stable/doc/media'¶: Absolute filesystem path to the directory that will hold user-uploaded files for the encode application.

AUDIO_PROFILES = ['MP3 Audio', 'Ogg Audio']¶: TODO

VIDEO_PROFILES = ['MP4', 'WebM Audio/Video']¶: TODO

IMAGE_PROFILES = ['PNG']¶: TODO

LOCAL_FILE_STORAGE = 'django.core.files.storage.FileSystemStorage'¶: TODO

REMOTE_FILE_STORAGE = 'django.core.files.storage.FileSystemStorage'¶: Django file storage used for transferring media uploads to the encoder.

CDN_FILE_STORAGE = 'django.core.files.storage.FileSystemStorage'¶: Django file storage used for storing encoded media on a CDN network.

LOCAL_STORAGE_OPTIONS = {'location': '/home/docs/checkouts/readthedocs.org/user_builds/django-encode/checkouts/stable/doc/media'}¶: TODO

REMOTE_STORAGE_OPTIONS = {'location': '/home/docs/checkouts/readthedocs.org/user_builds/django-encode/checkouts/stable/doc/media/remote'}¶: TODO

DEFAULT_ENCODER_CLASS = 'encode.encoders.BasicEncoder'¶: TODO

Development¶

After checkout, install dependencies and package in active virtualenv:

$ pip install -r requirements/development.txt
$ pip install -r requirements/testing.txt
$ pip install -r requirements/production.txt
$ pip install -e .

Testing¶

Running tests with Tox:

$ tox -v

Or alternatively:

$ python setup.py test

Running tests without Tox:

$ ./runtests.py

Directly with django-admin:

$ django-admin test --settings=encode.tests.settings encode

Coverage¶

To generate a test coverage report using coverage.py:

$ coverage run --source='.' runtests.py
$ coverage html

The resulting HTML report can be found in the htmlcov directory.

Localization¶

To collect all strings for the locale nl into django.po:

$ django-admin makemessages --settings=encode.tests.settings --ignore=tests/*.py -l nl

After translating, compile the django.po catalog into the binary version django.mo:

$ django-admin compilemessages --settings=encode.tests.settings