DVRescue

https://mipops.github.io/dvrescue/
Admin
DVRescue is cross-platform archival software that enables advanced data migration from DV tapes into...
Tokens:22,342
Snippets:333
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get dvpackager Help

Source: https://mipops.github.io/dvrescue/sections/packaging.html

Run this command to view all available flags and options for the dvpackager tool.

```bash
dvpackager -h
```

--------------------------------

### Launch DVRescue with logging enabled

Source: https://mipops.github.io/dvrescue/sections/troubleshooting.html

Run this command in Terminal to start the application and generate diagnostic logs for troubleshooting.

```bash
/Applications/dvrescue.app/Contents/MacOS/dvrescue --log
```

--------------------------------

### Split Output by Recording Start Markers

Source: https://mipops.github.io/dvrescue/sections/packaging.html

This flag forces dvpackager to split the output file at recording start markers, in addition to technical characteristic changes.

```bash
dvpackager -s INPUT.dv
```

--------------------------------

### DVRescue Merge Command Usage

Source: https://mipops.github.io/dvrescue/sections/merge.html

Instructions and examples for merging .dv files using the dvrescue command line tool.

```APIDOC
## DVRescue Merge Command

### Description
Merges multiple .dv files into a single output file, selecting the best parts from each input file. This process is useful for eliminating transient artifacts.

### Method
Command Line Interface (CLI)

### Endpoint
`dvrescue`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Usage Example
```bash
dvrescue --v 9 [pathtofile/file-pass-1.dv] [pathtofile/file-pass-2.dv] [pathtofile/file-pass-3.dv] --merge [pathtofile/file-merged.dv]
```

### Flags and Options

- `--m [value]` (string) - Merge all input files into `value` (file name), picking the best part of each file.
- `--merge-log value` (string) - Store merge log to `value` (file name).
- `--merge-output-speed` - Report and merge frames having speed not meaning normal playback. Is default (it will change in the future).
- `--merge-ignore-speed` - Do not report and do not merge frames having speed not meaning normal playback.
- `--merge-output-concealed` - Report and merge frames having all blocks concealed. Is default (it will change in the future).
- `--merge-ignore-concealed` - Do not report and do not merge frames having all blocks concealed.
- `--merge-log-missing` - Report frames considered as missing (due to time code jump etc). Is default if information output format is not CSV.
- `--merge-hide-missing` - Do not report frames considered as missing (due to time code jump etc). Is default if information output format is CSV.
- `--merge-log-intermediate` - Display additional lines of information about intermediate analysis during files merge. Is default if information output format is not CSV.
- `--merge-hide-intermediate` - Hide additional lines of information about intermediate analysis during files merge. Is default if information output format is CSV.
- `--verbosity value` or `-v value` (integer) - Sets the level of detail for terminal output during and after the merging process. Ranges from 0 (minimal information) to 9 (detailed information per frame).
  - `0`: no output, no summary is provided.
  - `5`: summary only.
  - `7`: information per problematic frame + a summary of the merging process.
  - `9`: information per frame + summary.

### Request Example
```bash
dvrescue --v 9 file1.dv file2.dv file3.dv --merge merged_file.dv --merge-log merge.log
```

### Response
Terminal output detailing the merge process, with verbosity controlled by the `--verbosity` flag. A log file can be generated using `--merge-log`.
```

--------------------------------

### Display help documentation

Source: https://mipops.github.io/dvrescue/sections/capture.html

View the full list of available command-line flags and options.

```bash
--help, -h
    Display this help and exit.

--version
    Display DVRescue version and exit.

--cc-format value
    Set Closed Captions output format to value.
    value can be 'scc', 'screen', 'srt'.
    If there is more than one instance of this option,
    this option is applied to the next --cc-output option.

--cc-output value | -c value
    Store Closed Captions output to value (file name).
    File extension must be the format name (see above)
    if --cc-format is not provided.
    if content is different between Dseq and/or has more than 1 field,
    extension is prefixed by 'dseq%dseq%.' and/or 'field%field%.'.
    There can be more than one instance of this option.

--cc-tc value
    Set Closed Captions output start time code to value.
    Used for SCC output.
    value format is HH:MM:SS;FF, or 'dv' (for DV first frame time code).

--webvtt-output value | -s value
    Store WebVTT output to value (file name).

--xml-output value | -x value
    Store XML output to value (file name).

--merge value | -m value
    Merge all input files into value (file name),
    picking the best part of each file.

--merge-log value
    Store merge log to value (file name).

--merge-output-speed
    Report and merge frames having speed not meaning normal playback
    Is default (it will change in the future).

--merge-ignore-speed
    Do not report and do not merge frames having speed not
    meaning normal playback.

--merge-output-concealed
```

