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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright (C) 2008, Nokia <ivan.frade@nokia.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.1 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 __LIBMEDIAART_EXTRACT_H__
#define __LIBMEDIAART_EXTRACT_H__
#include <glib.h>
#include <gio/gio.h>
#include "mediaart-macros.h"
#if !defined (__LIBMEDIAART_INSIDE__) && !defined (LIBMEDIAART_COMPILATION)
#error "Only <libmediaart/mediaart.h> must be included directly."
#endif
G_BEGIN_DECLS
/**
* MediaArtType:
* @MEDIA_ART_NONE: No media art is available
* @MEDIA_ART_ALBUM: Media art is an album
* @MEDIA_ART_VIDEO: Media art is a movie or video
*
* This type categorized the type of media art we're dealing with.
*/
typedef enum {
MEDIA_ART_NONE,
MEDIA_ART_ALBUM,
MEDIA_ART_VIDEO,
/*< private >*/
MEDIA_ART_TYPE_COUNT
} MediaArtType;
/**
* MediaArtProcessFlags:
* @MEDIA_ART_PROCESS_FLAGS_NONE: Normal operation.
* @MEDIA_ART_PROCESS_FLAGS_FORCE: Force media art to be re-saved to disk even if it already exists and the related file or URI has the same modified time (mtime).
*
* This type categorized the flags used when processing media art.
*
* Since: 0.3.0
*/
typedef enum {
MEDIA_ART_PROCESS_FLAGS_NONE = 0,
MEDIA_ART_PROCESS_FLAGS_FORCE = 1 << 0,
} MediaArtProcessFlags;
/**
* MediaArtError:
* @MEDIA_ART_ERROR_NO_STORAGE: Storage information is unknown, we
* have no knowledge about removable media.
* @MEDIA_ART_ERROR_NO_TITLE: Title is required, but was not provided,
* or was empty.
* @MEDIA_ART_ERROR_SYMLINK_FAILED: A call to symlink() failed
* resulting in the incorrect storage of media art.
* @MEDIA_ART_ERROR_RENAME_FAILED: File could not be renamed.
* @MEDIA_ART_ERROR_NO_CACHE_DIR: This is given when the
* XDG_CACHE_HOME directory could not be used to create the
* 'media-art' subdirectory used for caching media art. This is
* usually an initiation error.
*
* Enumeration values used in errors returned by the
* #MediaArtError API.
*
* Since: 0.2.0
**/
typedef enum {
MEDIA_ART_ERROR_NO_STORAGE,
MEDIA_ART_ERROR_NO_TITLE,
MEDIA_ART_ERROR_SYMLINK_FAILED,
MEDIA_ART_ERROR_RENAME_FAILED,
MEDIA_ART_ERROR_NO_CACHE_DIR
} MediaArtError;
_LIBMEDIAART_EXTERN
GQuark media_art_error_quark (void) G_GNUC_CONST;
#define MEDIA_ART_TYPE_PROCESS (media_art_process_get_type())
#define MEDIA_ART_PROCESS(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), MEDIA_ART_TYPE_PROCESS, MediaArtProcess))
#define MEDIA_ART_PROCESS_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), MEDIA_ART_TYPE_PROCESS, MediaArtProcessClass))
#define MEDIA_ART_IS_PROCESS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), MEDIA_ART_TYPE_PROCESS))
#define MEDIA_ART_IS_PROCESS_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), MEDIA_ART_TYPE_PROCESS))
#define MEDIA_ART_PROCESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MEDIA_ART_TYPE_PROCESS, MediaArtProcessClass))
typedef struct _MediaArtProcess MediaArtProcess;
typedef struct _MediaArtProcessClass MediaArtProcessClass;
/**
* MediaArtProcess:
*
* A class implementation for processing and extracting media art.
**/
struct _MediaArtProcess {
/*< private >*/
GObject parent;
};
/**
* MediaArtProcessClass:
*
* Prototype for the class.
**/
struct _MediaArtProcessClass {
/*< private >*/
GObjectClass parent;
};
_LIBMEDIAART_EXTERN
GType media_art_process_get_type (void) G_GNUC_CONST;
_LIBMEDIAART_EXTERN
MediaArtProcess *media_art_process_new (GError **error);
_LIBMEDIAART_EXTERN
gboolean media_art_process_uri (MediaArtProcess *process,
MediaArtType type,
MediaArtProcessFlags flags,
const gchar *uri,
const gchar *artist,
const gchar *title,
GCancellable *cancellable,
GError **error);
_LIBMEDIAART_EXTERN
void media_art_process_uri_async (MediaArtProcess *process,
MediaArtType type,
MediaArtProcessFlags flags,
const gchar *uri,
const gchar *artist,
const gchar *title,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
_LIBMEDIAART_EXTERN
gboolean media_art_process_uri_finish (MediaArtProcess *process,
GAsyncResult *result,
GError **error);
_LIBMEDIAART_EXTERN
gboolean media_art_process_file (MediaArtProcess *process,
MediaArtType type,
MediaArtProcessFlags flags,
GFile *file,
const gchar *artist,
const gchar *title,
GCancellable *cancellable,
GError **error);
_LIBMEDIAART_EXTERN
void media_art_process_file_async (MediaArtProcess *process,
MediaArtType type,
MediaArtProcessFlags flags,
GFile *file,
const gchar *artist,
const gchar *title,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
_LIBMEDIAART_EXTERN
gboolean media_art_process_file_finish (MediaArtProcess *process,
GAsyncResult *result,
GError **error);
_LIBMEDIAART_EXTERN
gboolean media_art_process_buffer (MediaArtProcess *process,
MediaArtType type,
MediaArtProcessFlags flags,
GFile *related_file,
const guchar *buffer,
gsize len,
const gchar *mime,
const gchar *artist,
const gchar *title,
GCancellable *cancellable,
GError **error);
_LIBMEDIAART_EXTERN
void media_art_process_buffer_async (MediaArtProcess *process,
MediaArtType type,
MediaArtProcessFlags flags,
GFile *related_file,
const guchar *buffer,
gsize len,
const gchar *mime,
const gchar *artist,
const gchar *title,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
_LIBMEDIAART_EXTERN
gboolean media_art_process_buffer_finish (MediaArtProcess *process,
GAsyncResult *result,
GError **error);
G_END_DECLS
#endif /* __LIBMEDIAART_EXTRACT_H__ */
|
