javascript - How can I read a file's metadata in Node.js, beyond what the fs.statSync provides without using a library?

admin管理员组

文章数量:1324995

This is a topic where I can't seem to find the answer on the Node.js docs (I know it's possible because of libraries like exif), nor can I find an answer on the internet without everyone saying to just use a library.

I don't want to use a library, so I want to do this natively and learn more about reading file metadata, and maybe eventually updating the metadata too while building my own mini-tool.

If I run something like fs.statSync() I can get generic metadata that returns in the Stats object; but, in my case, I'm looking for all the other metadata, NOT just the basic file info like size, birthtime, etc.

I want the other metadata like dimensions, date taken, and especially things you'd see in image, video, or audio files.

Maybe there's something like:

const deepMetaData = fs.readFileSync().getMetaDataAsString();
console.info(/Date Taken/.test(deepMetaData)); // true

or

const deepMetaData = fs.createReadStream().buffer().toString();
const dateTaken = deepMetaData.match(/Date Taken: (\d{4}-\d{2}-\d{2})/)[1];
console.info(dateTaken);

If I need to work with buffers, streams, whatever, instead of a string output, that's cool too. Ideally something synchronous. So if there's a simple example someone could provide of how to read that kind of meta data without a library, I'll at least be able to look up the methods used from that to understand more later and leverage the docs associated with whatever approach. Thank you!

This is a topic where I can't seem to find the answer on the Node.js docs (I know it's possible because of libraries like exif), nor can I find an answer on the internet without everyone saying to just use a library.

I don't want to use a library, so I want to do this natively and learn more about reading file metadata, and maybe eventually updating the metadata too while building my own mini-tool.

If I run something like fs.statSync() I can get generic metadata that returns in the Stats object; but, in my case, I'm looking for all the other metadata, NOT just the basic file info like size, birthtime, etc.

I want the other metadata like dimensions, date taken, and especially things you'd see in image, video, or audio files.

Maybe there's something like:

const deepMetaData = fs.readFileSync().getMetaDataAsString();
console.info(/Date Taken/.test(deepMetaData)); // true

or

const deepMetaData = fs.createReadStream().buffer().toString();
const dateTaken = deepMetaData.match(/Date Taken: (\d{4}-\d{2}-\d{2})/)[1];
console.info(dateTaken);

If I need to work with buffers, streams, whatever, instead of a string output, that's cool too. Ideally something synchronous. So if there's a simple example someone could provide of how to read that kind of meta data without a library, I'll at least be able to look up the methods used from that to understand more later and leverage the docs associated with whatever approach. Thank you!

• javascript
• node.js
• file
• filesystems
• metadata

Share Improve this question Follow asked Oct 31, 2022 at 23:18 Native DevNative Dev 7,40233 gold badges4242 silver badges4141 bronze badges 3

• This is a good question, but it's not suitable for StackOverflow. There's no specific coding problem that you're asking to have solved, you're literally asking people how to solve an open ended question. – Tibrogargan Commented Oct 31, 2022 at 23:33
• @Tibrogargan It may have been lost in the details, but the title is the question. Node.js provides limited metadata, but I need to know how to get ALL metadata. – Native Dev Commented Nov 1, 2022 at 0:04
• No, it wasn't lost. The question is simple, but the answer is very long, plex., and very open to interpretation - hence this question is both way too unfocused and much too broad to be a good question for the site. – Tibrogargan Commented Nov 1, 2022 at 0:13

Add a ment  | 

2 Answers 2

Sorted by: Reset to default 5

Nodejs fs functions like fs.statSync() provide OS level metadata on the file only (such as createDate, modificationDate, file size, etc...). These are properties of the file in the file system. These do NOT have anything at all to do with the actual data of the file itself.

When you talk about EXIF (for a photo), this is parsed from the file data itself. To know about that type of data, you must read and parse at least the beginning of the file and you must be able to recognize and understand all the different file formats that you might encounter. For photos, this would include JPEG, PNG, HEIC, GIF, etc... Each of those have different file formats and will require unique code for understanding the metadata embedded in the file.

Nodejs does not have support for any of that built-in.