--------------------------------

### View CLI help

Source: https://mipops.github.io/dvrescue/sections/merge.html

Displays all available command-line options and flags.

```bash
dvrescue -h
```

--------------------------------

### Accessing dvplay help

Source: https://mipops.github.io/dvrescue/sections/analysis.html

Command to display available options and usage information.

```bash
dvplay -h
```

--------------------------------

### Basic dvplay command syntax

Source: https://mipops.github.io/dvrescue/sections/analysis.html

The standard syntax for invoking the dvplay tool on a DV file.

```bash
dvplay [options] file.dv
```

--------------------------------

### Create Firewire Permissions Rule (Ubuntu)

Source: https://mipops.github.io/dvrescue/sections/troubleshooting.html

This command creates a udev rule to grant necessary permissions for Firewire devices on Ubuntu. Ensure you are running this with root privileges.

```bash
sudo mkdir /etc/udev/rules.d
```

```bash
sudo -s echo 'KERNEL=="fw*", GROUP="video", MODE="0664"' > /etc/udev/rules.d/80-firewire.rules exit
```

--------------------------------

### List FireWire Devices via Terminal

Source: https://mipops.github.io/dvrescue/sections/troubleshooting.html

Use system utilities to verify if the computer detects connected FireWire hardware.

```bash
avfctl -list_devices
```

```bash
ioreg -l
```

--------------------------------

### Generate output table from XML

Source: https://mipops.github.io/dvrescue/sections/packaging.html

Displays a table of potential output files based on provided options and an XML input file without performing the actual packaging.

```bash
dvpackager -s -a c -T file.dv.dvrescue.xml file.dv
```

--------------------------------

### dvplay options reference

Source: https://mipops.github.io/dvrescue/sections/analysis.html

A comprehensive list of flags and options available for the dvplay command.

```text
Options:
 -m         (Inverse of standard display)
 -x         (create output xml and jpgs)
 -g         (create gif from error jpgs)
 -o OUTPUT  (select a custom location for output files)

 -O FILE    (provide a path to a single output file. When set a single frame will be exported, depending on
             if -b or -t is set. If 'FILE' is set to '-', dvplay will output a jpeg to stdout.)
 -b OFFSET  (provide a byte offset of the frame to examine, otherwise the first frame is default)
 -t PTS     (provide a timestamp to examine, otherwise the first frame is default. Ignored if '-b OFFSET' is set)

 -h         (Displays this help)
 -B BLOCKS  (draw a box around a specific DIF Block(s). Use a comma-delimited list for more than one,
             such as '-B 0,1348,1349')

 -F <path> (provide a custom ffmpeg path)
 -M <path> (provide a custom mediainfo path)
 -D <path> (provide a custom dvrescue path)
 -X <path> (provide a custom xmlstarlet path)
 -d <path> (provide a custom path to a DVRescue XML that corresponds to the
            input file)

To vizualize the relationship between inputs and a merged output (-s, -S, and -b are required):
 -s <list> (provide a pipe-delimited list of the input files for the merge)
 -S <list> (provide a pipe-delimited list of the offsets to the input files listed in '-s')

 For example 'dvplay -s 'file1.dv|file2.dv' -S '120000|240000' -b 240000 output.dv' would show
 an image that depicts the input frames (at the corresponding offsets of the corresponding input
 file) with the corresponding merged output frame at the corresponding offset.

 -z       (disable colored terminal output)
```

--------------------------------

### Capture with preview window

Source: https://mipops.github.io/dvrescue/sections/capture.html

Capture command that pipes output to ffplay for real-time monitoring.

```bash
dvrescue device://0xdevicename -m /pathtofile/filename.dv -m - | ffplay -
```

```bash
dvrescue device://0x800460104ce2bad -m /Users/libbyshopfauf/Desktop/12345.dv -m - | ffplay -
```

--------------------------------

### Capture with rewind, merge, and preview

Source: https://mipops.github.io/dvrescue/sections/capture.html

Full command string to capture to a file with error recovery and live playback.

```bash
dvrescue device://0x0x80458280022265 -y --rewind-count 3 -m filename.dv -m - | ffplay -
```

```bash
dvrescue device://0x800460104ce2bad -y --rewind-count 3 -m /Users/libbyshopfauf/Desktop/12345.dv -m - | ffplay -
```

--------------------------------

