Memory pooling
[melted] / src / modules / vorbis / producer_vorbis.c
1 /*
2 * producer_vorbis.c -- vorbis producer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21 // Local header files
22 #include "producer_vorbis.h"
23
24 // MLT Header files
25 #include <framework/mlt_frame.h>
26
27 // vorbis Header files
28 #include <vorbis/codec.h>
29 #include <vorbis/vorbisfile.h>
30
31 // System header files
32 #include <stdlib.h>
33 #include <string.h>
34
35 // Forward references.
36 static int producer_open( mlt_producer this, char *file );
37 static int producer_get_frame( mlt_producer this, mlt_frame_ptr frame, int index );
38
39 /** Constructor for libvorbis.
40 */
41
42 mlt_producer producer_vorbis_init( char *file )
43 {
44 mlt_producer this = NULL;
45
46 // Check that we have a non-NULL argument
47 if ( file != NULL )
48 {
49 // Construct the producer
50 this = calloc( 1, sizeof( struct mlt_producer_s ) );
51
52 // Initialise it
53 if ( mlt_producer_init( this, NULL ) == 0 )
54 {
55 // Get the properties
56 mlt_properties properties = mlt_producer_properties( this );
57
58 // Set the resource property (required for all producers)
59 mlt_properties_set( properties, "resource", file );
60
61 // Register our get_frame implementation
62 this->get_frame = producer_get_frame;
63
64 // Open the file
65 if ( producer_open( this, file ) != 0 )
66 {
67 // Clean up
68 mlt_producer_close( this );
69 this = NULL;
70 }
71 }
72 }
73
74 return this;
75 }
76
77 /** Destuctor for ogg files.
78 */
79
80 static void producer_file_close( void *file )
81 {
82 if ( file != NULL )
83 {
84 // Close the ogg vorbis structure
85 ov_clear( file );
86
87 // Free the memory
88 free( file );
89 }
90 }
91
92 /** Open the file.
93 */
94
95 static int producer_open( mlt_producer this, char *file )
96 {
97 // FILE pointer for file
98 FILE *input = fopen( file, "r" );
99
100 // Error code to return
101 int error = input == NULL;
102
103 // Continue if file is open
104 if ( error == 0 )
105 {
106 // OggVorbis file structure
107 OggVorbis_File *ov = calloc( 1, sizeof( OggVorbis_File ) );
108
109 // Attempt to open the stream
110 error = ov == NULL || ov_open( input, ov, NULL, 0 ) != 0;
111
112 // Assign to producer properties if successful
113 if ( error == 0 )
114 {
115 // Get the properties
116 mlt_properties properties = mlt_producer_properties( this );
117
118 // Assign the ov structure
119 mlt_properties_set_data( properties, "ogg_vorbis_file", ov, 0, producer_file_close, NULL );
120
121 if ( ov_seekable( ov ) )
122 {
123 // Get the length of the file
124 double length = ov_time_total( ov, -1 );
125
126 // We will treat everything with the producer fps
127 double fps = mlt_properties_get_double( properties, "fps" );
128
129 // Set out and length of file
130 mlt_properties_set_position( properties, "out", ( length * fps ) - 1 );
131 mlt_properties_set_position( properties, "length", ( length * fps ) );
132 }
133 }
134 else
135 {
136 // Clean up
137 free( ov );
138
139 // Must close input file when open fails
140 fclose( input );
141 }
142 }
143
144 return error;
145 }
146
147 /** Convert a frame position to a time code.
148 */
149
150 static double producer_time_of_frame( mlt_producer this, mlt_position position )
151 {
152 // Get the properties
153 mlt_properties properties = mlt_producer_properties( this );
154
155 // Obtain the fps
156 double fps = mlt_properties_get_double( properties, "fps" );
157
158 // Do the calc
159 return ( double )position / fps;
160 }
161
162 /** Get the audio from a frame.
163 */
164
165 static int producer_get_audio( mlt_frame frame, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
166 {
167 // Get the properties from the frame
168 mlt_properties frame_properties = mlt_frame_properties( frame );
169
170 // Obtain the frame number of this frame
171 mlt_position position = mlt_properties_get_position( frame_properties, "vorbis_position" );
172
173 // Get the producer
174 mlt_producer this = mlt_properties_get_data( frame_properties, "vorbis_producer", NULL );
175
176 // Get the producer properties
177 mlt_properties properties = mlt_producer_properties( this );
178
179 // Get the ogg vorbis file
180 OggVorbis_File *ov = mlt_properties_get_data( properties, "ogg_vorbis_file", NULL );
181
182 // Obtain the expected frame numer
183 mlt_position expected = mlt_properties_get_position( properties, "audio_expected" );
184
185 // Get the fps for this producer
186 double fps = mlt_properties_get_double( properties, "fps" );
187
188 // Get the vorbis info
189 vorbis_info *vi = ov_info( ov, -1 );
190
191 // Obtain the audio buffer
192 int16_t *audio_buffer = mlt_properties_get_data( properties, "audio_buffer", NULL );
193
194 // Get amount of audio used
195 int audio_used = mlt_properties_get_int( properties, "audio_used" );
196
197 // Number of frames to ignore (for ffwd)
198 int ignore = 0;
199
200 // Flag for paused (silence)
201 int paused = 0;
202
203 // Check for audio buffer and create if necessary
204 if ( audio_buffer == NULL )
205 {
206 // Release pointer
207 void *release = NULL;
208
209 // Allocate the audio buffer
210 audio_buffer = mlt_pool_allocate( 131072 * sizeof( int16_t ), &release );
211
212 // And store it on properties for reuse
213 mlt_properties_set_data( properties, "audio_buffer_release", release, 0, ( mlt_destructor )mlt_pool_release, NULL );
214 mlt_properties_set_data( properties, "audio_buffer", audio_buffer, 0, NULL, NULL );
215 }
216
217 // Seek if necessary
218 if ( position != expected )
219 {
220 if ( position + 1 == expected )
221 {
222 // We're paused - silence required
223 paused = 1;
224 }
225 else if ( position > expected && ( position - expected ) < 250 )
226 {
227 // Fast forward - seeking is inefficient for small distances - just ignore following frames
228 ignore = position - expected;
229 }
230 else
231 {
232 // Seek to the required position
233 ov_time_seek( ov, producer_time_of_frame( this, position ) );
234 expected = position;
235 audio_used = 0;
236 }
237 }
238
239 // Return info in frame
240 *frequency = vi->rate;
241 *channels = vi->channels;
242
243 // Get the audio if required
244 if ( !paused )
245 {
246 // Bitstream section
247 int current_section;
248
249 // Get the number of samples for the current frame
250 *samples = mlt_sample_calculator( fps, *frequency, expected ++ );
251
252 while( *samples > audio_used )
253 {
254 // Read the samples
255 int bytes = ov_read( ov, ( char * )( &audio_buffer[ audio_used * 2 ] ), 4096, 0, 2, 1, &current_section );
256
257 // Break if error or eof
258 if ( bytes <= 0 )
259 break;
260
261 // Increment number of samples used
262 audio_used += bytes / ( sizeof( int16_t ) * *channels );
263
264 // Handle ignore
265 while ( ignore && audio_used >= *samples )
266 {
267 ignore --;
268 audio_used -= *samples;
269 memmove( audio_buffer, &audio_buffer[ *samples * *channels ], audio_used * sizeof( int16_t ) );
270 *samples = mlt_sample_calculator( fps, *frequency, expected ++ );
271 }
272 }
273
274 // Now handle the audio if we have enough
275 if ( audio_used >= *samples )
276 {
277 void *release = NULL;
278 *buffer = mlt_pool_allocate( *samples * *channels * sizeof( int16_t ), &release );
279 memcpy( *buffer, audio_buffer, *samples * *channels * sizeof( int16_t ) );
280 audio_used -= *samples;
281 memmove( audio_buffer, &audio_buffer[ *samples * *channels ], audio_used * *channels * sizeof( int16_t ) );
282 mlt_properties_set_data( frame_properties, "audio_release", release, 0, ( mlt_destructor )mlt_pool_release, NULL );
283 mlt_properties_set_data( frame_properties, "audio", *buffer, 0, NULL, NULL );
284 }
285 else
286 {
287 frame->get_audio = NULL;
288 mlt_frame_get_audio( frame, buffer, format, frequency, channels, samples );
289 audio_used = 0;
290 }
291
292 // Store the number of audio samples still available
293 mlt_properties_set_int( properties, "audio_used", audio_used );
294 }
295 else
296 {
297 // Get silence and don't touch the context
298 frame->get_audio = NULL;
299 *samples = mlt_sample_calculator( fps, *frequency, position );
300 mlt_frame_get_audio( frame, buffer, format, frequency, channels, samples );
301 }
302
303 // Regardless of speed, we expect to get the next frame (cos we ain't too bright)
304 mlt_properties_set_position( properties, "audio_expected", position + 1 );
305
306 return 0;
307 }
308
309 /** Set up audio handling.
310 */
311
312 static void producer_set_up_audio( mlt_producer this, mlt_frame frame )
313 {
314 // Get the properties
315 mlt_properties properties = mlt_frame_properties( frame );
316
317 // Set the audio method
318 frame->get_audio = producer_get_audio;
319
320 // Set the producer on the frame
321 mlt_properties_set_data( properties, "vorbis_producer", this, 0, NULL, NULL );
322 }
323
324 /** Our get frame implementation.
325 */
326
327 static int producer_get_frame( mlt_producer this, mlt_frame_ptr frame, int index )
328 {
329 // Create an empty frame
330 *frame = mlt_frame_init( );
331
332 // Update timecode on the frame we're creating
333 mlt_frame_set_position( *frame, mlt_producer_position( this ) );
334
335 // Set the position of this producer
336 mlt_properties_set_position( mlt_frame_properties( *frame ), "vorbis_position", mlt_producer_get_in( this ) + mlt_producer_position( this ) );
337
338 // Set up the audio
339 producer_set_up_audio( this, *frame );
340
341 // Calculate the next timecode
342 mlt_producer_prepare_next( this );
343
344 return 0;
345 }