So, it will take custom code for each file type. If you further want to include other types of files like videos, you need to extend your list of different file types you can read, parse and understand. For the depth of files you're talking about this is a big job, particular when it es to testing against all the different variants of files and metadata that exist out in the wild.

I personally would be fine with implementing my own code for one particular file type like JPEG, but if I was tasked with supporting dozens of types of files and particularly if tasked with supporting the wide range of video file formats, I'd immediately seek out help from existing libraries that have already done all the time consuming work to research, write and test how to properly read and understand all the variants.

I know it's possible because of libraries like exif

This is an example of a library that reads the beginning of the image file, parses it according to the expected format and knows how to interpret all the possible tags that can be in the EXIF header and what they all mean.

So if there's a simple example someone could provide of how to read that kind of meta data without a library

Go study the code for the EXIF library and see how it works. If you're going to implement it yourself, that's how you have to do it. I'm still not sure why you'd avoid using working libraries if they already exist. That is one of the biggest advantages of the nodejs ecosystem - you can build on all the open source code that already exists without reimplementing it all from scratch yourself and spend your coding time on parts of your problem that someone else has not already implemented.

how would one read that metadata using node?

You literally have to read the data from the file (usually at the start of the file). You can use any of the mechanisms that the fs module provides. For example, you can use fs.createReadStream() and then stream in the file, parsing and interpreting it as data arrives and then stop the stream when you get past the end of the metadata. Of, you can open a file handle using fs.open() and use fs.read() to read chunks of the file until you have read enough to have all the metadata.

You HAVE an example sitting right in front of you of code that does this in the EXIF library on NPM that you already seem to know about. Just go examine its code. The code is ALL there.

I'm just looking for a simple answer on getting that info, even if it's a blob of strings.

This is perhaps your main problem. There is no simple answer to get that info and it doesn't just exist as a blob of strings. These files are sometimes binary files (for space efficiency reasons). You have to learn how to read and parse binary data. Go study the code in the EXIF library and see what it is already doing and you can learn from that. There is no better example to start with.

But, for a simple example using the heic filetype, this will grab the first 5000 characters of the file's metadata, which can then be searched:

const fileDescriptor = fs.openSync(absPathToHeicPhoto);
const charCount = 5000;
const buffer = Buffer.alloc(charCount);
const headerBytes = fs.readSync(fileDescriptor, buffer, 0, charCount);
const bufferAsStr = buffer.toString('utf8', 0, charCount);
console.info(/\d{4}:\d{2}:\d{2}/.test(bufferAsStr));

FYI, I looked at the code for this EXIF library on NPM and it's poorly implemented. It uses fs.readFile() to load the ENTIRE image into RAM (even though it only needs a fraction of the data at the start of the file). This is a poor implementation for this reason (memory and disk inefficient).

But, it does have a method called processImage and one called extractExifData that process the binary data of the file to parse out the EXIF info. These are links to its actual code. You can start learning there.

FYI, as a photographer, I use a mand line program called exiftool that will dump exif info to stdout or to a file for many images. As a different approach, you could just run that tool from your nodejs program (using the child_process module and capture its output and use that output, letting it do the hard work you just operate on the generated output.

Problem

Reading metadata from many different file extensions can be extremely challenging due to the wide range of formats and standards used to store metadata in various file types. Each file format has its own unique way of storing metadata, and there may be different metadata fields and properties that are relevant to different types of files.

Solution

ExifTool is a perl based powerful solution for reading file metadata because it is designed to handle a wide variety of file formats and standards. ExifTool is a mand-line application that can extract metadata from many different file types, including images, audio, video, and documents. It supports a wide range of metadata formats, including EXIF, IPTC, XMP, and many proprietary formats used by specific software applications.

ExifTool with Node.js

Github: https://github./anasshakil/metadata

import Metadata from "@enviro/metadata";

async function read() {
  try {
    const metadata = await Metadata.get("sample.jpg");
    console.log(metadata);
  } catch (e) {
    console.error(e);
  }
}

async function write() {
  try {
    const metadata = await Metadata.set("sample.jpg", {
      new: true, // returns metadata after operation
      tags: [{
        name: "Author",
        value: "Foo Bar",
      }]
    });
    console.log(metadata);
  } catch (e) {
    console.error(e);
  }
}

本文标签：