Crate libburn_sys 

Low-level Rust bindings for libburn.

You can find out more about the libburnia project, of which libburn is a part, by visiting https://dev.lovelyhq.com/libburnia/web/wiki

This version of libburn-sys is based on libburn 1.5.6

Requirements

Currently, libburn-sys does not support statically linking libburn into your application, and may never do. Instead, you must have libburn 1.5.6 or greater installed on your system so libburn-sys can dynamically link to it.

Bindings for libburn are pregenerated for libburn-sys, so you shouldn’t need bindgen’s dependencies installed to start using libburn-sys.

Structs

__BindgenBitfieldUnit

burn_disc

References a whole disc

burn_drive

References a physical drive in the system

burn_drive_info

Information on a drive in the system

burn_multi_caps

The reply structure for burn_disc_get_multi_caps()

burn_progress

Operation progress report. All values are 0 based indices.

burn_read_opts

burn_session

References a single session on a disc

burn_source

Data source interface for tracks. This allows you to use arbitrary program code as provider of track input data.

burn_speed_descriptor

Description of a speed capability as reported by the drive in conjunction with eventually loaded media. There can be more than one such object per drive. So they are chained via .next and .prev , where NULL marks the end of the chain. This list is set up by burn_drive_scan() and gets updated by burn_drive_grab(). A copy may be obtained by burn_drive_get_speedlist() and disposed by burn_drive_free_speedlist(). For technical background info see SCSI specs MMC and SPC: mode page 2Ah (from SPC 5Ah MODE SENSE) , mmc3r10g.pdf , 6.3.11 Table 364 ACh GET PERFORMANCE, Type 03h , mmc5r03c.pdf , 6.8.5.3 Table 312

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. The documentation here is very terse. See a document such as mmc3 for proper information.

burn_track

References a single track on a disc

burn_write_opts

References a set of write parameters

libdax_audioxtr

Extractor object encapsulating intermediate states of extraction. The clients of libdax_audioxtr shall only allocate pointers to this struct and get a storage object via libdax_audioxtr_new(). Appropriate initial value for the pointer is NULL.

Constants

BURN_4CH

BURN_AUDIO

BURN_BLOCK_TYPES_BURN_BLOCK_MODE1

only 2048 bytes of user data provided by lib/user

BURN_BLOCK_TYPES_BURN_BLOCK_MODE2R

2336 bytes of user data provided by lib/user

BURN_BLOCK_TYPES_BURN_BLOCK_MODE2_LAME

2048 bytes of data + 8 byte subheader provided by lib/user hey, this is also dumb

BURN_BLOCK_TYPES_BURN_BLOCK_MODE2_OBSCURE

2324 bytes of data provided by lib/user subheader provided in write parameters no sir, I don’t like it.

BURN_BLOCK_TYPES_BURN_BLOCK_MODE2_OK

2332 bytes of data supplied by lib/user 8 bytes sub header provided in write parameters this is the second least suck mode2, and is mandatory for all drives to support.

BURN_BLOCK_TYPES_BURN_BLOCK_MODE2_PATHETIC

2048 bytes of user data provided by lib/user subheader provided in write parameters are we ever going to support this shit? I vote no. (supposed to be supported on all drives…)

BURN_BLOCK_TYPES_BURN_BLOCK_RAW0

sync, headers, edc/ecc provided by lib/user

BURN_BLOCK_TYPES_BURN_BLOCK_RAW16

sync, headers, edc/ecc and p/q subs provided by lib/user

BURN_BLOCK_TYPES_BURN_BLOCK_RAW96P

sync, headers, edc/ecc and packed p-w subs provided by lib/user

BURN_BLOCK_TYPES_BURN_BLOCK_RAW96R

sync, headers, edc/ecc and raw p-w subs provided by lib/user

BURN_BLOCK_TYPES_BURN_BLOCK_SAO

SAO block sizes are based on cue sheet, so use this.

BURN_CDI

BURN_CDROM

BURN_CDTEXT_NUM_GENRES

BURN_CDXA

BURN_COPY

BURN_DISC_STATUS_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_STATUS_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 Overwritable media with or without valid data DVD-RAM, DVD+RW, formatted DVD-RW, BD-RE

