Example › Film protocol

The following image shows the original film protocol for the shortfilm "Father and Daughter" in the PDF-format. The contents are not machine-readable and have to be converted to FEI. Additionally, heart rate measurements for the film are added to the FEI body.

View the source code here

Basic structure

The basic structure of the document contains the fei-tag as well as its two children fhead and fbody.

{
    "fhead": ...
    "fbody": ...
}

fhead - Metadata

The fhead element contains all metadata for the film such as the used version, production info and a crew list.

"fhead": {
    "titlestmt": ...
    "editionstmt": ...
    "prodstmt": ...
    "genrestmt": ...
    "crewlist": ...
}

titlestmt - Title statement

The titlestmt element provides info about the movie title. It is the parent of one or more title elements that can provide the title and subtitles in multiple languages.

"titlestmt": [
    "Father and Daughter"
]

editionstmt - Edition statement

The editionstmt element is the container element for version information about the film. It contains one or more edition elements that each provide data like release date or duration as well as the possibility to link a source file.

"editionstmt": [
  {
    "date": "April 2001",
    "duration": "00:09:22",
    "source": "Father and Daughter HD.mp4",
    "id": "current"
  },
  {
    "date": "2004",
    "desc": "theatrical",
    "id": "04jpth"
  }
}

prodstmt - Production statement

The prodstmt element provides info about the production of the film. This ranges from companies to individuals. The two child-elements production and distributor can be extended with the more generic proditem element that also provides a role description.

"prodstmt": {
  "production": {
    "corpname": [
      "CinéTé Filmproductie BV",
      "Cloudrunner Ltd."
    ],
    "persname": [
      "Claire Jennings",
      "Willem Thijssen"
    ]
  },
  "distributor": {
    "corpname": "Crest International",
    "editionreference": "04jpth"
  },
  "prodtask": [
    {
      "proddesc": "technical direction",
      "corpname": "Spider Eye Ltd."
    },
    {
      "proddesc": "sound mixing",
      "corpname": "Studio SPR"
    }
  ]
}

genrestmt - Genre statement

The genrestmt (Genre statement) is the container for one or more genreitem elements that each provide a genre from the list of available genres.

"genrestmt": [
  "Animation",
  "Short",
  "Drama"
]

crewlist - Crew list

The crewlist (Crew list) links different crew members and their roles to the film. There are one or more crewitem child elements that describe the role and individual.

"crewlist": [
  {
    "role": [
      "director",
      "writer",
      "animation and backgrounds"
    ],
    "persname": "Michael Dudok de Wit"
  },
  {
    "role": [
      "additional animation"
    ],
    "persname": "Arjan Wilschut"
  },
      
  ...
      
  {
    "role": [
      "special thanks"
    ],
    "persname": "Anthony Smith"
  }
]

fbody - The data

The data of an FEI-file is stored in the document body, the fbody element. There are several ways data can be stored. At the moment, the fbody covers quantitative data and film protocols with the division in sequence, scene and shot.

The fbody content for this filmprotocol covers both a film protocol and quantitative data (heart rate measurements):

"fbody": {
  "sequentialstmt": ...
  "measurementstmt": ...
}

measurementstmt

The measurementstmt (measurement statement) contains one or more measurementitem elements that represent a sequence of measurements. A description of the dataset via a quantdesc element is also possible.

"measurementstmt": [
  {
    "description": "Erhöhung der Herzfrequenz",
    "id": "measure_up",
    "data": [
      {
        "timecode": "00:00:00",
        "value": "12"
      },
      {
        "timecode": "00:00:01",
        "value": "9"
      },
      ...
    ],
   },
   ...
]

Film structure

The film can be hierarchically structured into smaller sections. In FEI, we propose three depth layers: sequences, scenes and shots. For each of these layers a container is provided that can both provide information on its segments and nest smaller layers in its children. Since the film protocol template only uses shots, the shotstmt is the only one used here. For more information about the film structure layers, please visit the documentation.

shot

The smallest section of a film is a shot. It can be defined with in- and out-points. The shot element can contain a description element as well as data about the shot with the use of quantstmt.

<shot id="2">
    <summary>Wolke im Himmel</summary>
    <timecodestart>00:00:09</timecodestart>
    <quantstmt>
        <quantitem type="referenceframe">
            <timecode>00:00:09</timecode>
            <source>img_log/003.jpg</source>
        </quantitem>
        <quantitem type="camera">HN</quantitem>
        <quantitem type="camera">front</quantitem>
        <quantitem type="camera">Normalperspektive</quantitem>
        <quantitem type="transition">Aufblende</quantitem>
        <quantitem type="imagery">Braun</quantitem>
        <quantitem type="imagery">Weiß</quantitem>
        <quantitem type="audio">Leitmotiv Akkordeon: Intro</quantitem>
    </quantstmt>
</shot>

shotstmt

This element contains a group of shot elements

<shotstmt>
    <shot id="0">
        <summary>START</summary>
        <timecodestart>00:00:00</timecodestart>
        <quantstmt>
            <quantitem type="referenceframe">
                <timecode>00:00:00</timecode>
                <source>img_log/001.jpg</source>
            </quantitem>
        </quantstmt>
    </shot>
    <shot id="1">
        <summary>Vorspann,Titel</summary>
        <timecodestart>00:00:02</timecodestart>
        <quantstmt>
            <quantitem type="referenceframe">
                <timecode>00:00:02</timecode>
                <source>img_log/002.jpg</source>
            </quantitem>
        </quantstmt>
    </shot>
    ...
</shotstmt>

annotations