2 * miracle_unit.c -- DV Transmission Unit Implementation
3 * Copyright (C) 2002-2003 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
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.
27 #include <sys/ioctl.h>
30 #include <sys/types.h>
40 #include "miracle_unit.h"
41 #include "miracle_log.h"
42 #include "miracle_local.h"
44 #include <framework/mlt.h>
46 /* Forward references */
47 static void miracle_unit_status_communicate( miracle_unit
);
49 /** Allocate a new DV transmission unit.
51 \return A new miracle_unit handle.
54 miracle_unit
miracle_unit_init( int index
, char *constructor
)
56 miracle_unit
this = NULL
;
57 mlt_consumer consumer
= NULL
;
59 char *id
= strdup( constructor
);
60 char *arg
= strchr( id
, ':' );
65 consumer
= mlt_factory_consumer( id
, arg
);
67 if ( consumer
!= NULL
)
69 mlt_playlist playlist
= mlt_playlist_init( );
70 this = calloc( sizeof( miracle_unit_t
), 1 );
71 this->properties
= mlt_properties_new( );
72 this->producers
= mlt_properties_new( );
73 mlt_properties_init( this->properties
, this );
74 mlt_properties_set_int( this->properties
, "unit", index
);
75 mlt_properties_set_int( this->properties
, "generation", 0 );
76 mlt_properties_set( this->properties
, "constructor", constructor
);
77 mlt_properties_set( this->properties
, "id", id
);
78 mlt_properties_set( this->properties
, "arg", arg
);
79 mlt_properties_set_data( this->properties
, "consumer", consumer
, 0, ( mlt_destructor
)mlt_consumer_close
, NULL
);
80 mlt_properties_set_data( this->properties
, "playlist", playlist
, 0, ( mlt_destructor
)mlt_playlist_close
, NULL
);
81 mlt_consumer_connect( consumer
, mlt_playlist_service( playlist
) );
87 static char *strip_root( miracle_unit unit
, char *file
)
89 mlt_properties properties
= unit
->properties
;
90 char *root
= mlt_properties_get( properties
, "root" );
91 if ( file
!= NULL
&& root
!= NULL
)
93 int length
= strlen( root
);
94 if ( root
[ length
- 1 ] == '/' )
96 if ( !strncmp( file
, root
, length
) )
102 /** Communicate the current status to all threads waiting on the notifier.
105 static void miracle_unit_status_communicate( miracle_unit unit
)
109 mlt_properties properties
= unit
->properties
;
110 char *root_dir
= mlt_properties_get( properties
, "root" );
111 valerie_notifier notifier
= mlt_properties_get_data( properties
, "notifier", NULL
);
112 valerie_status_t status
;
114 if ( root_dir
!= NULL
&& notifier
!= NULL
)
116 if ( miracle_unit_get_status( unit
, &status
) == 0 )
117 /* if ( !( ( status.status == unit_playing || status.status == unit_paused ) &&
118 strcmp( status.clip, "" ) &&
119 !strcmp( status.tail_clip, "" ) &&
120 status.position == 0 &&
122 status.out == 0 ) ) */
123 valerie_notifier_put( notifier
, &status
);
128 /** Set the notifier info
131 void miracle_unit_set_notifier( miracle_unit
this, valerie_notifier notifier
, char *root_dir
)
133 mlt_properties properties
= this->properties
;
134 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
135 mlt_properties playlist_properties
= mlt_playlist_properties( playlist
);
137 mlt_properties_set( properties
, "root", root_dir
);
138 mlt_properties_set_data( properties
, "notifier", notifier
, 0, NULL
, NULL
);
139 mlt_properties_set_data( playlist_properties
, "notifier_arg", this, 0, NULL
, NULL
);
140 mlt_properties_set_data( playlist_properties
, "notifier", miracle_unit_status_communicate
, 0, NULL
, NULL
);
142 miracle_unit_status_communicate( this );
145 static mlt_producer
create_producer( char *file
)
147 return mlt_factory_producer( "fezzik", file
);
150 /** Create or locate a producer for the file specified.
153 static mlt_producer
locate_producer( miracle_unit unit
, char *file
)
155 // Get the unit properties
156 mlt_properties properties
= unit
->producers
;
158 // Check if we already have loaded this file
159 mlt_producer result
= mlt_properties_get_data( properties
, file
, NULL
);
161 if ( result
== NULL
)
163 // Create the producer
164 result
= create_producer( file
);
166 // Now store the result
167 if ( result
!= NULL
)
168 mlt_properties_set_data( properties
, file
, result
, 0, ( mlt_destructor
)mlt_producer_close
, NULL
);
174 /** Update the generation count.
177 static void update_generation( miracle_unit unit
)
179 mlt_properties properties
= unit
->properties
;
180 int generation
= mlt_properties_get_int( properties
, "generation" );
181 mlt_properties_set_int( properties
, "generation", ++ generation
);
184 /** Wipe all clips on the playlist for this unit.
187 static void clear_unit( miracle_unit unit
)
189 mlt_properties properties
= unit
->properties
;
190 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
191 mlt_producer producer
= mlt_playlist_producer( playlist
);
193 mlt_playlist_clear( playlist
);
194 mlt_producer_seek( producer
, 0 );
196 if ( unit
->old_producers
!= NULL
)
197 mlt_properties_close( unit
->old_producers
);
198 unit
->old_producers
= unit
->producers
;
199 unit
->producers
= mlt_properties_new( );
201 update_generation( unit
);
204 /** Wipe all but the playing clip from the unit.
207 static void clean_unit( miracle_unit unit
)
209 mlt_properties properties
= unit
->properties
;
210 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
211 mlt_playlist_clip_info info
;
212 int current
= mlt_playlist_current_clip( playlist
);
213 mlt_producer producer
= mlt_playlist_producer( playlist
);
214 mlt_position position
= mlt_producer_frame( producer
);
215 double speed
= mlt_producer_get_speed( producer
);
216 mlt_playlist_get_clip_info( playlist
, &info
, current
);
218 if ( info
.resource
!= NULL
)
220 void *instance
= mlt_properties_get_data( unit
->producers
, info
.resource
, NULL
);
221 position
-= info
.start
;
222 mlt_properties_set_data( unit
->producers
, info
.resource
, instance
, 0, NULL
, NULL
);
224 mlt_playlist_append_io( playlist
, instance
, info
.frame_in
, info
.frame_out
);
225 mlt_properties_set_data( unit
->producers
, info
.resource
, instance
, 0, ( mlt_destructor
)mlt_producer_close
, NULL
);
226 mlt_producer_seek( producer
, position
);
227 mlt_producer_set_speed( producer
, speed
);
230 update_generation( unit
);
233 /** Generate a report on all loaded clips.
236 void miracle_unit_report_list( miracle_unit unit
, valerie_response response
)
239 mlt_properties properties
= unit
->properties
;
240 int generation
= mlt_properties_get_int( properties
, "generation" );
241 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
243 valerie_response_printf( response
, 1024, "%d\n", generation
);
245 for ( i
= 0; i
< mlt_playlist_count( playlist
); i
++ )
247 mlt_playlist_clip_info info
;
248 mlt_playlist_get_clip_info( playlist
, &info
, i
);
249 valerie_response_printf( response
, 10240, "%d \"%s\" %lld %lld %lld %lld %.2f\n",
251 strip_root( unit
, info
.resource
),
260 /** Load a clip into the unit clearing existing play list.
263 \param unit A miracle_unit handle.
264 \param clip The absolute file name of the clip to load.
265 \param in The starting frame (-1 for 0)
266 \param out The ending frame (-1 for maximum)
269 valerie_error_code
miracle_unit_load( miracle_unit unit
, char *clip
, int64_t in
, int64_t out
, int flush
)
271 // Now try to create an producer
272 mlt_producer instance
= create_producer( clip
);
274 if ( instance
!= NULL
)
277 mlt_properties properties
= unit
->properties
;
278 mlt_properties_set_data( unit
->producers
, clip
, instance
, 0, ( mlt_destructor
)mlt_producer_close
, NULL
);
279 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
280 mlt_playlist_append_io( playlist
, instance
, in
, out
);
281 miracle_log( LOG_DEBUG
, "loaded clip %s", clip
);
282 miracle_unit_status_communicate( unit
);
286 return valerie_invalid_file
;
289 valerie_error_code
miracle_unit_insert( miracle_unit unit
, char *clip
, int index
, int64_t in
, int64_t out
)
291 mlt_producer instance
= locate_producer( unit
, clip
);
293 if ( instance
!= NULL
)
295 mlt_properties properties
= unit
->properties
;
296 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
297 fprintf( stderr
, "inserting clip %s before %d\n", clip
, index
);
298 mlt_playlist_insert( playlist
, instance
, index
, in
, out
);
299 miracle_log( LOG_DEBUG
, "inserted clip %s at %d", clip
, index
);
300 update_generation( unit
);
301 miracle_unit_status_communicate( unit
);
305 return valerie_invalid_file
;
308 valerie_error_code
miracle_unit_remove( miracle_unit unit
, int index
)
310 mlt_properties properties
= unit
->properties
;
311 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
312 mlt_playlist_remove( playlist
, index
);
313 miracle_log( LOG_DEBUG
, "removed clip at %d", index
);
314 update_generation( unit
);
315 miracle_unit_status_communicate( unit
);
319 valerie_error_code
miracle_unit_clean( miracle_unit unit
)
322 miracle_log( LOG_DEBUG
, "Cleaned playlist" );
323 miracle_unit_status_communicate( unit
);
327 valerie_error_code
miracle_unit_move( miracle_unit unit
, int src
, int dest
)
329 mlt_properties properties
= unit
->properties
;
330 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
331 mlt_playlist_move( playlist
, src
, dest
);
332 miracle_log( LOG_DEBUG
, "moved clip %d to %d", src
, dest
);
333 update_generation( unit
);
334 miracle_unit_status_communicate( unit
);
338 /** Add a clip to the unit play list.
341 \param unit A miracle_unit handle.
342 \param clip The absolute file name of the clip to load.
343 \param in The starting frame (-1 for 0)
344 \param out The ending frame (-1 for maximum)
347 valerie_error_code
miracle_unit_append( miracle_unit unit
, char *clip
, int64_t in
, int64_t out
)
349 mlt_producer instance
= locate_producer( unit
, clip
);
351 if ( instance
!= NULL
)
353 mlt_properties properties
= unit
->properties
;
354 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
355 mlt_playlist_append_io( playlist
, instance
, in
, out
);
356 miracle_log( LOG_DEBUG
, "appended clip %s", clip
);
357 update_generation( unit
);
358 miracle_unit_status_communicate( unit
);
362 return valerie_invalid_file
;
365 /** Start playing the unit.
368 \param unit A miracle_unit handle.
369 \param speed An integer that specifies the playback rate as a
370 percentage multiplied by 100.
373 void miracle_unit_play( miracle_unit_t
*unit
, int speed
)
375 mlt_properties properties
= unit
->properties
;
376 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
377 mlt_producer producer
= mlt_playlist_producer( playlist
);
378 mlt_consumer consumer
= mlt_properties_get_data( unit
->properties
, "consumer", NULL
);
379 mlt_producer_set_speed( producer
, ( double )speed
/ 1000 );
380 mlt_consumer_start( consumer
);
381 miracle_unit_status_communicate( unit
);
386 Terminates the dv_pump and halts dv1394 transmission.
388 \param unit A miracle_unit handle.
391 void miracle_unit_terminate( miracle_unit unit
)
393 mlt_consumer consumer
= mlt_properties_get_data( unit
->properties
, "consumer", NULL
);
394 mlt_consumer_stop( consumer
);
395 miracle_unit_status_communicate( unit
);
398 /** Query the status of unit playback.
400 \param unit A miracle_unit handle.
401 \return 1 if the unit is not playing, 0 if playing.
404 int miracle_unit_has_terminated( miracle_unit unit
)
406 mlt_consumer consumer
= mlt_properties_get_data( unit
->properties
, "consumer", NULL
);
407 return mlt_consumer_is_stopped( consumer
);
410 /** Transfer the currently loaded clip to another unit
413 int miracle_unit_transfer( miracle_unit dest_unit
, miracle_unit src_unit
)
416 mlt_properties dest_properties
= dest_unit
->properties
;
417 mlt_playlist dest_playlist
= mlt_properties_get_data( dest_properties
, "playlist", NULL
);
418 mlt_properties src_properties
= src_unit
->properties
;
419 mlt_playlist src_playlist
= mlt_properties_get_data( src_properties
, "playlist", NULL
);
421 for ( i
= 0; i
< mlt_playlist_count( src_playlist
); i
++ )
423 mlt_playlist_clip_info info
;
424 mlt_playlist_get_clip_info( src_playlist
, &info
, i
);
425 mlt_producer producer
= locate_producer( dest_unit
, info
.resource
);
426 if ( producer
!= NULL
)
428 mlt_playlist_append_io( dest_playlist
, producer
, info
.frame_in
, info
.frame_out
);
431 miracle_unit_change_position( dest_unit
, mlt_playlist_count( dest_playlist
) - 1, 0 );
432 clean_unit( dest_unit
);
440 /** Determine if unit is offline.
443 int miracle_unit_is_offline( miracle_unit unit
)
448 /** Obtain the status for a given unit
451 int miracle_unit_get_status( miracle_unit unit
, valerie_status status
)
453 int error
= unit
== NULL
;
455 memset( status
, 0, sizeof( valerie_status_t
) );
459 mlt_properties properties
= unit
->properties
;
460 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
461 mlt_producer producer
= mlt_playlist_producer( playlist
);
462 mlt_producer clip
= mlt_playlist_current( playlist
);
464 mlt_playlist_clip_info info
;
465 int clip_index
= mlt_playlist_current_clip( playlist
);
466 mlt_playlist_get_clip_info( playlist
, &info
, clip_index
);
468 if ( info
.resource
!= NULL
&& strcmp( info
.resource
, "" ) )
470 strncpy( status
->clip
, strip_root( unit
, info
.resource
), sizeof( status
->clip
) );
471 status
->speed
= (int)( mlt_producer_get_speed( producer
) * 1000.0 );
472 status
->fps
= mlt_producer_get_fps( producer
);
473 status
->in
= info
.frame_in
;
474 status
->out
= info
.frame_out
;
475 status
->position
= mlt_producer_position( clip
);
476 status
->length
= mlt_producer_get_length( clip
);
477 strncpy( status
->tail_clip
, strip_root( unit
, info
.resource
), sizeof( status
->tail_clip
) );
478 status
->tail_in
= info
.frame_in
;
479 status
->tail_out
= info
.frame_out
;
480 status
->tail_position
= mlt_producer_position( clip
);
481 status
->tail_length
= mlt_producer_get_length( clip
);
482 status
->clip_index
= mlt_playlist_current_clip( playlist
);
483 status
->seek_flag
= 1;
486 status
->generation
= mlt_properties_get_int( properties
, "generation" );
488 if ( miracle_unit_has_terminated( unit
) )
489 status
->status
= unit_stopped
;
490 else if ( !strcmp( status
->clip
, "" ) )
491 status
->status
= unit_not_loaded
;
492 else if ( status
->speed
== 0 )
493 status
->status
= unit_paused
;
495 status
->status
= unit_playing
;
499 status
->status
= unit_undefined
;
502 status
->unit
= mlt_properties_get_int( unit
->properties
, "unit" );
507 /** Change position in the playlist.
510 void miracle_unit_change_position( miracle_unit unit
, int clip
, int64_t position
)
512 mlt_properties properties
= unit
->properties
;
513 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
514 mlt_producer producer
= mlt_playlist_producer( playlist
);
515 mlt_playlist_clip_info info
;
522 else if ( clip
>= mlt_playlist_count( playlist
) )
524 clip
= mlt_playlist_count( playlist
) - 1;
528 if ( mlt_playlist_get_clip_info( playlist
, &info
, clip
) == 0 )
530 int64_t frame_start
= info
.start
;
531 int64_t frame_offset
= position
;
533 if ( frame_offset
< 0 )
534 frame_offset
= info
.frame_out
;
535 if ( frame_offset
< info
.frame_in
)
536 frame_offset
= info
.frame_in
;
537 if ( frame_offset
>= info
.frame_out
)
538 frame_offset
= info
.frame_out
;
540 mlt_producer_seek( producer
, frame_start
+ frame_offset
- info
.frame_in
);
543 miracle_unit_status_communicate( unit
);
546 /** Get the index of the current clip.
549 int miracle_unit_get_current_clip( miracle_unit unit
)
551 mlt_properties properties
= unit
->properties
;
552 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
553 int clip_index
= mlt_playlist_current_clip( playlist
);
557 /** Set a clip's in point
560 int miracle_unit_set_clip_in( miracle_unit unit
, int index
, int64_t position
)
562 mlt_properties properties
= unit
->properties
;
563 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
564 mlt_playlist_clip_info info
;
565 int error
= mlt_playlist_get_clip_info( playlist
, &info
, index
);
569 miracle_unit_play( unit
, 0 );
570 error
= mlt_playlist_resize_clip( playlist
, index
, position
, info
.frame_out
);
571 update_generation( unit
);
572 miracle_unit_change_position( unit
, index
, 0 );
578 /** Set a clip's out point.
581 int miracle_unit_set_clip_out( miracle_unit unit
, int index
, int64_t position
)
583 mlt_properties properties
= unit
->properties
;
584 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
585 mlt_playlist_clip_info info
;
586 int error
= mlt_playlist_get_clip_info( playlist
, &info
, index
);
590 miracle_unit_play( unit
, 0 );
591 error
= mlt_playlist_resize_clip( playlist
, index
, info
.frame_in
, position
);
592 update_generation( unit
);
593 miracle_unit_status_communicate( unit
);
594 miracle_unit_change_position( unit
, index
, -1 );
600 /** Step by specified position.
603 void miracle_unit_step( miracle_unit unit
, int64_t offset
)
605 mlt_properties properties
= unit
->properties
;
606 mlt_playlist playlist
= mlt_properties_get_data( properties
, "playlist", NULL
);
607 mlt_producer producer
= mlt_playlist_producer( playlist
);
608 mlt_position position
= mlt_producer_frame( producer
);
609 mlt_producer_seek( producer
, position
+ offset
);
612 /** Set the unit's clip mode regarding in and out points.
615 //void miracle_unit_set_mode( miracle_unit unit, dv_player_clip_mode mode )
617 //dv_player player = miracle_unit_get_dv_player( unit );
618 //if ( player != NULL )
619 //dv_player_set_clip_mode( player, mode );
620 //miracle_unit_status_communicate( unit );
623 /** Get the unit's clip mode regarding in and out points.
626 //dv_player_clip_mode miracle_unit_get_mode( miracle_unit unit )
628 //dv_player player = miracle_unit_get_dv_player( unit );
629 //return dv_player_get_clip_mode( player );
632 /** Set the unit's clip mode regarding eof handling.
635 //void miracle_unit_set_eof_action( miracle_unit unit, dv_player_eof_action action )
637 //dv_player player = miracle_unit_get_dv_player( unit );
638 //dv_player_set_eof_action( player, action );
639 //miracle_unit_status_communicate( unit );
642 /** Get the unit's clip mode regarding eof handling.
645 //dv_player_eof_action miracle_unit_get_eof_action( miracle_unit unit )
647 //dv_player player = miracle_unit_get_dv_player( unit );
648 //return dv_player_get_eof_action( player );
651 int miracle_unit_set( miracle_unit unit
, char *name_value
)
653 mlt_properties properties
= NULL
;
655 if ( strncmp( name_value
, "consumer.", 9 ) )
657 mlt_playlist playlist
= mlt_properties_get_data( unit
->properties
, "playlist", NULL
);
658 properties
= mlt_playlist_properties( playlist
);
662 mlt_consumer consumer
= mlt_properties_get_data( unit
->properties
, "consumer", NULL
);
663 properties
= mlt_consumer_properties( consumer
);
667 return mlt_properties_parse( properties
, name_value
);
670 char *miracle_unit_get( miracle_unit unit
, char *name
)
672 mlt_playlist playlist
= mlt_properties_get_data( unit
->properties
, "playlist", NULL
);
673 mlt_properties properties
= mlt_playlist_properties( playlist
);
674 return mlt_properties_get( properties
, name
);
680 \param unit A miracle_unit handle.
683 void miracle_unit_close( miracle_unit unit
)
687 miracle_log( LOG_DEBUG
, "closing unit..." );
688 if ( unit
->old_producers
!= NULL
)
689 mlt_properties_close( unit
->old_producers
);
690 mlt_properties_close( unit
->properties
);
691 mlt_properties_close( unit
->producers
);
693 miracle_log( LOG_DEBUG
, "... unit closed." );