/usr/include/gmerlin/tree.h is in libgmerlin-dev 1.2.0~dfsg+1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 | /*****************************************************************
* gmerlin - a general purpose multimedia framework and applications
*
* Copyright (c) 2001 - 2011 Members of the Gmerlin project
* gmerlin-general@lists.sourceforge.net
* http://gmerlin.sourceforge.net
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* *****************************************************************/
#ifndef __BG_TREE_H_
#define __BG_TREE_H_
#include <wchar.h> /* wchar_t */
#include <gmerlin/pluginregistry.h>
/* Entry flags */
/* Flags should not be changed */
#define BG_ALBUM_ENTRY_ERROR (1<<0)
#define BG_ALBUM_ENTRY_SELECTED (1<<1)
#define BG_ALBUM_ENTRY_REDIRECTOR (1<<3)
#define BG_ALBUM_ENTRY_SAVE_AUTH (1<<4)
#define BG_ALBUM_ENTRY_EDL (1<<5)
#define BG_ALBUM_ENTRY_SYNC (1<<6) /* Used only internally */
/*
* Shuffle mode passed to bg_media_tree_next() and
* bg_media_tree_previous()
*/
typedef enum
{
BG_SHUFFLE_MODE_OFF = 0,
BG_SHUFFLE_MODE_CURRENT = 1,
BG_SHUFFLE_MODE_ALL = 2,
BG_NUM_SHUFFLE_MODES = 3,
} bg_shuffle_mode_t;
typedef struct bg_album_entry_s
{
char * name;
void * location;
char * plugin;
gavl_time_t duration;
int num_audio_streams;
int num_video_streams;
/* Need to distinguish between
normal and still streams here, because they get different
icons in the widget */
int num_still_streams;
int num_subtitle_streams;
/*
* Track index for multi track files/plugins
*/
int index;
int total_tracks;
/* Authentication data */
char * username;
char * password;
int flags;
struct bg_album_entry_s * next;
wchar_t * name_w;
int len_w;
time_t mtime;
} bg_album_entry_t;
typedef struct bg_album_s bg_album_t;
typedef struct bg_mediatree_s bg_media_tree_t;
typedef enum
{
/* Regular album */
BG_ALBUM_TYPE_REGULAR = 0,
/* Drive for removable media */
BG_ALBUM_TYPE_REMOVABLE = 1,
/* Hardware plugin (Subalbums are devices) */
BG_ALBUM_TYPE_PLUGIN = 2,
/* Incoming album: Stuff from the commandline and the remote will go there */
BG_ALBUM_TYPE_INCOMING = 3,
/* Favourites */
BG_ALBUM_TYPE_FAVOURITES = 4,
/* Tuner */
BG_ALBUM_TYPE_TUNER = 5,
} bg_album_type_t;
bg_album_type_t bg_album_get_type(bg_album_t *);
/* Can return 0 if CD is missing or so */
int bg_album_open(bg_album_t *);
void bg_album_close(bg_album_t *);
/* Call after open() */
const char * bg_album_get_disc_name(bg_album_t*);
int bg_album_can_eject(bg_album_t*);
void bg_album_eject(bg_album_t*);
void bg_album_select_error_tracks(bg_album_t*);
void bg_album_get_times(bg_album_t * a,
gavl_time_t * duration_before,
gavl_time_t * duration_current,
gavl_time_t * duration_after);
int bg_album_get_num_entries(bg_album_t*);
bg_album_entry_t * bg_album_get_entry(bg_album_t*, int);
int bg_album_get_index(bg_album_t*, const bg_album_entry_t * entry);
void bg_album_set_change_callback(bg_album_t * a,
void (*change_callback)(bg_album_t * a,
void * data),
void * change_callback_data);
void bg_album_set_entry_change_callback(bg_album_t * a,
void (*change_callback)(bg_album_t * a,
const bg_album_entry_t * e,
void * data),
void * change_callback_data);
void bg_album_set_name_change_callback(bg_album_t * a,
void (*name_change_callback)(bg_album_t * a,
const char * name,
void * data),
void * name_change_callback_data);
void bg_album_set_current_change_callback(bg_album_t * a,
void (*change_callback)(bg_album_t * a,
const bg_album_entry_t * e,
void * data),
void * change_callback_data);
void bg_album_set_delete_callback(bg_album_t * a,
void (*delete_callback)(bg_album_t * current_album,
int * indices, void * data),
void * delete_callback_data);
void bg_album_set_insert_callback(bg_album_t * a,
void (*insert_callback)(bg_album_t * current_album,
int start, int num, void * data),
void * insert_callback_data);
void bg_album_move_selected_to_favourites(bg_album_t * a);
void bg_album_copy_selected_to_favourites(bg_album_t * a);
bg_edl_t * bg_album_selected_to_edl(bg_album_t * a);
/* Return the current entry (might be NULL) */
bg_album_entry_t * bg_album_get_current_entry(bg_album_t*);
gavl_time_t bg_album_get_duration(bg_album_t*);
int bg_album_next(bg_album_t*, int wrap);
int bg_album_previous(bg_album_t*, int wrap);
void bg_album_set_current(bg_album_t * a, const bg_album_entry_t * e);
int bg_album_is_current(bg_album_t*);
int bg_album_entry_is_current(bg_album_t*, bg_album_entry_t*);
int bg_album_get_num_children(bg_album_t *);
bg_album_t * bg_album_get_child(bg_album_t *, int);
char * bg_album_get_name(bg_album_t * a);
/* This returns the disc name or the album name */
char * bg_album_get_label(bg_album_t * a);
void bg_album_set_error(bg_album_t * a, int err);
int bg_album_get_error(bg_album_t * a);
void bg_album_rename(bg_album_t * a, const char *);
void bg_album_append_child(bg_album_t * parent, bg_album_t * child);
void bg_album_select_entry(bg_album_t * a, int entry);
void bg_album_unselect_entry(bg_album_t * a, int entry);
void bg_album_select_entries(bg_album_t * a, int start, int num);
void bg_album_toggle_select_entry(bg_album_t * a, int entry);
void bg_album_unselect_all(bg_album_t * a);
int bg_album_num_selected(bg_album_t * a);
int bg_album_entry_is_selected(bg_album_t * a, int entry);
/* Seek support */
typedef struct bg_album_seek_data_s bg_album_seek_data_t;
bg_album_seek_data_t * bg_album_seek_data_create();
int bg_album_seek_data_changed(bg_album_seek_data_t*);
void bg_album_seek_data_set_string(bg_album_seek_data_t *, const char * str);
void bg_album_seek_data_ignore_case(bg_album_seek_data_t *, int ignore);
void bg_album_seek_data_exact_string(bg_album_seek_data_t *, int exact);
bg_album_entry_t * bg_album_seek_entry_after(bg_album_t * a,
bg_album_entry_t * e,
bg_album_seek_data_t*);
bg_album_entry_t * bg_album_seek_entry_before(bg_album_t * a,
bg_album_entry_t * e,
bg_album_seek_data_t*);
void bg_album_seek_data_destroy(bg_album_seek_data_t *);
/*
* Mark an album as expanded i.e. itself and all the
* children are visible
*/
void bg_album_set_expanded(bg_album_t * a, int expanded);
int bg_album_get_expanded(bg_album_t * a);
int bg_album_is_open(bg_album_t * a);
/* Add items */
void bg_album_insert_urls_before(bg_album_t * a,
char ** urls,
const char * plugin,
int prefer_edl,
bg_album_entry_t * after);
void bg_album_insert_urls_after(bg_album_t * a,
char ** urls,
const char * plugin,
int prefer_edl,
bg_album_entry_t * before);
/* Inserts an xml-string */
void bg_album_insert_xml_before(bg_album_t * a, const char * xml_string,
bg_album_entry_t * after);
void bg_album_insert_xml_after(bg_album_t * a, const char * xml_string,
bg_album_entry_t * before);
/* Load an xml string and make album entries from it */
bg_album_entry_t *
bg_album_entries_new_from_xml(const char * xml_string);
bg_album_entry_t *
bg_album_entry_create_from_track_info(bg_track_info_t * track_info,
const char * url);
/* Destroy the list returned from the function above */
void bg_album_entries_destroy(bg_album_entry_t*);
/* Check, how many they are */
int bg_album_entries_count(bg_album_entry_t*);
/* Inserts a string of the type text/uri-list into the album */
void bg_album_insert_urilist_after(bg_album_t * a, const char * xml_string,
int length, bg_album_entry_t * before);
void bg_album_insert_urilist_before(bg_album_t * a, const char * xml_string,
int length, bg_album_entry_t * after);
/*
* Play the current track. This works only, if a tree exists and
* has a play callback set
*/
void bg_album_play(bg_album_t * a);
/* Get the config section */
bg_cfg_section_t * bg_album_get_cfg_section(bg_album_t * album);
bg_plugin_registry_t * bg_album_get_plugin_registry(bg_album_t * album);
/* album_xml.c */
void bg_album_insert_albums_before(bg_album_t * a,
char ** locations,
bg_album_entry_t * after);
void bg_album_insert_albums_after(bg_album_t * a,
char ** locations,
bg_album_entry_t * after);
void bg_album_save(bg_album_t * a, const char * filename);
/* Export to playlist formats */
int
bg_album_entries_save_extm3u(bg_album_entry_t * e, const char * name,
int strip_dirs, const char * prefix);
int
bg_album_entries_save_pls(bg_album_entry_t * e, const char * name,
int strip_dirs, const char * prefix);
/* Create a struing containing the xml code for the album */
/* Can be used for Drag & Drop for example */
/* Delete entries */
void bg_album_delete_selected(bg_album_t * album);
/* Refresh entries */
void bg_album_refresh_selected(bg_album_t * album);
/* Move entries */
void bg_album_move_selected_up(bg_album_t * album);
void bg_album_move_selected_down(bg_album_t * album);
void bg_album_sort_entries(bg_album_t * album);
void bg_album_sort_children(bg_album_t * album);
void bg_album_rename_track(bg_album_t * album,
const bg_album_entry_t * entry,
const char * name);
/* Return value should be free()d */
char * bg_album_save_to_memory(bg_album_t * a);
char * bg_album_save_selected_to_memory(bg_album_t * a, int preserve_current);
char * bg_album_selected_to_string(bg_album_t * a);
/*
* tree.c
*/
/* Media tree */
bg_media_tree_t * bg_media_tree_create(const char * filename,
bg_plugin_registry_t * plugin_reg);
/* Call this after the configuration is set up */
void bg_media_tree_init(bg_media_tree_t * ret);
bg_plugin_registry_t *
bg_media_tree_get_plugin_registry(bg_media_tree_t *);
bg_cfg_section_t *
bg_media_tree_get_cfg_section(bg_media_tree_t *);
bg_album_t * bg_media_tree_get_incoming(bg_media_tree_t *);
bg_album_t * bg_media_tree_get_device_album(bg_media_tree_t *,
const char * gml);
void bg_media_tree_check_sync(bg_media_tree_t * t);
void
bg_media_tree_set_change_callback(bg_media_tree_t *,
void (*change_callback)(bg_media_tree_t*,
void*),
void*);
void bg_media_tree_set_userpass_callback(bg_media_tree_t *,
int (*userpass_callback)(const char * resource,
char ** user, char ** pass,
int * save_password,
void * data),
void * userpass_callback_data);
void bg_media_tree_set_play_callback(bg_media_tree_t *,
void (*play_callback)(void*),
void*);
void bg_media_tree_destroy(bg_media_tree_t *);
int bg_media_tree_get_num_albums(bg_media_tree_t *);
bg_album_t * bg_media_tree_get_current_album(bg_media_tree_t *);
void bg_media_tree_add_directory(bg_media_tree_t * t, bg_album_t * parent,
const char * directory,
int recursive,
int subdirs_to_subalbums,
int watch,
const char * plugin,
int prefer_edl);
/* Gets a root album */
bg_album_t * bg_media_tree_get_album(bg_media_tree_t *, int);
void bg_album_set_devices(bg_album_t * a);
void bg_album_find_devices(bg_album_t * a);
void bg_album_add_device(bg_album_t * a,
const char * device,
const char * name);
void bg_album_remove_from_parent(bg_album_t * album);
/*
* Returns an array of indices to the given album
* terminated with -1 and to be freed with free()
*/
int * bg_media_tree_get_path(bg_media_tree_t *, bg_album_t*);
/* Manage the tree */
bg_album_t * bg_media_tree_append_album(bg_media_tree_t *,
bg_album_t * parent);
void bg_media_tree_remove_album(bg_media_tree_t *,
bg_album_t * album);
/* Check if we can move an album */
int bg_media_tree_check_move_album_before(bg_media_tree_t *,
bg_album_t * album,
bg_album_t * after);
int bg_media_tree_check_move_album_after(bg_media_tree_t *,
bg_album_t * album,
bg_album_t * before);
int bg_media_tree_check_move_album(bg_media_tree_t *,
bg_album_t * album,
bg_album_t * parent);
/* Move an album inside the tree */
void bg_media_tree_move_album_before(bg_media_tree_t *,
bg_album_t * album,
bg_album_t * after);
void bg_media_tree_move_album_after(bg_media_tree_t *,
bg_album_t * album,
bg_album_t * before);
void bg_media_tree_move_album(bg_media_tree_t *,
bg_album_t * album,
bg_album_t * parent);
/* tree_xml.c */
void bg_media_tree_load(bg_media_tree_t *);
void bg_media_tree_save(bg_media_tree_t *);
/* Set and get entries for playback */
void bg_media_tree_set_current(void * data,
bg_album_t * album,
const bg_album_entry_t * entry);
/* Get the parent directory of the last added directory */
const char *
bg_media_tree_get_add_directory_path(bg_media_tree_t * t);
void
bg_media_tree_set_add_directory_path(bg_media_tree_t * t, const char *);
/* Set the next and previous track */
int bg_media_tree_next(bg_media_tree_t *, int wrap,
bg_shuffle_mode_t shuffle_mode);
int bg_media_tree_previous(bg_media_tree_t *, int wrap,
bg_shuffle_mode_t shuffle_mode);
bg_plugin_handle_t *
bg_media_tree_get_current_track(bg_media_tree_t *, int * index);
const char * bg_media_tree_get_current_track_name(bg_media_tree_t *);
/* Configuration stuff */
const bg_parameter_info_t * bg_media_tree_get_parameters(bg_media_tree_t*);
void bg_media_tree_set_parameter(void * priv, const char * name,
const bg_parameter_value_t * val);
int
bg_media_tree_get_parameter(void * priv, const char * name,
bg_parameter_value_t * val);
/* Mark the current entry as error */
void bg_media_tree_mark_error(bg_media_tree_t * , int err);
void bg_media_tree_copy_current_to_favourites(bg_media_tree_t * t);
#endif // __BG_TREE_H_
|