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

   1 /**
   2  * \file mlt_transition.h
   3  * \brief abstraction for all transition services
   4  *
   5  * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
   6  * \author Charles Yates <charles.yates@pandora.be>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef _MLT_TRANSITION_H_
  24 #define _MLT_TRANSITION_H_
  25
  26 #include "mlt_service.h"
  27
  28 /** \brief Transition abstract service class
  29  *
  30  * A transition may modify the output of a producer based on the output of a second producer.
  31  *
  32  * \extends mlt_service_s
  33  * \properties \em a_track the track index (0-based) of a multitrack of the first producer
  34  * \properties \em b_track the track index (0-based) of a multitrack of the second producer
  35  * \properties \em accepts_blanks a flag to indicate if the transition should accept blank frames
  36  * \properties \em always_active a flag to indicate that the in and out points do not apply
  37  * \properties \em _transition_type 1 for video, 2 for audio
  38  */
  39
  40 struct mlt_transition_s
  41 {
  42         /** We're implementing service here */
  43         struct mlt_service_s parent;
  44
  45         /** public virtual */
  46         void ( *close )( mlt_transition );
  47
  48         /** protected transition method */
  49         mlt_frame ( *process )( mlt_transition, mlt_frame, mlt_frame );
  50
  51         /** Protected */
  52         void *child;
  53
  54         /** track and in/out points */
  55         mlt_service producer;
  56
  57         /** Private */
  58         mlt_frame *frames;
  59         int held;
  60 };
  61
  62 #define MLT_TRANSITION_SERVICE( transition )            ( &( transition )->parent )
  63 #define MLT_TRANSITION_PROPERTIES( transition )         MLT_SERVICE_PROPERTIES( MLT_TRANSITION_SERVICE( transition ) )
  64
  65 extern int mlt_transition_init( mlt_transition self, void *child );
  66 extern mlt_transition mlt_transition_new( );
  67 extern mlt_service mlt_transition_service( mlt_transition self );
  68 extern mlt_properties mlt_transition_properties( mlt_transition self );
  69 extern int mlt_transition_connect( mlt_transition self, mlt_service producer, int a_track, int b_track );
  70 extern void mlt_transition_set_in_and_out( mlt_transition self, mlt_position in, mlt_position out );
  71 extern int mlt_transition_get_a_track( mlt_transition self );
  72 extern int mlt_transition_get_b_track( mlt_transition self );
  73 extern mlt_position mlt_transition_get_in( mlt_transition self );
  74 extern mlt_position mlt_transition_get_out( mlt_transition self );
  75 extern mlt_frame mlt_transition_process( mlt_transition self, mlt_frame a_frame, mlt_frame b_frame );
  76 extern void mlt_transition_close( mlt_transition self );
  77
  78 #endif