|
libburn
1.2.2
|
#include <sys/types.h>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 interface 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... | |
Macros | |
| #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_SCMS (1 << 13) |
| Track mode modifier - Serial Copy Management System, SAO only If this is set and BURN_COPY is not set, then copying the emerging track will be forbidden. | |
| #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 drive device file 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 | BURN_CDTEXT_LANGUAGES_0X00 |
| This is the first list of languages sorted by their Language codes, which start at 0x00. | |
| #define | BURN_CDTEXT_LANGUAGES_0X45 |
| This is the second list of languages sorted by their Language codes, which start at 0x45. | |
| #define | BURN_CDTEXT_FILLER |
| #define | BURN_CDTEXT_GENRE_LIST |
| This is the list of Genres sorted by their Genre codes. | |
| #define | BURN_CDTEXT_NUM_GENRES 28 |
| #define | burn_header_version_major 1 |
| These three release version numbers tell the revision of this header file and of the API it describes. | |
| #define | burn_header_version_minor 2 |
| #define | burn_header_version_micro 2 |
| #define | BURN_MSGS_MESSAGE_LEN 4096 |
| #define | LIBDAX_AUDIOXTR_STRLEN 4096 |
| #define | Libburn_dummy_probe_write_modeS 1 |
Typedefs | |
| typedef int(* | burn_abort_handler_t )(void *handle, int signum, int flag) |
| The prototype of a handler function suitable for burn_set_signal_handling() Such a function has to return -2 if it does not want the process to exit with value 1. | |
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 eventually 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_set_scsi_logging (int flag) |
| Enable resp. | |
| 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 device file address. | |
| 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_d_get_adr (struct burn_drive *drive, char adr[]) |
| Inquire the device file address of the given drive. | |
| int | burn_drive_get_adr (struct burn_drive_info *drive_info, char adr[]) |
| Inquire the device file address of a drive via a given drive_info object. | |
| int | burn_drive_is_enumerable_adr (char *adr) |
| Evaluate whether the given address would be a drive device file address which could be listed by a run of burn_drive_scan(). | |
| int | burn_drive_convert_fs_adr (char *path, char adr[]) |
| Try to convert a given existing filesystem address into a drive device file 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 drive device file address. | |
| int | burn_lookup_device_link (char *dev_adr, char link_adr[], char *dir_adr, char **templ, int num_templ, int flag) |
| Try to convert a given drive device file address into the address of a symbolic link that points to this 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. | |
| int | burn_drive_probe_cd_write_modes (struct burn_drive_info *drive_info) |
| int | burn_drive_snooze (struct burn_drive *d, int flag) |
| Calm down or alert a drive. | |
| int | burn_drive_re_assess (struct burn_drive *d, int flag) |
| Re-assess drive and media status. | |
| void | burn_drive_release (struct burn_drive *drive, int eject) |
| Release a drive. | |
| int | burn_drive_leave_locked (struct burn_drive *d, int flag) |
| Like burn_drive_release() but keeping the drive tray closed and its eject button disabled. | |
| 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. | |
| char * | burn_guess_cd_manufacturer (int m_li, int s_li, int f_li, int m_lo, int s_lo, int f_lo, int flag) |
| Guess the manufacturer name of CD media from the ATIP addresses of lead-in and lead-out. | |
| int | burn_disc_get_cd_info (struct burn_drive *d, char disc_type[80], unsigned int *disc_id, char bar_code[9], int *app_code, int *valid) |
| Retrieve some media information which is mainly specific to CD. | |
| int | burn_disc_get_leadin_text (struct burn_drive *d, unsigned char **text_packs, int *num_packs, int flag) |
| Read the array of CD-TEXT packs from the Lead-in of an audio CD. | |
| int | burn_disc_get_bd_spare_info (struct burn_drive *d, int *alloc_blocks, int *free_blocks, int flag) |
| Read the current usage of the eventual BD Spare Area. | |
| int | burn_disc_get_phys_format_info (struct burn_drive *d, int *disk_category, char **book_name, int *part_version, int *num_layers, int *num_blocks, int flag) |
| Retrieve some media information which is mainly specific to media of the DVD-R family: DVD-R , DVD-RW , DVD-R DL , HD DVD-R Currently the information cannot be retrieved from other media types. | |
| 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_next_track_is_damaged (struct burn_drive *d, int flag) |
| Tells whether a previous attempt to determine the Next Writeable Address of the upcomming track reveiled that the READ TRACK INFORMATION Damage Bit is set for this track, resp. | |
| int | burn_disc_close_damaged (struct burn_write_opts *o, int flag) |
| Try to close the last track and session of media which have bit0 set in the return value of call burn_disc_next_track_is_damaged(). | |
| 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_get_media_id (struct burn_drive *d, char **product_id, char **media_code1, char **media_code2, char **book_type, int flag) |
| Obtain product id and standards defined media codes. | |
| char * | burn_guess_manufacturer (int profile_no, char *manuf_code, char *media_code, int flag) |
| Guess the name of a manufacturer by profile number, manufacturer code and media code. | |
| 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. | |
| struct burn_write_opts * | burn_write_opts_new (struct burn_drive *drive) |
| Creates a write_opts struct for burning to the specified drive. | |
| struct burn_drive * | burn_write_opts_get_drive (struct burn_write_opts *opts) |
| Inquires the drive associated with a burn_write_opts object. | |
| void | burn_write_opts_free (struct burn_write_opts *opts) |
| Frees a write_opts struct created with burn_write_opts_new. | |
| 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. | |
| 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() whether 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. | |
| int | burn_drive_set_stream_recording (struct burn_drive *drive, int recmode, int start, int flag) |
| Control stream recording during the write run and eventually set the start LBA for stream recording. | |
| void | burn_drive_cancel (struct burn_drive *drive) |
| Cancel an operation on a drive. | |
| int | burn_drive_wrote_well (struct burn_drive *d) |
| Inquire whether the most recent asynchronous media job 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) | |
| struct 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. | |
| struct 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. | |
| int | burn_session_by_cue_file (struct burn_session *session, char *path, int fifo_size, struct burn_source **fifo, unsigned char **text_packs, int *num_packs, int flag) |
| Read a CDRWIN cue sheet file and equip the session object by tracks and CD-TEXT according to the content of the file. | |
| struct burn_track * | burn_track_create (void) |
| Create a track. | |
| 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. | |
| int | burn_session_set_start_tno (struct burn_session *session, int tno, int flag) |
| Set the number which shall be written as CD track number with the first track of the session. | |
| int | burn_session_get_start_tno (struct burn_session *session, int flag) |
| Inquire the CD track start number, as set by default ot by burn_session_set_start_tno(). | |
| int | burn_session_set_cdtext_par (struct burn_session *s, int char_codes[8], int copyrights[8], int languages[8], int flag) |
| Set the Character Codes, the Copyright bytes, and the Language Codes for CD-TEXT blocks 0 to 7. | |
| int | burn_session_get_cdtext_par (struct burn_session *s, int char_codes[8], int copyrights[8], int block_languages[8], int flag) |
| Obtain the current settings as of burn_session_set_cdtext_par() resp. | |
| int | burn_session_set_cdtext (struct burn_session *s, int block, int pack_type, char *pack_type_name, unsigned char *payload, int length, int flag) |
| Attach text or binary data as CD-TEXT attributes to a session. | |
| int | burn_session_get_cdtext (struct burn_session *s, int block, int pack_type, char *pack_type_name, unsigned char **payload, int *length, int flag) |
| Obtain a CD-TEXT attribute that was set by burn_session_set_cdtext() | |
| int | burn_session_input_sheet_v07t (struct burn_session *session, char *path, int block, int flag) |
| Read a Sony CD-TEXT Input Sheet Version 0.7T file and attach its text attributes to the given session and its tracks for the given CD-TEXT block number. | |
| int | burn_cdtext_from_session (struct burn_session *s, unsigned char **text_packs, int *num_packs, int flag) |
| Produce an array of CD-TEXT packs that could be submitted to burn_write_opts_set_leadin_text() or stored as *.cdt file. | |
| int | burn_session_dispose_cdtext (struct burn_session *s, int block) |
| Remove all CD-TEXT attributes of the given block from the session. | |
| int | burn_cdtext_from_packfile (char *path, unsigned char **text_packs, int *num_packs, int flag) |
| Read an array of CD-TEXT packs from a file. | |
| 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_cdtext (struct burn_track *t, int block, int pack_type, char *pack_type_name, unsigned char *payload, int length, int flag) |
| Attach text or binary data as CD-TEXT attributes to a track. | |
| int | burn_track_get_cdtext (struct burn_track *t, int block, int pack_type, char *pack_type_name, unsigned char **payload, int *length, int flag) |
| Obtain a CD-TEXT attribute that was set by burn_track_set_cdtext(). | |
| int | burn_track_dispose_cdtext (struct burn_track *t, int block) |
| Remove all CD-TEXT attributes of the given block from the track. | |
| int | burn_track_set_cdxa_conv (struct burn_track *t, int value) |
| Activates CD XA compatibility modes. | |
| 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. | |
| int | burn_track_set_isrc_string (struct burn_track *t, char isrc[13], int flag) |
| Set the composed ISRC string for a track. | |
| void | burn_track_clear_isrc (struct burn_track *t) |
| Disable ISRC parameters for a track. | |
| int | burn_track_set_index (struct burn_track *t, int index_number, unsigned int relative_lba, int flag) |
| Define an index start address within a track. | |
| int | burn_track_clear_indice (struct burn_track *t, int flag) |
| Remove all index start addresses and reset to the default indexing of CD SAO sessions. | |
| int | burn_track_set_pregap_size (struct burn_track *t, int size, int flag) |
| Define whether a pre-gap shall be written before the track and how many sectors this pre-gap shall have. | |
| int | burn_track_set_postgap_size (struct burn_track *t, int size, int flag) |
| Define whether a post-gap shall be written at the end of the track and how many sectors this gap shall have. | |
| int | burn_track_set_byte_swap (struct burn_track *t, int swap_source_bytes) |
| Define whether a track shall swap bytes of its input stream. | |
| void | burn_session_hide_first_track (struct burn_session *s, int onoff) |
| Hide the first track in the "pre gap" of the disc. | |
| struct 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) | |
| 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) | |
| int | burn_os_open_track_src (char *path, int open_flags, int flag) |
| Opens a file with eventual acceleration preparations which may depend on the operating system and on compile time options of libburn. | |
| void * | burn_os_alloc_buffer (size_t amount, int flag) |
| Allocate a memory area that is suitable for reading with a file descriptor opened by burn_os_open_track_src(). | |
| int | burn_os_free_buffer (void *buffer, size_t amount, int flag) |
| Dispose a memory area which was obtained by burn_os_alloc_buffer(),. | |
| 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. | |
| struct burn_source * | burn_offst_source_new (struct burn_source *inp, struct burn_source *prev, off_t start, off_t size, int flag) |
| Creates an offset source which shall provide a byte interval of a stream to its consumer. | |
| struct burn_source * | burn_fifo_source_new (struct burn_source *inp, int chunksize, int chunks, int flag) |
| Creates a fifo which acts as proxy for an already existing data source. | |
| int | burn_fifo_inquire_status (struct burn_source *fifo, int *size, int *free_bytes, char **status_text) |
| Inquires state and fill parameters of a fifo burn_source which was created by burn_fifo_source_new() . | |
| void | burn_fifo_get_statistics (struct burn_source *fifo, int *total_min_fill, int *interval_min_fill, int *put_counter, int *get_counter, int *empty_counter, int *full_counter) |
| Inquire various counters which reflect the fifo operation. | |
| void | burn_fifo_next_interval (struct burn_source *fifo, int *interval_min_fill) |
| Inquire the fifo minimum fill counter for intervals and reset that counter. | |
| int | burn_fifo_peek_data (struct burn_source *fifo, char *buf, int bufsize, int flag) |
| Obtain a preview of the first input data of a fifo which was created by burn_fifo_source_new(). | |
| int | burn_fifo_fill (struct burn_source *fifo, int fill, int flag) |
| Start the fifo worker thread and wait either until the requested number of bytes have arrived or until it becomes clear that this will not happen. | |
| 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 many sectors a track will have on disc, resp. | |
| 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_mediacatalog (struct burn_write_opts *opts, unsigned char mediacatalog[13]) |
| The Q sub-channel of a CD may contain a Media Catalog Number of 13 decimal digits. | |
| void | burn_write_opts_set_has_mediacatalog (struct burn_write_opts *opts, int has_mediacatalog) |
| This call activates the Media Catalog Number for writing. | |
| 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. | |
| int | burn_write_opts_set_leadin_text (struct burn_write_opts *opts, unsigned char *text_packs, int num_packs, int flag) |
| Submit an array of CD-TEXT packs which shall be written to the Lead-in of a SAO write run on CD. | |
| 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 (for now: DVD+RW, DVD-RAM, formatted DVD-RW). | |
| 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_write_opts_set_stream_recording (struct burn_write_opts *opts, int value) |
| Eventually makes use of the more modern write command AAh WRITE12 and sets the Streaming bit. | |
| void | burn_write_opts_set_dvd_obs (struct burn_write_opts *opts, int obs) |
| Overrides the write chunk size for DVD and BD media which is normally determined according to media type and setting of stream recording. | |
| void | burn_write_opts_set_stdio_fsync (struct burn_write_opts *opts, int rythm) |
| Sets the rythm by which stdio pseudo drives force their output data to be consumed by the receiving storage device. | |
| 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_all_profiles (struct burn_drive *d, int *num_profiles, int profiles[64], char is_current[64]) |
| Gets the list of profile codes supported by the drive. | |
| int | burn_obtain_profile_name (int profile_code, char name[80]) |
| Obtains the profile name associated with a profile code. | |
| 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. | |
| 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. | |
| int | burn_disc_get_sectors (struct burn_disc *d) |
| 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. | |
| 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. | |
| char * | burn_scsi_transport_id (int flag) |
| Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time. | |
| 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. | |
| int | burn_msgs_submit (int error_code, char msg_text[], int os_errno, char severity[], struct burn_drive *d) |
| Submit a message to the libburn queueing system. | |
| int | burn_text_to_sev (char *severity_name, int *severity_number, int flag) |
| Convert a severity name into a severity number, which gives the severity rank of the name. | |
| int | burn_sev_to_text (int severity_number, char **severity_name, int flag) |
| Convert a severity number into a severity name. | |
| int | burn_set_messenger (void *messenger) |
| Replace the messenger object handle of libburn by a compatible handle obtained from a related library. | |
| void | burn_set_signal_handling (void *handle, burn_abort_handler_t handler, int mode) |
| Control built-in signal handling. | |
| int | burn_is_aborting (int flag) |
| int | burn_random_access_write (struct burn_drive *d, off_t byte_address, char *data, off_t data_count, int flag) |
| Write data in random access mode. | |
| int | burn_get_read_capacity (struct burn_drive *d, int *capacity, int flag) |
| Inquire the maximum amount of readable data. | |
| int | burn_read_data (struct burn_drive *d, off_t byte_address, char data[], off_t data_size, off_t *data_count, int flag) |
| Read data in random access mode. | |
| int | burn_drive_get_drive_role (struct burn_drive *d) |
| Inquire whether the drive object is a real MMC drive or a pseudo-drive created by a stdio: address. | |
| void | burn_allow_drive_role_4 (int allowed) |
| Allow drive role 4 "random access read-only" and drive role 5 "random access write-only". | |
| int | burn_drive_equals_adr (struct burn_drive *d1, char *adr2, int drive_role2) |
| Find out whether a given address string would lead to the given drive object. | |
| int | libdax_audioxtr_new (struct libdax_audioxtr **xtr, char *path, int flag) |
| Open an audio file, check wether suitable, create extractor object. | |
| int | libdax_audioxtr_get_id (struct libdax_audioxtr *xtr, char **fmt, char **fmt_info, int *num_channels, int *sample_rate, int *bits_per_sample, int *msb_first, int flag) |
| Obtain identification parameters of opened audio source. | |
| int | libdax_audioxtr_get_size (struct libdax_audioxtr *o, off_t *size, int flag) |
| Obtain a prediction about the extracted size based on internal information of the formatted file. | |
| int | libdax_audioxtr_read (struct libdax_audioxtr *xtr, char buffer[], int buffer_size, int flag) |
| Obtain next buffer full of extracted data in desired format (only raw audio for now). | |
| int | libdax_audioxtr_detach_fd (struct libdax_audioxtr *o, int *fd, int flag) |
| Try to obtain a file descriptor which will deliver extracted data to normal calls of read(2). | |
| int | libdax_audioxtr_destroy (struct libdax_audioxtr **xtr, int flag) |
| Clean up after extraction and destroy extractor object. | |
| #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 110 of file libburn.h.
Referenced by libburner_payload(), and libburner_setup().
| #define BURN_CDI 0x10 |
| #define BURN_CDROM 0 |
| #define BURN_CDTEXT_FILLER |
| #define BURN_CDTEXT_GENRE_LIST |
This is the list of Genres sorted by their Genre codes.
E.g. genre code 0x0000 is "No Used", 0x0008 is "Dance, 0x0010 is "Musical", 0x0018 is "Rhythm & Blues", 0x001b is "World Music". See also file doc/cdtext.txt.
| #define BURN_CDTEXT_LANGUAGES_0X00 |
This is the first list of languages sorted by their Language codes, which start at 0x00.
They stem from from EBU Tech 3264, appendix 3. E.g. language 0x00 is "Unknown", 0x08 is "German", 0x10 is "Frisian", 0x18 is "Latvian", 0x20 is "Polish", 0x28 is "Swedish", 0x2b is "Wallon". See also file doc/cdtext.txt.
| #define BURN_CDTEXT_LANGUAGES_0X45 |
This is the second list of languages sorted by their Language codes, which start at 0x45.
They stem from from EBU Tech 3264, appendix 3. E.g. language 0x45 is "Zulu", 0x50 is "Sranan Tongo", 0x58 is "Pushtu", 0x60 is "Moldavian", 0x68 is "Kannada", 0x70 is "Greek", 0x78 is "Bengali", 0x7f is "Amharic". See also file doc/cdtext.txt.
| #define BURN_COPY (1 << 8) |
| #define BURN_DRIVE_ADR_LEN 1024 |
Maximum length+1 to expect with a drive device file address string.
Definition at line 1007 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 |
Possible formatting status values.
Definition at line 1654 of file libburn.h.
Referenced by libburner_format().
| #define burn_header_version_major 1 |
These three release version numbers tell the revision of this header file and of the API it describes.
They are memorized by applications at build time. Immediately after burn_initialize() an application should do this check: burn_version(&major, &minor, µ); if(major > burn_header_version_major || (major == burn_header_version_major && (minor > burn_header_version_minor || (minor == burn_header_version_minor && micro >= burn_header_version_micro)))) { ... Young enough. Go on with program run .... } else { ... Too old. Do not use this libburn version ... }
| #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 89 of file libburn.h.
Referenced by libburner_payload().
| #define BURN_MODE2 (1 << 3) |
| #define BURN_MODE_RAW (1 << 1) |
| #define BURN_POS_END 100 |
Definition at line 73 of file libburn.h.
Referenced by libburner_payload().
| #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 1718 of file libburn.h.
Referenced by libburner_payload().
| #define BURN_SCMS (1 << 13) |
| #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) |
The prototype of a handler function suitable for burn_set_signal_handling() Such a function has to return -2 if it does not want the process to exit with value 1.
| enum burn_block_types |
Data format to send to the drive.
Definition at line 188 of file libburn.h.
| enum burn_disc_status |
Possible status of the drive in regard to the disc in it.
| BURN_DISC_UNREADY |
The current status is not yet known. |
| BURN_DISC_BLANK |
The drive holds a blank disc. It is ready for writing from scratch. Unused multi-session media: CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R Blanked multi-session media (i.e. treated by burn_disc_erase()) CD-RW, DVD-RW Overwriteable media with or without valid data DVD-RAM, DVD+RW, formatted DVD-RW, BD-RE |
| BURN_DISC_EMPTY |
There is no disc at all in the drive. |
| BURN_DISC_APPENDABLE |
There is an incomplete disc in the drive. It is ready for appending another session. Written but not yet closed multi-session media CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R |
| BURN_DISC_FULL |
There is a disc with data on it in the drive. It is usable only for reading. Written and closed multi-session media CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R Read-Only media CD-ROM, DVD-ROM, BD-ROM Note that many DVD-ROM drives report any written media as Read-Only media and not by their real media types. |
| BURN_DISC_UNGRABBED |
The drive was not grabbed when the status was inquired. |
| BURN_DISC_UNSUITABLE |
The media seems to be unsuitable for reading and for writing. |
Definition at line 228 of file libburn.h.
| enum burn_drive_status |
Possible busy states for a drive.
Definition at line 289 of file libburn.h.
| 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 277 of file libburn.h.
| enum burn_write_types |
Possible disc writing style/modes.
Definition at line 134 of file libburn.h.
| int burn_abort | ( | int | patience, |
| int(*)(void *handle, int patience, int elapsed) | pacifier_func, | ||
| void * | handle | ||
| ) |
Abort any running drive operation and eventually call burn_finish().
You MUST shut down the busy drives 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 built-in signal handling: burn_set_signal_handling("my_app_name : ", NULL, 0); Else you may eventually call burn_drive_cancel() on the active drives and wait for them 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 |
Referenced by main().
| 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 |
Referenced by main().
| void burn_allow_drive_role_4 | ( | int | allowed | ) |
Allow drive role 4 "random access read-only" and drive role 5 "random access write-only".
By default a random access file assumes drive role 2 "read-write" regardless whether it is actually readable or writeable. If enabled, random-access file objects which recognizably allow no writing will be classified as role 4 and those which allow no reading will get role 5. Candidates are drive addresses of the form stdio:/dev/fd/# , where # is the integer number of an open file descriptor. If this descriptor was opened read-only resp. write-only, then it gets role 4 resp. role 5. Other paths may get tested by an attempt to open them for read-write (role 2) resp. read-only (role 4) resp. write-only (role 5). See bit1.
| allowed | Bitfield for control purposes: bit0= Enable roles 4 and 5 for drives which get aquired after this call bit1= with bit0: Test whether the file can be opened for read-write resp. read-only resp. write-only. Classify as roles 2 resp. 4 resp. 5. bit2= with bit0 and bit1: Classify files which cannot be opened at all as role 0 : useless dummy. Else classify as role 2. bit3= Classify non-empty role 5 drives as BURN_DISC_APPENDABLE with Next Writeable Address after the end of the file. It is nevertheless possible to change this address by call burn_write_opts_set_start_byte(). |
| 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.
| yes | 1=allow all implemented profiles, 0=only tested media (default) |
| int burn_cdtext_from_packfile | ( | char * | path, |
| unsigned char ** | text_packs, | ||
| int * | num_packs, | ||
| int | flag | ||
| ) |
Read an array of CD-TEXT packs from a file.
This array should be suitable for burn_write_opts_set_leadin_text(). The function tolerates and removes 4-byte headers as produced by cdrecord -vv -toc, if this header tells the correct number of bytes which matches the file size. If no 4-byte header is present, then the function tolerates and removes a trailing 0-byte as of Sony specs.
| path | Filesystem address of the CD-TEXT pack file. Normally with suffix .cdt or .dat |
| text_packs | Will return the buffer with the CD-TEXT packs. Dispose by free() when no longer needed. |
| num_packs | Will return the number of 18 byte text packs. |
| flag | Bitfield for control purposes. Unused yet.Submit 0. |
| int burn_cdtext_from_session | ( | struct burn_session * | s, |
| unsigned char ** | text_packs, | ||
| int * | num_packs, | ||
| int | flag | ||
| ) |
Produce an array of CD-TEXT packs that could be submitted to burn_write_opts_set_leadin_text() or stored as *.cdt file.
For a description of the format of the array, see file doc/cdtext.txt. The input data stem from burn_session_set_cdtext_par(), burn_session_set_cdtext(), and burn_track_set_cdtext().
| s | Session from which to produce CD-TEXT packs. |
| text_packs | Will return the buffer with the CD-TEXT packs. Dispose by free() when no longer needed. |
| num_packs | Will return the number of 18 byte text packs. |
| flag | Bitfield for control purposes. bit0= do not return generated CD-TEXT packs, but check whether production would work and indicate the number of packs by the call return value. This happens also if (text_packs == NULL || num_packs == NULL). |
| 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. If the drive is actually a file in a large filesystem or a large block device, then the capacity is curbed to a maximum of 0x7ffffff0 blocks = 4 TB - 32 KB.
| d | The drive to query. |
| o | If not NULL: write parameters to be set on drive before query |
| int burn_disc_close_damaged | ( | struct burn_write_opts * | o, |
| int | flag | ||
| ) |
Try to close the last track and session of media which have bit0 set in the return value of call burn_disc_next_track_is_damaged().
Whether it helps depends much on the reason why the media is reported as damaged by the drive. This call works only for profiles 0x09 CD-R, 0x0a CD-RW, 0x11 DVD-R, 0x14 DVD-RW sequential, 0x1b DVD+R, 0x2b DVD+R DL, 0x41 BD-R sequential. Note: After writing it is advised to give up the drive and to grab it again in order to learn about its view on the new media state.
| o | Write options created by burn_write_opts_new() and manipulated by burn_write_opts_set_multi(). burn_write_opts_set_write_type() should be set to BURN_WRITE_TAO, burn_write_opts_set_simulate() should be set to 0. |
| flag | Bitfield for control purposes bit0= force close, even if no damage was seen |
|
read |
Create a new disc.
Referenced by libburner_payload().
| int burn_disc_erasable | ( | struct burn_drive * | d | ) |
Tells whether a disc can be erased or not.
| d | The drive to inquire. |
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. Only drive roles 1 (MMC) and 5 (stdio random write-only) support erasing. |
| 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. DVD-RAM and BD-RE may get formatted initially or re-formatted to adjust their Defect Managment. This function usually returns while the drive is still in the process of formatting. The formatting is done, when burn_drive_get_status() returns BURN_DRIVE_IDLE. This may be immediately after return or may need several thousand seconds to occur.
| 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 and on parameter flag. |
| flag | Bitfield for control purposes: bit0= after formatting, write the given number of zero-bytes to the media and eventually perform preliminary closing. bit1+2: size mode 0 = use parameter size as far as it makes sense 1 = insist in size 0 even if there is a better default known (on DVD-RAM or BD-R identical to size mode 0, i.e. they never get formatted with payload size 0) 2 = without bit7: format to maximum available size with bit7 : take size from indexed format descriptor 3 = without bit7: format to default size with bit7 : take size from indexed format descriptor bit3= -reserved- bit4= enforce re-format of (partly) formatted media bit5= try to disable eventual defect management bit6= try to avoid lengthy media certification bit7, bit8 to bit15 = bit7 enables MMC expert application mode (else libburn tries to choose a suitable format type): If it is set then 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, 0x01, 0x10, 0x11, 0x13, 0x15, 0x26, 0x30, 0x31, 0x32. If bit7 is set, then bit4 is set automatically. bit16= enable POW on blank BD-R |
Referenced by libburner_format().
| 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_bd_spare_info | ( | struct burn_drive * | d, |
| int * | alloc_blocks, | ||
| int * | free_blocks, | ||
| int | flag | ||
| ) |
Read the current usage of the eventual BD Spare Area.
This area gets reserved on BD media during formatting. During writing it is used to host replacements of blocks which failed the checkread immediately after writing. This call applies only to recordable BD media. I.e. profiles 0x41 to 0x43.
| d | The drive to query. |
| alloc_blocks | Returns the number of blocks reserved as Spare Area |
| free_blocks | Returns the number of yet unused blocks in that area |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| int burn_disc_get_cd_info | ( | struct burn_drive * | d, |
| char | disc_type[80], | ||
| unsigned int * | disc_id, | ||
| char | bar_code[9], | ||
| int * | app_code, | ||
| int * | valid | ||
| ) |
Retrieve some media information which is mainly specific to CD.
For other media only the bits in reply parameter valid are supposed to be meaningful.
| d | The drive to query. |
| disc_type | A string saying either "CD-DA or CD-ROM", or "CD-I", or ""CD-ROM XA", or "undefined". |
| disc_id | A 32 bit number read from the media. (Meaning unclear yet) |
| bar_code | 8 hex digits from a barcode on media read by the drive (if the drive has a bar code reader built in). |
| app_code | The Host Application Code which must be set in the Write Parameters Page if the media is not unrestricted (URU==0). |
| valid | Replies bits which indicate the validity of other reply parameters or the state of certain CD info bits: bit0= disc_type is valid bit1= disc_id is valid bit2= bar_code is valid bit3= disc_app_code is valid bit4= Disc is unrestricted (URU bit, 51h READ DISC INFO) This seems to be broken with my drives. The bit is 0 and the validity bit for disc_app_code is 0 too. bit5= Disc is nominally erasable (Erasable bit) This will be set with overwriteable media which libburn normally considers to be unerasable blank. |
| 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, 0x30=BD-RE with spare areas, 0x31=BD-RE without spare areas |
| 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. |
Referenced by libburner_format().
| int burn_disc_get_leadin_text | ( | struct burn_drive * | d, |
| unsigned char ** | text_packs, | ||
| int * | num_packs, | ||
| int | flag | ||
| ) |
Read the array of CD-TEXT packs from the Lead-in of an audio CD.
Each pack consists of 18 bytes, of which 4 are header. 12 bytes are pieces of 0-terminated texts or binary data. 2 bytes hold a CRC. For a description of the format of the array, see file doc/cdtext.txt.
| d | The drive to query. |
| text_packs | Will point to an allocated memory buffer with CD-TEXT. It will only contain text packs, and not be prepended by the TOC header of four bytes, which gets stored with file cdtext.dat by cdrecord -vv -toc. (The first two of these bytes are supposed to hold the number of CD-TEXT bytes + 2. The other two bytes are supposed to be 0.) Dispose this buffer by free(), when no longer needed. |
| num_packs | Will tell the number of text packs, i.e. the number of bytes in text_packs divided by 18. |
| flag | Bitfield for control purposes, Unused yet. Submit 0. |
| int burn_disc_get_media_id | ( | struct burn_drive * | d, |
| char ** | product_id, | ||
| char ** | media_code1, | ||
| char ** | media_code2, | ||
| char ** | book_type, | ||
| int | flag | ||
| ) |
Obtain product id and standards defined media codes.
The product id is a printable string which is supposed to be the same for identical media but should vary with non-identical media. Some media do not allow to obtain such an id at all. The pair (profile_number, product_id) should be the best id to identify media with identical product specifications. The reply parameters media_code1 and media_code2 can be used with burn_guess_manufacturer() The reply parameters have to be disposed by free() when no longer needed.
| d | The drive where the media is inserted. |
| product_id | Reply: Printable text depicting manufacturer and eventually media id. |
| media_code1 | Reply: The eventual manufacturer identification as read from DVD/BD media or a text "XXmYYsZZf" from CD media ATIP lead-in. |
| media_code2 | The eventual media id as read from DVD+/BD media or a text "XXmYYsZZf" from CD ATIP lead-out. |
| book_type | Book type text for DVD and BD. Caution: is NULL with CD, even if return value says ok. |
| flag | Bitfield for control purposes bit0= do not escape " _/" (not suitable for burn_guess_manufacturer()) |
| 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_phys_format_info | ( | struct burn_drive * | d, |
| int * | disk_category, | ||
| char ** | book_name, | ||
| int * | part_version, | ||
| int * | num_layers, | ||
| int * | num_blocks, | ||
| int | flag | ||
| ) |
Retrieve some media information which is mainly specific to media of the DVD-R family: DVD-R , DVD-RW , DVD-R DL , HD DVD-R Currently the information cannot be retrieved from other media types.
| d | The drive to query. |
| disk_category | returns DVD Book to which the media complies |
| book_name | returns a pointer to the book name of disk_category. This memory is static. Do not alter or free it ! |
| part_version | returns the Media Version in the DVD Book |
| num_layers | returns the number of media layers |
| num_blocks | returns the number of blocks between pysical start and physical end of the media |
| 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 sequential recording" 0x12 "DVD-RAM" 0x13 "DVD-RW restricted overwrite" 0x14 "DVD-RW sequential recording", 0x15 "DVD-R/DL sequential recording", 0x1a "DVD+RW" 0x1b "DVD+R", 0x2b "DVD+R/DL", 0x41 "BD-R sequential recording", 0x43 "BD-RE", 0xffff "stdio file" Note: 0xffff is not a MMC profile but a libburn invention. Read-only are the profiles 0x08 "CD-ROM", 0x10 "DVD-ROM", 0x40 "BD-ROM", Read-only for now is this BD-R profile (testers wanted) 0x42 "BD-R random recording" Empty drives are supposed to report 0x00 ""
| d | The drive where the media is inserted. |
| pno | Profile Number. See also mmc5r03c.pdf, table 89 |
| name | Profile Name (see above list, unknown profiles have empty name) |
Referenced by libburner_aquire_drive(), and libburner_format().
| int burn_disc_get_sectors | ( | struct burn_disc * | d | ) |
|
read |
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(), libburner_format(), and libburner_payload().
| int burn_disc_next_track_is_damaged | ( | struct burn_drive * | d, |
| int | flag | ||
| ) |
Tells whether a previous attempt to determine the Next Writeable Address of the upcomming track reveiled that the READ TRACK INFORMATION Damage Bit is set for this track, resp.
that no valid writable address is available. See MMC-5 6.27.3.7 Damage Bit, 6.27.3.11 NWA_V (NWA valid)
| d | The drive to query. |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| 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 The first existing track on a CD may have a number higher than 1. Use burn_session_get_start_tno() to inquire this start number. |
| 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(). Note: This function is not suitable for overwriting data in the middle of a valid data area because it is allowed to append trailing data. For exact random access overwriting use burn_random_access_write(). Note: After writing it is advised to give up the drive and to grab it again in order to learn about its view on the new media state. Note: Before mounting the written media it might be necessary to eject and reload in order to allow the operating system to notice the new media state.
| 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 drive device file 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 device file 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 drive device file 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 device file address gets copied to it. |
| int burn_drive_d_get_adr | ( | struct burn_drive * | drive, |
| char | adr[] | ||
| ) |
Inquire the device file address of the given drive.
| drive | The drive to inquire. |
| adr | An application provided array of at least BURN_DRIVE_ADR_LEN characters size. The device file address gets copied to it. |
| int burn_drive_equals_adr | ( | struct burn_drive * | d1, |
| char * | adr2, | ||
| int | drive_role2 | ||
| ) |
Find out whether a given address string would lead to the given drive object.
This should be done in advance for track source addresses with parameter drive_role set to 2. Although a real MMC drive should hardly exist as two drive objects at the same time, this can easily happen with stdio-drives. So if more than one drive is used by the application, then this gesture is advised: burn_drive_d_get_adr(d2, adr2); if (burn_drive_equals_adr(d1, adr2, burn_drive_get_drive_role(d2))) ... Both drive objects point to the same storage facility ...
| d1 | Existing drive object |
| adr2 | Address string to be tested. Prefix "stdio:" overrides parameter drive_role2 by either 0 or 2 as appropriate. The string must be shorter than BURN_DRIVE_ADR_LEN. |
| drive_role2 | Role as burn_drive_get_drive_role() would attribute to adr2 if it was a drive. Use value 2 for checking track sources resp. pseudo-drive addresses without "stdio:". Use 1 for checking drive addresses including those with prefix "stdio:". |
| 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 device file address of a drive via a given drive_info object.
(Note: This is a legacy call.)
| 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 device file address gets copied to it. |
Referenced by libburner_aquire_by_driveno().
| int burn_drive_get_all_profiles | ( | struct burn_drive * | d, |
| int * | num_profiles, | ||
| int | profiles[64], | ||
| char | is_current[64] | ||
| ) |
Gets the list of profile codes supported by the drive.
Profiles depict the feature sets which constitute media types. For known profile codes and names see burn_disc_get_profile().
| d | is the drive to query |
| num_profiles | returns the number of supported profiles |
| profiles | returns the profile codes |
| is_current | returns the status of the corresponding profile code: 1= current, i.e. the matching media is loaded 0= not current, i.e. the matching media is not loaded |
| 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 whether 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) |
|
read |
Get the drive's disc struct - free when done.
| d | drive to query |
| int burn_drive_get_drive_role | ( | struct burn_drive * | d | ) |
Inquire whether the drive object is a real MMC drive or a pseudo-drive created by a stdio: address.
| d | The drive to inquire |
| 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(), 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 whether the given address would be a drive device file address which could be listed by a run of burn_drive_scan().
No check is made whether a device file with this address exists or whether it leads to a usable MMC drive.
| int burn_drive_leave_locked | ( | struct burn_drive * | d, |
| int | flag | ||
| ) |
Like burn_drive_release() but keeping the drive tray closed and its eject button disabled.
This physically locked drive state will last until the drive is grabbed again and released via burn_drive_release(). Programs like eject, cdrecord, growisofs will break that ban too.
| d | The drive to release and leave locked. |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| 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 drive device file address obtained via burn_drive_d_get_adr(). It is also supposed to succeed with any device file of a (possibly emulated) SCSI device.
| int burn_drive_probe_cd_write_modes | ( | struct burn_drive_info * | drive_info | ) |
| int burn_drive_re_assess | ( | struct burn_drive * | d, |
| int | flag | ||
| ) |
Re-assess drive and media status.
This should be done after a drive underwent a status change and shall be further used without intermediate burn_drive_release(), burn_drive_grab(). E.g. after blanking or burning.
| drive | The already grabbed drive to re-assess. |
| flag | Unused yet. Submit 0. |
| 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).
| 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. In case of re-scanning: All pointers to struct burn_drive and all struct burn_drive_info arrays are invalidated by using this function. Do NOT store drive pointers across calls to this function ! To avoid invalid pointers one MUST free all burn_drive_info arrays by burn_drive_info_free() before calling burn_drive_scan() a second time. If there are drives left, then burn_drive_scan() will refuse to work.
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 device file 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_d_get_adr(drive_infos[driveno].drive,adr). Another way is to drop the unwanted drives by burn_drive_info_forget().
Operating on multiple drives:
Different than with burn_drive_scan() it is allowed to call burn_drive_scan_and_grab() without giving up any other scanned drives. So this call can be used to get a collection of more than one aquired drives. The attempt to aquire the same drive twice will fail, though.
Pseudo-drives:
burn_drive_scan_and_grab() is able to aquire virtual drives which will accept options much like a MMC burner drive. Many of those options will not cause any effect, though. The address of a pseudo-drive begins with prefix "stdio:" followed by a path. Examples: "stdio:/tmp/pseudo_drive" , "stdio:/dev/null" , "stdio:-"
If the path is empty, the result is a null-drive = drive role 0. It pretends to have loaded no media and supports no reading or writing.
If the path leads to an existing regular file, or to a not yet existing file, or to an existing block device, then the result is a random access stdio-drive capable of reading and writing = drive role 2.
If the path leads to an existing file of any type other than directory, then the result is a sequential write-only stdio-drive = drive role 3.
The special address form "stdio:/dev/fd/{number}" is interpreted literally as reference to open file descriptor {number}. This address form coincides with real files on some systems, but it is in fact hardcoded in libburn. Special address "stdio:-" means stdout = "stdio:/dev/fd/1". The role of such a drive is determined by the file type obtained via fstat({number}).
Roles 2 and 3 perform all their eventual data transfer activities on a file via standard i/o functions open(2), lseek(2), read(2), write(2), close(2). The media profile is reported as 0xffff. Write space information from those media is not necessarily realistic.
The capabilities of role 2 resemble DVD-RAM but it can simulate writing. If the path does not exist in the filesystem yet, it is attempted to create it as a regular file as soon as write operations are started.
The capabilities of role 3 resemble a blank DVD-R. Nevertheless each burn_disc_write() run may only write a single track.
One may distinguish pseudo-drives from MMC drives by call burn_drive_get_drive_role().
| 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. This is a result from call burn_drive_scan(). See there. Use with driveno 0 only. |
| adr | The device file address of the desired drive. Either once obtained by burn_drive_d_get_adr() or composed skillfully by application resp. its user. E.g. "/dev/sr0". Consider to preprocess it by burn_drive_convert_fs_adr(). |
| 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 whether 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_set_stream_recording | ( | struct burn_drive * | drive, |
| int | recmode, | ||
| int | start, | ||
| int | flag | ||
| ) |
Control stream recording during the write run and eventually set the start LBA for stream recording.
Stream recording is set from struct burn_write_opts when the write run gets started. See burn_write_opts_set_stream_recording(). The call described here can be used later to override this setting and to program automatic switching at a given LBA. It also affects subsequent calls to burn_random_access_write().
| drive | The drive which performs the write operation. |
| recmode | -1= disable stream recording 0= leave setting as is 1= enable stream recording |
| start | The LBA where actual stream recording shall start. (0 means unconditional stream recording) |
| flag | Bitfield for control purposes (unused yet, submit 0). |
| int burn_drive_snooze | ( | struct burn_drive * | d, |
| int | flag | ||
| ) |
Calm down or alert a drive.
Some drives stay alert after reading for quite some time. This saves time with the startup for the next read operation but also causes noise and consumes extra energy. It makes sense to calm down the drive if no read operation is expected for the next few seconds. The drive will get alert automatically if operations are required.
| d | The drive to influence. |
| flag | Bitfield for control purposes bit0= become alert (else start snoozing) This is not mandatory to allow further drive operations |
| int burn_drive_wrote_well | ( | struct burn_drive * | d | ) |
Inquire whether the most recent asynchronous media job was successful.
This applies to burn_disc_erase(), burn_disc_format(), burn_disc_write(). Reasons for non-success may be: rejection of burn parameters, abort due to fatal errors during write, blank or format, a call to burn_drive_cancel() by the application thread.
| d | The drive to inquire. |
|
read |
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 of subchannel data. Only used in exotic raw write modes. Submit -1 for normal tasks. |
| 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().
| int burn_fifo_fill | ( | struct burn_source * | fifo, |
| int | fill, | ||
| int | flag | ||
| ) |
Start the fifo worker thread and wait either until the requested number of bytes have arrived or until it becomes clear that this will not happen.
Filling will go on asynchronously after burn_fifo_fill() returned. This call and burn_fifo_peek_data() do not disturb each other.
| fifo | The fifo object to start |
| fill | Number of bytes desired. Expect to get return 1 if at least fifo size - 32k were read. |
| flag | Bitfield for control purposes. bit0= fill fifo to maximum size |
| void burn_fifo_get_statistics | ( | struct burn_source * | fifo, |
| int * | total_min_fill, | ||
| int * | interval_min_fill, | ||
| int * | put_counter, | ||
| int * | get_counter, | ||
| int * | empty_counter, | ||
| int * | full_counter | ||
| ) |
Inquire various counters which reflect the fifo operation.
| fifo | The fifo object to inquire |
| total_min_fill | The minimum number of bytes in the fifo. Beginning from the moment when fifo consumption is enabled. |
| interval_min_fill | The minimum byte number beginning from the moment when fifo consumption is enabled or from the most recent moment when burn_fifo_next_interval() was called. |
| put_counter | The number of data transactions into the fifo. |
| get_counter | The number of data transactions out of the fifo. |
| empty_counter | The number of times the fifo was empty. |
| full_counter | The number of times the fifo was full. |
| int burn_fifo_inquire_status | ( | struct burn_source * | fifo, |
| int * | size, | ||
| int * | free_bytes, | ||
| char ** | status_text | ||
| ) |
Inquires state and fill parameters of a fifo burn_source which was created by burn_fifo_source_new() .
Do not use with other burn_source variants.
| fifo | The fifo object to inquire |
| size | The total size of the fifo |
| free_bytes | The current free capacity of the fifo |
| status_text | Returns a pointer to a constant text, see below |
Referenced by libburner_payload().
| void burn_fifo_next_interval | ( | struct burn_source * | fifo, |
| int * | interval_min_fill | ||
| ) |
Inquire the fifo minimum fill counter for intervals and reset that counter.
| fifo | The fifo object to inquire |
| interval_min_fill | The minimum number of bytes in the fifo. Beginning from the moment when fifo consumption is enabled or from the most recent moment when burn_fifo_next_interval() was called. |
| int burn_fifo_peek_data | ( | struct burn_source * | fifo, |
| char * | buf, | ||
| int | bufsize, | ||
| int | flag | ||
| ) |
Obtain a preview of the first input data of a fifo which was created by burn_fifo_source_new().
The data will later be delivered normally to the consumer track of the fifo. bufsize may not be larger than the fifo size (chunk_size * chunks) - 32k. This call will succeed only if data consumption by the track has not started yet, i.e. best before the call to burn_disc_write(). It will start the worker thread of the fifo with the expectable side effects on the external data source. Then it waits either until enough data have arrived or until it becomes clear that this will not happen. The call may be repeated with increased bufsize. It will always yield the bytes beginning from the first one in the fifo.
| fifo | The fifo object to inquire resp. start |
| buf | Pointer to memory of at least bufsize bytes where to deliver the peeked data. |
| bufsize | Number of bytes to peek from the start of the fifo data |
| flag | Bitfield for control purposes (unused yet, submit 0). |
|
read |
Creates a fifo which acts as proxy for an already existing data source.
The fifo provides a ring buffer which shall smoothen the data stream between burn_source and writer thread. Each fifo serves only for one data source. It may be attached to one track as its only data source by burn_track_set_source(), or it may be used as input for other burn sources. A fifo starts its life in "standby" mode with no buffer space allocated. As soon as its consumer requires bytes, the fifo establishes a worker thread and allocates its buffer. After input has ended and all buffer content is consumed, the buffer space gets freed and the worker thread ends. This happens asynchronously. So expect two buffers and worker threads to exist for a short time between tracks. Be modest in your size demands if multiple tracks are to be expected.
| inp | The burn_source for which the fifo shall act as proxy. It can be disposed by burn_source_free() immediately after this call. |
| chunksize | The size in bytes of a chunk. Use 2048 for sources suitable for BURN_BLOCK_MODE1, 2352 for sources which deliver for BURN_BLOCK_AUDIO, 2056 for sources which shall get treated by burn_track_set_cdxa_conv(track, 1). Some variations of burn_source might work only with a particular chunksize. E.g. libisofs demands 2048. |
| chunks | The number of chunks to be allocated in ring buffer. This value must be >= 2. |
| flag | Bitfield for control purposes: bit0= The read method of inp is capable of delivering arbitrary amounts of data per call. Not only one sector. Suitable for inp from burn_file_source_new() and burn_fd_source_new() if not the fd has exotic limitations on read size. You MUST use this on inp which uses an fd opened with burn_os_open_track_src(). Better do not use with other inp types. |
Referenced by libburner_payload().
|
read |
Creates a data source for an image file (and maybe subcode file)
| path | The file address for the main channel payload. |
| subpath | Eventual address for subchannel data. Only used in exotic raw write modes. Submit NULL for normal tasks. |
| 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_get_read_capacity | ( | struct burn_drive * | d, |
| int * | capacity, | ||
| int | flag | ||
| ) |
Inquire the maximum amount of readable data.
It is supposed that all LBAs in the range from 0 to media_read_acpacity-1 can be read via burn_read_data() although some of them may never have been recorded. If tracks are recognizable then it is better to only read LBAs which are part of some track. If the drive is actually a large file or block device, then the capacity is curbed to a maximum of 0x7ffffff0 blocks = 4 TB - 32 KB.
| d | The drive from which to read |
| capacity | Will return the result if valid |
| flag | Bitfield for control purposes: Unused yet, submit 0. |
| char* burn_guess_cd_manufacturer | ( | int | m_li, |
| int | s_li, | ||
| int | f_li, | ||
| int | m_lo, | ||
| int | s_lo, | ||
| int | f_lo, | ||
| int | flag | ||
| ) |
Guess the manufacturer name of CD media from the ATIP addresses of lead-in and lead-out.
(Currently only lead-in is interpreted. Lead-out may in future be used to identify the media type in more detail.) The parameters of this call should be obtained by burn_disc_read_atip(d), burn_drive_get_start_end_lba(d, &start_lba, &end_lba, 0), burn_lba_to_msf(start_lba, &m_li, &s_li, &f_li) and burn_lba_to_msf(end_lba, &m_lo, &s_lo, &f_lo).
| m_li | "minute" part of ATIP lead-in resp. start_lba |
| s_li | "second" of lead-in resp. start_lba |
| f_li | "frame" of lead-in |
| m_lo | "minute" part of ATIP lead-out |
| s_lo | "second" of lead-out |
| f_lo | "frame" of lead-out |
| flag | Bitfield for control purposes, bit0= append a text "(aka ...)" to reply if other brands or vendor names are known. |
| char* burn_guess_manufacturer | ( | int | profile_no, |
| char * | manuf_code, | ||
| char * | media_code, | ||
| int | flag | ||
| ) |
Guess the name of a manufacturer by profile number, manufacturer code and media code.
The profile number can be obtained by burn_disc_get_profile(), the other two parameters can be obtained as media_code1 and media_code2 by burn_get_media_product_id().
| profile_no | Profile number (submit -1 if not known) |
| manuf_code | Manufacturer code from media (e.g. "RICOHJPN") |
| media_code | Media ID code from media (e.g. "W11") |
| flag | Bitfield for control purposes, submit 0 |
| 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. Once this was 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().
| int burn_is_aborting | ( | int | flag | ) |
Referenced by libburner_blank_disc(), libburner_format(), libburner_payload(), and 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_lookup_device_link | ( | char * | dev_adr, |
| char | link_adr[], | ||
| char * | dir_adr, | ||
| char ** | templ, | ||
| int | num_templ, | ||
| int | flag | ||
| ) |
Try to convert a given drive device file address into the address of a symbolic link that points to this drive address.
Modern GNU/Linux systems may shuffle drive addresses from boot to boot. The udev daemon is supposed to create links which always point to the same drive, regardless of its system address. This call tries to find such links.
| dev_adr | Should contain a drive address as returned by burn_drive_scan(). |
| link_adr | An application provided array of at least BURN_DRIVE_ADR_LEN characters size. The found link address gets copied to it. |
| dir_adr | The address of the directory where to look for links. Normally: "/dev" |
| templ | An array of pointers to name templates, which links have to match. A symbolic link in dir_adr matches a name template if it begins by that text. E.g. link address "/dev/dvdrw1" matches template "dvdrw". If templ is NULL, then the default array gets used: {"dvdrw", "cdrw", "dvd", "cdrom", "cd"} If several links would match, then a link will win, which matches the template with the lowest array index. Among these candidates, the one with the lowest strcmp() rank will be chosen as link_adr. |
| num_templ | Number of array elements in templ. |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| 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", "ABORT", "FATAL", "FAILURE", "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 listed 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", "ABORT", "FATAL", "FAILURE", "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_msgs_submit | ( | int | error_code, |
| char | msg_text[], | ||
| int | os_errno, | ||
| char | severity[], | ||
| struct burn_drive * | d | ||
| ) |
Submit a message to the libburn queueing system.
It will be queued or printed as if it was generated by libburn itself.
| error_code | The unique error code of your message. Submit 0 if you do not have reserved error codes within the libburnia project. |
| msg_text | Not more than BURN_MSGS_MESSAGE_LEN characters of message text. |
| os_errno | Eventual errno related to the message. Submit 0 if the message is not related to a operating system error. |
| severity | One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL". |
| d | An eventual drive to which the message shall be related. Submit NULL if the message is not specific to a particular drive object. |
| int burn_obtain_profile_name | ( | int | profile_code, |
| char | name[80] | ||
| ) |
Obtains the profile name associated with a profile code.
| profile_code | the profile code to be translated |
| name | returns the profile name (e.g. "DVD+RW") |
|
read |
Creates an offset source which shall provide a byte interval of a stream to its consumer.
It is supposed to be chain-linked with other offset sources which serve neighboring consumers. The chronological sequence of consumers and the sequence of offset sources must match. The intervals of the sources must not overlap.
A chain of these burn_source objects may be used to feed multiple tracks from one single stream of input bytes. Each of the offset sources will skip the bytes up to its start address and provide the prescribed number of bytes to the track. Skipping takes into respect the bytes which have been processed by eventual predecessors in the chain. Important: It is not allowed to free an offset source before its successor has ended its work. Best is to keep them all until all tracks are done.
| inp | The burn_source object from which to read stream data. E.g. created by burn_file_source_new(). |
| prev | The eventual offset source object which shall read data from inp before the new offset source will begin its own work. This must either be a result of burn_offst_source_new() or it must be NULL. |
| start | The byte address where to start reading bytes for the consumer. inp bytes may get skipped to reach this address. |
| size | The number of bytes to be delivered to the consumer. If size is <= 0 then it may be set later by a call of method set_size(). If it is >= 0, then it can only be changed if flag bit0 was set with burn_offst_source_new(). |
| flag | Bitfield for control purposes bit0 = Prevent set_size() from overriding interval sizes > 0. If such a size is already set, then the new one will only affect the reply of get_size(). See also above struct burn_source. |
| void* burn_os_alloc_buffer | ( | size_t | amount, |
| int | flag | ||
| ) |
Allocate a memory area that is suitable for reading with a file descriptor opened by burn_os_open_track_src().
| amount | Number of bytes to allocate. This should be a multiple of the operating system's i/o block size. 32 KB is guaranteed by libburn to be safe. |
| flag | Bitfield for control purposes (unused yet, submit 0). |
| int burn_os_free_buffer | ( | void * | buffer, |
| size_t | amount, | ||
| int | flag | ||
| ) |
Dispose a memory area which was obtained by burn_os_alloc_buffer(),.
| buffer | Memory address to be freed. |
| amount | The number of bytes which was allocated at that address. |
| flag | Bitfield for control purposes (unused yet, submit 0). |
| int burn_os_open_track_src | ( | char * | path, |
| int | open_flags, | ||
| int | flag | ||
| ) |
Opens a file with eventual acceleration preparations which may depend on the operating system and on compile time options of libburn.
You may use this call instead of open(2) for opening file descriptors which shall be handed to burn_fd_source_new(). This should only be done for tracks with BURN_BLOCK_MODE1 (2048 bytes per block).
If you use this call then you MUST allocate the buffers which you use with read(2) by call burn_os_alloc_buffer(). Read sizes MUST be a multiple of a safe buffer amount. Else you risk that track data get altered during transmission. burn_disk_write() will allocate a suitable read/write buffer for its own operations. A fifo created by burn_fifo_source_new() will allocate suitable memory for its buffer if called with flag bit0 and a multiple of a safe buffer amount.
| path | The file address to open |
| open_flags | The flags as of man 2 open. Normally just O_RDONLY. |
| flag | Bitfield for control purposes (unused yet, submit 0). |
| 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() whether 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 | 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 on GNU/Linux , flock(LOCK_EX) on FreeBSD.) 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 on GNU/Linux 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. |
| int burn_random_access_write | ( | struct burn_drive * | d, |
| off_t | byte_address, | ||
| char * | data, | ||
| off_t | data_count, | ||
| int | flag | ||
| ) |
Write data in random access mode.
The drive must be grabbed successfully before calling this function which circumvents usual libburn session processing and rather writes data without preparations or finalizing. This will work only with overwriteable media which are also suitable for burn_write_opts_set_start_byte(). The same address alignment restrictions as with this function apply. I.e. for DVD it is best to align to 32 KiB blocks (= 16 LBA units). The amount of data to be written is subject to the same media dependent alignment rules. Again, 32 KiB is most safe. Call burn_disc_get_multi_caps() can obtain the necessary media info. See resulting struct burn_multi_caps elements .start_adr , .start_alignment , .start_range_low , .start_range_high . Other than burn_disc_write() this is a synchronous call which returns only after the write transaction has ended (sucessfully or not). So it is wise not to transfer giant amounts of data in a single call. Important: Data have to fit into the already formatted area of the media.
| d | The drive to which to write |
| byte_address | The start address of the write in byte (1 LBA unit = 2048 bytes) (do respect media alignment) |
| data | The bytes to be written |
| data_count | The number of those bytes (do respect media alignment) data_count == 0 is permitted (e.g. to flush the drive buffer without further data transfer). |
| flag | Bitfield for control purposes: bit0 = flush the drive buffer after eventual writing |
| int burn_read_data | ( | struct burn_drive * | d, |
| off_t | byte_address, | ||
| char | data[], | ||
| off_t | data_size, | ||
| off_t * | data_count, | ||
| int | flag | ||
| ) |
Read data in random access mode.
The drive must be grabbed successfully before calling this function. With all currently supported drives and media the byte_address has to be aligned to 2048 bytes. Only data tracks with 2048 bytes per sector can be read this way. I.e. not CD-audio, not CD-video-stream ... This is a synchronous call which returns only after the full read job has ended (sucessfully or not). So it is wise not to read giant amounts of data in a single call.
| d | The drive from which to read |
| byte_address | The start address of the read in byte (aligned to 2048) |
| data | A memory buffer capable of taking data_size bytes |
| data_size | The amount of data to be read. This does not have to be aligned to any block size. |
| data_count | The amount of data actually read (interesting on error) |
| flag | Bitfield for control purposes: bit0= - reserved - bit1= do not submit error message if read error bit2= on error do not try to read a second time with single block steps. |
| 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 |
|
read |
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. |
| char* burn_scsi_transport_id | ( | int | flag | ) |
Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time.
For the library compatibility check, BURN_*_VERSION in configure.ac are not decisive. Only the three numbers above do matter. Usage discussion:
Some developers of the libburnia project have differing opinions how to ensure the compatibility of libaries and applications.
It is about whether to use at compile time and at runtime the version numbers isoburn_header_version_* provided here. Thomas Schmitt advises to use them. Vreixo Formoso advises to use other means.
At compile time:
Vreixo Formoso advises to leave proper version matching to properly programmed checks in the the application's build system, which will eventually refuse compilation.
Thomas Schmitt advises to use the macros defined here for comparison with the application's requirements of library revisions and to eventually break compilation.
Both advises are combinable. I.e. be master of your build system and have #if checks in the source code of your application, nevertheless.
At runtime (via *_is_compatible()):
Vreixo Formoso advises to compare the application's requirements of library revisions with the runtime library. This is to allow runtime libraries which are young enough for the application but too old for the lib*.h files seen at compile time.
Thomas Schmitt advises to compare the header revisions defined here with the runtime library. This is to enforce a strictly monotonous chain of revisions from app to header to library, at the cost of excluding some older libraries.
These two advises are mutually exclusive. Obtain the id string of the SCSI transport interface. This interface may be a system specific adapter module of libburn or an adapter to a supporting library like libcdio.
| flag | Bitfield for control puposes, submit 0 for now |
| 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().
| int burn_session_by_cue_file | ( | struct burn_session * | session, |
| char * | path, | ||
| int | fifo_size, | ||
| struct burn_source ** | fifo, | ||
| unsigned char ** | text_packs, | ||
| int * | num_packs, | ||
| int | flag | ||
| ) |
Read a CDRWIN cue sheet file and equip the session object by tracks and CD-TEXT according to the content of the file.
For a description of CDRWIN file format see http://digitalx.org/cue-sheet/syntax/ Fully supported commands are: CATALOG , CDTEXTFILE , FLAGS , INDEX , ISRC , PERFORMER , POSTGAP , PREGAP , REM , SONGWRITER , TITLE Further supported commands introduced by cdrecord (usage like PERFORMER): ARRANGER , COMPOSER , MESSAGE Partly supported commands are: FILE which supports only types BINARY , MOTOROLA , WAVE TRACK which supports only datatypes AUDIO , MODE1/2048 Unsupported types of FILE or TRACK lead to failure of the call. libburn does not yet support mixing of AUDIO and MODE1/2048. So this call will fail if such a mix is found. CD-TEXT information is allowed only if all tracks are of datatype AUDIO. Empty lines and lines which start by '#' are ignored.
| session | Session where to attach tracks. It must not yet have tracks or else this call will fail. |
| path | Filesystem address of the CDRWIN cue sheet file. Normally with suffix .cue |
| fifo_size | Number of bytes in fifo. This will be rounded up by the block size of the track mode. <= 0 means no fifo. |
| fifo | Returns a reference to the burn_source object that was installed as fifo between FILE and the track burn sources. One may use this to inquire the fifo state. Dispose it by burn_source_free() when no longer needed. It is permissible to pass this parameter to libburn as NULL, in order to immediately drop ownership on the fifo. |
| text_packs | Returns pre-formatted CD-TEXT packs resulting from cue sheet command CDTEXTFILE. To be used with call burn_write_opts_set_leadin_text(). It is permissible to pass this parameter to libburn as NULL, in order to disable CDTEXTFILE. |
| num_packs | Returns the number of 18 byte records in text_packs. |
| flag | Bitfield for control purposes. bit0= Do not attach CD-TEXT information to session and tracks. Do not load text_packs. bit1= Do not use media catalog string of session or ISRC strings of tracks for writing to Q sub-channel. |
|
read |
Create a new session.
Referenced by libburner_payload().
| int burn_session_dispose_cdtext | ( | struct burn_session * | s, |
| int | block | ||
| ) |
Remove all CD-TEXT attributes of the given block from the session.
They were attached by burn_session_set_cdtext().
| s | Session where to remove the CD-TEXT attribute |
| block | Number of the language block in which the attribute shall appear. Possible values: 0 to 7. -1 causes text packs of all blocks to be removed. |
| 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_cdtext | ( | struct burn_session * | s, |
| int | block, | ||
| int | pack_type, | ||
| char * | pack_type_name, | ||
| unsigned char ** | payload, | ||
| int * | length, | ||
| int | flag | ||
| ) |
Obtain a CD-TEXT attribute that was set by burn_session_set_cdtext()
| s | Session to inquire |
| block | Number of the language block to inquire. |
| pack_type | Pack type number to inquire. Used if pack_type_name is NULL or empty text. Else submit 0 and a name. Pack type 0x8f is generated automatically and may not be inquire in advance. Use burn_cdtext_from_session() to generate all packs including type 0x8f packs. |
| pack_type_name | The pack type by name. See above burn_session_set_cdtext(). |
| payload | Will return a pointer to text or binary bytes. Not a copy of data. Do not free() this address. If no text attribute is attached for pack type and block, then payload is returned as NULL. The return value will not indicate error in this case. length Will return the number of bytes pointed to by payload. Including terminating 0-bytes. |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| int burn_session_get_cdtext_par | ( | struct burn_session * | s, |
| int | char_codes[8], | ||
| int | copyrights[8], | ||
| int | block_languages[8], | ||
| int | flag | ||
| ) |
Obtain the current settings as of burn_session_set_cdtext_par() resp.
by default.
| s | Session which to inquire |
| char_codes | Will return Character Codes for block 0 to 7 |
| copyrights | Will return Copyright bytes for block 0 to 7 |
| languages | Will return Language Codes for block 0 to 7 |
| flag | Bitfiled for control purposes. Unused yet. Submit 0. |
| 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 | ) |
| int burn_session_get_start_tno | ( | struct burn_session * | session, |
| int | flag | ||
| ) |
Inquire the CD track start number, as set by default ot by burn_session_set_start_tno().
| session | The session to be inquired |
|
read |
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_input_sheet_v07t | ( | struct burn_session * | session, |
| char * | path, | ||
| int | block, | ||
| int | flag | ||
| ) |
Read a Sony CD-TEXT Input Sheet Version 0.7T file and attach its text attributes to the given session and its tracks for the given CD-TEXT block number.
This overrides previous settings made by burn_session_set_cdtext(), burn_track_set_cdtext(), burn_track_set_isrc(), burn_session_set_start_tno(). It can later be overridden by said function calls. The media catalog number from purpose specifier "UPC / EAN" gets into effect only if burn_write_opts_set_has_mediacatalog() is set to 0. The format of a v07t sheet file is documented in doc/cdtext.txt.
| s | Session where to attach CD-TEXT attributes |
| path | Local filesystem address of the sheet file which shall be read and interpreted. |
| block | Number of the language block in which the attributes shall appear. Possible values: 0 to 7. |
| flag | Bitfield for control purposes. bit1= Do not use media catalog string of session or ISRC strings of tracks for writing to Q sub-channel. |
| 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 |
| int burn_session_set_cdtext | ( | struct burn_session * | s, |
| int | block, | ||
| int | pack_type, | ||
| char * | pack_type_name, | ||
| unsigned char * | payload, | ||
| int | length, | ||
| int | flag | ||
| ) |
Attach text or binary data as CD-TEXT attributes to a session.
They can be used to generate CD-TEXT packs by burn_cdtext_from_session() or to write CD-TEXT packs into the lead-in of a CD SAO session. The latter happens only if no array of CD-TEXT packs is attached to the write options by burn_write_opts_set_leadin_text(). For details of the CD-TEXT format and of the payload content, see file doc/cdtext.txt .
| s | Session where to attach CD-TEXT attribute |
| block | Number of the language block in which the attribute shall appear. Possible values: 0 to 7. |
| pack_type | Pack type number. 0x80 to 0x8e. Used if pack_type_name is NULL or empty text. Else submit 0 and a name. Pack type 0x8f is generated automatically and may not be set by applications. |
| pack_type_name | The pack type by name. Defined names are: 0x80 = "TITLE" 0x81 = "PERFORMER" 0x82 = "SONGWRITER" 0x83 = "COMPOSER" 0x84 = "ARRANGER" 0x85 = "MESSAGE" 0x86 = "DISCID" 0x87 = "GENRE" 0x88 = "TOC" 0x89 = "TOC2" 0x8d = "CLOSED" 0x8e = "UPC_ISRC" Names are recognized uppercase and lowercase. |
| payload | Text or binary bytes. The data will be copied to session-internal memory. Pack types 0x80 to 0x85 contain 0-terminated cleartext encoded according to the block's Character Code. If double byte characters are used, then two 0-bytes terminate the cleartext. Pack type 0x86 is 0-terminated ASCII cleartext. Pack type 0x87 consists of two byte big-endian Genre code (see below BURN_CDTEXT_GENRE_LIST), and 0-terminated ASCII cleartext of genre description. Pack type 0x88 mirrors the session table-of-content. Pack type 0x89 is not understood yet. Pack types 0x8a to 0x8c are reserved. Pack type 0x8d contains ISO-8859-1 cleartext which is not to be shown by commercial audio CD players. Pack type 0x8e is ASCII cleartext with UPC/EAN code. length Number of bytes in payload. Including terminating 0-bytes. |
| flag | Bitfield for control purposes. bit0= payload contains double byte characters (with character code 0x80 MS-JIS japanese Kanji) |
| int burn_session_set_cdtext_par | ( | struct burn_session * | s, |
| int | char_codes[8], | ||
| int | copyrights[8], | ||
| int | languages[8], | ||
| int | flag | ||
| ) |
Set the Character Codes, the Copyright bytes, and the Language Codes for CD-TEXT blocks 0 to 7.
They will be used in the block summaries of text packs which get generated from text or binary data submitted by burn_session_set_cdtext() and burn_track_set_cdtext(). Character Code value can be 0x00 = ISO-8859-1 0x01 = 7 bit ASCII 0x80 = MS-JIS (japanesei Kanji, double byte characters) Copyright byte value can be 0x00 = not copyrighted 0x03 = copyrighted Language Code value will typically be 0x09 = English or 0x69 = Japanese. See below macros BURN_CDTEXT_LANGUAGES_0X00 and BURN_CDTEXT_LANGUAGES_0X45, but be aware that many of these codes have never been seen on CD, and that many of them do not have a character representation among the above Character Codes. Default is 0x09 = English for block 0 and 0x00 = Unknown for block 1 to 7. Copyright and Character Code are 0x00 for all blocks by default. See also file doc/cdtext.txt, "Format of a CD-TEXT packs array", "Pack type 0x8f".
Parameter value -1 leaves the current setting of the session parameter unchanged.
| s | Session where to change settings |
| char_codes | Character Codes for block 0 to 7 |
| copyrights | Copyright bytes for block 0 to 7 |
| languages | Language Codes for block 0 to 7 |
| flag | Bitfiled for control purposes. Unused yet. Submit 0. |
| int burn_session_set_start_tno | ( | struct burn_session * | session, |
| int | tno, | ||
| int | flag | ||
| ) |
Set the number which shall be written as CD track number with the first track of the session.
The following tracks will then get written with consecutive CD track numbers. The resulting number of the last track must not exceed 99. The lowest possible start number is 1, which is also the default. This setting applies only to CD SAO writing.
| session | The session to be manipulated |
| tno | A number between 1 and 99 |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| int burn_set_messenger | ( | void * | messenger | ) |
Replace the messenger object handle of libburn by a compatible handle obtained from a related library.
See also: libisofs, API function iso_get_messenger().
| messenger | The foreign but compatible message handle. |
| void burn_set_scsi_logging | ( | int | flag | ) |
Enable resp.
disable logging of SCSI commands. This call can be made at any time - even before burn_initialize(). It is in effect for all active drives and currently not very thread safe for multiple drives.
| flag | Bitfield for control purposes. The default is 0. bit0= log to file /tmp/libburn_sg_command_log bit1= log to stderr bit2= flush output after each line |
| void burn_set_signal_handling | ( | void * | handle, |
| burn_abort_handler_t | handler, | ||
| int | mode | ||
| ) |
Control built-in signal handling.
Either by setting an own handler or by activating the built-in signal handler.
A function parameter handle of NULL activates the built-in abort handler. Depending on mode it may cancel all drive operations, wait for all drives to become idle, exit(1). It may also prepare function burn_drive_get_status() for waiting and performing exit(1). If parameter handle may be NULL or a text that shall be used as prefix for pacifier messages of burn_abort_pacifier(). Other than with an application provided handler, the prefix char array does not have to be kept existing until the eventual signal event. Before version 0.7.8 only action 0 was available. I.e. the built-in handler waited for the drives to become idle and then performed exit(1) directly. But during burn_disc_write() onto real CD or DVD, FreeBSD 8.0 pauses the other threads until the signal handler returns. The new actions try to avoid this deadlock. It is advised to use action 3 at least during burn_disc_write(), burn_disc_erase(), burn_disc_format(): burn_set_signal_handling(text, NULL, 0x30); and to call burn_is_aborting(0) when the drive is BURN_DRIVE_IDLE. If burn_is_aborting(0) returns 1, then call burn_abort() and exit(1).
| handle | Opaque handle eventually pointing to an application provided memory object |
| handler | A function to be called on signals, if the handling bits in parameter mode are set 0. It will get parameter handle as argument. flag will be 0. It should finally call burn_abort(). See there. If the handler function returns 2 or -2, then the wrapping signal handler of libburn will return and let the program continue its operations. Any other return value causes exit(1). |
| mode | : bit0 - bit3: Handling of received signals: 0 Install libburn wrapping signal handler, which will 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 bit4 - bit7: With handler == NULL : Action of built-in handler. "control thread" is the one which called burn_set_signal_handling(). All actions activate receive mode 2 to ignore further signals. 0 Same as 1 (for pre-0.7.8 backward compatibility) |
Referenced by libburner_blank_disc(), libburner_format(), libburner_payload(), and 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. |
| int burn_sev_to_text | ( | int | severity_number, |
| char ** | severity_name, | ||
| int | flag | ||
| ) |
Convert a severity number into a severity name.
| severity_number | The rank number: the higher, the more severe. |
| severity_name | A name as with burn_msgs_submit(), e.g. "SORRY". |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| 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 | ) |
| int burn_text_to_sev | ( | char * | severity_name, |
| int * | severity_number, | ||
| int | flag | ||
| ) |
Convert a severity name into a severity number, which gives the severity rank of the name.
| severity_name | A name as with burn_msgs_submit(), e.g. "SORRY". |
| severity_number | The rank number: the higher, the more severe. |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| int burn_track_clear_indice | ( | struct burn_track * | t, |
| int | flag | ||
| ) |
Remove all index start addresses and reset to the default indexing of CD SAO sessions.
This means index 0 of track 1 reaches from LBA -150 to LBA -1. Index 1 of track 1 reaches from LBA 0 to track end. Index 1 of track 2 follows immediately. The same happens for all further tracks after the end of their predecessor.
| t | The track to be manipulated |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| void burn_track_clear_isrc | ( | struct burn_track * | t | ) |
Disable ISRC parameters for a track.
| t | The track to change |
|
read |
Create a track.
Referenced by libburner_payload().
| 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().
| int burn_track_dispose_cdtext | ( | struct burn_track * | t, |
| int | block | ||
| ) |
Remove all CD-TEXT attributes of the given block from the track.
They were attached by burn_track_set_cdtext().
| t | Track where to remove the CD-TEXT attribute. |
| block | Number of the language block in which the attribute shall appear. Possible values: 0 to 7. -1 causes text packs of all blocks to be removed. |
| void burn_track_free | ( | struct burn_track * | t | ) |
| int burn_track_get_cdtext | ( | struct burn_track * | t, |
| int | block, | ||
| int | pack_type, | ||
| char * | pack_type_name, | ||
| unsigned char ** | payload, | ||
| int * | length, | ||
| int | flag | ||
| ) |
Obtain a CD-TEXT attribute that was set by burn_track_set_cdtext().
| t | Track to inquire |
| block | Number of the language block to inquire. |
| pack_type | Pack type number to inquire. Used if pack_type_name is NULL or empty text. Else submit 0 and a name. |
| pack_type_name | The pack type by name. See above burn_track_set_cdtext(). |
| payload | Will return a pointer to text bytes. Not a copy of data. Do not free() this address. If no text attribute is attached for pack type and block, then payload is returned as NULL. The return value will not indicate error in this case. length Will return the number of bytes pointed to by payload. Including terminating 0-bytes. |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| 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.
| t | The track to inquire |
| read_bytes | Number of bytes read from the track source |
| written_bytes | Number of bytes written to track |
| 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 many sectors a track will have on disc, resp.
already has on disc. This includes offset, payload, tail, and post-gap, but not pre-gap. The result is NOT RELIABLE with tracks of undefined length
| int burn_track_set_byte_swap | ( | struct burn_track * | t, |
| int | swap_source_bytes | ||
| ) |
Define whether 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_cdtext | ( | struct burn_track * | t, |
| int | block, | ||
| int | pack_type, | ||
| char * | pack_type_name, | ||
| unsigned char * | payload, | ||
| int | length, | ||
| int | flag | ||
| ) |
Attach text or binary data as CD-TEXT attributes to a track.
The payload will be used to generate CD-TEXT packs by burn_cdtext_from_session() or to write CD-TEXT packs into the lead-in of a CD SAO session. This happens if the CD-TEXT attribute of the session gets generated, which has the same block number and pack type. In this case, each track should have such a CD-TEXT attribute, too. See burn_session_set_cdtext(). Be cautious not to exceed the maximum number of 253 payload packs per language block. Use burn_cdtext_from_session() to learn whether a valid array of CD-TEXT packs can be generated from your attributes.
| t | Track where to attach CD-TEXT attribute. |
| block | Number of the language block in which the attribute shall appear. Possible values: 0 to 7. |
| pack_type | Pack type number. 0x80 to 0x85 or 0x8e. Used if pack_type_name is NULL or empty text. Else submit 0 and a name. |
| pack_type_name | The pack type by name. Applicable names are: 0x80 = "TITLE" 0x81 = "PERFORMER" 0x82 = "SONGWRITER" 0x83 = "COMPOSER" 0x84 = "ARRANGER" 0x85 = "MESSAGE" 0x8e = "UPC_ISRC" |
| payload | 0-terminated cleartext. If double byte characters are used, then two 0-bytes terminate the cleartext. length Number of bytes in payload. Including terminating 0-bytes. |
| flag | Bitfield for control purposes. bit0= payload contains double byte characters (with character code 0x80 MS-JIS japanese Kanji) |
| int burn_track_set_cdxa_conv | ( | struct burn_track * | t, |
| int | value | ||
| ) |
Activates CD XA compatibility modes.
libburn currently writes data only in CD mode 1. Some programs insist in sending data with additional management bytes. These bytes have to be stripped in order to make the input suitable for BURN_MODE1.
| t | The track to manipulate |
| value | 0= no conversion 1= strip 8 byte sector headers of CD-ROM XA mode 2 form 1 see MMC-5 4.2.3.8.5.3 Block Format for Mode 2 form 1 Data all other values are reserved |
| 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 |
| int burn_track_set_index | ( | struct burn_track * | t, |
| int | index_number, | ||
| unsigned int | relative_lba, | ||
| int | flag | ||
| ) |
Define an index start address within a track.
The index numbers inside a track have to form sequence starting at 0 or 1 with no gaps up to the highest number used. They affect only writing of CD SAO sessions. The first index start address of a track must be 0. Blocks between index 0 and index 1 are considered to be located before the track start as of the table-of-content.
| t | The track to be manipulated |
| index_number | A number between 0 and 99 |
| relative_lba | The start address relative to the start of the burn_source of the track. It will get mapped to the appropriate absolute block address. |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| 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.
When writing to CD media, ISRC will get written into the Q sub-channel.
| 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_isrc_string | ( | struct burn_track * | t, |
| char | isrc[13], | ||
| int | flag | ||
| ) |
Set the composed ISRC string for a track.
This is an alternative to burn_track_set_isrc().
| t | The track to be manipulated |
| isrc | 12 characters which are composed from ISRC details. Format is CCOOOYYSSSSS, terminated by a 0-byte: Country, Owner, Year(decimal digits), Serial(decimal digits). |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| int burn_track_set_postgap_size | ( | struct burn_track * | t, |
| int | size, | ||
| int | flag | ||
| ) |
Define whether a post-gap shall be written at the end of the track and how many sectors this gap shall have.
A post-gap occupies the range of an additional index of the track. It contains zeros. No bytes from the track source will be read for writing the post-gap. This setting affects only CD SAO write runs. MMC prescribes to add a post-gap to a data track which is followed by a non-data track. (But libburn does not yet support mixed mode CD SAO sessions.)
| t | The track to change |
| size | Number of sectors in the post-gap. -1 disables post-gap. libburn allows 0, but MMC does not propose this. |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| int burn_track_set_pregap_size | ( | struct burn_track * | t, |
| int | size, | ||
| int | flag | ||
| ) |
Define whether a pre-gap shall be written before the track and how many sectors this pre-gap shall have.
A pre-gap is written in the range of track index 0 and contains zeros resp. silence. No bytes from the track source will be read for writing the pre-gap. This setting affects only CD SAO write runs. The first track automatically gets a pre-gap of at least 150 sectors. Its size may be enlarged by this call. Further pre-gaps are demanded by MMC for tracks which follow tracks of a different mode. (But Mode mixing in CD SAO sessions is currently not supported by libburn.)
| t | The track to change |
| size | Number of sectors in the pre-gap. -1 disables pre-gap, except for the first track. libburn allows 0, but MMC does not propose this. |
| flag | Bitfield for control purposes. Unused yet. Submit 0. |
| 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 operate 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.
This is the runtime counterpart of the three build time macros burn_header_version_* below.
| 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().
|
read |
Inquires the drive associated with a burn_write_opts object.
| opts | object to inquire |
|
read |
Creates a write_opts struct for burning to the specified drive.
The returned object must later be freed with burn_write_opts_free().
| drive | The drive to write with |
Referenced by libburner_payload().
| void burn_write_opts_set_dvd_obs | ( | struct burn_write_opts * | opts, |
| int | obs | ||
| ) |
Overrides the write chunk size for DVD and BD media which is normally determined according to media type and setting of stream recording.
A chunk size of 64 KB may improve throughput with bus systems which show latency problems.
| opts | The write opts to change |
| obs | Number of bytes which shall be sent by a single write command. 0 means automatic size, 32768 and 65336 are the only other accepted sizes for now. |
| 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 whether 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 | ||
| ) |
This call activates the Media Catalog Number for writing.
The digits of that number have to be set by call burn_write_opts_set_mediacatalog().
| opts | The write opts to change |
| has_mediacatalog | 1= activate writing of catalog to Q sub-channel 0= deactivate it |
| int burn_write_opts_set_leadin_text | ( | struct burn_write_opts * | opts, |
| unsigned char * | text_packs, | ||
| int | num_packs, | ||
| int | flag | ||
| ) |
Submit an array of CD-TEXT packs which shall be written to the Lead-in of a SAO write run on CD.
| opts | The option object to be manipulated |
| text_packs | Array of bytes which form CD-TEXT packs of 18 bytes each. For a description of the format of the array, see file doc/cdtext.txt. No header of 4 bytes must be prepended which would tell the number of pack bytes + 2. This parameter may be NULL if the currently attached array of packs shall be removed. |
| num_packs | The number of 18 byte packs in text_packs. This parameter may be 0 if the currently attached array of packs shall be removed. |
| flag | Bitfield for control purposes. bit0= do not verify checksums bit1= repair mismatching checksums bit2= repair checksums if they are 00 00 with each pack |
| void burn_write_opts_set_mediacatalog | ( | struct burn_write_opts * | opts, |
| unsigned char | mediacatalog[13] | ||
| ) |
The Q sub-channel of a CD may contain a Media Catalog Number of 13 decimal digits.
This call sets the string of digits, but does not yet activate it for writing.
| opts | The write opts to change |
| mediacatalog | The 13 decimal digits as ASCII bytes. I.e. '0' = 0x30. |
| 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.
Note: DVD-R[W] in write mode BURN_WRITE_SAO are not capable of this. DVD-R DL are not capable of this at all. libburn will refuse to write if burn_write_opts_set_multi() is enabled under such conditions.
| opts | The option object to be manipulated |
| 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 .
This corresponds to the Test Write bit in MMC mode page 05h. Several media types do not support this. See struct burn_multi_caps.might_simulate for actual availability of this feature. If the media is suitable, the drive will perform burn_disc_write() as a simulation instead of effective write operations. This means that the media content and burn_disc_get_status() stay unchanged. Note: With stdio-drives, the target file gets eventually created, opened, lseeked, and closed, but not written. So there are effects on it. Warning: Call burn_random_access_write() will never do simulation because it does not get any burn_write_opts.
| opts | The write opts to change |
| sim | Non-zero enables simulation, 0 enables real writing |
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 (for now: DVD+RW, DVD-RAM, formatted DVD-RW).
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 supposed to be safe with DVD media. Call burn_disc_get_multi_caps() can obtain the necessary media info. See resulting struct burn_multi_caps elements .start_adr , .start_alignment , .start_range_low , .start_range_high .
| opts | The write opts to change |
| value | The address in bytes (-1 = start at default address) |
| void burn_write_opts_set_stdio_fsync | ( | struct burn_write_opts * | opts, |
| int | rythm | ||
| ) |
Sets the rythm by which stdio pseudo drives force their output data to be consumed by the receiving storage device.
This forcing keeps the memory from being clogged with lots of pending data for slow devices.
| opts | The write opts to change |
| rythm | Number of 2KB output blocks after which fsync(2) is performed. -1 means no fsync(), 0 means default, elsewise the value must be >= 32. Default is currently 8192 = 16 MB. |
| void burn_write_opts_set_stream_recording | ( | struct burn_write_opts * | opts, |
| int | value | ||
| ) |
Eventually makes use of the more modern write command AAh WRITE12 and sets the Streaming bit.
With DVD-RAM and BD this can override the traditional slowdown to half nominal speed. But if it speeds up writing then it also disables error management and correction. Weigh your priorities. This affects the write operations of burn_disc_write() and subsequent calls of burn_random_access_write().
| opts | The write opts to change |
| value | 0=use 2Ah WRITE10, 1=use AAh WRITE12 with Streaming bit |
| 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.
This is only needed with CD media and possibly with old DVD-R drives. All other media types are not vulnerable to burn failure due to buffer underrun.
| 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 |
| int libdax_audioxtr_destroy | ( | struct libdax_audioxtr ** | xtr, |
| int | flag | ||
| ) |
Clean up after extraction and destroy extractor object.
| xtr | Opaque handle to extractor, *xtr is allowed to be NULL, *xtr is set to NULL by this function |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| int libdax_audioxtr_detach_fd | ( | struct libdax_audioxtr * | o, |
| int * | fd, | ||
| int | flag | ||
| ) |
Try to obtain a file descriptor which will deliver extracted data to normal calls of read(2).
This may fail because the format is unsuitable for that, but ".wav" is ok. If this call succeeds the xtr object will have forgotten its file descriptor and libdax_audioxtr_read() will return a usage error. One may use *fd after libdax_audioxtr_destroy() and will have to close it via close(2) when done with it.
| xtr | Opaque handle to extractor |
| fd | Eventually returns the file descriptor number |
| flag | Bitfield for control purposes bit0= do not dup(2) and close(2) but hand out original fd |
| int libdax_audioxtr_get_id | ( | struct libdax_audioxtr * | xtr, |
| char ** | fmt, | ||
| char ** | fmt_info, | ||
| int * | num_channels, | ||
| int * | sample_rate, | ||
| int * | bits_per_sample, | ||
| int * | msb_first, | ||
| int | flag | ||
| ) |
Obtain identification parameters of opened audio source.
| xtr | Opaque handle to extractor |
| fmt | Gets pointed to the audio file format id text: ".wav" , ".au" |
| fmt_info | Gets pointed to a format info text telling parameters |
| num_channels | e.g. 1=mono, 2=stereo, etc |
| sample_rate | e.g. 11025, 44100 |
| bits_per_sample | e.g. 8= 8 bits per sample, 16= 16 bits ... |
| msb_first | Byte order of samples: 0= Intel = Little Endian 1= Motorola = Big Endian |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| int libdax_audioxtr_get_size | ( | struct libdax_audioxtr * | o, |
| off_t * | size, | ||
| int | flag | ||
| ) |
Obtain a prediction about the extracted size based on internal information of the formatted file.
| xtr | Opaque handle to extractor |
| size | Gets filled with the predicted size |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| int libdax_audioxtr_new | ( | struct libdax_audioxtr ** | xtr, |
| char * | path, | ||
| int | flag | ||
| ) |
Open an audio file, check wether suitable, create extractor object.
| xtr | Opaque handle to extractor. Gets attached extractor object. |
| path | Address of the audio file to extract. "-" is stdin (but might be not suitable for all futurely supported formats). |
| flag | Bitfield for control purposes (unused yet, submit 0) |
| int libdax_audioxtr_read | ( | struct libdax_audioxtr * | xtr, |
| char | buffer[], | ||
| int | buffer_size, | ||
| int | flag | ||
| ) |
Obtain next buffer full of extracted data in desired format (only raw audio for now).
| xtr | Opaque handle to extractor |
| buffer | Gets filled with extracted data |
| buffer_size | Maximum number of bytes to be filled into buffer |
| flag | Bitfield for control purposes bit0= do not stop at predicted end of data |
1.8.1.1