1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
2 /*
3  * Libbrasero-burn
4  * Copyright (C) Philippe Rouquier 2005-2009 <bonfire-app@wanadoo.fr>
5  *
6  * Libbrasero-burn 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  * The Libbrasero-burn authors hereby grant permission for non-GPL compatible
12  * GStreamer plugins to be used and distributed together with GStreamer
13  * and Libbrasero-burn. This permission is above and beyond the permissions granted
14  * by the GPL license by which Libbrasero-burn is covered. If you modify this code
15  * you may extend this exception to your version of the code, but you are not
16  * obligated to do so. If you do not wish to do so, delete this exception
17  * statement from your version.
18  *
19  * Libbrasero-burn is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU Library General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to:
26  * 	The Free Software Foundation, Inc.,
27  * 	51 Franklin Street, Fifth Floor
28  * 	Boston, MA  02110-1301, USA.
29  */
30 
31 #ifndef _BURN_PLUGIN_H_
32 #define _BURN_PLUGIN_H_
33 
34 #include <glib.h>
35 #include <glib-object.h>
36 #include <gmodule.h>
37 
38 G_BEGIN_DECLS
39 
40 #define BRASERO_TYPE_PLUGIN             (brasero_plugin_get_type ())
41 #define BRASERO_PLUGIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), BRASERO_TYPE_PLUGIN, BraseroPlugin))
42 #define BRASERO_PLUGIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), BRASERO_TYPE_PLUGIN, BraseroPluginClass))
43 #define BRASERO_IS_PLUGIN(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), BRASERO_TYPE_PLUGIN))
44 #define BRASERO_IS_PLUGIN_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), BRASERO_TYPE_PLUGIN))
45 #define BRASERO_PLUGIN_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), BRASERO_TYPE_PLUGIN, BraseroPluginClass))
46 
47 typedef struct _BraseroPluginClass BraseroPluginClass;
48 typedef struct _BraseroPlugin BraseroPlugin;
49 
50 struct _BraseroPluginClass {
51 	GTypeModuleClass parent_class;
52 
53 	/* Signals */
54 	void	(* loaded)	(BraseroPlugin *plugin);
55 	void	(* activated)	(BraseroPlugin *plugin,
56 			                  gboolean active);
57 };
58 
59 struct _BraseroPlugin {
60 	GTypeModule parent_instance;
61 };
62 
63 GType brasero_plugin_get_type (void) G_GNUC_CONST;
64 
65 GType
66 brasero_plugin_get_gtype (BraseroPlugin *self);
67 
68 /**
69  * Plugin configure options
70  */
71 
72 typedef struct _BraseroPluginConfOption BraseroPluginConfOption;
73 typedef enum {
74 	BRASERO_PLUGIN_OPTION_NONE	= 0,
75 	BRASERO_PLUGIN_OPTION_BOOL,
76 	BRASERO_PLUGIN_OPTION_INT,
77 	BRASERO_PLUGIN_OPTION_STRING,
78 	BRASERO_PLUGIN_OPTION_CHOICE
79 } BraseroPluginConfOptionType;
80 
81 typedef enum {
82 	BRASERO_PLUGIN_RUN_NEVER		= 0,
83 
84 	/* pre-process initial track */
85 	BRASERO_PLUGIN_RUN_PREPROCESSING	= 1,
86 
87 	/* run before final image/disc is created */
88 	BRASERO_PLUGIN_RUN_BEFORE_TARGET	= 1 << 1,
89 
90 	/* run after final image/disc is created: post-processing */
91 	BRASERO_PLUGIN_RUN_AFTER_TARGET		= 1 << 2,
92 } BraseroPluginProcessFlag;
93 
94 G_END_DECLS
95 
96 #endif /* _BURN_PLUGIN_H_ */
97