BURN_DISC_STATUS_BURN_DISC_EMPTY

There is no disc at all in the drive

BURN_DISC_STATUS_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_STATUS_BURN_DISC_UNGRABBED

The drive was not grabbed when the status was inquired

BURN_DISC_STATUS_BURN_DISC_UNREADY

The current status is not yet known

BURN_DISC_STATUS_BURN_DISC_UNSUITABLE

The media seems to be unsuitable for reading and for writing

BURN_DRIVE_ADR_LEN

BURN_DRIVE_STATUS_BURN_DRIVE_CLOSING_SESSION

The drive is told to close a session (TAO only)

BURN_DRIVE_STATUS_BURN_DRIVE_CLOSING_TRACK

The drive is told to close a track (TAO only)

BURN_DRIVE_STATUS_BURN_DRIVE_ERASING

The drive is erasing a disc

BURN_DRIVE_STATUS_BURN_DRIVE_FORMATTING

The drive is formatting media

BURN_DRIVE_STATUS_BURN_DRIVE_GRABBING

The drive is being grabbed

BURN_DRIVE_STATUS_BURN_DRIVE_IDLE

The drive is not in an operation

BURN_DRIVE_STATUS_BURN_DRIVE_READING

The drive is reading data from a disc

BURN_DRIVE_STATUS_BURN_DRIVE_READING_SYNC

The drive is busy in synchronous read (if you see this then it has been interrupted)

BURN_DRIVE_STATUS_BURN_DRIVE_SPAWNING

The library is spawning the processes to handle a pending operation (A read/write/etc is about to start but hasn’t quite yet)

BURN_DRIVE_STATUS_BURN_DRIVE_WRITING

The drive is writing data to a disc

BURN_DRIVE_STATUS_BURN_DRIVE_WRITING_LEADIN

The drive is writing Lead-In

BURN_DRIVE_STATUS_BURN_DRIVE_WRITING_LEADOUT

The drive is writing Lead-Out

BURN_DRIVE_STATUS_BURN_DRIVE_WRITING_PREGAP

The drive gets written zeroes before the track payload data

BURN_DRIVE_STATUS_BURN_DRIVE_WRITING_SYNC

The drive is busy in synchronous write (if you see this then it has been interrupted)

BURN_DRIVE_WHITELIST_LEN

BURN_FORM1

BURN_FORM2

BURN_FORMAT_IS_FORMATTED

BURN_FORMAT_IS_UNFORMATTED

BURN_FORMAT_IS_UNKNOWN

BURN_HEADER_VERSION_MAJOR

BURN_HEADER_VERSION_MICRO

BURN_HEADER_VERSION_MINOR

BURN_MODE0

BURN_MODE1

BURN_MODE2

BURN_MODE_BITS

BURN_MODE_RAW

BURN_MSGS_MESSAGE_LEN

BURN_POS_END

BURN_PREEMPHASIS

BURN_REASONS_LEN

BURN_SCMS

BURN_SOURCE_STATUS_BURN_SOURCE_EOF

The source is at end of file

BURN_SOURCE_STATUS_BURN_SOURCE_FAILED

The source is unusable

BURN_SOURCE_STATUS_BURN_SOURCE_OK

The source is ok

BURN_SUBCODE_P16

BURN_SUBCODE_P96

BURN_SUBCODE_R96

BURN_WRITE_TYPES_BURN_WRITE_NONE

In replies this indicates that not any writing will work. As parameter for inquiries it indicates that no particular write mode shall is specified. Do not use for setting a write mode for burning. It will not work.

BURN_WRITE_TYPES_BURN_WRITE_PACKET

Packet writing. currently unsupported, (for DVD Incremental Streaming use TAO)

BURN_WRITE_TYPES_BURN_WRITE_RAW

With CD: Raw disc at once recording. all subcodes must be provided by lib or user only raw block types are supported With DVD and BD media: not supported.

BURN_WRITE_TYPES_BURN_WRITE_SAO

With CD: Session At Once Block type MUST be BURN_BLOCK_SAO ts A70122: Currently not capable of mixing data and audio tracks.

