#include <sys/types.h>
Include dependency graph for libburn.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
struct | burn_toc_entry |
Information about a track on a disc - this is from the q sub channel of the lead-in area of a disc. More... | |
struct | burn_source |
Data source for tracks. More... | |
struct | burn_drive_info |
Information on a drive in the system. More... | |
struct | burn_progress |
Operation progress report. More... | |
struct | burn_speed_descriptor |
Description of a speed capability as reported by the drive in conjunction with eventually loaded media. More... | |
struct | burn_multi_caps |
The reply structure for burn_disc_get_multi_caps(). More... | |
Defines | |
#define | BURN_CDROM 0 |
Session format for normal audio or data discs. | |
#define | BURN_CDI 0x10 |
Session format for obsolete CD-I discs. | |
#define | BURN_CDXA 0x20 |
Session format for CDROM-XA discs. | |
#define | BURN_POS_END 100 |
#define | BURN_MODE_BITS 127 |
Mask for mode bits. | |
#define | BURN_MODE0 (1 << 0) |
Track mode - mode 0 data 0 bytes of user data. | |
#define | BURN_MODE_RAW (1 << 1) |
Track mode - mode "raw" - all 2352 bytes supplied by app FOR DATA TRACKS ONLY! | |
#define | BURN_MODE1 (1 << 2) |
Track mode - mode 1 data 2048 bytes user data, and all the LEC money can buy. | |
#define | BURN_MODE2 (1 << 3) |
Track mode - mode 2 data defaults to formless, 2336 bytes of user data, unprotected | with a data form if required. | |
#define | BURN_FORM1 (1 << 4) |
Track mode modifier - Form 1, | with MODE2 for reasonable results 2048 bytes of user data, 4 bytes of subheader. | |
#define | BURN_FORM2 (1 << 5) |
Track mode modifier - Form 2, | with MODE2 for reasonable results lots of user data. | |
#define | BURN_AUDIO (1 << 6) |
Track mode - audio 2352 bytes per sector. | |
#define | BURN_4CH (1 << 7) |
Track mode modifier - 4 channel audio. | |
#define | BURN_COPY (1 << 8) |
Track mode modifier - Digital copy permitted, can be set on any track. | |
#define | BURN_PREEMPHASIS (1 << 9) |
Track mode modifier - 50/15uS pre-emphasis. | |
#define | BURN_SUBCODE_P16 (1 << 10) |
Input mode modifier - subcodes present packed 16. | |
#define | BURN_SUBCODE_P96 (1 << 11) |
Input mode modifier - subcodes present packed 96. | |
#define | BURN_SUBCODE_R96 (1 << 12) |
Input mode modifier - subcodes present raw 96. | |
#define | BURN_DRIVE_WHITELIST_LEN 255 |
Maximum number of particularly permissible drive addresses. | |
#define | BURN_DRIVE_ADR_LEN 1024 |
Maximum length+1 to expect with a persistent drive address string. | |
#define | BURN_FORMAT_IS_UNFORMATTED 1 |
Possible formatting status values. | |
#define | BURN_FORMAT_IS_FORMATTED 2 |
#define | BURN_FORMAT_IS_UNKNOWN 3 |
#define | BURN_REASONS_LEN 4096 |
The length of a rejection reasons string for burn_precheck_write() and burn_write_opts_auto_write_type() . | |
#define | Libburn_precheck_write_ruleS 1 |
#define | BURN_MSGS_MESSAGE_LEN 4096 |
Typedefs | |
typedef int(*) | burn_abort_handler_t (void *handle, int signum, int flag) |
Enumerations | |
enum | burn_write_types { BURN_WRITE_PACKET, BURN_WRITE_TAO, BURN_WRITE_SAO, BURN_WRITE_RAW, BURN_WRITE_NONE } |
Possible disc writing style/modes. More... | |
enum | burn_block_types { BURN_BLOCK_RAW0 = 1, BURN_BLOCK_RAW16 = 2, BURN_BLOCK_RAW96P = 4, BURN_BLOCK_RAW96R = 8, BURN_BLOCK_MODE1 = 256, BURN_BLOCK_MODE2R = 512, BURN_BLOCK_MODE2_PATHETIC = 1024, BURN_BLOCK_MODE2_LAME = 2048, BURN_BLOCK_MODE2_OBSCURE = 4096, BURN_BLOCK_MODE2_OK = 8192, BURN_BLOCK_SAO = 16384 } |
Data format to send to the drive. More... | |
enum | burn_disc_status { BURN_DISC_UNREADY, BURN_DISC_BLANK, BURN_DISC_EMPTY, BURN_DISC_APPENDABLE, BURN_DISC_FULL, BURN_DISC_UNGRABBED, BURN_DISC_UNSUITABLE } |
Possible status' of the drive in regard to the disc in it. More... | |
enum | burn_source_status { BURN_SOURCE_OK, BURN_SOURCE_EOF, BURN_SOURCE_FAILED } |
Possible data source return values. More... | |
enum | burn_drive_status { BURN_DRIVE_IDLE, BURN_DRIVE_SPAWNING, BURN_DRIVE_READING, BURN_DRIVE_WRITING, BURN_DRIVE_WRITING_LEADIN, BURN_DRIVE_WRITING_LEADOUT, BURN_DRIVE_ERASING, BURN_DRIVE_GRABBING, BURN_DRIVE_WRITING_PREGAP, BURN_DRIVE_CLOSING_TRACK, BURN_DRIVE_CLOSING_SESSION, BURN_DRIVE_FORMATTING } |
Possible busy states for a drive. More... | |
Functions | |
int | burn_initialize (void) |
Initialize the library. | |
void | burn_finish (void) |
Shutdown the library. | |
int | burn_abort (int patience, int(*pacifier_func)(void *handle, int patience, int elapsed), void *handle) |
Abort any running drive operation and finally call burn_finish(). | |
int | burn_abort_pacifier (void *handle, int patience, int elapsed) |
A pacifier function suitable for burn_abort. | |
void | burn_set_verbosity (int level) |
ts A61006 : This is for development only. | |
void | burn_preset_device_open (int exclusive, int blocking, int abort_on_busy) |
Set parameters for behavior on opening device files. | |
void | burn_allow_untested_profiles (int yes) |
Allows the use of media types which are implemented in libburn but not yet tested. | |
int | burn_drive_scan_and_grab (struct burn_drive_info *drive_infos[], char *adr, int load) |
Aquire a drive with known persistent address.This is the sysadmin friendly way to open one drive and to leave all others untouched. | |
int | burn_drive_add_whitelist (char *device_address) |
Add a device to the list of permissible drives. | |
void | burn_drive_clear_whitelist (void) |
Remove all drives from whitelist. | |
int | burn_drive_scan (struct burn_drive_info *drive_infos[], unsigned int *n_drives) |
Scan for drives. | |
int | burn_drive_info_forget (struct burn_drive_info *drive_info, int force) |
Release memory about a single drive and any exclusive lock on it. | |
void | burn_drive_info_free (struct burn_drive_info drive_infos[]) |
When no longer needed, free a whole burn_drive_info array which was returned by burn_drive_scan(). | |
int | burn_drive_get_adr (struct burn_drive_info *drive_info, char adr[]) |
Inquire the persistent address of the given drive. | |
int | burn_drive_is_enumerable_adr (char *adr) |
Evaluate wether the given address would be a possible persistent drive address of libburn. | |
int | burn_drive_convert_fs_adr (char *path, char adr[]) |
Try to convert a given existing filesystem address into a persistent drive address. | |
int | burn_drive_convert_scsi_adr (int bus_no, int host_no, int channel_no, int target_no, int lun_no, char adr[]) |
Try to convert a given SCSI address of bus,host,channel,target,lun into a persistent drive address. | |
int | burn_drive_obtain_scsi_adr (char *path, int *bus_no, int *host_no, int *channel_no, int *target_no, int *lun_no) |
Try to obtain bus,host,channel,target,lun from path. | |
int | burn_drive_grab (struct burn_drive *drive, int load) |
Grab a drive. | |
void | burn_drive_release (struct burn_drive *drive, int eject) |
Release a drive. | |
enum burn_disc_status | burn_disc_get_status (struct burn_drive *drive) |
Returns what kind of disc a drive is holding. | |
int | burn_disc_pretend_blank (struct burn_drive *drive) |
WARNING: This revives an old bug-like behavior that might be dangerous. | |
int | burn_disc_pretend_full (struct burn_drive *drive) |
WARNING: This overrides the safety measures against unsuitable media. | |
int | burn_disc_read_atip (struct burn_drive *drive) |
Reads ATIP information from inserted media. | |
int | burn_drive_get_start_end_lba (struct burn_drive *drive, int *start_lba, int *end_lba, int flag) |
Returns start and end lba of the media which is currently inserted in the given drive. | |
int | burn_disc_track_lba_nwa (struct burn_drive *d, struct burn_write_opts *o, int trackno, int *lba, int *nwa) |
Read start lba and Next Writeable Address of a track from media. | |
int | burn_disc_get_msc1 (struct burn_drive *d, int *start_lba) |
Read start lba of the first track in the last complete session. | |
off_t | burn_disc_available_space (struct burn_drive *d, struct burn_write_opts *o) |
Return the best possible estimation of the currently available capacity of the media. | |
int | burn_disc_get_profile (struct burn_drive *d, int *pno, char name[80]) |
Tells the MMC Profile identifier of the loaded media. | |
int | burn_disc_erasable (struct burn_drive *d) |
Tells whether a disc can be erased or not. | |
enum burn_drive_status | burn_drive_get_status (struct burn_drive *drive, struct burn_progress *p) |
Returns the progress and status of a drive. | |
burn_write_opts * | burn_write_opts_new (struct burn_drive *drive) |
Creates a write_opts struct for burning to the specified drive must be freed with burn_write_opts_free. | |
void | burn_write_opts_free (struct burn_write_opts *opts) |
Frees a write_opts struct created with burn_write_opts_new. | |
burn_read_opts * | burn_read_opts_new (struct burn_drive *drive) |
Creates a read_opts struct for reading from the specified drive must be freed with burn_read_opts_free. | |
void | burn_read_opts_free (struct burn_read_opts *opts) |
Frees a read_opts struct created with burn_read_opts_new. | |
void | burn_disc_erase (struct burn_drive *drive, int fast) |
Erase a disc in the drive. | |
void | burn_disc_format (struct burn_drive *drive, off_t size, int flag) |
Format media for use with libburn. | |
int | burn_disc_get_formats (struct burn_drive *drive, int *status, off_t *size, unsigned *bl_sas, int *num_formats) |
Inquire the formatting status, the associated sizes and the number of available formats. | |
int | burn_disc_get_format_descr (struct burn_drive *drive, int index, int *type, off_t *size, unsigned *tdp) |
Inquire parameters of an available media format. | |
void | burn_disc_read (struct burn_drive *drive, const struct burn_read_opts *o) |
Read a disc from the drive and write it to an fd pair. | |
int | burn_precheck_write (struct burn_write_opts *o, struct burn_disc *disc, char reasons[BURN_REASONS_LEN], int silent) |
Examines a completed setup for burn_disc_write() wether it is permissible with drive and media. | |
void | burn_disc_write (struct burn_write_opts *o, struct burn_disc *disc) |
Write a disc in the drive. | |
void | burn_drive_cancel (struct burn_drive *drive) |
Cancel an operation on a drive. | |
int | burn_drive_wrote_well (struct burn_drive *d) |
Inquire wether the most recent write run was successful. | |
int | burn_msf_to_sectors (int m, int s, int f) |
Convert a minute-second-frame (MSF) value to sector count. | |
void | burn_sectors_to_msf (int sectors, int *m, int *s, int *f) |
Convert a sector count to minute-second-frame (MSF). | |
int | burn_msf_to_lba (int m, int s, int f) |
Convert a minute-second-frame (MSF) value to an lba. | |
void | burn_lba_to_msf (int lba, int *m, int *s, int *f) |
Convert an lba to minute-second-frame (MSF). | |
burn_disc * | burn_disc_create (void) |
Create a new disc. | |
void | burn_disc_free (struct burn_disc *d) |
Delete disc and decrease the reference count on all its sessions. | |
burn_session * | burn_session_create (void) |
Create a new session. | |
void | burn_session_free (struct burn_session *s) |
Free a session (and decrease reference count on all tracks inside). | |
int | burn_disc_add_session (struct burn_disc *d, struct burn_session *s, unsigned int pos) |
Add a session to a disc at a specific position, increasing the sessions's reference count. | |
int | burn_disc_remove_session (struct burn_disc *d, struct burn_session *s) |
Remove a session from a disc. | |
burn_track * | burn_track_create (void) |
Create a track (for TAO recording, or to put in a session). | |
void | burn_track_free (struct burn_track *t) |
Free a track. | |
int | burn_session_add_track (struct burn_session *s, struct burn_track *t, unsigned int pos) |
Add a track to a session at specified position. | |
int | burn_session_remove_track (struct burn_session *s, struct burn_track *t) |
Remove a track from a session. | |
void | burn_track_define_data (struct burn_track *t, int offset, int tail, int pad, int mode) |
Define the data in a track. | |
int | burn_track_set_byte_swap (struct burn_track *t, int swap_source_bytes) |
Define wether a track shall swap bytes of its input stream. | |
void | burn_track_set_isrc (struct burn_track *t, char *country, char *owner, unsigned char year, unsigned int serial) |
Set the ISRC details for a track. | |
void | burn_track_clear_isrc (struct burn_track *t) |
Disable ISRC parameters for a track. | |
void | burn_session_hide_first_track (struct burn_session *s, int onoff) |
Hide the first track in the "pre gap" of the disc. | |
burn_disc * | burn_drive_get_disc (struct burn_drive *d) |
Get the drive's disc struct - free when done. | |
enum burn_source_status | burn_track_set_source (struct burn_track *t, struct burn_source *s) |
Set the track's data source. | |
int | burn_track_set_default_size (struct burn_track *t, off_t size) |
Set a default track size to be used only if the track turns out to be of unpredictable length and if the effective write type demands a fixed size. | |
void | burn_source_free (struct burn_source *s) |
Free a burn_source (decrease its refcount and maybe free it). | |
burn_source * | burn_file_source_new (const char *path, const char *subpath) |
Creates a data source for an image file (and maybe subcode file). | |
burn_source * | burn_fd_source_new (int datafd, int subfd, off_t size) |
Creates a data source for an image file (a track) from an open readable filedescriptor, an eventually open readable subcodes file descriptor and eventually a fixed size in bytes. | |
int | burn_track_set_size (struct burn_track *t, off_t size) |
Sets a fixed track size after the data source object has already been created. | |
int | burn_track_get_sectors (struct burn_track *) |
Tells how long a track will be on disc >>> NOTE: Not reliable with tracks of undefined length. | |
int | burn_track_get_counters (struct burn_track *t, off_t *read_bytes, off_t *written_bytes) |
Tells how many source bytes have been read and how many data bytes have been written by the track during burn. | |
void | burn_drive_set_speed (struct burn_drive *d, int read, int write) |
Sets drive read and write speed Note: "k" is 1000, not 1024. | |
int | burn_drive_set_buffer_waiting (struct burn_drive *d, int enable, int min_usec, int max_usec, int timeout_sec, int min_percent, int max_percent) |
Controls the behavior with writing when the drive buffer is suspected to be full. | |
void | burn_structure_print_disc (struct burn_disc *d) |
void | burn_structure_print_session (struct burn_session *s) |
void | burn_structure_print_track (struct burn_track *t) |
int | burn_write_opts_set_write_type (struct burn_write_opts *opts, enum burn_write_types write_type, int block_type) |
Sets the write type for the write_opts struct. | |
enum burn_write_types | burn_write_opts_auto_write_type (struct burn_write_opts *opts, struct burn_disc *disc, char reasons[BURN_REASONS_LEN], int flag) |
As an alternative to burn_write_opts_set_write_type() this function tries to find a suitable write type and block type for a given write job described by opts and disc. | |
void | burn_write_opts_set_toc_entries (struct burn_write_opts *opts, int count, struct burn_toc_entry *toc_entries) |
Supplies toc entries for writing - not normally required for cd mastering. | |
void | burn_write_opts_set_format (struct burn_write_opts *opts, int format) |
Sets the session format for a disc. | |
int | burn_write_opts_set_simulate (struct burn_write_opts *opts, int sim) |
Sets the simulate value for the write_opts struct. | |
int | burn_write_opts_set_underrun_proof (struct burn_write_opts *opts, int underrun_proof) |
Controls buffer underrun prevention. | |
void | burn_write_opts_set_perform_opc (struct burn_write_opts *opts, int opc) |
Sets whether to use opc or not with the write_opts struct. | |
void | burn_write_opts_set_has_mediacatalog (struct burn_write_opts *opts, int has_mediacatalog) |
void | burn_write_opts_set_mediacatalog (struct burn_write_opts *opts, unsigned char mediacatalog[13]) |
void | burn_write_opts_set_multi (struct burn_write_opts *opts, int multi) |
Sets the multi flag which eventually marks the emerging session as not being the last one and thus creating a BURN_DISC_APPENDABLE media. | |
void | burn_write_opts_set_start_byte (struct burn_write_opts *opts, off_t value) |
Sets a start address for writing to media and write modes which allow to choose this address at all (DVD+RW, DVD-RAM, formatted DVD-RW only for now). | |
void | burn_write_opts_set_fillup (struct burn_write_opts *opts, int fill_up_media) |
Caution: still immature and likely to change. | |
void | burn_write_opts_set_force (struct burn_write_opts *opts, int use_force) |
Eventually makes libburn ignore the failure of some conformance checks:
| |
void | burn_read_opts_set_raw (struct burn_read_opts *opts, int raw_mode) |
Sets whether to read in raw mode or not. | |
void | burn_read_opts_set_c2errors (struct burn_read_opts *opts, int c2errors) |
Sets whether to report c2 errors or not. | |
void | burn_read_opts_read_subcodes_audio (struct burn_read_opts *opts, int subcodes_audio) |
Sets whether to read subcodes from audio tracks or not. | |
void | burn_read_opts_read_subcodes_data (struct burn_read_opts *opts, int subcodes_data) |
Sets whether to read subcodes from data tracks or not. | |
void | burn_read_opts_set_hardware_error_recovery (struct burn_read_opts *opts, int hardware_error_recovery) |
Sets whether to recover errors if possible. | |
void | burn_read_opts_report_recovered_errors (struct burn_read_opts *opts, int report_recovered_errors) |
Sets whether to report recovered errors or not. | |
void | burn_read_opts_transfer_damaged_blocks (struct burn_read_opts *opts, int transfer_damaged_blocks) |
Sets whether blocks with unrecoverable errors should be read or not. | |
void | burn_read_opts_set_hardware_error_retries (struct burn_read_opts *opts, unsigned char hardware_error_retries) |
Sets the number of retries to attempt when trying to correct an error. | |
int | burn_drive_get_write_speed (struct burn_drive *d) |
Gets the maximum write speed for a drive and eventually loaded media. | |
int | burn_drive_get_min_write_speed (struct burn_drive *d) |
Gets the minimum write speed for a drive and eventually loaded media. | |
int | burn_drive_get_read_speed (struct burn_drive *d) |
Gets the maximum read speed for a drive. | |
int | burn_drive_get_speedlist (struct burn_drive *d, struct burn_speed_descriptor **speed_list) |
Obtain a copy of the current speed descriptor list. | |
int | burn_drive_get_best_speed (struct burn_drive *d, int speed_goal, struct burn_speed_descriptor **best_descr, int flag) |
Look up the fastest speed descriptor which is not faster than the given speed_goal. | |
int | burn_drive_free_speedlist (struct burn_speed_descriptor **speed_list) |
Dispose a speed descriptor list copy which was obtained by burn_drive_get_speedlist(). | |
int | burn_disc_get_multi_caps (struct burn_drive *d, enum burn_write_types wt, struct burn_multi_caps **caps, int flag) |
Allocates a struct burn_multi_caps (see above) and fills it with values which are appropriate for the drive and the loaded media. | |
int | burn_disc_free_multi_caps (struct burn_multi_caps **caps) |
Removes from memory a multi session info structure which was returned by burn_disc_get_multi_caps(). | |
void | burn_track_get_entry (struct burn_track *t, struct burn_toc_entry *entry) |
Gets a copy of the toc_entry structure associated with a track. | |
void | burn_session_get_leadout_entry (struct burn_session *s, struct burn_toc_entry *entry) |
Gets a copy of the toc_entry structure associated with a session's lead out. | |
burn_session ** | burn_disc_get_sessions (struct burn_disc *d, int *num) |
Gets an array of all the sessions for the disc THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION. | |
int | burn_disc_get_sectors (struct burn_disc *d) |
burn_track ** | burn_session_get_tracks (struct burn_session *s, int *num) |
Gets an array of all the tracks for a session THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK. | |
int | burn_session_get_sectors (struct burn_session *s) |
int | burn_track_get_mode (struct burn_track *track) |
Gets the mode of a track. | |
int | burn_session_get_hidefirst (struct burn_session *session) |
Returns whether the first track of a session is hidden in the pregap. | |
void | burn_version (int *major, int *minor, int *micro) |
Returns the library's version in its parts. | |
int | burn_msgs_set_severities (char *queue_severity, char *print_severity, char *print_id) |
Control queueing and stderr printing of messages from libburn. | |
int | burn_msgs_obtain (char *minimum_severity, int *error_code, char msg_text[], int *os_errno, char severity[]) |
Obtain the oldest pending libburn message from the queue which has at least the given minimum_severity. | |
void | burn_set_signal_handling (void *handle, burn_abort_handler_t handler, int mode) |
Control builtin signal handling. |
#define BURN_4CH (1 << 7) |
#define BURN_AUDIO (1 << 6) |
Track mode - audio 2352 bytes per sector.
may be | with 4ch or preemphasis. NOT TO BE CONFUSED WITH BURN_MODE_RAW Audio data must be 44100Hz 16bit stereo with no riff or other header at beginning. Extra header data will cause pops or clicks. Audio data should also be in little-endian byte order. Big-endian audio data causes static.
Definition at line 92 of file libburn.h.
Referenced by libburner_payload(), and libburner_setup().
#define BURN_CDI 0x10 |
#define BURN_CDROM 0 |
#define BURN_COPY (1 << 8) |
#define BURN_DRIVE_ADR_LEN 1024 |
Maximum length+1 to expect with a persistent drive address string.
Definition at line 709 of file libburn.h.
Referenced by libburner_aquire_by_adr(), libburner_aquire_by_driveno(), and libburner_setup().
#define BURN_DRIVE_WHITELIST_LEN 255 |
#define BURN_FORM1 (1 << 4) |
#define BURN_FORM2 (1 << 5) |
#define BURN_FORMAT_IS_UNFORMATTED 1 |
#define BURN_MODE0 (1 << 0) |
#define BURN_MODE1 (1 << 2) |
Track mode - mode 1 data 2048 bytes user data, and all the LEC money can buy.
Definition at line 71 of file libburn.h.
Referenced by libburner_payload().
#define BURN_MODE2 (1 << 3) |
#define BURN_MODE_RAW (1 << 1) |
#define BURN_POS_END 100 |
#define BURN_PREEMPHASIS (1 << 9) |
#define BURN_REASONS_LEN 4096 |
The length of a rejection reasons string for burn_precheck_write() and burn_write_opts_auto_write_type() .
Definition at line 1035 of file libburn.h.
Referenced by libburner_payload().
#define BURN_SUBCODE_P16 (1 << 10) |
#define BURN_SUBCODE_P96 (1 << 11) |
#define BURN_SUBCODE_R96 (1 << 12) |
typedef int(*) burn_abort_handler_t(void *handle, int signum, int flag) |
enum burn_block_types |
Data format to send to the drive.
Definition at line 147 of file libburn.h.
00148 { 00149 /** sync, headers, edc/ecc provided by lib/user */ 00150 BURN_BLOCK_RAW0 = 1, 00151 /** sync, headers, edc/ecc and p/q subs provided by lib/user */ 00152 BURN_BLOCK_RAW16 = 2, 00153 /** sync, headers, edc/ecc and packed p-w subs provided by lib/user */ 00154 BURN_BLOCK_RAW96P = 4, 00155 /** sync, headers, edc/ecc and raw p-w subs provided by lib/user */ 00156 BURN_BLOCK_RAW96R = 8, 00157 /** only 2048 bytes of user data provided by lib/user */ 00158 BURN_BLOCK_MODE1 = 256, 00159 /** 2336 bytes of user data provided by lib/user */ 00160 BURN_BLOCK_MODE2R = 512, 00161 /** 2048 bytes of user data provided by lib/user 00162 subheader provided in write parameters 00163 are we ever going to support this shit? I vote no. 00164 (supposed to be supported on all drives...) 00165 */ 00166 BURN_BLOCK_MODE2_PATHETIC = 1024, 00167 /** 2048 bytes of data + 8 byte subheader provided by lib/user 00168 hey, this is also dumb 00169 */ 00170 BURN_BLOCK_MODE2_LAME = 2048, 00171 /** 2324 bytes of data provided by lib/user 00172 subheader provided in write parameters 00173 no sir, I don't like it. 00174 */ 00175 BURN_BLOCK_MODE2_OBSCURE = 4096, 00176 /** 2332 bytes of data supplied by lib/user 00177 8 bytes sub header provided in write parameters 00178 this is the second least suck mode2, and is mandatory for 00179 all drives to support. 00180 */ 00181 BURN_BLOCK_MODE2_OK = 8192, 00182 /** SAO block sizes are based on cue sheet, so use this. */ 00183 BURN_BLOCK_SAO = 16384 00184 };
enum burn_disc_status |
Possible status' of the drive in regard to the disc in it.
Definition at line 187 of file libburn.h.
00188 { 00189 /** The current status is not yet known */ 00190 BURN_DISC_UNREADY, 00191 /** The drive holds a blank disc */ 00192 BURN_DISC_BLANK, 00193 /** There is no disc at all in the drive */ 00194 BURN_DISC_EMPTY, 00195 /** There is an incomplete disc in the drive */ 00196 BURN_DISC_APPENDABLE, 00197 /** There is a disc with data on it in the drive */ 00198 BURN_DISC_FULL, 00199 00200 /* ts A61007 */ 00201 /** The drive was not grabbed when the status was inquired */ 00202 BURN_DISC_UNGRABBED, 00203 00204 /* ts A61020 */ 00205 /** The media seems not to be suitable for burning */ 00206 BURN_DISC_UNSUITABLE 00207 };
enum burn_drive_status |
Possible busy states for a drive.
Definition at line 223 of file libburn.h.
00224 { 00225 /** The drive is not in an operation */ 00226 BURN_DRIVE_IDLE, 00227 /** The library is spawning the processes to handle a pending 00228 operation (A read/write/etc is about to start but hasn't quite 00229 yet) */ 00230 BURN_DRIVE_SPAWNING, 00231 /** The drive is reading data from a disc */ 00232 BURN_DRIVE_READING, 00233 /** The drive is writing data to a disc */ 00234 BURN_DRIVE_WRITING, 00235 /** The drive is writing Lead-In */ 00236 BURN_DRIVE_WRITING_LEADIN, 00237 /** The drive is writing Lead-Out */ 00238 BURN_DRIVE_WRITING_LEADOUT, 00239 /** The drive is erasing a disc */ 00240 BURN_DRIVE_ERASING, 00241 /** The drive is being grabbed */ 00242 BURN_DRIVE_GRABBING, 00243 00244 /* ts A61102 */ 00245 /** The drive gets written zeroes before the track payload data */ 00246 BURN_DRIVE_WRITING_PREGAP, 00247 /** The drive is told to close a track (TAO only) */ 00248 BURN_DRIVE_CLOSING_TRACK, 00249 /** The drive is told to close a session (TAO only) */ 00250 BURN_DRIVE_CLOSING_SESSION, 00251 00252 /* ts A61223 */ 00253 /** The drive is formatting media */ 00254 BURN_DRIVE_FORMATTING 00255 00256 };
enum burn_source_status |
Possible data source return values.
BURN_SOURCE_OK | The source is ok. |
BURN_SOURCE_EOF | The source is at end of file. |
BURN_SOURCE_FAILED | The source is unusable. |
Definition at line 211 of file libburn.h.
00212 { 00213 /** The source is ok */ 00214 BURN_SOURCE_OK, 00215 /** The source is at end of file */ 00216 BURN_SOURCE_EOF, 00217 /** The source is unusable */ 00218 BURN_SOURCE_FAILED 00219 };
enum burn_write_types |
Possible disc writing style/modes.
Definition at line 107 of file libburn.h.
00108 { 00109 /** Packet writing. 00110 currently unsupported, (for DVD Incremental Streaming use TAO) 00111 */ 00112 BURN_WRITE_PACKET, 00113 00114 /** With CD: Track At Once recording 00115 2s gaps between tracks, no fonky lead-ins 00116 00117 With sequential DVD-R[W]: Incremental Streaming 00118 With DVD-RAM/+RW: Random Writeable (used sequentially) 00119 With overwriteable DVD-RW: Rigid Restricted Overwrite 00120 */ 00121 BURN_WRITE_TAO, 00122 00123 /** With CD: Session At Once 00124 Block type MUST be BURN_BLOCK_SAO 00125 ts A70122: Currently not capable of mixing data and audio tracks. 00126 00127 With sequential DVD-R[W]: Disc-at-once, DAO 00128 Single session, single track, fixed size mandatory, (-dvd-compat) 00129 */ 00130 BURN_WRITE_SAO, 00131 00132 /** With CD: Raw disc at once recording. 00133 all subcodes must be provided by lib or user 00134 only raw block types are supported 00135 */ 00136 BURN_WRITE_RAW, 00137 00138 /** In replies this indicates that not any writing will work. 00139 As parameter for inquiries it indicates that no particular write 00140 mode shall is specified. 00141 Do not use for setting a write mode for burning. It won't work. 00142 */ 00143 BURN_WRITE_NONE 00144 };
int burn_abort | ( | int | patience, | |
int(*)(void *handle, int patience, int elapsed) | pacifier_func, | |||
void * | handle | |||
) |
Abort any running drive operation and finally call burn_finish().
You MUST calm down the busy drive if an aborting event occurs during a burn run. For that you may call this function either from your own signal handling code or indirectly by activating the builtin signal handling: burn_set_signal_handling("my_app_name : ", NULL, 0); Else you may eventually call burn_drive_cancel() on the active drive and wait for it to assume state BURN_DRIVE_IDLE.
patience | Maximum number of seconds to wait for drives to finish | |
pacifier_func | If not NULL: a function to produce appeasing messages. See burn_abort_pacifier() for an example. | |
handle | Opaque handle to be used with pacifier_func |
int burn_abort_pacifier | ( | void * | handle, | |
int | patience, | |||
int | elapsed | |||
) |
A pacifier function suitable for burn_abort.
handle | If not NULL, a pointer to a text suitable for printf("%s") | |
patience | Maximum number of seconds to wait | |
elapsed | Elapsed number of seconds |
void burn_allow_untested_profiles | ( | int | yes | ) |
Allows the use of media types which are implemented in libburn but not yet tested.
The list of those untested profiles is subject to change. Currently it contains: 0x15 "DVD-R/DL Sequential". If you really test such media, then please report the outcome on libburn-hackers@pykix.org If ever then this call should be done soon after burn_initialize() before any drive scanning.
yes | 1=allow all implemented profiles, 0=only tested media (default) |
int burn_disc_add_session | ( | struct burn_disc * | d, | |
struct burn_session * | s, | |||
unsigned int | pos | |||
) |
Add a session to a disc at a specific position, increasing the sessions's reference count.
d | Disc to add the session to | |
s | Session to add to the disc | |
pos | position to add at (BURN_POS_END is "at the end") |
Referenced by libburner_payload().
off_t burn_disc_available_space | ( | struct burn_drive * | d, | |
struct burn_write_opts * | o | |||
) |
Return the best possible estimation of the currently available capacity of the media.
This might depend on particular write option settings. For inquiring the space with such a set of options, the drive has to be grabbed and BURN_DRIVE_IDLE. If not, then one will only get a canned value from the most recent automatic inquiry (e.g. during last drive grabbing). An eventual start address from burn_write_opts_set_start_byte() will be subtracted from the obtained capacity estimation. Negative results get defaulted to 0.
d | The drive to query. | |
o | If not NULL: write parameters to be set on drive before query |
struct burn_disc* burn_disc_create | ( | void | ) |
int burn_disc_erasable | ( | struct burn_drive * | d | ) |
Tells whether a disc can be erased or not.
Referenced by libburner_blank_disc(), and libburner_payload().
void burn_disc_erase | ( | struct burn_drive * | drive, | |
int | fast | |||
) |
Erase a disc in the drive.
The drive must be grabbed successfully BEFORE calling this functions. Always ensure that the drive reports a status of BURN_DISC_FULL before calling this function. An erase operation is not cancellable, as control of the operation is passed wholly to the drive and there is no way to interrupt it safely.
drive | The drive with which to erase a disc. | |
fast | Nonzero to do a fast erase, where only the disc's headers are erased; zero to erase the entire disc. With DVD-RW, fast blanking yields media capable only of DAO. |
Referenced by libburner_blank_disc().
void burn_disc_format | ( | struct burn_drive * | drive, | |
off_t | size, | |||
int | flag | |||
) |
Format media for use with libburn.
This currently applies to DVD-RW in state "Sequential Recording" (profile 0014h) which get formatted to state "Restricted Overwrite" (profile 0013h). DVD+RW can be "de-iced" by setting bit2 of flag. Other media cannot be formatted yet.
drive | The drive with the disc to format. | |
size | The size in bytes to be used with the format command. It should be divisible by 32*1024. The effect of this parameter may depend on the media profile. | |
flag | Bitfield for control purposes: bit0= after formatting, write the given number of zero-bytes to the media and eventually perform preliminary closing. bit1= insist in size 0 even if there is a better default known bit2= format to maximum available size bit3= -reserved- bit4= enforce re-format of (partly) formatted media bit7= MMC expert application mode (else libburn tries to choose a suitable format type): bit8 to bit15 contain the index of the format to use. See burn_disc_get_formats(), burn_disc_get_format_descr(). Acceptable types are: 0x00, 0x10, 0x11, 0x13, 0x15, 0x26. If bit7 is set, bit4 is set automatically. |
Referenced by libburner_format_row().
void burn_disc_free | ( | struct burn_disc * | d | ) |
Delete disc and decrease the reference count on all its sessions.
d | The disc to be freed |
Referenced by libburner_payload().
int burn_disc_free_multi_caps | ( | struct burn_multi_caps ** | caps | ) |
Removes from memory a multi session info structure which was returned by burn_disc_get_multi_caps().
The pointer *caps gets set to NULL.
caps | the info structure to dispose (note: pointer to pointer) |
int burn_disc_get_format_descr | ( | struct burn_drive * | drive, | |
int | index, | |||
int * | type, | |||
off_t * | size, | |||
unsigned * | tdp | |||
) |
Inquire parameters of an available media format.
drive | The drive with the disc to format. | |
index | The index of the format item. Beginning with 0 up to reply parameter from burn_disc_get_formats() : num_formats - 1 | |
type | The format type. See mmc5r03c.pdf, 6.5, 04h FORMAT UNIT. 0x00=full, 0x10=CD-RW/DVD-RW full, 0x11=CD-RW/DVD-RW grow, 0x15=DVD-RW quick, 0x13=DVD-RW quick grow, 0x26=DVD+RW background | |
size | The maximum size in bytes achievable with this format. | |
tdp | Type Dependent Parameter. See mmc5r03c.pdf. |
int burn_disc_get_formats | ( | struct burn_drive * | drive, | |
int * | status, | |||
off_t * | size, | |||
unsigned * | bl_sas, | |||
int * | num_formats | |||
) |
Inquire the formatting status, the associated sizes and the number of available formats.
The info is media specific and stems from MMC command 23h READ FORMAT CAPACITY. See mmc5r03c.pdf 6.24 for background details. Media type can be determined via burn_disc_get_profile().
drive | The drive with the disc to format. | |
status | The current formatting status of the inserted media. See BURN_FORMAT_IS_* macros. Note: "unknown" is the legal status for quick formatted, yet unwritten DVD-RW. | |
size | The size in bytes associated with status. unformatted: the maximum achievable size of the media formatted: the currently formatted capacity unknown: maximum capacity of drive or of media | |
bl_sas | Additional info "Block Length/Spare Area Size". Expected to be constantly 2048 for non-BD media. | |
num_formats | The number of available formats. To be used with burn_disc_get_format_descr() to obtain such a format and eventually with burn_disc_format() to select one. |
int burn_disc_get_msc1 | ( | struct burn_drive * | d, | |
int * | start_lba | |||
) |
Read start lba of the first track in the last complete session.
This is the first parameter of mkisofs option -C. The second parameter is nwa as obtained by burn_disc_track_lba_nwa() with trackno 0.
d | The drive to query. | |
start_lba | returns the start address of that track |
int burn_disc_get_multi_caps | ( | struct burn_drive * | d, | |
enum burn_write_types | wt, | |||
struct burn_multi_caps ** | caps, | |||
int | flag | |||
) |
Allocates a struct burn_multi_caps (see above) and fills it with values which are appropriate for the drive and the loaded media.
The drive must be grabbed for this call. The returned structure has to be disposed via burn_disc_free_multi_caps() when no longer needed.
d | The drive to inquire | |
wt | With BURN_WRITE_NONE the best capabilities of all write modes get returned. If set to a write mode like BURN_WRITE_SAO the capabilities with that particular mode are returned and the return value is 0 if the desired mode is not possible. | |
caps | returns the info structure | |
flag | Bitfield for control purposes (unused yet, submit 0) |
int burn_disc_get_profile | ( | struct burn_drive * | d, | |
int * | pno, | |||
char | name[80] | |||
) |
Tells the MMC Profile identifier of the loaded media.
The drive must be grabbed in order to get a non-zero result. libburn currently writes only to profiles 0x09 "CD-R", 0x0a "CD-RW", 0x11 "DVD-R", 0x12 "DVD-RAM", 0x13 "DVD-RW restricted overwrite", 0x14 "DVD-RW Sequential Recording" or 0x1a "DVD+RW". If enabled by burn_allow_untested_profiles() it also writes to profile 0x15 "DVD-R/DL Sequential Recording".
d | The drive where the media is inserted. | |
pno | Profile Number as of mmc5r03c.pdf, table 89 | |
name | Profile Name (e.g "CD-RW", unknown profiles have empty name) |
Referenced by libburner_aquire_drive(), and libburner_format_row().
int burn_disc_get_sectors | ( | struct burn_disc * | d | ) |
struct burn_session** burn_disc_get_sessions | ( | struct burn_disc * | d, | |
int * | num | |||
) |
Gets an array of all the sessions for the disc THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION.
d | Disc to get session array for | |
num | Returns the number of sessions in the array |
enum burn_disc_status burn_disc_get_status | ( | struct burn_drive * | drive | ) |
Returns what kind of disc a drive is holding.
This function may need to be called more than once to get a proper status from it. See burn_disc_status for details.
drive | The drive to query for a disc. |
Referenced by libburner_blank_disc(), and libburner_payload().
int burn_disc_pretend_blank | ( | struct burn_drive * | drive | ) |
WARNING: This revives an old bug-like behavior that might be dangerous.
Sets the drive status to BURN_DISC_BLANK if it is BURN_DISC_UNREADY or BURN_DISC_UNSUITABLE. Thus marking media as writable which actually failed to declare themselves either blank or (partially) filled.
int burn_disc_pretend_full | ( | struct burn_drive * | drive | ) |
WARNING: This overrides the safety measures against unsuitable media.
Sets the drive status to BURN_DISC_FULL if it is BURN_DISC_UNREADY or BURN_DISC_UNSUITABLE. Thus marking media as blankable which actually failed to declare themselves either blank or (partially) filled.
void burn_disc_read | ( | struct burn_drive * | drive, | |
const struct burn_read_opts * | o | |||
) |
Read a disc from the drive and write it to an fd pair.
The drive must be grabbed successfully BEFORE calling this function. Always ensure that the drive reports a status of BURN_DISC_FULL before calling this function.
drive | The drive from which to read a disc. | |
o | The options for the read operation. |
int burn_disc_read_atip | ( | struct burn_drive * | drive | ) |
Reads ATIP information from inserted media.
To be obtained via burn_drive_get_write_speed(), burn_drive_get_min_write_speed(), burn_drive_get_start_end_lba(). The drive must be grabbed for this call.
drive | The drive to query. |
int burn_disc_remove_session | ( | struct burn_disc * | d, | |
struct burn_session * | s | |||
) |
Remove a session from a disc.
d | Disc to remove session from | |
s | Session pointer to find and remove |
int burn_disc_track_lba_nwa | ( | struct burn_drive * | d, | |
struct burn_write_opts * | o, | |||
int | trackno, | |||
int * | lba, | |||
int * | nwa | |||
) |
Read start lba and Next Writeable Address of a track from media.
Usually a track lba is obtained from the result of burn_track_get_entry(). This call retrieves an updated lba, eventual nwa, and can address the invisible track to come. The drive must be grabbed for this call. One may not issue this call during ongoing burn_disc_write() or burn_disc_erase().
d | The drive to query. | |
o | If not NULL: write parameters to be set on drive before query | |
trackno | 0=next track to come, >0 number of existing track | |
lba | return value: start lba | |
nwa | return value: Next Writeable Address |
void burn_disc_write | ( | struct burn_write_opts * | o, | |
struct burn_disc * | disc | |||
) |
Write a disc in the drive.
The drive must be grabbed successfully before calling this function. Always ensure that the drive reports a status of BURN_DISC_BLANK ot BURN_DISC_APPENDABLE before calling this function. Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. To be set by burn_write_opts_set_write_type().
o | The options for the writing operation. | |
disc | The struct burn_disc * that described the disc to be created |
Referenced by libburner_payload().
int burn_drive_add_whitelist | ( | char * | device_address | ) |
Add a device to the list of permissible drives.
As soon as some entry is in the whitelist all non-listed drives are banned from scanning.
void burn_drive_cancel | ( | struct burn_drive * | drive | ) |
Cancel an operation on a drive.
This will only work when the drive's busy state is BURN_DRIVE_READING or BURN_DRIVE_WRITING.
drive | The drive on which to cancel the current operation. |
void burn_drive_clear_whitelist | ( | void | ) |
Remove all drives from whitelist.
This enables all possible drives.
int burn_drive_convert_fs_adr | ( | char * | path, | |
char | adr[] | |||
) |
Try to convert a given existing filesystem address into a persistent drive address.
This succeeds with symbolic links or if a hint about the drive's system address can be read from the filesystem object and a matching drive is found.
path | The address of an existing file system object | |
adr | An application provided array of at least BURN_DRIVE_ADR_LEN characters size. The persistent address gets copied to it. |
Referenced by libburner_aquire_by_adr().
int burn_drive_convert_scsi_adr | ( | int | bus_no, | |
int | host_no, | |||
int | channel_no, | |||
int | target_no, | |||
int | lun_no, | |||
char | adr[] | |||
) |
Try to convert a given SCSI address of bus,host,channel,target,lun into a persistent drive address.
If a SCSI address component parameter is < 0 then it is not decisive and the first enumerated address which matches the >= 0 parameters is taken as result. Note: bus and (host,channel) are supposed to be redundant.
bus_no | "Bus Number" (something like a virtual controller) | |
host_no | "Host Number" (something like half a virtual controller) | |
channel_no | "Channel Number" (other half of "Host Number") | |
target_no | "Target Number" or "SCSI Id" (a device) | |
lun_no | "Logical Unit Number" (a sub device) | |
adr | An application provided array of at least BURN_DRIVE_ADR_LEN characters size. The persistent address gets copied to it. |
int burn_drive_free_speedlist | ( | struct burn_speed_descriptor ** | speed_list | ) |
Dispose a speed descriptor list copy which was obtained by burn_drive_get_speedlist().
speed_list | The list copy. *speed_list gets set to NULL. |
int burn_drive_get_adr | ( | struct burn_drive_info * | drive_info, | |
char | adr[] | |||
) |
Inquire the persistent address of the given drive.
drive_info | The drive to inquire. Usually some &(drive_infos[driveno]) | |
adr | An application provided array of at least BURN_DRIVE_ADR_LEN characters size. The persistent address gets copied to it. |
Referenced by libburner_aquire_by_driveno().
int burn_drive_get_best_speed | ( | struct burn_drive * | d, | |
int | speed_goal, | |||
struct burn_speed_descriptor ** | best_descr, | |||
int | flag | |||
) |
Look up the fastest speed descriptor which is not faster than the given speed_goal.
If it is 0, then the fastest one is chosen among the descriptors with the highest end_lba. If it is -1 then the slowest speed descriptor is chosen regardless of end_lba. Parameter flag decides wether the speed goal means write speed or read speed.
d | Drive to query | |
speed_goal | Upper limit for speed, 0=search for maximum speed , -1 search for minimum speed | |
best_descr | Result of the search, NULL if no match | |
flag | Bitfield for control purposes bit0= look for best read speed rather than write speed bit1= look for any source type (else look for source==2 first and for any other source type only with CD media) |
struct burn_disc* burn_drive_get_disc | ( | struct burn_drive * | d | ) |
Get the drive's disc struct - free when done.
d | drive to query |
int burn_drive_get_min_write_speed | ( | struct burn_drive * | d | ) |
Gets the minimum write speed for a drive and eventually loaded media.
The return value might change by the media type of already loaded media, again by call burn_drive_grab() and again by call burn_disc_read_atip().
d | Drive to query |
int burn_drive_get_read_speed | ( | struct burn_drive * | d | ) |
Gets the maximum read speed for a drive.
d | Drive to query |
int burn_drive_get_speedlist | ( | struct burn_drive * | d, | |
struct burn_speed_descriptor ** | speed_list | |||
) |
Obtain a copy of the current speed descriptor list.
The drive's list gets updated on various occasions such as burn_drive_grab() but the copy obtained here stays untouched. It has to be disposed via burn_drive_free_speedlist() when it is not longer needed. Speeds may appear several times in the list. The list content depends much on drive and media type. It seems that .source == 1 applies mostly to CD media whereas .source == 2 applies to any media.
d | Drive to query | |
speed_list | The copy. If empty, *speed_list gets returned as NULL. |
int burn_drive_get_start_end_lba | ( | struct burn_drive * | drive, | |
int * | start_lba, | |||
int * | end_lba, | |||
int | flag | |||
) |
Returns start and end lba of the media which is currently inserted in the given drive.
The drive has to be grabbed to have hope for reply. Shortcomming (not a feature): unless burn_disc_read_atip() was called only blank media will return valid info.
drive | The drive to query. | |
start_lba | Returns the start lba value | |
end_lba | Returns the end lba value | |
flag | Bitfield for control purposes (unused yet, submit 0) |
enum burn_drive_status burn_drive_get_status | ( | struct burn_drive * | drive, | |
struct burn_progress * | p | |||
) |
Returns the progress and status of a drive.
drive | The drive to query busy state for. | |
p | Returns the progress of the operation, NULL if you don't care |
Referenced by libburner_blank_disc(), libburner_format_row(), and libburner_payload().
int burn_drive_get_write_speed | ( | struct burn_drive * | d | ) |
Gets the maximum write speed for a drive and eventually loaded media.
The return value might change by the media type of already loaded media, again by call burn_drive_grab() and again by call burn_disc_read_atip().
d | Drive to query |
int burn_drive_grab | ( | struct burn_drive * | drive, | |
int | load | |||
) |
Grab a drive.
This must be done before the drive can be used (for reading, writing, etc).
drive | The drive to grab. This is found in a returned burn_drive_info struct. | |
load | Nonzero to make the drive attempt to load a disc (close its tray door, etc). |
Referenced by libburner_aquire_by_driveno().
int burn_drive_info_forget | ( | struct burn_drive_info * | drive_info, | |
int | force | |||
) |
Release memory about a single drive and any exclusive lock on it.
Become unable to inquire or grab it. Expect FATAL consequences if you try.
drive_info | pointer to a single element out of the array obtained from burn_drive_scan() : &(drive_infos[driveno]) | |
force | controls degree of permissible drive usage at the moment this function is called, and the amount of automatically provided drive shutdown : 0= drive must be ungrabbed and BURN_DRIVE_IDLE 1= try to release drive resp. accept BURN_DRIVE_GRABBING Use these two only. Further values are to be defined. |
Referenced by libburner_aquire_by_driveno().
void burn_drive_info_free | ( | struct burn_drive_info | drive_infos[] | ) |
When no longer needed, free a whole burn_drive_info array which was returned by burn_drive_scan().
For freeing single drive array elements use burn_drive_info_forget().
int burn_drive_is_enumerable_adr | ( | char * | adr | ) |
Evaluate wether the given address would be a possible persistent drive address of libburn.
int burn_drive_obtain_scsi_adr | ( | char * | path, | |
int * | bus_no, | |||
int * | host_no, | |||
int * | channel_no, | |||
int * | target_no, | |||
int * | lun_no | |||
) |
Try to obtain bus,host,channel,target,lun from path.
If there is an SCSI address at all, then this call should succeed with a persistent drive address obtained via burn_drive_get_adr(). It is also supposed to succeed with any device file of a (possibly emulated) SCSI device.
void burn_drive_release | ( | struct burn_drive * | drive, | |
int | eject | |||
) |
Release a drive.
This should not be done until the drive is no longer busy (see burn_drive_get_status). Linux: The drive is unlocked afterwards. (O_EXCL , F_SETLK).
drive | The drive to release. | |
eject | Nonzero to make the drive eject the disc in it. |
Referenced by main().
int burn_drive_scan | ( | struct burn_drive_info * | drive_infos[], | |
unsigned int * | n_drives | |||
) |
Scan for drives.
This function MUST be called until it returns nonzero. No drives may be in use when this is called. All drive pointers are invalidated by using this function. Do NOT store drive pointers across calls to this function or death AND pain will ensue. After this call all drives depicted by the returned array are subject to eventual (O_EXCL) locking. See burn_preset_device_open(). This state ends either with burn_drive_info_forget() or with burn_drive_release(). It is unfriendly to other processes on the system to hold drives locked which one does not definitely plan to use soon.
drive_infos | Returns an array of drive info items (cdroms/burners). The returned array must be freed by burn_drive_info_free() before burn_finish(), and also before calling this function burn_drive_scan() again. | |
n_drives | Returns the number of drive items in drive_infos. |
Referenced by libburner_aquire_by_driveno().
int burn_drive_scan_and_grab | ( | struct burn_drive_info * | drive_infos[], | |
char * | adr, | |||
int | load | |||
) |
Aquire a drive with known persistent address.This is the sysadmin friendly way to open one drive and to leave all others untouched.
It bundles the following API calls to form a non-obtrusive way to use libburn: burn_drive_add_whitelist() , burn_drive_scan() , burn_drive_grab() You are *strongly urged* to use this call whenever you know the drive address in advance. If not, then you have to use directly above calls. In that case, you are strongly urged* to drop any unintended drive which will be exclusively occupied and not closed by burn_drive_scan(). This can be done by shutting down the library including a call to burn_finish(). You may later start a new libburn session and should then use the function described here with an address obtained after burn_drive_scan() via burn_drive_get_adr(&(drive_infos[driveno]), adr) . Another way is to drop the unwanted drives by burn_drive_info_forget().
drive_infos | On success returns a one element array with the drive (cdrom/burner). Thus use with driveno 0 only. On failure the array has no valid elements at all. The returned array should be freed via burn_drive_info_free() when it is no longer needed, and before calling a scan function again. This is a result from call burn_drive_scan(). See there. Use with driveno 0 only. | |
adr | The persistent address of the desired drive. Either obtained by burn_drive_get_adr() or guessed skillfully by application resp. its user. | |
load | Nonzero to make the drive attempt to load a disc (close its tray door, etc). |
Referenced by libburner_aquire_by_adr().
int burn_drive_set_buffer_waiting | ( | struct burn_drive * | d, | |
int | enable, | |||
int | min_usec, | |||
int | max_usec, | |||
int | timeout_sec, | |||
int | min_percent, | |||
int | max_percent | |||
) |
Controls the behavior with writing when the drive buffer is suspected to be full.
To check and wait for enough free buffer space before writing will move the task of waiting from the operating system's device driver to libburn. While writing is going on and waiting is enabled, any write operation will be checked wether it will fill the drive buffer up to more than max_percent. If so, then waiting will happen until the buffer fill is predicted with at most min_percent. Thus: if min_percent < max_percent then transfer rate will oscillate. This may allow the driver to operate on other devices, e.g. a disk from which to read the input for writing. On the other hand, this checking might reduce maximum throughput to the drive or even get misled by faulty buffer fill replies from the drive. If a setting parameter is < 0, then this setting will stay unchanged by the call. Known burner or media specific pitfalls: To have max_percent larger than the burner's best reported buffer fill has the same effect as min_percent==max_percent. Some burners do not report their full buffer with all media types. Some are not suitable because they report their buffer fill with delay.
d | The drive to control | |
enable | 0= disable , 1= enable waiting , (-1 = do not change setting) | |
min_usec | Shortest possible sleeping period (given in micro seconds) | |
max_usec | Longest possible sleeping period (given in micro seconds) | |
timeout_sec | If a single write has to wait longer than this number of seconds, then waiting gets disabled and mindless writing starts. A value of 0 disables this timeout. | |
min_percent | Minimum of desired buffer oscillation: 25 to 100 | |
max_percent | Maximum of desired buffer oscillation: 25 to 100 |
void burn_drive_set_speed | ( | struct burn_drive * | d, | |
int | read, | |||
int | write | |||
) |
Sets drive read and write speed Note: "k" is 1000, not 1024.
1xCD = 176.4 k/s, 1xDVD = 1385 k/s. Fractional speeds should be rounded up. Like 4xCD = 706.
d | The drive to set speed for | |
read | Read speed in k/s (0 is max, -1 is min). | |
write | Write speed in k/s (0 is max, -1 is min). |
Referenced by libburner_payload().
int burn_drive_wrote_well | ( | struct burn_drive * | d | ) |
Inquire wether the most recent write run was successful.
Reasons for non-success may be: rejection of burn parameters, abort during fatal errors during write, a call to burn_drive_cancel() by the application thread.
d | The drive to inquire. |
struct burn_source* burn_fd_source_new | ( | int | datafd, | |
int | subfd, | |||
off_t | size | |||
) |
Creates a data source for an image file (a track) from an open readable filedescriptor, an eventually open readable subcodes file descriptor and eventually a fixed size in bytes.
datafd | The source of data. | |
subfd | The eventual source for subcodes. Not used if -1. | |
size | The eventual fixed size of eventually both fds. If this value is 0, the size will be determined from datafd. |
Referenced by libburner_payload().
struct burn_source* burn_file_source_new | ( | const char * | path, | |
const char * | subpath | |||
) |
Creates a data source for an image file (and maybe subcode file).
void burn_finish | ( | void | ) |
Shutdown the library.
This should be called before exiting your application. Make sure that all drives you have grabbed are released before calling this.
Referenced by main().
int burn_initialize | ( | void | ) |
Initialize the library.
This must be called before using any other functions in the library. It may be called more than once with no effect. It is possible to 'restart' the library by shutting it down and re-initializing it. This is necessary if you follow the older and more general way of accessing a drive via burn_drive_scan() and burn_drive_grab(). See burn_drive_scan_and_grab() with its strong urges and its explanations.
Referenced by main().
void burn_lba_to_msf | ( | int | lba, | |
int * | m, | |||
int * | s, | |||
int * | f | |||
) |
Convert an lba to minute-second-frame (MSF).
lba | The lba | |
m | Returns the minute component | |
s | Returns the second component | |
f | Returns the frame component |
int burn_msf_to_lba | ( | int | m, | |
int | s, | |||
int | f | |||
) |
Convert a minute-second-frame (MSF) value to an lba.
m | Minute component | |
s | Second component | |
f | Frame component |
int burn_msf_to_sectors | ( | int | m, | |
int | s, | |||
int | f | |||
) |
Convert a minute-second-frame (MSF) value to sector count.
m | Minute component | |
s | Second component | |
f | Frame component |
int burn_msgs_obtain | ( | char * | minimum_severity, | |
int * | error_code, | |||
char | msg_text[], | |||
int * | os_errno, | |||
char | severity[] | |||
) |
Obtain the oldest pending libburn message from the queue which has at least the given minimum_severity.
This message and any older message of lower severity will get discarded from the queue and is then lost forever.
minimum_severity | may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL". To call with minimum_severity "NEVER" will discard the whole queue. | |
error_code | Will become a unique error code as liste in libburn/libdax_msgs.h | |
msg_text | Must provide at least BURN_MSGS_MESSAGE_LEN bytes. | |
os_errno | Will become the eventual errno related to the message | |
severity | Will become the severity related to the message and should provide at least 80 bytes. |
int burn_msgs_set_severities | ( | char * | queue_severity, | |
char * | print_severity, | |||
char * | print_id | |||
) |
Control queueing and stderr printing of messages from libburn.
Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL".
queue_severity | Gives the minimum limit for messages to be queued. Default: "NEVER". If you queue messages then you must consume them by burn_msgs_obtain(). | |
print_severity | Does the same for messages to be printed directly to stderr. Default: "FATAL". | |
print_id | A text prefix to be printed before the message. |
Referenced by main().
int burn_precheck_write | ( | struct burn_write_opts * | o, | |
struct burn_disc * | disc, | |||
char | reasons[BURN_REASONS_LEN], | |||
int | silent | |||
) |
Examines a completed setup for burn_disc_write() wether it is permissible with drive and media.
This function is called by burn_disc_write() but an application might be interested in this check in advance.
o | The options for the writing operation. | |
disc | The descrition of the disc to be created | |
reasons | Eventually returns a list of rejection reason statements | |
silent | 1= do not issue error messages , 0= report problems |
void burn_preset_device_open | ( | int | exclusive, | |
int | blocking, | |||
int | abort_on_busy | |||
) |
Set parameters for behavior on opening device files.
To be called early after burn_initialize() and before any bus scan. But not mandatory at all. Parameter value 1 enables a feature, 0 disables. Default is (1,0,0). Have a good reason before you change it.
exclusive | Linux only: 0 = no attempt to make drive access exclusive. 1 = Try to open only devices which are not marked as busy and try to mark them busy if opened sucessfully. (O_EXCL) There are kernels which simply don't care about O_EXCL. Some have it off, some have it on, some are switchable. 2 = in case of a SCSI device, also try to open exclusively the matching /dev/sr, /dev/scd and /dev/st . One may select a device SCSI file family by adding 0 = default family 4 = /dev/srd 8 = /dev/scdd 16 = /dev/sgd Do not use other values ! Add 32 to demand an exclusive lock by fcntl(,F_SETLK,) after open() has succeeded. | |
blocking | Try to wait for drives which do not open immediately but also do not return an error as well. (O_NONBLOCK) This might stall indefinitely with /dev/hdX hard disks. | |
abort_on_busy | Unconditionally abort process when a non blocking exclusive opening attempt indicates a busy drive. Use this only after thorough tests with your app. |
void burn_read_opts_free | ( | struct burn_read_opts * | opts | ) |
Frees a read_opts struct created with burn_read_opts_new.
opts | write_opts to free |
struct burn_read_opts* burn_read_opts_new | ( | struct burn_drive * | drive | ) |
Creates a read_opts struct for reading from the specified drive must be freed with burn_read_opts_free.
drive | The drive to read from |
void burn_read_opts_read_subcodes_audio | ( | struct burn_read_opts * | opts, | |
int | subcodes_audio | |||
) |
Sets whether to read subcodes from audio tracks or not.
opts | The read opts to change | |
subcodes_audio | If non-zero, read subcodes from audio tracks on the disc. |
void burn_read_opts_read_subcodes_data | ( | struct burn_read_opts * | opts, | |
int | subcodes_data | |||
) |
Sets whether to read subcodes from data tracks or not.
opts | The read opts to change | |
subcodes_data | If non-zero, read subcodes from data tracks on the disc. |
void burn_read_opts_report_recovered_errors | ( | struct burn_read_opts * | opts, | |
int | report_recovered_errors | |||
) |
Sets whether to report recovered errors or not.
opts | The read opts to change | |
report_recovered_errors | If non-zero, recovered errors will be reported. |
void burn_read_opts_set_c2errors | ( | struct burn_read_opts * | opts, | |
int | c2errors | |||
) |
Sets whether to report c2 errors or not.
opts | The read opts to change | |
c2errors | If non-zero, report c2 errors. |
void burn_read_opts_set_hardware_error_recovery | ( | struct burn_read_opts * | opts, | |
int | hardware_error_recovery | |||
) |
Sets whether to recover errors if possible.
opts | The read opts to change | |
hardware_error_recovery | If non-zero, attempt to recover errors if possible. |
void burn_read_opts_set_hardware_error_retries | ( | struct burn_read_opts * | opts, | |
unsigned char | hardware_error_retries | |||
) |
Sets the number of retries to attempt when trying to correct an error.
opts | The read opts to change | |
hardware_error_retries | The number of retries to attempt when correcting an error. |
void burn_read_opts_set_raw | ( | struct burn_read_opts * | opts, | |
int | raw_mode | |||
) |
Sets whether to read in raw mode or not.
opts | The read opts to change | |
raw_mode | If non-zero, reading will be done in raw mode, so that everything in the data tracks on the disc is read, including headers. |
void burn_read_opts_transfer_damaged_blocks | ( | struct burn_read_opts * | opts, | |
int | transfer_damaged_blocks | |||
) |
Sets whether blocks with unrecoverable errors should be read or not.
opts | The read opts to change | |
transfer_damaged_blocks | If non-zero, blocks with unrecoverable errors will still be read. |
void burn_sectors_to_msf | ( | int | sectors, | |
int * | m, | |||
int * | s, | |||
int * | f | |||
) |
Convert a sector count to minute-second-frame (MSF).
sectors | The sector count | |
m | Returns the minute component | |
s | Returns the second component | |
f | Returns the frame component |
int burn_session_add_track | ( | struct burn_session * | s, | |
struct burn_track * | t, | |||
unsigned int | pos | |||
) |
Add a track to a session at specified position.
s | Session to add to | |
t | Track to insert in session | |
pos | position to add at (BURN_POS_END is "at the end") |
Referenced by libburner_payload().
struct burn_session* burn_session_create | ( | void | ) |
void burn_session_free | ( | struct burn_session * | s | ) |
Free a session (and decrease reference count on all tracks inside).
s | Session to be freed |
Referenced by libburner_payload().
int burn_session_get_hidefirst | ( | struct burn_session * | session | ) |
Returns whether the first track of a session is hidden in the pregap.
session | the session to query |
void burn_session_get_leadout_entry | ( | struct burn_session * | s, | |
struct burn_toc_entry * | entry | |||
) |
Gets a copy of the toc_entry structure associated with a session's lead out.
s | Session to get the entry from | |
entry | Struct for the library to fill out |
int burn_session_get_sectors | ( | struct burn_session * | s | ) |
struct burn_track** burn_session_get_tracks | ( | struct burn_session * | s, | |
int * | num | |||
) |
Gets an array of all the tracks for a session THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK.
s | session to get track array for | |
num | Returns the number of tracks in the array |
void burn_session_hide_first_track | ( | struct burn_session * | s, | |
int | onoff | |||
) |
Hide the first track in the "pre gap" of the disc.
s | session to change | |
onoff | 1 to enable hiding, 0 to disable |
int burn_session_remove_track | ( | struct burn_session * | s, | |
struct burn_track * | t | |||
) |
Remove a track from a session.
s | Session to remove track from | |
t | Track pointer to find and remove |
void burn_set_signal_handling | ( | void * | handle, | |
burn_abort_handler_t | handler, | |||
int | mode | |||
) |
Control builtin signal handling.
See also burn_abort().
handle | Opaque handle eventually pointing to an application provided memory object | |
handler | A function to be called on signals. It will get handle as argument. It should finally call burn_abort(). See there. | |
mode | : 0 call handler(handle, signum, 0) on nearly all signals 1 enable system default reaction on all signals 2 try to ignore nearly all signals 10 like mode 2 but handle SIGABRT like with mode 0 Arguments (text, NULL, 0) activate the builtin abort handler. It will eventually call burn_abort() and then perform exit(1). If text is not NULL then it is used as prefix for pacifier messages of burn_abort_pacifier(). |
Referenced by main().
void burn_set_verbosity | ( | int | level | ) |
ts A61006 : This is for development only.
Not suitable for applications. Set the verbosity level of the library. The default value is 0, which means that nothing is output on stderr. The more you increase this, the more debug output should be displayed on stderr for you.
level | The verbosity level desired. 0 for nothing, higher positive values for more information output. |
void burn_source_free | ( | struct burn_source * | s | ) |
Free a burn_source (decrease its refcount and maybe free it).
s | Source to free |
Referenced by libburner_payload().
void burn_structure_print_disc | ( | struct burn_disc * | d | ) |
void burn_structure_print_session | ( | struct burn_session * | s | ) |
void burn_structure_print_track | ( | struct burn_track * | t | ) |
void burn_track_clear_isrc | ( | struct burn_track * | t | ) |
Disable ISRC parameters for a track.
t | The track to change |
struct burn_track* burn_track_create | ( | void | ) |
void burn_track_define_data | ( | struct burn_track * | t, | |
int | offset, | |||
int | tail, | |||
int | pad, | |||
int | mode | |||
) |
Define the data in a track.
t | the track to define | |
offset | The lib will write this many 0s before start of data | |
tail | The number of extra 0s to write after data | |
pad | 1 means the lib should pad the last sector with 0s if the track isn't exactly sector sized. (otherwise the lib will begin reading from the next track) | |
mode | data format (bitfield) |
Referenced by libburner_payload().
void burn_track_free | ( | struct burn_track * | t | ) |
int burn_track_get_counters | ( | struct burn_track * | t, | |
off_t * | read_bytes, | |||
off_t * | written_bytes | |||
) |
Tells how many source bytes have been read and how many data bytes have been written by the track during burn.
void burn_track_get_entry | ( | struct burn_track * | t, | |
struct burn_toc_entry * | entry | |||
) |
Gets a copy of the toc_entry structure associated with a track.
t | Track to get the entry from | |
entry | Struct for the library to fill out |
int burn_track_get_mode | ( | struct burn_track * | track | ) |
Gets the mode of a track.
track | the track to query |
int burn_track_get_sectors | ( | struct burn_track * | ) |
Tells how long a track will be on disc >>> NOTE: Not reliable with tracks of undefined length.
int burn_track_set_byte_swap | ( | struct burn_track * | t, | |
int | swap_source_bytes | |||
) |
Define wether a track shall swap bytes of its input stream.
t | The track to change | |
swap_source_bytes | 0=do not swap, 1=swap byte pairs |
int burn_track_set_default_size | ( | struct burn_track * | t, | |
off_t | size | |||
) |
Set a default track size to be used only if the track turns out to be of unpredictable length and if the effective write type demands a fixed size.
This can be useful to enable write types CD SAO or DVD DAO together with a track source like stdin. If the track source delivers fewer bytes than announced then the track will be padded up with zeros.
t | The track to change | |
size | The size to set |
void burn_track_set_isrc | ( | struct burn_track * | t, | |
char * | country, | |||
char * | owner, | |||
unsigned char | year, | |||
unsigned int | serial | |||
) |
Set the ISRC details for a track.
t | The track to change | |
country | the 2 char country code. Each character must be only numbers or letters. | |
owner | 3 char owner code. Each character must be only numbers or letters. | |
year | 2 digit year. A number in 0-99 (Yep, not Y2K friendly). | |
serial | 5 digit serial number. A number in 0-99999. |
int burn_track_set_size | ( | struct burn_track * | t, | |
off_t | size | |||
) |
Sets a fixed track size after the data source object has already been created.
t | The track to poperate on | |
size | the number of bytes to use as track size |
enum burn_source_status burn_track_set_source | ( | struct burn_track * | t, | |
struct burn_source * | s | |||
) |
Set the track's data source.
t | The track to set the data source for | |
s | The data source to use for the contents of the track |
Referenced by libburner_payload().
void burn_version | ( | int * | major, | |
int * | minor, | |||
int * | micro | |||
) |
Returns the library's version in its parts.
major | The major version number | |
minor | The minor version number | |
micro | The micro version number |
enum burn_write_types burn_write_opts_auto_write_type | ( | struct burn_write_opts * | opts, | |
struct burn_disc * | disc, | |||
char | reasons[BURN_REASONS_LEN], | |||
int | flag | |||
) |
As an alternative to burn_write_opts_set_write_type() this function tries to find a suitable write type and block type for a given write job described by opts and disc.
To be used after all other setups have been made, i.e. immediately before burn_disc_write().
opts | The nearly complete write opts to change | |
disc | The already composed session and track model | |
reasons | This text string collects reasons for decision resp. failure | |
flag | Bitfield for control purposes: bit0= do not choose type but check the one that is already set bit1= do not issue error messages via burn_msgs queue (is automatically set with bit0) |
Referenced by libburner_payload().
void burn_write_opts_free | ( | struct burn_write_opts * | opts | ) |
Frees a write_opts struct created with burn_write_opts_new.
opts | write_opts to free |
Referenced by libburner_payload().
struct burn_write_opts* burn_write_opts_new | ( | struct burn_drive * | drive | ) |
Creates a write_opts struct for burning to the specified drive must be freed with burn_write_opts_free.
drive | The drive to write with |
Referenced by libburner_payload().
void burn_write_opts_set_fillup | ( | struct burn_write_opts * | opts, | |
int | fill_up_media | |||
) |
Caution: still immature and likely to change.
Problems arose with sequential DVD-RW on one drive.
Controls wether the whole available space of the media shall be filled up by the last track of the last session.
opts | The write opts to change | |
fill_up_media | If 1 : fill up by last track, if 0 = do not fill up |
void burn_write_opts_set_force | ( | struct burn_write_opts * | opts, | |
int | use_force | |||
) |
Eventually makes libburn ignore the failure of some conformance checks:
opts | The write opts to change | |
use_force | 1=ignore above checks, 0=refuse work on failed check |
void burn_write_opts_set_format | ( | struct burn_write_opts * | opts, | |
int | format | |||
) |
Sets the session format for a disc.
opts | The write opts to change | |
format | The session format to set |
void burn_write_opts_set_has_mediacatalog | ( | struct burn_write_opts * | opts, | |
int | has_mediacatalog | |||
) |
void burn_write_opts_set_mediacatalog | ( | struct burn_write_opts * | opts, | |
unsigned char | mediacatalog[13] | |||
) |
void burn_write_opts_set_multi | ( | struct burn_write_opts * | opts, | |
int | multi | |||
) |
Sets the multi flag which eventually marks the emerging session as not being the last one and thus creating a BURN_DISC_APPENDABLE media.
multi | 1=media will be appendable, 0=media will be closed (default) |
Referenced by libburner_payload().
void burn_write_opts_set_perform_opc | ( | struct burn_write_opts * | opts, | |
int | opc | |||
) |
Sets whether to use opc or not with the write_opts struct.
opts | The write opts to change | |
opc | If non-zero, optical power calibration will be performed at start of burn |
Referenced by libburner_payload().
int burn_write_opts_set_simulate | ( | struct burn_write_opts * | opts, | |
int | sim | |||
) |
Sets the simulate value for the write_opts struct.
opts | The write opts to change | |
sim | If non-zero, the drive will perform a simulation instead of a burn |
Referenced by libburner_payload().
void burn_write_opts_set_start_byte | ( | struct burn_write_opts * | opts, | |
off_t | value | |||
) |
Sets a start address for writing to media and write modes which allow to choose this address at all (DVD+RW, DVD-RAM, formatted DVD-RW only for now).
The address is given in bytes. If it is not -1 then a write run will fail if choice of start address is not supported or if the block alignment of the address is not suitable for media and write mode. (Alignment to 32 kB blocks is advised with DVD media.)
opts | The write opts to change | |
value | The address in bytes (-1 = start at default address) |
void burn_write_opts_set_toc_entries | ( | struct burn_write_opts * | opts, | |
int | count, | |||
struct burn_toc_entry * | toc_entries | |||
) |
Supplies toc entries for writing - not normally required for cd mastering.
opts | The write opts to change | |
count | The number of entries | |
toc_entries |
int burn_write_opts_set_underrun_proof | ( | struct burn_write_opts * | opts, | |
int | underrun_proof | |||
) |
Controls buffer underrun prevention.
opts | The write opts to change | |
underrun_proof | if non-zero, buffer underrun protection is enabled |
Referenced by libburner_payload().
int burn_write_opts_set_write_type | ( | struct burn_write_opts * | opts, | |
enum burn_write_types | write_type, | |||
int | block_type | |||
) |
Sets the write type for the write_opts struct.
Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix of data and audio tracks. You must use BURN_WRITE_TAO for such sessions.
opts | The write opts to change | |
write_type | The write type to use | |
block_type | The block type to use |