summaryrefslogtreecommitdiff
path: root/libgupnp-dlna/metadata/gupnp-dlna-metadata-extractor.h
blob: 610d28d8917d051830823a96a2c34af58715a53f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
 * Copyright (C) 2010 Nokia Corporation.
 * Copyright (C) 2012 Intel Corporation.
 *
 * Authors: Arun Raghavan <arun.raghavan@collabora.co.uk>
 *          Krzesimir Nowak <krnowak@openismus.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __GUPNP_DLNA_METADATA_EXTRACTOR_H__
#define __GUPNP_DLNA_METADATA_EXTRACTOR_H__

#include <glib-object.h>
#include <libgupnp-dlna/gupnp-dlna-information.h>

G_BEGIN_DECLS

#define GUPNP_TYPE_DLNA_METADATA_EXTRACTOR \
        (gupnp_dlna_metadata_extractor_get_type())

#define GUPNP_DLNA_METADATA_EXTRACTOR(obj) \
        (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
                                     GUPNP_TYPE_DLNA_METADATA_EXTRACTOR, \
                                     GUPnPDLNAMetadataExtractor))

#define GUPNP_DLNA_METADATA_EXTRACTOR_CLASS(klass) \
        (G_TYPE_CHECK_CLASS_CAST ((klass), \
                                  GUPNP_TYPE_DLNA_METADATA_EXTRACTOR, \
                                  GUPnPDLNAMetadataExtractorClass))

#define GUPNP_IS_DLNA_METADATA_EXTRACTOR(obj) \
        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
                                     GUPNP_TYPE_DLNA_METADATA_EXTRACTOR))

#define GUPNP_IS_DLNA_METADATA_EXTRACTOR_CLASS(klass) \
        (G_TYPE_CHECK_CLASS_TYPE ((klass), \
                                  GUPNP_TYPE_DLNA_METADATA_EXTRACTOR))

#define GUPNP_DLNA_METADATA_EXTRACTOR_GET_CLASS(obj) \
        (G_TYPE_INSTANCE_GET_CLASS ((obj), \
                                    GUPNP_TYPE_DLNA_METADATA_EXTRACTOR, \
                                    GUPnPDLNAMetadataExtractorClass))

typedef struct _GUPnPDLNAMetadataExtractorPrivate
                GUPnPDLNAMetadataExtractorPrivate;

/**
 * GUPnPDLNAMetadataExtractor:
 *
 * The top-level object used to for metadata extraction.
 */
typedef struct {
        GObject parent;

        GUPnPDLNAMetadataExtractorPrivate *priv;
} GUPnPDLNAMetadataExtractor;

/**
 * GUPnPDLNAMetadataExtractorClass:
 * @parent_class: Parent class.
 * @extract_async: This is called by #GUPnPDLNAProfileGuesser to get a
 * information about media file asynchronously.
 * @extract_sync: This is called by #GUPnPDLNAProfileGuesser to get a
 * information about media file synchronously.
 * @_reserved: Padding. Ignore it.
 */
typedef struct {
        GObjectClass parent_class;

        /* virtuals */
        gboolean
        (* extract_async) (GUPnPDLNAMetadataExtractor  *extractor,
                           const gchar                 *uri,
                           guint                        timeout_in_ms,
                           GError                     **error);

        GUPnPDLNAInformation *
        (* extract_sync) (GUPnPDLNAMetadataExtractor  *extractor,
                          const gchar                 *uri,
                          guint                        timeout_in_ms,
                          GError                     **error);

        gpointer _reserved[12];
} GUPnPDLNAMetadataExtractorClass;

GType
gupnp_dlna_metadata_extractor_get_type (void);

gboolean
gupnp_dlna_metadata_extractor_extract_async
                                    (GUPnPDLNAMetadataExtractor  *extractor,
                                     const gchar                 *uri,
                                     guint                        timeout_in_ms,
                                     GError                     **error);

GUPnPDLNAInformation *
gupnp_dlna_metadata_extractor_extract_sync
                                    (GUPnPDLNAMetadataExtractor  *extractor,
                                     const gchar                 *uri,
                                     guint                        timeout_in_ms,
                                     GError                     **error);

void
gupnp_dlna_metadata_extractor_emit_done (GUPnPDLNAMetadataExtractor *extractor,
                                         GUPnPDLNAInformation       *info,
                                         GError                     *error);

G_END_DECLS

#endif /* __GUPNP_DLNA_METADATA_EXTRACTOR_H__ */