BURN_WRITE_TYPES_BURN_WRITE_TAO

With CD: Track At Once recording 2s gaps between tracks, no fonky lead-ins

LIBDAX_AUDIOXTR_STRLEN

Functions

burn_abort^⚠

Abort any running drive operation and eventually call burn_finish().

burn_abort_pacifier^⚠

A pacifier function suitable for burn_abort.

burn_allow_drive_role_4^⚠

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 permit no writing will be classified as role 4 and those which permit 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 or write-only, then it gets role 4 or role 5, respectively. Other paths may get tested by an attempt to open them for read-write (role 2) or read-only (role 4) or write-only (role 5). See bit1.

burn_allow_untested_profiles^⚠

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.

burn_cdtext_from_packfile^⚠

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.

burn_cdtext_from_session^⚠

Produce an array of CD-TEXT packs that could be submitted to burn_write_opts_set_leadin_text(), or stored as *.cdt file, or submitted to burn_make_input_sheet_v07t(). 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().

burn_disc_add_session^⚠

Add a session to a disc at a specific position, increasing the sessions’s reference count.

burn_disc_available_space^⚠

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 taken into respect with the 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.

burn_disc_close_damaged^⚠

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.

burn_disc_create^⚠

Create a new disc

burn_disc_erasable^⚠

Tells whether a disc can be erased or not

burn_disc_erase^⚠

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.

burn_disc_format^⚠

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 bit4 of flag. DVD-RAM and BD-RE may get formatted initially or re-formatted to adjust their Defect Management. 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.

burn_disc_free^⚠

Delete disc and decrease the reference count on all its sessions

burn_disc_free_multi_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.

burn_disc_get_bd_spare_info^⚠

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.

burn_disc_get_cd_info^⚠

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.

burn_disc_get_format_descr^⚠

Inquire parameters of an available media format.

burn_disc_get_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().

burn_disc_get_incomplete_sessions^⚠

Obtains the number of incomplete sessions which are recorded in the result array of burn_disc_get_sessions() after the complete sessions. See above.

burn_disc_get_leadin_text^⚠

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.

burn_disc_get_media_id^⚠

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 cannot provide 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.

burn_disc_get_msc1^⚠

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.

burn_disc_get_multi_caps^⚠

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.

burn_disc_get_phys_format_info^⚠

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.

burn_disc_get_profile^⚠

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 ""

burn_disc_get_sectors^⚠

burn_disc_get_sessions^⚠

Gets an array of all complete sessions for the disc THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION The result array contains *num + burn_disc_get_incomplete_sessions() elements. All above *num are incomplete sessions. Typically there is at most one incomplete session with one empty track. DVD+R and BD-R seem support more than one track with even readable data.

burn_disc_get_status^⚠

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.

burn_disc_next_track_is_damaged^⚠

Tells whether a previous attempt to determine the Next Writeable Address of the upcoming track reveiled that the READ TRACK INFORMATION Damage Bit is set for this track and that no valid writable address is available. See MMC-5 6.27.3.7 Damage Bit, 6.27.3.11 NWA_V (NWA valid)

burn_disc_pretend_blank^⚠

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.

burn_disc_pretend_full^⚠

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.

burn_disc_pretend_full_uncond^⚠

WARNING: This overrides the safety measures against unsuitable media. Sets the drive status to BURN_DISC_FULL unconditionally.

burn_disc_read^⚠

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.

burn_disc_read_atip^⚠

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.

burn_disc_remove_session^⚠

Remove a session from a disc

burn_disc_track_lba_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().

burn_disc_write^⚠

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.

burn_drive_add_whitelist^⚠

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.

burn_drive_cancel^⚠

Cancel an operation on a drive. This will only work when the drive’s busy state is BURN_DRIVE_READING or BURN_DRIVE_WRITING.

burn_drive_clear_whitelist^⚠

Remove all drives from whitelist. This enables all possible drives.

burn_drive_convert_fs_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.

burn_drive_convert_scsi_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.

burn_drive_d_get_adr^⚠

Inquire the device file address of the given drive.

burn_drive_equals_adr^⚠

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 …

burn_drive_extract_audio^⚠