### Add User to Video Group (Ubuntu)

Source: https://mipops.github.io/dvrescue/sections/troubleshooting.html

This command adds the specified user to the 'video' group, which is required for Firewire device access on Ubuntu after setting up udev rules.

```bash
usermod -a -G video USERNAME
```

--------------------------------

### Capture with rewind, merge, and preview (single deck)

Source: https://mipops.github.io/dvrescue/sections/capture.html

Capture command with error recovery and preview for a single connected deck.

```bash
dvrescue device://0xdevicename -y --rewind-count 3 -m filename.dv -m - | ffplay -
```

```bash
dvrescue device://0x800460104ce2bad -y --rewind-count 3 -m /Users/libbyshopfauf/Desktop/12345.dv -m - | ffplay -
```

--------------------------------

### dvpackager configuration options

Source: https://mipops.github.io/dvrescue/sections/packaging.html

A comprehensive list of flags for controlling file splitting, output naming patterns, and external tool paths.

```text
By default, dvpackager will split the output files so that each time
significant technical characteristics of the dv stream change (such as aspect
ratio, frame rate, audio channel count, or audio sample rate) a new output file
will be written. The following flags adjust the way dvpackager will split the
output.

-s       (split the output file at recording start markers)
-d       (split the output file at non-consecutive recording timestamps)
-t       (split the output file at non-consecutive timecode values)

-o <dir> (provide a custom output directory)
-O <pattern>
      (specify a pattern for output files. The following variables may be
       used:
      %FILENAME% - will use the filename of the input file without it's
                   extension
      %RECDATE% -  will use the recording date of the first output frame,
                   in YYYY-MM-DD format. If there is no embedded recording
                   date, then 'XXXX-XX-XX' will be used.
      %RECTIME% -  will use the recording date of the first output frame.
                   If there is no embedded recording date, then
                   'XX-XX-XX' will be used.
      %TC% -       will use the timecode value of the first frame or use
                   XX-XX-XX-XX if no timecode is stored in the first frame.
      %PARTNO% -   This is an incrementing number of the output starting
                   from 1.
       The default pattern is "%FILENAME%_part%PARTNO%". The
 extension of the output file is determined by the -e
 setting.)
           
       Note that if the output pattern would generate multiple output files
       with the same name then a 3-digit incrementing number such as "-001"
       will be added to the end of the filename.
-e <ext> (specify the extension of the container to use. Tested with:
       mkv, mov, dv. Defaults to mov. Note that using the 'dv' option
       shall simply extract the dv from the file while using the
       selected options to split the output.)
-l <code>(specify the language code to use for the audio tracks.
       If multiple languages are provided with a comma delimiter such as
       'eng,spa,fra,nor' then they are used for each audio track in order.
       Note that usually could be one or two stereo tracks, but if -m is 
       enabled then it is possible for two or four mono tracks, each
       with it's own language code.)
-L <code>(specify the language code to use for the caption tracks (if
       any).
-m       (By default, audio will be handled in stereo pairs, enabling this
       option will arrange the audio into tracks with mono channels.)
-S       (embeds a caption track if there are captions to represent in the
       source DV)
-Z       (generate a DVRescue technical subtitle file, which contains
       timecode and other frame-based metadata. This is an experimental
       dvrescue subtitle format)
-n       (do not repackage, simply generate a dvrescue xml if one doesn't
       already exist, and report on what the output files would be)
-N <parts> (List the numbers of the segments that should not be packaged.
         Multiple segments numbers may be listed as comma-delimited; for
         instance "-N '1,3'" would output the 2nd segment and any segment
         after the 3rd. Use "-n" to list the segments by number.)
-v       (shows ffmpeg stderr output, otherwise this is hidden)
-z       (disable colored terminal output)

-F <path> (provide a custom ffmpeg path)
-M <path> (provide a custom mediainfo path)
-D <path> (provide a custom dvrescue path)
-X <path> (provide a custom xmlstarlet path)
-x <path> (provide a custom path to a DVRescue XML that corresponds to the
        input file)
-V <path> (provide a custom path to a DVRescue technical subtitle file that
```

--------------------------------

### DVRescue Foreground Option

Source: https://mipops.github.io/dvrescue/sections/capture.html

With --cmd or --speed, wait for the device to stop before proceeding. This option is usable only if the input is a device.

```bash
--foreground
    With --cmd or --speed, wait for the device to stop.
    Usable only if input is a device.
```

--------------------------------

### CLI: dvpackager Configuration Options

