Big modification - switch to macros for parent class access
[melted] / src / modules / core / filter_data_feed.c
1 /*
2 * filter_data_feed.c -- data feed filter
3 * Copyright (C) 2004-2005 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 #include <stdlib.h>
22 #include <string.h>
23 #include "filter_data.h"
24 #include <framework/mlt.h>
25
26 /** This filter should be used in conjuction with the data_show filter.
27 The concept of the data_feed is that it can be used to pass titles
28 or images to render on the frame, but doesn't actually do it
29 itself. data_feed imposes few rules on what's passed on and the
30 validity is confirmed in data_show before use.
31 */
32
33 /** Data queue destructor.
34 */
35
36 static void destroy_data_queue( void *arg )
37 {
38 if ( arg != NULL )
39 {
40 // Assign the correct type
41 mlt_deque queue = arg;
42
43 // Iterate through each item and destroy them
44 while ( mlt_deque_peek_front( queue ) != NULL )
45 mlt_properties_close( mlt_deque_pop_back( queue ) );
46
47 // Close the deque
48 mlt_deque_close( queue );
49 }
50 }
51
52 /** Filter processing.
53 */
54
55 static mlt_frame filter_process( mlt_filter this, mlt_frame frame )
56 {
57 // Get the filter properties
58 mlt_properties filter_properties = MLT_FILTER_PROPERTIES( this );
59
60 // Get the frame properties
61 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
62
63 // Get the data queue
64 mlt_deque data_queue = mlt_properties_get_data( frame_properties, "data_queue", NULL );
65
66 // Get the type of the data feed
67 char *type = mlt_properties_get( filter_properties, "type" );
68
69 // Get the in and out points of this filter
70 int in = mlt_filter_get_in( this );
71 int out = mlt_filter_get_out( this );
72
73 // Create the data queue if it doesn't exist
74 if ( data_queue == NULL )
75 {
76 // Create the queue
77 data_queue = mlt_deque_init( );
78
79 // Assign it to the frame with the destructor
80 mlt_properties_set_data( frame_properties, "data_queue", data_queue, 0, destroy_data_queue, NULL );
81 }
82
83 // Now create the data feed
84 if ( data_queue != NULL && type != NULL && !strcmp( type, "attr_check" ) )
85 {
86 int i = 0;
87 int count = mlt_properties_count( frame_properties );
88 char inactive[ 512 ];
89
90 for ( i = 0; i < count; i ++ )
91 {
92 char *name = mlt_properties_get_name( frame_properties, i );
93 if ( !strncmp( name, "meta.attr.", 10 ) && strstr( name, ".inactive" ) == NULL )
94 {
95 char *value = mlt_properties_get( frame_properties, name );
96 sprintf( inactive, "%s.inactive", name );
97 if ( value != NULL && mlt_properties_get_int( frame_properties, inactive ) == 0 )
98 {
99 // Create a new data feed
100 mlt_properties feed = mlt_properties_new( );
101
102 // Assign it the base properties
103 mlt_properties_set( feed, "id", mlt_properties_get( filter_properties, "_unique_id" ) );
104 mlt_properties_set( feed, "type", strrchr( name, '.' ) + 1 );
105 mlt_properties_set_position( feed, "position", mlt_frame_get_position( frame ) );
106
107 // Assign in/out of service we're connected to
108 mlt_properties_set_position( feed, "in", mlt_properties_get_position( frame_properties, "in" ) );
109 mlt_properties_set_position( feed, "out", mlt_properties_get_position( frame_properties, "out" ) );
110
111 // Assign the value to the feed
112 mlt_properties_set( feed, "markup", value );
113
114 // Push it on to the queue
115 mlt_deque_push_back( data_queue, feed );
116 }
117 }
118 }
119 }
120 else if ( data_queue != NULL )
121 {
122 // Create a new data feed
123 mlt_properties feed = mlt_properties_new( );
124
125 // Assign it the base properties
126 mlt_properties_set( feed, "id", mlt_properties_get( filter_properties, "_unique_id" ) );
127 mlt_properties_set( feed, "type", type );
128 mlt_properties_set_position( feed, "position", mlt_frame_get_position( frame ) );
129
130 // Assign in/out of service we're connected to
131 mlt_properties_set_position( feed, "in", mlt_properties_get_position( frame_properties, "in" ) );
132 mlt_properties_set_position( feed, "out", mlt_properties_get_position( frame_properties, "out" ) );
133
134 // Correct in/out to the filter if specified
135 if ( in != 0 )
136 mlt_properties_set_position( feed, "in", in );
137 if ( out != 0 )
138 mlt_properties_set_position( feed, "out", out );
139
140 // Pass the properties which start with a "feed." prefix
141 // Note that 'feed.text' in the filter properties becomes 'text' on the feed
142 mlt_properties_pass( feed, filter_properties, "feed." );
143
144 // Push it on to the queue
145 mlt_deque_push_back( data_queue, feed );
146 }
147
148 return frame;
149 }
150
151 /** Constructor for the filter.
152 */
153
154 mlt_filter filter_data_feed_init( char *arg )
155 {
156 // Create the filter
157 mlt_filter this = mlt_filter_new( );
158
159 // Initialise it
160 if ( this != NULL )
161 {
162 // Get the properties
163 mlt_properties properties = MLT_FILTER_PROPERTIES( this );
164
165 // Assign the argument (default to titles)
166 mlt_properties_set( properties, "type", arg == NULL ? "titles" : arg );
167
168 // Specify the processing method
169 this->process = filter_process;
170 }
171
172 return this;
173 }
174