Extract an interval of audio sectors from CD and store it as a WAVE audio file on hard disk.

burn_drive_extract_audio_track^⚠

Extract all audio sectors of a track from CD and store them as a WAVE audio file on hard disk.

burn_drive_free_speedlist^⚠

Dispose a speed descriptor list copy which was obtained by burn_drive_get_speedlist().

burn_drive_get_adr^⚠

Inquire the device file address of a drive via a given drive_info object. (Note: This is a legacy call.)

burn_drive_get_all_profiles^⚠

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().

burn_drive_get_bd_r_pow^⚠

Tells whether a BD-R medium with Pseudo Overwrite (POW) formatting is in the drive. Such a formatting may have been applied by dvd+rw-tools. It prevents sequential multi-session. libburn will refuse to write to such a medium.

burn_drive_get_best_speed^⚠

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.

burn_drive_get_disc^⚠

Get the drive’s disc struct - free when done

burn_drive_get_drive_role^⚠

Inquire whether the drive object is a real MMC drive or a pseudo-drive created by a stdio: address.

burn_drive_get_feature^⚠

Obtains the fields and data of a particular feature which were obtained from the drive when it was last acquired or re-assessed. See MMC specs for full detail.

burn_drive_get_feature_codes^⚠

Obtains the list of SCSI Feature Codes from feature descriptors which were obtained from the drive when it was most recently acquired or re-assessed.

burn_drive_get_immed^⚠

Inquire the current setting of usage of the Immed bit. Either the still set system dependent default or the value set by call burn_drive_set_immed().

burn_drive_get_media_sno^⚠

Returns the Media Serial Number as of MMC feature 109h and command ABh READ MEDIA SERIAL NUMBER.

burn_drive_get_min_write_speed^⚠

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().

burn_drive_get_read_speed^⚠

Gets the maximum read speed for a drive

burn_drive_get_serial_no^⚠

Returns the Drive Serial Number as of MMC feature 108h.

burn_drive_get_speedlist^⚠

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.

burn_drive_get_start_end_lba^⚠

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. Shortcoming (not a feature): unless burn_disc_read_atip() was called only blank media will return valid info.

burn_drive_get_status^⚠

Returns the progress and status of a drive.

burn_drive_get_write_speed^⚠

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().

burn_drive_grab^⚠

Grab a drive. This must be done before the drive can be used (for reading, writing, etc).

burn_drive_info_forget^⚠

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.

burn_drive_info_free^⚠

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().

burn_drive_is_enumerable_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.

burn_drive_leave_locked^⚠

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.

burn_drive_obtain_scsi_adr^⚠

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.

burn_drive_probe_cd_write_modes^⚠

burn_drive_re_assess^⚠

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.

burn_drive_release^⚠

Release a drive. This should not be done until the drive is no longer busy (see burn_drive_get_status).

burn_drive_reset_simulate^⚠

Control the write simulation mode before or after burn_write_opts get into effect. Beginning with version 1.4.8 a burn run by burn_disc_write() brings the burn_drive object in the simulation state as set to the burn_write_opts by burn_write_opts_set_simulate(). This state is respected by call burn_random_access_write() until a new call of burn_disc_write() happens or until burn_drive_reset_simulate() is called. This call may only be made when burn_drive_get_status() returns BURN_DRIVE_IDLE.

burn_drive_scan^⚠

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.

burn_drive_scan_and_grab^⚠

Acquire a drive with known device file address.

burn_drive_set_buffer_waiting^⚠

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. Some do not go to full speed unless their buffer is full.

burn_drive_set_immed^⚠

Enable or disable use of the Immed bit with long running SCSI commands. If the Immed bit is used, then those SCSI commands end early and leave the drive in not-ready state. libburn then tries periodically whether the drive became ready again. Only then it assumes the command to be completely done. The default setting may depend on the operating system on which libburn was compiled.

burn_drive_set_speed^⚠

Sets drive read and write speed. Note: "k" is 1000, not 1024. 1xCD = 176.4 k/s, 1xDVD = 1385 k/s, 1xBD = 4496 k/s. Fractional speeds should be rounded up. Like 4xCD = 706.

burn_drive_set_speed_exact^⚠

