2 * mlt_producer.c -- abstraction for all producer services
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
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.
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.
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.
22 #include "mlt_producer.h"
23 #include "mlt_factory.h"
24 #include "mlt_frame.h"
30 /** Forward references.
33 static int producer_get_frame( mlt_service this, mlt_frame_ptr frame, int index );
38 int mlt_producer_init( mlt_producer this, void *child )
40 // Check that we haven't received NULL
41 int error = this == NULL;
43 // Continue if no error
46 // Initialise the producer
47 memset( this, 0, sizeof( struct mlt_producer_s ) );
49 // Associate with the child
52 // Initialise the service
53 if ( mlt_service_init( &this->parent, this ) == 0 )
55 // Get the normalisation preference
56 char *normalisation = mlt_environment( "MLT_NORMALISATION" );
58 // The parent is the service
59 mlt_service parent = &this->parent;
61 // Define the parent close
62 parent->close = ( mlt_destructor )mlt_producer_close;
63 parent->close_object = this;
65 // For convenience, we'll assume the close_object is this
66 this->close_object = this;
68 // Get the properties of the parent
69 mlt_properties properties = mlt_service_properties( parent );
71 // Set the default properties
72 mlt_properties_set( properties, "mlt_type", "mlt_producer" );
73 mlt_properties_set_position( properties, "_position", 0.0 );
74 mlt_properties_set_double( properties, "_frame", 0 );
75 if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
77 mlt_properties_set_double( properties, "fps", 25.0 );
78 mlt_properties_set_double( properties, "aspect_ratio", 72.0 / 79.0 );
82 mlt_properties_set_double( properties, "fps", 30000.0 / 1001.0 );
83 mlt_properties_set_double( properties, "aspect_ratio", 128.0 / 117.0 );
85 mlt_properties_set_double( properties, "_speed", 1.0 );
86 mlt_properties_set_position( properties, "in", 0 );
87 mlt_properties_set_position( properties, "out", 14999 );
88 mlt_properties_set_position( properties, "length", 15000 );
89 mlt_properties_set( properties, "eof", "pause" );
90 mlt_properties_set( properties, "resource", "<producer>" );
92 // Override service get_frame
93 parent->get_frame = producer_get_frame;
100 /** Create a new producer.
103 mlt_producer mlt_producer_new( )
105 mlt_producer this = malloc( sizeof( struct mlt_producer_s ) );
106 mlt_producer_init( this, NULL );
110 /** Get the parent service object.
113 mlt_service mlt_producer_service( mlt_producer this )
115 return this != NULL ? &this->parent : NULL;
118 /** Get the producer properties.
121 mlt_properties mlt_producer_properties( mlt_producer this )
123 return mlt_service_properties( &this->parent );
126 /** Seek to a specified position.
129 int mlt_producer_seek( mlt_producer this, mlt_position position )
131 // Determine eof handling
132 char *eof = mlt_properties_get( mlt_producer_properties( this ), "eof" );
133 int use_points = 1 - mlt_properties_get_int( mlt_producer_properties( this ), "ignore_points" );
140 else if ( use_points && !strcmp( eof, "pause" ) && position >= mlt_producer_get_playtime( this ) )
142 mlt_producer_set_speed( this, 0 );
143 position = mlt_producer_get_playtime( this ) - 1;
145 else if ( use_points && !strcmp( eof, "loop" ) && position >= mlt_producer_get_playtime( this ) )
147 position = position % mlt_producer_get_playtime( this );
151 mlt_properties_set_position( mlt_producer_properties( this ), "_position", position );
153 // Calculate the absolute frame
154 mlt_properties_set_position( mlt_producer_properties( this ), "_frame", use_points * mlt_producer_get_in( this ) + position );
159 /** Get the current position (relative to in point).
162 mlt_position mlt_producer_position( mlt_producer this )
164 return mlt_properties_get_position( mlt_producer_properties( this ), "_position" );
167 /** Get the current position (relative to start of producer).
170 mlt_position mlt_producer_frame( mlt_producer this )
172 return mlt_properties_get_position( mlt_producer_properties( this ), "_frame" );
175 /** Set the playing speed.
178 int mlt_producer_set_speed( mlt_producer this, double speed )
180 return mlt_properties_set_double( mlt_producer_properties( this ), "_speed", speed );
183 /** Get the playing speed.
186 double mlt_producer_get_speed( mlt_producer this )
188 return mlt_properties_get_double( mlt_producer_properties( this ), "_speed" );
191 /** Get the frames per second.
194 double mlt_producer_get_fps( mlt_producer this )
196 return mlt_properties_get_double( mlt_producer_properties( this ), "fps" );
199 /** Set the in and out points.
202 int mlt_producer_set_in_and_out( mlt_producer this, mlt_position in, mlt_position out )
204 // Correct ins and outs if necessary
207 else if ( in > mlt_producer_get_length( this ) )
208 in = mlt_producer_get_length( this );
212 else if ( out > mlt_producer_get_length( this ) )
213 out = mlt_producer_get_length( this );
215 // Swap ins and outs if wrong
224 mlt_properties_set_position( mlt_producer_properties( this ), "in", in );
225 mlt_properties_set_position( mlt_producer_properties( this ), "out", out );
230 /** Get the in point.
233 mlt_position mlt_producer_get_in( mlt_producer this )
235 return mlt_properties_get_position( mlt_producer_properties( this ), "in" );
238 /** Get the out point.
241 mlt_position mlt_producer_get_out( mlt_producer this )
243 return mlt_properties_get_position( mlt_producer_properties( this ), "out" );
246 /** Get the total play time.
249 mlt_position mlt_producer_get_playtime( mlt_producer this )
251 return mlt_producer_get_out( this ) - mlt_producer_get_in( this ) + 1;
254 /** Get the total length of the producer.
257 mlt_position mlt_producer_get_length( mlt_producer this )
259 return mlt_properties_get_position( mlt_producer_properties( this ), "length" );
262 /** Prepare for next frame.
265 void mlt_producer_prepare_next( mlt_producer this )
267 mlt_producer_seek( this, mlt_producer_position( this ) + mlt_producer_get_speed( this ) );
273 static int producer_get_frame( mlt_service service, mlt_frame_ptr frame, int index )
276 mlt_producer this = service->child;
278 // Determine eof handling
279 char *eof = mlt_properties_get( mlt_producer_properties( this ), "eof" );
281 // A properly instatiated producer will have a get_frame method...
282 if ( this->get_frame == NULL || ( !strcmp( eof, "continue" ) && mlt_producer_position( this ) > mlt_producer_get_out( this ) ) )
284 // Generate a test frame
285 *frame = mlt_frame_init( );
288 result = mlt_frame_set_position( *frame, mlt_producer_position( this ) );
290 // Mark as a test card
291 mlt_properties_set_int( mlt_frame_properties( *frame ), "test_image", 1 );
292 mlt_properties_set_int( mlt_frame_properties( *frame ), "test_audio", 1 );
294 // Calculate the next position
295 mlt_producer_prepare_next( this );
299 // Get the frame from the implementation
300 result = this->get_frame( this, frame, index );
303 // Copy the fps and speed of the producer onto the frame
304 mlt_properties properties = mlt_frame_properties( *frame );
305 mlt_properties_set_double( properties, "fps", mlt_producer_get_fps( this ) );
306 double speed = mlt_producer_get_speed( this );
307 mlt_properties_set_double( properties, "_speed", speed );
308 mlt_properties_set_int( properties, "test_audio", mlt_frame_is_test_audio( *frame ) );
309 mlt_properties_set_int( properties, "test_image", mlt_frame_is_test_card( *frame ) );
314 /** Close the producer.
317 void mlt_producer_close( mlt_producer this )
319 if ( this != NULL && mlt_properties_dec_ref( mlt_producer_properties( this ) ) <= 0 )
321 this->parent.close = NULL;
323 if ( this->close != NULL )
324 this->close( this->close_object );
326 mlt_service_close( &this->parent );