git.sesse.net Git - mlt/blob - src/framework/mlt_producer.h

   1 /*
   2  * mlt_producer.h -- abstraction for all producer services
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Charles Yates <charles.yates@pandora.be>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef _MLT_PRODUCER_H_
  22 #define _MLT_PRODUCER_H_
  23
  24 #include "mlt_service.h"
  25 #include "mlt_filter.h"
  26
  27 /** The interface definition for all producers.
  28 */
  29
  30 struct mlt_producer_s
  31 {
  32         /* We're implementing service here */
  33         struct mlt_service_s parent;
  34
  35         /* Public virtual methods */
  36         int ( *get_frame )( mlt_producer, mlt_frame_ptr, int );
  37         mlt_destructor close;
  38         void *close_object;
  39
  40         /* Private data */
  41         void *local;
  42         void *child;
  43 };
  44
  45 /** Public final methods
  46 */
  47
  48 #define MLT_PRODUCER_SERVICE( producer )        ( &( producer )->parent )
  49 #define MLT_PRODUCER_PROPERTIES( producer )     MLT_SERVICE_PROPERTIES( MLT_PRODUCER_SERVICE( producer ) )
  50
  51 extern int mlt_producer_init( mlt_producer self, void *child );
  52 extern mlt_producer mlt_producer_new( );
  53 extern mlt_service mlt_producer_service( mlt_producer self );
  54 extern mlt_properties mlt_producer_properties( mlt_producer self );
  55 extern int mlt_producer_seek( mlt_producer self, mlt_position position );
  56 extern mlt_position mlt_producer_position( mlt_producer self );
  57 extern mlt_position mlt_producer_frame( mlt_producer self );
  58 extern int mlt_producer_set_speed( mlt_producer self, double speed );
  59 extern double mlt_producer_get_speed( mlt_producer self );
  60 extern double mlt_producer_get_fps( mlt_producer self );
  61 extern int mlt_producer_set_in_and_out( mlt_producer self, mlt_position in, mlt_position out );
  62 extern int mlt_producer_clear( mlt_producer self );
  63 extern mlt_position mlt_producer_get_in( mlt_producer self );
  64 extern mlt_position mlt_producer_get_out( mlt_producer self );
  65 extern mlt_position mlt_producer_get_playtime( mlt_producer self );
  66 extern mlt_position mlt_producer_get_length( mlt_producer self );
  67 extern void mlt_producer_prepare_next( mlt_producer self );
  68 extern int mlt_producer_attach( mlt_producer self, mlt_filter filter );
  69 extern int mlt_producer_detach( mlt_producer self, mlt_filter filter );
  70 extern mlt_filter mlt_producer_filter( mlt_producer self, int index );
  71 extern mlt_producer mlt_producer_cut( mlt_producer self, int in, int out );
  72 extern int mlt_producer_is_cut( mlt_producer self );
  73 extern int mlt_producer_is_mix( mlt_producer self );
  74 extern int mlt_producer_is_blank( mlt_producer self );
  75 extern mlt_producer mlt_producer_cut_parent( mlt_producer self );
  76 extern int mlt_producer_optimise( mlt_producer self );
  77 extern void mlt_producer_close( mlt_producer self );
  78
  79 #endif