Sets drive read and write speed using the "Exact" bit of SCSI command SET STREAMING. This command will be used even if a CD medium is present. MMC specifies that with the Exact bit the desired speed settings shall either be obeyed by the drive exactly, or that the drive shall indicate failure and not accept the settings. But many drives reply no error and nevertheless adjust their read speed only coarsly or ignore the setting after a few MB of fast read attempts.

burn_drive_set_stream_recording^⚠

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().

burn_drive_snooze^⚠

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.

burn_drive_was_feat21_failure^⚠

Inquire whether a write error occurred which is suspected to have happened due to a false report about DVD-RW capability to be written in write type BURN_WRITE_TAO.

burn_drive_wrote_well^⚠

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.

burn_fd_source_new^⚠

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.

burn_fifo_fill^⚠

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.

burn_fifo_get_statistics^⚠

Inquire various counters which reflect the fifo operation.

burn_fifo_inquire_status^⚠

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.

burn_fifo_next_interval^⚠

Inquire the fifo minimum fill counter for intervals and reset that counter.

burn_fifo_peek_data^⚠

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.

burn_fifo_source_new^⚠

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.

burn_file_source_new^⚠

Creates a data source for an image file (and maybe subcode file)

burn_finish^⚠

Shutdown the library. This should be called before exiting your application. Make sure that all drives you have grabbed are released before calling this.

burn_get_read_capacity^⚠

Inquire the maximum amount of readable data. On DVD and BD it is supposed that all LBAs in the range from 0 to capacity - 1 can be read via burn_read_data() although some of them may never have been recorded. With multi-session CD there have to be expected unreadable TAO Run-out blocks. If tracks are recognizable then it is better to only read LBAs which are part of some track and on CD to be cautious about the last two blocks of each track which might be TAO Run-out blocks. 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.

burn_guess_cd_manufacturer^⚠

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).

burn_guess_manufacturer^⚠

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_disc_get_media_id().

burn_initialize^⚠

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.

burn_is_aborting^⚠

burn_lba_to_msf^⚠

Convert an lba to minute-second-frame (MSF)

burn_list_sev_texts^⚠

Return a blank separated list of severity names. Sorted from low to high severity.

burn_lookup_device_link^⚠

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.

burn_make_input_sheet_v07t^⚠

Convert an array of CD-TEXT packs into the text format of Sony CD-TEXT Input Sheet Version 0.7T .

burn_msf_to_lba^⚠

Convert a minute-second-frame (MSF) value to an lba

burn_msf_to_sectors^⚠

Convert a minute-second-frame (MSF) value to sector count

burn_msgs_obtain^⚠

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.

burn_msgs_set_severities^⚠

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".

burn_msgs_submit^⚠

Submit a message to the libburn queueing system. It will be queued or printed as if it was generated by libburn itself.

burn_nominal_slowdown^⚠

Waits until the time has elapsed since the given previous time to transmit the given byte count with the given speed in KB/second (KB = 1000 bytes). This call may be used between random access read operations like burn_read_data() in order to force a slower speed than the drive is willing to use if it gets read requests as fast as it delivers data.

burn_obtain_profile_name^⚠

Obtains the profile name associated with a profile code.

burn_offst_source_new^⚠

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.

burn_os_alloc_buffer^⚠

Allocate a memory area that is suitable for reading with a file descriptor opened by burn_os_open_track_src().

burn_os_free_buffer^⚠

Dispose a memory area which was obtained by burn_os_alloc_buffer(),

burn_os_open_track_src^⚠

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).

burn_precheck_write^⚠

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.

burn_preset_device_open^⚠

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.

burn_random_access_write^⚠

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 overwritable 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 (successfully 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.

burn_read_audio^⚠

Read CD audio sectors in random access mode. The drive must be grabbed successfully before calling this function. Only CD audio tracks with 2352 bytes per sector can be read this way. I.e. not data tracks, not CD-video-stream, …

burn_read_data^⚠

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 (successfully or not). So it is wise not to read giant amounts of data in a single call.

burn_read_opts_free^⚠

Frees a read_opts struct created with burn_read_opts_new

burn_read_opts_new^⚠

Creates a read_opts struct for reading from the specified drive must be freed with burn_read_opts_free

burn_read_opts_read_subcodes_audio^⚠

Sets whether to read subcodes from audio tracks or not

burn_read_opts_read_subcodes_data^⚠

Sets whether to read subcodes from data tracks or not

burn_read_opts_report_recovered_errors^⚠

Sets whether to report recovered errors or not

burn_read_opts_set_c2errors^⚠

Sets whether to report c2 errors or not

burn_read_opts_set_hardware_error_recovery^⚠

Sets whether to recover errors if possible

burn_read_opts_set_hardware_error_retries^⚠

Sets the number of retries to attempt when trying to correct an error

burn_read_opts_set_raw^⚠

Sets whether to read in raw mode or not

burn_read_opts_transfer_damaged_blocks^⚠

Sets whether blocks with unrecoverable errors should be read or not

burn_scsi_transport_id^⚠

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.

burn_sectors_to_msf^⚠

Convert a sector count to minute-second-frame (MSF)

burn_session_add_track^⚠

Add a track to a session at specified position

burn_session_by_cue_file^⚠

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.

burn_session_create^⚠

Create a new session

burn_session_dispose_cdtext^⚠

Remove all CD-TEXT attributes of the given block from the session. They were attached by burn_session_set_cdtext().

burn_session_free^⚠

Free a session (and decrease reference count on all tracks inside)

burn_session_get_cdtext^⚠

Obtain a CD-TEXT attribute that was set by burn_session_set_cdtext()

burn_session_get_cdtext_par^⚠

Obtain the current settings as of burn_session_set_cdtext_par()

burn_session_get_hidefirst^⚠

Returns whether the first track of a session is hidden in the pregap

burn_session_get_leadout_entry^⚠

Gets a copy of the toc_entry structure associated with a session’s lead out

burn_session_get_sectors^⚠

burn_session_get_start_tno^⚠

Inquire the CD track start number, as set by default or by burn_session_set_start_tno().

burn_session_get_tracks^⚠

Gets an array of all the tracks for a session THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK

burn_session_hide_first_track^⚠

Hide the first track in the "pre gap" of the disc

burn_session_input_sheet_v07t^⚠

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.

burn_session_remove_track^⚠

Remove a track from a session

burn_session_set_cdtext^⚠

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 .

burn_session_set_cdtext_par^⚠

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".

burn_session_set_start_tno^⚠

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.

burn_set_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().

burn_set_scsi_logging^⚠

Enable or 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.

burn_set_signal_handling^⚠

Control built-in signal handling. Either by setting an own handler or by activating the built-in signal handler.

burn_set_verbosity^⚠

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.

burn_sev_to_text^⚠

Convert a severity number into a severity name

burn_source_free^⚠

Free a burn_source (decrease its refcount and maybe free it)

burn_structure_print_disc^⚠

burn_structure_print_session^⚠

burn_structure_print_track^⚠

burn_text_to_sev^⚠

Convert a severity name into a severity number, which gives the severity rank of the name.

burn_track_clear_indice^⚠

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.

burn_track_clear_isrc^⚠

Disable ISRC parameters for a track

burn_track_create^⚠

Create a track

burn_track_define_data^⚠

Define the data in a track

burn_track_dispose_cdtext^⚠

Remove all CD-TEXT attributes of the given block from the track. They were attached by burn_track_set_cdtext().

burn_track_free^⚠

Free a track

burn_track_get_cdtext^⚠

Obtain a CD-TEXT attribute that was set by burn_track_set_cdtext().

burn_track_get_counters^⚠

Tells how many source bytes have been read and how many data bytes have been written by the track during burn.

burn_track_get_entry^⚠

Gets a copy of the toc_entry structure associated with a track

burn_track_get_mode^⚠

Gets the mode of a track

burn_track_get_sectors^⚠

Tells how many sectors a track will have on disc, or 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

burn_track_set_byte_swap^⚠

Define whether a track shall swap bytes of its input stream.

burn_track_set_cdtext^⚠

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.

burn_track_set_cdxa_conv^⚠

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.

burn_track_set_default_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.

burn_track_set_index^⚠

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.

burn_track_set_isrc^⚠

Set the ISRC details for a track. When writing to CD media, ISRC will get written into the Q sub-channel.

burn_track_set_isrc_string^⚠

Set the composed ISRC string for a track. This is an alternative to burn_track_set_isrc().

burn_track_set_postgap_size^⚠

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.)