Source: https://mipops.github.io/dvrescue/sections/packaging.html

Configuration flags for controlling output splitting, naming patterns, and metadata handling.

```APIDOC
## [CLI] dvpackager Configuration

### Description
Flags to adjust how dvpackager splits output files and configures metadata.

### Parameters
#### Options
- **-a** (char) - Optional - Strategy for handling aspect ratio changes (n, 4, 9, c).
- **-s** (flag) - Optional - Split output at recording start markers.
- **-d** (flag) - Optional - Split output at non-consecutive recording timestamps.
- **-t** (flag) - Optional - Split output at non-consecutive timecode values.
- **-o** (string) - Optional - Custom output directory.
- **-O** (string) - Optional - Pattern for output files (e.g., %FILENAME%, %RECDATE%, %RECTIME%, %TC%, %PARTNO%).
- **-e** (string) - Optional - Container extension (mkv, mov, dv).
- **-l** (string) - Optional - Language code for audio tracks.
- **-L** (string) - Optional - Language code for caption tracks.
- **-m** (flag) - Optional - Arrange audio into mono channels.
- **-S** (flag) - Optional - Embed caption track.
- **-Z** (flag) - Optional - Generate DVRescue technical subtitle file.
```

--------------------------------

### DVRescue Input and Device Control Options

Source: https://mipops.github.io/dvrescue/sections/capture.html

Manage input sources and device interactions with DVRescue. Options include setting timeouts, launching capture, controlling input devices, and listing available devices.

```bash
--timeout value
    Time out limit for the device or pipe input ("-" file name) set to value (in seconds)
```

```bash
--capture
    Launch capture.
    Is the default if no --cmd option is provided.
    Usable only if input is a device.
```

```bash
--in-control
    Include an integrated command line input for controlling the input.
    Usable only if input is a device.
```

```bash
--list_devices
    List detected devices and their ID.
```

```bash
--list_devices_json
    List detected devices and their ID (JSON output).
```

```bash
--status
    Provide the status (playing, stop...) of the input.
    By default device://0 is used.
    Usable only if input is a device.
```

```bash
--cmd value
    Send a command to the input.
    By default device://0 is used.
    Usable only if input is a device.
    value may be:
    play      Set speed to 1.0 and mode to play.
    srew      Set speed to -1.0 and mode to play.
    stop      Set speed to 0.0 and mode to no-play.
    rew       Set speed to -2.0 and mode to play.
    ff        Set speed to 2.0 and mode to play.
```

--------------------------------

### Basic dvpackager Usage

Source: https://mipops.github.io/dvrescue/sections/packaging.html

Use this command to package a DV file. Options can be added to control how the file is split.

```bash
dvpackager [options] file.dv
```

--------------------------------

### Check DV Device in vrecord

Source: https://mipops.github.io/dvrescue/sections/troubleshooting.html

Run the vrecord command to list available DV devices.

```bash
vrecord -e
```

--------------------------------

### List connected devices

Source: https://mipops.github.io/dvrescue/sections/capture.html

Display the names and identifiers of connected DV devices.

```bash
dvrescue --list_devices
```

--------------------------------

### Unpackage DV streams

Source: https://mipops.github.io/dvrescue/sections/packaging.html

Use the -u flag to combine multiple input files into a single DV stream.

```bash
dvpackager -u INPUT_1.mkv INPUT_2.mkv INPUT_3.mkv
```

--------------------------------

### DVRescue CLI flags and options

Source: https://mipops.github.io/dvrescue/sections/merge.html

Configuration options for the merge process, including logging, frame handling, and verbosity settings.

```text
--m [value]                   Merge all input files into value (file name), picking the best part of each file.
--merge-log value             Store merge log to value (file name).
--merge-output-speed          Report and merge frames having speed not meaning normal playback
                                  Is default (it will change in the future).
--merge-ignore-speed          Do not report and do not merge frames having speed not meaning normal playback.
--merge-output-concealed      Report and merge frames having all blocks concealed.
                                  Is default (it will change in the future).
--merge-ignore-concealed      Do not report and do not merge frames having all blocks concealed.
--merge-log-missing           Report frames considered as missing (due to time code jump etc).
                                  Is default if information output format is not CSV.
--merge-hide-missing          Do not report frames considered as missing (due to time code jump etc).
                                  Is default if information output format is CSV.
--merge-log-intermediate      Display additional lines of information about intermediate analysis during files merge.
                                  Is default if information output format is not CSV.
--merge-hide-intermediate     Hide additional lines of information about intermediate analysis during files merge.
                                  Is default if information output format is CSV.
--verbosity value | -v value  This is the level of detail that you would like the Terminal to provide during and after the merging process.
                              The amount of information provided varies from 0 (no information is provided during merging besides a frame count
                              of the current processing location) to 9 (information on what frames and blocks are being selected is displayed
                              for every single frame included in the merge (problematic, as well as frames that are fine).  on the way that
                              Verbosity of the output set to value:
                                  0: no output, no summary is provided
                                  5: summary only.
                                  7: information per problematic frame + a summary of the merging process.
                                  9: information per frame + summary.
```

