Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/areski/django-audiofield
Django-Audiofield is a simple app that allows Audio files upload, management and conversion to different audio format (mp3, wav & ogg), which also makes it easy to play audio files into your Django application.
https://github.com/areski/django-audiofield
Last synced: 29 days ago
JSON representation
Django-Audiofield is a simple app that allows Audio files upload, management and conversion to different audio format (mp3, wav & ogg), which also makes it easy to play audio files into your Django application.
- Host: GitHub
- URL: https://github.com/areski/django-audiofield
- Owner: areski
- License: other
- Created: 2011-12-08T16:53:48.000Z (about 13 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-20T08:03:23.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T12:45:14.901Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 1.28 MB
- Stars: 174
- Watchers: 21
- Forks: 51
- Open Issues: 15
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: MIT-LICENSE.txt
Awesome Lists containing this project
- awesome-django-cn - django-audiofield, star:91 - 允许对音频文件进行上传，管理，将转换成不同的音频格式 (mp3, wav & ogg)。 (数据项)
- awesome-django - django-audiofield - Allows audio files upload, management and conversion to different audio format (mp3, wav & ogg). (Fields)
- awesome-django - django-audiofield - Allows audio files upload, management and conversion to different audio format (mp3, wav & ogg). (Fields)
README
Django-Audiofield
=================
:Description: Django Audio Management Tools
:Maintainer: Areski_
:Contributors: `list of contributors `_
.. _Areski: https://github.com/areski/
.. image:: https://img.shields.io/pypi/v/django-audiofield.svg
:target: https://pypi.python.org/pypi/django-audiofield/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/django-audiofield.svg
:target: https://pypi.python.org/pypi/django-audiofield/
:alt: Downloads
.. image:: https://img.shields.io/pypi/pyversions/django-audiofield.svg
:target: https://pypi.python.org/pypi/django-audiofield/
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/l/django-audiofield.svg
:target: https://pypi.python.org/pypi/django-audiofield/
:alt: License
Django-Audiofield is a simple app that allows Audio files upload, management and conversion to different audio format (mp3, wav & ogg), which also makes it easy to play audio files into your Django application.
We are using the HTML5 and Flash audio player SoundManager2_
.. _SoundManager2: http://www.schillmania.com/projects/soundmanager2/
.. image:: https://github.com/Star2Billing/django-audiofield/raw/master/docs/source/_static/django-admin-audiofield.png
.. image:: https://github.com/Star2Billing/django-audiofield/raw/master/docs/source/_static/django-admin-audiofield-upload.png
Installation
============
Install Django-Audiofield::
python setup.py install
Dependencies
------------
Install dependencies on Debian::
apt-get -y install libsox-fmt-mp3 libsox-fmt-all mpg321 dir2ogg ffmpeg
Note: For Debian version 7 (Wheezy) and older, replace `ffmpeg` with `libav-tools`
Install dependencies on Redhat/CentOS::
yum -y install python-setuptools libsox-fmt-mp3 libsox-fmt-all mpg321 dir2ogg
Install avconv on Redhat/CentOS::
git clone git://git.libav.org/libav.git
cd libav
sudo ./configure --disable-yasm
sudo make
sudo make install
Settings
========
in your settings.py file::
# Set Following variable
MEDIA_ROOT = ''
MEDIA_URL = ''
In MIDDLEWARE_CLASSES add 'audiofield.middleware.threadlocals.ThreadLocals'
In INSTALLED_APPS add 'audiofield'
# Frontend widget values
# 0-Keep original, 1-Mono, 2-Stereo
CHANNEL_TYPE_VALUE = 0
# 0-Keep original, 8000-8000Hz, 16000-16000Hz, 22050-22050Hz,
# 44100-44100Hz, 48000-48000Hz, 96000-96000Hz
FREQ_TYPE_VALUE = 8000
# 0-Keep original, 1-Convert to MP3, 2-Convert to WAV, 3-Convert to OGG
CONVERT_TYPE_VALUE = 0
Usage
=====
Add the following lines in your models.py file::
from django.conf import settings
from audiofield.fields import AudioField
import os.path
# Add the audio field to your model
audio_file = AudioField(upload_to='your/upload/dir', blank=True,
ext_whitelist=(".mp3", ".wav", ".ogg"),
help_text=("Allowed type - .mp3, .wav, .ogg"))
# Add this method to your model
def audio_file_player(self):
"""audio player tag for admin"""
if self.audio_file:
file_url = settings.MEDIA_URL + str(self.audio_file)
player_string = 'Your browser does not support the audio element.' % (file_url)
return player_string
audio_file_player.allow_tags = True
audio_file_player.short_description = ('Audio file player')
Add the following lines in your admin.py::
from your_app.models import your_model_name
# add 'audio_file_player' tag to your admin view
list_display = (..., 'audio_file_player', ...)
actions = ['custom_delete_selected']
def custom_delete_selected(self, request, queryset):
#custom delete code
n = queryset.count()
for i in queryset:
if i.audio_file:
if os.path.exists(i.audio_file.path):
os.remove(i.audio_file.path)
i.delete()
self.message_user(request, ("Successfully deleted %d audio files.") % n)
custom_delete_selected.short_description = "Delete selected items"
def get_actions(self, request):
actions = super(AudioFileAdmin, self).get_actions(request)
del actions['delete_selected']
return actions
Then perform following commands to create the table and collect the static files::
./manage.py syncdb
./manage.py collectstatic
Create audiofield.log file::
touch /var/log/audio-field.log
Contributing
============
If you've found a bug, implemented a feature or customized the template and
think it is useful then please consider contributing. Patches, pull requests or
just suggestions are welcome!
Source code: http://github.com/Star2Billing/django-audiofield
Bug tracker: https://github.com/Star2Billing/django-audiofield/issues
Documentation
=============
Documentation is available on 'Read the Docs':
http://django-audiofield.readthedocs.org
Credit
======
Django-audiofield is a Star2Billing-Sponsored Community Project, for more information visit http://www.star2billing.com or email us at [email protected]
License
=======
Django-Audiofield is licensed under MIT, see `MIT-LICENSE.txt`.
TODO
====
- Use pydub (http://pydub.com) to lift the audio conversion away from django-audiofield
- integrate with django-storage (http://django-storages.readthedocs.org/)
- support more formats