burn_track_set_pregap_size^⚠

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 (audio 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.)

burn_track_set_size^⚠

Sets a fixed track size after the data source object has already been created.

burn_track_set_source^⚠

Set the track’s data source

burn_version^⚠

Returns the library’s version in its parts. This is the runtime counterpart of the three build time macros burn_header_version_* below.

burn_write_opts_auto_write_type^⚠

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().

burn_write_opts_free^⚠

Frees a write_opts struct created with burn_write_opts_new

burn_write_opts_get_drive^⚠

Inquires the drive associated with a burn_write_opts object.

burn_write_opts_new^⚠

Creates a write_opts struct for burning to the specified drive. The returned object must later be freed with burn_write_opts_free().

burn_write_opts_set_bdr_obs_exempt^⚠

Exempts BD-R media from the elsewise unavoidable automatic padding of the last write chunk to its full size. Even if this exempt is granted it gets into effect only if stream recording is disabled and burn_write_opts_set_obs_pad() is set to 0.

burn_write_opts_set_dvd_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.

burn_write_opts_set_fail21h_sev^⚠

Set the severity to be used with write error messages which are potentially caused by not using write type BURN_WRITE_SAO on fast blanked DVD-RW.

burn_write_opts_set_fillup^⚠

Caution: still immature and likely to change. Problems arose with sequential DVD-RW on one drive.

burn_write_opts_set_force^⚠

Lets libburn ignore the failure of some conformance checks:

burn_write_opts_set_format^⚠

Sets the session format for a disc

burn_write_opts_set_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().

burn_write_opts_set_leadin_text^⚠

Submit an array of CD-TEXT packs which shall be written to the Lead-in of a SAO write run on CD.

burn_write_opts_set_mediacatalog^⚠

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.

burn_write_opts_set_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.

burn_write_opts_set_obs_pad^⚠

Overrides the automatic decision whether to pad up the last write chunk to its full size. This applies to DVD, BD and stdio: pseudo-drives. Note: This override may get enabled fixely already at compile time by defining macro Libburn_dvd_always_obs_paD .

burn_write_opts_set_perform_opc^⚠

Sets whether to use opc or not with the write_opts struct

burn_write_opts_set_simulate^⚠

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. Note: Up to version 1.4.6 the call burn_random_access_write() after burn_disc_write() did not simulate because it does not get any burn_write_opts and the drive did not memorize the simulation state. This has changed now. burn_random_access_write() will not write after a simulated burn run. Use burn_drive_reset_simulate(drive, 0) if you really want to end simulation before you call burn_disc_write() with new write options.

burn_write_opts_set_start_byte^⚠

Sets a start address for writing to media and write modes which are able 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 .

burn_write_opts_set_stdio_fsync^⚠

Sets the rhythm 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.

burn_write_opts_set_stream_recording^⚠

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().

burn_write_opts_set_toc_entries^⚠

Supplies toc entries for writing - not normally required for cd mastering

burn_write_opts_set_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.

burn_write_opts_set_write_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.

libdax_audioxtr_destroy^⚠

Clean up after extraction and destroy extractor object.

libdax_audioxtr_detach_fd^⚠

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 WAVE (.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.

libdax_audioxtr_get_id^⚠

Obtain identification parameters of opened audio source.

libdax_audioxtr_get_size^⚠

Obtain a prediction about the extracted size based on internal information of the formatted file.

libdax_audioxtr_new^⚠

Open an audio file, check whether suitable, create extractor object.

libdax_audioxtr_read^⚠

Obtain next buffer full of extracted data in desired format (only raw audio for now).

Type Aliases

burn_abort_handler_t

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.

burn_block_types

Data format to send to the drive

burn_disc_status

Possible status of the drive in regard to the disc in it.

burn_drive_status

Possible busy states for a drive

burn_source_status

Possible data source return values

burn_write_types

Possible disc writing style/modes