--------------------------------

### Device Control and Capture

Source: https://mipops.github.io/dvrescue/sections/capture.html

Commands for interacting with capture devices, listing hardware, and controlling playback.

```APIDOC
## Device Control API

### Description
Commands to manage capture devices, list available hardware, and control tape transport.

### Parameters
- **--list_devices** - List detected devices and IDs.
- **--list_devices_json** - List detected devices and IDs in JSON format.
- **--capture** - Launch capture (default if no --cmd).
- **--status** - Provide status of the input device.
- **--cmd** (value) - Send command (play, srew, stop, rew, ff).
- **--speed** (float) - Set input speed.
- **--mode** (n/p) - Set input mode (no-play/play).
- **--rewind-count** (value) - Automatically rewind to last good frame and capture again.
```

--------------------------------

### dvplay CLI Usage

Source: https://mipops.github.io/dvrescue/sections/analysis.html

Command-line interface for analyzing DV files and generating error reports.

```APIDOC
## dvplay [options] file.dv

### Description
Analyzes a DV file to visually display frames, identify error concealment data, and optionally generate XML reports or image exports.

### Method
CLI Command

### Parameters
#### Options
- **-m** (flag) - Inverse of standard display
- **-x** (flag) - Create output xml and jpgs
- **-g** (flag) - Create gif from error jpgs
- **-o** (string) - Select a custom location for output files
- **-O** (string) - Provide a path to a single output file
- **-b** (integer) - Provide a byte offset of the frame to examine
- **-t** (string) - Provide a timestamp to examine
- **-h** (flag) - Displays help
- **-B** (string) - Draw a box around a specific DIF Block(s)
- **-F** (path) - Provide a custom ffmpeg path
- **-M** (path) - Provide a custom mediainfo path
- **-D** (path) - Provide a custom dvrescue path
- **-X** (path) - Provide a custom xmlstarlet path
- **-d** (path) - Provide a custom path to a DVRescue XML
- **-s** (list) - Provide a pipe-delimited list of the input files for the merge
- **-S** (list) - Provide a pipe-delimited list of the offsets to the input files
- **-z** (flag) - Disable colored terminal output
```

--------------------------------

### Retrieve DVRescue GUI logs

Source: https://mipops.github.io/dvrescue/sections/troubleshooting.html

Use this command to display the contents of the application log file in the terminal for debugging purposes.

```bash
cat ~/Library/Containers/net.MediaArea.dvrescue.mac-gui/Data/dvrescue-gui_logs/dvrescue-gui.log
```

--------------------------------

### Capture from a specific device

Source: https://mipops.github.io/dvrescue/sections/capture.html

Basic capture command targeting a specific device identifier.

```bash
dvrescue device://0xdevicename -m /pathtofile/filename.dv
```

```bash
dvrescue device://0x800460104ce2bad -m /Users/libbyshopfauf/Desktop/12345.dv
```

--------------------------------

### DVRescue Rewind and File Naming Options

Source: https://mipops.github.io/dvrescue/sections/capture.html

Configure automatic rewinding and specify base names for files storing buggy frames. These options help manage the capture process and organize output files.

```bash
--rewind-count value
    Automatically rewind to last good frame and capture again,
    value times.
    Usable only if input is a device.
```

```bash
--rewind
    Same as --rewind-count 1
```

```bash
--rewind-basename value
    Base name of files storing buggy frames per take
    Default is output file name.
```

--------------------------------

### DVRescue Output and Verbosity Options

Source: https://mipops.github.io/dvrescue/sections/capture.html

Configure the output format and verbosity level for DVRescue. Use --csv for machine-readable output and adjust verbosity from 0 to 9 for detailed logging.

```bash
--csv
    Output is in CSV format rather than human readable text.
```

```bash
--verbosity value | -v value
    Verbosity of the output set to value:
    0: no output.
    5: summary only.
    7: information per frame if there is a problem + summary.
    9: information per frame + summary.
```
Tokens:
Raw