filesrc

## filesrc filesrc — Read from arbitrary point in a file |

## Synopsis

                        GstFileSrc;

## Object Hierarchy

      GObject
       +----GstObject
             +----GstElement
                   +----GstBaseSrc
                         +----GstFileSrc

## Implemented Interfaces

GstFileSrc implements GstURIHandler.

## Properties

      "fd"                       gint                  : Read
      "location"                 gchar*                : Read / Write
      "mmapsize"                 gulong                : Read / Write
      "touch"                    gboolean              : Read / Write
      "use-mmap"                 gboolean              : Read / Write
      "sequential"               gboolean              : Read / Write

## Description

Read data from a file in the local file system.

## Synopsis

### Element Information

plugin | coreelements
author | Erik Walthinsen <omega@cse.ogi.edu>
class | Source/File

### Element Pads

name | src
direction | source
presence | always
details | ANY

## Details

### GstFileSrc

    typedef struct _GstFileSrc GstFileSrc;

Opaque GstFileSrc structure.

## Property Details

### The `"fd"` property

      "fd"                       gint                  : Read

File-descriptor for the file being mmap()d.

Allowed values: >= 0

Default value: 0

### The `"location"` property

      "location"                 gchar*                : Read / Write

Location of the file to read.

Default value: NULL

### The `"mmapsize"` property

      "mmapsize"                 gulong                : Read / Write

Size in bytes of mmap()d regions.

### The `"touch"` property

      "touch"                    gboolean              : Read / Write

Touch mmapped data regions to force them to be read from disk.

Default value: TRUE

### The `"use-mmap"` property

      "use-mmap"                 gboolean              : Read / Write

Whether to use `mmap()`. Set to TRUE to force use of `mmap()` instead of `read()` for reading data.

Use of `mmap()` is disabled by default since with `mmap()` there are a number of occasions where the process/application will be notified of read errors via a SIGBUS signal from the kernel, which will lead to the application being killed if not handled by the application. This is something that is difficult to work around for a library like GStreamer, hence use of `mmap()` is disabled by default. Said errors can occur for example when an external device (e.g. an external hard drive or a portable music player) are unplugged while in use, or when a CD/DVD medium cannot be be read because the medium is scratched or otherwise damaged.

Default value: FALSE

### The `"sequential"` property

      "sequential"               gboolean              : Read / Write

Whether to use madvise to hint to the kernel that access to mmap pages will be sequential.

Default value: FALSE

## See Also

GstFileSrc