Remove fallback system and add comprehensive documentation
- Removed sound generation fallback functionality - Updated error handling to show proper music generation access errors - Added comprehensive README.md with full documentation - Included installation, usage, troubleshooting, and deployment guides - Updated UI messaging for better user experience 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
DJP
parent
ddd35655da
commit
16578bf175
4 changed files with 338 additions and 9 deletions
300
README.md
Normal file
300
README.md
Normal file
|
|
@ -0,0 +1,300 @@
|
|||
# 🎵 ElevenLabs Music Generator
|
||||
|
||||
A web-based application for generating AI music using ElevenLabs' Music Generation API. This application provides both simple prompt-based music generation and advanced composition planning features.
|
||||
|
||||
## 🌟 Features
|
||||
|
||||
### 🎼 Two Generation Modes
|
||||
- **Simple Mode**: Generate music directly from a text prompt
|
||||
- **Advanced Mode**: Create detailed composition plans first, then generate music from those plans
|
||||
|
||||
### 🎛️ Advanced Controls
|
||||
- **Duration Control**: Set music length from 10 seconds to 5 minutes (300 seconds)
|
||||
- **Composition Planning**: Generate structured plans with styles, sections, and arrangements
|
||||
- **Real-time Preview**: Built-in audio player with download capability
|
||||
- **Dark Mode**: Toggle between light and dark themes
|
||||
|
||||
### 🔒 Enterprise Features
|
||||
- **SSO Authentication**: Microsoft Azure AD integration (disabled for local development)
|
||||
- **Webhook Integration**: Automatic provenance tracking for generated content
|
||||
- **Auto-cleanup**: Generated files automatically deleted after 24 hours
|
||||
- **Error Handling**: Comprehensive error reporting and logging
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
### System Requirements
|
||||
- **PHP 7.4+** with cURL extension
|
||||
- **Web Server** (Apache, Nginx, or PHP built-in server)
|
||||
- **ElevenLabs API Key** with Music Generation access
|
||||
|
||||
### ElevenLabs Subscription Requirements
|
||||
- **Music Generation Access**: Requires special access and additional terms acceptance
|
||||
- **Recommended**: Creator or Pro tier subscription
|
||||
- **Contact**: Your ElevenLabs account team for music generation enablement
|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### 1. Clone the Repository
|
||||
```bash
|
||||
git clone https://bitbucket.org/zlalani/music-generation.git
|
||||
cd music-generation
|
||||
```
|
||||
|
||||
### 2. Configure API Key
|
||||
Edit `config.php` and replace the API key:
|
||||
```php
|
||||
return [
|
||||
'elevenlabs_api_key' => 'your-actual-api-key-here',
|
||||
'max_file_age_hours' => 24,
|
||||
'generated_files_dir' => 'generated/'
|
||||
];
|
||||
```
|
||||
|
||||
### 3. Set Permissions
|
||||
```bash
|
||||
# Create generated files directory
|
||||
mkdir -p generated/
|
||||
chmod 755 generated/
|
||||
|
||||
# Ensure PHP can write to the directory
|
||||
chown www-data:www-data generated/ # On Ubuntu/Debian
|
||||
# OR
|
||||
chown apache:apache generated/ # On CentOS/RHEL
|
||||
```
|
||||
|
||||
### 4. Local Development
|
||||
For quick local testing:
|
||||
```bash
|
||||
# Using PHP built-in server
|
||||
php -S localhost:8000
|
||||
|
||||
# Then visit: http://localhost:8000
|
||||
```
|
||||
|
||||
## 🎯 Usage Guide
|
||||
|
||||
### Simple Mode
|
||||
1. Select **"Simple Mode"** from the dropdown
|
||||
2. Enter your music description (e.g., "Upbeat electronic dance track with driving bass")
|
||||
3. Optionally set duration using the slider (0 = auto-duration)
|
||||
4. Click **"Generate Music"**
|
||||
5. Wait for generation (may take 30-60 seconds)
|
||||
6. Play and download your generated music
|
||||
|
||||
### Advanced Mode
|
||||
1. Select **"Advanced Mode (with Composition Plan)"**
|
||||
2. Enter your music description
|
||||
3. Click **"Generate Composition Plan"** first
|
||||
4. Review the generated plan (includes styles, sections, structure)
|
||||
5. Click **"Generate Music"** to create audio from the plan
|
||||
6. Play and download your generated music
|
||||
|
||||
### Example Prompts
|
||||
- **Electronic**: "Energetic EDM track with heavy bass drops and soaring synths"
|
||||
- **Classical**: "Peaceful piano melody with subtle string accompaniment"
|
||||
- **Ambient**: "Atmospheric soundscape with ethereal pads and gentle rain sounds"
|
||||
- **Rock**: "Driving rock anthem with powerful drums and electric guitar"
|
||||
|
||||
## 🔧 API Endpoints Used
|
||||
|
||||
### Music Generation
|
||||
- **Endpoint**: `POST https://api.elevenlabs.io/v1/music`
|
||||
- **Purpose**: Generate music from prompts or composition plans
|
||||
- **Parameters**:
|
||||
- `prompt`: Text description (max 2000 characters)
|
||||
- `music_length_ms`: Duration in milliseconds (10000-300000)
|
||||
- `composition_plan`: Advanced structured plan (optional)
|
||||
|
||||
### Composition Planning
|
||||
- **Endpoint**: `POST https://api.elevenlabs.io/v1/music/plan`
|
||||
- **Purpose**: Create detailed composition plans
|
||||
- **Parameters**:
|
||||
- `prompt`: Text description (max 2000 characters)
|
||||
- `music_length_ms`: Duration in milliseconds (optional)
|
||||
- **Note**: This endpoint doesn't consume credits but is rate-limited
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
### File Structure
|
||||
```
|
||||
music-generation/
|
||||
├── index.php # Main application interface
|
||||
├── config.php # Configuration settings
|
||||
├── generate_plan.php # Composition plan generation endpoint
|
||||
├── webhook_processor_audio.php # Webhook integration for provenance
|
||||
├── generated/ # Auto-generated music files (auto-cleanup)
|
||||
└── README.md # This documentation
|
||||
```
|
||||
|
||||
### Key Components
|
||||
|
||||
#### Authentication System
|
||||
- **Microsoft SSO**: Azure AD integration for enterprise use
|
||||
- **Local Override**: Disabled for development/testing
|
||||
- **Session Management**: Token-based authentication
|
||||
|
||||
#### Webhook Integration
|
||||
- **Provenance Tracking**: Automatic logging of all generation events
|
||||
- **Data Structure**: Standardized webhook payload format
|
||||
- **Error Handling**: Graceful fallback if webhook fails
|
||||
|
||||
#### File Management
|
||||
- **Auto-naming**: Timestamped filename generation
|
||||
- **Auto-cleanup**: Configurable file retention (default: 24 hours)
|
||||
- **Storage**: Local filesystem with organized structure
|
||||
|
||||
## 🛠️ Configuration Options
|
||||
|
||||
### config.php Settings
|
||||
```php
|
||||
return [
|
||||
// ElevenLabs API configuration
|
||||
'elevenlabs_api_key' => 'your-api-key',
|
||||
|
||||
// File management
|
||||
'max_file_age_hours' => 24, # Auto-delete after 24 hours
|
||||
'generated_files_dir' => 'generated/' # Storage directory
|
||||
];
|
||||
```
|
||||
|
||||
### Webhook Configuration
|
||||
The `AudioWebhookProcessor` class supports:
|
||||
- Custom webhook URLs
|
||||
- Configurable timeouts
|
||||
- SSL verification settings
|
||||
- Client/user identification
|
||||
- Deliverable tracking
|
||||
|
||||
## 🚨 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### "Music generation requires additional access"
|
||||
- **Cause**: ElevenLabs Music API requires special access
|
||||
- **Solution**: Contact your ElevenLabs account team
|
||||
- **Links**: [Music Terms](https://elevenlabs.io/music-terms)
|
||||
|
||||
#### "Please configure your ElevenLabs API key"
|
||||
- **Cause**: Invalid or missing API key in config.php
|
||||
- **Solution**: Update config.php with valid API key
|
||||
|
||||
#### "API Error (403): limited_access"
|
||||
- **Cause**: API key doesn't have music generation permissions
|
||||
- **Solution**: Upgrade subscription and accept music terms
|
||||
|
||||
#### Files not generating
|
||||
- **Check**: PHP error logs for detailed error messages
|
||||
- **Verify**: Generated directory permissions (755)
|
||||
- **Ensure**: Sufficient disk space available
|
||||
|
||||
### Debug Mode
|
||||
Enable PHP error reporting for development:
|
||||
```php
|
||||
// Add to top of index.php for debugging
|
||||
error_reporting(E_ALL);
|
||||
ini_set('display_errors', 1);
|
||||
```
|
||||
|
||||
## 🔐 Security Considerations
|
||||
|
||||
### API Key Protection
|
||||
- Store API keys securely in config.php
|
||||
- Never commit API keys to version control
|
||||
- Use environment variables in production
|
||||
|
||||
### File Security
|
||||
- Generated files are automatically cleaned up
|
||||
- No sensitive data stored in generated files
|
||||
- Directory permissions properly configured
|
||||
|
||||
### SSO Integration
|
||||
- Microsoft Azure AD integration available
|
||||
- Token-based session management
|
||||
- Configurable for enterprise environments
|
||||
|
||||
## 🚀 Deployment
|
||||
|
||||
### Production Checklist
|
||||
- [ ] Configure proper web server (Apache/Nginx)
|
||||
- [ ] Set up HTTPS/SSL certificates
|
||||
- [ ] Configure proper file permissions
|
||||
- [ ] Enable SSO authentication
|
||||
- [ ] Set up monitoring and logging
|
||||
- [ ] Configure webhook endpoints
|
||||
- [ ] Test music generation access
|
||||
- [ ] Set up automated backups
|
||||
|
||||
### Environment Variables
|
||||
Consider using environment variables for sensitive config:
|
||||
```php
|
||||
// In config.php
|
||||
return [
|
||||
'elevenlabs_api_key' => $_ENV['ELEVENLABS_API_KEY'] ?? 'fallback-key',
|
||||
// ... other settings
|
||||
];
|
||||
```
|
||||
|
||||
## 📊 Monitoring & Analytics
|
||||
|
||||
### Webhook Tracking
|
||||
All generations are tracked via webhook with:
|
||||
- Generation timestamp
|
||||
- User identification
|
||||
- Prompt/settings used
|
||||
- File size and duration
|
||||
- Success/failure status
|
||||
|
||||
### File Management
|
||||
- Automatic cleanup prevents disk space issues
|
||||
- Configurable retention periods
|
||||
- File size and generation tracking
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
### Development Setup
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Make your changes
|
||||
4. Test thoroughly
|
||||
5. Submit a pull request
|
||||
|
||||
### Code Standards
|
||||
- Follow PHP PSR standards
|
||||
- Comment complex functionality
|
||||
- Test with both generation modes
|
||||
- Verify webhook integration
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is proprietary software developed for Oliver Agency. All rights reserved.
|
||||
|
||||
## 🆘 Support
|
||||
|
||||
### For Technical Issues
|
||||
- Check the troubleshooting section above
|
||||
- Review PHP error logs
|
||||
- Test with the provided example prompts
|
||||
|
||||
### For ElevenLabs API Issues
|
||||
- Contact ElevenLabs support
|
||||
- Review your subscription tier
|
||||
- Check API key permissions
|
||||
|
||||
### For Feature Requests
|
||||
- Submit issues to the repository
|
||||
- Include detailed requirements
|
||||
- Provide use case examples
|
||||
|
||||
## 🔄 Version History
|
||||
|
||||
### v1.0.0 - Initial Release
|
||||
- Music generation with simple and advanced modes
|
||||
- Composition plan generation
|
||||
- Webhook integration for provenance tracking
|
||||
- Dark mode support
|
||||
- SSO authentication system
|
||||
- Automatic file cleanup
|
||||
|
||||
---
|
||||
|
||||
**Built with ❤️ using ElevenLabs Music Generation API**
|
||||
BIN
generated/audio_2025-08-19_14-34-49.mp3
Normal file
BIN
generated/audio_2025-08-19_14-34-49.mp3
Normal file
Binary file not shown.
BIN
generated/audio_2025-08-19_14-35-14.mp3
Normal file
BIN
generated/audio_2025-08-19_14-35-14.mp3
Normal file
Binary file not shown.
47
index.php
47
index.php
|
|
@ -304,8 +304,8 @@
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Login Screen -->
|
||||
<div id="login-container">
|
||||
<!-- Login Screen - Hidden for local testing -->
|
||||
<div id="login-container" style="display: none;">
|
||||
<h1>🎵 Music Generator</h1>
|
||||
<p>Please log in to access the music generator and create amazing compositions for your projects.</p>
|
||||
<button id="login-button" onclick="signIn()">
|
||||
|
|
@ -313,8 +313,8 @@
|
|||
</button>
|
||||
</div>
|
||||
|
||||
<!-- Logout Button -->
|
||||
<button id="logout-button" onclick="signOut()" title="Log Out">
|
||||
<!-- Logout Button - Hidden for local testing -->
|
||||
<button id="logout-button" onclick="signOut()" title="Log Out" style="display: none;">
|
||||
Log Out
|
||||
</button>
|
||||
|
||||
|
|
@ -337,6 +337,12 @@
|
|||
<div class="container">
|
||||
<h1>🎵 Music Generator</h1>
|
||||
|
||||
<div class="result" style="background-color: #fff3cd; border: 1px solid #ffeaa7; color: #856404; margin-bottom: 20px;">
|
||||
<strong>Note:</strong> ElevenLabs Music Generation requires special access and additional terms acceptance.
|
||||
Contact your account team to enable music generation access.
|
||||
<a href="https://elevenlabs.io/music-terms" target="_blank">Learn more about music terms</a>
|
||||
</div>
|
||||
|
||||
<?php
|
||||
// Load configuration
|
||||
$config = require_once 'config.php';
|
||||
|
|
@ -393,14 +399,16 @@
|
|||
$url = 'https://api.elevenlabs.io/v1/music';
|
||||
|
||||
$data = [
|
||||
'prompt' => $prompt,
|
||||
'model_id' => 'music_v1'
|
||||
'prompt' => $prompt
|
||||
];
|
||||
|
||||
// Only add music_length_ms if it's specified and valid (minimum 10 seconds)
|
||||
if (!empty($musicLengthMs) && is_numeric($musicLengthMs) && $musicLengthMs >= 10000) {
|
||||
$data['music_length_ms'] = (int)$musicLengthMs;
|
||||
}
|
||||
|
||||
// Don't include model_id as it defaults to music_v1
|
||||
|
||||
return generateMusicRequest($url, $data, $apiKey, $error, 'ElevenLabs Music Generation', $prompt);
|
||||
}
|
||||
|
||||
|
|
@ -431,6 +439,9 @@
|
|||
$response = curl_exec($ch);
|
||||
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
|
||||
|
||||
// Log the request for debugging
|
||||
error_log("Music API Request - URL: $url, Data: " . json_encode($data) . ", HTTP Code: $httpCode, Response: " . substr($response, 0, 500));
|
||||
|
||||
if (curl_error($ch)) {
|
||||
$error = 'Connection error: ' . curl_error($ch);
|
||||
curl_close($ch);
|
||||
|
|
@ -484,8 +495,24 @@
|
|||
return false;
|
||||
}
|
||||
} else {
|
||||
// Better error handling
|
||||
$errorResponse = json_decode($response, true);
|
||||
$error = 'API Error (' . $httpCode . '): ' . ($errorResponse['detail'] ?? 'Unknown error occurred');
|
||||
if (json_last_error() === JSON_ERROR_NONE && is_array($errorResponse)) {
|
||||
// Successfully parsed JSON response
|
||||
if (isset($errorResponse['detail'])) {
|
||||
$errorDetail = is_array($errorResponse['detail']) ? json_encode($errorResponse['detail']) : $errorResponse['detail'];
|
||||
} elseif (isset($errorResponse['message'])) {
|
||||
$errorDetail = is_array($errorResponse['message']) ? json_encode($errorResponse['message']) : $errorResponse['message'];
|
||||
} elseif (isset($errorResponse['error'])) {
|
||||
$errorDetail = is_array($errorResponse['error']) ? json_encode($errorResponse['error']) : $errorResponse['error'];
|
||||
} else {
|
||||
$errorDetail = json_encode($errorResponse);
|
||||
}
|
||||
} else {
|
||||
// Raw response if JSON parsing failed
|
||||
$errorDetail = substr($response, 0, 500);
|
||||
}
|
||||
$error = 'API Error (' . $httpCode . '): ' . $errorDetail;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
|
@ -622,8 +649,10 @@
|
|||
|
||||
// Initialize authentication on page load
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
// Disable SSO for local testing - auto show protected content
|
||||
showProtectedContent();
|
||||
// Disable SSO for local testing - directly show protected content
|
||||
document.getElementById('login-container').style.display = 'none';
|
||||
document.getElementById('protected-content').style.display = 'block';
|
||||
document.getElementById('logout-button').style.display = 'none';
|
||||
|
||||
// Dark mode toggle functionality
|
||||
// Check for saved dark mode preference
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue